restful_metrics 1.1.3 → 1.1.4

data/README.md

@@ -7,7 +7,7 @@ For more detailed instructions, check out our [Dev Center](http://devcenter.rest
 ## Install
 
 ```
-    gem install restful_metrics-ruby
+  gem install restful_metrics-ruby
 ```
 
 ## Configure
@@ -17,7 +17,7 @@ For more detailed instructions, check out our [Dev Center](http://devcenter.rest
 The only step required for initialization is setting your API key. Once it's set, it's stored in memory while your Ruby program runs. You set your API key with the following command:
 
 ``` ruby
-    RestfulMetrics::Client.set_credentials('214c7da8edd333abc78712313918ffe5')
+  RestfulMetrics::Client.set_credentials('214c7da8edd333abc78712313918ffe5')
 ```
 
 You can skip this step if you've installed the RESTful Metrics Heroku Addon.
@@ -27,7 +27,7 @@ You can skip this step if you've installed the RESTful Metrics Heroku Addon.
 The client also has an optional flag that prevents the client from actually sending data points to the server. This allows you to keep your RESTful Metrics tracking code in place even in your test enviornments. You can disable the client with the following (by default the client is enabled):
 
 ``` ruby
-    RestfulMetrics::Client.disabled = true unless ENV == 'production'
+  RestfulMetrics::Client.disabled = true unless ENV == 'production'
 ```
 
 We added the optional conditional check in the above example to illustrate how the flag can be set dynamically during your application's launch.
@@ -37,9 +37,43 @@ We added the optional conditional check in the above example to illustrate how t
 The client currently has built-in support for Delayed::Job. If you enable the asynchronous flag the client will automatically queue the data point for transmission to the server at a later time. This is highly recommended for applications that are sensitive to latency.
 
 ``` ruby
-    RestfulMetrics::Client.async = true
+  RestfulMetrics::Client.async = true
 ```
-    
+
+If you use a worker library other than Delayed::Job, you can wrap all your RESTful Metrics calls. For example, if we were using Resque we might add this to an initializer:
+
+``` ruby
+  module CompoundMetric
+    @queue = :metrics
+
+    def self.perform(fqdn, name, values, distinct_id = nil)
+      RestfulMetrics::Client.add_compound_metric(fqdn, name, values, distinct_id)
+    end
+  end
+
+  module Metric
+    @queue = :metrics
+
+    def self.perform(fqdn, name, value, distinct_id = nil)
+      RestfulMetrics::Client.add_metric(fqdn, name, value, distinct_id)
+    end
+  end
+
+  def restful_metrics_add_data_point(metric_type, app, metric, value, distinct_id=nil)
+    unless RestfulMetrics::Client.disabled?
+      Resque.enqueue(metric_type, app, metric, value, distinct_id)
+    end
+  end
+```
+
+We've now separated the metrics and compound metrics into their own queue called `metrics`. To add a compound metric data point, we call:
+
+``` ruby
+    restful_metrics_add_data_point(CompoundMetric, "myapp.com", "impression", ["apple juice", "orange juice", "soda"], "fe352fe23e823668e23e7")
+```
+
+Make sure that the `async` flag is set to off. This flag only applies to the built-in Delayed::Job support.
+
 ## Sending Data Points
 
 ### Metrics
@@ -56,7 +90,7 @@ Distinct User Identifier  | "fe352fe23e823668e23e7"
 You would transmit this data point with the following:
 
 ``` ruby
-    RestfulMetrics::Client.add_metric("myapp.com", "impression", 1, "fe352fe23e823668e23e7")
+  RestfulMetrics::Client.add_metric("myapp.com", "impression", 1, "fe352fe23e823668e23e7")
 ```
 
 ### Compound Metrics
@@ -73,7 +107,7 @@ Distinct User Identifier  | "fe352fe23e823668e23e7"
 You would transmit this data point with the following:
 
 ``` ruby
-    RestfulMetrics::Client.add_compound_metric("myapp.com", "impression", ["apple juice", "orange juice", "soda"], "fe352fe23e823668e23e7")
+  RestfulMetrics::Client.add_compound_metric("myapp.com", "impression", ["apple juice", "orange juice", "soda"], "fe352fe23e823668e23e7")
 ```
 
 ## Copyright
@@ -83,3 +117,4 @@ Copyright (c) 2011-2012 RESTful Labs LLC. See LICENSE for details.
 ## Authors
 
 * [Mauricio Gomes](http://github.com/mgomes)
+* [Dan Porter](http://github.com/wolfpakz)

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.1.4

data/lib/restful_metrics/client.rb

@@ -44,29 +44,41 @@ module RestfulMetrics
         @@disabled
       end
 
-      def add_metric(fqdn, name, value, distinct_id = nil)
+      def add_metric(fqdn, name, value, distinct_id=nil, timestamp=nil)
         params = Hash.new
         params[:metric] = Hash.new
         params[:metric][:fqdn] = fqdn
         params[:metric][:name] = name
         params[:metric][:value] = value
+
         unless distinct_id.nil?
           params[:metric][:distinct_id] = distinct_id
         end
 
+        unless timestamp.nil?
+          raise InvalidTimestamp unless timestamp.respond_to?(:to_i)
+          params[:metric][:occurred_at] = timestamp.to_i
+        end
+
         post(Endpoint.metrics, params)
       end
 
-      def add_compound_metric(fqdn, name, values, distinct_id = nil)
+      def add_compound_metric(fqdn, name, values, distinct_id=nil, timestamp=nil)
         params = Hash.new
         params[:compound_metric] = Hash.new
         params[:compound_metric][:fqdn] = fqdn
         params[:compound_metric][:name] = name
         params[:compound_metric][:values] = values
+
         unless distinct_id.nil?
           params[:compound_metric][:distinct_id] = distinct_id
         end
 
+        unless timestamp.nil?
+          raise InvalidTimestamp unless timestamp.respond_to?(:to_i)
+          params[:compound_metric][:occurred_at] = timestamp.to_i
+        end
+
         post(Endpoint.compound_metrics, params)
       end
 

data/lib/restful_metrics.rb

@@ -13,16 +13,17 @@ require 'restful_metrics/endpoint'
 require 'restful_metrics/client'
 
 # Rails integration
-require 'restful_metrics/railtie/cookie_integration'  
+require 'restful_metrics/railtie/cookie_integration'
 
 module RestfulMetrics
-  
-  REALM = "http://track.restfulmetrics.com"
+
+  REALM = "https://track.restfulmetrics.com"
   VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
 
   class RestfulMetricsError < StandardError; end
   class InsufficentArguments < RestfulMetricsError; end
   class InvalidAPIKey < RestfulMetricsError; end
   class NoConnectionEstablished < RestfulMetricsError; end
-  
+  class InvalidTimestamp < RestfulMetricsError; end
+
 end

data/restful_metrics.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.description = %q{Ruby client for the RESTful Metrics service.}
   s.homepage = %q{http://github.com/restful-labs/resetful_metrics-ruby}
   s.version = File.read(File.join(File.dirname(__FILE__), 'VERSION'))
-  s.authors = ["Mauricio Gomes"]
+  s.authors = ["Mauricio Gomes", "Dan Porter"]
   s.email = "mauricio@restful-labs.com"
 
   s.add_dependency "yajl-ruby", ">= 0.8.1"

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: restful_metrics
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
   prerelease: 
 platform: ruby
 authors:
 - Mauricio Gomes
+- Dan Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby