renamed project to pyramlson

MANIFEST.in

@@ -1,5 +1,5 @@
 include *.md *.txt tox.ini docs/Makefile *.rst LICENSE .coveragerc .travis.yml *.ini
-recursive-include pyramid_raml *.py *.ini *.json
+recursive-include pyramlson *.py *.ini *.json
 recursive-include docs *.py *.rst
 recursive-include docs/_static *
 prune docs/_build

README.rst

@@ -1,10 +1,10 @@
-``pyramid_raml``
+``pyramlson``
 ==================
 
-.. image:: https://travis-ci.org/jenner/pyramid_raml.png?branch=master
-   :target: https://travis-ci.org/jenner/pyramid_raml
+.. image:: https://travis-ci.org/jenner/pyramlson.png?branch=master
+   :target: https://travis-ci.org/jenner/pyramlson
 
-Build REST APIs with RAML_ and Pyramid_.
+Build JSON REST APIs with RAML_ and Pyramid_.
 
 .. _RAML: http://raml.org/
 .. _Pyramid: http://docs.pylonsproject.org/en/latest/docs/pyramid.html

pyramid_raml/__init__.py → pyramlson/__init__.py

@@ -205,22 +205,22 @@ def includeme(config):
     .. code-block:: python
        :linenos:
        config = Configurator()
