lhc 12.0.2 → 12.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eb0a56bdedb5ee97b2ab47ea911fe69419679add3702442659dd29722676495
-  data.tar.gz: e8d95c1c772a91592ada2f0062e1b9fe463c5b1bffe600e745e799ed8e1db068
+  metadata.gz: c1d43867c7519eb1697f118fb44668142aa46bcdfb13d725be6617c74f4ed47f
+  data.tar.gz: cdfa710bc5c7ae5297eeceec6858738ad414e828237038b92a3dcbaa9c088fed
 SHA512:
-  metadata.gz: 612db75bd05d1b172cb8282ecc2129e752b1d35b7c5514827fc984ea5da449bc52796d4e2f455fa14bbf752bf72f65c50673668259aba85547e84d5843d12df9
-  data.tar.gz: 4eceeabc7780e0fa1b2a9039515a9e8f6fdbae86b7b50e09e82afec1fefa7a4c2309175ba52ef195ce182dc6caf63d8edf0721fe5b23d5f96b65516291956493
+  metadata.gz: 9e11b8821556d2bb0e40b91cb080379fc82a3a90453fe36dd6127b4d26a571d065637275988ba03b46d96f6217a697022d0a6aa46532ab20a5d46e1ef5dbadfd
+  data.tar.gz: 192cabec15b2d1881a14505343f2e2f4218fad00ffaac4935dd3d1edbdc6132edb6b9ae0834f2d556dfbcacca9221f473f39dba37071ec40949e407bc953813f

data/README.md

