lhc 12.0.0 → 12.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cde56134f9f363649066cc6a6764534c56887fbd9ea2234beaaac0babe6a56c
-  data.tar.gz: 4daf357293a3539de5764670def7e682d6d6dfb98cc209980fcd968a187bad31
+  metadata.gz: a8c1cf6d1d9237c3cad231ae1fca7cadfcaaf6283eb429544945715235172b61
+  data.tar.gz: 9945fabdbdd44fbef2fd472f0e4f7a37f347393b92fda1918abda13d6b65d195
 SHA512:
-  metadata.gz: fc0deecc6746fb5c192fdc4648af66992cf21fe1fc340665cb7ec03e98a6f9aaabfbb0f5d59769fa8312c8448cf64c4236f8bcb807915b8055270af709163b75
-  data.tar.gz: fbbda42ca1d2d7976b41c982a2b5135865af46340f4e5f6539f21c79115144bd9c8ff0039b5ee910e581fbe6d075d6776f564476cccded2e41fd330ab48e952f
+  metadata.gz: d208eca04aac94eb7f93b3053590df5c0626165cddf479ca3b1ea94907a71ee530df9de76f86f6b6492f14936a77d06f3ae296c9a854c8f1262866fdc4bad3bf
+  data.tar.gz: eaa8166c752a295b34a2b6e0c3406bee09f771a77f2f17ba39b509396fa264ce9387ea5f2dc507fa50f51c2287c0d4fe57bc9849dfdada0a7fc2572aaf5527bf

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/lhc.gemspec

@@ -35,5 +35,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'webmock'
 
-  s.license = 'GPL-3'
+  s.license = 'GPL-3.0'
 end

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHC
-  VERSION ||= '12.0.0'
+  VERSION ||= '12.1.1'
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 12.1.1
 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-07-30 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
@@ -384,7 +387,7 @@ files:
 - spec/timeouts/timings_spec.rb
 homepage: https://github.com/local-ch/lhc
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -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