Merge pull request #10 from KingDarBoja/webob-graphql-v3

chore: use graphql-server to re-export webob

.gitignore

@@ -1,10 +1,204 @@
-*.pyc
-.idea
-.cache
-.tox
+
+# Created by https://www.gitignore.io/api/python,intellij+all,visualstudiocode
+# Edit at https://www.gitignore.io/?templates=python,intellij+all,visualstudiocode
+
+### Intellij+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
 *.egg
-*.egg-info
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.venv/
 .coverage
-/build/
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+### VisualStudioCode ###
+.vscode
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
 
-/dist/
+# End of https://www.gitignore.io/api/python,intellij+all,visualstudiocode

.travis.yml

@@ -1,25 +1,21 @@
 language: python
 sudo: false
-matrix:
-  include:
-  - python: pypy
-    env: TOX_ENV=pypy
-  - python: '2.7'
-    env: TOX_ENV=py27
-  - python: '3.5'
-    env: TOX_ENV=py35
-  - python: '3.6'
-    env: TOX_ENV=py36,import-order,flake8
-cache:
-  directories:
-  - $HOME/.cache/pip
-  - $TRAVIS_BUILD_DIR/.tox
+python:
+  - 3.6
+  - 3.7
+  - 3.8
+cache: pip
+
 install:
-- pip install tox coveralls
+  - pip install tox-travis
+
 script:
-- tox -e $TOX_ENV -- --cov=webob_graphql
+  - tox
+
 after_success:
-- coveralls
+  - pip install coveralls
+  - coveralls
+
 deploy:
   provider: pypi
   user: syrusakbary

MANIFEST.in

@@ -1,3 +1,10 @@
+include LICENSE
 include README.md
-recursive-include webob_graphql/static *
-recursive-include webob_graphql/templates *
+
+include tox.ini
+include Makefile
+
+recursive-include webob_graphql *.py
+recursive-include tests *.py
+
+global-exclude *.py[co] __pycache__

Makefile

@@ -0,0 +1,5 @@
+dev-setup:
+	python pip install -e ".[test]"
+
+tests:
+	py.test tests --cov=webob_graphql -vv

README.md

@@ -4,49 +4,53 @@
 
 Adds GraphQL support to your WebOb (Pyramid, Pylons, ...) application.
 
-## Installation
-
-For instaling WebOb-GraphQL, just run this command in your shell
-
-```bash
-pip install "webob-graphql>=1.0.dev"
-```
-
-
 ## Usage
 
-Just use the `serve_graphql_request` function from `webob_graphql`
-
+Use the `GraphQLView` view from `webob_graphql`
 
 ### Pyramid
 
 ```python
+from wsgiref.simple_server import make_server
 from pyramid.view import view_config
 
 from webob_graphql import serve_graphql_request
 
+from schema import schema
 
-@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):
-    context = {'session': request.session}
-    return serve_graphql_request(request, schema, context_value=context)
-
-    # Optional, for adding batch query support (used in Apollo-Client)
-    return serve_graphql_request(request, schema, batch_enabled=True, context_value=context)
+    return GraphQLView(request=request, schema=schema, graphiql=True).dispatch_request(request)
+
+if __name__ == '__main__':
+    with Configurator() as config:
+        config.add_route('graphql', '/graphql')
+        config.add_view(graphql_view, route_name='graphql')
+        app = config.make_wsgi_app()
+    server = make_server('0.0.0.0', 6543, app)
+    server.serve_forever()
 ```
+This will add `/graphql` endpoint to your app and enable the GraphiQL IDE.
+
+### Supported options for GraphQLView
 
-### Supported options
  * `schema`: The `GraphQLSchema` object that you want the view to execute when it gets a valid request.
- * `context_value`: A value to pass as the `context` to the `graphql()` function.
- * `root_value`: The `root_value` you want to provide to `executor.execute`.
- * `format_error`: If you want to use a custom error formatter.
+ * `context`: A value to pass as the `context_value` to graphql `execute` function. By default is set to `dict` with request object at key `request`.
+ * `root_value`: The `root_value` you want to provide to graphql `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).
- * `render_graphiql`: A custom function for rendering GraphiQL (this function should have the arguments `result` and `params`).
- * `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))
+ * `graphiql`: If `True`, may present [GraphiQL](https://github.com/graphql/graphiql) when loaded directly from a browser (a useful tool for debugging and exploration).
+ * `graphiql_version`: The graphiql version to load. Defaults to **"1.0.3"**.
+ * `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
+ * `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
+ * `batch`: Set the GraphQL view as batch (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))
+ * `middleware`: A list of graphql [middlewares](http://docs.graphene-python.org/en/latest/execution/middleware/).
+ * `encode`: the encoder to use for responses (sensibly defaults to `graphql_server.json_encode`).
+ * `format_error`: the error formatter to use for responses (sensibly defaults to `graphql_server.default_format_error`.
+ * `enable_async`: whether `async` mode will be enabled.
+ * `subscriptions`: The GraphiQL socket endpoint for using subscriptions in graphql-ws.
+ * `headers`: An optional GraphQL string to use as the initial displayed request headers, if not provided, the stored headers will be used.
+ * `default_query`: An optional GraphQL string to use when no query is provided and no stored query exists from a previous session. If not provided, GraphiQL will use its own default query.
+* `header_editor_enabled`: An optional boolean which enables the header editor when true. Defaults to **false**.
+* `should_persist_headers`:  An optional boolean which enables to persist headers to storage when true. Defaults to **false**.
+
+## Contributing
+Since v3, `webob-graphql` code lives at [graphql-server](https://github.com/graphql-python/graphql-server) repository to keep any breaking change on the base package on sync with all other integrations. In order to contribute, please take a look at [CONTRIBUTING.md](https://github.com/graphql-python/graphql-server/blob/master/CONTRIBUTING.md).