def to_xml(self, request, response):
response.content_type = 'text/xml'
doc = etree.Element("Index", name=self.env.config.get("app", "name", "botoweb application"))
if self.env.config.get("app", "version"):
doc.set("version", str(self.env.config.get("app", "version")))
if request.user:
user_node = etree.SubElement(doc, "User", id=request.user.id)
etree.SubElement(user_node, "name", type='string').text = request.user.name
etree.SubElement(user_node, "username", type='string').text = request.user.username
etree.SubElement(user_node, "email", type='string').text = request.user.email
for auth_group in request.user.auth_groups:
etree.SubElement(user_node, "auth_groups", type='string').text = auth_group
for route in self.env.config.get("botoweb", "handlers"):
if route.get("name"):
model_name = route.get("name")
href = route['url'].strip('/')
api_node = etree.SubElement(doc, "api", name=model_name)
etree.SubElement(api_node, "href").text = href
if route.get("description"):
etree.SubElement(api_node, "description").text = route.get("description")
handler = find_class(route.get("handler"))
if not handler:
raise Exception("Handler not found: %s" % route.get('handler'))
methods_node = etree.SubElement(api_node, "methods")
for method_name in handler.allowed_methods:
method = getattr(handler, "_%s" % method_name)
etree.SubElement(methods_node, method_name).text = method.__doc__
if route.get("db_class"):
model_class = find_class(route.get("db_class"))
if model_class:
if len(model_class.mro()) > 1:
api_node.set("parentClass", model_class.mro()[1].__name__)
props_node = etree.SubElement(api_node, "properties")
for prop in model_class.properties():
if prop.name.startswith("_"):
continue
prop_node = etree.SubElement(props_node, "property")
prop_node.set("name", prop.name)
if hasattr(prop, "collection_name") and prop.collection_name:
prop_node.set("reference_name", prop.collection_name)
if hasattr(prop, "reference_class"):
prop_node.set("type", "reference")
prop_node.set("item_type", prop.reference_class.__name__)
else:
prop_type_name = prop.type_name.lower()
if prop_type_name:
prop_node.set("type", TYPE_CONVERSIONS.get(prop_type_name, prop_type_name))
elif hasattr(prop, "calculated_type"):
if prop.calculated_type:
prop_type_name = prop.calculated_type.__name__.lower()
else:
prop_type_name = "str"
prop_node.set("type", TYPE_CONVERSIONS.get(prop_type_name, prop_type_name))
prop_node.set("calculated", "true")
else:
prop_node.set("type", TYPE_NAMES.get(prop.data_type, "string"))
if prop.data_type in [str, unicode]:
prop_node.set("max_length", "1024")
if prop.data_type == int:
prop_node.set("min", "-2147483648")
prop_node.set("max", "2147483647")
if hasattr(prop, "item_type"):
if hasattr(prop.item_type, "__name__"):
item_type = prop.item_type.__name__
else:
item_type = TYPE_NAMES.get(prop.item_type, "string")
prop_node.set("item_type", item_type)
if hasattr(prop, "verbose_name") and prop.verbose_name != None:
etree.SubElement(prop_node, "description").text = str(prop.verbose_name)
if hasattr(prop, "default") and prop.default:
default_node = etree.SubElement(prop_node, "default")
default_node.text = str(prop.default)
if hasattr(prop, "choices") and prop.choices:
choices_node = etree.SubElement(prop_node, "choices")
for choice in prop.choices:
etree.SubElement(choices_node, "choice", value=choice)
response.write(etree.tostring(doc, encoding="utf-8", pretty_print=True))
return response
def to_xml(self, request, response):
response.content_type = 'text/xml'
doc = etree.Element("Index",
name=self.env.config.get("app", "name",
"botoweb application"))
if self.env.config.get("app", "version"):
doc.set("version", str(self.env.config.get("app", "version")))
if request.user:
user_node = etree.SubElement(doc, "User", id=request.user.id)
etree.SubElement(user_node, "name",
type='string').text = request.user.name
etree.SubElement(user_node, "username",
type='string').text = request.user.username
etree.SubElement(user_node, "email",
type='string').text = request.user.email
for auth_group in request.user.auth_groups:
etree.SubElement(user_node, "auth_groups",
type='string').text = auth_group
for route in self.env.config.get("botoweb", "handlers"):
if route.get("name"):
model_name = route.get("name")
href = route['url'].strip('/')
api_node = etree.SubElement(doc, "api", name=model_name)
etree.SubElement(api_node, "href").text = href
if route.get("description"):
etree.SubElement(
api_node,
"description").text = route.get("description")
handler = find_class(route.get("handler"))
if not handler:
raise Exception("Handler not found: %s" %
route.get('handler'))
methods_node = etree.SubElement(api_node, "methods")
for method_name in handler.allowed_methods:
method = getattr(handler, "_%s" % method_name)
etree.SubElement(methods_node,
method_name).text = method.__doc__
if route.get("db_class"):
model_class = find_class(route.get("db_class"))
if model_class:
if len(model_class.mro()) > 1:
api_node.set("parentClass",
model_class.mro()[1].__name__)
props_node = etree.SubElement(api_node, "properties")
for prop in model_class.properties():
if prop.name.startswith("_"):
continue
prop_node = etree.SubElement(
props_node, "property")
prop_node.set("name", prop.name)
if hasattr(prop, "collection_name"
) and prop.collection_name:
prop_node.set("reference_name",
prop.collection_name)
if hasattr(prop, "reference_class"):
prop_node.set("type", "reference")
prop_node.set("item_type",
prop.reference_class.__name__)
else:
prop_type_name = prop.type_name.lower()
if prop_type_name:
prop_node.set(
"type",
TYPE_CONVERSIONS.get(
prop_type_name, prop_type_name))
elif hasattr(prop, "calculated_type"):
if prop.calculated_type:
prop_type_name = prop.calculated_type.__name__.lower(
)
else:
prop_type_name = "str"
prop_node.set(
"type",
TYPE_CONVERSIONS.get(
prop_type_name, prop_type_name))
prop_node.set("calculated", "true")
else:
prop_node.set(
"type",
TYPE_NAMES.get(prop.data_type,
"string"))
if prop.data_type in [str, unicode]:
prop_node.set("max_length", "1024")
if prop.data_type == int:
prop_node.set("min", "-2147483648")
prop_node.set("max", "2147483647")
if hasattr(prop, "item_type"):
if hasattr(prop.item_type, "__name__"):
item_type = prop.item_type.__name__
else:
item_type = TYPE_NAMES.get(
prop.item_type, "string")
prop_node.set("item_type", item_type)
if hasattr(prop, "verbose_name"
) and prop.verbose_name != None:
etree.SubElement(prop_node,
"description").text = str(
prop.verbose_name)
if hasattr(prop, "default") and prop.default:
default_node = etree.SubElement(
prop_node, "default")
default_node.text = str(prop.default)
if hasattr(prop, "choices") and prop.choices:
choices_node = etree.SubElement(
prop_node, "choices")
for choice in prop.choices:
etree.SubElement(choices_node,
"choice",
value=choice)
response.write(etree.tostring(doc, encoding="utf-8",
pretty_print=True))
return response
def to_dict(self, request):
ret = {}
if self.env.config.get("app", "version"):
ret['__version__'] = self.env.config.get("app", "version")
if request.user:
ret["User"] = {
"__id__": request.user.id,
"name": request.user.name,
"username": request.user.username,
"email": request.user.email
}
ret['User']['auth_groups'] = []
for auth_group in request.user.auth_groups:
ret['User']['auth_groups'].append(auth_group)
ret['resources'] = {}
for route in self.env.config.get("botoweb", "handlers"):
if route.get("name"):
route_dict = {
"name": route.get("name"),
"href": route['url'].strip('/'),
"description": route.get("description")
}
# Handler info
handler = find_class(route.get("handler"))
if not handler:
raise Exception("Handler not found: %s" % route.get('handler'))
# Add in the Methods
route_dict['methods' ] = {}
for method_name in handler.allowed_methods:
method = getattr(handler, "_%s" % method_name)
route_dict['methods'][method_name] = method.__doc__
# Info about the object returned
if route.get("db_class"):
model_class = find_class(route.get("db_class"))
if model_class:
# Class Info
route_dict['class_name'] = model_class.__name__
if len(model_class.mro()) > 1:
route_dict['parent_class'] = model_class.mro()[1].__name__
# Property Info
route_dict['properties'] = {}
for prop in model_class.properties():
if prop.name.startswith("_"):
continue
route_dict['properties'][prop.name] = {
"name": prop.name,
"type": prop.__class__.__name__
}
if hasattr(prop, "collection_name") and prop.collection_name:
route_dict['properties'][prop.name]['reference_name'] = prop.collection_name
if hasattr(prop, "reference_class"):
route_dict['properties'][prop.name]['type'] = "reference"
route_dict['properties'][prop.name]['item_type'] = prop.reference_class.__name__
else:
prop_type_name = prop.type_name.lower()
if not prop_type_name:
if hasattr(prop, "calculated_type"):
if prop.calculated_type:
prop_type_name = prop.calculated_type.__name__.lower()
else:
prop_type_name = "str"
route_dict['properties'][prop.name]['calculated'] = True
else:
prop_type_name = TYPE_NAMES.get(prop.data_type, "string")
route_dict['properties'][prop.name]['type'] = TYPE_CONVERSIONS.get(prop_type_name, prop_type_name)
if prop.data_type in [str, unicode]:
route_dict['properties'][prop.name]['max_length'] = 1024
if prop.data_type == int:
route_dict['properties'][prop.name]['min'] = -2147483648
route_dict['properties'][prop.name]['max'] = 2147483647
if hasattr(prop, "item_type"):
if hasattr(prop.item_type, "__name__"):
item_type = prop.item_type.__name__
else:
item_type = TYPE_NAMES.get(prop.item_type, "string")
route_dict['properties'][prop.name]['item_type'] = item_type
if hasattr(prop, "verbose_name") and prop.verbose_name != None:
route_dict['properties'][prop.name]['description'] = str(prop.verbose_name)
if hasattr(prop, "default") and prop.default:
route_dict['properties'][prop.name]['default'] = prop.default
if hasattr(prop, "choices") and prop.choices:
route_dict['properties'][prop.name]['choices'] = []
for choice in prop.choices:
route_dict['properties'][prop.name]['choices'].append(choice)
ret['resources'][route.get("name")] = route_dict
return ret
def to_dict(self, request):
ret = {}
if self.env.config.get("app", "version"):
ret['__version__'] = self.env.config.get("app", "version")
if request.user:
ret["User"] = {
"__id__": request.user.id,
"name": request.user.name,
"username": request.user.username,
"email": request.user.email
}
ret['User']['auth_groups'] = []
for auth_group in request.user.auth_groups:
ret['User']['auth_groups'].append(auth_group)
ret['resources'] = {}
for route in self.env.config.get("botoweb", "handlers"):
if route.get("name"):
route_dict = {
"name": route.get("name"),
"href": route['url'].strip('/'),
"description": route.get("description")
}
# Handler info
handler = find_class(route.get("handler"))
if not handler:
raise Exception("Handler not found: %s" %
route.get('handler'))
# Add in the Methods
route_dict['methods'] = {}
for method_name in handler.allowed_methods:
method = getattr(handler, "_%s" % method_name)
route_dict['methods'][method_name] = method.__doc__
# Info about the object returned
if route.get("db_class"):
model_class = find_class(route.get("db_class"))
if model_class:
# Class Info
route_dict['class_name'] = model_class.__name__
if len(model_class.mro()) > 1:
route_dict['parent_class'] = model_class.mro(
)[1].__name__
# Property Info
route_dict['properties'] = {}
for prop in model_class.properties():
if prop.name.startswith("_"):
continue
route_dict['properties'][prop.name] = {
"name": prop.name,
"type": prop.__class__.__name__
}
if hasattr(prop, "collection_name"
) and prop.collection_name:
route_dict['properties'][prop.name][
'reference_name'] = prop.collection_name
if hasattr(prop, "reference_class"):
route_dict['properties'][
prop.name]['type'] = "reference"
route_dict['properties'][prop.name][
'item_type'] = prop.reference_class.__name__
else:
prop_type_name = prop.type_name.lower()
if not prop_type_name:
if hasattr(prop, "calculated_type"):
if prop.calculated_type:
prop_type_name = prop.calculated_type.__name__.lower(
)
else:
prop_type_name = "str"
route_dict['properties'][
prop.name]['calculated'] = True
else:
prop_type_name = TYPE_NAMES.get(
prop.data_type, "string")
route_dict['properties'][
prop.name]['type'] = TYPE_CONVERSIONS.get(
prop_type_name, prop_type_name)
if prop.data_type in [str, unicode]:
route_dict['properties'][
prop.name]['max_length'] = 1024
if prop.data_type == int:
route_dict['properties'][
prop.name]['min'] = -2147483648
route_dict['properties'][
prop.name]['max'] = 2147483647
if hasattr(prop, "item_type"):
if hasattr(prop.item_type, "__name__"):
item_type = prop.item_type.__name__
else:
item_type = TYPE_NAMES.get(
prop.item_type, "string")
route_dict['properties'][
prop.name]['item_type'] = item_type
if hasattr(prop, "verbose_name"
) and prop.verbose_name != None:
route_dict['properties'][
prop.name]['description'] = str(
prop.verbose_name)
if hasattr(prop, "default") and prop.default:
route_dict['properties'][
prop.name]['default'] = prop.default
if hasattr(prop, "choices") and prop.choices:
route_dict['properties'][
prop.name]['choices'] = []
for choice in prop.choices:
route_dict['properties'][
prop.name]['choices'].append(choice)
ret['resources'][route.get("name")] = route_dict
return ret
