restful_metrics 1.0.0 → 1.0.1

data/README.md

@@ -1,15 +1,85 @@
-# Restful Metrics Ruby Client #
+# Restful Metrics Ruby Client
 
-Tracks your app's custom metrics.
+Tracks your app's custom business metrics in your Ruby apps.
 
-## Status ##
+For more detailed instructions, check out our [Dev Center](http://devcenter.restful-labs.com/metrics/ruby_initialize).
 
-This gem is currently unreleased.
+## Install
 
-## Copyright ##
+```
+    gem install restful_metrics-ruby
+```
+
+## Configure
+
+### Setting your API Key
+
+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')
+```
+
+You can skip this step if you've installed the RESTful Metrics Heroku Addon.
+
+### Disable Flag
+
+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'
+```
+
+We added the optional conditional check in the above example to illustrate how the flag can be set dynamically during your application's launch.
+
+### Asynchronous Mode
+
+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
+```
+    
+## Sending Data Points
+
+### Metrics
+
+So given the following values for the attributes:
+
+Attribute                 | Value
+-------------             | -------------
+Application Identifier    | "myapp.com"
+Metric Name               | "impression"
+Value                     | 1
+Distinct User Identifier  | "fe352fe23e823668e23e7"
+
+You would transmit this data point with the following:
+
+``` ruby
+    RestfulMetrics::Client.add_metric("myapp.com", "impression", 1, "fe352fe23e823668e23e7")
+```
+
+### Compound Metrics
+
+So given the following values for the attributes:
+
+Attribute                 | Value
+-------------             | -------------
+Application Identifier    | "myapp.com"
+Compound Metric Name      | "beverage_search"
+Values                    | ["apple juice", "orange juice", "soda"]
+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")
+```
+
+## Copyright
 
 Copyright (c) 2011 Restful Labs LLC. See LICENSE for details.
 
-## Authors ##
+## Authors
 
 * [Mauricio Gomes](http://github.com/mgomes)

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/restful_metrics/client.rb

@@ -74,7 +74,13 @@ module RestfulMetrics
     
       def post(endpoint, data=nil)
         return false if disabled?
-        raise NoConnectionEstablished if @@connection.nil?
+        if @@connection.nil?
+          if ENV["RESTFUL_METRICS_API_KEY"]
+            @@connection = Connection.new(ENV["RESTFUL_METRICS_API_KEY"])
+          else
+            raise NoConnectionEstablished
+          end
+        end
         
         unless production_env?
           logger "Skipping while not in production", :info

data/spec/client_spec.rb

@@ -2,18 +2,39 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "A NON-initialized Restful Metrics client" do
   
-  it "should NOT send a metric if a connection is not initialized" do
+  it "should NOT send a metric data point" do
     lambda { 
       RestfulMetrics::Client.add_metric("foo.bar.org", "hit", 1)
     }.should raise_error(RestfulMetrics::NoConnectionEstablished)
   end
   
-  it "should NOT send a compound metric if a connection is not initialized" do
+  it "should NOT send a compound metric data point" do
     lambda { 
       RestfulMetrics::Client.add_compound_metric("foo.bar.org", "hit", [1,2,3])
     }.should raise_error(RestfulMetrics::NoConnectionEstablished)
   end
   
+  describe "in a Heroku environment" do
+    
+    before(:each) do
+      ENV["RESTFUL_METRICS_API_KEY"] = "xyz123"
+      RestfulMetrics::Connection.any_instance.stubs(:post).returns(100)
+    end
+    
+    it "should send a metric data point" do
+      rails_env "production" do
+        RestfulMetrics::Client.add_metric("foo.bar.org", "hit", 1).should be_true
+      end
+    end
+  
+    it "should send a compound metric data point" do
+      rails_env "production" do
+        RestfulMetrics::Client.add_compound_metric("foo.bar.org", "hit", [1,2,3]).should be_true
+      end
+    end
+    
+  end
+  
 end
 
 describe "A disabled Restful Metrics client" do

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ require 'action_controller/test_process'
 require 'rspec'
 require 'mocha'
 require 'restful_metrics'
+require 'delayed_job'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: restful_metrics
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Mauricio Gomes
@@ -15,257 +10,187 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 -04:00
+date: 2011-09-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+  name: yajl-ruby
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 8
-        - 1
         version: 0.8.1
-  name: yajl-ruby
+  type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+  name: rest-client
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
         version: 1.6.0
-  name: rest-client
+  type: :runtime
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: jeweler
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: jeweler
+  type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: i18n
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: i18n
+  type: :development
+  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: actionpack
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 2
-        - 3
-        - 9
         version: 2.3.9
-  name: actionpack
+  type: :development
+  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: activesupport
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 2
-        - 3
-        - 9
         version: 2.3.9
-  name: activesupport
+  type: :development
+  prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: delayed_job
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 0
-        - 0
         version: 2.0.0
-  name: delayed_job
+  type: :development
+  prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: rspec
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
         version: 2.5.0
-  name: rspec
+  type: :development
+  prerelease: false
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: mocha
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: mocha
+  type: :development
+  prerelease: false
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+  name: yajl-ruby
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 8
-        - 2
         version: 0.8.2
-  name: yajl-ruby
+  type: :runtime
+  prerelease: false
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+  name: rest-client
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
         version: 1.6.0
-  name: rest-client
+  type: :runtime
+  prerelease: false
   version_requirements: *id011
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: rack
   requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">"
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
-  name: rack
+  type: :development
+  prerelease: false
   version_requirements: *id012
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: i18n
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: i18n
+  type: :development
+  prerelease: false
   version_requirements: *id013
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: activesupport
   requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: activesupport
+  type: :development
+  prerelease: false
   version_requirements: *id014
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: delayed_job
   requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - <
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
         version: 2.1.0
-  name: delayed_job
+  type: :development
+  prerelease: false
   version_requirements: *id015
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: rspec
   requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - <
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 0
-        - 0
         version: 2.0.0
-  name: rspec
+  type: :development
+  prerelease: false
   version_requirements: *id016
-description: Ruby client for the Restful Metrics service.
-email: mgomes@geminisbs.com
+description: Ruby client for the RESTful Metrics service.
+email: mauricio@restful-labs.com
 executables: []
 
 extensions: []
@@ -275,6 +200,7 @@ extra_rdoc_files:
 - README.md
 files: 
 - LICENSE
+- README.md
 - VERSION
 - lib/delayed/backend/mock.rb
 - lib/restful_metrics.rb
@@ -283,13 +209,12 @@ files:
 - lib/restful_metrics/endpoint.rb
 - lib/restful_metrics/log_tools.rb
 - lib/restful_metrics/railtie/cookie_integration.rb
-- README.md
 - spec/client_spec.rb
 - spec/cookie_integration_spec.rb
 - spec/endpoint_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/geminisbs/restful_metrics-ruby
+homepage: http://restfulmetrics.com
 licenses: []
 
 post_install_message: 
@@ -302,7 +227,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 174319405052663915
       segments: 
       - 0
       version: "0"
@@ -311,17 +236,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Ruby client for Restful Metrics
+summary: Ruby client for RESTful Metrics
 test_files: 
 - spec/client_spec.rb
 - spec/cookie_integration_spec.rb