rack-graphql 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535af6fb2ace2236a1f0a4e9b9bebc2d7994faba89c00d360c2766df2b9ef6bf
-  data.tar.gz: ca6da432ed43fcd68aaaa5063dbd525ae47ef74bd4fd7ff489265475b9c1ec0f
+  metadata.gz: 96ec802b9de117754bdea93534b69eb47be05796d31ecc362d2c1ac32d4ab929
+  data.tar.gz: f87c56ccc52c047e35ebde5777e7a0ff171e61263c6e58fe1b7312be47e41561
 SHA512:
-  metadata.gz: 392778718046028d89a8a4ad817b8894100e556c337730681f7391b177d098144d7086971df9333607db846f482344fea6d663de782ff1fadb36c85851250e34
-  data.tar.gz: 26fa315ff80b03f38be308280245e1e90d92808a431062eeb72fd04d92d7c2d0d44c31c6dc27111f39251d6f67e57f6159a7603b8df33a09efad2b0025c71b07
+  metadata.gz: 2637be8f7dc262397347f60d89133cbfb354c3943b7b2e16343bf2ec26cb2ffd127eedfb0a0d255cc29fadff3c02005373539e2325b300b655f000ad6f55dbac
+  data.tar.gz: 4edf965d3d98f562618479721323adffc7093bdb34efeba9e495af8157e3690855f82d3f0dbcd77b49e4cad38247fe3c43dd6dd14efd8a1282d306e1dd6ddb70

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 2.3.0 - 2020-09-39
+
+- Add `error_status_code_map` option to `RackGraphql::Application`.
+
+  `error_status_code_map` allows for return custom http code when specific errors are raised.
+
+## 2.2.1 - 2020-09-14
+
+- Rename `source_app` to `app_name` in error payload.
+
+## 2.2.0 - 2020-09-14
+
+- Add `source_app` to error payload.
+
+## 2.1.0 - 2020-09-14
+
+- Add `log_exception_backtrace` option to `RackGraphql::Application`
+
 ## 2.0.0 - 2020-09-14
 
 - Catch all exceptions raised by the app respond with 500 status codea and json content type

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-graphql (2.0.0)
+    rack-graphql (2.3.1)
       graphql (~> 1.11)
       oj
       rack (~> 2.2)
@@ -10,13 +10,14 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    awesome_print (1.8.0)
     coderay (1.1.3)
     diff-lcs (1.4.4)
     graphql (1.11.4)
     method_source (1.0.0)
     oj (3.10.14)
     parallel (1.19.2)
-    parser (2.7.1.4)
+    parser (2.7.1.5)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -26,7 +27,7 @@ GEM
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -41,19 +42,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.90.0)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.8.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
@@ -63,6 +65,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   bundler
   pry
   rack-graphql!

data/README.md

@@ -23,11 +23,13 @@ Add following to your `config.ru` file:
 
 ```ruby
 run RackGraphql::Application.call(
-  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
-  logger: A9n.logger,                         # optional, not set by default
+  schema: YourGraqphqlSchema,                      # required
+  app_name: 'your-service-name',                   # optional, used for health endpoint content
+  context_handler: YourGraphqlContextHandler,      # optional, empty `proc` by default
+  log_exception_backtrace: !A9n.env.production?,   # optional, `true` default
+  health_route: true,                              # optional, true by default
+  logger: A9n.logger,                              # optional, not set by default
+  error_status_code_map: { IamTeapotError => 418 }, # optional
 )
 ```
 

data/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i[rubocop:auto_correct spec]
+task default: %i[spec rubocop:auto_correct]

data/lib/rack_graphql/application.rb

@@ -1,11 +1,26 @@
 module RackGraphql
   class Application
-    def self.call(schema:, app_name: 'rack-graphql-service', logger: nil, context_handler: nil,
-      health_route: true, health_response_builder: RackGraphql::HealthResponseBuilder)
+    def self.call(
+      schema:,
+      app_name: 'rack-graphql-service',
+      logger: nil,
+      context_handler: nil,
+      log_exception_backtrace: RackGraphql.log_exception_backtrace,
+      health_route: true,
+      health_response_builder: RackGraphql::HealthResponseBuilder,
+      error_status_code_map: {}
+    )
 
       ::Rack::Builder.new do
         map '/graphql' do
-          run RackGraphql::Middleware.new(schema: schema, context_handler: context_handler, logger: logger)
+          run RackGraphql::Middleware.new(
+            app_name: app_name,
+            schema: schema,
+            context_handler: context_handler,
+            logger: logger,
+            log_exception_backtrace: log_exception_backtrace,
+            error_status_code_map: error_status_code_map,
+          )
         end
 
         if health_route

data/lib/rack_graphql/middleware.rb

@@ -1,9 +1,22 @@
 module RackGraphql
   class Middleware
-    def initialize(schema:, logger: nil, context_handler: nil)
+    DEFAULT_ERROR_STATUS_CODE = 500
+
+    def initialize(
+      schema:,
+      app_name: nil,
+      context_handler: nil,
+      logger: nil,
+      log_exception_backtrace: RackGraphql.log_exception_backtrace,
+      error_status_code_map: {}
+    )
+
       @schema = schema
-      @logger = logger
+      @app_name = app_name
       @context_handler = context_handler || ->(_) {}
+      @logger = logger
+      @log_exception_backtrace = log_exception_backtrace
+      @error_status_code_map = error_status_code_map
     end
 
     def call(env)
@@ -43,9 +56,9 @@ module RackGraphql
       env[Rack::RACK_ERRORS].puts(exception_string)
       env[Rack::RACK_ERRORS].flush
       [
-        500,
+        error_status_code_map[e.class] || DEFAULT_ERROR_STATUS_CODE,
         { 'Content-Type' => 'application/json' },
-        [Oj.dump(errors: [exception_hash(e)])]
+        [Oj.dump('errors' => [exception_hash(e)])]
       ]
     ensure
       ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
@@ -53,7 +66,7 @@ module RackGraphql
 
     private
 
-    attr_reader :schema, :logger, :context_handler
+    attr_reader :schema, :app_name, :logger, :context_handler, :log_exception_backtrace, :error_status_code_map
 
     def post_request?(env)
       env['REQUEST_METHOD'] == 'POST'
@@ -151,14 +164,15 @@ module RackGraphql
     # Based on https://github.com/rack/rack/blob/master/lib/rack/show_exceptions.rb
     def dump_exception(exception)
       string = "#{exception.class}: #{exception.message}\n"
-      string << exception.backtrace.map { |l| "\t#{l}" }.join("\n") if RackGraphql.log_exception_backtrace
+      string << exception.backtrace.map { |l| "\t#{l}" }.join("\n") if log_exception_backtrace
       string
     end
 
     def exception_hash(exception)
       {
-        message: "#{exception.class}: #{exception.message}",
-        backtrace: RackGraphql.log_exception_backtrace ? exception.backtrace : "[FILTERED]"
+        'app_name' => app_name,
+        'message' => "#{exception.class}: #{exception.message}",
+        'backtrace' => log_exception_backtrace ? exception.backtrace : "[FILTERED]"
       }
     end
   end

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.3.1'.freeze
 end

data/rack-graphql.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = 'https://github.com/RenoFi/rack-graphql'
   spec.metadata['source_code_uri'] = 'https://github.com/RenoFi/rack-graphql'
+  spec.metadata['changelog_uri'] = 'https://github.com/RenoFi/rack-graphql/blob/master/CHANGELOG.md'
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }
@@ -28,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'oj'
   spec.add_dependency 'rack', '~> 2.2'
 
+  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack-test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +216,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/RenoFi/rack-graphql
   source_code_uri: https://github.com/RenoFi/rack-graphql
+  changelog_uri: https://github.com/RenoFi/rack-graphql/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: