flexirest 1.10.3 → 1.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53b34d9600101b9d80a61559054a3599242a7739b12845df02bde410c5858d94
-  data.tar.gz: e7398bcc97a8a0f89fb3380110e126e482d5fc1e14a973dd9e34208f28634814
+  metadata.gz: 9a072753fe6a84d8f13ae90d26cdff777e78fc129d4555b5188ae0c0be35ad78
+  data.tar.gz: 7e6ecfe247cc9f021a3e35f9cf4d3b28a6743694b53a2ca32c0ea988a2113276
 SHA512:
-  metadata.gz: 32014dfe143032f040ae140cdcf562f05832f74d0b05e692b8f866d4636363b6f7ffcbe0a4de0e7a895c8b1722aef0f6736f34c130916dc5c02869caa198434a
-  data.tar.gz: a7f3cb00fd3451c4f06ef32bf6e148f90d4046c1cce7526a8bfe6c247e2d65dcd68a0d924f85683ef052929432ddf341768578a7591b37db8b7729ed96053c80
+  metadata.gz: 561fdb72c84a9bd3d0a353f46d4761179df66f3e45967bec4b4b620c6f818dca0058388b5f83c2d2455da1f21fa90a72ec0f73ab056fbf086dab522cc8f48fd7
+  data.tar.gz: 95d6f2852392a23c82a5ae0e157a9ad1bc391c4846e79946eab75236c1c3b409c8193a3550e42b9e19676b94a3cccda28e6f0ddf438e47b3e77de9c66669006a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.10.4
+
+Enhancement:
+
+- Implement support for in-header Basic Auth (thanks to François Ferrandis for the PR)
+
 ## 1.10.3
 
 Enhancement:

data/docs/authentication.md

@@ -40,6 +40,30 @@ Or if it's called from a class context:
 Person.find(id: 1234)
 ```
 
+### Basic authentication method
+
+Flexirest provides two methods for HTTP Basic Auth. The default method is `:url`:
+
+```ruby
+class Person < Flexirest::Base
+  basic_auth_method :url
+end
+# Includes the credentials in the URL:
+#   https://my_username:my_password@example.com/
+```
+
+But you might want to keep the credentials out of your logs and use the `:header` method:
+
+```ruby
+class Person < Flexirest::Base
+  basic_auth_method :header
+end
+# Clean URL:
+#   https://example.com/
+# with the base64 encoded credentials:
+#   Authorization: Basic YXBpOmViNjkzZWMtODI1MmMtZDYzMDEtMDJmZDAtZDBmYjctYzM0ODU=
+```
+
 ## Api-Auth
 
 Using the [Api-Auth](https://github.com/mgomes/api_auth) integration it is very easy to sign requests. Include the Api-Auth gem in your `Gemfile` and  then add it to your application. Then simply configure Api-Auth one time in your app and all requests will be signed from then on.

data/docs/raw-requests.md

@@ -1,6 +1,6 @@
 # *Flexirest:* Raw requests
 
-Sometimes you have have a URL that you just want to force through, but have the response handled in the same way as normal objects or you want to have the callbacks run (say for authentication). The easiest way to do that is to call `_request` on the class:
+Sometimes you have a URL that you just want to force through, but have the response handled in the same way as normal objects or you want to have the callbacks run (say for authentication). The easiest way to do that is to call `_request` on the class:
 
 ```ruby
 class Person < Flexirest::Base

data/lib/flexirest/configuration.rb

@@ -135,6 +135,23 @@ module Flexirest
         @@password = value
       end
 
