rack-graphql 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afa1d729bd08ddcda6bb8f5b0d6a64b7c4d339bb96abc34ae75840cb30c00175
-  data.tar.gz: a0fe1c3fb2b0aa9104f44db024305f98f9901567fd5f3765c8c5b5b76bd55c4e
+  metadata.gz: e69b413c11c9ffcfe8f71f6028e1705b1ce41866f534b8f5a334b250e62555d4
+  data.tar.gz: 802e055347ec762a5d8d2fe7bb21a1cfa550bdf1025252c1b4d64223fc34773e
 SHA512:
-  metadata.gz: 2793fd223e882a6e91f4389d65dd9a95e4ec40df68c77d11392599c1775ec04228287a797781e01c41dba5d4972fd5ac13b03346c6e78a87b7cd99467d3e5c32
-  data.tar.gz: f4feff581c4ea565a2bb5672a45fd6aac01d7f8cd4962b53eecab128ba41e81b66e931deb28615dcaef4e53ca58fd766be7230d904dd03ac8be3524add09d24c
+  metadata.gz: d1287d8512398086dc312be90fa689abf0107afa9503b871570d4185e670033e9bc5f7c970ee5d2cf0e4074f681dcd7a83fc1559256df6a8d6d5aeed7ba6cf42
+  data.tar.gz: 46d1ea9285fcc9fee9db13e7374539361bca874474086dec3fd98b2d09a4df54015fc96e5d3bb47abedbfaa5ada2caa6f4bc01926c11807457033de9929ff729

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-graphql (0.2.0)
+    rack-graphql (0.3.0)
       graphql (>= 1.9.0)
       multi_json
       rack (>= 2.0.0)

data/README.md

@@ -3,9 +3,11 @@
 
 # rack-graphql
 
-Rack middleware implementing graphql endpoint for ruby (non-`ActionController`) services. It uses pure rack and none of `ActionController` or `Sinatra` is required. By default it implements health route on `/health` and `/`, since it's only expected to be used on graphql-only services.
+`rack-graphql` is designed to build ruby services with graphql api. It provides `/graphql` endpoint and can handle [subscriptions](https://graphql-ruby.org/guides#subscriptions-guides) and [multiplex](https://graphql-ruby.org/queries/multiplex.html).
 
-It also handles [subscriptions](https://graphql-ruby.org/guides#subscriptions-guides) and [multiplex](https://graphql-ruby.org/queries/multiplex.html).
+It works on pure rack and none of `ActionController`/`ActionDispatch`/`ActionPack` or `Sinatra` is required.
+
+It can be used together with rails to not make graphql requests be routed with `ActionDispatch` or more pure ruby apps.
 
 ## Installation
 
@@ -17,18 +19,16 @@ gem 'rack-graphql'
 
 ## Usage example
 
-Add to your `config.ru` file
+Add following to your `config.ru` file:
 
 ```ruby
-run RackGraphql::Application.call(                    
-  schema: YourGraqphqlSchema,                 # required
-  app_name: 'your-service-name',              # optional, used for health route
-  context_handler: YourGraphqlContextHandler, # optional, empty proc by default
-  health_route: true,                     # optional, true by default
+run RackGraphql::Application.call(
+  schema: YourGraqphqlSchema,                # required
+  context_handler: YourGraphqlContextHandler # optional, empty `proc` by default
 )
 ```
 
-`context_handler` can be a class, object or proc. It only must respond to `call` merhod taking `env` as an argument. It is supposed to decode request properties to graphql context (eg. jwt token to user object, as shown below).
+`context_handler` can be a class, object or proc. It must respond to `call` method taking `env` as an argument. It is supposed to decode or transform request properties to graphql context (eg. jwt token to user object, as shown on an example below).
 
 ### Example: using context handler for JWT authentication
 
@@ -61,7 +61,7 @@ class GraphqlContextHandler
       return unless payload
       return unless payload['user_id']
 
-      UserRepo.find_by_id(payload['user_id])
+      UserRepo.find_by_id(payload['user_id'])
     end
   end
 end

data/lib/rack-graphql.rb

@@ -3,6 +3,5 @@ require 'rack'
 require 'graphql'
 
 require 'rack_graphql/version'
-require 'rack_graphql/health_response_builder'
 require 'rack_graphql/middleware'
 require 'rack_graphql/application'

data/lib/rack_graphql/application.rb

@@ -1,20 +1,10 @@
 module RackGraphql
   class Application
-    def self.call(schema:, app_name: 'rack-graphql-service', context_handler: nil, health_route: true)
+    def self.call(schema:, context_handler: nil)
       ::Rack::Builder.new do
         map '/graphql' do
           run RackGraphql::Middleware.new(schema: schema, context_handler: context_handler)
         end
-
-        if health_route
-          map '/health' do
-            run ->(env) { RackGraphql::HealthResponseBuilder.new(app_name: app_name).build }
-          end
-
-          map '/' do
-            run ->(env) { RackGraphql::HealthResponseBuilder.new(app_name: app_name).build }
-          end
-        end
       end
     end
   end

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -160,7 +160,6 @@ files:
 - lib/rack-graphql.rb
 - lib/rack_graphql.rb
 - lib/rack_graphql/application.rb
-- lib/rack_graphql/health_response_builder.rb
 - lib/rack_graphql/middleware.rb
 - lib/rack_graphql/version.rb
 - rack-graphql.gemspec

data/lib/rack_graphql/health_response_builder.rb

@@ -1,29 +0,0 @@
-module RackGraphql
-  class HealthResponseBuilder
-    def initialize(app_name:)
-      @app_name = app_name
-    end
-
-    def build
-      [200, headers, [body]]
-    end
-
-    private
-
-    attr_reader :app_name
-
-    def headers
-      { 'Content-Type' => 'application/json' }
-    end
-
-    def body
-      MultiJson.dump(
-        status:   :ok,
-        app_name: app_name,
-        env:      ENV['RACK_ENV'],
-        host:     ENV['HOSTNAME'],
-        revision: ENV['REVISION']
-      )
-    end
-  end
-end