api_client_base 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0d7688c1ef8b38a3f6dabd86884a22d199f06793b66ac821e83560bfb3c9a52
-  data.tar.gz: 3ff78a2323c040fbac2c5b59963910c291273c1d096074b36af32333d943a616
+  metadata.gz: e748c8549dc84cfd16776fe9a92be6aafb043328916a80d88c5dbfd08e7b75d2
+  data.tar.gz: 145246c9dac0f31dace95aa41cf2b0183e706cfe112ba05831b7673f8ab8bd2e
 SHA512:
-  metadata.gz: 32eefbc1cf3d275bf534fc68611baa123ef809da3d7fd90af4116beb4912e9fb1f57aaca902a41ef0509a82f27676d38f16f2ec2cd08b568efbf76ddbf0345a3
-  data.tar.gz: c1eb95b14c639e6a29e23eb8a779a522fa6f7462239b2e35e0893de7d6d85a292665258715b73d3aebd2418abcf1f8222db38cd857399e6e42bf1723f07da7c7
+  metadata.gz: 418ac87d1b08d87a1f2931a977f88c7da8f4a2ddbe49d0d7d3933be3fc73a2f598358aa8eae468023b50ff677319f044efbf303dc0d246d4d6e6131affcedbcf
+  data.tar.gz: 3351c32d99bed922cb89e388ad815976819a09cf46bf8e995fd9fdfb0df1600fe5c88e13500401dca83c7c7d3203dbd224ec9a9d02287b2cb950386a4aec10cc

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.11.0] - 2021-11-26
+### Added
+- `after_response` hook
+- Add `#headers` and `#header(key)` methods to response for easy access to the headers
+
 ## [1.10.0] - 2021-06-15
 ### Added
 - `dry-validation` 1.x support (0.x support has not been dropped)

data/README.md

@@ -42,6 +42,8 @@ MyGem.configure do |c|
 end
 ```
 
+Note: there is a default configuration setting called `after_response`. See the "Response hooks" section for more details.
+
 - instantiate `MyGem::Client` by calling `MyGem.new(host: "https://api.com", username: "user", password: "password")`. If you do not specify an option, it will use the gem's default.
 
 ### Configuring the `Client`
@@ -240,7 +242,36 @@ module MyGem
 end
 ```
 
-You can an example gem at https://github.com/imacchiato/bridge_client-ruby.
+You can an example gem [here](https://github.com/bloom-solutions/binance_client-ruby).
+
+#### Response hooks
+
+If you want to give the applications access to the request and response objects after each response (useful when tracking rate limits that are reported in the response, for example), then:
+
+```ruby
+MyGem.configure do |c|
+  c.after_request = ->(request, response) do
+    if response.header("remaining-requets") < 20
+      Rails.logger.warn "mayday!"
+    end
+  end
+end
+```
+
+Note: the request and response objects are the request and response instances such as:
+- `GetUserResponse`
+- `GetUserRequest`
+
+You can assign any object that response to `call`:
+
+```ruby
+class AfterMyGemResponse
+  def self.call(request, response)
+  end
+end
+```
+
+Note: avoid putting long running/expensive requests here because this will block the Ruby process.
 
 ## Development
 
@@ -250,7 +281,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/imacchiato/api_client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bloom-solutions/api_client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/api_client_base.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Abstractions to help author API wrappers in Ruby.}
   spec.description   = %q{Abstractions to help author API wrappers in Ruby.}
-  spec.homepage      = "https://github.com/imacchiato/api_client-ruby"
+  spec.homepage      = "https://github.com/bloom-solutions/api_client-ruby"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

data/lib/api_client_base/base.rb

@@ -21,6 +21,10 @@ module APIClientBase
 
     included do
       include GemConfig::Base
+
+      with_configuration do
+        has :after_response
+      end
     end
 
   end

data/lib/api_client_base/client/attributes.rb

@@ -10,7 +10,7 @@ module APIClientBase
       private
 
       def self.inherit_attributes!(klass)
-        parent_module = klass.name.deconstantize.constantize
+        parent_module = _api_client_parent_module(klass)
         return unless parent_module.respond_to?(:configuration)
         parent_module.configuration.rules.each do |rule|
           self.inherit_attribute!(klass, rule)
@@ -21,6 +21,10 @@ module APIClientBase
         klass.attribute rule[0]
       end
 
+      def self._api_client_parent_module(klass)
+        klass.name.deconstantize.constantize
+      end
+
     end
   end
 end

data/lib/api_client_base/client/class_methods.rb

@@ -28,7 +28,11 @@ module APIClientBase
 
           request = request_class.new(request_args)
           raw_response = request.()
-          response_class.new(raw_response: raw_response)
+          response = response_class.new(raw_response: raw_response)
+
+          _api_client_call_hook_with request, response
+
+          response
         end
       end
 

data/lib/api_client_base/client.rb

@@ -22,6 +22,24 @@ module APIClientBase
     included do
       include APIClientBase::Client::Attributes
       extend APIClientBase::Client::ClassMethods
+
+      private
+
+      def _api_client_call_hook_with(request, response)
+        hook = _api_client_after_response
+        return if hook.nil?
+
+        hook.(request, response)
+      end
+
+      def _api_client_gem_module
+        @_api_client_gem_module ||= self.class.name.deconstantize.constantize
+      end
+
+      def _api_client_after_response
+        return nil if not _api_client_gem_module.respond_to?(:configuration)
+        _api_client_gem_module.configuration.after_response
+      end
     end
 
   end

data/lib/api_client_base/response.rb

@@ -26,6 +26,7 @@ module APIClientBase
       attribute :success, self::Boolean, lazy: true, default: :default_success
       attribute :code, Integer, lazy: true, default: :default_code
       attribute :body, String, lazy: true, default: :default_body
+      attribute :headers, Hash, lazy: true, default: :default_headers
     end
 
     def default_success
@@ -40,5 +41,13 @@ module APIClientBase
       raw_response.body
     end
 
+    def default_headers
+      (raw_response.headers || {}).transform_keys {|key| key.upcase }
+    end
+
+    def header(key)
+      headers[key.upcase]
+    end
+
   end
 end

data/lib/api_client_base/version.rb

@@ -1,3 +1,3 @@
 module APIClientBase
-  VERSION = "1.10.0"
+  VERSION = "1.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client_base
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -200,7 +200,7 @@ files:
 - lib/api_client_base/services/build_typhoeus_options.rb
 - lib/api_client_base/services/validate.rb
 - lib/api_client_base/version.rb
-homepage: https://github.com/imacchiato/api_client-ruby
+homepage: https://github.com/bloom-solutions/api_client-ruby
 licenses:
 - MIT
 metadata: