lhc 11.0.2 → 12.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08a828482abe7ecd92b963be2f85a921d5d33c21386048c0de1dd5eddd7a0c5d'
-  data.tar.gz: afbe59a64dbf4e6a772aa045c6717694fc45c99f08818eb3892cfc3df3d24607
+  metadata.gz: 640050193c04d507d98ed7538bc526c3693dcef5cb1ee2c07ff99c908c171f96
+  data.tar.gz: e8c0772f3d7258f16a8c2b069b2f00040f6592d55d7daecbccc6ec58cb15b736
 SHA512:
-  metadata.gz: ca154508dfeab839682d6cc9babd7d9ac3fd194ff318f0132fd05399aea04dcd155c9cf77b679ae91be6fef0971b2c13de0c14673b7f90beff77ca13d8bc2a42
-  data.tar.gz: e24477b6e9cc94aa1faa1c3b4e366d59b466df46c9abb4a914255316cd4a9b5eef192f70157df5c50c38422b738b6b384f692180cd415b7bfd19398d87b91fa3
+  metadata.gz: f184fa4ea6eb799b474a747c1dbd519c4ddbf5d47867cca507525892c204d71bb7cc537411dbbf6afe4385d9f827413c8e918d19440fdcc47bc0b3c9b911050f
+  data.tar.gz: a7770bacfad84efe0a1c821bc2d8c02c1f3903ed2c3754f23ca5a4b290c66f975bd2af2773456b334fe35c4a0166b5ee55daff030965a62e670d472946dc1351

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,70 @@ 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)
+           * [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 +401,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 +411,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
@@ -817,16 +817,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/lib/lhc/concerns/lhc/formats_concern.rb

@@ -5,6 +5,10 @@ module LHC
     extend ActiveSupport::Concern
 
     module ClassMethods
+      def form
+        LHC::Formats::Form
+      end
+
       def json
         LHC::Formats::JSON
       end

data/lib/lhc/error.rb

@@ -59,6 +59,10 @@ class LHC::Error < StandardError
     self.response = response
   end
 
+  def self.to_a
+    [self]
+  end
+
   def to_s
     return response if response.is_a?(String)
     request = response.request

data/lib/lhc/formats.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module LHC::Formats
+  autoload :Form, 'lhc/formats/form'
   autoload :JSON, 'lhc/formats/json'
   autoload :Multipart, 'lhc/formats/multipart'
   autoload :Plain, 'lhc/formats/plain'

data/lib/lhc/formats/form.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module LHC::Formats
+  class Form < LHC::Format
+    include LHC::BasicMethodsConcern
+
+    def self.request(options)
+      options[:format] = new
+      super(options)
+    end
+
+    def format_options(options)
+      options[:headers] ||= {}
+      no_content_type_header!(options)
+      options[:headers]['Content-Type'] = 'application/x-www-form-urlencoded'
+      options
+    end
+
+    def as_json(input)
+      parse(input)
+    end
+
+    def as_open_struct(input)
+      parse(input)
+    end
+
+    def to_body(input)
+      input
+    end
+
+    def to_s
+      'form'
+    end
+
+    def to_sym
+      to_s.to_sym
+    end
+
+    private
+
+    def parse(input)
+      input
+    end
+  end
+end

data/lib/lhc/interceptors/auth.rb

@@ -66,7 +66,7 @@ class LHC::Auth < LHC::Interceptor
   end
 
   def bearer_header_present?
-    @has_bearer_header ||= request.headers['Authorization'] =~ /^Bearer [0-9a-f-]+$/i
+    @has_bearer_header ||= request.headers['Authorization'] =~ /^Bearer .+$/i
   end
 
   def refresh_client_token_option

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, []) || []).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.0.2'
+  VERSION ||= '12.0.1'
 end

data/spec/formats/form_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC do
+  include ActionDispatch::TestProcess
+
+  context 'form' do
+    it 'formats requests to be application/x-www-form-urlencoded' do
+      stub = stub_request(:post, 'http://local.ch/')
+        .with(body: 'client_id=1234&client_secret=4567&grant_type=client_credentials')
+        .with(headers: { 'Content-Type': 'application/x-www-form-urlencoded' })
+        .to_return(status: 200)
+
+      LHC.form.post(
+        'http://local.ch',
+        body: {
+          client_id: '1234',
+          client_secret: '4567',
+          grant_type: 'client_credentials'
+        }
+      )
+
+      expect(stub).to have_been_requested
+    end
+  end
+end

data/spec/formats/multipart_spec.rb

@@ -10,7 +10,7 @@ describe LHC do
     let(:body) { { size: 2231 }.to_json }
     let(:location) { 'http://local.ch/uploads/image.jpg' }
 
-    it 'leaves plains requests unformatted' do
+    it 'formats requests to be multipart/form-data' do
       stub_request(:post, 'http://local.ch/') do |request|
         raise 'Content-Type header wrong' unless request.headers['Content-Type'] == 'multipart/form-data'
         raise 'Body wrongly formatted' unless request.body.match(/file=%23%3CActionDispatch%3A%3AHttp%3A%3AUploadedFile%3A.*%3E&type=Image/)

data/spec/interceptors/auth/reauthentication_spec.rb

@@ -31,4 +31,14 @@ describe LHC::Auth do
     LHC.config.endpoint(:local, 'http://local.ch', auth: options.merge(reauthenticated: true))
     expect { LHC.get(:local) }.to raise_error(LHC::Unauthorized)
   end
+
+  context 'token format' do
+    let(:initial_token) { 'BAsZ-98-ZZZ' }
+
+    it 'refreshes tokens with various formats' do
+      LHC.config.endpoint(:local, 'http://local.ch', auth: options)
+      LHC.get(:local)
+      expect(auth_suceeding_after_recovery).to have_been_made.once
+    end
+  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,14 +52,22 @@ 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
+
+  context 'passing keys instead of arrays' 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', ignore: LHC::NotFound)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 11.0.2
+  version: 12.0.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -230,6 +230,7 @@ files:
 - lib/lhc/errors/unknown_error.rb
 - lib/lhc/format.rb
 - lib/lhc/formats.rb
+- lib/lhc/formats/form.rb
 - lib/lhc/formats/json.rb
 - lib/lhc/formats/multipart.rb
 - lib/lhc/formats/plain.rb
@@ -316,6 +317,7 @@ files:
 - spec/error/response_spec.rb
 - spec/error/timeout_spec.rb
 - spec/error/to_s_spec.rb
+- spec/formats/form_spec.rb
 - spec/formats/json_spec.rb
 - spec/formats/multipart_spec.rb
 - spec/formats/plain_spec.rb
@@ -465,6 +467,7 @@ test_files:
 - spec/error/response_spec.rb
 - spec/error/timeout_spec.rb
 - spec/error/to_s_spec.rb
+- spec/formats/form_spec.rb
 - spec/formats/json_spec.rb
 - spec/formats/multipart_spec.rb
 - spec/formats/plain_spec.rb