graphql-persisted_documents 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4705b7ffafbf43fd6313d0dc28eab8bec977b5ce
-  data.tar.gz: 9a90cfbd553bcc4d473afe7cd194bb0959519f9f
+  metadata.gz: 88182d39575df6439d1f3a31327b67747c2de106
+  data.tar.gz: 1a3f507675a50d2b07681c34dc50fc4936ada5ee
 SHA512:
-  metadata.gz: be981aae45332255e1b938344c8612b3178a16c497d3c33ad788c7d788d6cb7125dec48093c353b1637ca7e48e4cef8dba5aaec609df1d634a636441fd383490
-  data.tar.gz: df1dec550f99cc3231aadd5dcca47148da219a43ab97bdc66492ea8a6eec596d2d03013d67ad04278fd8d6aa17a3252e34023751550b810049262aad665abed5
+  metadata.gz: 5ede97c6586c9294ff780ea232f495dbd3f719e4958b6fae74c81d18947ee28da2a2fab9f8b06c4563e5da3054228aa5bbd626575745ed43304e52d701d00512
+  data.tar.gz: 8db10fd68a72ff0192cae40aa39dedcbe22b228f64c8ab6bb30347c497b28749a937a9f40e802b01345d08d8deb010e9100172fab7710eebcd8a88d3a052e7fb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 
+
+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

@@ -1,19 +1,10 @@
 # Graphql::PersistedDocuments
+Short description and motivation.
 
-### 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.
+## Usage
+How to use my plugin.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -21,113 +12,17 @@ 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
+```bash
+$ bundle
 ```
 
-## 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
+Or install it yourself as:
+```bash
+$ gem install graphql-persisted_documents
 ```
 
-## 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
-
+Contribution directions go here.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,2 +1,37 @@
-require "bundler/gem_tasks"
-task :default => :spec
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Graphql::PersistedDocuments'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/graphql/persisted_documents/application_controller.rb

@@ -0,0 +1,6 @@
+module Graphql
+  module PersistedDocuments
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/controllers/graphql/persisted_documents/persisted_documents_controller.rb

@@ -0,0 +1,36 @@
+module Graphql
+  module PersistedDocuments
+    class PersistedDocumentsController < ApplicationController
+      def persist
+        document = params[:document]
+
+        unless document
+          render_errors(['Missing required argument document'], status: 422)
+          return
+        end
+
+        persister = Persister.new(document)
+        document_id = persister.persist
+
+        render json: { document_id: document_id }, status: :ok
+
+      rescue Persister::ParseError
+        render_errors(['Unable to parse document'], status: 422)
+      rescue Persister::InvalidDocumentError
+        render_errors(persister.errors, status: 422)
+      rescue Persister::MissingPersistValidatedDocumentError
+        render_errors(['persist_validated_document must be defined in config'])
+      end
+
+      private
+
+      def render_errors(messages, status: 400)
+        response = {
+          errors: messages.map { |msg| { message: msg } }
+        }
+
+        render json: response, status: status
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Graphql::PersistedDocuments::Engine.routes.draw do
+  post '/persist', to: 'persisted_documents#persist'
+end

data/lib/graphql/persisted_documents/engine.rb

@@ -0,0 +1,11 @@
+module Graphql
+  module PersistedDocuments
+    class Engine < ::Rails::Engine
+      isolate_namespace Graphql::PersistedDocuments
+
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+    end
+  end
+end

data/lib/graphql/persisted_documents/persister.rb

@@ -1,8 +1,8 @@
 module Graphql
   module PersistedDocuments
     class Persister
-      InvalidDocument = Class.new(StandardError)
-      MissingPersistValidatedDocument = Class.new(StandardError)
+      InvalidDocumentError = Class.new(StandardError)
+      MissingPersistValidatedDocumentError = Class.new(StandardError)
       ParseError = Class.new(StandardError)
 
       attr_reader :query_string, :errors
@@ -12,17 +12,17 @@ module Graphql
         @errors = []
       end
 
-      def persist!
+      def persist
         document = GraphQL.parse(query_string)
         query = GraphQL::Query.new(config.schema, document: document)
         perform_validation(query)
 
-        raise InvalidDocument unless errors.empty?
+        raise InvalidDocumentError unless errors.empty?
 
         user_persister = config.persist_validated_document
         return user_persister.call(document) if user_persister
 
-        raise MissingPersistValidatedDocument
+        raise MissingPersistValidatedDocumentError
       rescue GraphQL::ParseError
         raise ParseError
       end
@@ -31,7 +31,8 @@ module Graphql
 
       def perform_validation(query)
         validation_result = validator.validate(query)
-        @errors = validation_result[:errors]
+        validation_errors = validation_result[:errors] || []
+        @errors = validation_errors.map { |error| error["message"] }
       end
 
       def config

data/lib/graphql/persisted_documents/version.rb

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

data/lib/graphql/persisted_documents.rb

@@ -1,8 +1,5 @@
-require "graphql"
-
 require "graphql/persisted_documents/configuration"
-require "graphql/persisted_documents/version"
-require "graphql/persisted_documents/rack"
+require "graphql/persisted_documents/engine"
 require "graphql/persisted_documents/persister"
 
 module Graphql

data/lib/tasks/graphql/persisted_documents_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :graphql_persisted_documents do
+#   # Task goes here
+# end

data/spec/controllers/persisted_documents_controller_spec.rb

@@ -0,0 +1,85 @@
+require "rails_helper"
+
+describe Graphql::PersistedDocuments::PersistedDocumentsController do
+  routes { Graphql::PersistedDocuments::Engine.routes }
+
+  describe "POST persist" do
+    before do
+      Graphql::PersistedDocuments.configure do |config|
+        config.schema = TestSchema
+        config.persist_validated_document = lambda do |document|
+          'yolo-swag'
+        end
+      end
+    end
+
+    it "parses, validates and persists a document" do
+      post :persist, params: { document: 'query { validField }' }
+
+      expect(response.code).to eq("200")
+      expect(response.body).to eq({
+        document_id: 'yolo-swag'
+      }.to_json)
+    end
+
+
+    context "when no params are passed in" do
+      it "responds with an error" do
+        post :persist, params: {}
+
+        expect(response.code).to eq("422")
+        expect(response.body).to eq({
+          errors: [{
+            message: "Missing required argument document"
+          }]
+        }.to_json)
+      end
+    end
+
+    context "when the document is not parsable" do
+      it "responds with an error" do
+        post :persist, params: { document: "query {" }
+
+        expect(response.code).to eq("422")
+        expect(response.body).to eq({
+          errors: [{
+            message: "Unable to parse document"
+          }]
+        }.to_json)
+      end
+    end
+
+    context "when the document is invalid according to schema" do
+      it "responds with an error" do
+        post :persist, params: { document: "query { invalidField }" }
+
+        expect(response.code).to eq("422")
+        expect(response.body).to eq({
+          errors: [{
+            message: "Field 'invalidField' doesn't exist on type 'Query'"
+          }]
+        }.to_json)
+      end
+    end
+
+    context "when the persist_validated_document fn is not set" do
+      before do
+        Graphql::PersistedDocuments.configure do |config|
+          config.schema = TestSchema
+          config.persist_validated_document = nil
+        end
+      end
+
+      it "responds with an error" do
+        post :persist, params: { document: "query { validField }" }
+
+        expect(response.code).to eq("400")
+        expect(response.body).to eq({
+          errors: [{
+            message: "persist_validated_document must be defined in config"
+          }]
+        }.to_json)
+      end
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link graphql_persisted_documents_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,15 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "graphql/persisted_documents"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end
+