-       config.include('pyramid_raml')
+       config.include('pyramlson')
     """
-    from pyramid_raml.apidef import RamlApiDefinition, IRamlApiDefinition
+    from pyramlson.apidef import RamlApiDefinition, IRamlApiDefinition
     settings = config.registry.settings
-    settings['pyramid_raml.debug'] = \
+    settings['pyramlson.debug'] = \
             settings.get('debug_all') or \
             settings.get('pyramid.debug_all') or \
-            settings.get('pyramid_raml.debug')
-    config.add_view('pyramid_raml.error.generic', context=Exception, renderer='json')
-    config.add_view('pyramid_raml.error.http_error', context=IExceptionResponse, renderer='json')
-    config.add_notfound_view('pyramid_raml.error.notfound', renderer='json')
-    config.add_forbidden_view('pyramid_raml.error.forbidden', renderer='json')
+            settings.get('pyramlson.debug')
+    config.add_view('pyramlson.error.generic', context=Exception, renderer='json')
+    config.add_view('pyramlson.error.http_error', context=IExceptionResponse, renderer='json')
+    config.add_notfound_view('pyramlson.error.notfound', renderer='json')
+    config.add_forbidden_view('pyramlson.error.forbidden', renderer='json')
 
-    if 'pyramid_raml.apidef_path' not in settings:
+    if 'pyramlson.apidef_path' not in settings:
         raise ValueError("Cannot create RamlApiDefinition without a RAML file.")
-    apidef = RamlApiDefinition(settings['pyramid_raml.apidef_path'])
+    apidef = RamlApiDefinition(settings['pyramlson.apidef_path'])
     config.registry.registerUtility(apidef, IRamlApiDefinition)
 
 

pyramid_raml/error.py → pyramlson/error.py

@@ -12,14 +12,15 @@ def err_dict(message):
 
 def generic(context, request):
     log.error("error.generic -- context: \"{}\"".format(context))
+    tb = ''.join(traceback.format_exception(*request.exc_info))
+    log.error("error.generic -- traceback: \"{}\"".format(tb))
     request.response.status_int = 500
     try:
         response = err_dict(context.args[0])
     except IndexError:
         response = err_dict('Unknown error')
-    if request.registry.settings.get('pyramid_raml.debug'):
-        response['traceback'] = ''.join(
-                traceback.format_exception(*request.exc_info))
+    if request.registry.settings.get('pyramlson.debug'):
+        response['traceback'] = tb
     return response
 
 

setup.cfg

@@ -3,13 +3,14 @@ zip_ok = false
 
 [nosetests]
 match=^test
-nocapture=1
-cover-package=pyramid_raml
+verbosity=3
+nocapture=0
+cover-package=pyramlson
 cover-erase=1
 
 [aliases]
-dev = develop easy_install pyramid_raml[testing]
-docs = develop easy_install pyramid_raml[docs]
+dev = develop easy_install pyramlson[testing]
+docs = develop easy_install pyramlson[docs]
 
 [bdist_wheel]
 universal = 1

setup.py

@@ -25,9 +25,9 @@
     'coverage',
 ]
 
-setup(name='pyramid_raml',
+setup(name='pyramlson',
     version='1.0.0',
-    description='pyramid_raml',
+    description='pyramlson',
     long_description=README + '\n\n' + CHANGES,
     classifiers=[
         "Programming Language :: Python",
@@ -40,8 +40,8 @@
     ],
     author='Igor Stroh',
     author_email='[email protected]',
-    url='http://github.com/jenner/pyramid_raml',
-    keywords='web pyramid api',
+    url='http://github.com/jenner/pyramlson',
+    keywords='web pyramid api json',
     packages=find_packages(),
     include_package_data=True,
     zip_safe=False,
@@ -50,5 +50,5 @@
     extras_require = {
         'testing': testing_extras,
     },
-    test_suite="pyramid_raml",
+    test_suite="pyramlson",
 )

tests/bad_resource.py

@@ -1,4 +1,4 @@
-from pyramid_raml import api_service, api_method
+from pyramlson import api_service, api_method
 
 @api_service('/books')
 class BadResource(object):

tests/error_resource.py

@@ -1,4 +1,4 @@
-from pyramid_raml import api_service, api_method
+from pyramlson import api_service, api_method
 
 @api_service('/foo')
 class ErrorsResource(object):

tests/resource.py

@@ -1,12 +1,32 @@
 from collections import OrderedDict
+from lxml import objectify
+
 from pyramid.httpexceptions import HTTPNotFound
 from pyramid.security import (
     Allow,
     ALL_PERMISSIONS,
     DENY_ALL,
 )
 
-from pyramid_raml import api_service, api_method
+from pyramlson import api_service, api_method
+
+
+class Book(object):
+    """ A simcple book class """
+
+    def __init__(self, id, title, author, isbn=None):
+        self.id = id
+        self.title = title
+        self.author = author
+        selfisbn = isbn
+
+    @classmethod
+    def from_dict(klass, id, data):
+        return klass(id, data['title'], data['author'], data.get('isbn', None))
+
+    @classmethod
+    def from_etree(klass, id, tree):
+        return klass(id, data['title'], data['author'], data.get('isbn', None))
 
 BOOKS = OrderedDict()
 BOOKS[123] = {"id": 123,

tests/test_apidef.py

@@ -4,7 +4,7 @@
 
 from pyramid import testing
 
-from pyramid_raml import apidef
+from pyramlson import apidef
 
 from .base import DATA_DIR
 
@@ -64,7 +64,7 @@ def test_empty_traits():
 
 class TestMissingRaml(unittest.TestCase):
     def test_missing_raml(self):
-        # not providing a path to RAML specs file in settings['pyramid_raml.apidef_path']
+        # not providing a path to RAML specs file in settings['pyramlson.apidef_path']
         # must raise a ValueError
         config = testing.setUp()
-        self.assertRaises(ValueError, config.include, 'pyramid_raml')
+        self.assertRaises(ValueError, config.include, 'pyramlson')

tests/test_errors.py

@@ -25,13 +25,13 @@ class ErrorsTests(unittest.TestCase):
 
     def setUp(self):
         settings = {
-            'pyramid_raml.apidef_path': os.path.join(DATA_DIR, 'test-api.raml'),
+            'pyramlson.apidef_path': os.path.join(DATA_DIR, 'test-api.raml'),
         }
         auth_policy = BasicAuthAuthenticationPolicy(dummy_check, 'TEST REALM')
         self.config = testing.setUp(settings=settings)
         self.config.set_authorization_policy(ACLAuthorizationPolicy())
         self.config.set_authentication_policy(auth_policy)
-        self.config.include('pyramid_raml')
+        self.config.include('pyramlson')
         self.config.scan('.resource')
         from webtest import TestApp
         self.testapp = TestApp(self.config.make_wsgi_app())
@@ -58,11 +58,11 @@ def test_bad_roles(self):
 class ErrorsWithDebugTests(unittest.TestCase):
     def setUp(self):
         settings = {
-            'pyramid_raml.apidef_path': os.path.join(DATA_DIR, 'test-errors-api.raml'),
-            'pyramid_raml.debug': 'true',
+            'pyramlson.apidef_path': os.path.join(DATA_DIR, 'test-errors-api.raml'),
+            'pyramlson.debug': 'true',
         }
         self.config = testing.setUp(settings=settings)
-        self.config.include('pyramid_raml')
+        self.config.include('pyramlson')
         self.config.scan('.error_resource')
         from webtest import TestApp
         self.testapp = TestApp(self.config.make_wsgi_app())
@@ -75,11 +75,11 @@ def test_traceback(self):
 class UnknownErrorTests(unittest.TestCase):
     def setUp(self):
         settings = {
-            'pyramid_raml.apidef_path': os.path.join(DATA_DIR, 'test-errors-api.raml'),
-            'pyramid_raml.debug': 'true',
+            'pyramlson.apidef_path': os.path.join(DATA_DIR, 'test-errors-api.raml'),
+            'pyramlson.debug': 'true',
         }
         self.config = testing.setUp(settings=settings)
-        self.config.include('pyramid_raml')
+        self.config.include('pyramlson')
         self.config.scan('.error_resource')
         from webtest import TestApp
         self.testapp = TestApp(self.config.make_wsgi_app())

tests/test_resource.py

@@ -8,16 +8,25 @@
 from .base import DATA_DIR
 from .resource import BOOKS
 
+BOOK_XML_TMPL = """\
+<?xml version="1.0" encoding="utf-8"?>
+<book id="{}">
+  <author>Foo</author>
+  <title>Blah</title>
+  <isbn>123456789</isbn>
+</book>
+"""
+
 
 class ResourceFunctionalTests(unittest.TestCase):
 
     def setUp(self):
         settings = {
-            'pyramid_raml.apidef_path': os.path.join(DATA_DIR, 'test-api.raml'),
-            'pyramid_raml.debug': 'true',
+            'pyramlson.apidef_path': os.path.join(DATA_DIR, 'test-api.raml'),
+            'pyramlson.debug': 'true',
         }
         self.config = testing.setUp(settings=settings)
-        self.config.include('pyramid_raml')
+        self.config.include('pyramlson')
         self.config.scan('.resource')
         from webtest import TestApp
         self.testapp = TestApp(self.config.make_wsgi_app())
@@ -84,13 +93,23 @@ def test_not_accepted_body_mime_type(self):
         assert r.json_body['success'] == False
         assert "Unsupported body content-type: 'text/plain'" in r.json_body['message']
 
-    def test_succesful_put(self):
+    def test_succesful_json_put(self):
         app = self.testapp
         book_id = 123
         fake_book = {'id': book_id, 'title': 'Foo', 'author': 'Blah'}
         r = app.put_json('/api/v1/books/{}'.format(book_id), params=fake_book, status=200)
         assert r.json_body['success'] == True
 
+    def test_succesful_xml_put(self):
+        app = self.testapp
+        book_id = 123
+        fake_book_xml = BOOK_XML_TMPL.format(book_id)
+        r = app.put('/api/v1/books/{}'.format(book_id),
+            params=fake_book_xml,
+            content_type='application/xml',
+            status=200)
+        assert r.json_body['success'] == True
+
     def test_default_options(self):
         app = self.testapp
         r = app.options('/api/v1/books', status=204)
@@ -115,10 +134,10 @@ class NoMatchingResourceMethodTests(unittest.TestCase):
 
     def setUp(self):
         settings = {
-            'pyramid_raml.apidef_path': os.path.join(DATA_DIR, 'test-api.raml'),
+            'pyramlson.apidef_path': os.path.join(DATA_DIR, 'test-api.raml'),
         }
         self.config = testing.setUp(settings=settings)
 
     def test_valueerror(self):
-        self.config.include('pyramid_raml')
+        self.config.include('pyramlson')
         self.assertRaises(ValueError, self.config.scan, '.bad_resource')

tox.ini

@@ -15,21 +15,21 @@ basepython =
     py3: python3.4
 
 commands =
-    pip install pyramid_raml[testing]
+    pip install pyramlson[testing]
     nosetests --with-xunit --xunit-file=nosetests-{envname}.xml --logging-level=INFO {posargs:}
 
 [testenv:py2-cover]
 commands =
-    pip install pyramid_raml[testing]
-    coverage run --source=pyramid_raml {envbindir}/nosetests
+    pip install pyramlson[testing]
+    coverage run --source=pyramlson {envbindir}/nosetests
     coverage xml -o coverage-py2.xml
 setenv =
     COVERAGE_FILE=.coverage.py2
 
 [testenv:py3-cover]
 commands =
-    pip install pyramid_raml[testing]
-    coverage run --source=pyramid_raml {envbindir}/nosetests
+    pip install pyramlson[testing]
+    coverage run --source=pyramlson {envbindir}/nosetests
     coverage xml -o coverage-py3.xml
 setenv =
     COVERAGE_FILE=.coverage.py3