lhc 11.2.0 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19e2069105d325acde5b2d89abcb267604658239dfc8808acc58637aac94a97a
-  data.tar.gz: f1795b3999b8307cca582bfd55318a663a823b87057535e9652b1c611d952292
+  metadata.gz: 20beb1550ea6286010ac46dd969bcdd8cdcc4dbb968d5ebbfdf3b591eb118fb1
+  data.tar.gz: c219d6d5bfb4b7a00e7c2d2273162d2cf3b1d106742dc803e9abfaa0987c0fae
 SHA512:
-  metadata.gz: 2b0da63bf8c0ff0a66c37e7c3ca3b28f14e4940c2c16d432734b56ff957c4b305ca408660b5448c5f81e87cf19faf76578ddf52b0fbe826a2f63d1ad8c59468d
-  data.tar.gz: bd50aacfc4667b1d30cf9e1c1b2961d31b46e5603868a6d14ebcc2690deb4e9e3691e5ef65881f5b1744994d342eaf11be47b48cbd60bb33c1a9065033b32e5c
+  metadata.gz: 609167a963677ba5191a5579a43b9740c08b16be259041da52cb5459e5e5c0eb481361a4115323b6bfa1c444b068669760dc530a5cbaea35af747f63650cea62
+  data.tar.gz: 47e4cbc20c4ab60befb908c719b0c7625a982325b7b756c48ceedec11f649c082c0715a26b0e8f76ce6124b1ef5dd2b0df475e1c13cfef568147b989a317dbe7

data/README.md

