librato-metrics 0.4.3 → 0.5.0.pre1

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+require 'pry'
 require 'rspec'
 require 'rspec/mocks/standalone'
 
@@ -19,10 +20,11 @@ RSpec.configure do |config|
 
   # purge all metrics from test account
   def delete_all_metrics
-    connection = Librato::Metrics.connection
+    connection = Librato::Metrics.client.connection
     Librato::Metrics.list.each do |metric|
       #puts "deleting #{metric['name']}..."
-      connection.delete(:path => "v1/metrics/#{metric['name']}", :expects => 204)
+      # expects 204
+      connection.delete("metrics/#{metric['name']}")
     end
   end
 

data/spec/unit/metrics/client_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+module Librato
+  module Metrics
+
+    describe Client do
+
+      describe "#agent_identifier" do
+        context "when given a single string argument" do
+          it "should set agent_identifier" do
+            subject.agent_identifier 'mycollector/0.1 (dev_id:foo)'
+            subject.agent_identifier.should == 'mycollector/0.1 (dev_id:foo)'
+          end
+        end
+
+        context "when given three arguments" do
+          it "should compose an agent string" do
+            subject.agent_identifier('test_app', '0.5', 'foobar')
+            subject.agent_identifier.should == 'test_app/0.5 (dev_id:foobar)'
+          end
+
+          context "when given an empty string" do
+            it "should set to empty" do
+              subject.agent_identifier ''
+              subject.agent_identifier.should == ''
+            end
+          end
+        end
+
+        context "when given two arguments" do
+          it "should raise error" do
+            lambda { subject.agent_identifier('test_app', '0.5') }.should raise_error(ArgumentError)
+          end
+        end
+      end
+
+      describe "#api_endpoint" do
+        it "should default to metrics" do
+          subject.api_endpoint.should == 'https://metrics-api.librato.com'
+        end
+      end
+
+      describe "#api_endpoint=" do
+        it "should set api_endpoint" do
+          subject.api_endpoint = 'http://test.com/'
+          subject.api_endpoint.should == 'http://test.com/'
+        end
+
+        # TODO:
+        # it "should ensure trailing slash"
+        # it "should ensure real URI"
+      end
+
+      describe "#authenticate" do
+        context "when given two arguments" do
+          it "should store them as email and api_key" do
+            subject.authenticate 'test@librato.com', 'api_key'
+            subject.email.should == 'test@librato.com'
+            subject.api_key.should == 'api_key'
+          end
+        end
+      end
+
+      describe "#connection" do
+        it "should raise exception without authentication" do
+          subject.flush_authentication
+          lambda{ subject.connection }.should raise_error(Librato::Metrics::CredentialsMissing)
+        end
+      end
+
+      describe "#new_queue" do
+        it "should return a new queue with client set" do
+          queue = subject.new_queue
+          queue.client.should be subject
+        end
+      end
+
+      describe "#persistence" do
+        it "should default to direct" do
+          subject.send(:flush_persistence)
+          subject.persistence.should == :direct
+        end
+
+        it "should allow configuration of persistence method" do
+          subject.persistence = :fake
+          subject.persistence.should == :fake
+        end
+      end
+
+      describe "#submit" do
+        it "should persist metrics immediately" do
+          subject.authenticate 'me@librato.com', 'foo'
+          subject.persistence = :test
+          subject.submit(:foo => 123).should eql true
+          subject.persister.persisted.should eql({:gauges => [{:name => 'foo', :value => 123}]})
+        end
+
+        it "should tolerate muliple metrics" do
+          subject.authenticate 'me@librato.com', 'foo'
+          subject.persistence = :test
+          lambda{ subject.submit :foo => 123, :bar => 456 }.should_not raise_error
+          expected = {:gauges => [{:name => 'foo', :value => 123}, {:name => 'bar', :value => 456}]}
+          subject.persister.persisted.should eql expected
+        end
+      end
+
+    end
+
+  end
+end

data/spec/unit/metrics/connection_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+module Librato
+  module Metrics
+
+    describe Connection do
+      
+      describe "network operations" do
+        context "when missing client" do
+          it "should raise exception" do
+            lambda { subject.get 'metrics' }#.should raise(NoClientProvided)
+          end
+        end
+      end
+      
+      describe "#api_endpoint" do
+        context "when not provided" do
+          it "should be default" do
+            subject.api_endpoint.should == 'https://metrics-api.librato.com'
+          end
+        end
+        
+        context "when provided" do
+          it "should be respected" do
+            connection = Connection.new(:api_endpoint => 'http://test.com/')
+            connection.api_endpoint.should == 'http://test.com/'
+          end
+        end
+      end  
+
+      describe "#user_agent" do
+        context "without an agent_identifier" do
+          it "should render standard string" do
+            connection = Connection.new(:client => Client.new)
+            connection.user_agent.should start_with('librato-metrics')
+          end
+        end
+
+        context "with an agent_identifier" do
+          it "should render agent_identifier first" do
+            client = Client.new
+            client.agent_identifier('foo', '0.5', 'bar')
+            connection = Connection.new(:client => client)
+            connection.user_agent.should start_with('foo/0.5')
+          end
+        end
+        
+        # TODO: verify user agent is being sent with rackup test
+      end
+      
+      
+    end
+    
+  end
+end

data/spec/unit/metrics/queue_spec.rb

@@ -7,7 +7,24 @@ module Librato
 
       before(:all) do
         @time = Time.now.to_i
-        Librato::Metrics::Queue.stub(:epoch_time).and_return(@time)
+        Queue.stub(:epoch_time).and_return(@time)
+      end
+
+      describe "initialization" do
+        context "with specified client" do
+          it "should set to client" do
+            barney = Client
+            queue = Queue.new(:client => barney)
+            queue.client.should be barney
+          end
+        end
+
+        context "without specified client" do
+          it "should use Librato::Metrics client" do
+            queue = Queue.new
+            queue.client.should be Librato::Metrics.client
+          end
+        end
       end
 
       describe "#add" do
@@ -115,7 +132,6 @@ module Librato
           Librato::Metrics.authenticate 'me@librato.com', 'foo'
           Librato::Metrics.persistence = :test
         end
-        after(:all) { Librato::Metrics::Simple.flush_authentication }
 
         context "when successful" do
           it "should flush queued metrics and return true" do

data/spec/unit/metrics_spec.rb

@@ -9,8 +9,8 @@ module Librato
      context "when given two arguments" do
        it "should store them on simple" do
          Metrics.authenticate 'tester@librato.com', 'api_key'
-         Metrics::Simple.email.should == 'tester@librato.com'
-         Metrics::Simple.api_key.should == 'api_key'
+         Metrics.client.email.should == 'tester@librato.com'
+         Metrics.client.api_key.should == 'api_key'
        end
      end
 
@@ -30,7 +30,7 @@ module Librato
        Librato::Metrics.persistence = :test
        Librato::Metrics.authenticate 'me@librato.com', 'foo'
      end
-     after(:all) { Librato::Metrics::Simple.flush_authentication }
+     after(:all) { Librato::Metrics.client.flush_authentication }
 
      it "should persist metrics immediately" do
        Metrics.persistence = :test

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: librato-metrics
 version: !ruby/object:Gem::Version
-  version: 0.4.3
-  prerelease: 
+  version: 0.5.0.pre1
+  prerelease: 6
 platform: ruby
 authors:
 - Matt Sanders
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000Z
+date: 2012-03-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: excon
-  requirement: &70348621518180 !ruby/object:Gem::Requirement
+  name: faraday
+  requirement: &70341863470180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: *70348621518180
+  version_requirements: *70341863470180
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70348621517780 !ruby/object:Gem::Requirement
+  requirement: &70341863469760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70348621517780
+  version_requirements: *70341863469760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70348621517320 !ruby/object:Gem::Requirement
+  requirement: &70341863469300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348621517320
+  version_requirements: *70341863469300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70348621505780 !ruby/object:Gem::Requirement
+  requirement: &70341863468800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,21 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70348621505780
+  version_requirements: *70341863468800
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70341863468380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70341863468380
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70348621505280 !ruby/object:Gem::Requirement
+  requirement: &70341863467920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348621505280
+  version_requirements: *70341863467920
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70348621504820 !ruby/object:Gem::Requirement
+  requirement: &70341863467500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348621504820
+  version_requirements: *70341863467500
 description: An easy to use ruby wrapper for Librato's Metrics API
 email: matt@librato.com
 executables: []
@@ -92,19 +103,24 @@ files:
 - README.md
 - Rakefile
 - lib/librato/metrics.rb
-- lib/librato/metrics/collect.rb
+- lib/librato/metrics/client.rb
+- lib/librato/metrics/collection.rb
+- lib/librato/metrics/connection.rb
 - lib/librato/metrics/errors.rb
+- lib/librato/metrics/middleware/expects_status.rb
+- lib/librato/metrics/middleware/retry.rb
 - lib/librato/metrics/persistence.rb
 - lib/librato/metrics/persistence/direct.rb
 - lib/librato/metrics/persistence/test.rb
 - lib/librato/metrics/queue.rb
-- lib/librato/metrics/simple.rb
 - lib/librato/metrics/version.rb
 - librato-metrics.gemspec
+- spec/integration/metrics/connection_spec.rb
 - spec/integration/metrics_spec.rb
 - spec/spec_helper.rb
+- spec/unit/metrics/client_spec.rb
+- spec/unit/metrics/connection_spec.rb
 - spec/unit/metrics/queue_spec.rb
-- spec/unit/metrics/simple_spec.rb
 - spec/unit/metrics_spec.rb
 homepage: https://github.com/librato/librato-metrics
 licenses: []
@@ -122,19 +138,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 2
 summary: Ruby wrapper for Librato's Metrics API
 test_files:
+- spec/integration/metrics/connection_spec.rb
 - spec/integration/metrics_spec.rb
 - spec/spec_helper.rb
+- spec/unit/metrics/client_spec.rb
+- spec/unit/metrics/connection_spec.rb
 - spec/unit/metrics/queue_spec.rb
-- spec/unit/metrics/simple_spec.rb
 - spec/unit/metrics_spec.rb
 has_rdoc: 

data/lib/librato/metrics/simple.rb

@@ -1,148 +0,0 @@
-module Librato
-  module Metrics
-
-    # Class-level methods for quick one-off submission of metrics.
-    #
-    # @example Send a quick metric
-    #   Librato::Metrics::Simple.authenticate 'fred@foo.com', 'myapikey'
-    #   Librato::Metrics::Simple.save :total_vists => {:type => counter, :value => 2311}
-    #
-    # For more than quick one-off use, take a look at {Queue}. For
-    # convenience, most of Simple's methods can be accessed directly from
-    # the {Metrics} module.
-    #
-    class Simple
-
-      class << self
-        # class instance vars
-        attr_accessor :email, :api_key
-
-        # Provide agent identifier for the developer program. See:
-        # http://support.metrics.librato.com/knowledgebase/articles/53548-developer-program
-        #
-        # @example Have the gem build your identifier string
-        #   Librato::Metrics.agent_identifier 'flintstone', '0.5', 'fred'
-        #
-        # @example Provide your own identifier string
-        #   Librato::Metrics.agent_identifier 'flintstone/0.5 (dev_id:fred)'
-        #
-        # @example Remove identifier string
-        #   Librato::Metrics.agent_identifier ''
-        def agent_identifier(*args)
-          if args.length == 1
-            @agent_identifier = args.first
-          elsif args.length == 3
-            @agent_identifier = "#{args[0]}/#{args[1]} (dev_id:#{args[2]})"
-          elsif ![0,1,3].include?(args.length)
-            raise ArgumentError, 'invalid arguments, see method documentation'
-          end
-          @agent_identifier ||= ''
-        end
-
-        # API endpoint to use for queries and direct
-        # persistence.
-        #
-        # @return [String] api_endpoint
-        def api_endpoint
-          @api_endpoint ||= 'https://metrics-api.librato.com/v1/'
-        end
-
-        # Set API endpoint for use with queries and direct
-        # persistence. Generally you should not need to set this
-        # as it will default to the current Librato Metrics
-        # endpoint.
-        #
-        def api_endpoint=(endpoint)
-          @api_endpoint = endpoint
-        end
-
-        # Authenticate for direct persistence
-        #
-        # @param [String] email
-        # @param [String] api_key
-        def authenticate(email, api_key)
-          flush_authentication
-          self.email, self.api_key = email, api_key
-        end
-
-        def connection
-          # TODO: upate when excon connection recovery is improved.
-          # @connection ||= Excon.new(self.api_endpoint, :headers => common_headers)
-          Excon.defaults[:ssl_verify_peer] = false if RUBY_PLATFORM == "java"
-          Excon.new(self.api_endpoint, :headers => common_headers)
-        end
-
-        # Purge current credentials and connection
-        #
-        def flush_authentication
-          self.email = nil
-          self.api_key = nil
-          @connection = nil
-        end
-
-        # Persistence type to use when saving metrics.
-        # Default is :direct.
-        #
-        def persistence
-          @persistence ||= :direct
-        end
-
-        # Set persistence type to use when saving metrics.
-        #
-        # @param [Symbol] persistence_type
-        def persistence=(persist_method)
-          @persistence = persist_method
-        end
-
-        # Current persister object.
-        def persister
-          @queue ? @queue.persister : nil
-        end
-
-        # Submit all queued metrics.
-        #
-        def submit(args)
-          @queue ||= Queue.new(:skip_measurement_times => true)
-          @queue.add args
-          @queue.submit
-        end
-
-        # User-agent used when making requests.
-        #
-        def user_agent
-          ua_chunks = []
-          if agent_identifier && !agent_identifier.empty?
-            ua_chunks << agent_identifier
-          end
-          ua_chunks << "librato-metrics/#{Metrics::VERSION}"
-          ua_chunks << "(#{ruby_engine}; #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}; #{RUBY_PLATFORM})"
-          ua_chunks << "direct-excon/#{Excon::VERSION}"
-          ua_chunks.join(' ')
-        end
-
-      private
-
-        def auth_header
-          raise CredentialsMissing unless (self.email and self.api_key)
-          encoded = Base64.encode64("#{email}:#{api_key}").gsub("\n", '')
-          "Basic #{encoded}"
-        end
-
-        def common_headers
-          {'Authorization' => auth_header, 'User-Agent' => user_agent}
-        end
-
-        def flush_persistence
-          @persistence = nil
-        end
-
-        def ruby_engine
-          return RUBY_ENGINE if Object.constants.include?(:RUBY_ENGINE)
-          RUBY_DESCRIPTION.split[0]
-        end
-
-      end
-
-    end
-  end
-end

data/spec/unit/metrics/simple_spec.rb

@@ -1,126 +0,0 @@
-require 'spec_helper'
-
-module Librato
-  module Metrics
-
-    describe Simple do
-
-      describe "#agent_identifier" do
-        context "when given a single string argument" do
-          it "should set agent_identifier" do
-            Simple.agent_identifier 'mycollector/0.1 (dev_id:foo)'
-            Simple.agent_identifier.should == 'mycollector/0.1 (dev_id:foo)'
-          end
-        end
-
-        context "when given three arguments" do
-          it "should compose an agent string" do
-            Simple.agent_identifier('test_app', '0.5', 'foobar')
-            Simple.agent_identifier.should == 'test_app/0.5 (dev_id:foobar)'
-          end
-
-          context "when given an empty string" do
-            it "should set to empty" do
-              Simple.agent_identifier ''
-              Simple.agent_identifier.should == ''
-            end
-          end
-        end
-
-        context "when given two arguments" do
-          it "should raise error" do
-            lambda { Simple.agent_identifier('test_app', '0.5') }.should raise_error(ArgumentError)
-          end
-        end
-      end
-
-      describe "#api_endpoint" do
-        it "should default to metrics" do
-          Simple.api_endpoint.should == 'https://metrics-api.librato.com/v1/'
-        end
-      end
-
-      describe "#api_endpoint=" do
-        it "should set api_endpoint" do
-          @prior = Simple.api_endpoint
-          Simple.api_endpoint = 'http://test.com/'
-          Simple.api_endpoint.should == 'http://test.com/'
-          Simple.api_endpoint = @prior
-        end
-
-        # TODO:
-        # it "should ensure trailing slash"
-        # it "should ensure real URI"
-      end
-
-      describe "#authenticate" do
-        context "when given two arguments" do
-          it "should store them as email and api_key" do
-            Simple.authenticate 'test@librato.com', 'api_key'
-            Simple.email.should == 'test@librato.com'
-            Simple.api_key.should == 'api_key'
-          end
-        end
-      end
-
-      describe "#connection" do
-        it "should raise exception without authentication" do
-          Simple.flush_authentication
-          lambda{ Simple.connection }.should raise_error(Librato::Metrics::CredentialsMissing)
-        end
-      end
-
-      describe "#persistence" do
-        it "should default to direct" do
-          Simple.send(:flush_persistence)
-          Simple.persistence.should == :direct
-        end
-
-        it "should allow configuration of persistence method" do
-          current = Simple.persistence
-          Simple.persistence = :fake
-          Simple.persistence.should == :fake
-          Simple.persistence = current
-        end
-      end
-
-      describe "#submit" do
-        before(:all) do
-          Simple.persistence = :test
-          Simple.authenticate 'me@librato.com', 'foo'
-        end
-        after(:all) { Simple.flush_authentication }
-
-        it "should persist metrics immediately" do
-          Simple.persistence = :test
-          Simple.submit(:foo => 123).should eql true
-          Simple.persister.persisted.should eql({:gauges => [{:name => 'foo', :value => 123}]})
-        end
-
-        it "should tolerate muliple metrics" do
-          lambda{ Simple.submit :foo => 123, :bar => 456 }.should_not raise_error
-          expected = {:gauges => [{:name => 'foo', :value => 123}, {:name => 'bar', :value => 456}]}
-          Simple.persister.persisted.should eql expected
-        end
-      end
-
-      describe "#user_agent" do
-        context "without an agent_identifier" do
-          it "should render standard string" do
-            Simple.agent_identifier('')
-            Simple.user_agent.should start_with('librato-metrics')
-          end
-        end
-
-        context "with an agent_identifier" do
-          it "should render agent_identifier first" do
-            Simple.agent_identifier('foo', '0.5', 'bar')
-            Simple.user_agent.should start_with('foo/0.5')
-          end
-        end
-      end
-
-    end
-
-  end
-end