From 57611ec523056a20982523ab69df0a4e6da1747b Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <richard@matrix.org>
Date: Fri, 14 Oct 2016 12:20:00 +0100
Subject: [PATCH] More example formatting improvements

Generate more realistic example integers, and do some sanity checks on other
examples.
---
 templating/matrix_templates/units.py | 40 +++++++++++++++++++++-------
 1 file changed, 31 insertions(+), 9 deletions(-)

diff --git a/templating/matrix_templates/units.py b/templating/matrix_templates/units.py
index 5205186e..6305dc91 100644
--- a/templating/matrix_templates/units.py
+++ b/templating/matrix_templates/units.py
@@ -372,16 +372,31 @@ def get_example_for_schema(schema):
     if 'example' in schema:
         example = schema['example']
         return example
-    if 'properties' in schema:
+
+    proptype = schema['type']
+
+    if proptype == 'object':
+        if 'properties' not in schema:
+            raise Exception('"object" property has neither properties nor example')
         res = OrderedDict()
         for prop_name, prop in schema['properties'].iteritems():
             logger.debug("Parsing property %r" % prop_name)
             prop_example = get_example_for_schema(prop)
             res[prop_name] = prop_example
         return res
-    if 'items' in schema:
+
+    if proptype == 'array':
+        if 'items' not in schema:
+            raise Exception('"array" property has neither items nor example')
         return [get_example_for_schema(schema['items'])]
-    return schema.get('type', '??')
+
+    if proptype == 'integer':
+        return 0
+
+    if proptype == 'string':
+        return proptype
+
+    raise Exception("Don't know to make an example %s" % proptype)
 
 def get_example_for_param(param):
     """Returns a stringified example for a parameter"""
@@ -418,9 +433,14 @@ def get_example_for_response(response):
     if exampleobj is None:
         schema = response.get('schema')
         if schema:
+            if schema['type'] == 'file':
+                # no example for 'file' responses
+                return None
             exampleobj = get_example_for_schema(schema)
+
     if exampleobj is None:
         return None
+
     return json.dumps(exampleobj, indent=2)
 
 class MatrixUnits(Units):
@@ -512,29 +532,31 @@ class MatrixUnits(Units):
                 qps = []
                 body = ""
                 for param in single_api.get("parameters", []):
+                    paramname = param.get("name")
                     try:
                         example = get_example_for_param(param)
 
                         if not example:
                             logger.warn(
-                                "The parameter %s is missing an example." %
-                                param["name"])
+                                "The parameter %s is missing an example.",
+                                paramname
+                            )
                             continue
 
                         if param["in"] == "path":
                             path_template = path_template.replace(
-                                "{%s}" % param["name"], urllib.quote(example)
+                                "{%s}" % paramname, urllib.quote(example)
                             )
                         elif param["in"] == "body":
                             body = example
                         elif param["in"] == "query":
                             if type(example) == list:
                                 for value in example:
-                                    qps.append((param["name"], value))
+                                    qps.append((paramname, value))
                                 else:
-                                    qps.append((param["name"], example))
+                                    qps.append((paramname, example))
                     except Exception, e:
-                        raise Exception("Error handling parameter %s" % param["name"],
+                        raise Exception("Error handling parameter %s" % paramname,
                                         e)
 
                 query_string = "" if len(qps) == 0 else "?"+urllib.urlencode(qps)