+      DEFAULT_BASIC_URL_METHOD = :url
+
+      def basic_auth_method(value = nil)
+        if value.nil? # Used as a getter method
+          if @basic_auth_method.nil? && superclass.respond_to?(:basic_auth_method)
+            superclass.basic_auth_method
+          else
+            @basic_auth_method || DEFAULT_BASIC_URL_METHOD
+          end
+        else # Used as a setter method
+          unless [:header, :url].include?(value)
+            raise %(Invalid basic_auth_method #{value.inspect}. Valid methods are :url (default) and :header.)
+          end
+          @basic_auth_method = value
+        end
+      end
+
       def alias_type(value = nil)
         @alias_type ||= nil
         if value.nil?
@@ -311,6 +328,7 @@ module Flexirest
         @adapter              = Faraday.default_adapter
         @api_auth_access_id   = nil
         @api_auth_secret_key  = nil
+        @basic_auth_method    = :url
       end
 
       private

data/lib/flexirest/request.rb

@@ -32,6 +32,10 @@ module Flexirest
       !@object.respond_to?(:dirty?)
     end
 
+    def model_class
+      object_is_class? ? @object : @object.class
+    end
+
     def class_name
       if object_is_class?
         @object.name
@@ -124,6 +128,18 @@ module Flexirest
       ret
     end
 
+    def inject_basic_auth_in_url(url)
+      url.gsub!(%r{//(.)}, "//#{username}:#{password}@\\1") if !url[%r{//[^/]*:[^/]*@}]
+    end
+
+    def using_basic_auth?
+      !!username
+    end
+
+    def basic_auth_digest
+      Base64.strict_encode64("#{username}:#{password}")
+    end
+
     def request_body_type
       if @method[:options][:request_body_type]
         @method[:options][:request_body_type]
@@ -527,7 +543,9 @@ module Flexirest
           else
             _, @base_url, @url = parts
           end
-          base_url.gsub!(%r{//(.)}, "//#{username}:#{password}@\\1") if username && !base_url[%r{//[^/]*:[^/]*@}]
+          if using_basic_auth? && model_class.basic_auth_method == :url
+            inject_basic_auth_in_url(base_url)
+          end
           connection = Flexirest::ConnectionManager.get_connection(base_url)
         end
       else
@@ -540,7 +558,9 @@ module Flexirest
         else
           base_url = parts[0]
         end
-        base_url.gsub!(%r{//(.)}, "//#{username}:#{password}@\\1") if username && !base_url[%r{//[^/]*:[^/]*@}]
+        if using_basic_auth? && model_class.basic_auth_method == :url
+          inject_basic_auth_in_url(base_url)
+        end
         connection = Flexirest::ConnectionManager.get_connection(base_url)
       end
       if @method[:options][:direct]
@@ -566,6 +586,8 @@ module Flexirest
           :api_auth_secret_key => api_auth_secret_key,
           :api_auth_options => api_auth_options
         }
+      elsif using_basic_auth? && model_class.basic_auth_method == :header
+        http_headers["Authorization"] = "Basic #{basic_auth_digest}"
       end
       if @method[:options][:timeout]
         request_options[:timeout] = @method[:options][:timeout]

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.10.3"
+  VERSION = "1.10.4"
 end

data/spec/lib/request_spec.rb

@@ -81,6 +81,26 @@ describe Flexirest::Request do
       get :all, "/"
     end
 
+    class AuthenticatedBasicHeaderExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+      username "john"
+      password "smith"
+      basic_auth_method :header
+      get :all, "/"
+    end
+
+    class AuthenticatedBasicHeaderExampleClientChildClass < AuthenticatedBasicHeaderExampleClient
+      get :child_method, "/"
+    end
+
+    class AuthenticatedBasicUrlExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+      username "john"
+      password "smith"
+      basic_auth_method :url
+      get :all, "/"
+    end
+
     class AuthenticatedProcExampleClient < Flexirest::Base
       base_url "http://www.example.com"
       username Proc.new { |obj| obj ? "bill-#{obj.id}" : "bill" }
@@ -314,13 +334,53 @@ describe Flexirest::Request do
     expect(servers.uniq.count).to eq(2)
   end
 
-  it "should get an HTTP connection with authentication when called" do
+  it "should use the URL method for Basic HTTP Auth when no basic_auth_method is set" 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(connection).to receive(:get).with("/", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    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==" })
+
+    connection = double(Flexirest::Connection).as_null_object
+    expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://www.example.com").and_return(connection)
+    expect(connection).to receive(:get).with("/", hash_including(headers: headers_including_auth)).and_return(mocked_response)
+    AuthenticatedBasicHeaderExampleClient.all
+  end
+
+  it "should raise an error if Basic HTTP method is not :header or :url" do
+    expect do
+      AuthenticatedExampleClient.class_eval do
+        basic_auth_method :some_invalid_value
+      end
+    end.to raise_error(RuntimeError, "Invalid basic_auth_method :some_invalid_value. Valid methods are :url (default) and :header.")
+  end
+
+  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==" })
+
+    connection = double(Flexirest::Connection).as_null_object
+    expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://www.example.com").and_return(connection)
+    expect(connection).to receive(:get).with("/", hash_including(headers: headers_including_auth)).and_return(mocked_response)
+    AuthenticatedBasicHeaderExampleClientChildClass.child_method
+  end
+
+  it "should use the URL method for Basic auth when basic_auth_method is set to :url (and not include Authorization header)" do
+    mocked_response = ::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{}))
+    headers_not_including_auth = hash_excluding("Authorization")
+
+    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(connection).to receive(:get).with("/", headers: headers_not_including_auth).and_return(mocked_response)
+    AuthenticatedBasicUrlExampleClient.all
+  end
+
   it "should get an HTTP connection with basic authentication using procs when called in a class context" do
     connection = double(Flexirest::Connection).as_null_object
     expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://bill:jones@www.example.com").and_return(connection)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.10.3
+  version: 1.10.4
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler