cube-ruby 0.0.1 → 0.0.2

data/README.md

@@ -1,17 +1,31 @@
 # cube-ruby
 
 A Cube client for Ruby (http://square.github.com/cube). Heavily based on
-[this statsd ruby client](https://github.com/github/statsd-ruby).
+[this statsd ruby client][sdc].
 
-MIT licensed. See https://github.com/codykrieger/cube-ruby/blob/master/LICENSE
+MIT licensed. See [the LICENSE file][license] for more details.
 for more details.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Since Cube is under constant development, it's best if you specify a particular
+version of cube-ruby in your `Gemfile`. That way, you can ensure your Ruby
+application and your Cube instance will be compatible with each other.
+
+Here's a version compatibility table:
+
+    Cube   | cube-ruby
+    --------------------
+    0.2.0  | 0.0.1
+    0.2.1  | 0.0.2 (master)
+
+Add this line to your application's `Gemfile`:
 
     gem 'cube-ruby', require: "cube"
 
+    # or specify a particular version:
+    gem 'cube-ruby', '0.0.2', require: "cube"
+
 And then execute:
 
     $ bundle
@@ -35,6 +49,9 @@ $cube = Cube::Client.new 'cube.example.org', 2280
 ### Send Cube some metrics!
 
 ```ruby
+# send a new "foo" event to cube
+$cube.send "foo"
+
 # send a new event to cube that looks like this:
 # { type: "request", time: [now], data: { value: "somevalue" } }
 $cube.send "request", value: "somevalue"
@@ -47,6 +64,9 @@ event_id = 42
 $cube.send "request", DateTime.now, event_id, duration_ms: 234
 ```
 
+Yes, the method is called `send`. You can still call `Object#send` on
+`Cube::Client` objects by using the `__send__` method, [per the Ruby docs][rd].
+
 ## Testing
 
 Run the specs with `rake`.
@@ -60,3 +80,8 @@ To include real UDP socket testing in the specs, run `LIVE=true rake`.
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[sdc]: https://github.com/github/statsd-ruby
+[license]: https://github.com/codykrieger/cube-ruby/blob/master/LICENSE
+[rd]: http://ruby-doc.org/core-1.9.3/Object.html#method-i-send
+

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 (https://square.github.com/cube).}
+  gem.summary       = %q{A Cube client for Ruby (https://square.github.com/cube).}
   gem.homepage      = "https://github.com/codykrieger/cube-ruby"
 
   gem.files         = `git ls-files`.split($\)

data/lib/cube.rb

@@ -34,7 +34,6 @@ module Cube
     # cube.send "request", DateTime.now, duration_ms: 234
     # ```
     def send(type, *args)
-      default_time = DateTime.now
       time = nil
       id = nil
       data = nil
@@ -52,7 +51,7 @@ module Cube
       end
 
       # Send off our parsed arguments to be further massaged and socketized.
-      actual_send type, (time || default_time), id, data
+      actual_send type, time, id, data
     end
 
     private
@@ -67,9 +66,9 @@ module Cube
 
       # Start constructing the message to be sent to Cube over UDP.
       message = {
-        type: "#{prefix}#{type}",
-        time: time.iso8601
+        type: "#{prefix}#{type}"
       }
+      message[:time] = time.iso8601 unless time.nil?
       message[:id] = id unless id.nil?
       message[:data] = data unless data.nil?
 

data/lib/cube/version.rb

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

data/spec/cube_spec.rb

@@ -32,13 +32,20 @@ describe Cube::Client do
   describe "#send" do
     it "should format the message according to the Cube spec" do
       type = "request"
-      time = DateTime.now
-      data = { duration_ms: 234 }
-      @cube.send type, time, data
+      @cube.send type
       recv = JSON.parse @cube.socket.recv.first
       recv["type"].must_equal "request"
-      recv["time"].must_equal time.iso8601
-      recv["data"].must_equal({ "duration_ms" => 234 })
+    end
+
+    describe "with a time" do
+      it "should format the message according to the Cube spec" do
+        type = "request"
+        time = DateTime.now
+        @cube.send type, time
+        recv = JSON.parse @cube.socket.recv.first
+        recv["type"].must_equal "request"
+        recv["time"].must_equal time.iso8601
+      end
     end
 
     describe "with an id" do
@@ -55,6 +62,21 @@ describe Cube::Client do
         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"
+        time = DateTime.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
   end
 
   describe "with namespace" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cube-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2012-05-01 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 (https://square.github.com/cube).
 email:
 - cody@codykrieger.com
 executables: []
@@ -67,7 +67,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 (https://square.github.com/cube).
 test_files:
 - spec/cube_spec.rb
 - spec/helper.rb