cube-ruby 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cube-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Cody Krieger
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# 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).
+
+MIT licensed. See https://github.com/codykrieger/cube-ruby/blob/master/LICENSE
+for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cube-ruby', require: "cube"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cube-ruby
+
+## Usage
+
+### Set up a global Cube client
+
+```ruby
+# use default hostname and port of localhost:1180
+$cube = Cube::Client.new
+
+# use custom hostname and port
+$cube = Cube::Client.new 'cube.example.org', 2280
+```
+
+### Send Cube some metrics!
+
+```ruby
+# send a new event to cube that looks like this:
+# { type: "request", time: [now], data: { value: "somevalue" } }
+$cube.send "request", value: "somevalue"
+
+# optionally specify a specific date/time (two days ago)
+$cube.send "request", DateTime.now - 2, value: "othervalue"
+
+# specify an event id (https://github.com/square/cube/wiki/Events)
+event_id = 42
+$cube.send "request", DateTime.now, event_id, duration_ms: 234
+```
+
+## Testing
+
+Run the specs with `rake`.
+
+To include real UDP socket testing in the specs, run `LIVE=true rake`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+task default: :spec
+

data/cube-ruby.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-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.homepage      = "https://github.com/codykrieger/cube-ruby"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cube-ruby"
+  gem.require_paths = ["lib"]
+  gem.version       = Cube::VERSION
+
+  gem.add_development_dependency "minitest"
+end

data/lib/cube.rb

@@ -0,0 +1,89 @@
+require 'cube/version'
+
+module Cube
+  require 'date'
+  # We'll be sending data to Cube over a UDP socket.
+  require 'socket'
+  # Cube requires data to be in JSON format.
+  require 'json'
+
+  class Client
+    # A namespace to prepend to all Cube calls.
+    attr_accessor :namespace
+
+    # We'll use this to eliminate any unwanted/disallowed characters from our
+    # event type later on.
+    RESERVED_CHARS_REGEX = /[^\w\d]/
+
+    class << self
+      # Set to any logger instance that responds to #debug and #error (like the
+      # Rails or stdlib logger) to enable metric logging.
+      attr_accessor :logger
+    end
+
+    # Set 'er up with a host and port, defaults to `localhost:1180`.
+    def initialize(host="localhost", port=1180)
+      @host, @port = host, port
+    end
+
+    # The primary endpoint for sending metrics to Cube - call like this:
+    #
+    # ```ruby
+    # cube = Cube::Client.new
+    # cube.send "request", value: "somevalue"
+    # cube.send "request", DateTime.now, duration_ms: 234
+    # ```
+    def send(type, *args)
+      default_time = DateTime.now
+      time = nil
+      id = nil
+      data = nil
+
+      until args.empty?
+        arg = args.shift
+
+        if arg.is_a? DateTime
+          time ||= arg
+        elsif arg.is_a? Hash
+          data ||= arg
+        else
+          id ||= arg
+        end
+      end
+
+      # Send off our parsed arguments to be further massaged and socketized.
+      actual_send type, (time || default_time), id, data
+    end
+
+    private
+
+    # Actually send the given data to a socket, and potentially log it along
+    # the way.
+    def actual_send(type, time, id, data)
+      # Namespace support!
+      prefix = "#{@namespace}_" unless @namespace.nil?
+      # Get rid of any unwanted characters, and replace each of them with an _.
+      type = type.to_s.gsub RESERVED_CHARS_REGEX, '_'
+
+      # Start constructing the message to be sent to Cube over UDP.
+      message = {
+        type: "#{prefix}#{type}",
+        time: time.iso8601
+      }
+      message[:id] = id unless id.nil?
+      message[:data] = data unless data.nil?
+
+      # JSONify it, log it, and send it off.
+      message_str = message.to_json
+      self.class.logger.debug { "Cube: #{message_str}" } if self.class.logger
+
+      socket.send message_str, 0, @host, @port
+    rescue => err
+      self.class.logger.error { "Cube: #{err.class} #{err}" } if self.class.logger
+    end
+
+    # Helper for getting the socket. `@socket` can be set to a mock object to
+    # test without needing an actual UDP socket.
+    def socket ; @socket ||= UDPSocket.new ; end
+  end
+end

data/lib/cube/version.rb

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

data/spec/cube_spec.rb

@@ -0,0 +1,111 @@
+require 'helper'
+require 'date'
+require 'json'
+
+# a few things yanked verbatim from here: https://github.com/github/statsd-ruby/blob/master/spec/statsd_spec.rb
+# license: https://github.com/github/statsd-ruby/blob/master/LICENSE.txt
+
+describe Cube::Client do
+  before do
+    @cube = Cube::Client.new "cube.example.org", 1185
+    class << @cube
+      attr_reader :host, :port
+      def socket ; @socket ||= FakeUDPSocket.new ; end
+    end
+  end
+
+  after { @cube.socket.clear }
+
+  describe "#initialize" do
+    it "should set the host and port" do
+      @cube.host.must_equal "cube.example.org"
+      @cube.port.must_equal 1185
+    end
+
+    it "should default the host and port to localhost:1180" do
+      cube = Cube::Client.new
+      cube.instance_variable_get('@host').must_equal 'localhost'
+      cube.instance_variable_get('@port').must_equal 1180
+    end
+  end
+
+  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
+      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 an id" 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
+    before { @cube.namespace = 'someservice' }
+
+    it "should add namespace to send" do
+      @cube.send "request"
+      recv = JSON.parse @cube.socket.recv.first
+      recv["type"].must_equal 'someservice_request'
+    end
+  end
+
+  describe "with logging" do
+    require 'stringio'
+    before { Cube::Client.logger = Logger.new(@log = StringIO.new) }
+
+    it "should write to the log in debug" do
+      Cube::Client.logger.level = Logger::DEBUG
+
+      @cube.send "request"
+
+      recv = @cube.socket.recv.first
+      @log.string.must_match "Cube: #{recv}"
+    end
+
+    it "should not write to the log unless debug" do
+      Cube::Client.logger.level = Logger::INFO
+
+      @cube.send "request"
+
+      recv = @cube.socket.recv.first
+      @log.string.must_be_empty
+    end
+  end
+end
+
+describe Cube::Client do
+  describe "with a real UDP socket" do
+    it "should actually send stuff over the socket" do
+      socket = UDPSocket.new
+      host, port = 'localhost', 12345
+      socket.bind host, port
+
+      time = DateTime.now
+      cube = Cube::Client.new host, port
+      cube.send "request", time
+
+      recv = JSON.parse socket.recvfrom(64).first
+      recv["type"].must_equal "request"
+      recv["time"].must_equal time.iso8601
+    end
+  end
+end if ENV['LIVE']
+

data/spec/helper.rb

@@ -0,0 +1,37 @@
+require 'minitest/autorun'
+
+# yanked almost verbatim from here: https://github.com/github/statsd-ruby/blob/master/spec/helper.rb
+# license: https://github.com/github/statsd-ruby/blob/master/LICENSE.txt
+
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'cube'
+require 'logger'
+
+class FakeUDPSocket
+  def initialize
+    @buffer = []
+  end
+
+  def send(message, *args)
+    @buffer.push [message]
+  end
+
+  def recv
+    res = @buffer.shift
+  end
+
+  def clear
+    @buffer = []
+  end
+
+  def to_s
+    inspect
+  end
+
+  def inspect
+    "<FakeUDPSocket: #{@buffer.inspect}>"
+  end
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: cube-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cody Krieger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Cube client for Ruby (https://square.github.com/cube)
+email:
+- cody@codykrieger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cube-ruby.gemspec
+- lib/cube.rb
+- lib/cube/version.rb
+- spec/cube_spec.rb
+- spec/helper.rb
+homepage: https://github.com/codykrieger/cube-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Cube client for Ruby (https://square.github.com/cube)
+test_files:
+- spec/cube_spec.rb
+- spec/helper.rb