lhc 10.5.2 → 10.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ceecd53d94051855df66cfa2733ac9afda9b6b4
-  data.tar.gz: fbb5373333e5a18c287c1846b3bf0ad5b913e269
+  metadata.gz: ca7d73d46581639f7628788d19deba210e4a593d
+  data.tar.gz: 2915b1bfe0cca8c89f8637134496f438b2ea60ec
 SHA512:
-  metadata.gz: 829385685260241d20874839ca0a32d8ad05f5870a7a9e6a509882833bc86af8d02d6addd1b837acf0b31456e29a65e4267d9110ddbb2f1fc6e6c76536ddf146
-  data.tar.gz: 63bc036627030c330e0a1ea811ea8296ce1cdf64b0ea499d761e29e0c5cae7b853d7484d501116bed38b901d81d7e25b504a61b7d5254ff079e742e79bb062e8
+  metadata.gz: 679e9a3b6ba4c5766377924da57c027a1d0812e0da0112d0d0cbeb6ca2b010985c8678e03d76de3a60c3ef7092121ea3500dd55a265e5d4dbda922abfd8b6324
+  data.tar.gz: d0fbeb0aa24298e8f9c843eebbab27617dc65c0e62af0fc520449059a5c9cf227e48163722732a1e124565220ec95f61e41367b732af5b2bf060eb8f7648f4c7

data/lib/core_ext/hash/deep_transform_values.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# This was copied from: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_transform_values.rb
+class Hash
+  # Returns a new hash with all values converted by the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #  hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #  hash.deep_transform_values{ |value| value.to_s.upcase }
+  #  # => {person: {name: "ROB", age: "28"}}
+  def deep_transform_values(&block)
+    _deep_transform_values_in_object(self, &block)
+  end
+
+  # Destructively converts all values by using the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  def deep_transform_values!(&block)
+    _deep_transform_values_in_object!(self, &block)
+  end
+
+  private
+
+  # support methods for deep transforming nested hashes and arrays
+  def _deep_transform_values_in_object(object, &block)
+    case object
+    when Hash
+      object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
+    when Array
+      object.map { |e| _deep_transform_values_in_object(e, &block) }
+    else
+      yield(object)
+    end
+  end
+
+  def _deep_transform_values_in_object!(object, &block)
+    case object
+    when Hash
+      object.transform_values! { |value| _deep_transform_values_in_object!(value, &block) }
+    when Array
+      object.map! { |e| _deep_transform_values_in_object!(e, &block) }
+    else
+      yield(object)
+    end
+  end
+end

data/lib/lhc.rb

@@ -9,6 +9,8 @@ module LHC
     'lhc/concerns/lhc/basic_methods_concern'
   autoload :ConfigurationConcern,
     'lhc/concerns/lhc/configuration_concern'
+  autoload :FixInvalidEncodingConcern,
+    'lhc/concerns/lhc/fix_invalid_encoding_concern'
   autoload :FormatsConcern,
     'lhc/concerns/lhc/formats_concern'
 

data/lib/lhc/concerns/lhc/fix_invalid_encoding_concern.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module LHC
+  module FixInvalidEncodingConcern
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # 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
+
+      private
+
+      def utf8?(string)
+        string.encoding == Encoding::UTF_8
+      end
+    end
+  end
+end

data/lib/lhc/error.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class LHC::Error < StandardError
+  include LHC::FixInvalidEncodingConcern
+
   attr_accessor :response, :_message
 
   def self.map
@@ -61,44 +63,14 @@ class LHC::Error < StandardError
     return response if response.is_a?(String)
     request = response.request
     debug = []
-    debug << [request.method, request.url].map { |str| fix_invalid_encoding(str) }.join(' ')
+    debug << [request.method, request.url].map { |str| self.class.fix_invalid_encoding(str) }.join(' ')
     debug << "Options: #{request.options}"
     debug << "Headers: #{request.headers}"
     debug << "Response Code: #{response.code} (#{response.options[:return_code]})"
     debug << "Response Options: #{response.options}"
     debug << response.body
     debug << _message
-    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
+    debug.map { |str| self.class.fix_invalid_encoding(str) }.join("\n")
   end
 end

data/lib/lhc/interceptors/rollbar.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'core_ext/hash/deep_transform_values'
+
 class LHC::Rollbar < LHC::Interceptor
   include ActiveSupport::Configurable
+  include LHC::FixInvalidEncodingConcern
 
   def after_response
     return unless Object.const_defined?('Rollbar')
@@ -23,6 +26,11 @@ class LHC::Rollbar < LHC::Interceptor
         params: request.params
       }
     }.merge additional_params
-    Rollbar.warning("Status: #{response.code} URL: #{request.url}", data)
+    begin
+      Rollbar.warning("Status: #{response.code} URL: #{request.url}", data)
+    rescue Encoding::UndefinedConversionError
+      sanitized_data = data.deep_transform_values { |value| self.class.fix_invalid_encoding(value) }
+      Rollbar.warning("Status: #{response.code} URL: #{request.url}", sanitized_data)
+    end
   end
 end

data/lib/lhc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHC
-  VERSION ||= '10.5.2'
+  VERSION ||= '10.5.3'
 end

data/spec/core_ext/hash/deep_transform_values_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'core_ext/hash/deep_transform_values'
+
+describe Hash do
+  subject do
+    {
+      'key' => 'value',
+      'key2' => { 'key' => 'value', key2: 'value' }
+    }
+  end
+
+  let(:expected_result) do
+    {
+      'key' => 'VALUE',
+      'key2' => { 'key' => 'VALUE', key2: 'VALUE' }
+    }
+  end
+
+  it 'applies upcase to all values' do
+    expect(subject.deep_transform_values { |value| value.upcase }).to eq(expected_result)
+  end
+end

data/spec/interceptors/rollbar/invalid_encoding_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Rollbar do
+  context 'invalid encoding in rollbar payload' do
+    before(:each) do
+      LHC.config.interceptors = [LHC::Rollbar]
+      stub_request(:get, 'http://local.ch').to_return(status: 400)
+
+      allow(described_class).to receive(:fix_invalid_encoding).and_call_original
+      # a stub that will throw a error on first call and suceed on subsequent calls
+      call_counter = 0
+      class Rollbar; end
+      ::Rollbar.stub(:warning) do
+        call_counter += 1
+        raise Encoding::UndefinedConversionError if call_counter == 1
+      end
+
+      # the response for the caller is still LHC::BadRequest
+      expect(-> { LHC.get('http://local.ch', rollbar: { additional: invalid }) }).to raise_error LHC::BadRequest
+    end
+
+    let(:invalid) { (+"in\xc3lid").force_encoding('ASCII-8BIT') }
+    let(:valid) { described_class.fix_invalid_encoding(invalid) }
+
+    it 'calls fix_invalid_encoding incase a Encoding::UndefinedConversionError was encountered' do
+      expect(described_class).to have_received(:fix_invalid_encoding).with(invalid)
+    end
+
+    it 'calls Rollbar.warn with the fixed data' do
+      expect(::Rollbar).to have_received(:warning)
+        .with(
+          'Status: 400 URL: http://local.ch',
+          hash_including(
+            response: anything,
+            request: anything,
+            additional: valid
+          )
+        )
+    end
+  end
+end

data/spec/interceptors/rollbar/main_spec.rb

@@ -7,16 +7,21 @@ describe LHC::Rollbar do
     LHC.config.interceptors = [LHC::Rollbar]
   end
 
-  it 'does not report if Rollbar is not defined' do
-    stub_request(:get, 'http://local.ch').to_return(status: 400)
-    expect(-> { LHC.get('http://local.ch') })
-      .to raise_error LHC::BadRequest
+  context 'Rollbar is undefined' do
+    before(:each) do
+      Object.send(:remove_const, 'Rollbar') if Object.const_defined?('Rollbar')
+    end
+    it 'does not report' do
+      stub_request(:get, 'http://local.ch').to_return(status: 400)
+      expect(-> { LHC.get('http://local.ch') })
+        .to raise_error LHC::BadRequest
+    end
   end
 
   context 'Rollbar is defined' do
     before(:each) do
       class Rollbar; end
-      allow(::Rollbar).to receive(:warning)
+      ::Rollbar.stub(:warning)
     end
 
     it 'does report errors to rollbar' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 10.5.2
+  version: 10.5.3
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
@@ -213,9 +213,11 @@ files:
 - cider-ci/task_components/ruby.yml
 - friday.yml
 - lhc.gemspec
+- lib/core_ext/hash/deep_transform_values.rb
 - lib/lhc.rb
 - lib/lhc/concerns/lhc/basic_methods_concern.rb
 - lib/lhc/concerns/lhc/configuration_concern.rb
+- lib/lhc/concerns/lhc/fix_invalid_encoding_concern.rb
 - lib/lhc/concerns/lhc/formats_concern.rb
 - lib/lhc/concerns/lhc/request/user_agent_concern.rb
 - lib/lhc/config.rb
@@ -262,6 +264,7 @@ files:
 - spec/basic_methods/request_without_rails_spec.rb
 - spec/config/endpoints_spec.rb
 - spec/config/placeholders_spec.rb
+- spec/core_ext/hash/deep_transform_values_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/images/.keep
@@ -340,6 +343,7 @@ files:
 - spec/interceptors/response_competition_spec.rb
 - spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
+- spec/interceptors/rollbar/invalid_encoding_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/interceptors/throttle/main_spec.rb
 - spec/interceptors/throttle/reset_track_spec.rb
@@ -409,6 +413,7 @@ test_files:
 - spec/basic_methods/request_without_rails_spec.rb
 - spec/config/endpoints_spec.rb
 - spec/config/placeholders_spec.rb
+- spec/core_ext/hash/deep_transform_values_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/images/.keep
@@ -487,6 +492,7 @@ test_files:
 - spec/interceptors/response_competition_spec.rb
 - spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
+- spec/interceptors/rollbar/invalid_encoding_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/interceptors/throttle/main_spec.rb
 - spec/interceptors/throttle/reset_track_spec.rb