@@ -1,6 +1,3 @@
-LHC
-===
-
 LHC is an extended/advanced HTTP client. Implementing basic http-communication enhancements like interceptors, exception handling, format handling, accessing response data, configuring endpoints and placeholders and fully compatible, RFC-compliant URL-template support.
 
 LHC uses [typhoeus](https://github.com/typhoeus/typhoeus) for low level http communication.
@@ -30,69 +27,72 @@ use it like:
 ```
 
 ## Table of contents
-   * [LHC](#lhc)
-      * [Quick start guide](#quick-start-guide)
-      * [Table of contents](#table-of-contents)
-      * [Basic methods](#basic-methods)
-      * [Request](#request)
-         * [Formats](#formats)
-            * [Default format](#default-format)
-            * [Unformatted requests](#unformatted-requests)
-               * [Upload with LHC](#upload-with-lhc)
-         * [Parallel requests](#parallel-requests)
-         * [Follow redirects](#follow-redirects)
-         * [Transfer data through the request body](#transfer-data-through-the-request-body)
-         * [Request parameters](#request-parameters)
-            * [Array Parameter Encoding](#array-parameter-encoding)
-         * [Request URL encoding](#request-url-encoding)
-         * [Request URL-Templates](#request-url-templates)
-         * [Request timeout](#request-timeout)
-         * [Request Agent](#request-agent)
-      * [Response](#response)
-         * [Accessing response data](#accessing-response-data)
-      * [Exceptions](#exceptions)
-         * [Custom error handling](#custom-error-handling)
-         * [Ignore certain errors](#ignore-certain-errors)
-      * [Configuration](#configuration)
-         * [Configuring endpoints](#configuring-endpoints)
-         * [Configuring placeholders](#configuring-placeholders)
-      * [Interceptors](#interceptors)
-         * [Quick start: Configure/Enable Interceptors](#quick-start-configureenable-interceptors)
-         * [Interceptors on local request level](#interceptors-on-local-request-level)
-         * [Core Interceptors](#core-interceptors)
-            * [Authentication Interceptor](#authentication-interceptor)
-               * [Bearer Authentication](#bearer-authentication)
-               * [Basic Authentication](#basic-authentication)
-               * [Reauthenticate](#reauthenticate)
-               * [Bearer Authentication with client access token](#bearer-authentication-with-client-access-token)
-            * [Caching Interceptor](#caching-interceptor)
-               * [Options](#options)
-            * [Default Timeout Interceptor](#default-timeout-interceptor)
-               * [Overwrite defaults](#overwrite-defaults)
-            * [Logging Interceptor](#logging-interceptor)
-               * [Installation](#installation)
-               * [What and how it logs](#what-and-how-it-logs)
-               * [Configure](#configure)
-            * [Monitoring Interceptor](#monitoring-interceptor)
-               * [Installation](#installation-1)
-               * [Environment](#environment)
-               * [What it tracks](#what-it-tracks)
-               * [Configure](#configure-1)
-            * [Prometheus Interceptor](#prometheus-interceptor)
-            * [Retry Interceptor](#retry-interceptor)
-               * [Limit the amount of retries while making the request](#limit-the-amount-of-retries-while-making-the-request)
-               * [Change the default maximum of retries of the retry interceptor](#change-the-default-maximum-of-retries-of-the-retry-interceptor)
-               * [Retry all requests](#retry-all-requests)
-            * [Rollbar Interceptor](#rollbar-interceptor)
-               * [Forward additional parameters](#forward-additional-parameters)
-            * [Throttle](#throttle)
-            * [Zipkin](#zipkin)
-         * [Create an interceptor from scratch](#create-an-interceptor-from-scratch)
-            * [Interceptor callbacks](#interceptor-callbacks)
-            * [Interceptor request/response](#interceptor-requestresponse)
-            * [Provide a response replacement through an interceptor](#provide-a-response-replacement-through-an-interceptor)
-      * [Testing](#testing)
-      * [License](#license)
+  * [Quick start guide](#quick-start-guide)
+  * [Basic methods](#basic-methods)
+  * [Request](#request)
+     * [Formats](#formats)
+        * [Default format](#default-format)
+        * [Unformatted requests](#unformatted-requests)
+           * [Upload with LHC](#upload-with-lhc)
+     * [Parallel requests](#parallel-requests)
+     * [Follow redirects](#follow-redirects)
+     * [Transfer data through the request body](#transfer-data-through-the-request-body)
+     * [Request parameters](#request-parameters)
+        * [Array Parameter Encoding](#array-parameter-encoding)
+     * [Request URL encoding](#request-url-encoding)
+     * [Request URL-Templates](#request-url-templates)
+     * [Request timeout](#request-timeout)
+     * [Request Agent](#request-agent)
+  * [Response](#response)
+     * [Accessing response data](#accessing-response-data)
+  * [Exceptions](#exceptions)
+     * [Custom error handling (rescue)](#custom-error-handling-rescue)
+     * [Ignore certain errors](#ignore-certain-errors)
+  * [Configuration](#configuration)
+     * [Configuring endpoints](#configuring-endpoints)
+     * [Configuring placeholders](#configuring-placeholders)
+  * [Interceptors](#interceptors)
+     * [Quick start: Configure/Enable Interceptors](#quick-start-configureenable-interceptors)
+     * [Interceptors on local request level](#interceptors-on-local-request-level)
+     * [Core Interceptors](#core-interceptors)
+        * [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)
+           * [Options](#options)
+        * [Default Timeout Interceptor](#default-timeout-interceptor)
+           * [Overwrite defaults](#overwrite-defaults)
+        * [Logging Interceptor](#logging-interceptor)
+           * [Installation](#installation)
+           * [What and how it logs](#what-and-how-it-logs)
+           * [Configure](#configure)
+        * [Monitoring Interceptor](#monitoring-interceptor)
+           * [Installation](#installation-1)
+           * [Environment](#environment)
+           * [What it tracks](#what-it-tracks)
+           * [Configure](#configure-1)
+        * [Prometheus Interceptor](#prometheus-interceptor)
+        * [Retry Interceptor](#retry-interceptor)
+           * [Limit the amount of retries while making the request](#limit-the-amount-of-retries-while-making-the-request)
+           * [Change the default maximum of retries of the retry interceptor](#change-the-default-maximum-of-retries-of-the-retry-interceptor)
+           * [Retry all requests](#retry-all-requests)
+           * [Do not retry certain response codes](#do-not-retry-certain-response-codes)
+        * [Rollbar Interceptor](#rollbar-interceptor)
+           * [Forward additional parameters](#forward-additional-parameters)
+        * [Throttle](#throttle)
+        * [Zipkin](#zipkin)
+     * [Create an interceptor from scratch](#create-an-interceptor-from-scratch)
+        * [Interceptor callbacks](#interceptor-callbacks)
+        * [Interceptor request/response](#interceptor-requestresponse)
+        * [Provide a response replacement through an interceptor](#provide-a-response-replacement-through-an-interceptor)
+  * [Testing](#testing)
+  * [License](#license)
+
+
+
 
 ## Basic methods
 
@@ -403,7 +403,7 @@ timeout? => LHC::Timeout
 anything_else => LHC::UnknownError
 ```
 
-### Custom error handling
+### Custom error handling (rescue)
 
 You can provide custom error handlers to handle errors happening during the request.
 
@@ -413,19 +413,21 @@ If your error handler returns anything else but `nil` it replaces the response b
 
 ```ruby
 handler = ->(response){ do_something_with_response; return {name: 'unknown'} }
-response = LHC.get('http://something', error_handler: handler)
+response = LHC.get('http://something', rescue: handler)
 response.data.name # 'unknown'
 ```
 
 ### Ignore certain errors
 
 As it's discouraged to rescue errors and then don't handle them (ruby styleguide)[https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions],
-but you often want to continue working with `nil`, LHC provides the `ignored_errors` option.
+but you often want to continue working with `nil`, LHC provides the `ignore` option.
 
 Errors listed in this option will not be raised and will leave the `response.body` and `response.data` to stay `nil`.
 
+You can either pass the LHC error class you want to be ignored or an array of LHC error classes.
+
 ```ruby
-response = LHC.get('http://something', ignored_errors: [LHC::NotFound])
+response = LHC.get('http://something', ignore: LHC::NotFound)
 
 response.body # nil
 response.data # nil
@@ -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:
@@ -817,16 +833,16 @@ If you want to retry all requests made from your application, you just need to c
 
 ##### Do not retry certain response codes
 
-If you do not want to retry based on certain response codes, use retry in combination with explicit `ignore_errors`:
+If you do not want to retry based on certain response codes, use retry in combination with explicit `ignore`:
 
 ```ruby
-  LHC.get('http://local.ch', ignore_errors: [LHC::NotFound], retry: { max: 1 })
+  LHC.get('http://local.ch', ignore: LHC::NotFound, retry: { max: 1 })
 ```
 
 Or if you use `LHC::Retry.all`:
 
 ```ruby
-LHC.get('http://local.ch', ignore_errors: [LHC::NotFound])
+LHC.get('http://local.ch', ignore: LHC::NotFound)
 ```
 
 #### Rollbar Interceptor

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!

data/lib/lhc/request.rb

@@ -15,10 +15,10 @@ class LHC::Request
   attr_accessor :response, :options, :raw, :format, :error_handler, :errors_ignored, :source
 
   def initialize(options, self_executing = true)
-    self.errors_ignored = (options.fetch(:ignored_errors, []) || []).to_a.compact
+    self.errors_ignored = (options.fetch(:ignore, []) || []).to_a.compact
     self.source = options&.dig(:source)
     self.options = format!(options.deep_dup || {})
-    self.error_handler = options.delete :error_handler
+    self.error_handler = options.delete :rescue
     use_configured_endpoint!
     generate_url_from_template!
     self.interceptors = LHC::Interceptors.new(self)

data/lib/lhc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHC
-  VERSION ||= '11.2.0'
+  VERSION ||= '12.1.0'
 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/retry/main_spec.rb

@@ -66,7 +66,7 @@ describe LHC::Rollbar do
 
     it 'does not retry if the error is explicitly ignored' do
       request_stub
-      LHC.get('http://local.ch', retry: { max: 1 }, ignored_errors: [LHC::NotFound])
+      LHC.get('http://local.ch', retry: { max: 1 }, ignore: [LHC::NotFound])
       expect(request_stub).to have_been_requested.times(1)
     end
   end

data/spec/request/error_handling_spec.rb

@@ -67,21 +67,21 @@ describe LHC::Request do
     it 'handles errors with the provided handler and does not raise them' do
       stub_request(:get, "http://something").to_return(status: 400)
       handler = double('handler', call: -> {})
-      LHC::Request.new(url: "http://something", error_handler: handler)
+      LHC::Request.new(url: "http://something", rescue: handler)
       expect(handler).to have_received(:call)
     end
 
     it 'exchanges body with handlers return if the handler returns something' do
       stub_request(:get, "http://something").to_return(status: 400)
       handler = ->(_response) { { name: 'unknown' }.to_json }
-      request = LHC::Request.new(url: "http://something", error_handler: handler)
+      request = LHC::Request.new(url: "http://something", rescue: handler)
       expect(request.response.data.name).to eq 'unknown'
     end
 
     it 'does not exchange body with handlers return if the handler returns nil' do
       stub_request(:get, "http://something").to_return(status: 400, body: { message: 'an error occurred' }.to_json)
       handler = ->(_response) { nil }
-      request = LHC::Request.new(url: "http://something", error_handler: handler)
+      request = LHC::Request.new(url: "http://something", rescue: handler)
       expect(request.response.data.message).to eq 'an error occurred'
     end
   end

data/spec/request/ignore_errors_spec.rb

@@ -4,7 +4,7 @@ require 'rails_helper'
 
 describe LHC::Request do
   context 'ignoring LHC::NotFound' do
-    let(:response) { LHC.get('http://local.ch', ignored_errors: [LHC::NotFound]) }
+    let(:response) { LHC.get('http://local.ch', ignore: [LHC::NotFound]) }
 
     before { stub_request(:get, 'http://local.ch').to_return(status: 404) }
 
@@ -36,13 +36,13 @@ describe LHC::Request do
 
     it "does not raise an error when it's a subclass of the ignored error" do
       expect {
-        LHC.get('http://local.ch', ignored_errors: [LHC::Error])
+        LHC.get('http://local.ch', ignore: [LHC::Error])
       }.not_to raise_error
     end
 
     it "does raise an error if it's not a subclass of the ignored error" do
       expect {
-        LHC.get('http://local.ch', ignored_errors: [ArgumentError])
+        LHC.get('http://local.ch', ignore: [ArgumentError])
       }.to raise_error(LHC::NotFound)
     end
   end
@@ -52,13 +52,13 @@ describe LHC::Request do
 
     it "does not raise an error when ignored errors is set to array with nil" do
       expect {
-        LHC.get('http://local.ch', ignored_errors: [nil])
+        LHC.get('http://local.ch', ignore: [nil])
       }.to raise_error(LHC::NotFound)
     end
 
     it "does not raise an error when ignored errors is set to nil" do
       expect {
-        LHC.get('http://local.ch', ignored_errors: nil)
+        LHC.get('http://local.ch', ignore: nil)
       }.to raise_error(LHC::NotFound)
     end
   end
@@ -67,7 +67,7 @@ describe LHC::Request do
     before { stub_request(:get, 'http://local.ch').to_return(status: 404) }
 
     it "does not raise an error when ignored errors is a key instead of an array" do
-      LHC.get('http://local.ch', ignored_errors: LHC::NotFound)
+      LHC.get('http://local.ch', ignore: LHC::NotFound)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 11.2.0
+  version: 12.1.0
 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-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -325,6 +325,8 @@ 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/reauthentication_configuration_spec.rb
 - spec/interceptors/auth/reauthentication_spec.rb
 - spec/interceptors/before_request_spec.rb
@@ -384,7 +386,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 +477,8 @@ 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/reauthentication_configuration_spec.rb
 - spec/interceptors/auth/reauthentication_spec.rb
 - spec/interceptors/before_request_spec.rb