batsd 1.0.0 → 1.0.1

data/README.md

@@ -1,4 +1,52 @@
 batsd-ruby
 ==========
 
-A ruby client for batsd.
+A Ruby client for [batsd](https://github.com/noahhl/batsd), a ruby-based alternative to statsd for aggregating and storing statistics.
+
+# Installation
+
+A simple gem installation.
+
+	gem install batsd
+
+Or you can include it in your Gemfile:
+
+	gem "batsd"
+
+# Getting Started
+
+You can connect to Batsd by instantiating the Batsd class:
+
+	client = Batsd.new
+
+This assumes Batsd was started with a default configuration, and it listening on `localhost`, port `8127`. If you need to connect to a remote server or a different port, pass in the appropriate options:
+
+	client = Batsd.new(:host => "10.0.0.1", :port => 8127)
+
+The options and defaults are:
+	
+	:host => "127.0.0.1"
+	:port => 8127
+	:timeout => 2000 #milliseconds
+	:max_attempts => 2
+
+Now you can grab the list of available keys:
+
+	keys = client.available
+
+To pull the stats for a key:
+
+	start_timestamp = Time.now - (60*60) # 1 hour ago
+	end_timestamp = Time.now
+	stats = client.stats("metric_name", start_timestamp, end_timestamp)
+
+Each stat is returned as a hash with a `:timestamp` and `:value`. To pull only the timestamps or values for a range:
+
+	start_timestamp = Time.now - (60*60) # 1 hour ago
+	end_timestamp = Time.now
+	values = client.values("metric_name", start_timestamp, end_timestamp)
+	timestamps = client.timestamps("metric_name", start_timestamp, end_timestamp)
+
+# Contributing
+
+[Fork the project](https://github.com/hathaway/batsd-client) and send pull requests.

data/lib/batsd.rb

@@ -98,7 +98,7 @@ class Batsd
                 raise InvalidValuesError
             end
         end
-        results = values[metric_name].collect{|v| { timestamp: Time.at(v["timestamp"].to_i), value: v["value"].to_f }  }
+        results = values[metric_name].collect{|v| { :timestamp => Time.at(v["timestamp"].to_i), :value => v["value"].to_f }  }
         results
     end
 

data/lib/batsd/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batsd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies: []
 description: A Batsd client for Ruby. Provides an interface for querying data in a
   batsd server.