api_valve 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c5ecd7703186bfbcd52c8b50d3a643a5c2af56043e92f00e56b8b1863c38fb7
-  data.tar.gz: 95263987cdf177ce4703955572e28f4540a3c32f47fb7b519fd0233b79506160
+  metadata.gz: 3082a9e6ce31e0044de55d718dc95764b9a7bd966b26f2eac1a219b687b1dc90
+  data.tar.gz: df5e9392bafe22aa847b603b392ea6d386b4736e9af1fcb991a3a5c3989253e5
 SHA512:
-  metadata.gz: a43f1ff0ea8e795a1676bd918b9d849d2404a14793f6ccf93adac8b70c3aa672729822a1e6d516f38201ae3505023e3d0adc46c0a4257497c6c5aaa577bc97fe
-  data.tar.gz: 2db871a83ee2dc02b2639ba0e6c19a795f765e24421ef0aacc8ec2f4adbefd2b682d7746cb8c99cd0e976d5afe89af70abb87cb2680dbce92c9f45d6458ed467
+  metadata.gz: 92fcfc205c9da56bc4a565ede28e87cbf4dd0eb5a5f9a0a705e20d3d74699b32015222930bd028dbe592818a03e6988b34d80a4798601a127dd0a2373883a7ed
+  data.tar.gz: 35402f30d4d8ad53792c77d5cc86893e489bdcf5717dc28b7b6dcee1e09a247aad58d4a939e88d13fbdcaaa82bf7845b81808bbfde9932d71d09eb7c41df142c

data/lib/api_valve/cascade.rb

@@ -0,0 +1,22 @@
+module ApiValve
+  class Cascade
+    def initialize(*proxies)
+      @proxies = proxies
+    end
+
+    def call(env)
+      @proxies.each do |proxy|
+        return proxy.call env
+      rescue Error::NotRouted
+        next
+      end
+      render_error Error::NotFound.new
+    end
+
+    protected
+
+    def render_error(error)
+      self.class.const_get(ApiValve.error_responder).new(error).call
+    end
+  end
+end

data/lib/api_valve/error.rb

@@ -1,13 +1,27 @@
 module ApiValve
-  module Error
-    class Base < RuntimeError
-      class_attribute :http_status
-      self.http_status = :server_error
+  class Error < RuntimeError
+    class_attribute :http_status, :code, :title, :default_message
+    self.http_status = :server_error
+
+    Client = Class.new(self)
+    Server = Class.new(self)
+
+    def initialize(*args)
+      @options = args.extract_options!
+      super(args.first || default_message)
     end
 
     Rack::Utils::SYMBOL_TO_STATUS_CODE.each do |sym, code|
-      next unless code >= 400
-      const_set sym.to_s.camelize, Class.new(Base) { self.http_status = sym }
+      case code
+      when 400..499
+        const_set sym.to_s.camelize, Class.new(Client) { self.http_status = sym }
+      when 500..599
+        const_set sym.to_s.camelize, Class.new(Server) { self.http_status = sym }
+      end
+    end
+
+    NotRouted = Class.new(self) do
+      self.http_status = 404
     end
   end
 end

data/lib/api_valve/error_responder.rb

@@ -7,7 +7,7 @@ module ApiValve
     def call
       [
         status,
-        {'Content-Type' => 'application/json'},
+        {'Content-Type' => 'application/vnd.api+json'},
         [MultiJson.dump({errors: [json_error]}, mode: :compat)]
       ]
     end
@@ -22,19 +22,26 @@ module ApiValve
 
     def json_error
       {
-        status: status,
-        code: json_code,
+        status: status.to_s,
+        code:   json_code,
+        title:  json_title,
         detail: json_detail,
-        meta: json_meta
+        meta:   json_meta
       }.compact
     end
 
     def json_code
-      @error.try(:code) || Rack::Utils::HTTP_STATUS_CODES[status]
+      @error.try(:code) || @error.class.name.demodulize.underscore
+    end
+
+    def json_title
+      @error.try(:title) || Rack::Utils::HTTP_STATUS_CODES[status]
     end
 
     def json_detail
-      @error.message != @error.class.to_s ? @error.message : nil
+      return if json_title == @error.message
+      return if @error.message == @error.class.name
+      @error.message
     end
 
     def json_meta

data/lib/api_valve/forwarder/permission_handler.rb

@@ -4,6 +4,8 @@ module ApiValve
   # attributes that can be read or written.
 
   class Forwarder::PermissionHandler
+    InsufficientPermissions = Class.new(Error::Forbidden)
+
     module RequestIntegration
       private
 
@@ -33,7 +35,8 @@ module ApiValve
 
     # Tells the request class if the request is allowed
     # Simple implementation is always true. Override in your implementation.
-    def request_allowed?
+    # Should raise InsufficientPermissions when not allowed
+    def check_permissions!
       true
     end
   end

data/lib/api_valve/forwarder/request.rb

@@ -26,8 +26,8 @@ module ApiValve
     end
 
     # Is the request allowed? If it returns false, Forwarder will raise Error::Forbidden
-    def allowed?
-      permission_handler.request_allowed?
+    def check_permissions!
+      permission_handler.check_permissions!
     end
 
     # HTTP method to use when forwarding. Must return sym.

data/lib/api_valve/forwarder.rb

@@ -24,7 +24,7 @@ module ApiValve
     # request and response.
     def call(original_request, local_options = {})
       request = request_klass.new(original_request, request_options.deep_merge(local_options))
-      raise Error::Forbidden unless request.allowed?
+      request.check_permissions!
       response_klass.new(
         original_request,
         run_request(request),

data/lib/api_valve/middleware/error_handling.rb

@@ -9,7 +9,7 @@ module ApiValve
         @app.call(env)
       rescue Exception => e # rubocop:disable Lint/RescueException
         log_error e
-        ErrorResponder.new(e).call
+        self.class.const_get(ApiValve.error_responder).new(e).call
       end
 
       private

data/lib/api_valve/middleware/logging.rb

@@ -91,21 +91,10 @@ module ApiValve::Middleware
       end
     end
 
-    config_accessor :log_request_headers do
-      false
-    end
-
-    config_accessor :log_request_body do
-      false
-    end
-
-    config_accessor :log_response_headers do
-      false
-    end
-
-    config_accessor :log_response_body do
-      false
-    end
+    config_accessor(:log_request_headers) { false }
+    config_accessor(:log_request_body) { false }
+    config_accessor(:log_response_headers) { false }
+    config_accessor(:log_response_body) { false }
 
     def initialize(app)
       @app = app

data/lib/api_valve/proxy.rb

@@ -62,8 +62,8 @@ module ApiValve
     def call(env)
       @request = Rack::Request.new(env)
       run_callbacks(:call) { @router.call(@request) }
-    rescue ApiValve::Error::Base => e
-      ErrorResponder.new(e).call
+    rescue ApiValve::Error::Client, ApiValve::Error::Server => e
+      render_error e
     end
 
     delegate :add_route, to: :router
@@ -78,7 +78,7 @@ module ApiValve
           forward method, path_regexp, request_override
         end
       end
-      forward_all
+      forward_all unless config['routes']
     end
 
     def forward(methods, path_regexp = nil, request_override = {})
@@ -100,5 +100,11 @@ module ApiValve
         router.public_send(method, path_regexp, ->(*_args) { raise ApiValve.const_get(with) })
       end
     end
+
+    protected
+
+    def render_error(error)
+      self.class.const_get(ApiValve.error_responder).new(error).call
+    end
   end
 end

data/lib/api_valve/router.rb

@@ -68,7 +68,7 @@ module ApiValve
           return route.call request, match_data
         end
       end
-      raise Error::NotFound, 'Endpoint not found'
+      raise Error::NotRouted, 'Endpoint not found'
     end
   end
 end

data/lib/api_valve.rb

@@ -13,6 +13,7 @@ require 'logger'
 
 module ApiValve
   autoload :Benchmarking,   'api_valve/benchmarking'
+  autoload :Cascade,        'api_valve/cascade'
   autoload :Error,          'api_valve/error'
   autoload :ErrorResponder, 'api_valve/error_responder'
   autoload :Forwarder,      'api_valve/forwarder'
@@ -31,6 +32,10 @@ module ApiValve
     Logger.new(STDOUT)
   end
 
+  config_accessor :error_responder do
+    'ApiValve::ErrorResponder'
+  end
+
   config_accessor :expose_backtraces do
     false
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_valve
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +120,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 0.58.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 0.58.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +194,7 @@ files:
 - README.md
 - lib/api_valve.rb
 - lib/api_valve/benchmarking.rb
+- lib/api_valve/cascade.rb
 - lib/api_valve/error.rb
 - lib/api_valve/error_responder.rb
 - lib/api_valve/forwarder.rb
@@ -211,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Lightweight ruby/rack API reverse proxy or gateway