api_recipes 2.6.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ce6553d9d7e1e72dca69781d977310670ac25a3c88b39a974b3b4d5865c0f0f
-  data.tar.gz: '08ff597bfc3b86e31d4f7d467cf7b0a7f67bd5d08783d9b901ce15f05e0f85ac'
+  metadata.gz: 8ac0841819d455adb4d85f88d7858e33cfaa17bf35316811f5a6d7c75879b271
+  data.tar.gz: ddacdca3095b42cdc14c51e066a52d237c85dfc0ba79419342168d7667f0b12e
 SHA512:
-  metadata.gz: ddfbfdedaba0d774e87c868836f22e493bd0e336e015fa0907939d57756bc6f93b7540836887ea194ef27041b2c4848ccff258b69a9eb59142d591951bfe5827
-  data.tar.gz: ebca5a942daeb2d98522bb8fc811e1f0ad4b0916e6299a7bf7b6ad3c1b549d3ef28a1ebfe4cbdaf51103513578b97fd4732e730608174b356fafe8ef58a993a1
+  metadata.gz: ec9f37f976b33f9386b4f201f4200ce33fdc526510f31984b591823c093c187037c7c8fc6c967fd33094b41f5343b4810ae251a89d3a9922e55b565f7f648503
+  data.tar.gz: 4c2f41152de95562744e8b60e8d14ca4adbbd4a88487d89f52149ba9bfd6b9bff3bf830bedc1aee9c59787e541ad5386d151baea552b11e7c63a8eac1e795b85

data/lib/api_recipes.rb

@@ -32,13 +32,13 @@ module ApiRecipes
 
         define_method api_name do
           configs = ApiRecipes._aprcps_merge_apis_configs(api_name, configs.deep_symbolize_keys)
-          api = Api.new(api_name, configs)
+          api = Api.new(api_name, configs, self)
           ApiRecipes.copy_global_authorizations_to_api api
           api
         end
         define_singleton_method api_name do
           configs = ApiRecipes._aprcps_merge_apis_configs(api_name, configs.deep_symbolize_keys)
-          api = Api.new(api_name, configs)
+          api = Api.new(api_name, configs, self)
           ApiRecipes.copy_global_authorizations_to_api api
           api
         end
@@ -105,7 +105,7 @@ module ApiRecipes
   def self._aprcps_define_global_apis
     configuration.apis_configs.each do |api_name, api_configs|
       api_name = api_name.to_sym
-      _aprcps_global_storage[api_name] = Api.new api_name, api_configs
+      _aprcps_global_storage[api_name] = Api.new api_name, api_configs, self
       define_singleton_method api_name do
         _aprcps_global_storage[api_name]
       end

data/lib/api_recipes/api.rb

@@ -2,13 +2,14 @@ module ApiRecipes
   class Api
 
     attr_accessor :name, :configs, :authorization, :basic_auth
-    attr_reader :base_configs
+    attr_reader :base_configs, :object
 
-    BASE_CONFIGS_KEYS = [:protocol, :host, :port, :api_version, :timeout, :on_bad_code]
+    BASE_CONFIGS_KEYS = [:protocol, :host, :port, :api_version, :timeout, :on_bad_code, :verify_with]
 
-    def initialize(name, configs)
+    def initialize(name, configs, object)
       @name = name
       @configs = ApiRecipes::Settings::DEFAULT.merge configs
+      @object = object
 
       # Generate   some_api.some_endpoint  methods
       # e.g.  github.users

data/lib/api_recipes/endpoint.rb

@@ -3,6 +3,8 @@ module ApiRecipes
 
     attr_reader :api, :name, :params, :route, :children
 
+    FORWARDABLE_PARAMS = %i[verify_with].freeze
+
     def initialize(api: nil, name: nil, path: nil, params: {}, request_params: [], &block)
       @api = api
       @name = name
@@ -52,6 +54,8 @@ module ApiRecipes
       # puts "generating children of #{@name}: #{children.inspect}"
       if children
         children.each do |ep_name, pars|
+          pars = forwardable_params.merge(pars) if pars
+          # TODO: Merge pars with params
           # puts "Creating Endpoint '#{@name}' child '#{ep_name}' passing path #{build_path}"
           define_singleton_method ep_name do |*request_params, &block|
             Endpoint.new api: @api, name: ep_name, path: build_path, params: pars, request_params: request_params, &block
@@ -89,7 +93,6 @@ module ApiRecipes
       end
       # Merge DEFAULT_ROUTE_ATTRIBUTES with Api base_configs
       # Then merge the result with provided attributes
-
       @params = Settings::DEFAULT_ROUTE_ATTRIBUTES.inject({}) do |out, key_val|
         new_val = @api.base_configs[key_val.first]
         out[key_val.first] = new_val.nil? ? key_val.last : new_val
@@ -126,5 +129,9 @@ module ApiRecipes
     def required_params_for_path
       absolute_path.scan(/:(\w+)/).flatten.map { |p| p.to_sym }
     end
+
+    def forwardable_params
+      params.select { |k, v| FORWARDABLE_PARAMS.include? k }
+    end
   end
 end

data/lib/api_recipes/exceptions.rb

@@ -40,8 +40,10 @@ module ApiRecipes
   end
 
   class ResponseCodeNotAsExpected < Exception
-    def initialize(path, expected_code = nil, response_code = nil, response_body = nil)
-      message = "response code for request on route '#{path}' has returned #{response_code}, but #{expected_code} was expected\n\nResponse body:\n #{response_body}"
+    def initialize(path, expected_code = nil, response_code = nil, response_body = nil, message: nil)
+      unless message
+        message = "response code for request on route '#{path}' has returned '#{response_code}', but '#{expected_code}' was expected\n\nResponse body:\n #{response_body}"
+      end
       super(message)
     end
   end

data/lib/api_recipes/route.rb

@@ -52,22 +52,31 @@ module ApiRecipes
     end
 
     def check_response_code
-      # If :ok_code property is present, check the response code
       ok_code = false
       code = @response.code
-      if expected_code = attributes[:ok_code]
-        # If the code does not match, apply the requested strategy
-        ok_code = true if code == expected_code
+      message = nil
+
+      verify_with = attributes[:verify_with]
+      if verify_with && @api.object.respond_to?(verify_with, true )
+        ok_code = @api.object.send verify_with, @response
+        message = "response for request on route '#{path}' was not valid. Verified with #{@api.object}##{verify_with}.\n\nResponse body:\n #{@response.body}"
       else
-        # Default: 200 <= OK < 300
-        ok_code = true if (code >= 200 && code < 300)
-        expected_code = '200 <= CODE < 300'
+        # If :ok_code property is present, check the response code
+        if expected_code = attributes[:ok_code]
+          # If the code does not match, apply the requested strategy
+          ok_code = true if code == expected_code
+        else
+          # Default: 200 <= OK < 300
+          ok_code = true if @response.status.success?
+          expected_code = '200 <= CODE < 300'
+        end
       end
+
       unless ok_code
         case attributes[:on_bad_code].to_s
         when 'ignore'
         when 'raise'
-          raise ResponseCodeNotAsExpected.new(path, expected_code, code, @response.body)
+          raise ResponseCodeNotAsExpected.new(path, expected_code, code, @response.body, message: message)
         end
       end
     end

data/lib/api_recipes/settings.rb

@@ -9,7 +9,8 @@ module ApiRecipes
         base_url: nil,
         timeout: 3,
         on_bad_code: 'raise',
-        endpoints: {}
+        endpoints: {},
+        verify_with: nil
     }
 
     DEFAULT_ROUTE_ATTRIBUTES = {
@@ -18,7 +19,8 @@ module ApiRecipes
         path: nil,
         ok_code: nil,
         timeout: DEFAULT[:timeout],
-        on_bad_code: DEFAULT[:on_bad_code]
+        on_bad_code: DEFAULT[:on_bad_code],
+        verify_with: DEFAULT[:verify_with]
     }
 
     AVAILABLE_PARAMS_ENCODINGS = %w(form params json body)

data/lib/api_recipes/version.rb

@@ -1,3 +1,3 @@
 module ApiRecipes
-  VERSION = '2.6.2'.freeze
+  VERSION = '2.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_recipes
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http