restful_metrics 1.1.0 → 1.1.1

data/README.md

@@ -1,4 +1,4 @@
-# Restful Metrics Ruby Client
+# RESTful Metrics Ruby Client
 
 Tracks your app's custom business metrics in your Ruby apps.
 
@@ -78,7 +78,7 @@ You would transmit this data point with the following:
 
 ## Copyright
 
-Copyright (c) 2011 Restful Labs LLC. See LICENSE for details.
+Copyright (c) 2011-2012 RESTful Labs LLC. See LICENSE for details.
 
 ## Authors
 

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.1

data/lib/restful_metrics/client.rb

@@ -20,7 +20,7 @@ module RestfulMetrics
         @@connection.debug = @@debug if @@connection
       end
 
-      def debug
+      def debug?
         @@debug
       end
 
@@ -78,13 +78,7 @@ module RestfulMetrics
           return false
         end
 
-        if @@connection.nil?
-          if ENV["RESTFUL_METRICS_API_KEY"]
-            @@connection = Connection.new(ENV["RESTFUL_METRICS_API_KEY"])
-          else
-            raise NoConnectionEstablished
-          end
-        end
+        raise NoConnectionEstablished if @@connection.nil?
 
         if async?
           self.delay.transmit(endpoint, data)
@@ -99,7 +93,7 @@ module RestfulMetrics
           @@connection.post(endpoint, data)
           true
         rescue
-          logger "There was an error communicating with the server"
+          logger "There was an error communicating with the server: #{$!}"
           false
         end
       end

data/lib/restful_metrics/connection.rb

@@ -1,8 +1,8 @@
 module RestfulMetrics
 
   class Connection
-    
-    include RestfulMetrics::LogTools
+
+    extend LogTools
 
     attr_accessor :debug, :async
     attr_reader :api_key, :default_options
@@ -23,7 +23,7 @@ module RestfulMetrics
     def request(method, endpoint, data=nil)
       headers = { 'User-Agent' => "Restful Metrics Ruby Client v#{VERSION}",
                   'Content-Type' => "application/json" }
-      
+
       if data.nil?
         data = @default_options
       else
@@ -31,14 +31,14 @@ module RestfulMetrics
       end
 
       if debug
-        puts "request: #{method.to_s.upcase} #{endpoint}"
-        puts "headers:"
+        logger "request: #{method.to_s.upcase} #{endpoint}"
+        logger "headers:"
         headers.each do |key, value|
-          puts "#{key}=#{value}"
+          logger "#{key}=#{value}"
         end
         if [:post, :put].include?(method)
-          puts "data:"
-          puts Yajl::Encoder.encode data
+          logger "data:"
+          logger Yajl::Encoder.encode data
         end
       end
 
@@ -48,20 +48,20 @@ module RestfulMetrics
         logger "there was an error encoding your submission: #{$!}"
         return nil
       end
-        
+
       response = send_request(method, endpoint, headers, data)
 
       if debug
         if response.nil?
-          puts "There was an error processing the response from Restful Metrics."
+          logger "There was an error processing the response from Restful Metrics."
         else
-          puts "\nresponse: #{response.code}"
-          puts "headers:"
+          logger "\nresponse: #{response.code}"
+          logger "headers:"
           response.header.each do |key, value|
-            puts "#{key}=#{value}"
+            logger "#{key}=#{value}"
           end
-          puts "body:"
-          puts response.body
+          logger "body:"
+          logger response.body
         end
       end
 
@@ -79,11 +79,11 @@ module RestfulMetrics
       content
     end
 
-    def send_request(method, endpoint, headers, data=nil)      
+    def send_request(method, endpoint, headers, data=nil)
       begin
-        response = RestClient::Request.execute(:method => :post, 
-                                               :url => endpoint, 
-                                               :payload => data, 
+        response = RestClient::Request.execute(:method => :post,
+                                               :url => endpoint,
+                                               :payload => data,
                                                :headers => headers)
       rescue => e
         logger "there was an error transmitting your entry: #{$!}"

data/restful_metrics.gemspec

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

data/spec/client_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "A NON-initialized Restful Metrics client" do
+describe "A NON-initialized RESTful Metrics client" do
 
   it "should NOT send a metric data point" do
     lambda {
@@ -21,19 +21,23 @@ describe "A NON-initialized Restful Metrics client" do
       RestfulMetrics::Connection.any_instance.stubs(:post).returns(100)
     end
 
-    it "should send a metric data point" do
-      RestfulMetrics::Client.add_metric("foo.bar.org", "hit", 1).should be_true
+    it "should NOT send a metric data point" do
+      lambda {
+        RestfulMetrics::Client.add_metric("foo.bar.org", "hit", 1).should be_true
+      }.should raise_error(RestfulMetrics::NoConnectionEstablished)
     end
 
-    it "should send a compound metric data point" do
-      RestfulMetrics::Client.add_compound_metric("foo.bar.org", "hit", [1,2,3]).should be_true
+    it "should NOT send a compound metric data point" do
+      lambda {
+        RestfulMetrics::Client.add_compound_metric("foo.bar.org", "hit", [1,2,3]).should be_true
+      }.should raise_error(RestfulMetrics::NoConnectionEstablished)
     end
 
   end
 
 end
 
-describe "A disabled Restful Metrics client" do
+describe "A disabled RESTful Metrics client" do
 
   before(:each) do
     RestfulMetrics::Client.disabled = true
@@ -55,18 +59,58 @@ describe "A disabled Restful Metrics client" do
 
 end
 
-describe "An initialized Restful Metrics client" do
+describe "An initialized RESTful Metrics client" do
 
   before(:each) do
     @connection = RestfulMetrics::Connection
-    @connection.any_instance.stubs(:post).returns(true)
     RestfulMetrics::Client.set_credentials('xyz123')
     RestfulMetrics::Client.disabled = false
     Delayed::Job.delete_all
   end
 
+  describe "in debug mode" do
+
+    class SampleRequest
+
+      def body
+        '{ "test": "success" }'
+      end
+
+      def code
+        200
+      end
+
+      def header
+        { "one" => "test", "two" => "test" }
+      end
+
+    end
+
+    before(:all) do
+      RestfulMetrics::Client.debug = true
+      RestfulMetrics::Client.debug?.should be_true
+    end
+
+    it "should send a metric to RESTful Metrics while outputting debug info" do
+      @connection.any_instance.expects(:logger).at_least_once
+      @connection.any_instance.expects(:send_request).once.returns(SampleRequest.new)
+      RestfulMetrics::Client.add_metric("foo.bar.org", "hit", 1).should == true
+    end
+
+    it "should send the compound metric to RESTful Metrics while outputting debug info" do
+      @connection.any_instance.expects(:logger).at_least_once
+      @connection.any_instance.expects(:send_request).once.returns(SampleRequest.new)
+      RestfulMetrics::Client.add_compound_metric("foo.bar.org", "hit", [1,2,3]).should be_true
+    end
+
+  end
+
   describe "initializing the client" do
 
+    before(:each) do
+      @connection.any_instance.stubs(:post).returns(true)
+    end
+
     it "should set the API key" do
       RestfulMetrics::Client.set_credentials('4ed4ef44e44ed4').should be_true
     end
@@ -80,17 +124,21 @@ describe "An initialized Restful Metrics client" do
 
   describe "adding metrics synchronously" do
 
+    before(:each) do
+      @connection.any_instance.stubs(:post).returns(true)
+    end
+
     before(:all) do
       RestfulMetrics::Client.async = false
       RestfulMetrics::Client.async?.should be_false
     end
 
-    it "should send the metric to Restful Metrics" do
+    it "should send the metric to RESTful Metrics" do
       @connection.any_instance.expects(:post).at_least_once.returns({})
       RestfulMetrics::Client.add_metric("foo.bar.org", "hit", 1).should be_true
     end
 
-    it "should send the compound metric to Restful Metrics" do
+    it "should send the compound metric to RESTful Metrics" do
       @connection.any_instance.expects(:post).at_least_once.returns({})
       RestfulMetrics::Client.add_compound_metric("foo.bar.org", "hit", [1,2,3]).should be_true
     end
@@ -99,6 +147,10 @@ describe "An initialized Restful Metrics client" do
 
   describe "adding metrics asynchronously" do
 
+    before(:each) do
+      @connection.any_instance.stubs(:post).returns(true)
+    end
+
     before(:all) do
       RestfulMetrics::Client.async = true
       RestfulMetrics::Client.async?.should be_true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_metrics
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000 Z
+date: 2012-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70354861209440 !ruby/object:Gem::Requirement
+  requirement: &70322334817280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70354861209440
+  version_requirements: *70322334817280
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70354861208320 !ruby/object:Gem::Requirement
+  requirement: &70322334816280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70354861208320
+  version_requirements: *70322334816280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70354861207620 !ruby/object:Gem::Requirement
+  requirement: &70322334831700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70354861207620
+  version_requirements: *70322334831700
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70354861206880 !ruby/object:Gem::Requirement
+  requirement: &70322334831000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.10.4
   type: :development
   prerelease: false
-  version_requirements: *70354861206880
+  version_requirements: *70322334831000
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70354861206140 !ruby/object:Gem::Requirement
+  requirement: &70322334830300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70354861206140
+  version_requirements: *70322334830300
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70354861205400 !ruby/object:Gem::Requirement
+  requirement: &70322334829500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.2.5
   type: :development
   prerelease: false
-  version_requirements: *70354861205400
+  version_requirements: *70322334829500
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70354861204600 !ruby/object:Gem::Requirement
+  requirement: &70322334828920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70354861204600
+  version_requirements: *70322334828920
 - !ruby/object:Gem::Dependency
   name: delayed_job
-  requirement: &70354861203940 !ruby/object:Gem::Requirement
+  requirement: &70322334828280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 3.0.1
   type: :development
   prerelease: false
-  version_requirements: *70354861203940
+  version_requirements: *70322334828280
 description: Ruby client for the RESTful Metrics service.
 email: mauricio@restful-labs.com
 executables: []