api_recipes 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f6c660a507389c702d45be8f603b3836aa36173a71e74d0def460c7827b4e20
-  data.tar.gz: 69573a634db4da03e59902f147cd725a1035ddf7ba6f082b215943fddc784582
+  metadata.gz: 409a786b8eff1b1fd48bdbb1f5c8a14cea860056581f86f0c994ce8436874f53
+  data.tar.gz: d8923466ea1f2109a8528e2d7e55d402c5ed2e45b714612081bda920d3e03fe4
 SHA512:
-  metadata.gz: 7bfb47fbd9ac54c246068a42f768bdbfd9382ad2604d403c4ff1ffbae8d925136020b8fee18e39c0200dcc4ec2bfe3cb92fc594e2c4a6f8a8ef3d22bc6260c07
-  data.tar.gz: 42e766ed0288f8487a0645006d5d054f072884043e563f9e0e89aaf670d02223efff7c790d028991655674e47151e12da9c725668914f5356b32586ac3e2dce4
+  metadata.gz: 70aa364742f8dc27d38c1fa0f5d9fec9a0c6b294421fac1413ed34379b39f2c28ae4cb993d51f67bfa4ddda16fe6b8074fe6646680b7a3fcb45c8d98e3f75d5b
+  data.tar.gz: fd4885cd695a4356c4f57417f77bc914a9b0104372d8eb37fb6d0531831348e9da38f2d99a394fbdc9802cd9a20bc99b3289cf4c18f92683b0fd9f9644d5f555

data/Gemfile

@@ -1,16 +1,12 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in api_recipes.gemspec
 gemspec
 
-gem 'rake', '~> 10.0'
-
-group :development do
-  gem 'guard',          '~> 2.13.0'
-  gem 'guard-rspec',    '~> 4.6.4'
-  gem 'guard-bundler',  '~> 2.1.0'
-end
+gem 'rake', '~> 12.3'
 
 group :test do
-  gem 'rspec', '~> 3.3'
+  gem 'rspec', '~> 3.8.0'
+  gem 'guard',          '~> 2.15.0'
+  gem 'guard-rspec',    '~> 4.7.3'
+  gem 'guard-bundler',  '~> 2.2.1'
 end

data/Guardfile

@@ -2,7 +2,6 @@ guard :rspec, cmd: 'bundle exec rspec' do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
-
   # RSpec files
   rspec = dsl.rspec
   watch(rspec.spec_helper) { rspec.spec_dir }

data/api_recipes.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '> 2.2.0'
 
-  spec.add_dependency 'oj', '~> 3.5.0'
-  spec.add_dependency 'http', '~> 2.0.3'
+  spec.add_dependency 'oj', '~> 3.7.0'
+  spec.add_dependency 'http', '~> 4.1.1'
 end

data/lib/api_recipes.rb

@@ -10,16 +10,46 @@ require 'api_recipes/settings'
 
 module ApiRecipes
 
-  def self.included(base)
+  def self.included(receiver)
 
-    def base.endpoint(endpoint_name, configs = {})
-      configs = ApiRecipes._aprcps_merge_endpoints_configs(endpoint_name, configs.deep_symbolize_keys)
-      endpoint_name = endpoint_name.to_sym
+    def receiver.endpoint(endpoint_name, configs = {})
+      unless endpoint_name.is_a?(String) || endpoint_name.is_a?(Symbol)
+        raise ArgumentError, "endpoint name must be a Symbol or String"
+      end
 
