rack-graphql 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bacf440a72a93e3a15d93d3250673e3e881a7b9c00baeb23a3b492a7bd173726
-  data.tar.gz: b025f5b71e3523a9cb420eeb7e84b32244e7b8b2733e2e9233534e7fd15b3235
+  metadata.gz: afa1d729bd08ddcda6bb8f5b0d6a64b7c4d339bb96abc34ae75840cb30c00175
+  data.tar.gz: a0fe1c3fb2b0aa9104f44db024305f98f9901567fd5f3765c8c5b5b76bd55c4e
 SHA512:
-  metadata.gz: 37c256d2391cd25a8100885dc46bd7fe09b43441204f8f6265664663759c0bfe5e0329f59e421181074f8153d4eb4f778f6eeb27353053b79608cf5e596c0271
-  data.tar.gz: 017c9499ad224dd3ff714f4f28438c69298be871222ed2a639e5ce4bab3f2207b8c645dd3164ddd0628a300d30f6dde84d1a85aebd6bbaec63f64a5ac9c5ca33
+  metadata.gz: 2793fd223e882a6e91f4389d65dd9a95e4ec40df68c77d11392599c1775ec04228287a797781e01c41dba5d4972fd5ac13b03346c6e78a87b7cd99467d3e5c32
+  data.tar.gz: f4feff581c4ea565a2bb5672a45fd6aac01d7f8cd4962b53eecab128ba41e81b66e931deb28615dcaef4e53ca58fd766be7230d904dd03ac8be3524add09d24c

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,11 @@
-[![Gem Version](https://badge.fury.io/rb/rack-pagination.svg)](https://rubygems.org/gems/rack-graphql)
-[![Build Status](https://travis-ci.org/RenoFi/rack-pagination.svg?branch=master)](https://travis-ci.org/RenoFi/rack-graphql)
+[![Gem Version](https://badge.fury.io/rb/rack-graphql.svg)](https://rubygems.org/gems/rack-graphql)
+[![Build Status](https://travis-ci.org/RenoFi/rack-graphql.svg?branch=master)](https://travis-ci.org/RenoFi/rack-graphql)
 
 # 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.
+
+It also handles [subscriptions](https://graphql-ruby.org/guides#subscriptions-guides) and [multiplex](https://graphql-ruby.org/queries/multiplex.html).
 
 ## Installation
 
@@ -14,6 +17,55 @@ gem 'rack-graphql'
 
 ## Usage example
 
+Add 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
+)
+```
+
+`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).
+
+### Example: using context handler for JWT authentication
+
+```ruby
+class GraphqlContextHandler
+  class << self
+    def call(env)
+      payload = decode_payload(env)
+
+      graphql_context_hash(payload)
+    end
+
+    private
+
+    def graphql_context_hash(payload)
+      {
+        current_user: current_user(payload)
+      }
+    end
+
+    def decode_payload(env)
+      jwt = env["HTTP_AUTHORIZATION"].to_s.split(' ').last
+
+      return if jwt.blank?
+
+      DecodeJwt.call(jwt) || {}
+    end
+
+    def current_user(payload)
+      return unless payload
+      return unless payload['user_id']
+
+      UserRepo.find_by_id(payload['user_id])
+    end
+  end
+end
+```
 
 ## Contributing
 

data/lib/rack_graphql/application.rb

@@ -1,17 +1,19 @@
 module RackGraphql
   class Application
-    def self.call(schema:, app_name: 'rack-graphql-service', context_handler: nil)
+    def self.call(schema:, app_name: 'rack-graphql-service', context_handler: nil, health_route: true)
       ::Rack::Builder.new do
         map '/graphql' do
           run RackGraphql::Middleware.new(schema: schema, context_handler: context_handler)
         end
 
-        map '/health' do
-          run ->(env) { RackGraphql::HealthResponseBuilder.new(app_name: app_name).build }
-        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 }
+          map '/' do
+            run ->(env) { RackGraphql::HealthResponseBuilder.new(app_name: app_name).build }
+          end
         end
       end
     end

data/lib/rack_graphql/version.rb

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

data/rack-graphql.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.4'
+
   spec.add_dependency 'graphql', '>= 1.9.0'
   spec.add_dependency 'multi_json'
   spec.add_dependency 'rack', '>= 2.0.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -178,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="