api_client_base 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab81c1e64a88897c1acdc27560853545889693a32398fce9ae64b5ba4b29c4ca
-  data.tar.gz: cea3469155ef8e303d168d8a3e9b6f28ce08915fd2b072ce4be433e909998846
+  metadata.gz: 4944507aab7a50bfa722d2ee9c712467c515dcb8fe030087ad98fd0f417a1129
+  data.tar.gz: 05662a54b48237e43bf69f07d1f21c505e3d6782a3f5cc9814b9109666ef26ef
 SHA512:
-  metadata.gz: 3983bbe59413269d8a4fa4e9b8d9791c6ec2ee1e4f4b8013aa570640575117ee7643420515bc9cf12fa9c5b7e27408090b75373f01219524c550e2c8f7937071
-  data.tar.gz: acd06f3eb25ce1337d47df1f95ab6a8db983db6243bd8f16562e0b4577dc7fdb862925ce145e19f57167a2781a4a3e9f01cff08e0523ac84a8beedf710bba40f
+  metadata.gz: d8179471df1171101b4701e16c1d8473c941c37e0a3eca87ed33fc02c908808a50cb4412186997baa77fade63ca963a6072d87920f7aade180856a07e1a5d41b
+  data.tar.gz: e840dee362e45038426e39958ab265787d3659c5248a95929f4346355786eae0f6c95a07960ae696f7a8946dc86691fd70fff3e915b6aa2840f3afa98302240d

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,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.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

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.3"
+
+gem "pry-byebug", "~> 3.9"
 gem "typhoeus"

data/README.md

@@ -197,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
@@ -206,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,29 +29,26 @@ 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,
-        )
-
+        request = Typhoeus::Request.new(uri, typhoeus_options)
         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
@@ -90,5 +87,15 @@ module APIClientBase
 
     def before_call; end
 
+    def typhoeus_options
+      BuildTyphoeusOptions.(
+        method: action,
+        headers: headers,
+        body: body,
+        params: params,
+        proxy: proxy,
+      )
+    end
+
   end
 end

data/lib/api_client_base/services/build_typhoeus_options.rb

@@ -0,0 +1,26 @@
+module APIClientBase
+  class BuildTyphoeusOptions
+
+    def self.call(
+      method: nil,
+      headers: nil,
+      body: nil,
+      params: nil,
+      proxy: nil
+    )
+      opts = {
+        method: method,
+        headers: headers,
+        body: body,
+        params: params,
+      }
+
+      if proxy.present?
+        opts[:proxy] = proxy
+      end
+
+      opts
+    end
+
+  end
+end

data/lib/api_client_base/version.rb

@@ -1,3 +1,3 @@
 module APIClientBase
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client_base
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2020-04-09 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
@@ -199,8 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Abstractions to help author API wrappers in Ruby.