libhoney 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ee74ef74255d89969a6fa143e1b9f28aabf3b32
-  data.tar.gz: 5f9659817e94933e8138396315092d36196b00c4
+  metadata.gz: 26970710f84624c24124fb3610ff33d1f3869474
+  data.tar.gz: a665425df122795e8aa25599931e9950551672f3
 SHA512:
-  metadata.gz: 1ef9aba4d5ed49c28741ed995575177dc831972ea756c18392ef42e6c30a468988481543e01dacb4a58582bb280f84a968ba6e834b470b6af5ec42d79a9001ec
-  data.tar.gz: a46d2468b7f38ff6fd2c7f934ca913415ff5b4aef8670ab66d70e8e8414269483818d61c043692e000cff1ba4e5ece43fd92e6b9328fd643006419f3641da353
+  metadata.gz: 0b497556547823d888f302a2942e5a2a3fa761b729fbe70fbb516f8786c759cd680c56ba3725112395192d1bafbbfacbd57a850c8b4ddcd67d35fe1f4e94361e
+  data.tar.gz: 6051ebf88baf99c30f635ac7f9906f35d53dfbb99445e2dc362f7fe3e6b5eff189c621e601debcb2f44f8f87fa23e773de0367df24ce50088a1296469eb434b6

data/.travis.yml

@@ -1,3 +1,11 @@
 language: ruby
 rvm:
   - 2.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: vtuGhZ4wujoJKVUdg5+sW6LbwWjiRQwTtA/2YFHPv+1guJNHyLcRJLAxZ9S4AVibjMqm38Qfh6GkK8rJCgur4wvO4EJoxp3qq7xOEAt02Lvg2KKtJ7ge6cQ0f5c8sIQ8emB2U5XFu4G5PARKAdtqlNxWWDwU9WbCZWxiDd9oCiX8/b8xt08GTlk7roI3tZGtpoa1Ca3u6bdJWAilGZQSwslx3mjnnZeLGTWsDEfLffjzt1aX+F2z3W1tUv7PGBPZLqfvsSh11ZnOV7o38VFbMwmAKcTcc6bYT4eUr1EYVpncGgw+zyi1X5BwBdRDXHKCJXclqhM+2q6dPpg32lzowksXS7DT8AdmwiybG05mvw7oAZM8DNCZ5Yf98MxOFKgIE5aE1XG31La7+e5llJA5SA3MKjd24FgnX1t71K0jcmAfJiHBWMEW8QnRfvM4gdlq6hViM6Adxh1htjRVtBVIE3SXwMfBiG6iLFx6BCIyK9kTKhzFWdqz0eQJkVCvjGpv18R6BOFem+cMKNrFIUGrc4nHRHstJ26kicVD8TSd1ja5mOfjHN5NXabEpx0nKtG6eFGGNyRaxh4lUKQ175wtnYyAlyoHG8g4Ya2o1NGDOHgjOCoz9SLy0BEyCl/gormwTJI7M2aDAoHtp68Yr8/oojhWxzkXr7HPSwqysbbNaDw=
+  gem: libhoney
+  on:
+    tags: true
+    repo: honeycombio/libhoney-rb

data/CONTRIBUTORS

@@ -1,2 +1,3 @@
 Tim Spencer <tspencer@hungry.com>
-Chris Toshok <toshok@honeycomb.io>
+Chris Toshok <toshok@honeycomb.io>
+Jamie Osler <j.osler@gmail.com>

data/NOTICE

@@ -0,0 +1,13 @@
+Copyright (c) 2016-Present Honeycomb, Hound Technology, Inc. All Rights Reserved.
+
+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

@@ -1,16 +1,7 @@
-libhoney
-========
-Ruby gem for sending events to http://honeycomb.io from within your ruby code.
+# libhoney [![Build Status](https://travis-ci.org/honeycombio/libhoney-rb.svg?branch=master)](https://travis-ci.org/honeycombio/libhoney-rb) [![Gem Version](https://badge.fury.io/rb/libhoney.svg)](https://badge.fury.io/rb/libhoney)
 
