libhoney 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ee74ef74255d89969a6fa143e1b9f28aabf3b32
+  data.tar.gz: 5f9659817e94933e8138396315092d36196b00c4
+SHA512:
+  metadata.gz: 1ef9aba4d5ed49c28741ed995575177dc831972ea756c18392ef42e6c30a468988481543e01dacb4a58582bb280f84a968ba6e834b470b6af5ec42d79a9001ec
+  data.tar.gz: a46d2468b7f38ff6fd2c7f934ca913415ff5b4aef8670ab66d70e8e8414269483818d61c043692e000cff1ba4e5ece43fd92e6b9328fd643006419f3641da353

data/.gitignore

@@ -0,0 +1,55 @@
+*~
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# vim stuff
+*.swp
+*.swo

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2

data/CONTRIBUTORS

@@ -0,0 +1,2 @@
+Tim Spencer <tspencer@hungry.com>
+Chris Toshok <toshok@honeycomb.io>

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,57 @@
+libhoney
+========
+Ruby gem for sending events to http://honeycomb.io from within your ruby code.
+
+[![Build Status](https://travis-ci.com/honeycombio/libhoney-rb.svg?token=pycxQxHKSNdG7LiWg3Nt&branch=master)](https://travis-ci.com/honeycombio/libhoney-rb)
+
+## Summary
+
+libhoney is written to ease the process of sending data to Honeycomb from within
+your ruby code.
+
+For an overview of how to use a honeycomb library, see our documentation at
+https://honeycomb.io/docs/send-data/sdks/
+
+## Installation
+
+To install the stable release:
+
+```
+gem install libhoney
+```
+
+If you're using bundler, you can also reference the git repo and stay on the bleeding age by putting this in your `Gemfile`:
+
+```
+gem 'libhoney', :git => 'http://github.com/honeycombio/libhoney-rb.git'
+```
+
+## Example Usage
+```ruby
+require 'libhoney'
+
+# create a client instance
+honey = Libhoney::Client.new(:writekey => "your writekey",
+                             :dataset => "your dataset")
+
+# create an event and add fields to it
+event = honey.event
+event.add_field("duration_ms", 153.12)
+event.add_field("method", "get")
+# send the event
+event.send
+
+# when all done, call close
+honey.close
+```
+
+You can find a more complete example demonstrating usage in `example/fact.rb`
+
+## Contributions
+
+Features, bug fixes and other changes to libhoney are gladly accepted. Please
+open issues or a pull request with your change. Remember to add your name to the
+CONTRIBUTORS file!
+
+All contributions will be released under the Apache License 2.0.
+

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require "yardstick/rake/measurement"
+Yardstick::Rake::Measurement.new do |measurement|
+  measurement.output = "measurement/report.txt"
+end
+
+require "yardstick/rake/verify"
+Yardstick::Rake::Verify.new do |verify|
+  verify.require_exact_threshold = false
+  verify.threshold = 55
+end
+
+task :default => :test

data/example/fact.rb

@@ -0,0 +1,57 @@
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'libhoney'
+
+writekey = "7aefa39399a474bd9f414a8e3f8d9691" # replace this with yours from https://ui.honeycomb.com/account
+dataset = "factorial"
+
+
+def factorial(n)
+  return -1 * factorial(abs(n)) if n < 0
+  return 1 if n == 0
+  return n * factorial(n - 1)
+end
+
+def run_fact(low, high, libh_builder)
+  for i in low..high do
+    ev = libh_builder.event
+    ev.metadata = { :fn => "run_fact",
+                    :i => i }
+    ev.with_timer("fact") do
+      res = factorial(10 + i)
+      ev.add_field("retval", res)
+    end
+    ev.send
+  end
+end
+
+def read_responses(resp_queue)
+  loop do
+    resp = resp_queue.pop()
+    break if resp == nil
+    puts "sending event with metadata #{resp.metadata} took #{resp.duration*1000}ms and got response code #{resp.status_code}"
+  end
+end
+    
+
+libhoney = Libhoney::Client.new(:writekey => writekey,
+                                :dataset => dataset,
+                                :max_concurrent_batches => 1)
+
+resps = libhoney.responses()
+Thread.new do
+  begin
+    libhoney.add_field("version", "3.4.5")
+    libhoney.add_dynamic_field("num_threads", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
+    libhoney.send_now({:status => "starting run"})
+    run_fact(1, 20, libhoney.builder({:range => "low"}))
+    run_fact(31, 40, libhoney.builder({:range => "high"}))
+    libhoney.send_now({:status => "ending run"})
+    libhoney.close(true)
+  rescue Exception => e
+    puts e
+  end
+end
+
+read_responses(resps)

data/lib/libhoney/builder.rb

@@ -0,0 +1,112 @@
+require 'libhoney/event'
+
+module Libhoney
+  class Builder
+    attr_accessor :writekey, :dataset, :sample_rate, :api_host
+    attr_accessor :fields, :dyn_fields
+
+    # @api private
+    # @see Client#builder
+    # @see Builder#builder
+    def initialize(libhoney, parent_builder, fields = {}, dyn_fields = {})
+      @libhoney = libhoney
+
+      @fields = {}
+      @dyn_fields = {}
+
+      if parent_builder != nil
+        @writekey = parent_builder.writekey
+        @dataset = parent_builder.dataset
+        @sample_rate = parent_builder.sample_rate
+        @api_host = parent_builder.api_host
+        @fields.merge!(parent_builder.fields)
+        @dyn_fields.merge!(parent_builder.dyn_fields)
+      end
+
+      @fields.merge!(fields)
+      @dyn_fields.merge!(dyn_fields)
+      self
+    end
+
+    # adds a group of field->values to the events created from this builder.
+    #
+    # @param data [Hash<String=>any>] field->value mapping.
+    # @return [self] this Builder instance.
+    # @example using an object
+    #   honey = Libhoney::Client.new(...)
+    #   builder = honey.builder
+    #   builder.add {
+    #     :responseTime_ms => 100,
+    #     :httpStatusCode => 200
+    #   }
+    def add(data)
+      @fields.merge!(data)
+      self
+    end
+
+    # adds a single field->value mapping to the events created from this builder.
+    #
+    # @param name [string]
+    # @param val [any]
+    # @return [self] this Builder instance.
+    # @example
+    #   builder.add_field("responseTime_ms", 100)
+    def add_field(name, val)
+      @fields[name] = val
+      self
+    end
+
+    # adds a single field->dynamic value function, which is invoked to supply values when events are created from this builder.
+    #
+    # @param name [string] the name of the field to add to events.
+    # @param fn [#call] the function called to generate the value for this field.
+    # @return [self] this Builder instance.
+    # @example
+    #   builder.add_dynamic_field("process_heapUsed", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
+    def add_dynamic_field(name, fn)
+      @dyn_fields[name] = fn
+    end
+
+    # creates and sends an event, including all builder fields/dyn_fields, as well as anything in the optional data parameter.
+    #
+    # @param data [Hash<String=>any>] optional field->value mapping to add to the event sent.
+    # @return [self] this Builder instance
+    # @example empty send_now
+    #   builder.send_now # sends just the data that has been added via add/add_field/add_dynamic_field.
+    # @example adding data at send-time
+    #   builder.send_now {
+    #     :additionalField => value
+    #   }
+    def send_now(data = {})
+      ev = self.event
+      ev.add(data)
+      ev.send()
+      self
+    end
+
+    # creates and returns a new Event containing all fields/dyn_fields from this builder, that can be further fleshed out and sent on its own.
+    #
+    # @return [Event] an Event instance
+    # @example adding data at send-time
+    #   ev = builder.event
+    #   ev.addField("additionalField", value)
+    #   ev.send
+    def event
+      Event.new(@libhoney, self, @fields, @dyn_fields)
+    end
+
+    # creates and returns a clone of this builder, merged with fields and dyn_fields passed as arguments.
+    #
+    # @param fields [Hash<String=>any>] a field->value mapping to merge into the new builder.
+    # @param dyn_fields [Hash<String=>#call>] a field->dynamic function mapping to merge into the new builder.
+    # @return [Builder] a Builder instance
+    # @example no additional fields/dyn_field
+    #   another_builder = the_builder.builder
+    # @example additional fields/dyn_field
+    #   anotherBuilder = the_builder.builder({ :request_id => @request_id },
+    #                                        { :active_threads => Proc.new { Thread.list.select {|thread| thread.status == "run"}.count } });
+    def builder(fields = {}, dyn_fields = {})
+      Builder.new(@libhoney, self, fields, dyn_fields)
+    end
+  end
+end

data/lib/libhoney/client.rb

@@ -0,0 +1,209 @@
+require 'thread'
+require 'time'
+require 'json'
+require 'http'
+
+# define a few additions that proxy access through Client's builder.  makes Client much tighter.
+class Class
+  def builder_attr_accessor(*args)
+    args.each do |arg|
+      self.class_eval("def #{arg};@builder.#{arg};end")
+      self.class_eval("def #{arg}=(val);@builder.#{arg}=val;end")
+    end
+  end
+  def builder_attr_reader(*args)
+    args.each do |arg|
+      self.class_eval("def #{arg};@builder.#{arg};end")
+    end
+  end
+  def builder_attr_writer(*args)
+    args.each do |arg|
+      self.class_eval("def #{arg}=(val);@builder.#{arg}=val;end")
+    end
+  end
+end
+
+module Libhoney
+  ##
+  # This is a library to allow you to send events to Honeycomb from within your
+  # ruby application.
+  #
+  # Example:
+  #   require 'libhoney'
+  #   honey = Libhoney.new(writekey, dataset, url, sample_rate, num_workers)
+  #   event = honey.event
+  #   event.add({'pglatency' => 100})
+  #   honey.send(event)
+  #   <repeat creating and sending events until your program is finished>
+  #   honey.close
+  #
+  # Arguments:
+  # * *writekey* is the key to use the Honeycomb service
+  # * *dataset* is the dataset to write into
+  # * *sample_rate* is how many samples you want to keep.  IE:  1 means you want 1 out of 1 samples kept, or all of them.  10 means you want 1 out of 10 samples kept.  And so on.
+  # * *url* is the url to connect to Honeycomb
+  # * *num_workers* is the number of threads working on the queue of events you are generating
+  #
+  # Note that by default, the max queue size is 1000.  If the queue gets bigger than that, we start dropping events.
+  #
+  class Client
+    # Instantiates libhoney and prepares it to send events to Honeycomb.
+    #
+    # @param writekey [String] the write key from your honeycomb team
+    # @param dataset [String] the dataset you want 
+    # @param sample_rate [Fixnum] cause libhoney to send 1 out of sampleRate events.  overrides the libhoney instance's value.
+    # @param api_host [String] the base url to send events to
+    # @param block_on_send [Boolean] if more than pending_work_capacity events are written, block sending further events
+    # @param block_on_responses [Boolean] if true, block if there is no thread reading from the response queue
+    def initialize(writekey: '',
+                   dataset: '',
+                   sample_rate: 1,
+                   api_host: 'https://api.honeycomb.io/',
+                   block_on_send: false,
+                   block_on_responses: false,
+                   max_batch_size: 50,
+                   send_frequency: 100,
+                   max_concurrent_batches: 10,
+                   pending_work_capacity: 1000)
+      # check for insanity
+      raise Exception.new('libhoney:  max_concurrent_batches must be greater than 0') if max_concurrent_batches < 1
+      raise Exception.new('libhoney:  sample rate must be greater than 0') if sample_rate < 1
+
+      raise Exception.new("libhoney:  Ruby versions < 2.2 are not supported") if !Gem::Dependency.new("ruby", "~> 2.2").match?("ruby", RUBY_VERSION)      
+      @builder = Builder.new(self, nil)
+      @builder.writekey = writekey
+      @builder.dataset = dataset
+      @builder.sample_rate = sample_rate
+      @builder.api_host = api_host
+
+      @block_on_send = block_on_send
+      @block_on_responses = block_on_responses
+      @max_batch_size = max_batch_size
+      @send_frequency = send_frequency
+      @max_concurrent_batches = max_concurrent_batches
+      @pending_work_capacity = pending_work_capacity
+      @responses = SizedQueue.new(2 * @pending_work_capacity)
+      @tx = nil
+      @lock = Mutex.new
+
+      self
+    end
+
+    builder_attr_accessor :writekey, :dataset, :sample_rate, :api_host
+
+    attr_reader :block_on_send, :block_on_responses, :max_batch_size,
+                :send_frequency, :max_concurrent_batches,
+                :pending_work_capacity, :responses
+
+    def event
+      @builder.event
+    end
+
+    def builder(fields = {}, dyn_fields = {})
+      @builder.builder(fields, dyn_fields)
+    end
+
+    ##
+    # Nuke the queue and wait for inflight requests to complete before returning.
+    # If you set drain=true, it will not clear the queue, so all queued requests
+    # will drain before exiting.
+    def close(drain=false)
+      return @tx.close(drain) if @tx
+      0
+    end
+
+    # adds a group of field->values to the global Builder.
+    #
+    # @param data [Hash<String=>any>] field->value mapping.
+    # @return [self] this Client instance
+    # @example
+    #   honey.add {
+    #     :responseTime_ms => 100,
+    #     :httpStatusCode => 200
+    #   }
+    def add(data)
+      @builder.add(data)
+      self
+    end
+
+    # adds a single field->value mapping to the global Builder.
+    #
+    # @param name [String] name of field to add.
+    # @param val [any] value of field to add.
+    # @return [self] this Client instance
+    # @example
+    #   honey.addField("responseTime_ms", 100)
+    def add_field(name, val)
+      @builder.add_field(name, val)
+      self
+    end
+
+    # adds a single field->dynamic value function to the global Builder.
+    #
+    # @param name [String] name of field to add.
+    # @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 })
+    def add_dynamic_field(name, fn)
+      @builder.add_dynamic_field(name, fn)
+      self
+    end
+
+    # creates and sends an event, including all global builder fields/dyn_fields, as well as anything in the optional data parameter.
+    #
+    # @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 adding data at send-time
+    #   honey.sendNow {
+    #     additionalField: value
+    #   }
+    #/
+    def send_now(data = {})
+      @builder.send_now(data)
+      self
+    end
+
+    ##
+    # Enqueue an event to send.  Sampling happens here, and we will create
+    # new threads to handle work as long as we haven't gone over max_concurrent_batches and
+    # there are still events in the queue.
+    #
+    # @param event [Event] the event to send to honeycomb
+    # @api private
+    def send_event(event)
+      @lock.synchronize {
+        if !@tx
+          @tx = TransmissionClient.new(:max_batch_size => @max_batch_size,
+                                       :send_frequency => @send_frequency,
+                                       :max_concurrent_batches => @max_concurrent_batches,
+                                       :pending_work_capacity => @pending_work_capacity,
+                                       :responses => @responses,
+                                       :block_on_send => @block_on_send,
+                                       :block_on_responses => @block_on_responses)
+        end
+      }
+
+      @tx.add(event)
+    end
+
+    # @api private
+    def send_dropped_response(event, msg)
+      response = Response.new(:error => msg,
+                              :metadata => event.metadata)
+      begin
+        @responses.enq(response, !@block_on_responses)
+      rescue ThreadError
+        # happens if the queue was full and block_on_responses = false.
+      end
+    end
+
+    # @api private
+    def should_drop(sample_rate)
+      rand(1..sample_rate) != 1
+    end
+
+  end
+end

data/lib/libhoney/event.rb

@@ -0,0 +1,102 @@
+module Libhoney
+  ##
+  # This is the event object that you can fill up with data.
+  # The data itself is a ruby hash.
+  class Event
+    attr_accessor :writekey, :dataset, :sample_rate, :api_host
+    attr_accessor :timestamp, :metadata
+
+    attr_reader :data
+    
+    # @api private
+    # @see Client#event
+    # @see Builder#event
+    def initialize(libhoney, builder, fields = {}, dyn_fields = {})
+      @libhoney = libhoney
+
+      @writekey = builder.writekey
+      @dataset = builder.dataset
+      @sample_rate = builder.sample_rate
+      @api_host = builder.api_host
+      @timestamp = Time.now
+      @metadata = nil
+
+      @data = { }
+      fields.each { |k, v| self.add_field(k, v) }
+      dyn_fields.each { |k, v| self.add_field(k, v.call) }
+      
+      self
+    end
+
+    # adds a group of field->values to this event.
+    #
+    # @param newdata [Hash<String=>any>] field->value mapping.
+    # @return [self] this event.
+    # @example using an object
+    #   builder.event
+    #     .add({
+    #       :responseTime_ms => 100,
+    #       :httpStatusCode => 200
+    #     })
+    def add(newdata)
+      @data.merge!(newdata)
+      self
+    end
+
+    # adds a single field->value mapping to this event.
+    #
+    # @param name [String]
+    # @param val [any]
+    # @return [self] this event.
+    # @example
+    #   builder.event
+    #     .add_field("responseTime_ms", 100)
+    #     .send
+    def add_field(name, val)
+      @data[name] = val
+      self
+    end
+
+    # times the execution of a block and adds a field containing the duration in milliseconds
+    #
+    # @param name [String] the name of the field to add to the event
+    # @return [self] this event.
+    # @example
+    #   event.with_timer "task_ms" do
+    #     # something time consuming
+    #   end
+    def with_timer(name, &block)
+        start = Time.now
+        block.call
+        duration = Time.now - start
+        # report in ms
+        self.add_field(name, duration * 1000)
+        self
+    end
+    
+    # sends this event to honeycomb
+    #
+    # @return [self] this event.
+    def send
+      # discard if sampling rate says so
+      if @libhoney.should_drop(self.sample_rate)
+        @libhoney.send_dropped_response(self, "event dropped due to sampling")
+      end
+
+      self.send_presampled()
+    end
+
+    # sends a presampled event to honeycomb
+    #
+    # @return [self] this event.
+    def send_presampled
+      raise ArgumentError.new("No metrics added to event. Won't send empty event.")         if self.data.length == 0
+      raise ArgumentError.new("No APIHost for Honeycomb. Can't send to the Great Unknown.") if self.api_host == ""
+      raise ArgumentError.new("No WriteKey specified. Can't send event.")                   if self.writekey == ""
+      raise ArgumentError.new("No Dataset for Honeycomb. Can't send datasetless.")          if self.dataset == ""
+
+      @libhoney.send_event(self)
+      self
+    end
+  end
+end

data/lib/libhoney/response.rb

@@ -0,0 +1,16 @@
+
+module Libhoney
+  class Response
+    attr_accessor :duration, :status_code, :metadata, :error
+
+    def initialize(duration: 0,
+                   status_code: 0,
+                   metadata: nil,
+                   error: nil)
+      @duration = duration
+      @status_code = status_code
+      @metadata = metadata
+      @error = error
+    end
+  end
+end

data/lib/libhoney/transmission.rb

@@ -0,0 +1,86 @@
+require 'libhoney/response'
+
+module Libhoney
+  # @api private
+  class TransmissionClient
+    def initialize(max_batch_size: 0,
+                   send_frequency: 0,
+                   max_concurrent_batches: 0,
+                   pending_work_capacity: 0,
+                   responses: 0,
+                   block_on_send: 0,
+                   block_on_responses: 0)
+
+      @responses = responses
+      @block_on_send = block_on_send
+      @block_on_responses = block_on_responses
+      @max_batch_size = max_batch_size
+      @send_frequency = send_frequency
+      @max_concurrent_batches = max_concurrent_batches
+      @pending_work_capacity = pending_work_capacity
+
+      # 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 = []
+      @lock = Mutex.new
+    end
+    
+    def add(event)
+      begin
+        @send_queue.enq(event, !@block_on_send)
+      rescue ThreadError
+        # happens if the queue was full and block_on_send = false.
+      end
+
+      @lock.synchronize {
+        return if @threads.length > 0
+        while @threads.length < @max_concurrent_batches
+          @threads << Thread.new { self.send_loop }
+        end
+      }
+    end
+
+    def send_loop
+      # eat events until we run out
+      loop {
+        e = @send_queue.pop
+        break if e == nil
+
+        before = Time.now
+        resp = HTTP.headers('User-Agent' => "libhoney-rb/#{VERSION}",
+                            'Content-Type' => 'application/json',
+                            'X-Honeycomb-Team' => e.writekey,
+                            'X-Honeycomb-SampleRate' => e.sample_rate,
+                            'X-Event-Time' => e.timestamp.iso8601)
+               .post(URI.join(e.api_host, '/1/events/', e.dataset), :json => e.data)
+        after = Time.now
+
+        response = Response.new(:duration => after - before,
+                                :status_code => resp.status,
+                                :metadata => e.metadata)
+        begin
+          @responses.enq(response, !@block_on_responses)
+        rescue ThreadError
+          # happens if the queue was full and block_on_send = false.
+        end
+      }
+    end
+
+    def close(drain)
+      # if drain is false, clear the remaining unprocessed events from the queue
+      @send_queue.clear if drain == false
+
+      # send @threads.length number of nils so each thread will fall out of send_loop
+      @threads.length.times { @send_queue << nil }
+
+      @threads.each do |t|
+        t.join
+      end
+      @threads = []
+
+      @responses.enq(nil)
+
+      0
+    end
+  end
+end

data/lib/libhoney/version.rb

@@ -0,0 +1,3 @@
+module Libhoney
+  VERSION = "1.0.0"
+end

data/lib/libhoney.rb

@@ -0,0 +1,5 @@
+require 'libhoney/client'
+require 'libhoney/version'
+require 'libhoney/builder'
+require 'libhoney/response'
+require 'libhoney/transmission'

data/libhoney.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "libhoney/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = 'libhoney'
+  spec.version     = Libhoney::VERSION
+  spec.date        = '2016-11-07'
+
+  spec.summary     = "send data to Honeycomb"
+  spec.description = "Ruby gem for sending data to Honeycomb"
+  spec.authors     = ['The Honeycomb.io Team']
+  spec.email       = 'support@honeycomb.io'
+  spec.files       = ['lib/libhoney.rb', 'lib/libhoney/version.rb']
+  spec.homepage    = 'https://github.com/honeycombio/libhoney-rb'
+  spec.license     = 'Apache-2.0'
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  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 "yardstick", "~> 0.9"
+  spec.add_dependency "http", "~> 2.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: libhoney
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- The Honeycomb.io Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby gem for sending data to Honeycomb
+email: support@honeycomb.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example/fact.rb
+- lib/libhoney.rb
+- lib/libhoney/builder.rb
+- lib/libhoney/client.rb
+- lib/libhoney/event.rb
+- lib/libhoney/response.rb
+- lib/libhoney/transmission.rb
+- lib/libhoney/version.rb
+- libhoney.gemspec
+homepage: https://github.com/honeycombio/libhoney-rb
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: send data to Honeycomb
+test_files: []