rack-graphql 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e69b413c11c9ffcfe8f71f6028e1705b1ce41866f534b8f5a334b250e62555d4
-  data.tar.gz: 802e055347ec762a5d8d2fe7bb21a1cfa550bdf1025252c1b4d64223fc34773e
+  metadata.gz: f1f6210f9dd519a4d0126f0233030a78dd9bcaa7c3d461cbe0444dafb71b9390
+  data.tar.gz: aa3f41e2f0630c77f0863c29299dac49c1ac54ec35f43ce4c18b6725755c0955
 SHA512:
-  metadata.gz: d1287d8512398086dc312be90fa689abf0107afa9503b871570d4185e670033e9bc5f7c970ee5d2cf0e4074f681dcd7a83fc1559256df6a8d6d5aeed7ba6cf42
-  data.tar.gz: 46d1ea9285fcc9fee9db13e7374539361bca874474086dec3fd98b2d09a4df54015fc96e5d3bb47abedbfaa5ada2caa6f4bc01926c11807457033de9929ff729
+  metadata.gz: a873134d698b5e0841a38d81a8ea91c876b396f194b5774b4dbad66ce302b1fcc5cb16defefd71a41a445b37cf44b6202187f2528ad12dcc4820c57f1681dc03
+  data.tar.gz: 799751d5575822fe3a8553779ed4bd7a24d717344065b39d98c4cc9f7066e2d6432fc63caa02f4a435555e47fb61f0dc39f692e50f89e73ef4c6456010491b08

data/Gemfile.lock

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

data/README.md

@@ -5,7 +5,7 @@
 
 `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 works on pure rack and none of `ActionController`/`ActionDispatch`/`ActionPack` or `Sinatra` is required.
+It works on pure rack and none of `ActionController`/`ActionDispatch`/`ActionPack` or `Sinatra` is required. By default it provides health route on `/health` and `/`, which can be disabled.
 
 It can be used together with rails to not make graphql requests be routed with `ActionDispatch` or more pure ruby apps.
 
@@ -23,8 +23,10 @@ Add following to your `config.ru` file:
 
 ```ruby
 run RackGraphql::Application.call(
-  schema: YourGraqphqlSchema,                # required
-  context_handler: YourGraphqlContextHandler # optional, empty `proc` by default
+  schema: YourGraqphqlSchema,                 # required
+  app_name: 'your-service-name',              # optional, used for health endpoint content
+  context_handler: YourGraphqlContextHandler, # optional, empty `proc` by default
+  health_route: true,                         # optional, true by default
 )
 ```
 

data/lib/rack-graphql.rb

@@ -3,5 +3,6 @@ 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,10 +1,20 @@
 module RackGraphql
   class Application
-    def self.call(schema:, 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
+
+        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/health_response_builder.rb

@@ -0,0 +1,29 @@
+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

data/lib/rack_graphql/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -160,6 +160,7 @@ 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