-      # Define 'endpoint_name' method for the class
-      ApiRecipes._aprcps_define_class_endpoint endpoint_name, configs, self, true
-      # Define 'endpoint_name' method for the class' instances
-      ApiRecipes._aprcps_define_instance_endpoint endpoint_name, self
+      if configs && !configs.is_a?(Hash)
+        raise ApiRecipes::EndpointConfigIsNotAnHash.new(endpoint_name)
+      end
+
+      endpoint_name = endpoint_name.to_sym
+      configs = ApiRecipes._aprcps_merge_endpoints_configs(endpoint_name, configs.deep_symbolize_keys)
+      if self.respond_to? endpoint_name
+        raise EndpointNameClashError.new(self, endpoint_name)
+      else
+        ep = Endpoint.new(endpoint_name, configs)
+        ApiRecipes.copy_global_authorizations_to_endpoint ep
+        ApiRecipes._aprcps_thread_storage[endpoint_name] = {}
+        ApiRecipes._aprcps_thread_storage[endpoint_name][self] = ep
+
+        define_method endpoint_name do
+          unless ApiRecipes._aprcps_thread_storage[endpoint_name]
+            ApiRecipes._aprcps_thread_storage[endpoint_name] = {}
+          end
+          unless ApiRecipes._aprcps_thread_storage[endpoint_name][self.class]
+            ApiRecipes._aprcps_thread_storage[endpoint_name][self.class] = ep.clone
+          end
+          ApiRecipes._aprcps_thread_storage[endpoint_name][self.class]
+        end
+        define_singleton_method endpoint_name do
+          unless ApiRecipes._aprcps_thread_storage[endpoint_name]
+            ApiRecipes._aprcps_thread_storage[endpoint_name] = {}
+          end
+          unless ApiRecipes._aprcps_thread_storage[endpoint_name][self]
+            ApiRecipes._aprcps_thread_storage[endpoint_name][self] = ep.clone
+          end
+          ApiRecipes._aprcps_thread_storage[endpoint_name][self]
+        end
+      end
     end
   end
 
@@ -33,65 +63,86 @@ module ApiRecipes
   def self.configure
     if block_given?
       yield(configuration)
-      _aprcps_define_global_endpoints
     else
       configuration
     end
   end
 
-  def self._aprcps_define_global_endpoints
-    configuration.endpoints_configs.each do |endpoint_name, endpoint_configs|
-      unless method_defined? endpoint_name
-        define_singleton_method endpoint_name do
-          unless _aprcps_storage[endpoint_name]
-            _aprcps_storage[endpoint_name] = Endpoint.new endpoint_name, endpoint_configs
-          end
-          _aprcps_storage[endpoint_name]
-        end
+  def self.copy_global_authorizations_to_endpoint(endpoint)
+    if _aprcps_global_storage[endpoint.name]
+      if auth = _aprcps_global_storage[endpoint.name].basic_auth
+        endpoint.authorization = auth
+      end
+      if auth = _aprcps_global_storage[endpoint.name].authorization
+        endpoint.authorization = auth
       end
     end
   end
 
+  def self.set_authorization_for_endpoint(authorization, endpoint_name)
+    endpoint_name = endpoint_name.to_sym
 
-  def self._aprcps_storage
-    unless Thread.current[:api_recipes]
-      Thread.current[:api_recipes] = {}
+    # Set authorization on thread storage
+    if _aprcps_thread_storage[endpoint_name]
+      _aprcps_thread_storage[endpoint_name].each do |_, endpoint|
+        endpoint.authorization = authorization
+      end
     end
-    Thread.current[:api_recipes]
   end
 
+  def self.set_basic_auth_for_endpoint(basic_auth, endpoint_name)
+    endpoint_name = endpoint_name.to_sym
 
-  def self._aprcps_define_class_endpoint(ep_name, configs, obj, overwrite)
-    unless obj.method_defined? ep_name
-      if overwrite
-        ep = Endpoint.new(ep_name, configs)
-      else
-        ep = _aprcps_storage[ep_name]
-      end
-      obj.define_singleton_method ep_name do
-        ep
+    # Set authorization on thread storage
+    if _aprcps_thread_storage[endpoint_name]
+      _aprcps_thread_storage[endpoint_name].each do |_, endpoint|
+        endpoint.authorization = basic_auth
       end
     end
   end
 