@@ -58,6 +58,7 @@ use it like:
         * [Authentication Interceptor](#authentication-interceptor)
            * [Bearer Authentication](#bearer-authentication)
            * [Basic Authentication](#basic-authentication)
+           * [Body Authentication](#body-authentication)
            * [Reauthenticate](#reauthenticate)
            * [Bearer Authentication with client access token](#bearer-authentication-with-client-access-token)
         * [Caching Interceptor](#caching-interceptor)
@@ -92,6 +93,7 @@ use it like:
 
 
 
+
 ## Basic methods
 
 Available are `get`, `post`, `put` & `delete`.
@@ -549,6 +551,20 @@ Adds the following header to the request:
 
 Which is the base64 encoded credentials "username:password".
 
+##### Body Authentication
+
+```ruby
+  LHC.post('http://local.ch', auth: { body: { userToken: 'dheur5hrk3' } })
+```
+
+Adds the following to body of all requests:
+
+```
+  {
+    "userToken": "dheur5hrk3"
+  }
+```
+
 ##### Reauthenticate
 
 The current implementation can only offer reauthenticate for _client access tokens_. For this to work the following has to be given:

data/lib/lhc/interceptors/auth.rb

@@ -4,8 +4,13 @@ class LHC::Auth < LHC::Interceptor
   include ActiveSupport::Configurable
   config_accessor :refresh_client_token
 
+  def before_raw_request
+    body_authentication! if auth_options[:body]
+  end
+
   def before_request
-    authenticate!
+    bearer_authentication! if auth_options[:bearer]
+    basic_authentication! if auth_options[:basic]
   end
 
   def after_response
@@ -16,18 +21,15 @@ class LHC::Auth < LHC::Interceptor
 
   private
 
-  def authenticate!
-    if auth_options[:bearer]
-      bearer_authentication!
-    elsif auth_options[:basic]
-      basic_authentication!
-    end
+  def body_authentication!
+    auth = auth_options[:body]
+    request.options[:body] = (request.options[:body] || {}).merge(auth)
   end
 
   def basic_authentication!
     auth = auth_options[:basic]
     credentials = "#{auth[:username]}:#{auth[:password]}"
-    set_authorization_header("Basic #{Base64.encode64(credentials).chomp}")
+    set_authorization_header("Basic #{Base64.strict_encode64(credentials).chomp}")
   end
 
   def bearer_authentication!
@@ -78,7 +80,7 @@ class LHC::Auth < LHC::Interceptor
   end
 
   def auth_options
-    @auth_options ||= request.options[:auth].dup || {}
+    request.options[:auth] || {}
   end
 
   def configuration_correct?

data/lib/lhc/response/data.rb

@@ -12,9 +12,9 @@ class LHC::Response::Data
     @data = data
 
     if as_json.is_a?(Hash)
-      @base = LHC::Response::Data::Item.new(response, data: data)
+      @base = LHC::Response::Data::Item.new(@response, data: data)
     elsif as_json.is_a?(Array)
-      @base = LHC::Response::Data::Collection.new(response, data: data)
+      @base = LHC::Response::Data::Collection.new(@response, data: data)
     end
   end
 

data/lib/lhc/response/data/base.rb

@@ -4,7 +4,7 @@
 # but made accssible in the ruby world
 module LHC::Response::Data::Base
   def as_json
-    @json ||= (@data || response.format.as_json(response.body))
+    @json ||= (@data || @response.format.as_json(@response.body))
   end
 
   def as_open_struct
@@ -12,11 +12,7 @@ module LHC::Response::Data::Base
       if @data
         JSON.parse(@data.to_json, object_class: OpenStruct)
       else
-        response.format.as_open_struct(response.body)
+        @response.format.as_open_struct(@response.body)
       end
   end
-
-  private
-
-  attr_reader :response
 end

data/lib/lhc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHC
-  VERSION ||= '12.0.2'
+  VERSION ||= '12.1.3'
 end

data/spec/interceptors/auth/body_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Auth do
+  before(:each) do
+    LHC.config.interceptors = [LHC::Auth]
+  end
+
+  it 'adds body authentication to the existing request body' do
+    stub_request(:post, "http://local.ch/")
+      .with(body: {
+        message: 'body',
+        userToken: 'dheur5hrk3'
+      }.to_json)
+
+    LHC.post('http://local.ch', auth: { body: { userToken: 'dheur5hrk3' } }, body: {
+               message: 'body'
+             })
+  end
+
+  it 'adds body authentication to an empty request body' do
+    stub_request(:post, "http://local.ch/")
+      .with(body: {
+        userToken: 'dheur5hrk3'
+      }.to_json)
+
+    LHC.post('http://local.ch', auth: { body: { userToken: 'dheur5hrk3' } })
+  end
+
+  it 'adds nothing if request method is GET' do
+    stub_request(:get, "http://local.ch/")
+
+    LHC.get('http://local.ch', auth: { body: { userToken: 'dheur5hrk3' } })
+  end
+end

data/spec/interceptors/auth/long_basic_auth_credentials_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Auth do
+  before(:each) do
+    LHC.config.interceptors = [LHC::Auth]
+  end
+
+  it 'adds basic auth in a correct way even if username and password are especially long' do
+    options = { basic: { username: '123456789101234', password: '12345678901234567890123456789012' } }
+    LHC.config.endpoint(:local, 'http://local.ch', auth: options)
+    stub_request(:get, 'http://local.ch')
+      .with(headers: { 'Authorization' => 'Basic MTIzNDU2Nzg5MTAxMjM0OjEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEy' })
+    LHC.get(:local)
+  end
+end

data/spec/interceptors/auth/no_instance_var_for_options_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Auth do
+  before(:each) do
+    class AuthPrepInterceptor < LHC::Interceptor
+
+      def before_request
+        request.options[:auth] = { bearer: 'sometoken' }
+      end
+    end
+
+    LHC.config.interceptors = [AuthPrepInterceptor, LHC::Auth]
+  end
+
+  after do
+    LHC.config.reset
+  end
+
+  it 'does not use instance variables internally so that other interceptors can still change auth options' do
+    stub_request(:get, "http://local.ch/")
+      .with(headers: { 'Authorization' => 'Bearer sometoken' })
+      .to_return(status: 200)
+    LHC.get('http://local.ch')
+  end
+end

data/spec/response/data_spec.rb

@@ -58,4 +58,28 @@ describe LHC::Response do
       end
     end
   end
+
+  context 'response data if responding error data contains a response' do
+    before do
+      stub_request(:get, "http://listings/")
+        .to_return(status: 404, body: {
+          meta: {
+            errors: [
+              { code: 2000, msg: 'I like to hide error messages (this is meta).' }
+            ]
+          },
+          response: 'why not?'
+        }.to_json)
+    end
+
+    it 'does not throw a stack level to deep issue when accessing data in a rescue context' do
+      begin
+        LHC.get('http://listings')
+      rescue LHC::Error => error
+        expect(
+          error.response.request.response.data.meta.errors.detect { |item| item.code == 2000 }.msg
+        ).to eq 'I like to hide error messages (this is meta).'
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 12.0.2
+  version: 12.1.3
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -325,6 +325,9 @@ files:
 - spec/interceptors/after_response_spec.rb
 - spec/interceptors/auth/basic_auth_spec.rb
 - spec/interceptors/auth/bearer_spec.rb
+- spec/interceptors/auth/body_spec.rb
+- spec/interceptors/auth/long_basic_auth_credentials_spec.rb
+- spec/interceptors/auth/no_instance_var_for_options_spec.rb
 - spec/interceptors/auth/reauthentication_configuration_spec.rb
 - spec/interceptors/auth/reauthentication_spec.rb
 - spec/interceptors/before_request_spec.rb
@@ -475,6 +478,9 @@ test_files:
 - spec/interceptors/after_response_spec.rb
 - spec/interceptors/auth/basic_auth_spec.rb
 - spec/interceptors/auth/bearer_spec.rb
+- spec/interceptors/auth/body_spec.rb
+- spec/interceptors/auth/long_basic_auth_credentials_spec.rb
+- spec/interceptors/auth/no_instance_var_for_options_spec.rb
 - spec/interceptors/auth/reauthentication_configuration_spec.rb
 - spec/interceptors/auth/reauthentication_spec.rb
 - spec/interceptors/before_request_spec.rb