api_recipes 1.0.0 → 2.5.0

data/lib/api_recipes/exceptions.rb

@@ -1,8 +1,8 @@
 module ApiRecipes
 
-  class EndpointNameClashError < Exception
+  class ApiNameClashError < Exception
     def initialize(object, endpoint_name)
-      message = "#{object.class} already defines a method called '#{endpoint_name}'. Tip: change endpoint name"
+      message = "#{object.class} already defines a method called '#{endpoint_name}'. Tip: change api name"
       super(message)
     end
   end
@@ -15,14 +15,18 @@ module ApiRecipes
   end
 
   class MissingRouteAttribute < Exception
-    attr_reader :resource, :route, :attribute
+    def initialize(endpoint = nil, route = nil,  attribute = nil)
+      message = "route '#{endpoint}.#{route}' requires '#{attribute}' attribute but this was not provided"
+      super(message)
+    end
+  end
 
-    def initialize(message = nil, resource = nil, route = nil,  attribute = nil)
-      @resource = resource; @route = route; @attribute = attribute
-      if message
-        # Nothing to do
-      elsif @route && @attribute
-        message = "route '#{@resource}.#{@route}' requires '#{@attribute}' attribute but this was not given"
+  class PathParamsMismatch < Exception
+    def initialize(path, expected_params, provided_params)
+      if expected_params.size == 0
+        message = "route '#{path}' requires NO PARAMS but #{provided_params} were provided"
+      else
+        message = "route '#{path}' requires params #{expected_params} but #{provided_params} were provided"
       end
       super(message)
     end
@@ -36,20 +40,13 @@ module ApiRecipes
   end
 
   class ResponseCodeNotAsExpected < Exception
-    attr_reader :resource, :route, :expected_code, :response_code, :response_body
-
-    def initialize(message = nil, resource = nil, route = nil, expected_code = nil, response_code = nil, response_body = nil)
-      @resource = resource; @route = route; @expected_code = expected_code; @response_code = response_code; @response_body = response_body
-      if message
-        # Nothing to do
-      else
-        message = "response code for request on route '#{@resource}.#{@route}' has returned #{@response_code}, but #{@expected_code} was expected. Reason: #{@response_body}"
-      end
+    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}"
       super(message)
     end
   end
 
-  class EndpointConfigIsNotAnHash < Exception
+  class ApiConfigIsNotAnHash < Exception
     def initialize(endpoint)
       message = "provided config for endpoint '#{endpoint}' must be an Hash"
       super(message)
@@ -71,11 +68,15 @@ module ApiRecipes
   end
 
   class RouteNameClashWithExistentMethod < Exception
-    attr_reader :resource, :route
+    def initialize(endpoint_name, route_name)
+      message = "can't define route '#{route_name}' method in endpoint '#{endpoint_name}' because method '#{route_name}' has already been defined"
+      super(message)
+    end
+  end
 
-    def initialize(resource, route)
-      @resource = resource; @route = route
-      message = "can't define route '#{@route}' method in resource '#{@resource}' because method '#{@route}' already exists"
+  class NoRouteExists < Exception
+    def initialize(endpoint_name)
+      message = "no route defined on #{endpoint_name}"
       super(message)
     end
   end

data/lib/api_recipes/response.rb

@@ -1,5 +1,22 @@
 module ApiRecipes
-  class Response < HTTP::Response
+  class Response
 
+    attr_reader :original_response
+
+    def initialize(response, attributes = {})
+      @original_response = response
+      @attributes = attributes
+    end
+
+    def data
+      return @data unless @data.nil?
+
+      @data = @original_response.parse
+    end
+
+    # Forward method calls to 'original' Response class
+    def method_missing(symbol, *args, &block)
+      @original_response.send symbol,* args, &block
+    end
   end
 end

data/lib/api_recipes/route.rb

