restful_resource 2.17.0 → 2.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f1e1688884fd8954caa9da4cef1a9d2c3a1e294ded09414ce82a3865cf40e30
-  data.tar.gz: cb8672227647b41612c0a6a9ba739dde8705fb353369347106b037cc4c2a45c2
+  metadata.gz: ae9742d01111654892905db77a9f9e81ba74faf1924a438db004192dc748a6f8
+  data.tar.gz: 2434e333866d1642800b5624a5602be68be0ef6c496cd7bfdc655ef9c16e7910
 SHA512:
-  metadata.gz: 676a02c4acb372b64b6a82e628cef146a2043709cecb56a9819e37ce253d15af0f386db2a9d6e08a5c9b02d5e7e8895b61e88af7065f560c941ccad1400a8daa
-  data.tar.gz: e5ebf7348404ce117ac51963c23969754adbc144fbd97cc8ee4a967a80fe8c0a1a162ce55824800f5afd321167efe240fdb97226d05ded37fb74ba67209d6f4d
+  metadata.gz: f91c478064cd2c7caa343fdd8327c616c8e8f276fae93f7ab1ffe0be7f7e517b7ec6e92be254ece7da2e47aa7cdad002ce3649a6747ee1c777b700a50b587b06
+  data.tar.gz: f0d2700f5ed096c09427175d7a7a7c909c1e8f0be1f68b2bc107d0de36801f6e36e6acd26cb94f41c4f64de30671dc798cc57c4d4fb6346e83a083265b01558f

data/CHANGELOG.md

@@ -1,4 +1,15 @@
 # Changelog
+2.18.1
+---
+
+- Explicitly require 'ostruct' to prevent load error
+
+2.18
+---
+
+- Configure Faraday's default adapter as `net_http`
+- Fix `X-Client-Start` & `X-Client-Timeout` headers to be strings not integers
+
 2.17
 ---
 

data/README.md

@@ -102,6 +102,14 @@ Metrics.sample('rails_site.api.cache_bypass', 1) # When a request did not go thr
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Releasing new version
+
+1. Amend the `version.rb` to your desired version on your Pull Request & get it merged
+2. Pull latest `main` & create a matching tag e.g.: `git tag -a v2.15.0 -m "Bump Faraday to a minimum 1.10"`
+3. Push the tag e.g.: ` git push origin v2.15.0`
+4. Run `bundle exec rake release`
+    - You'll need to authenticate with RubyGems, the credentials are in [Bitwarden](https://vault.bitwarden.com/#/vault?search=ruby&itemId=54601528-29be-494f-ba3c-aa3300d5dd18)
+
 ## Planned Features
 
 ### Core

data/lib/restful_resource/http_client.rb

@@ -1,6 +1,3 @@
-# Use the Faraday-Typhoeus adapter provided by Typhoeus, not Faraday
-require 'typhoeus/adapters/faraday'
-
 module RestfulResource
   class HttpClient
     class HttpError < StandardError
@@ -240,7 +237,7 @@ module RestfulResource
         b.response :encoding
         b.use :gzip
 
-        b.adapter :typhoeus
+        b.adapter Faraday.default_adapter
       end
     end
 
@@ -261,7 +258,7 @@ module RestfulResource
         req.url request.url
 
         req.headers = req.headers.merge(request.headers).merge(x_client_start: time_current_ms)
-        req.headers = req.headers.merge(x_client_timeout: req.options[:timeout]) if req.options[:timeout]
+        req.headers = req.headers.merge(x_client_timeout: req.options[:timeout]&.to_s) if req.options[:timeout]
       end
 
       Response.new(body: response.body, headers: response.headers, status: response.status)
@@ -295,7 +292,7 @@ module RestfulResource
     end
 
     def time_current_ms
-      (Time.current.to_f * 1_000.0).to_i
+      (Time.current.to_f * 1_000.0).to_i.to_s
     end
   end
 end

data/lib/restful_resource/strict_open_struct.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module RestfulResource
   class StrictOpenStruct < ::OpenStruct
     deprecate :dig, :[], deprecator: Base::Deprecator

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.17.0'.freeze
+  VERSION = '2.18.1'.freeze
 end

data/restful_resource.gemspec

@@ -34,5 +34,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday_middleware', '~> 1.0'
   spec.add_dependency 'link_header'
   spec.add_dependency 'rack', '~> 2.2'
-  spec.add_dependency 'typhoeus', '~> 1.4'
 end

data/spec/restful_resource/http_client_configuration_spec.rb

@@ -18,8 +18,8 @@ describe RestfulResource::HttpClient do
     let(:middleware) { connection.builder.handlers }
 
     describe 'Builder configuration' do
-      it 'uses the typhoeus adapter' do
-        expect(connection.adapter).to eq Faraday::Adapter::Typhoeus
+      it 'uses the net http adapter' do
+        expect(connection.adapter).to eq Faraday::Adapter::NetHttp
       end
 
       it 'url_encodes requests' do

data/spec/restful_resource/http_client_spec.rb

@@ -221,7 +221,7 @@ RSpec.describe RestfulResource::HttpClient do
 
     context 'when explicit timeout set on connection' do
       let(:timeout) { 5 }
-      let(:required_headers) { { 'X-Client-Timeout' => 5 } }
+      let(:required_headers) { { 'X-Client-Timeout' => '5' } }
 
       it 'sets X-Client-Timeout correctly' do
         response = http_client.get('http://httpbin.org/get')
@@ -243,7 +243,7 @@ RSpec.describe RestfulResource::HttpClient do
 
     context 'when set on request' do
       let(:timeout) { nil }
-      let(:required_headers) { { 'X-Client-Timeout' => 1 } }
+      let(:required_headers) { { 'X-Client-Timeout' => '1' } }
 
       it 'sets X-Client-Timeout correctly' do
         response = http_client.get('http://httpbin.org/get', timeout: 1)
@@ -255,7 +255,7 @@ RSpec.describe RestfulResource::HttpClient do
 
   describe 'X-Client-Start' do
     let(:now) { Time.current }
-    let(:required_headers) { { 'X-Client-Start' => (now.to_f * 1000.0).to_i } }
+    let(:required_headers) { { 'X-Client-Start' => (now.to_f * 1000.0).to_i.to_s } }
     let(:http_client) { described_class.new(connection: connection) }
     let(:connection) do
       conn = faraday_connection do |stubs|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 2.18.1
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -227,20 +227,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 description: A simple activerecord inspired rest resource base class implemented using
   rest-client
 email: