First version of webob_graphql

Author: syrusakbary

.gitignore

@@ -0,0 +1,10 @@
+*.pyc
+.idea
+.cache
+.tox
+*.egg
+*.egg-info
+.coverage
+/build/
+
+/dist/

.travis.yml

@@ -0,0 +1,31 @@
+language: python
+sudo: false
+matrix:
+  include:
+  - python: pypy
+    env: TOX_ENV=pypy
+  - python: '2.7'
+    env: TOX_ENV=py27
+  - python: '3.3'
+    env: TOX_ENV=py33
+  - python: '3.4'
+    env: TOX_ENV=py34
+  - python: '3.5'
+    env: TOX_ENV=py35,import-order,flake8
+cache:
+  directories:
+  - $HOME/.cache/pip
+  - $TRAVIS_BUILD_DIR/.tox
+install:
+- pip install tox coveralls
+script:
+- tox -e $TOX_ENV -- --cov=webob_graphql
+after_success:
+- coveralls
+deploy:
+  provider: pypi
+  user: syrusakbary
+  on:
+    tags: true
+  password:
+    secure: GB3YHihKAbmfh9kzMxzsZQDMf5h1aIJYwESfaYMc4DjMA1Qms+ZhBN2RiH3irwJ6FW47ZsS/O6ZsrlNxu75J/Mc1NJfzFev1d0xt7cYp+s0umYHhheelR6wmP8KOt3ugK7qmWuk5bykljpxsRKzKJCvGH+LOM7mDQy3NZOfYPTAM2znWjuBr+X4iUv6pUCKk5N20GBbs9T+jNttE7K8TH4zuXCWxgbE7xVHth76pB5Q/9FZkB8hZQ7K2esO3QyajDO7FzsOk8Z/jXRJ3MOxZCI3vGgmSzKTH4fMqmSrtyr1sCaBO5tgS8ytqQBjsuV1vIWl+75bXrAXfdkin63zMne4Rsb+uSWj3djP+iy2yML8a2mWMizxr803v8lwaGnMZ26f4rwdZnHGUPlTp3geVKq23vidVTQwF8v2o1rHvtdD4KJ5Mi41TXAfnih3XUf+fCTXdbAXKqweDuhcZg09/r7U/6zo76wjnt1cePPZe63/xG6bAVQ+Gz1J+HZz55ofDZV9g9kwyNll4Jfdzj9hUHO8AfBMvXQJewRj/LbzbmbBp5peov+DFhx7TWofvqxjreVKxDiDN89pC+WKy5BwZMcpB3dRVGuZ25ZrENLgoTX7W4PHPb1+OF4edP6xM44egcJLamk7vhvpZQqukJGRQZFtIMw8KIkC7OWzpCFIXN08=

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Syrus Akbary
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+recursive-include webob_graphql/static *
+recursive-include webob_graphql/templates *

README.md

