libhoney 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73ba17fc70708d8053426b67e2ea8da0d08903867754cf9a7d051fd9cd697574
-  data.tar.gz: 8ccf1db8d232401dc40ac3a844b3ef09d1880006367fef800817737471ef2369
+  metadata.gz: 29ad40e8dcbca0f6fecd415db07673c112775cf9c8e5c57c4c8d483110bab179
+  data.tar.gz: e2d40016c340a2220d83ae5f7de8971b637153d2dd5b1b687cd656adb19651e7
 SHA512:
-  metadata.gz: 47002251459186d6cae72b0d35fde132925c435b46e3fc6d9de786e64ec3b4871730e1a4214a0b4391f7a49f1c30dbb86afec56dabe28584b729258e26578d68
-  data.tar.gz: 6c26143b930627497eefdd378aa002335dbb5a32aac3d51332730f4ed95879a249ea028b8f68ae53ff34a4a05e48efba05d3580b926359bb94e7055e0bf74b1b
+  metadata.gz: 1ed70a0475fb88e90441f4e3626c12705f3f5a9cf8252f8046b0f2be3acac8806349311af87f43f423f7a41e60af4f14e1c662b0d8654f5c74adade31baca3a4
+  data.tar.gz: 86ee5a883863ec5ca594df1e3057c83bba3416340f979e54df5ccbeb98f978862ca00408cc16a5352b8a9394206ed260a5f66546fe5e7345a3cf149b29fc0fe5

data/README.md

@@ -57,6 +57,8 @@ honeycomb.send_now({
 honeycomb.close
 ```
 
+Check out the documentation for [`Libhoney::Client`](http://www.rubydoc.info/gems/libhoney/Libhoney/Client) for more detailed API documentation.
+
 You can find a more complete example demonstrating usage in [`example/fact.rb`](example/fact.rb)
 
 ## Testing instrumented code

data/Rakefile

@@ -1,4 +1,5 @@
 require "bundler/gem_tasks"
+require 'yard'
 
 require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
@@ -7,6 +8,8 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+YARD::Rake::YardocTask.new(:doc)
+
 require "yardstick/rake/measurement"
 Yardstick::Rake::Measurement.new do |measurement|
   measurement.output = "measurement/report.txt"

data/lib/libhoney/client.rb

@@ -60,6 +60,7 @@ module Libhoney
                    dataset: '',
                    sample_rate: 1,
                    api_host: 'https://api.honeycomb.io/',
+                   user_agent_addition: nil,
                    transmission: nil,
                    block_on_send: false,
                    block_on_responses: false,
@@ -78,6 +79,8 @@ module Libhoney
       @builder.sample_rate = sample_rate
       @builder.api_host = api_host
 
+      @user_agent_addition = user_agent_addition
+
       @block_on_send = block_on_send
       @block_on_responses = block_on_responses
       @max_batch_size = max_batch_size
@@ -145,7 +148,7 @@ module Libhoney
     # @param fn [#call] function that will be called to generate the value whenever an event is created.
     # @return [self] this libhoney instance.
     # @example
-    #   honey.addDynamicField("active_threads", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
+    #   honey.add_dynamic_field("active_threads", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
     def add_dynamic_field(name, fn)
       @builder.add_dynamic_field(name, fn)
       self
@@ -155,10 +158,10 @@ module Libhoney
     #
     # @param data [Hash<String=>any>] optional field->value mapping to add to the event sent.
     # @return [self] this libhoney instance.
-    # @example empty sendNow
-    #   honey.sendNow() # sends just the data that has been added via add/add_field/add_dynamic_field.
+    # @example empty send_now
+    #   honey.send_now() # sends just the data that has been added via add/add_field/add_dynamic_field.
     # @example adding data at send-time
-    #   honey.sendNow {
+    #   honey.send_now {
     #     additionalField: value
     #   }
     #/
@@ -183,7 +186,8 @@ module Libhoney
                                        :pending_work_capacity => @pending_work_capacity,
                                        :responses => @responses,
                                        :block_on_send => @block_on_send,
-                                       :block_on_responses => @block_on_responses)
+                                       :block_on_responses => @block_on_responses,
+                                       :user_agent_addition => @user_agent_addition)
         end
       }
 

data/lib/libhoney/transmission.rb

@@ -9,7 +9,8 @@ module Libhoney
                    pending_work_capacity: 0,
                    responses: 0,
                    block_on_send: 0,
-                   block_on_responses: 0)
+                   block_on_responses: 0,
+                   user_agent_addition: nil)
 
       @responses = responses
       @block_on_send = block_on_send
@@ -19,6 +20,8 @@ module Libhoney
       @max_concurrent_batches = max_concurrent_batches
       @pending_work_capacity = pending_work_capacity
 
+      @user_agent = build_user_agent(user_agent_addition).freeze
+
       # use a SizedQueue so the producer will block on adding to the send_queue when @block_on_send is true
       @send_queue = SizedQueue.new(@pending_work_capacity)
       @threads = []
@@ -54,7 +57,7 @@ module Libhoney
 
         begin
           resp = HTTP.headers(
-            'User-Agent' => "libhoney-rb/#{VERSION}",
+            'User-Agent' => @user_agent,
             'Content-Type' => 'application/json',
             'X-Honeycomb-Team' => e.writekey,
             'X-Honeycomb-SampleRate' => e.sample_rate,
@@ -97,5 +100,12 @@ module Libhoney
 
       0
     end
+
+    private
+    def build_user_agent(user_agent_addition)
+      ua = "libhoney-rb/#{VERSION}"
+      ua << " #{user_agent_addition}" if user_agent_addition
+      ua
+    end
   end
 end

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/libhoney.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "webmock", "~> 2.1"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard"
   spec.add_development_dependency "yardstick", "~> 0.9"
   spec.add_development_dependency "bump", "~> 0.5"
   spec.add_dependency "http", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: send data to Honeycomb