batsd 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Benjamin Hathaway
+
+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,4 @@
+batsd-ruby
+==========
+
+A ruby client for batsd.

data/batsd.gemspec

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require "batsd/version"
+
+Gem::Specification.new do |s|
+    s.name          = "batsd"
+
+    s.version       = Batsd::VERSION
+
+    s.homepage      = "https://github.com/hathaway/batsd-client"
+    s.authors       = ["Ben Hathaway"]
+    s.email         = ["ben@hathaway.cc"]
+
+    s.summary       = "Batsd Client"
+    s.description   = "A Batsd client for Ruby. Provides an interface for querying data in a batsd server."
+
+    s.files         = `git ls-files`.split("\n")
+end

data/lib/batsd.rb

@@ -0,0 +1,224 @@
+require 'timeout'
+require 'json'
+require 'socket'
+
+##
+# A batsd client for querying data from a batsd server.
+class Batsd
+
+	##
+	# The default option values.
+	DEFAULTS = {
+		:host => "127.0.0.1",
+		:port => 8127,
+		:timeout => 2000,
+		:max_attempts => 2
+	}
+
+	##
+	# The hostname of the batsd server.
+	def host
+      	@options[:host]
+    end
+
+    ##
+    # The port the batsd server is running on.
+    def port
+      	@options[:port]
+    end
+
+    ##
+    # The timeout in milliseconds to use for the TCP connection.
+    def timeout
+      	@options[:timeout]
+    end
+
+    ##
+    # The maxiumum number of attempts to make when querying for data. 
+    # If an error is encountered, it will try this many total times before throwing an exception.
+    def max_attempts
+    	@options[:max_attempts]
+    end
+
+    attr_accessor :remote
+
+    def initialize(options = {})
+		@options = _parse_options(options)
+		connect!
+    end
+
+    ##
+    # Send the 'ping' command to the server.
+	#
+	# @return [String] The response received from the server.
+    def ping
+        send_command("ping")
+    end
+
+    # Queries for the available keys in the batsd server.
+	#
+	# @return [Array] An array of string keys.
+    def available
+        keys = send_command("available")
+        keys.collect do |k|
+            if k.match /^timer/
+                ["mean", "min", "max", "upper_90", "stddev", "count"].collect{|a| "#{k}:#{a}"}
+            else
+                k
+            end
+        end.flatten
+    end
+
+    ##
+    # Get the stats for a given <code>metric_name</code> that's contained in the available
+    # set of datapoints within the range of <code>start_timestamp</code> to
+    # <code>end_timestamp</code>
+	#
+	# @param [String] metric_name
+	# 	The key for the metric you are querying for.
+	#
+	# @param [Time] start_timestamp
+	# 	The start of the time range of the query.
+	#
+	# @param [Time] end_timestamp
+	# 	The end of the time range of the query. Defaults to the current time.
+	#
+	# @param [Integer] attempts
+	# 	The number of attempts that have been made for this query. Defaults to 0.
+	#
+	# @return [Array] An array of hashes. Each hash contains the <code>:timestamp</code>
+	# 	and <code>:value</code> of the data point.
+    def stats(metric_name, start_timestamp, end_timestamp=Time.now, attempt=0)
+        results = []
+        values = send_command("values #{metric_name} #{start_timestamp.to_i} #{end_timestamp.to_i}")
+        if values[metric_name].nil?
+            if attempt < max_attempts
+                return values(metric_name, start_timestamp, end_timestamp, attempt+1)
+            else
+                raise InvalidValuesError
+            end
+        end
+        results = values[metric_name].collect{|v| { timestamp: Time.at(v["timestamp"].to_i), value: v["value"].to_f }  }
+        results
+    end
+
+    ##
+    # Get only the values of the stats for a given <code>metric_name</code> 
+    # that's contained in the available set of datapoints within the range 
+    # of <code>start_timestamp</code> to <code>end_timestamp</code>
+	#
+	# @param [String] metric_name
+	# 	The key for the metric you are querying for.
+	#
+	# @param [Time] start_timestamp
+	# 	The start of the time range of the query.
+	#
+	# @param [Time] end_timestamp
+	# 	The end of the time range of the query. Defaults to the current time.
+	#
+	# @return [Array] An array of floating point numbers.
+    def values(metric_name, start_timestamp, end_timestamp=Time.now)
+    	stats(metric_name, start_timestamp, end_timestamp).map{|s| s[:value]}
+    end
+
+    ##
+    # Get only the timestamps of the stats for a given <code>metric_name</code> 
+    # that's contained in the available set of datapoints within the range 
+    # of <code>start_timestamp</code> to <code>end_timestamp</code>
+	#
+	# @param [String] metric_name
+	# 	The key for the metric you are querying for.
+	#
+	# @param [Time] start_timestamp
+	# 	The start of the time range of the query.
+	#
+	# @param [Time] end_timestamp
+	# 	The end of the time range of the query. Defaults to the current time.
+	#
+	# @return [Array] An array of Time objects.
+    def timestamps(metric_name, start_timestamp, end_timestamp=Time.now)
+    	stats(metric_name, start_timestamp, end_timestamp).map{|s| s[:timestamp]}
+    end
+   
+
+    protected
+
+    ##
+    # Parse the options provided in the constructor. Use the defaults for
+    # any options not provided.
+    def _parse_options(options)
+		defaults = DEFAULTS.dup
+		options = options.dup
+
+		defaults.keys.each do |key|
+			options[key] ||= defaults[key]
+		end
+
+		options
+    end
+
+    private
+
+    	##
+    	# Connect to the remote batsd server over TCP.
+		def connect!
+			Timeout::timeout(5) do
+				self.remote = TCPSocket.new(host, port)
+			end
+			rescue Timeout::Error => e
+				raise ConnectionTimeoutError
+			rescue
+				raise CannotConnectError
+		end
+
+		##
+		# Disconnect from the remote batsd server.
+		def disconnect
+			self.remote.close
+		end
+
+		##
+		# Reconnect to the batsd server.
+		def reconnect!
+			disconnect
+			connect!
+		end
+
+		##
+		# Send a command to the remote and attempt to parse the response as JSON
+		#
+		# @param [String] command
+		# 	The command to send to the server.
+		#
+		# @return [Array, String] The response received from the server. Unless it is 
+		# 	the ping command, the JSON response is parsed into an array.
+        def send_command(command, attempt=0)
+            Timeout::timeout(timeout.to_f / 1000.0) do
+                connect! unless self.remote
+                self.remote.puts command
+                @response = self.remote.gets
+                unless command == "ping"
+                    results = JSON.parse(@response)
+                else
+                    results = @response.delete("\n")
+                end
+                results
+            end
+            rescue TimeoutError => e
+                if attempt < max_attempts 
+                    send_command(command, attempt+1)
+                else
+                    raise CommandTimeoutError
+                end
+            rescue Exception => e
+                if attempt < max_attempts 
+                    send_command(command, attempt+1)
+                else
+                    self.remote = nil
+                    raise CommandError
+                end
+        end
+end
+
+require 'batsd/version'
+require 'batsd/errors'

data/lib/batsd/errors.rb

@@ -0,0 +1,41 @@
+class Batsd
+    ##
+    # Base error for all batsd errors.
+    class BaseError < RuntimeError
+    end
+
+    ##
+    # Base error for connection related errors.
+    class BaseConnectionError < BaseError
+    end
+
+    ##
+    # Raised when connection to a batsd server cannot be made.
+    class CannotConnectError < BaseConnectionError
+    end
+
+    ##
+    # Raised when a new connection times out
+    class ConnectionTimeoutError < BaseConnectionError
+    end
+
+    ##
+    # Base error for command related errors.
+    class BaseCommandError < BaseError
+    end
+
+    ##
+    # Raised when a command could not be run
+    class CommandError < BaseCommandError
+    end
+
+    ##
+    # Raised when a command times out
+    class CommandTimeoutError < BaseCommandError
+    end
+
+    ##
+    # Raised when the values returned weren't the same as what was asked for
+    class InvalidValuesError < BaseError
+    end
+end

data/lib/batsd/version.rb

@@ -0,0 +1,3 @@
+class Batsd
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: batsd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Hathaway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-08 00:00:00.000000000 Z
+dependencies: []
+description: A Batsd client for Ruby. Provides an interface for querying data in a
+  batsd server.
+email:
+- ben@hathaway.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- batsd.gemspec
+- lib/batsd.rb
+- lib/batsd/errors.rb
+- lib/batsd/version.rb
+homepage: https://github.com/hathaway/batsd-client
+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.11
+signing_key: 
+specification_version: 3
+summary: Batsd Client
+test_files: []