api_client_base 1.4.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b20a668021e8155ac1a9f45863a2bf24c8671d529d6050d4c7d351d4a67475
-  data.tar.gz: 295d032174dbbf604bc1f7fa39ad81e53fd6fb0466a48325f96e2c4a728726d3
+  metadata.gz: 8b9fd36954265d22fd5c8b2ae143ccf63a54b941ffbfd4230022683501e5b674
+  data.tar.gz: 5bf06572c3e6c65ccc66dd6c98e650c8cd33b639f720b5cbd56a397daa8815e1
 SHA512:
-  metadata.gz: 715769a66ce42746dff5ed6b09e4fd9c20e7476e2dbc76d0780f3d542a4d6ddc4ec7ab06d2a325de5da9f4888db10efc1e45ed06857cd7eb0d55c57387758fe4
-  data.tar.gz: 8091fb4977f8b329a9f55865913351e51ba1fd1be20f8f018d76fe7fc6fd91b1b86540f9f76f6cb6c21a952d66027fedef2bbea63a6bb59cd68e717a586c0e91
+  metadata.gz: d4e2dcc49429d9d20a65daff58d433aeb0170e0b5b0bbf9fc2feb2121be17ea28894e8a196175e095eb8f29526042d4418e2d0822a22e1c80aecc0c8eec56638
+  data.tar.gz: 441e6aeeb41f95255f35522f43e558370df1cc25b6954684c5eea40b0a4d0bffb6d47e10be187b209f9fd21515f3f4559a70a7a4d557d971edbedd408a5c8491

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+/.smartgf*

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.13.1
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -4,6 +4,27 @@ 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.9.0] - 2020-06-30
+### Added
+- Allow users to override typhoeus_options to pass any args that we haven't defined
+
+## [1.8.0] - 2020-06-30
+### Added
+- Allow all Typhoeus options to be passed to BuildTyphoeusOptions. This is useful when overriding the method `typhoeus_options` in requests
+
+## [1.7.0] - 2020-04-15
+### Added
+- Add `Response#body` which is `raw_response`'s `body`
+
+## [1.6.0] - 2020-04-09
+### Added
+- Move http-related code to Request#run. This is the one that should be overridden, instead of call, since `#call` calls other methods like `before_call`
+- Set `#proxy` attribute to requests. This is passed to Typhoeus if present
+
+## [1.5.0] - 2019-04-03
+### Added
+- Allow developer to define `before_call` in requests to execute code
+
 ## [1.4.1] - 2019-01-30
 ### Fixed
 - `host` configuration should not remove the path

data/Gemfile

@@ -3,5 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in api_client_base.gemspec
 gemspec
 
-gem "pry-byebug"
+ruby "2.6.5"
+
+gem "pry-byebug", "~> 3.9"
 gem "typhoeus"

data/README.md

@@ -154,6 +154,14 @@ module MyGem
     def default_action
       :post # defaults to :get
     end
+
+    def before_call
+      # You need not define this, but it might be helpful if you want to log things, for example, before the http request is executed.
+      # The following example would require you to define a `logger` attribute
+
+      self.logger.debug "Will make a #{action} call: #{body}"
+    end
+
   end
 end
 ```
@@ -189,6 +197,9 @@ client = MyGem::Client.new #...
 client.get_user(user_id: nil) # -> this raises an ArgumentError "[user_id: 'must be filled']"
 ```
 
+##### Proxy
+Requests automatically have `proxy`. If set and you are relying on using Typhoeus, proxy will be passed on and used by Typhoeus.
+
 #### Responses
 
 ```ruby
@@ -198,6 +209,7 @@ module MyGem
     # - has `#status` method that is delegated to `raw_response.status`
     # - has `#code` method to get the response's code
     # - has `#raw_response` which is a Typhoeus response object
+    # - has `#success` which is delegated to `raw_response.success?`. May be accessed via `#success?`
 
     # You're encouraged to use Virtus attributes to extract information cleanly
     attribute :id, Integer, lazy: true, default: :default_id

data/api_client_base.gemspec

@@ -34,11 +34,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "virtus", ">= 1.0"
   spec.add_dependency "gem_config", ">= 0.3.1"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "virtus-matchers"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "dry-validation"
+  spec.add_development_dependency "dry-validation", "< 1.0"
 end

data/lib/api_client_base.rb

@@ -7,6 +7,7 @@ require "gem_config"
 require "virtus"
 require "api_client_base/version"
 require "api_client_base/services/validate"
+require "api_client_base/services/build_typhoeus_options"
 require "api_client_base/base"
 require "api_client_base/base/class_methods"
 require "api_client_base/client"

data/lib/api_client_base/request.rb

@@ -29,27 +29,35 @@ module APIClientBase
         lazy: true,
         default: :default_api_client_base_path,
       })
+      attribute :proxy, String
     end
 
     def call
+      before_call
+      run
+    end
+
+    private
+
+    def run
       require "typhoeus"
       if defined?(Typhoeus)
-        request = Typhoeus::Request.new(
-          uri,
-          method: action,
-          headers: headers,
-          body: body,
-          params: params,
+        opts = BuildTyphoeusOptions.(
+          {
+            method: action,
+            headers: headers,
+            body: body,
+            params: params,
+            proxy: proxy,
+          }.merge(typhoeus_options)
         )
-
+        request = Typhoeus::Request.new(uri, opts)
         request.run
       else
-        fail "Either override #call or make sure Typhoeus is available for use."
+        fail "Either override #run or make sure Typhoeus is available for use."
       end
     end
 
-    private
-
     def headers ; {}  ; end
     def body    ; nil ; end
     def params  ; {}  ; end
@@ -63,8 +71,8 @@ module APIClientBase
               path = URI.parse(host).path
               if path.present?
                 URI.join(
-                  host, 
-                  [path, "/"].join, 
+                  host,
+                  [path, "/"].join,
                   api_client_base_path[1..-1]
                 )
               else
@@ -86,5 +94,11 @@ module APIClientBase
       end
     end
 
+    def before_call; end
+
+    def typhoeus_options
+      {}
+    end
+
   end
 end

data/lib/api_client_base/response.rb

@@ -25,6 +25,7 @@ module APIClientBase
       attribute :raw_response, Object
       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
     end
 
     def default_success
@@ -35,5 +36,9 @@ module APIClientBase
       raw_response.code
     end
 
+    def default_body
+      raw_response.body
+    end
+
   end
 end

data/lib/api_client_base/services/build_typhoeus_options.rb

@@ -0,0 +1,13 @@
+module APIClientBase
+  class BuildTyphoeusOptions
+
+    def self.call(opts={})
+      if opts[:proxy].blank?
+        opts = opts.except(:proxy)
+      end
+
+      opts
+    end
+
+  end
+end

data/lib/api_client_base/version.rb

@@ -1,3 +1,3 @@
 module APIClientBase
-  VERSION = "1.4.1"
+  VERSION = "1.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client_base
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Ramon Tayag
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,16 +140,16 @@ dependencies:
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: Abstractions to help author API wrappers in Ruby.
 email:
 - ramon.tayag@gmail.com
@@ -177,6 +177,7 @@ files:
 - lib/api_client_base/client/class_methods.rb
 - lib/api_client_base/request.rb
 - lib/api_client_base/response.rb
+- 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
@@ -184,7 +185,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,9 +200,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Abstractions to help author API wrappers in Ruby.
 test_files: []