api_recipes 2.5.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: febe7d307961dd407eae97ef0519280abf463e896f8a83471d3242b6f8a7b8a1
-  data.tar.gz: 15df723f847728e9c433223eef128069204aa15344856a4388847860c45304f2
+  metadata.gz: 3c49acd995e584ae959722b5bccb248e1c532289e0be89ebda5e1f59d6a81e8e
+  data.tar.gz: 92dbb6ce976e6a22d9f5a8b54e5c0fd62d585afb2b0222fe2cf99f885364d52d
 SHA512:
-  metadata.gz: 94627389adf247362789b3213f6ec2f45c4443e43c4212ec1fffa96f4796c4de9c097288ef0d328d657c98eb8590fa6908e89f77f080c09be1b0cb0b9c7f44d9
-  data.tar.gz: a887790e2ac8c3ec7853d2a24735f6c79a7761287e76265854963e80f18320b63bb598365ba75fb316064ebf9c424569e09160f4dc3eb79ce4c09e6326e1972f
+  metadata.gz: f327fb50389e63e750cc6c349af86ad791b27196da80cd78434afbb050868cd56e0b91e9825abc62d621a8adf1afeb8b18ac1c04b72cfdea99ad516526752726
+  data.tar.gz: 1763a9298481a31923acd934dde45da4f3e105537e35182f65d189eaa7f0128ebfbb96d7409fbf7c6974d389bb495e07d21edae6cf145c6b011520769ad571c6

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
@@ -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/configuration.rb

@@ -1,7 +1,7 @@
 module ApiRecipes
   class Configuration
 
-    attr_accessor :log_to, :log_level
+    attr_accessor :log_to, :log_level, :print_urls
 
     def apis_configs=(configs = {})
       raise ArgumentError, 'apis_configs must be an Hash' unless configs.is_a? Hash

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
@@ -29,6 +31,10 @@ module ApiRecipes
       end
     end
 
+    def url
+      @route.url
+    end
+
     private
 
     def generate_route
@@ -48,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
@@ -85,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
@@ -122,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/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

@@ -1,7 +1,7 @@
 module ApiRecipes
   class Route
 
-    attr_reader :request, :response
+    attr_reader :request, :response, :url
     attr_accessor :request_params, :attributes, :path
 
     def initialize(api: nil, endpoint: nil, path: nil, attributes: {}, req_pars: {})
@@ -10,7 +10,7 @@ module ApiRecipes
       @path = path.to_s
       @attributes = attributes
       self.request_params = req_pars
-      @uri = nil
+      @url = nil
 
       prepare_request
     end
@@ -28,7 +28,7 @@ module ApiRecipes
     end
 
     def start_request(&block)
-      original_response = @request.send http_verb, @uri, request_params
+      original_response = @request.send http_verb, @url, request_params
       @response = Response.new original_response, attributes
       check_response_code
 
@@ -41,35 +41,42 @@ module ApiRecipes
 
     private
 
-    def build_uri_from_path
+    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)
-        when 'return_false'
-          return false
+          raise ResponseCodeNotAsExpected.new(path, expected_code, code, @response.body, message: message)
         end
       end
     end
@@ -83,17 +90,17 @@ 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
-      @uri = build_uri_from_path
-      puts @uri if ApiRecipes.print_urls
+      @url = build_url_from_path
+      puts @url if ApiRecipes.configuration.print_urls
 
       @request = request_with_auth
     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.5.0'.freeze
+  VERSION = '2.7.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_recipes
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -62,8 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Consume HTTP APIs with style