flexirest 1.12.0 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 530331988751770dc906ba6b17ffafa88cc5213f8c99a67fb8e6335af2152082
-  data.tar.gz: a55ce84b1ac4e3b1e17df27abefd3e2d9c7250a22e4368c5806a318a29ac72cd
+  metadata.gz: c7e62a7d0f69e17e808ebb5a91e63805618a5a0e9dee6fa4e1fabbbbe46c065b
+  data.tar.gz: e1961e477b96fac798530f5ea1dccdd55a6c1e1aca9f169f848492184d4b6820
 SHA512:
-  metadata.gz: ef1ac1a698388648711b665eccbb43f0f52d751a75abe156221081f84198cdd3c426d6643db563f9bd57af9813c3ede8049114f1859603572105bec20357bfff
-  data.tar.gz: 7f0ef624a7a958b33fcecd69f0d397e480ab98ffef1cbe3029cf87d2c290d02cb8be4b9f4c97903b6b495564dcb94607b64991ac530ec68851b13e7c474158b6
+  metadata.gz: 10a59eceb8374b68bd5b5a1556a5490ac8d1d1a125d2c64b56e78af6eebf5b54754813504bcb64e728211ee24c3f9ecc58791c3c5797517fbba0b3c45608be31
+  data.tar.gz: 66d9ef4f620f34c5657bf993e30020b3ceb49d5932a2340e4d7b9f3a0ed7e18082dd02e90c33907f25116df33c758b4ff425fd0fe9bf4fe90951fc2a73973c80

data/.github/workflows/build.yml

@@ -19,10 +19,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.12.2
+
+Bugfix:
+
+- Changing the parameters in a `defaults` option to a mapping shouldn't mutate the parameters, meaning that retries should get the same as the original parameters (thanks to vskbjrn for the bug report)
+
+## 1.12.1
+
+Bugfix:
+
+- Usernames and passwords for simple authentication should be URL-encoded unless they're actually going in the URL (thanks to Scott Duke for the bug report)
+
 ## 1.12.0
 
 Bugfix:

data/lib/flexirest/configuration.rb

@@ -92,7 +92,6 @@ module Flexirest
           if value.respond_to?(:call)
             @username = value
           else
-            value = CGI::escape(value) if value.present? && !value.include?("%")
             @username = value
           end
         end
@@ -100,7 +99,6 @@ module Flexirest
 
       def username=(value)
         Flexirest::Logger.info "\033[1;4;32m#{name}\033[0m Username set to be #{value}"
-        value = CGI::escape(value) if value.present? && !value.include?("%")
         @@username = value
       end
 
@@ -123,7 +121,6 @@ module Flexirest
           if value.respond_to?(:call)
             @password = value
           else
-            value = CGI::escape(value) if value.present? && !value.include?("%")
             @password = value
           end
         end
@@ -131,7 +128,6 @@ module Flexirest
 
       def password=(value)
         Flexirest::Logger.info "\033[1;4;32m#{name}\033[0m Password set..."
-        value = CGI::escape(value) if value.present? && !value.include?("%")
         @@password = value
       end
 

data/lib/flexirest/request.rb

@@ -129,7 +129,11 @@ module Flexirest
     end
 
     def inject_basic_auth_in_url(url)
