lhc 3.5.5 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bd96d437b05df955ff37aed6c1bea4c6c3a68ff
-  data.tar.gz: 6fa74559274820bf6cecca05fc6deb4620483529
+  metadata.gz: 115f947aab614d63771827eac4b14455c0233baa
+  data.tar.gz: a44cfd0e91469c137db12ee78061fa935b61ccec
 SHA512:
-  metadata.gz: a46627d6d00ea9193860f8cab7e8beaace7c514992cccc803baa36ed050112667445c7cd683f9c95e1d19703dc2e0fd47feb969d09e1d770b9c5bcd4be7b9bb0
-  data.tar.gz: 1ea0e5bd2384dc033d38f93a20227160de7c6512b4ff9322c3f2800237ce9db354ea88489ee761938580295ddceab2e70a325852f4c5649670fdfd2fc71b958d
+  metadata.gz: cd8e5c6561008f93d3ea4f90a078152512097e769b664dc292a8274d8a988fc63a379d23b7b6ccc0910810e0d406799959d1594023bbcc68c6de5233e30c51dd
+  data.tar.gz: 7d6826fee6f4e55535017380e84318cb351356167faafbc9fdf31a29640be2344515ee8dbbb9bfbde71e9278252ffe4da22d7555128d02a4520d0b44647188a3

data/README.md

@@ -110,6 +110,20 @@ Anything but a response code indicating success (2**) throws an exception.
 
 → [Read more about exceptions](docs/exceptions.md)
 
+## Custom error handling
+
+You can provide custom error handlers to handle errors happening during the request.
+
+If a error handler is provided nothing is raised.
+
+If your error handler returns anything else but `nil` it replaces the response body.
+
+```ruby
+handler = ->{ do_something; return {name: 'unknown'} }
+response = LHC.get('http://something', error_handler: handler)
+response.data.name # 'unknown'
+```
+
 ## Interceptors
 
 To monitor and manipulate the http communication done with LHC, you can define interceptors.

data/lhc.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.authors     = ['local.ch']
   s.email       = ['ws-operations@local.ch']
   s.homepage    = 'https://github.com/local-ch/lhc'
-  s.summary     = 'LocalHttpServices'
-  s.description = 'Rails gem for HTTP wrapping typhoeus and providing additional features (like interceptors)'
+  s.summary     = 'LocalHttpClient'
+  s.description = 'Rails gem for HTTP: Wraps typhoeus and provides additional features (like interceptors)'
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- spec/*`.split("\n") +

data/lib/lhc/request.rb

@@ -9,10 +9,11 @@ class LHC::Request
 
   TYPHOEUS_OPTIONS = [:params, :method, :body, :headers, :follow_location]
 
-  attr_accessor :response, :options, :raw, :format
+  attr_accessor :response, :options, :raw, :format, :error_handler
 
   def initialize(options, self_executing = true)
     self.options = options.deep_dup || {}
+    self.error_handler = options.delete :error_handler
     use_configured_endpoint!
     generate_url_from_template!
     self.iprocessor = LHC::InterceptorProcessor.new(self)
@@ -97,10 +98,15 @@ class LHC::Request
   def on_complete(response)
     self.response ||= LHC::Response.new(response, self)
     iprocessor.intercept(:after_response, self.response)
-    throw_error unless self.response.success?
+    handle_error(self.response) unless self.response.success?
   end
 
-  def throw_error
+  def handle_error(response)
+    throw_error(response) unless error_handler
+    response.body_replacement = error_handler.call(response)
+  end
+
+  def throw_error(response)
     error = LHC::Error.find(response)
     fail error.new(error, response)
   end

data/lib/lhc/response.rb

@@ -4,7 +4,7 @@ require 'typhoeus'
 # and provides functionality to access response data.
 class LHC::Response
 
-  attr_accessor :request
+  attr_accessor :request, :body_replacement
 
   # A response is initalized with the underlying raw response (typhoeus in our case)
   # and the associated request.
@@ -25,7 +25,7 @@ class LHC::Response
   end
 
   def body
-    raw.body
+    body_replacement || raw.body
   end
 
   def code

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION = "3.5.5"
+  VERSION = "3.6.0"
 end

data/spec/request/error_handling_spec.rb

@@ -59,4 +59,27 @@ describe LHC::Request do
       }).to raise_error(LHC::ParserError)
     end
   end
+
+  context 'custom error handler' do
+    it 'handles errors with the provided handler and does not raise them' do
+      stub_request(:get, "http://something").to_return(status: 400)
+      handler = spy('handler')
+      LHC::Request.new(url: "http://something", error_handler: 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)
+      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)
+      expect(request.response.data.message).to eq 'an error occurred'
+    end
+  end
 end

data/spec/request/headers_spec.rb

@@ -5,6 +5,6 @@ describe LHC::Request do
     stub_request(:get, 'http://local.ch')
     response = LHC.get('http://local.ch')
     request = response.request
-    expect(request.headers).to eq("User-Agent" => "Typhoeus - https://github.com/typhoeus/typhoeus")
+    expect(request.headers.keys).to include 'User-Agent'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 3.5.5
+  version: 3.6.0
 platform: ruby
 authors:
 - local.ch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -122,8 +122,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails gem for HTTP wrapping typhoeus and providing additional features
-  (like interceptors)
+description: 'Rails gem for HTTP: Wraps typhoeus and provides additional features
+  (like interceptors)'
 email:
 - ws-operations@local.ch
 executables: []
@@ -280,7 +280,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: LocalHttpServices
+summary: LocalHttpClient
 test_files:
 - spec/basic_methods/delete_spec.rb
 - spec/basic_methods/get_spec.rb