Change GraphqlServer to GraphQLServer, removed path, code style

Author: betaflag

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## v0.1.0
+
+- Changed `GraphqlServer` class name to `GraphQLServer` to follow the graphql gem convention
+- Removed `path` as an option for middleware since it can be mapped with rack
+- Fix a few small issues with the code

README.md

@@ -26,7 +26,7 @@ resolver = {
   }
 }
 
-run GraphqlServer.new(type_def: type_def, resolver: resolver)
+run GraphQLServer.new(type_def: type_def, resolver: resolver)
 ```
 
 Start using `rackup`
@@ -44,7 +44,7 @@ require 'graphql_server'
 type_def = ...
 resolver = ...
 
-use GraphqlServer, type_def: type_def, resolver: resolver, path: '/graphql'
+use GraphQLServer, type_def: type_def, resolver: resolver
 ```
 
 # Options
@@ -54,21 +54,21 @@ use GraphqlServer, type_def: type_def, resolver: resolver, path: '/graphql'
 You can get started fast by writing a type defintions and a resolver hash
 
 ```ruby
-GraphqlServer.new(type_def: type_def, resolver: resolver)
+GraphQLServer.new(type_def: type_def, resolver: resolver)
 ```
 
 You can also provide your own [schema](http://graphql-ruby.org/schema/definition.html)
 
 ```ruby
-GraphqlServer.new(schema: schema)
+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 `/`)
+## Rack app Middleware
 
 ```ruby
-use GraphqlServer, type_def: type_def, resolver: resolver, path: '/graphql'
+map '/graphql'
+  use GraphQLServer, type_def: type_def, resolver: resolver
+end
 ```

examples/blog/app.ru

@@ -8,4 +8,4 @@ require_relative 'types/post_type'
 require_relative 'types/query_type'
 require_relative 'schema'
 
-run GraphqlServer.new(schema: Schema)
+run GraphQLServer.new(schema: Schema)

examples/hello_world_app/hello_world_app.ru

@@ -12,4 +12,4 @@ resolver = {
   }
 }
 
-run GraphqlServer.new(type_def: type_def, resolver: resolver)
+run GraphQLServer.new(type_def: type_def, resolver: resolver)

examples/hello_world_middleware/hello_world_middleware.ru

@@ -12,5 +12,8 @@ resolver = {
   }
 }
 
-use GraphqlServer, type_def: type_def, resolver: resolver, path: '/graphql'
+map '/graphql' do
+  use GraphQLServer, type_def: type_def, resolver: resolver
+end
+
 run ->(env) { [200, {"Content-Type" => "text/html"}, ["Hello World!"]] }

graphql_server.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'graphql_server'
-  s.version     = '0.0.1'
-  s.date        = '2019-01-18'
+  s.version     = '0.0.2'
+  s.date        = '2019-01-21'
   s.summary     = "A simple spec-compliant GraphQL rack application and middleware"
   s.description = "A simple spec-compliant GraphQL rack application and middleware"
   s.authors     = ["betaflag"]

lib/graphql_server.rb

@@ -2,25 +2,23 @@
 require 'json'
 require 'rack'
 
-class GraphqlServer
-  class InvalidRequestTypeError < Exception; end;
+class GraphQLServer
+  class InvalidRequestType < Exception; end;
   class PostBodyMissing < Exception; end;
 
-  # Initilizes GraphqlServer as a Rack app or middleware
+  # 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)
+  def initialize(*args, 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
 
@@ -30,19 +28,16 @@ def middleware?
 
   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?
+    raise InvalidRequestType 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)
+      JSON.parse(body)
     end
 
     response = @schema.execute(
@@ -53,7 +48,7 @@ def call(env)
     ).to_json
 
     [200, {'Content-Type' => 'application/json', 'Content-Length' => response.bytesize.to_s}, [response]]
-  rescue InvalidRequestTypeError
+  rescue InvalidRequestType
     # Method Not Allowed
     [405, {"Content-Type" => "text/html"}, ["GraphQL Server supports only GET/POST requests"]]
   rescue PostBodyMissing

test/graphql_server_test.rb

@@ -3,10 +3,9 @@
 
 require 'graphql_server'
 require 'rack/test'
-require 'graphql'
 require 'hello_world_server'
 
-describe GraphqlServer do
+describe GraphQLServer do
   include Rack::Test::Methods
 
   describe "app" do

test/hello_world_server.rb

@@ -14,7 +14,7 @@ def app
       }
 
       Rack::Builder.new do
-        run GraphqlServer.new(type_def: type_def, resolver: resolver)
+        run GraphQLServer.new(type_def: type_def, resolver: resolver)
       end
     end
 
@@ -32,7 +32,7 @@ def middleware(path = nil)
       }
 
       Rack::Builder.new do
-        use GraphqlServer, type_def: type_def, resolver: resolver, path: path
+        use GraphQLServer, type_def: type_def, resolver: resolver
         run [200]
       end
     end