@@ -0,0 +1,158 @@
+module ApiRecipes
+  class Route
+
+    attr_reader :request, :response
+    attr_accessor :request_params, :attributes, :path
+
+    def initialize(api: nil, endpoint: nil, path: nil, attributes: {}, req_pars: {})
+      @api = api
+      @endpoint = endpoint
+      @path = path.to_s
+      @attributes = attributes
+      self.request_params = req_pars
+      @uri = nil
+
+      prepare_request
+    end
+
+    def fill(object)
+      data = @response.parse
+      if block_given?
+        tap do
+          try_to_fill object, data
+          yield object, data, @response.status
+        end
+      else
+        try_to_fill object, data
+      end
+    end
+
+    def start_request(&block)
+      original_response = @request.send http_verb, @uri, request_params
+      @response = Response.new original_response, attributes
+      check_response_code
+
+      if block_given?
+        tap { block.call @response }
+      else
+        response
+      end
+    end
+
+    private
+
+    def build_uri_from_path
+      attrs = {
+          scheme: settings[:protocol],
+          host: settings[:host],
+          port: port,
+          path: path
+      }
+      URI::Generic.build 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
+      else
+        # Default: 200 <= OK < 300
+        ok_code = true if (code >= 200 && code < 300)
+        expected_code = '200 <= CODE < 300'
+      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
+        end
+      end
+    end
+
+    def extract_headers
+      settings[:default_headers] || {}
+    end
+
+    def timeout
+      attributes.fetch(:timeout, ApiRecipes::Settings::GLOBAL_TIMEOUT)
+    end
+
+    def port
+      settings[:port] || case settings[:protocol]
+                         when 'http'
+                           80
+                         when 'https'
+                           443
+                         end
+    end
+
+    def prepare_request
+      @uri = build_uri_from_path
+      puts @uri if ApiRecipes.print_urls
+
+      @request = request_with_auth
+    end
+
+    def request_params=(params)
+      unless params.is_a? Hash
+        raise ArgumentError, 'provided params must be an Hash'
+      end
+      # Merge route attributes with defaults and deep clone route attributes
+      @request_params = params
+    end
+
+    def request_with_auth
+      req = HTTP
+      req = req.headers(extract_headers)
+                .timeout(timeout)
+
+      basic_auth = @api.basic_auth
+      if basic_auth
+        req = req.basic_auth basic_auth
+      end
+      authorization = @api.authorization
+      if authorization
+        req = req.auth authorization
+      end
+      req
+    end
+
+    def settings
+      @api.configs
+    end
+
+    def try_to_fill(object, data)
+      case data
+      when Hash
+        res = fill_object_with object, data
+      when Array
+        res = []
+        data.each do |element|
+          res << fill_object_with(object.new, element)
+        end
+      end
+
+      res
+    end
+
+    def fill_object_with(object, data)
+      data.each do |key, value|
+        begin
+          object.send "#{key}=", value
+        rescue
+        end
+      end
+
+      object
+    end
+
+    def http_verb
+      attributes[:verb]
+    end
+  end
+end

data/lib/api_recipes/settings.rb

@@ -1,21 +1,24 @@
 module ApiRecipes
   module Settings
     GLOBAL_TIMEOUT = 1
-    FAIL_OPTIONS = [:return, :raise, :return_false]
 
     DEFAULT = {
         protocol: 'https',
         host: 'localhost',
         port: nil,
-        base_path: '',
-        api_version: '',
+        base_url: nil,
         timeout: 3,
-        on_nok_code: :raise,
-        routes: {}
+        on_bad_code: 'raise',
+        endpoints: {}
     }
 
     DEFAULT_ROUTE_ATTRIBUTES = {
-        method: :get
+        verb: :get,
+        route: 'yes',
+        path: nil,
+        ok_code: nil,
+        timeout: DEFAULT[:timeout],
+        on_bad_code: DEFAULT[:on_bad_code]
     }
 
     AVAILABLE_PARAMS_ENCODINGS = %w(form params json body)

data/lib/api_recipes/version.rb

@@ -1,3 +1,3 @@
 module ApiRecipes
-  VERSION = '1.0.0'
+  VERSION = '2.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_recipes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Alessandro Verlato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,49 +16,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
-description: 
+        version: 4.4.1
+description:
 email:
 - averlato@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Guardfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
-- Rakefile
-- api_recipes.gemspec
-- api_recipes.png
-- bin/console
-- bin/setup
-- examples/authorization.rb
-- examples/authorization_with_default_headers.rb
-- examples/basic_auth.rb
-- examples/config/apis.yml
-- examples/custom_configs.rb
-- examples/delete_me.rb
-- examples/multiple_endpoints.rb
-- examples/simple_usage.rb
 - lib/api_recipes.rb
+- lib/api_recipes/api.rb
 - lib/api_recipes/configuration.rb
 - lib/api_recipes/endpoint.rb
 - lib/api_recipes/exceptions.rb
-- lib/api_recipes/resource.rb
 - lib/api_recipes/response.rb
+- lib/api_recipes/route.rb
 - lib/api_recipes/settings.rb
 - lib/api_recipes/utils.rb
 - lib/api_recipes/version.rb
@@ -66,24 +47,24 @@ homepage: https://github.com/madAle/api_recipes
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.7
+signing_key:
 specification_version: 4
 summary: Consume HTTP APIs with style
 test_files: []

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.orig
-.idea
-.rvmrc
-.ruby-version
-.ruby-gemset
-.DS_Store
-*.gem

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - 2.2.3
-notifications:
-  email: false
-bundler_args: --without development

data/CHANGELOG.md

@@ -1,15 +0,0 @@
-## Version 0.6.0 - Default to HTTPS
-
-**POSSIBLE BREAKING CHANGES**
-
-Requests now default to HTTPS. If you still want to use (unsecure) HTTP you have to specify it in your configs through the dedicated `protocol` option e.g.
-
-```yaml
-github:
-  protocol: http
-  host: api.github.com
-```
-
-## Version 0.5.0 - Better Exceptions
-
-Exceptions now include attributes that can be accessed during the `rescue` phase in order to execute specific actions