-  def self._aprcps_define_instance_endpoint(ep_name, obj)
-    obj.instance_eval do
-      unless obj.method_defined? ep_name
-        define_method ep_name do
-          self.class.send ep_name
-        end
+  def self._aprcps_define_global_endpoints
+    configuration.endpoints_configs.each do |endpoint_name, endpoint_configs|
+      endpoint_name = endpoint_name.to_sym
+      _aprcps_global_storage[endpoint_name] = Endpoint.new endpoint_name, endpoint_configs
+      define_singleton_method endpoint_name do
+        _aprcps_global_storage[endpoint_name]
       end
     end
   end
 
-  def self._aprcps_merge_endpoints_configs(endpoint_name, configs)
-    if configs && !configs.is_a?(Hash)
-      raise ApiRecipes::EndpointConfigIsNotAnHash.new(endpoint_name)
+  def self._aprcps_global_storage
+    unless @storage
+      @storage = {}
+    end
+    @storage
+  end
+
+  def self._aprcps_thread_storage
+    unless Thread.current[:api_recipes]
+      Thread.current[:api_recipes] = {}
+    end
+    Thread.current[:api_recipes]
+  end
+
+  def self._aprcps_merge_endpoints_configs(endpoint_name, configs = nil)
+    unless endpoint_name.is_a?(String) || endpoint_name.is_a?(Symbol)
+      raise ArgumentError, "no enpoint_name provided. Given: #{endpoint_name.inspect}"
     end
     unless ApiRecipes.configuration.endpoints_configs[endpoint_name]
       ApiRecipes.configuration.endpoints_configs[endpoint_name] = {}
     end
-    ApiRecipes.configuration.endpoints_configs[endpoint_name].merge configs
+    if configs
+      ApiRecipes.configuration.endpoints_configs[endpoint_name].merge(configs) do |_, old_val, new_val|
+        if new_val.nil?
+          old_val
+        else
+          new_val
+        end
+      end
+    else
+      ApiRecipes.configuration.endpoints_configs[endpoint_name]
+    end
   end
 end
 

data/lib/api_recipes/configuration.rb

@@ -1,9 +1,12 @@
 module ApiRecipes
   class Configuration
 
+    attr_accessor :log_to, :log_level
+
     def endpoints_configs=(configs = {})
       raise ArgumentError, 'endpoints_configs must be an Hash' unless configs.is_a? Hash
       @endpoints_configs = configs.deep_symbolize_keys
+      ApiRecipes._aprcps_define_global_endpoints
     end
 
     def endpoints_configs
@@ -12,5 +15,35 @@ module ApiRecipes
       end
       @endpoints_configs
     end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def logger
+      unless @logger
+        log = ::Logger.new(log_to)
+        log.level    = normalize_log_level
+        log.progname = 'ApiRecipes'
+        @logger = log
+      end
+
+      @logger
+    end
+
+    private
+
+    # @private
+    def normalize_log_level
+      case @log_level
+      when :debug, ::Logger::DEBUG, 'debug' then ::Logger::DEBUG
+      when :info,  ::Logger::INFO,  'info'  then ::Logger::INFO
+      when :warn,  ::Logger::WARN,  'warn'  then ::Logger::WARN
+      when :error, ::Logger::ERROR, 'error' then ::Logger::ERROR
+      when :fatal, ::Logger::FATAL, 'fatal' then ::Logger::FATAL
+      else
+        Logger::ERROR
+      end
+    end
   end
 end

data/lib/api_recipes/endpoint.rb

@@ -21,5 +21,31 @@ module ApiRecipes
         end
       end
     end
+
+    def authorization=(auth)
+      @authorization = auth
+
+      # Check if I'm the global endpoint
+      if global?
+        # Set authorization also on every "children" (classes that define the same endpoint)
+        ApiRecipes.set_authorization_for_endpoint auth, name
+      end
+    end
+
+    def basic_auth=(auth)
+      @basic_auth = auth
+
+      # Check if I'm the global endpoint
+      if global?
+        # Set authorization also on every "children" (classes that define the same endpoint)
+        ApiRecipes.set_basic_auth_for_endpoint auth, name
+      end
+    end
+
+    private
+
+    def global?
+      ApiRecipes._aprcps_global_storage[name] == self
+    end
   end
 end

data/lib/api_recipes/exceptions.rb

@@ -1,16 +1,15 @@
 module ApiRecipes
-  class RouteNameClashError < Exception
-    attr_reader :route, :resource
 
-    def initialize(message = nil, route = nil, resource = nil)
-      @route = route; @resource = resource
-      if message
-        # Nothing to do
-      elsif route
-        message = "route name (#{@route}) can't be equal to resource name (#{@resource}). Please change route or resource name."
-      else
-        message = "route name can't be equal to resource name. Please change route or resource names."
-      end
+  class EndpointNameClashError < Exception
+    def initialize(object, endpoint_name)
+      message = "#{object.class} already defines a method called '#{endpoint_name}'. Tip: change endpoint name"
+      super(message)
+    end
+  end
+
+  class RouteAndResourceNamesClashError < Exception
+    def initialize(route_name, resource_name)
+      message = "route name (#{route_name}) can't be equal to resource name (#{resource_name}). Please change route or resource name."
       super(message)
     end
   end
@@ -44,15 +43,8 @@ module ApiRecipes
   end
 
   class EndpointConfigIsNotAnHash < Exception
-    attr_reader :endpoint
-
-    def initialize(message = nil, endpoint = nil)
-      @endpoint = endpoint
-      if message
-        # Nothing to do
-      else
-        message = "provided config for endpoint '#{@endpoint}' must be an Hash"
-      end
+    def initialize(endpoint)
+      message = "provided config for endpoint '#{endpoint}' must be an Hash"
       super(message)
     end
   end

data/lib/api_recipes/resource.rb

@@ -1,8 +1,6 @@
 module ApiRecipes
   class Resource
 
-    attr_accessor :authorization, :basic_auth
-
     def initialize(name, endpoint, routes = {})
       @name = name
       @routes = routes
@@ -81,8 +79,9 @@ module ApiRecipes
     # e.g. webapp.alarms.index
     def generate_routes
       @routes.each do |route, attrs|
+        # Check if route name clashes with resource name
         if route.eql? @name
-          raise RouteNameClashError.new(route, @name)
+          raise RouteAndResourceNamesClashError.new(route, @name)
         end
         unless respond_to? route.to_sym
           define_singleton_method route.to_sym do |*params, &block|
@@ -95,8 +94,8 @@ module ApiRecipes
       self
     end
 
-    def per_kind_timeout
-      settings.fetch(:timeout, ApiRecipes::Settings::GLOBAL_TIMEOUT)/3.0
+    def timeout
+      settings.fetch(:timeout, ApiRecipes::Settings::GLOBAL_TIMEOUT)
     end
 
     def port
@@ -111,22 +110,15 @@ module ApiRecipes
     def request_with_auth
       req = HTTP
       req = req.headers(extract_headers)
-                .timeout(
-                    :global,
-                    write: per_kind_timeout,
-                    connect: per_kind_timeout,
-                    read: per_kind_timeout
-                )
+                .timeout(timeout)
 
+      basic_auth = @endpoint.basic_auth
       if basic_auth
         req = req.basic_auth basic_auth
-      elsif ba = @endpoint.basic_auth
-        req = req.basic_auth ba
       end
+      authorization = @endpoint.authorization
       if authorization
         req = req.auth authorization
-      elsif auth = @endpoint.authorization
-        req = req.auth auth
       end
       req
     end

data/lib/api_recipes/version.rb

@@ -1,3 +1,3 @@
 module ApiRecipes
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_recipes
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 4.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 4.1.1
 description: 
 email:
 - averlato@gmail.com
@@ -85,9 +85,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="