lhc 3.8.0 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b11d4708f7d94c14f063078c8c7d2d19ef0b17b3
-  data.tar.gz: 6af6b618ffbf68766bcbe1fa0aa1a90320794d1f
+  metadata.gz: e327e8cf911398de6860f5e328bfee3d4ec4a117
+  data.tar.gz: eee4da06a4953d23eaef467a935a0a6ab7198454
 SHA512:
-  metadata.gz: 9d592f45c4492bf54a9a91be316bee2023612cb21680e996812db68d9a47b3cf11c37933c4a17ef40f7c0cee919947d6f0a30fc1a27877aa6fd0c99a7e382a2f
-  data.tar.gz: 00b53d02f8a57a918873f110b733d7084989e2c92057d0ca66ca0a693163cbe8d8351173f3b84c703f0bd931006dc2046d0c3dc7b56cc83cbbc4bf5025e1898c
+  metadata.gz: 63b5203325d62df8aec412bb04e0e4bd6cffdafa29527641a8e0319a91e7fd39300135d31a0a9e3e169ad287c5c678f248994a71eb786a558957017ff6c8bed5
+  data.tar.gz: b13e872cab4a98c6e06a49d1c5e59ce86fdb1c1ae0ddc2b1bfb11366b5157e2444953b0d6cb52db4d0192656d64c413a24f83295b040afec96cfb795378db954

data/lib/lhc/error.rb

@@ -55,12 +55,43 @@ class LHC::Error < StandardError
   def to_s
     request = response.request
     debug = []
-    debug << "#{request.method} #{request.url}"
-    debug << "Params: #{request.options}"
+    debug << [request.method, request.url].map { |str| fix_invalid_encoding(str) }.join(' ')
+    debug << "Options: #{request.options}"
     debug << "Headers: #{request.headers}"
     debug << "Response Code: #{response.code}"
     debug << response.body
     debug << _message
-    debug.join("\n")
+    debug.map { |str| fix_invalid_encoding(str) }.join("\n")
+  end
+
+  private
+
+  # fix strings that contain non-UTF8 encoding in a forceful way
+  # should none of the fix-attempts be successful,
+  # an empty string is returned instead
+  def fix_invalid_encoding(string)
+    return string unless string.is_a?(String)
+    result = string.dup
+
+    # we assume it's ISO-8859-1 first
+    if !result.valid_encoding? || !utf8?(result)
+      result.encode!('UTF-8', 'ISO-8859-1', invalid: :replace, undef: :replace, replace: '')
+    end
+
+    # if it's still an issue, try with BINARY
+    if !result.valid_encoding? || !utf8?(result)
+      result.encode!('UTF-8', 'BINARY', invalid: :replace, undef: :replace, replace: '')
+    end
+
+    # if its STILL an issue, return an empty string :(
+    if !result.valid_encoding? || !utf8?(result)
+      result = ""
+    end
+
+    result
+  end
+
+  def utf8?(string)
+    string.encoding == Encoding::UTF_8
   end
 end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= "3.8.0"
+  VERSION ||= "3.8.1"
 end

data/spec/error/to_s_spec.rb

@@ -0,0 +1,44 @@
+require 'rails_helper'
+
+describe LHC::Error do
+  context 'to_s' do
+    let(:invalid) { "in\xc3lid".force_encoding('ASCII-8BIT') }
+    let(:valid) { "vælid" }
+
+    context 'check assumptions' do
+      it 'joining raises an error' do
+        expect { [valid, invalid].join }.to raise_error Encoding::CompatibilityError
+      end
+      it 'interpolation raises an error' do
+        expect { "#{valid} #{invalid}" }.to raise_error Encoding::CompatibilityError
+      end
+      it 'to_json on an array raises an error' do
+        expect { [valid, invalid].to_json }.to raise_error Encoding::UndefinedConversionError
+      end
+
+      it 'to_s on a hash does not raise an error' do
+        expect { { valid: valid, invalid: invalid }.to_s }.not_to raise_error
+      end
+
+      it 'to_json on a hash does raise an error' do
+        expect { { valid: valid, invalid: invalid }.to_json }.to raise_error Encoding::UndefinedConversionError
+      end
+    end
+
+    it 'invalid body, valid message' do
+      stub_request(:get, 'http://local.ch')
+        .to_return(status: 200, body: "{ text : '#{invalid}' }")
+      response = LHC.get('http://local.ch')
+      expect { LHC::Error.new(valid, response).to_s }.not_to raise_error # Encoding::CompatibilityError
+    end
+
+    it 'valid body, invalid message' do
+      stub_request(:get, 'http://local.ch')
+        .to_return(status: 200, body: "{ text : '#{valid}' }")
+      response = LHC.get('http://local.ch')
+      expect { LHC::Error.new(invalid, response).to_s }.not_to raise_error # Encoding::CompatibilityError
+    end
+    # the other cases cannot be tested (for example what happens if the headers contain invalid data)
+    # because the mocking framework triggers the encoding error already
+  end
+end

data/spec/interceptors/after_request_spec.rb

@@ -4,8 +4,7 @@ describe LHC do
   context 'interceptor' do
     before(:each) do
       class SomeInterceptor < LHC::Interceptor
-        def after_request(request)
-        end
+        def after_request(request); end
       end
       LHC.configure { |c| c.interceptors = [SomeInterceptor] }
     end

data/spec/interceptors/before_response_spec.rb

@@ -4,8 +4,7 @@ describe LHC do
   context 'interceptor' do
     before(:each) do
       class SomeInterceptor < LHC::Interceptor
-        def before_response(request)
-        end
+        def before_response(request); end
       end
       LHC.configure { |c| c.interceptors = [SomeInterceptor] }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.8.1
 platform: ruby
 authors:
 - local.ch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -241,6 +241,7 @@ files:
 - spec/error/find_spec.rb
 - spec/error/response_spec.rb
 - spec/error/timeout_spec.rb
+- spec/error/to_s_spec.rb
 - spec/formats/json_spec.rb
 - spec/interceptors/after_request_spec.rb
 - spec/interceptors/after_response_spec.rb
@@ -295,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 1.9.2
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient
@@ -354,6 +355,7 @@ test_files:
 - spec/error/find_spec.rb
 - spec/error/response_spec.rb
 - spec/error/timeout_spec.rb
+- spec/error/to_s_spec.rb
 - spec/formats/json_spec.rb
 - spec/interceptors/after_request_spec.rb
 - spec/interceptors/after_response_spec.rb