libhoney 1.14.0 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acad70fa5327549aaf1faca4fff6eeab79cdc72e7bab0cd3b6eb44fad49f2333
-  data.tar.gz: 15fb1bdfaa6770ebe836764217a24f7f4410a38096409b7c3c64b775b4116349
+  metadata.gz: 2373830c8e1db77f91d3246c8e0f70f014d18f3ddf385f7a47eaff425e5750df
+  data.tar.gz: a40a3eef2910a08fad7c23302ad15ed42764e9dea1dce589a4f75473ed7a4adb
 SHA512:
-  metadata.gz: e7a813d6e5b8a0f25f70f3e978a9b9a42e169f62d9b740829e784cf4f92c48531800fc93b69aa8f1aee4f6acebef0f648405db66418ca38e39c46042d02214d8
-  data.tar.gz: 4d764b9c4bfb0b244bb5bf97275730b77c5e70d7720bfeac2cac39ae5d2a858b9fe5ed935379a08ee77a827b29262f787c9fd8ad1ae5ae529efa20fa8a03626e
+  metadata.gz: 47d18ab9a49b10f8277508048eaf0736ca36547918181c02b94d8ea7a5c6c2e9c068b63972446cc90a0e1adc4c6a4f900671e6644d869798f687b019356233f3
+  data.tar.gz: f356d9b7428041fa5e6fbfaafded29b4c84aa78eaecbc61f04a9472162a796d9934d3c1912d60182cbb8696dc4d77e3c2d4fc1642f5d7c11017802625ea4f4d3

data/.rubocop.yml

@@ -19,7 +19,7 @@ Metrics/ClassLength:
     - test/*
 
 Metrics/MethodLength:
-  Max: 25
+  Max: 40
   Exclude:
     - lib/libhoney/transmission.rb
     - test/*

data/.rubocop_todo.yml

@@ -14,17 +14,17 @@ Lint/HandleExceptions:
 
 # Offense count: 7
 Metrics/AbcSize:
-  Max: 35
+  Max: 40
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 27
+  Max: 30
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 12
 
 # Offense count: 2
 # Configuration parameters: CountKeywordArgs.
@@ -33,4 +33,4 @@ Metrics/ParameterLists:
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    libhoney (1.14.0)
+    libhoney (1.14.1)
       addressable (~> 2.0)
       http (>= 2.0, < 5.0)
 
@@ -17,16 +17,21 @@ GEM
       safe_yaml (~> 1.0.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    ffi (1.11.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
     hashdiff (1.0.0)
-    http (4.1.1)
+    http (4.2.0)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
     jaro_winkler (1.5.3)
     minitest (5.11.3)
     multi_json (1.13.1)

data/lib/libhoney/cleaner.rb

@@ -0,0 +1,62 @@
+module Libhoney
+  module Cleaner
+    ENCODING_OPTIONS = { invalid: :replace, undef: :replace }.freeze
+    RECURSION = '[RECURSION]'.freeze
+    RAISED = '[RAISED]'.freeze
+
+    # Cleans an object for converting to JSON. Checks for recursion,
+    # exceptions generated, and non UTF8 encoded strings.
+    # @param data the data to clean
+    # @param seen [Hash] used to check for recursion
+    # @return the cleaned object
+    def clean_data(data, seen = {})
+      return nil if data.nil?
+
+      # check for recursion here, by tracking all of the potentially nested
+      # objects that we have seen before.
+      protection =  case data
+                    when Hash, Array, Set
+                      # bail here if we have already seen this object
+                      return seen[data] if seen[data]
+
+                      seen[data] = RECURSION
+                    end
+
+      value = case data
+              when Hash
+                clean_hash = {}
+                data.each do |key, val|
+                  clean_hash[key] = clean_data(val, seen)
+                end
+                clean_hash
+              when Array, Set
+                data.map do |element|
+                  clean_data(element, seen)
+                end
+              when Numeric, TrueClass, FalseClass
+                data
+              when String
+                clean_string(data)
+              else
+                str = begin
+                        data.to_s
+                      rescue StandardError
+                        RAISED
+                      end
+                clean_string(str)
+              end
+
+      seen[data] = value if protection
+      value
+    end
+
+    # Converts a string to UTF8 encoding if required using the ENCODING_OPTIONS
+    # @param str [String] the string to convert
+    # @return [String] the UTF8 encoded string
+    def clean_string(str)
+      return str if str.encoding == Encoding::UTF_8 && str.valid_encoding?
+
+      str.encode(Encoding::UTF_8, ENCODING_OPTIONS)
+    end
+  end
+end

data/lib/libhoney/transmission.rb

@@ -1,10 +1,13 @@
 require 'json'
 require 'timeout'
 require 'libhoney/response'
+require 'libhoney/cleaner'
 
 module Libhoney
   # @api private
   class TransmissionClient
+    include Cleaner
+
     def initialize(max_batch_size: 50,
                    send_frequency: 100,
                    max_concurrent_batches: 10,
@@ -63,6 +66,7 @@ module Libhoney
         begin
           http = http_clients[api_host]
           body = serialize_batch(batch)
+
           next if body.nil?
 
           headers = {
@@ -179,11 +183,14 @@ module Libhoney
       payload = []
       batch.map! do |event|
         begin
+          data = clean_data(event.data)
+
           e = {
             time: event.timestamp.iso8601(3),
             samplerate: event.sample_rate,
-            data: event.data
+            data: data
           }
+
           payload << JSON.generate(e)
 
           event

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = '1.14.0'.freeze
+  VERSION = '1.14.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.1
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -219,6 +219,7 @@ files:
 - example/factorial.rb
 - lib/libhoney.rb
 - lib/libhoney/builder.rb
+- lib/libhoney/cleaner.rb
 - lib/libhoney/client.rb
 - lib/libhoney/event.rb
 - lib/libhoney/log_client.rb