-      url.gsub!(%r{//(.)}, "//#{username}:#{password}@\\1") if !url[%r{//[^/]*:[^/]*@}]
+      u = username
+      u = CGI::escape(u) if u.present? && !u.include?("%")
+      p = password
+      p = CGI::escape(p) if p.present? && !p.include?("%")
+      url.gsub!(%r{//(.)}, "//#{u}:#{p}@\\1") if !url[%r{//[^/]*:[^/]*@}]
     end
 
     def using_basic_auth?
@@ -340,6 +344,8 @@ module Flexirest
         params = {id:params}
       end
 
+      params = params.dup
+
       # Format includes parameter for jsonapi
       if proxy == :json_api
         JsonAPIProxy::Request::Params.translate(params, @object._include_associations)

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.12.0"
+  VERSION = "1.12.2"
 end

data/spec/lib/configuration_spec.rb

@@ -81,18 +81,6 @@ describe Flexirest::Configuration do
     expect(SubConfigurationExample.username).to eq("john")
   end
 
-  it "should escape the username" do
-    Flexirest::Base.username = "bill@example.com"
-    expect(Flexirest::Base.username).to eq("bill%40example.com")
-    Flexirest::Base.username = nil
-  end
-
-  it "should not doubly escape the username" do
-    Flexirest::Base.username = "bill%40example.com"
-    expect(Flexirest::Base.username).to_not eq("bill%2540example.com")
-    Flexirest::Base.username = nil
-  end
-
   it "should remember the set password" do
     expect(ConfigurationExample.password).to eq("smith")
   end
@@ -107,18 +95,6 @@ describe Flexirest::Configuration do
     expect(SubConfigurationExample.password).to eq("smith")
   end
 
-  it "should escape the password" do
-    Flexirest::Base.password = "something@else"
-    expect(Flexirest::Base.password).to eq("something%40else")
-    Flexirest::Base.password = nil
-  end
-
-  it "should not doubly escape the password" do
-    Flexirest::Base.password = "something%40else"
-    expect(Flexirest::Base.password).to_not eq("something%2540else")
-    Flexirest::Base.password = nil
-  end
-
   it "should default to a form_encoded request_body_type" do
     expect(Flexirest::Base.request_body_type).to eq(:form_encoded)
   end

data/spec/lib/request_spec.rb

@@ -78,15 +78,15 @@ describe Flexirest::Request do
 
     class AuthenticatedExampleClient < Flexirest::Base
       base_url "http://www.example.com"
-      username "john"
-      password "smith"
+      username "john@example.com"
+      password "smith?$"
       get :all, "/"
     end
 
     class AuthenticatedBasicHeaderExampleClient < Flexirest::Base
       base_url "http://www.example.com"
-      username "john"
-      password "smith"
+      username "john@example.com"
+      password "smith?$"
       basic_auth_method :header
       get :all, "/"
     end
@@ -97,8 +97,8 @@ describe Flexirest::Request do
 
     class AuthenticatedBasicUrlExampleClient < Flexirest::Base
       base_url "http://www.example.com"
-      username "john"
-      password "smith"
+      username "john@example.com"
+      password "smith?$"
       basic_auth_method :url
       get :all, "/"
     end
@@ -173,6 +173,13 @@ describe Flexirest::Request do
       get :second_call, "/second_call"
     end
 
+    class SimpleRetryingExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+      get :all, "/objects", defaults: proc { |params| { type: params.delete(:object_type) } }
+
+      after_request -> (name, response) { raise Flexirest::CallbackRetryRequestException.new }
+    end
+
     class LazyLoadedExampleClient < ExampleClient
       base_url "http://www.example.com"
       lazy_load!
@@ -357,14 +364,14 @@ describe Flexirest::Request do
     mocked_response = ::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{}))
 
     connection = double(Flexirest::Connection).as_null_object
-    expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://john:smith@www.example.com").and_return(connection)
+    expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://john%40example.com:smith%3F%24@www.example.com").and_return(connection)
     expect(connection).to receive(:get).with("/", an_instance_of(Hash)).and_return(mocked_response)
     AuthenticatedExampleClient.all
   end
 
   it "should use the headers method for Basic auth when basic_auth_method is set to :header" do
     mocked_response = ::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{}))
-    headers_including_auth = hash_including({ "Authorization" => "Basic am9objpzbWl0aA==" })
+    headers_including_auth = hash_including({ "Authorization" => "Basic am9obkBleGFtcGxlLmNvbTpzbWl0aD8k" })
 
     connection = double(Flexirest::Connection).as_null_object
     expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://www.example.com").and_return(connection)
@@ -382,7 +389,7 @@ describe Flexirest::Request do
 
   it "should use the setting set on the parent class" do
     mocked_response = ::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{}))
-    headers_including_auth = hash_including({ "Authorization" => "Basic am9objpzbWl0aA==" })
+    headers_including_auth = hash_including({ "Authorization" => "Basic am9obkBleGFtcGxlLmNvbTpzbWl0aD8k" })
 
     connection = double(Flexirest::Connection).as_null_object
     expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://www.example.com").and_return(connection)
@@ -394,7 +401,7 @@ describe Flexirest::Request do
     mocked_response = ::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{}))
 
     connection = double(Flexirest::Connection).as_null_object
-    expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://john:smith@www.example.com").and_return(connection)
+    expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://john%40example.com:smith%3F%24@www.example.com").and_return(connection)
     expect(connection).to receive(:get) do |path, options|
       expect(path).to eq("/")
       expect(options[:headers]).to eq({"Accept"=>"application/hal+json, application/json;q=0.5", "Content-Type"=>"application/x-www-form-urlencoded; charset=utf-8"})
@@ -1395,6 +1402,13 @@ describe Flexirest::Request do
     expect(RetryingExampleClient.retries).to eq(2)
   end
 
+  it "shouldn't destructively change params before retrying" do
+    stub_request(:get, "http://www.example.com/objects?type=foo").
+      to_return(status: 200, body: "", headers: {})
+    SimpleRetryingExampleClient.all(object_type: 'foo')
+
+    expect(WebMock).to have_requested(:get, "www.example.com/objects?type=foo").twice
+  end
 
   context "Direct URL requests" do
     class SameServerExampleClient < Flexirest::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.2
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-08 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -407,7 +407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: This gem is for accessing REST services in a flexible way.  ActiveResource