-[![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/
+Ruby gem for sending events to [Honeycomb](https://honeycomb.io). (See here for more information about [using Honeycomb](https://honeycomb.io/intro/) and [its libraries](https://honeycomb.io/docs/send-data/sdks).)
 
 ## Installation
 
@@ -27,25 +18,28 @@ gem 'libhoney', :git => 'http://github.com/honeycombio/libhoney-rb.git'
 ```
 
 ## Example Usage
+
+Honeycomb can calculate all sorts of statistics, so send the values you care about and let us crunch the averages, percentiles, lower/upper bounds, cardinality -- whatever you want -- for you.
+
 ```ruby
 require 'libhoney'
 
-# create a client instance
-honey = Libhoney::Client.new(:writekey => "your writekey",
-                             :dataset => "your dataset")
+# Create a client instance
+honeycomb = Libhoney::Client.new(:writekey => "YOUR_WRITE_KEY",
+                                 :dataset => "honeycomb-ruby-example")
 
-# 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
+honeycomb.send_now({
+  duration_ms: 153.12,
+  method: "get",
+  hostname: "appserver15",
+  payload_length: 27
+})
 
-# when all done, call close
-honey.close
+# Call close to flush any pending calls to Honeycomb
+honeycomb.close
 ```
 
-You can find a more complete example demonstrating usage in `example/fact.rb`
+You can find a more complete example demonstrating usage in [`example/fact.rb`](example/fact.rb)
 
 ## Contributions
 
@@ -55,3 +49,12 @@ CONTRIBUTORS file!
 
 All contributions will be released under the Apache License 2.0.
 
+
+### Releasing a new version
+
+Travis will automatically upload tagged releases to Rubygems. To release a new
+version, run
+```
+bump patch --tag   # Or bump minor --tag, etc.
+git push --follow-tags
+```

data/example/fact.rb

@@ -13,6 +13,8 @@ def factorial(n)
   return n * factorial(n - 1)
 end
 
+# run factorial. libh_builder comes with some fields already populated
+# (namely, "version", "num_threads", and "range")
 def run_fact(low, high, libh_builder)
   for i in low..high do
     ev = libh_builder.event
@@ -27,9 +29,7 @@ def run_fact(low, high, libh_builder)
 end
 
 def read_responses(resp_queue)
-  loop do
-    resp = resp_queue.pop()
-    break if resp == nil
+  while resp = resp_queue.pop()
     puts "sending event with metadata #{resp.metadata} took #{resp.duration*1000}ms and got response code #{resp.status_code}"
   end
 end
@@ -42,11 +42,16 @@ libhoney = Libhoney::Client.new(:writekey => writekey,
 resps = libhoney.responses()
 Thread.new do
   begin
+    # attach fields to top-level instance
     libhoney.add_field("version", "3.4.5")
     libhoney.add_dynamic_field("num_threads", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
+
+    # sends an event with "version", "num_threads", and "status" fields
     libhoney.send_now({:status => "starting run"})
     run_fact(1, 20, libhoney.builder({:range => "low"}))
     run_fact(31, 40, libhoney.builder({:range => "high"}))
+
+    # sends an event with "version", "num_threads", and "status" fields
     libhoney.send_now({:status => "ending run"})
     libhoney.close(true)
   rescue Exception => e

data/lib/libhoney/event.rb

@@ -81,6 +81,7 @@ module Libhoney
       # discard if sampling rate says so
       if @libhoney.should_drop(self.sample_rate)
         @libhoney.send_dropped_response(self, "event dropped due to sampling")
+        return
       end
 
       self.send_presampled()

data/lib/libhoney/version.rb

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

data/libhoney.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   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
@@ -29,5 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 2.1"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "yardstick", "~> 0.9"
+  spec.add_development_dependency "bump", "~> 0.5"
   spec.add_dependency "http", "~> 2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - The Honeycomb.io Team
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,7 @@ files:
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
+- NOTICE
 - README.md
 - Rakefile
 - example/fact.rb