cube-ruby 0.0.2 → 0.0.3

data/README.md

@@ -17,7 +17,7 @@ Here's a version compatibility table:
     Cube   | cube-ruby
     --------------------
     0.2.0  | 0.0.1
-    0.2.1  | 0.0.2 (master)
+    0.2.1+ | 0.0.2 (master)
 
 Add this line to your application's `Gemfile`:
 
@@ -53,7 +53,7 @@ $cube = Cube::Client.new 'cube.example.org', 2280
 $cube.send "foo"
 
 # send a new event to cube that looks like this:
-# { type: "request", time: [now], data: { value: "somevalue" } }
+# { type: "request", data: { value: "somevalue" } }
 $cube.send "request", value: "somevalue"
 
 # optionally specify a specific date/time (two days ago)

data/cube-ruby.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/cube/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Cody Krieger"]
   gem.email         = ["cody@codykrieger.com"]
-  gem.description   = %q{A Cube client for Ruby (https://square.github.com/cube).}
-  gem.summary       = %q{A Cube client for Ruby (https://square.github.com/cube).}
+  gem.description   = %q{A Cube client for Ruby (http://square.github.com/cube).}
+  gem.summary       = %q{A Cube client for Ruby (http://square.github.com/cube).}
   gem.homepage      = "https://github.com/codykrieger/cube-ruby"
 
   gem.files         = `git ls-files`.split($\)

data/lib/cube.rb

@@ -22,17 +22,18 @@ module Cube
     end
 
     # Set 'er up with a host and port, defaults to `localhost:1180`.
+    #
+    # @param [String] The hostname to send metrics to.
+    # @param [Integer] The UDP port to send metrics to.
     def initialize(host="localhost", port=1180)
       @host, @port = host, port
     end
 
-    # The primary endpoint for sending metrics to Cube - call like this:
+    # The primary endpoint for sending metrics to Cube.
     #
-    # ```ruby
-    # cube = Cube::Client.new
-    # cube.send "request", value: "somevalue"
-    # cube.send "request", DateTime.now, duration_ms: 234
-    # ```
+    # @param [String] The desired name of the new Cube event.
+    # @param [Array] A splat that takes an optional DateTime, an event id
+    #   (typically an integer, but can be any object), and a Hash of data.
     def send(type, *args)
       time = nil
       id = nil
@@ -41,13 +42,14 @@ module Cube
       until args.empty?
         arg = args.shift
 
-        if arg.is_a? DateTime
-          time ||= arg
-        elsif arg.is_a? Hash
-          data ||= arg
-        else
-          id ||= arg
-        end
+        case arg
+          when DateTime, Time
+            time ||= arg
+          when Hash
+            data ||= arg
+          else
+            id ||= arg
+          end
       end
 
       # Send off our parsed arguments to be further massaged and socketized.
@@ -58,6 +60,12 @@ module Cube
 
     # Actually send the given data to a socket, and potentially log it along
     # the way.
+    #
+    # @param [String] The desired name of the new Cube event.
+    # @param [DateTime] Optional. A specific time when the Cube event occurred.
+    # @param [Object] Optional. Typically an integer, but can be any object.
+    # @param [Hash] Optional. Anything in this hash will be stored in the
+    #   `data` subdocument of the Cube event.
     def actual_send(type, time, id, data)
       # Namespace support!
       prefix = "#{@namespace}_" unless @namespace.nil?

data/lib/cube/version.rb

@@ -1,3 +1,3 @@
 module Cube
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/realtest.rb

@@ -0,0 +1,6 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'cube'
+
+cube = Cube::Client.new
+cube.send "testorz"
+

data/spec/cube_spec.rb

@@ -1,5 +1,6 @@
 require 'helper'
 require 'date'
+require 'time'
 require 'json'
 
 # a few things yanked verbatim from here: https://github.com/github/statsd-ruby/blob/master/spec/statsd_spec.rb
@@ -37,7 +38,7 @@ describe Cube::Client do
       recv["type"].must_equal "request"
     end
 
-    describe "with a time" do
+    describe "with a DateTime" do
       it "should format the message according to the Cube spec" do
         type = "request"
         time = DateTime.now
@@ -63,6 +64,21 @@ describe Cube::Client do
       end
     end
 
+    describe "with Time" do
+      it "should format the message according to the Cube spec" do
+        type = "request"
+        time = Time.now
+        id = 42
+        data = { duration_ms: 234 }
+        @cube.send type, time, id, data
+        recv = JSON.parse @cube.socket.recv.first
+        recv["type"].must_equal "request"
+        recv["time"].must_equal time.iso8601
+        recv["id"].must_equal 42
+        recv["data"].must_equal({ "duration_ms" => 234 })
+      end
+    end
+
     describe "with data" do
       it "should format the message according to the Cube spec" do
         type = "request"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cube-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Cube client for Ruby (https://square.github.com/cube).
+description: A Cube client for Ruby (http://square.github.com/cube).
 email:
 - cody@codykrieger.com
 executables: []
@@ -42,6 +42,7 @@ files:
 - cube-ruby.gemspec
 - lib/cube.rb
 - lib/cube/version.rb
+- realtest.rb
 - spec/cube_spec.rb
 - spec/helper.rb
 homepage: https://github.com/codykrieger/cube-ruby
@@ -67,7 +68,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A Cube client for Ruby (https://square.github.com/cube).
+summary: A Cube client for Ruby (http://square.github.com/cube).
 test_files:
 - spec/cube_spec.rb
 - spec/helper.rb