api_recipes 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 977a895fe8c06312c73575391e759f6bd23c91fbdad1d26dfb5bb66dfc494b09
-  data.tar.gz: 507c600f1ab08ea1bcec035d8a5e60178da5d08c4e5f49beb84fba64829f39b5
+  metadata.gz: b8b743f62651355bb59b3d641637d8df6b28a860d5000a3b684758a7d1de5c47
+  data.tar.gz: d2febad009985547a7a148e1b07b193d568b76bd75a2064a9c55257652ce7997
 SHA512:
-  metadata.gz: a4bdfe19e5994165e5d2ab7256b66887c54951f2df93cd44417b4c019f10979532188ff21f581fbfb5ff8528c9d04063eda93326cefeda396a26a4d397c5d5dd
-  data.tar.gz: b67d63a82f8199e9c38bf043a0d3ba192d7613b34a3955d7aef0ef6df0d5a20017fce3be9083be8e0a697a6e96d7fcdfecb37b0aed3f43742f3600c7deb429cc
+  metadata.gz: 6a4b6882211bbae0c27f546267674e501df253eb9a22303fadf0bbf85dfd26a2ada943f813ae1660164c20e3dae68d3afd61caf132e6e40be04bf1f62e9cfcd4
+  data.tar.gz: e5429acaf4fbcaa1f5e83090d8ede9dcee36253a61b8d17b5e79fb5c4c4178115b677d91ac39e8c145af63dd1813e904834201fddbc930e45e07b3d8df3455b9

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
@@ -58,6 +58,7 @@ module ApiRecipes
     unless @configuration
       @configuration = Configuration.new
     end
+
     @configuration
   end
 
@@ -105,7 +106,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
@@ -16,6 +17,7 @@ module ApiRecipes
       if endpoints && endpoints.is_a?(Hash)
         endpoints.each do |ep_name, params|
           unless respond_to? ep_name
+            # TODO: store endpoints, routes and routes_urls
             define_singleton_method ep_name do |*request_params, &block|
               # puts "API params: #{params}"
               Endpoint.new api: self, name: ep_name, path: path, params: params, request_params: request_params, &block

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,16 @@ 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}"
+
+    attr_reader :path, :expected_code, :response
+
+    def initialize(path, expected_code = nil, response = nil, message: nil)
+      @path = path
+      @expected_code = expected_code
+      @response = response
+      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/response.rb

@@ -11,6 +11,7 @@ module ApiRecipes
     def data
       return @data unless @data.nil?
 
+      # TODO: rescue nil?
       @data = @original_response.parse
     end
 

data/lib/api_recipes/route.rb

@@ -43,31 +43,40 @@ module ApiRecipes
 
     def build_url_from_path
       attrs = {
-          scheme: settings[:protocol],
+          scheme: settings[:protocol].to_s,
           host: settings[:host],
           port: port,
           path: path
       }
-      URI::Generic.build attrs
+      URI::Generic.build2 attrs
     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, @response, message: message)
         end
       end
     end
@@ -81,12 +90,12 @@ module ApiRecipes
     end
 
     def port
-      settings[:port] || case settings[:protocol]
-                         when 'http'
-                           80
-                         when 'https'
-                           443
-                         end
+      settings[:port].to_s || case settings[:protocol].to_s
+                              when 'http'
+                                '80'
+                              when 'https'
+                                '443'
+                              end
     end
 
     def prepare_request

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.0'.freeze
+  VERSION = '2.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_recipes
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Consume HTTP APIs with style