restful_resource 2.13.3 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f578b915d89258f07c42764c2145d2c2d312a5c433150b8ffc9aaf0928ac9afd
-  data.tar.gz: 474ee1332121730907f668e7f27f8e9eedd68c97039a5460be734bf8eaf32611
+  metadata.gz: 9f2c32b411aee9609b0df3982688270ef55fe0ba8f8e15c472f6ec16d5562104
+  data.tar.gz: 71978eaef61ece9aba34fecf03268d83fb1e6d24c81cd4922eebcecc683f2431
 SHA512:
-  metadata.gz: 200b5161e691223658fdc487251f1136b13a099c7bc59fef225080455c40d720239d6a6924b3935edc5bcf9aa42e8668d71983955aa04c1e8e049879f170e5db
-  data.tar.gz: e28af4d1460c452b0a51d966e3899a0ded290dc79177d85b320d94a22b4d61a88a2a1acae1b5179021bba6c6f925b0c8d3923875a9fdbcbf8a60335dbc8f4239
+  metadata.gz: 06e10e1280f1d428c879366832f6ec9d74105a9c77c958e82734ffb41f01b1590544023f385f69b148bbc9c57577c58493c65d97e901d2eba30cbb292380e769
+  data.tar.gz: 04a45aca352e95e2ef502ae084c1546f828a833bacbc18fb6a3ee053689aefad8b2cce6d79b891c4cc6ed4e30b0b4faf8c2238f6791700c0d88d38b48ab91fc1

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 # Changelog
+2.14
+---
+
+- Added support for default headers when configuring a `RestfulResource::Base`
+
+2.13.4
+---
+
+- Support passing a an instance of `RestfulResource::Response` to the constructor for a `RestfulResource::HttpClient::HttpError`
+
 2.13.3
 ---
 

data/lib/restful_resource/base.rb

@@ -12,7 +12,9 @@ module RestfulResource
       timeout: nil,
       open_timeout: nil,
       faraday_config: nil,
-      faraday_options: {})
+      faraday_options: {},
+      default_headers: {}
+    )
 
       @base_url = URI.parse(base_url)
 
@@ -25,7 +27,8 @@ module RestfulResource
                                               open_timeout: open_timeout,
                                               instrumentation: instrumentation,
                                               faraday_config: faraday_config,
-                                              faraday_options: faraday_options
+                                              faraday_options: faraday_options,
+                                              default_headers: default_headers
                                              )
     end
 

data/lib/restful_resource/http_client.rb

@@ -11,8 +11,12 @@ module RestfulResource
         @response = assign_response(response)
       end
 
-      def assign_response(response = nil)
-        @response = if response
+      private
+
+      def assign_response(response)
+        @response = if response.is_a?(Response)
+                      response
+                    elsif response
                       Response.new(body: response[:body], headers: response[:headers], status: response[:status])
                     else
                       Response.new
@@ -88,7 +92,9 @@ module RestfulResource
       timeout: nil,
       open_timeout: nil,
       faraday_config: nil,
-      faraday_options: {})
+      faraday_options: {},
+      default_headers: {}
+    )
       api_name = instrumentation[:api_name]            ||= 'api'
       instrumentation[:request_instrument_name]        ||= "http.#{api_name}"
       instrumentation[:cache_instrument_name]          ||= "http_cache.#{api_name}"
@@ -119,6 +125,8 @@ module RestfulResource
                                                         faraday_options: faraday_options
                                                        )
 
+      @connection.headers.merge!(default_headers)
+
       if auth_token
         @connection.headers[:authorization] = "Bearer #{auth_token}"
       elsif username && password

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.13.3'.freeze
+  VERSION = '2.14.0'.freeze
 end

data/spec/restful_resource/base_spec.rb

@@ -390,33 +390,38 @@ RSpec.describe RestfulResource::Base do
     let(:open_timeout) { double }
     let(:faraday_config) { double }
     let(:faraday_options) { double }
+    let(:default_headers) { double }
 
     it 'passes arguments to HttpClient' do
       client = Class.new(described_class)
-      expect(RestfulResource::HttpClient).to receive(:new).with(username: username,
-                                                                password: password,
-                                                                auth_token: auth_token,
-                                                                logger: logger,
-                                                                cache_store: cache_store,
-                                                                instrumentation: instrumentation,
-                                                                timeout: timeout,
-                                                                open_timeout: open_timeout,
-                                                                faraday_config: faraday_config,
-                                                                faraday_options: faraday_options
-                                                               )
-
-      client.configure(base_url: 'http://foo.bar',
-                       username: username,
-                       password: password,
-                       auth_token: auth_token,
-                       logger: logger,
-                       cache_store: cache_store,
-                       instrumentation: instrumentation,
-                       timeout: timeout,
-                       open_timeout: open_timeout,
-                       faraday_config: faraday_config,
-                       faraday_options: faraday_options
-                      )
+      expect(RestfulResource::HttpClient).to receive(:new).with(
+        username: username,
+        password: password,
+        auth_token: auth_token,
+        logger: logger,
+        cache_store: cache_store,
+        instrumentation: instrumentation,
+        timeout: timeout,
+        open_timeout: open_timeout,
+        faraday_config: faraday_config,
+        faraday_options: faraday_options,
+        default_headers: default_headers
+      )
+
+      client.configure(
+        base_url: 'http://foo.bar',
+        username: username,
+        password: password,
+        auth_token: auth_token,
+        logger: logger,
+        cache_store: cache_store,
+        instrumentation: instrumentation,
+        timeout: timeout,
+        open_timeout: open_timeout,
+        faraday_config: faraday_config,
+        faraday_options: faraday_options,
+        default_headers: default_headers
+      )
     end
   end
 

data/spec/restful_resource/http_client_spec.rb

@@ -271,4 +271,16 @@ RSpec.describe RestfulResource::HttpClient do
       expect(response.status).to eq 200
     end
   end
+
+  describe 'default headers' do
+    it 'uses default headers' do
+      connection = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/get', 'Foo' => 'bar') { |_env| [200, {}, nil] }
+      end
+
+      response = described_class.new(connection: connection, default_headers: { foo: 'bar' }).get('http://httpbin.org/get')
+
+      expect(response.status).to eq 200
+    end
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 2.13.3
+  version: 2.14.0
 platform: ruby
 authors:
 - David Santoro
 - Federico Rebora
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -297,7 +297,7 @@ homepage: http://www.github.com/carwow/restful_resource
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -313,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A simple activerecord inspired rest resource base class implemented using
   rest-client