@@ -0,0 +1,41 @@
+# WebOb-GraphQL
+
+[![Build Status](https://travis-ci.org/graphql-python/webob-graphql.svg?branch=master)](https://travis-ci.org/graphql-python/webob-graphql) [![Coverage Status](https://coveralls.io/repos/graphql-python/webob-graphql/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-python/webob-graphql?branch=master) [![PyPI version](https://badge.fury.io/py/webob-graphql.svg)](https://badge.fury.io/py/webob-graphql)
+
+Adds GraphQL support to your WebOb application.
+
+## Usage
+
+Just use the `serve_graphql_request` function from `webob_graphql`
+
+
+### Pyramid
+
+```python
+from pyramid.view import view_config
+
+from webob_graphql import serve_graphql_request
+
+
+@view_config(
+    route_name='graphql',
+    # The serve_graphql_request method will detect what's the best renderer
+    # to use, so it will do the json render automatically.
+    # In summary, don't use the renderer='json' here :)
+)
+def graphql_view(request):
+    return serve_graphql_request(request, schema)
+
+	# Optional, for adding batch query support (used in Apollo-Client)
+    return serve_graphql_request(request, schema, batch_enabled=True)
+```
+
+### Supported options
+ * `schema`: The `GraphQLSchema` object that you want the view to execute when it gets a valid request.
+ * `context`: A value to pass as the `context` to the `graphql()` function.
+ * `root_value`: The `root_value` you want to provide to `executor.execute`.
+ * `pretty`: Whether or not you want the response to be pretty printed JSON.
+ * `executor`: The `Executor` that you want to use to execute queries.
+ * `graphiql_enabled`: If `True` (default), may present [GraphiQL](https://github.com/graphql/graphiql) when loaded directly from a browser (a useful tool for debugging and exploration).
+ * `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
+ * `batch_enabled`: Enable batch support (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))

README.rst

@@ -0,0 +1,64 @@
+WebOb-GraphQL
+=============
+
+|Build Status| |Coverage Status| |PyPI version|
+
+Adds GraphQL support to your WebOb application.
+
+Usage
+-----
+
+Just use the ``serve_graphql_request`` function from ``webob_graphql``
+
+Pyramid
+~~~~~~~
+
+.. code:: python
+
+    from pyramid.view import view_config
+
+    from webob_graphql import serve_graphql_request
+
+
+    @view_config(
+        route_name='graphql',
+        # The serve_graphql_request method will detect what's the best renderer
+        # to use, so it will do the json render automatically.
+        # In summary, don't use the renderer='json' here :)
+    )
+    def graphql_view(request):
+        return serve_graphql_request(request, schema)
+
+        # Optional, for adding batch query support (used in Apollo-Client)
+        return serve_graphql_request(request, schema, batch_enabled=True)
+
+Supported options
+~~~~~~~~~~~~~~~~~
+
+-  ``schema``: The ``GraphQLSchema`` object that you want the view to
+   execute when it gets a valid request.
+-  ``context``: A value to pass as the ``context`` to the ``graphql()``
+   function.
+-  ``root_value``: The ``root_value`` you want to provide to
+   ``executor.execute``.
+-  ``pretty``: Whether or not you want the response to be pretty printed
+   JSON.
+-  ``executor``: The ``Executor`` that you want to use to execute
+   queries.
+-  ``graphiql_enabled``: If ``True`` (default), may present
+   `GraphiQL <https://github.com/graphql/graphiql>`__ when loaded
+   directly from a browser (a useful tool for debugging and
+   exploration).
+-  ``graphiql_template``: Inject a Jinja template string to customize
+   GraphiQL.
+-  ``batch_enabled``: Enable batch support (for using in
+   `Apollo-Client <http://dev.apollodata.com/core/network.html#query-batching>`__
+   or
+   `ReactRelayNetworkLayer <https://github.com/nodkz/react-relay-network-layer>`__)
+
+.. |Build Status| image:: https://travis-ci.org/graphql-python/webob-graphql.svg?branch=master
+   :target: https://travis-ci.org/graphql-python/webob-graphql
+.. |Coverage Status| image:: https://coveralls.io/repos/graphql-python/webob-graphql/badge.svg?branch=master&service=github
+   :target: https://coveralls.io/github/graphql-python/webob-graphql?branch=master
+.. |PyPI version| image:: https://badge.fury.io/py/webob-graphql.svg
+   :target: https://badge.fury.io/py/webob-graphql

bin/autolinter

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Install the required scripts with
+# pip install autoflake autopep8 isort
+autoflake ./webob_graphql/ -r --remove-unused-variables --remove-all-unused-imports --in-place
+autopep8 ./webob_graphql/ -r --in-place --experimental --aggressive --max-line-length 120
+isort -rc ./webob_graphql/

bin/convert_documentation

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pandoc README.md --from markdown --to rst -s -o README.rst

setup.cfg

@@ -0,0 +1,9 @@
+[flake8]
+exclude = tests,scripts,setup.py,docs
+max-line-length = 160
+
+[isort]
+known_first_party=graphql
+
+[pytest]
+norecursedirs = venv .tox .cache

setup.py

@@ -0,0 +1,47 @@
+from setuptools import setup, find_packages
+
+required_packages = [
+    'graphql-core>=1.0',
+    'webob',
+    'graphql-server-core>=1.0.dev'
+]
+
+tests_require = [
+    'pytest>=2.7.3',
+    'mako'
+]
+
+setup(
+    name='WebOb-GraphQL',
+    version='1.0.dev20170404001',
+    description='Adds GraphQL support to your WebOb (Pyramid/Pylons/...) application',
+    long_description=open('README.rst').read(),
+    url='https://github.com/graphql-python/webob-graphql',
+    download_url='https://github.com/graphql-python/webob-graphql/releases',
+    author='Syrus Akbary',
+    author_email='me@syrusakbary.com',
+    license='MIT',
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: Implementation :: PyPy',
+        'License :: OSI Approved :: MIT License',
+    ],
+    keywords='api graphql protocol rest webob',
+    packages=find_packages(exclude=['tests']),
+    install_requires=required_packages,
+    extras_require={
+        'test': tests_require,
+    },
+    tests_require=tests_require,
+    include_package_data=True,
+    zip_safe=False,
+    platforms='any',
+)

tests/__init__.py

@@ -0,0 +1,38 @@
+from graphql.type.definition import GraphQLArgument, GraphQLField, GraphQLNonNull, GraphQLObjectType
+from graphql.type.scalars import GraphQLString
+from graphql.type.schema import GraphQLSchema
+
+
+def resolve_raises(*_):
+    raise Exception("Throws!")
+
+
+QueryRootType = GraphQLObjectType(
+    name='QueryRoot',
+    fields={
+        'thrower': GraphQLField(GraphQLNonNull(GraphQLString), resolver=resolve_raises),
+        'request': GraphQLField(GraphQLNonNull(GraphQLString),
+                                resolver=lambda obj, args, context, info: context.params.get('q')),
+        'context': GraphQLField(GraphQLNonNull(GraphQLString),
+                                resolver=lambda obj, args, context, info: context),
+        'test': GraphQLField(
+            type=GraphQLString,
+            args={
+                'who': GraphQLArgument(GraphQLString)
+            },
+            resolver=lambda obj, args, context, info: 'Hello %s' % (args.get('who') or 'World')
+        )
+    }
+)
+
+MutationRootType = GraphQLObjectType(
+    name='MutationRoot',
+    fields={
+        'writeTest': GraphQLField(
+            type=QueryRootType,
+            resolver=lambda *_: QueryRootType
+        )
+    }
+)
+
+schema = GraphQLSchema(QueryRootType, MutationRootType)

tests/schema.py

@@ -0,0 +1,65 @@
+import pytest
+
+from .schema import schema
+from .utils import url_string, response_json, j, jl, Client
+
+from webob_graphql.mako import render_graphiql as mako_render_graphiql
+
+
+@pytest.fixture
+def settings():
+    return {}
+
+
+@pytest.fixture
+def client(settings):
+    return Client(schema, settings)
+
+
+@pytest.fixture
+def pretty_response():
+    return (
+        '{\n'
+        '  "data": {\n'
+        '    "test": "Hello World"\n'
+        '  }\n'
+        '}'
+    ).replace('\"','\\\"').replace('\n', '\\n')
+
+
+def test_graphiql_is_enabled_by_default(client):
+    response = client.get(url_string(), headers={'Accept': 'text/html'})
+    assert response.status_code == 200
+    assert response.content_type == 'text/html'
+
+
+def test_graphiql_simple_renderer(client, pretty_response):
+    response = client.get(url_string(query='{test}'), headers={'Accept': 'text/html'})
+    assert response.status_code == 200
+    assert pretty_response in response.body.decode('utf-8')
+
+
+@pytest.mark.parametrize('settings', [dict(render_graphiql=mako_render_graphiql)])
+def test_graphiql_mako_renderer(client, pretty_response):
+    response = client.get(url_string(query='{test}'), headers={'Accept': 'text/html'})
+    assert response.status_code == 200
+    assert pretty_response in response.body.decode('utf-8')
+
+
+def test_graphiql_html_is_not_accepted(client):
+    response = client.get(url_string(), headers={'Accept': 'application/json'})
+    assert response.status_code == 400
+
+
+def test_graphiql_get_mutation(client, pretty_response):
+    query = 'mutation TestMutation { writeTest { test } }'
+    response = client.get(url_string(query=query), headers={'Accept': 'text/html'})
+    assert response.status_code == 200
+    assert 'response: null' in response.body.decode('utf-8')
+
+
+@pytest.mark.parametrize('settings', [dict(graphiql_enabled=False)])
+def test_graphiql_is_enabled_by_default(client):
+    response = client.get(url_string(query='{test}'), headers={'Accept': 'text/html'})
+    assert response.status_code == 200
+    assert response.content_type == 'application/json'