graphql-persisted_documents 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4705b7ffafbf43fd6313d0dc28eab8bec977b5ce
+  data.tar.gz: 9a90cfbd553bcc4d473afe7cd194bb0959519f9f
+SHA512:
+  metadata.gz: be981aae45332255e1b938344c8612b3178a16c497d3c33ad788c7d788d6cb7125dec48093c353b1637ca7e48e4cef8dba5aaec609df1d634a636441fd383490
+  data.tar.gz: df1dec550f99cc3231aadd5dcca47148da219a43ab97bdc66492ea8a6eec596d2d03013d67ad04278fd8d6aa17a3252e34023751550b810049262aad665abed5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mgiroux0@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-persisted_documents.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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.

data/README.md

@@ -0,0 +1,133 @@
+# Graphql::PersistedDocuments
+
+### What is a GraphQL Document ?
+
+From the GraphQL spec:
+
+> A GraphQL document is defined as a syntactic grammar where terminal symbols are tokens (indivisible lexical units). These tokens are defined in a lexical grammar which matches patterns of source characters (defined by a double‐colon ::)
+
+### Persisted Documents
+
+In most client side applications, the GraphQL requests are static. There is a limited set of them in an app and they chances are they wont change during the lifetime of the app. If they are not going to change, why not cache them server side, and simply call them by an id instead of sending a potentially huge query server side each time ?
+
+This is what Graphql::PersistedDocuments allows you to do. At build time / deploy time, a client side can send all it's documents to a special endpoint, called `/persist` in this case. The GraphQL backend simply returns a `document_id` which allows every client side running application to call the server using an id instead of a full query_stirng.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-persisted_documents'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-persisted_documents
+
+## Usage
+
+`GraphQL::PersistedDocuments` is simply a Rack Middleware defined as `Graphql::PersistedDocuments::Rack`. To use it in Rails for example:
+
+```ruby
+module YourApp
+  class Application < Rails::Application
+
+    # ...
+
+    # Rails 3/4
+    config.middleware.insert_before 0, "Graphql::PersistedDocuments::Rack"
+
+    # Rails 5
+    config.middleware.insert_before 0, Rack::Cors
+  end
+end
+```
+
+## Configuring
+
+The middleware currently required two things to be defined in the config:
+
+  - `config.schema`: A GraphQL Schema, defined by the `graphql` gem.
+  - `config.persit_validated_document`: An object that responds to `call`, which returns an id in exchange of a parsed GraphQL Document.
+
+To configure, for example in a Rails app:
+
+```ruby
+Graphql::PersistedDocuments.configure do |config|
+  config.schema = ShopSchema
+  config.persist_validated_document = lambda do |document|
+    uuid = SecureRandom.uuid
+    Rails.cache.write(uuid, document)
+    uuid
+  end
+end
+```
+
+## Using with Rails
+
+When using with `rails` and `graphql` gems. We can simply accept a `document_id` as a param, as well as the standard `query` param.
+
+If we receive a `document_id`, we can retrieve that id from a store, cache, database, depending on how you implemented `persist_validated_document`.
+
+Example controller:
+
+
+```ruby
+class GraphqlController < ApplicationController
+  def execute
+    query_string = params[:query]
+    document_id = params[:document_id]
+    variables = params[:variables]
+
+    raise SomeGraphQLError unless query_string || document_id
+
+    if document_id
+      result = execute_from_persisted_document(document_id, variables)
+    else
+      result = execute_from_query_string(query_string, variables)
+    end
+
+    render json: result
+  end
+
+  private
+
+  def execute_from_query_string(query_string, variables)
+    MySchema.execute(query_string, variables: variables)
+  end
+
+  def execute_from_persisted_document(document_id, variables)
+    persisted_document = get_persisted_document(document_id)
+    MySchema.execute(document: persisted_document, variables: variables)
+  end
+
+  def get_persisted_document(document_id)
+    Rails.cache.fetch(document_id)
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xuorig/graphql-persisted_documents. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## TODO
+
+  - [ ] Better error messages
+  - [ ] Allow custom path
+  - [ ] Add unit tests for persister
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/persisted_documents"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-persisted_documents.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/persisted_documents/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-persisted_documents"
+  spec.version       = Graphql::PersistedDocuments::VERSION
+  spec.authors       = ["Marc-Andre Giroux"]
+  spec.email         = ["mgiroux0@gmail.com"]
+
+  spec.summary       = %q{Persisted GraphQL documents for Rack applications}
+  spec.description   = %q{Rack middleware enabling an endpoint to persist GraphQL documents}
+  spec.homepage      = "http://mgiroux.me"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "graphql", "~> 0.17.2"
+
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rack-test", "~> 0.6.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/graphql/persisted_documents.rb

@@ -0,0 +1,21 @@
+require "graphql"
+
+require "graphql/persisted_documents/configuration"
+require "graphql/persisted_documents/version"
+require "graphql/persisted_documents/rack"
+require "graphql/persisted_documents/persister"
+
+module Graphql
+  module PersistedDocuments
+    @configuration = Configuration.new
+
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        @configuration ||= Configuration.new
+        yield(configuration) if block_given?
+      end
+    end
+  end
+end

data/lib/graphql/persisted_documents/configuration.rb

@@ -0,0 +1,17 @@
+module Graphql
+  module PersistedDocuments
+    class Configuration
+      DEFAULT_PATH = '/persist'
+
+      attr_accessor(
+        :schema,
+        :persist_validated_document,
+        :path
+      )
+
+      def initialize
+        @path = DEFAULT_PATH
+      end
+    end
+  end
+end

data/lib/graphql/persisted_documents/persister.rb

@@ -0,0 +1,46 @@
+module Graphql
+  module PersistedDocuments
+    class Persister
+      InvalidDocument = Class.new(StandardError)
+      MissingPersistValidatedDocument = Class.new(StandardError)
+      ParseError = Class.new(StandardError)
+
+      attr_reader :query_string, :errors
+
+      def initialize(query_string)
+        @query_string = query_string
+        @errors = []
+      end
+
+      def persist!
+        document = GraphQL.parse(query_string)
+        query = GraphQL::Query.new(config.schema, document: document)
+        perform_validation(query)
+
+        raise InvalidDocument unless errors.empty?
+
+        user_persister = config.persist_validated_document
+        return user_persister.call(document) if user_persister
+
+        raise MissingPersistValidatedDocument
+      rescue GraphQL::ParseError
+        raise ParseError
+      end
+
+      private
+
+      def perform_validation(query)
+        validation_result = validator.validate(query)
+        @errors = validation_result[:errors]
+      end
+
+      def config
+        PersistedDocuments.configuration
+      end
+
+      def validator
+        GraphQL::StaticValidation::Validator.new(schema: config.schema)
+      end
+    end
+  end
+end

data/lib/graphql/persisted_documents/rack.rb

@@ -0,0 +1,47 @@
+module Graphql
+  module PersistedDocuments
+    class Rack
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env['PATH_INFO'] == PersistedDocuments.configuration.path
+          request = ::Rack::Request.new(env)
+          document = request.params['document']
+
+          unless document
+            return error_response(422, ['Missing required argument document'])
+          end
+
+          persister = Persister.new(document)
+          document_id = persister.persist!
+
+          [
+            '200',
+            {'Content-Type' => 'application/json'},
+            [ { document_id: document_id }.to_json ]
+          ]
+        else
+          @app.call(env)
+        end
+      rescue Persister::ParseError
+        error_response(422, ['Unable to parse document'])
+      rescue Persister::InvalidDocument
+        error_response(422, persister.errors)
+      rescue Persister::MissingPersistValidatedDocument
+        error_response(400, ['persist_validated_document must be defined in config'])
+      end
+
+      private
+
+      def error_response(code, errors)
+        [
+          code,
+          {'Content-Type' => 'application/json'},
+          [ { errors: errors }.to_json ]
+        ]
+      end
+    end
+  end
+end

data/lib/graphql/persisted_documents/version.rb

@@ -0,0 +1,5 @@
+module Graphql
+  module PersistedDocuments
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: graphql-persisted_documents
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc-Andre Giroux
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Rack middleware enabling an endpoint to persist GraphQL documents
+email:
+- mgiroux0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-persisted_documents.gemspec
+- lib/graphql/persisted_documents.rb
+- lib/graphql/persisted_documents/configuration.rb
+- lib/graphql/persisted_documents/persister.rb
+- lib/graphql/persisted_documents/rack.rb
+- lib/graphql/persisted_documents/version.rb
+homepage: http://mgiroux.me
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Persisted GraphQL documents for Rack applications
+test_files: []