nxt_http_client 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a9156afeb06fcba2f57308d7a0ef33582d4e14dd2f1673fdec05fd4173fdd73
-  data.tar.gz: f39565c9ab124f24ca55df92c5664037c7a116bf749f8d4acc0ccc502a0e9a54
+  metadata.gz: 22aa2f16ec7170133779ae75097fdd0c164a3a3a793a98f8d565d6ddfd2ca96c
+  data.tar.gz: c21b929937fe483cd7d56754d50ba37ae9d83b10bb120e5b772b425f3a04e559
 SHA512:
-  metadata.gz: af06d4cbc5dfa2aa713e70f8e93bdff96f0e8669691b14d75e194306019d1e5f879f77f894d0d6afe673419a548d41faf4fbf34c5fb0ea704f6c6dc5b6408712
-  data.tar.gz: 73d399f7d6ceb3ed38312f7b98d0f825e697be53920a177dad2558fc2a4066146d5eb6413ec1b56957cee08b50b374d7cc8238f70827faaef823d52e4b81f355
+  metadata.gz: be208ed0c5e3b617d48dcca068c8c588e9748ab34f23a538d9039f6b7ed1649dd96f54ec0dbb716de3c823b5f6ff452b06eadfd79a85514f97106d4fef0d7fd4
+  data.tar.gz: 0743b9d3371ff51381c8a0f5b45547bc86302f0282e8064fe7a93f268e195361ca055ed7a085df38b82653909542488cd6de02a2d5b95abcf547068215097278

data/.circleci/config.yml

@@ -0,0 +1,57 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7.0-node
+      - image: circleci/redis:5.0.4
+    environment:
+      BUNDLER_VERSION: 2.1.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run: gem install bundler --version $BUNDLER_VERSION
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_artifacts:
+          path: /tmp/rspec/
+          destination: rspec
+
+      - store_test_results:
+          path: /tmp/rspec/

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# v0.2.10 2020-03-10
+
+### Refactored
+
+- [internal] Added CHANGELOG.MD
+- Refactored a bit
+
+[Compare v0.2.9...v0.2.10](https://github.com/nxt-insurance/nxt_http_client/compare/v0.2.9...v0.2.10)

data/Gemfile.lock

@@ -1,66 +1,73 @@
 PATH
   remote: .
   specs:
-    nxt_http_client (0.2.5)
-      activesupport (~> 5.2)
+    nxt_http_client (0.3.0)
+      activesupport (~> 6.0.0)
+      nxt_registry
       typhoeus
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.11.1)
-    hashdiff (1.0.0)
-    i18n (1.6.0)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
-    minitest (5.11.3)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    nxt_registry (0.2.0)
+      activesupport
     nxt_vcr_harness (0.1.3)
       rspec (~> 3.0)
       vcr (~> 5.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.1.1)
-    rake (10.5.0)
-    redis (4.1.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.3)
+    rake (13.0.1)
+    redis (4.2.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     safe_yaml (1.0.5)
     thread_safe (0.3.6)
-    typhoeus (1.3.1)
+    typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    vcr (5.0.0)
-    webmock (3.6.0)
+    vcr (5.1.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -70,11 +77,12 @@ DEPENDENCIES
   nxt_http_client!
   nxt_vcr_harness
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   redis
   rspec (~> 3.0)
+  rspec_junit_formatter
   vcr
   webmock
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -1,8 +1,8 @@
 # NxtHttpClient
 
-Build http clients with ease. NxtHttpClient is a simple DSL on top of the typhoeus gem.
-The idea is that you can configure a client on the class level and then adjust or further configure
-request options on an instance level. All http interactions are handled by typhoeus. If you need to 
+Build http clients with ease. NxtHttpClient is a simple DSL on top of the awesome typhoeus gem.
+The idea is that you can configure your http clients on the class level and then adjust or further configure
+request options on the instance level. All http interactions are handled by typhoeus. If you need to 
 access the original `Typhoeus::Request` in your instance, you can do that. 
 
 ## Installation
@@ -43,6 +43,7 @@ class MyClient < NxtHttpClient
   
   register_response_handler do |handler|
     handler.on(:error) do |response|
+      Raven.extra_context(error_details: error.to_h) # call error.to_h to inspect request and response
       raise StandardError, "I can't handle this: #{response.code}"
     end
   end

data/lib/nxt_http_client.rb

@@ -1,5 +1,6 @@
 require 'active_support/all'
 require 'typhoeus'
+require 'nxt_registry'
 
 require 'nxt_http_client/version'
 require 'nxt_http_client/response_handler'

data/lib/nxt_http_client/client.rb

@@ -1,51 +1,22 @@
 module NxtHttpClient
   class Client
     extend ClientDsl
-    CACHE_STRATEGIES = %w[global thread]
+    CACHE_STRATEGIES = %w[global thread].freeze
+    HTTP_METHODS = %w[get post patch put delete head].freeze
 
     def build_request(url, **opts)
-      base_url = opts.delete(:base_url) || default_config.base_url
-      url = [base_url, url].reject(&:blank?).join('/')
-
-      duplicated_slashes = url.match(/([^:]\/{2,})/)
-      duplicated_slashes && duplicated_slashes.captures.each do |capture|
-        url.gsub!(capture, "#{capture[0]}/")
-      end
-
-      opts = default_config.request_options.with_indifferent_access.deep_merge(opts.with_indifferent_access)
-      opts[:headers] ||= {}
-
-      if default_config.x_request_id_proc
-        opts[:headers]['X-Request-ID'] ||= default_config.x_request_id_proc.call
-      end
-
-      if opts[:cache] ||= false
-        strategy = opts.delete(:cache)
-
-        case strategy.to_s
-        when 'thread'
-          cache_key = Thread.current[:nxt_http_client_cache_key] ||= "#{SecureRandom.base58}::#{DateTime.current}"
-          opts[:headers].reverse_merge!(cache_key: cache_key)
-        when 'global'
-          opts[:headers].delete(:cache_key)
-        else
-          raise ArgumentError, "Cache strategy unknown: #{strategy}. Options are #{CACHE_STRATEGIES}"
-        end
-      end
+      url = build_url(opts, url)
+      opts = build_headers(opts)
 
       Typhoeus::Request.new(url, **opts.symbolize_keys)
     end
 
-    def fire(url = '', **opts, &block)
-      # calling_method = caller_locations(1,1)[0].label
-      response_handler = opts.fetch(:response_handler) do
-        dup_handler_from_class || NxtHttpClient::ResponseHandler.new
-      end
+    delegate :before_fire_callback, :after_fire_callback, to: :class
 
+    def fire(url = '', **opts, &block)
+      response_handler = opts.fetch(:response_handler) { dup_handler_from_class || NxtHttpClient::ResponseHandler.new }
       response_handler.configure(&block) if block_given?
-      request = build_request(url, opts.except(:response_handler))
-
-      before_fire_callback = self.class.before_fire_callback
+      request = build_request(url, **opts.except(:response_handler))
       before_fire_callback && instance_exec(self, request, response_handler, &before_fire_callback)
 
       if response_handler.callbacks['headers']
@@ -61,20 +32,17 @@ module NxtHttpClient
       end
 
       result = nil
-      error = nil
+      current_error = nil
 
       request.on_complete do |response|
-        callback = response_handler.callback_for_response(response)
-        result = callback && instance_exec(response, &callback) || response
-      rescue StandardError => e
-        error = e
+        result = callback_or_response(response, response_handler)
+      rescue StandardError => error
+        current_error = error
       ensure
-        after_fire_callback = self.class.after_fire_callback
-
         if after_fire_callback
-          result = instance_exec(self, request, response, result, error, &after_fire_callback)
+          result = instance_exec(self, request, response, result, current_error, &after_fire_callback)
         else
-          result || (raise error)
+          result || (raise current_error)
         end
       end
 
@@ -83,10 +51,32 @@ module NxtHttpClient
       result
     end
 
-    %w[get post patch put delete head].each do |method|
+    HTTP_METHODS.each do |method|
       define_method method do |url = '', **opts, &block|
-        fire(url, opts.reverse_merge(method: method), &block)
+        fire(url, **opts.reverse_merge(method: method), &block)
+      end
+    end
+
+    private
+
+    def build_url(opts, url)
+      base_url = opts.delete(:base_url) || default_config.base_url
+      url = [base_url, url].reject(&:blank?).join('/')
+
+      url_without_duplicated_hashes(url)
+      url
+    end
+
+    def build_headers(opts)
+      opts = default_config.request_options.with_indifferent_access.deep_merge(opts.with_indifferent_access)
+      opts[:headers] ||= {}
+
+      if default_config.x_request_id_proc
+        opts[:headers]['X-Request-ID'] ||= default_config.x_request_id_proc.call
       end
+
+      build_cache_header(opts)
+      opts
     end
 
     def dup_handler_from_class
@@ -96,5 +86,35 @@ module NxtHttpClient
     def default_config
       self.class.default_config
     end
+
+    def build_cache_header(opts)
+      if opts[:cache] ||= false
+        strategy = opts.delete(:cache)
+
+        case strategy.to_s
+        when 'thread'
+          cache_key = Thread.current[:nxt_http_client_cache_key] ||= "#{SecureRandom.base58}::#{DateTime.current}"
+          opts[:headers].reverse_merge!(cache_key: cache_key)
+        when 'global'
+          opts[:headers].delete(:cache_key)
+        else
+          raise ArgumentError, "Cache strategy unknown: #{strategy}. Options are #{CACHE_STRATEGIES}"
+        end
+      end
+    end
+
+    def url_without_duplicated_hashes(url)
+      duplicated_slashes = url.match(/([^:]\/{2,})/)
+      duplicated_slashes && duplicated_slashes.captures.each do |capture|
+        url.gsub!(capture, "#{capture[0]}/")
+      end
+
+      url
+    end
+
+    def callback_or_response(response, response_handler)
+      callback = response_handler.callback_for_response(response)
+      callback && instance_exec(response, &callback) || response
+    end
   end
 end

data/lib/nxt_http_client/client_dsl.rb

@@ -1,9 +1,7 @@
 module NxtHttpClient
   module ClientDsl
     def configure(opts = {}, &block)
-      opts.each do |k,v|
-        default_config.send(k, v)
-      end
+      opts.each { |k, v| default_config.send(k, v) }
       default_config.tap { |d| block.call(d) }
       default_config
     end
@@ -13,7 +11,7 @@ module NxtHttpClient
     end
 
     def before_fire_callback
-      @before_fire ||= dup_instance_variable_from_ancestor_chain(:@before_fire_callback)
+      @before_fire_callback ||= dup_instance_variable_from_ancestor_chain(:@before_fire_callback)
     end
 
     def after_fire(&block)
@@ -44,21 +42,16 @@ module NxtHttpClient
     end
 
     def instance_variable_from_ancestor_chain(instance_variable_name)
-      client = client_ancestors.find do |client|
-        client.instance_variable_get(instance_variable_name)
-      end
+      client = client_ancestors.find { |c| c.instance_variable_get(instance_variable_name) }
 
       client.instance_variable_get(instance_variable_name)
     end
 
     def dup_instance_variable_from_ancestor_chain(instance_variable_name)
       result = instance_variable_from_ancestor_chain(instance_variable_name).dup
+      return result unless block_given?
 
-      if block_given?
-        result || yield
-      else
-        result
-      end
+      result || yield
     end
   end
 end

data/lib/nxt_http_client/default_config.rb

@@ -1,5 +1,5 @@
 module NxtHttpClient
-  CONFIGURABLE_OPTIONS = %i[request_options base_url x_request_id_proc]
+  CONFIGURABLE_OPTIONS = %i[request_options base_url x_request_id_proc].freeze
 
   DefaultConfig = Struct.new('DefaultConfig', *CONFIGURABLE_OPTIONS) do
     def initialize(request_options: ActiveSupport::HashWithIndifferentAccess.new, base_url: '', x_request_id_proc: nil)
@@ -7,5 +7,9 @@ module NxtHttpClient
       self.base_url = base_url
       self.x_request_id_proc = x_request_id_proc
     end
+
+    def dup
+      self.class.new(**to_h.deep_dup)
+    end
   end
 end

data/lib/nxt_http_client/error.rb

@@ -2,9 +2,10 @@ module NxtHttpClient
   class Error < StandardError
     def initialize(response)
       @response = response.blank? ? Typhoeus::Response.new : response
+      @id = SecureRandom.uuid
     end
 
-    attr_reader :response
+    attr_reader :response, :id
 
     def to_s
       "NxtHttpClient::Error::#{response_code}"
@@ -12,6 +13,7 @@ module NxtHttpClient
 
     def to_h
       {
+        id: id,
         url: url,
         response_code: response_code,
         request_options: request_options,

data/lib/nxt_http_client/response_handler.rb

@@ -1,18 +1,18 @@
 module NxtHttpClient
   class ResponseHandler
     CallbackAlreadyRegistered = Class.new(StandardError)
+    include NxtRegistry
 
     def initialize
-      @callbacks = {}
       @result = nil
     end
 
     attr_accessor :result
-    attr_reader :callbacks
 
     def eval_callback(target, key, response)
-      return unless callbacks[key]
-      target.instance_exec(response, &callbacks[key])
+      return unless callbacks.resolve!(key)
+
+      target.instance_exec(response, &callbacks.resolve(key))
     end
 
     def configure(&block)
@@ -20,21 +20,19 @@ module NxtHttpClient
     end
 
     def register_callback(code, overwrite: false, &block)
-      key = code.to_s
-      # This would add callbacks to the response handler
-      unless overwrite
-        callbacks[key].present? && raise_callback_already_registered(code)
+      if overwrite
+        callbacks.register!(code, block)
+      else
+        callbacks.register(code, block)
       end
-
-      callbacks[key] = block
     end
 
     def register_callback!(code, &block)
       register_callback(code, overwrite: true, &block)
     end
 
-    alias_method :on, :register_callback
-    alias_method :on!, :register_callback!
+    alias on register_callback
+    alias on! register_callback!
 
     def callback_for_response(response)
       key_from_response = response.code.to_s
@@ -46,10 +44,18 @@ module NxtHttpClient
       end
 
       first_matching_key && callbacks[first_matching_key] ||
-      response.success? && callbacks['success'] ||
-      response.timed_out? && callbacks['timed_out'] ||
-      !response.success? && callbacks['error'] ||
-      callbacks['others']
+        response.success? && callbacks['success'] ||
+        response.timed_out? && callbacks['timed_out'] ||
+        !response.success? && callbacks['error'] ||
+        callbacks['others']
+    end
+
+    def callbacks
+      @callbacks ||= NxtRegistry::Registry.new(
+        :callbacks,
+        call: false,
+        on_key_already_registered: ->(key) { raise_callback_already_registered(key) }
+      )
     end
 
     private
@@ -60,10 +66,9 @@ module NxtHttpClient
       raise CallbackAlreadyRegistered, msg
     end
 
-    # we need to dup callbacks since dup is shallow
     def initialize_copy(original)
       super
-      @callbacks = original.send(:callbacks).dup
+      @callbacks = original.send(:callbacks).clone
       @result = nil
     end
   end

data/lib/nxt_http_client/version.rb

@@ -1,3 +1,3 @@
 module NxtHttpClient
-  VERSION = "0.2.5"
+  VERSION = '0.3.0'
 end

data/nxt_http_client.gemspec

@@ -36,14 +36,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'typhoeus'
-  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'activesupport', '~> 6.0.0'
+  spec.add_dependency 'nxt_registry'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'nxt_vcr_harness'
   spec.add_development_dependency 'redis'
+  spec.add_development_dependency 'rspec_junit_formatter'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_http_client
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -33,14 +33,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: nxt_registry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -61,14 +75,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +167,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: NxtHttpClinet allows you to easily create and configure http clients.
 email:
 - a.robecke@getsafe.de
@@ -160,9 +188,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -200,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: NxtHttpClinet is a simple DSL on top the typhoeus http gem