api_valve 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3082a9e6ce31e0044de55d718dc95764b9a7bd966b26f2eac1a219b687b1dc90
-  data.tar.gz: df5e9392bafe22aa847b603b392ea6d386b4736e9af1fcb991a3a5c3989253e5
+  metadata.gz: 6e02e6ea22e34fe53e6b776abc3844b1581ea0ca12eade5f6ee5f857a6bb779d
+  data.tar.gz: 846954dd57564d157906ca5956a9ec43fa9ad9ecc750aac4dcddcb536c7ad9d1
 SHA512:
-  metadata.gz: 92fcfc205c9da56bc4a565ede28e87cbf4dd0eb5a5f9a0a705e20d3d74699b32015222930bd028dbe592818a03e6988b34d80a4798601a127dd0a2373883a7ed
-  data.tar.gz: 35402f30d4d8ad53792c77d5cc86893e489bdcf5717dc28b7b6dcee1e09a247aad58d4a939e88d13fbdcaaa82bf7845b81808bbfde9932d71d09eb7c41df142c
+  metadata.gz: ff191c95817ae0d9e335131afe42a5163224c69400e055596ff419f9d93404c0e82da26fe296ddc1d2fe4adb49d79bd8541e0108a16a0e87a13a9d710ee84cc5
+  data.tar.gz: c8436b6a7402b1fab1831a38f2b1662d6eddcfefe46b44a5e487b0c8d382174eaea88fea153eda252a1c89655d3f8ade2be0b92a906359b573588a12b44649fc

data/lib/api_valve/cascade.rb

@@ -1,7 +1,7 @@
 module ApiValve
   class Cascade
     def initialize(*proxies)
-      @proxies = proxies
+      @proxies = Array.wrap(proxies).flatten
     end
 
     def call(env)

data/lib/api_valve/error_responder.rb

@@ -17,6 +17,7 @@ module ApiValve
     def status
       status = @error.try(:http_status)
       return status if status&.is_a?(Integer)
+
       Rack::Utils::SYMBOL_TO_STATUS_CODE[status] || 500
     end
 
@@ -41,6 +42,7 @@ module ApiValve
     def json_detail
       return if json_title == @error.message
       return if @error.message == @error.class.name
+
       @error.message
     end
 

data/lib/api_valve/forwarder/permission_handler.rb

@@ -33,9 +33,9 @@ module ApiValve
       @options = options
     end
 
-    # Tells the request class if the request is allowed
+    # Run permission checks
     # Simple implementation is always true. Override in your implementation.
-    # Should raise InsufficientPermissions when not allowed
+    # For example raise ApiValve::Error::Forbidden in certain conditions
     def check_permissions!
       true
     end

data/lib/api_valve/forwarder/request.rb

@@ -25,10 +25,8 @@ module ApiValve
       @options = options.with_indifferent_access
     end
 
-    # Is the request allowed? If it returns false, Forwarder will raise Error::Forbidden
-    def check_permissions!
-      permission_handler.check_permissions!
-    end
+    # Called by forwarder before actual request is executed
+    delegate :check_permissions!, to: :permission_handler
 
     # HTTP method to use when forwarding. Must return sym.
     # Returns original request method
@@ -62,6 +60,7 @@ module ApiValve
     # Override to control the payload that is passed through
     def body
       return unless %i(put post patch).include? method
+
       original_request.body.read
     end
 
@@ -69,6 +68,7 @@ module ApiValve
     # Override to control the query parameters that can be passed through
     def url_params
       return unless original_request.query_string.present?
+
       @url_params ||= Rack::Utils.parse_nested_query(original_request.query_string)
     end
 

data/lib/api_valve/forwarder/response.rb

@@ -53,6 +53,7 @@ module ApiValve
 
     def adjust_location(location)
       return location if @options[:target_prefix] == @options[:local_prefix]
+
       location&.gsub(/^#{@options[:target_prefix]}/, @options[:local_prefix])
     end
 

data/lib/api_valve/forwarder.rb

@@ -16,7 +16,8 @@ module ApiValve
     def initialize(options = {})
       @options = options.with_indifferent_access
       uri = URI(options[:endpoint])
-      @target_prefix = uri.path
+      # Target prefix must be without trailing slash
+      @target_prefix = uri.path.gsub(%r{/$}, '')
     end
 
     # Takes the original rack request with optional options and returns a rack response

data/lib/api_valve/middleware/logging.rb

@@ -52,6 +52,7 @@ module ApiValve::Middleware
 
       def log_url_params
         return unless env['QUERY_STRING'].present?
+
         logger.info URL_PARAMS % Rack::Utils.parse_nested_query(env['QUERY_STRING']).inspect
       end
 
@@ -60,25 +61,30 @@ module ApiValve::Middleware
         env.each_pair do |k, v|
           next unless k =~ /^HTTP_/ && v.present?
           next if v.blank? || (!k.start_with?('HTTP_') && !NON_STANDARD_REQUEST_HEADERS.include?(k))
+
           headers[k] = v
         end
         return if headers.empty?
+
         logger.debug REQUEST_HEADERS % headers
       end
 
       def log_request_payload
         return unless %w(PATCH POST PUT).include? env['REQUEST_METHOD']
+
         logger.debug REQUEST_PAYLOAD % env['rack.input'].read(1000)
         env['rack.input'].rewind
       end
 
       def log_response_headers
         return if response_headers&.empty?
+
         logger.debug RESPONSE_HEADERS % response_headers.inspect
       end
 
       def log_response_payload
         return if response_payload&.empty?
+
         logger.debug RESPONSE_PAYLOAD % response_payload.first(config_log_body_size)
       end
 

data/lib/api_valve/proxy.rb

@@ -16,6 +16,7 @@ module ApiValve
         file_name ||= name.underscore
         path = find_config(file_name)
         raise "Config not found for #{name.underscore}(.yml|.yml.erb) in #{ApiValve.config_paths.inspect}" unless path
+
         yaml = File.read(path)
         yaml = ERB.new(yaml, nil, '-').result if path.fnmatch? '*.erb'
         from_yaml yaml
@@ -37,6 +38,7 @@ module ApiValve
         ApiValve.config_paths.each do |dir|
           path = dir.join("#{file_name}.yml")
           return path if path.exist?
+
           path = dir.join("#{file_name}.yml.erb")
           return path if path.exist?
         end

data/lib/api_valve/router.rb

@@ -7,6 +7,7 @@ module ApiValve
 
       def match(path_info)
         return {} if regexp.nil? # return empty 'match data' on catch all
+
         regexp.match(path_info)
       end
     end
@@ -63,6 +64,7 @@ module ApiValve
       # For security reasons do not allow URLs that could break out of the proxy namespace on the
       # server. Preferably an nxing/apache rewrite will kill these URLs before they hit us
       raise 'URL not supported' if request.path_info.include?('/../')
+
       @routes && @routes[request.request_method.downcase.to_sym].each do |route|
         if match_data = route.match(request.path_info)
           return route.call request, match_data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_valve
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2018-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.59.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.59.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement