graphql_server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea7e41d5079cadfd0e82b88bc6b3fc3d4f9650e4e35d6791a974d4a74f98e856
+  data.tar.gz: 0d7510f53f3c12e69edb84a2f7c3b7f030963d61a124abde624ff7afbd4c0305
+SHA512:
+  metadata.gz: 6339904a26acca60b5e16fd6bff3b6da87cf61a12c224f00e9702e3b02a344183e9a6154e6fc6fbeb5b49162d06019480832b45db843221146e6fbe9b86361c6
+  data.tar.gz: 873be8b072f5fd36174fcdbbf9fee36a51803bec80774bf811060bf70094e536469ed6a53f68ecefc4eac4927df6c157790dd402f38d1dfe9f45c0d603bdbfce

data/README.md

@@ -0,0 +1,80 @@
+This is a simple spec-compliant GraphQL rack application and middleware based on the [graphql](https://github.com/rmosolgo/graphql-ruby) gem. Since it's built with Rack, it can be mounted with most ruby web servers.
+
+Install the gem:
+
+```
+gem install graphql-server
+```
+
+# Using the server
+
+## As a standalone application
+
+```ruby
+# app.ru
+require 'graphql_server'
+
+type_def = <<-GRAPHQL
+  type Query {
+    hello: String
+  }
+GRAPHQL
+
+resolver = {
+  "Query" => {
+    "hello" => Proc.new { "world" }
+  }
+}
+
+run GraphqlServer.new(type_def: type_def, resolver: resolver)
+```
+
+Start using `rackup`
+
+```
+rackup app.ru
+```
+
+## As a middleware in your application
+
+```ruby
+# app.ru
+require 'graphql_server'
+
+type_def = ...
+resolver = ...
+
+use GraphqlServer, type_def: type_def, resolver: resolver, path: '/graphql'
+```
+
+Start using `rackup`
+
+```
+rackup app.ru
+```
+
+# Options
+
+## Schema
+
+You can get started fast by writing a type defintions and a resolver hash
+
+```ruby
+GraphqlServer.new(type_def: type_def, resolver: resolver)
+```
+
+You can also provide your own schema
+
+```ruby
+GraphqlServer.new(schema: schema)
+```
+
+See the examples folder for more details
+
+## Middleware
+
+When using as a middleware, you can specify the path to mount the graphql endpoint (defaults to `/`)
+
+```ruby
+use GraphqlServer, type_def: type_def, resolver: resolver, path: '/graphql'
+```

data/lib/graphql_server.rb

@@ -0,0 +1,63 @@
+require 'graphql'
+require 'json'
+require 'rack'
+
+class GraphqlServer
+  class InvalidRequestTypeError < Exception; end;
+  class PostBodyMissing < Exception; end;
+
+  # Initilizes GraphqlServer as a Rack app or middleware
+  #
+  # This Rack middleware (or app) implements a spec-compliant GraphQL server which can be queried from any GraphQL client.
+  # It can be used with a provided GraphQL schema or can build one from a type definition and a resolver hash.
+  #
+  # @param [Array<Object>] *args The first argument should be `app` when used as a middleware
+  # @param String path Also for middleware, we will use path to determine when to process GraphQL, defaults to '/'
+  # @param String type_def A schema definition string, or a path to a file containing the definition
+  # @param Hash resolver A hash with callables for handling field resolution
+  # @param GraphQL::Schema schema Use this schema if `type_def` and `resolver` is nil
+  # @param Hash context
+  def initialize(*args , path: nil, type_def: nil, resolver: nil, schema: nil, context: nil)
+    @app = args && args[0]
+    @context = context
+    @path = (@app && !path) ? '/' : path
+    @schema = type_def && resolver ? GraphQL::Schema.from_definition(type_def, default_resolve: resolver) : schema
+  end
+
+  def middleware?
+    !@app.nil?
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+
+    # only resolve when url matches `path` if we're in a middleware
+    return @app.call(env) if middleware? && @path != request.path_info
+    
+    # graphql accepts GET and POST requests
+    raise InvalidRequestTypeError unless request.get? || request.post?
+
+    payload = if request.get?
+      request.params
+    elsif request.post?
+      body = request.body.read
+      raise PostBodyMissing if body.empty?
+      payload = JSON.parse(body)
+    end
+
+    response = @schema.execute(
+      payload['query'], 
+      variables: payload['variables'],
+      operation_name: payload['operationName'],
+      context: @context, 
+    ).to_json
+    
+    [200, {'Content-Type' => 'application/json', 'Content-Length' => response.bytesize.to_s}, [response]]
+  rescue InvalidRequestTypeError
+    # Method Not Allowed
+    [405, {"Content-Type" => "text/html"}, ["GraphQL Server supports only GET/POST requests"]]
+  rescue PostBodyMissing
+    # Bad Request
+    [400, {"Content-Type" => "text/html"}, ["POST body missing"]]
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: graphql_server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- betaflag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A simple spec-compliant GraphQL rack application and middleware
+email: hello@betaflag.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/graphql_server.rb
+homepage: https://github.com/betaflag/graphql-server-ruby
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A simple spec-compliant GraphQL rack application and middleware
+test_files: []