statraptor 0.2.0 → 0.2.1

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    statraptor (0.1.0)
+    statraptor (0.2.0)
       activeresource (>= 2.3.5)
       json (>= 1.4.6)
+      rest-client (>= 1.6.7)
       typhoeus (>= 0.3.3)
 
 GEM
@@ -31,10 +32,14 @@ GEM
       guard (>= 0.10.0)
     i18n (0.6.0)
     json (1.6.5)
+    macaddr (1.5.0)
+      systemu (>= 2.4.0)
     mime-types (1.17.2)
-    multi_json (1.0.4)
+    multi_json (1.1.0)
     rake (0.9.2.2)
     rb-fsevent (0.9.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -43,9 +48,12 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    systemu (2.4.2)
     thor (0.14.6)
     typhoeus (0.3.3)
       mime-types
+    uuid (2.3.5)
+      macaddr (~> 1.0)
     vcr (2.0.0.rc1)
     webmock (1.7.10)
       addressable (~> 2.2, > 2.2.5)
@@ -61,5 +69,6 @@ DEPENDENCIES
   rb-fsevent (~> 0.9.0)
   rspec (~> 2.8.0)
   statraptor!
+  uuid (~> 2.3.5)
   vcr (= 2.0.0.rc1)
   webmock (= 1.7.10)

data/lib/statraptor/client/adapters/rest_client.rb

@@ -0,0 +1,24 @@
+module StatRaptor
+  class Client
+    module Adapters
+      module RestClient
+        def self.request_api_response(method, path, params = {})
+          params.merge!(:platform_credentials => StatRaptor.platform_credentials)
+          verify_ssl = StatRaptor.disable_ssl_peer_verification ? false : true
+          url = StatRaptor.full_uri(path)
+
+          options = {
+            :url => url,
+            :method => method,
+            :payload => params,
+            :verify_ssl =>  StatRaptor.disable_ssl_peer_verification,
+            :timeout => StatRaptor.timeout_in_seconds,
+            :headers => Config::HTTP_HEADERS
+          }
+
+          ::RestClient::Request.execute(options){|response, request, result| response }
+        end
+      end
+    end
+  end
+end

data/lib/statraptor/client/adapters/typhoeus.rb

@@ -0,0 +1,19 @@
+module StatRaptor
+  class Client
+    module Adapters
+      module Typhoeus
+        def self.request_api_response(method, path, params = {})
+          params.merge!(:platform_credentials => StatRaptor.platform_credentials)
+
+          ::Typhoeus::Request.run(
+            "#{StatRaptor.endpoint}/api/v1#{path}",
+            :method => method,
+            :params => params,
+            :disable_ssl_peer_verification => StatRaptor.disable_ssl_peer_verification,
+            :timeout => StatRaptor.timeout
+          )
+        end
+      end
+    end
+  end
+end

data/lib/statraptor/client/graphs.rb

@@ -20,7 +20,7 @@ module StatRaptor
       private
 
       def graph_data(type, params = {})
-        get("/graphs/#{type}.json", params)
+        get("/api/v1/graphs/#{type}.json", params)
       end
     end
   end

data/lib/statraptor/client/projects.rb

@@ -2,11 +2,11 @@ module StatRaptor
   class Client
     module Projects
       def create_project(params = {})
-        post("/projects", params)
+        post("/api/v1/projects", params)
       end
 
       def delete_project(params = {})
-        delete("/projects/#{params[:subdomain]}", :user_credentials => params[:user_credentials])
+        delete("/api/v1/projects/#{params[:subdomain]}", :user_credentials => params[:user_credentials])
       end
     end
   end

data/lib/statraptor/client/users.rb

@@ -2,15 +2,15 @@ module StatRaptor
   class Client
     module Users
       def create_user(params = {})
-        post("/users.json", :user => params)
+        post("/api/v1/users.json", :user => params)
       end
 
       def delete_user(user_credentials)
-        delete("/users/#{user_credentials}.json")
+        delete("/api/v1/users/#{user_credentials}.json")
       end
 
       def get_users
-        get("/users.json")
+        get("/api/v1/users.json")
       end
     end
   end

data/lib/statraptor/client.rb

@@ -15,6 +15,9 @@ module StatRaptor
     require 'statraptor/client/graphs'
     include StatRaptor::Client::Graphs
 
+    require 'statraptor/client/adapters/rest_client'
+    require 'statraptor/client/adapters/typhoeus'
+
     attr_accessor *Config::VALID_OPTIONS_KEYS
 
     # Initializes a new API object
@@ -30,40 +33,28 @@ module StatRaptor
 
     private
 
-    def get(url, params = {})
-      request_and_parse :get, url, params
+    def get(path, params = {})
+      request_and_parse :get, path, params
     end
 
-    def post(url, params = {})
-      request_and_parse :post, url, params
+    def post(path, params = {})
+      request_and_parse :post, path, params
     end
 
-    def put(url, params = {})
-      request_and_parse :put, url, params
+    def put(path, params = {})
+      request_and_parse :put, path, params
     end
 
-    def delete(url, params = {})
-      request_and_parse :delete, url, params
+    def delete(path, params = {})
+      request_and_parse :delete, path, params
     end
 
-    def request_and_parse(method, url, params = {})
-      response = request_api_response(method, url, params)
+    def request_and_parse(method, path, params = {})
+      response = Client::Adapters::RestClient.request_api_response(method, path, params)
       handle_response(response)
       parse_response(response)
     end
 
-    def request_api_response(method, url, params = {})
-      params.merge!(:platform_credentials => StatRaptor.platform_credentials)
-
-      Typhoeus::Request.run(
-        "#{StatRaptor.endpoint}/api/v1#{url}",
-        :method => method,
-        :params => params,
-        :disable_ssl_peer_verification => StatRaptor.disable_ssl_peer_verification,
-        :timeout => StatRaptor.timeout
-      )
-    end
-
     def parse_response(response)
       JSON.parse(response.body)
     rescue JSON::ParserError

data/lib/statraptor/config.rb

@@ -21,6 +21,11 @@ module StatRaptor
     # then you’ll have to disable peer verification to make SSL work
     DEFAULT_DISABLE_SSL_PEER_VERIFICATION = false
 
+    HTTP_HEADERS = {
+      'Accept' => 'application/json',
+      'User-Agent' => "StatRaptor RubyGem #{StatRaptor::VERSION} - http://github.com/chargify/statraptor",
+    }
+
     # An array of valid keys in the options hash when configuring a {StatRaptor::Client}
     VALID_OPTIONS_KEYS = [
       :endpoint,
@@ -59,5 +64,13 @@ module StatRaptor
       self.disable_ssl_peer_verification = DEFAULT_DISABLE_SSL_PEER_VERIFICATION
       self
     end
+
+    def timeout_in_seconds
+      self.timeout / 1000.0
+    end
+
+    def full_uri(path)
+      "#{StatRaptor.endpoint}#{path}"
+    end
   end
 end

data/lib/statraptor/version.rb

@@ -1,3 +1,3 @@
 module StatRaptor
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/statraptor.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'typhoeus'
 require 'json'
+require 'rest_client'
 require 'statraptor/version'
 require 'statraptor/config'
 require 'statraptor/client'

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'rspec'
 require 'vcr'
 require 'webmock/rspec'
 require 'yaml'
+require 'uuid'
 
 unless File.exists?(File.join(File.dirname(__FILE__), 'remote.yml'))
   STDERR.puts "\nERROR: Make sure a remote.yml file exists at ./spec/remote.yml\n\n"
@@ -34,7 +35,7 @@ VCR.configure do |config|
   config.hook_into :webmock
   config.cassette_library_dir = 'spec/cassettes'
   config.configure_rspec_metadata!
-  config.default_cassette_options = {:record => :once, :match_requests_on => [:uri, :body, :headers]}
+  config.default_cassette_options = {:record => :new_episodes, :match_requests_on => [:uri, :body, :headers]}
 end
 
 def platform_credentials
@@ -62,3 +63,7 @@ private
 def remote_configuration
   @remote_configuration ||= YAML.load_file(File.expand_path(File.join(File.dirname(__FILE__), 'remote.yml')))
 end
+
+def random_email
+  "statraptor-gem-test-email-#{UUID.generate}@example.com"
+end

data/spec/statrapator/client/adapters/rest_client_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe StatRaptor::Client::Adapters::RestClient do
+  describe ".request_api_response", :vcr do
+    it "returns a RestClient response" do
+      response = StatRaptor::Client::Adapters::RestClient.request_api_response(:get, "/users.json")
+      [:code, :headers, :raw_headers].each do |attr|
+        response.respond_to?(attr).should be_true
+      end
+    end
+  end
+end

data/spec/statrapator/client/adapters/typhoeus_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe StatRaptor::Client::Adapters::Typhoeus do
+  describe ".request_api_response", :vcr do
+    it "returns a typhoeus response" do
+      response = StatRaptor::Client::Adapters::Typhoeus.request_api_response(:get, "/users.json")
+      response.should be_a(Typhoeus::Response)
+    end
+  end
+end

data/spec/statrapator/client/projects_spec.rb

@@ -5,7 +5,7 @@ describe StatRaptor::Client::Projects do
 
   context "#create_project", :vcr do
     before do
-      @user = client.create_user(:email => "tommy@example.com", :chargify_api_key => "ABC123")
+      @user = client.create_user(:email => random_email, :chargify_api_key => "ABC123")
       @user["user_credentials"].should_not be_nil
     end
 
@@ -22,7 +22,7 @@ describe StatRaptor::Client::Projects do
 
   context "#delete_project", :vcr do
     it "returns the project hash on success" do
-      user = client.create_user(:email => "sammy@example.com", :chargify_api_key => "ABC123")
+      user = client.create_user(:email => random_email, :chargify_api_key => "ABC123")
       project = client.create_project(:user_credentials => user["user_credentials"], :project => {
        :name => "Modern Marvels", :subdomain => "modern-marvels", :component => "advanced" 
       })

data/spec/statrapator/client/user_spec.rb

@@ -5,20 +5,22 @@ describe StatRaptor::Client::Users do
 
   context "#create", :vcr do
     it "returns a user hash on success" do
-      user = client.create_user(:email => "austin@example.com", :chargify_api_key => "ABC123")
+      email = random_email
+      user = client.create_user(:email => email, :chargify_api_key => "ABC123")
       user["user_credentials"].should_not be_nil
       user["chargify_api_key"].should == "ABC123"
-      user["email"].should == "austin@example.com"
+      user["email"].should == email
     end
   end
 
   context "#delete_user", :vcr do
     it "returns the user hash on success" do
-      user = client.create_user(:email => "leroy@example.com", :chargify_api_key => "XYZ123")
+      email = random_email
+      user = client.create_user(:email => email, :chargify_api_key => "XYZ123")
       deleted_user = client.delete_user(user["user_credentials"])
       deleted_user["user_credentials"].should == user["user_credentials"]
       deleted_user["chargify_api_key"].should == "XYZ123"
-      deleted_user["email"].should == "leroy@example.com"
+      deleted_user["email"].should == email
     end
   end
 

data/spec/statrapator/config_spec.rb

@@ -88,4 +88,33 @@ describe StatRaptor do
     end
   end
 
+  describe ".timeout_in_seconds" do
+    it "returns the read timeout in seconds" do
+      StatRaptor.timeout = 1000
+      StatRaptor.timeout_in_seconds.should == 1.0
+    end
+  end
+
+  context "HTTP_HEADERS" do
+    it "should set the Accept header" do
+      StatRaptor::Config::HTTP_HEADERS['Accept'].should == "application/json"
+    end
+
+    it "should set the User-Agent header" do
+      StatRaptor::Config::HTTP_HEADERS['User-Agent'].should == "StatRaptor RubyGem #{StatRaptor::VERSION} - http://github.com/chargify/statraptor"
+    end
+  end
+
+  describe ".full_uri" do
+    it "accepts a path and returns the full URI to the StatRaptor API" do
+      StatRaptor.endpoint = "https://statraptor.com"
+      StatRaptor.full_uri("/api/v1/users").should == "https://statraptor.com/api/v1/users"
+    end
+
+    it "utilizes the current StatRaptor endpoint config option" do
+      StatRaptor.endpoint = "http://example.com"
+      StatRaptor.full_uri("/api/v2/path").should == "http://example.com/api/v2/path"
+    end
+  end
+
 end

data/statraptor.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.name        = "statraptor"
   s.version     = StatRaptor::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.date        = "2012-02-28"
+  s.date        = "2012-02-29"
   s.authors     = ["Shay Frendt"]
   s.email       = "shay.frendt@gmail.com"
   s.homepage    = "http://github.com/chargify/statraptor"
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('activeresource', '>= 2.3.5')
   s.add_runtime_dependency('typhoeus', '>= 0.3.3')
   s.add_runtime_dependency('json', '>= 1.4.6')
+  s.add_runtime_dependency('rest-client', '>= 1.6.7')
 
   # Development Dependencies
   s.add_development_dependency('rake', '~> 0.9.2')
@@ -34,4 +35,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('guard-rspec', '~> 0.6.0')
   s.add_development_dependency('growl', '~> 1.0.3')
   s.add_development_dependency('rb-fsevent', '~> 0.9.0')
+  s.add_development_dependency('uuid', '~> 2.3.5')
 end

data/todo.taskpaper

@@ -1,3 +1,3 @@
 StatRaptor Todo:
 - Raise an error on a timeout
-- Set the user_agent for all HTTP calls
+- Allow specifying an http adapter in the config

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: statraptor
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Shay Frendt
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-28 00:00:00 -05:00
+date: 2012-02-29 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,9 +67,25 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: rest-client
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 6
+        - 7
+        version: 1.6.7
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,11 +97,11 @@ dependencies:
         - 2
         version: 0.9.2
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,16 +113,16 @@ dependencies:
         - 0
         version: 2.8.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: vcr
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: -2355515322
+        hash: -1931884648
         segments: 
         - 2
         - 0
@@ -115,11 +131,11 @@ dependencies:
         - 1
         version: 2.0.0.rc1
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -131,11 +147,11 @@ dependencies:
         - 10
         version: 1.7.10
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: guard-rspec
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -147,11 +163,11 @@ dependencies:
         - 0
         version: 0.6.0
   type: :development
-  version_requirements: *id008
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: growl
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -163,11 +179,11 @@ dependencies:
         - 3
         version: 1.0.3
   type: :development
-  version_requirements: *id009
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: rb-fsevent
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -179,7 +195,23 @@ dependencies:
         - 0
         version: 0.9.0
   type: :development
-  version_requirements: *id010
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id012
 description: StatRaptor gathers all your metrics into one simple-to-use dashboard.
 email: shay.frendt@gmail.com
 executables: []
@@ -200,6 +232,8 @@ files:
 - Rakefile
 - lib/statraptor.rb
 - lib/statraptor/client.rb
+- lib/statraptor/client/adapters/rest_client.rb
+- lib/statraptor/client/adapters/typhoeus.rb
 - lib/statraptor/client/graphs.rb
 - lib/statraptor/client/projects.rb
 - lib/statraptor/client/users.rb
@@ -210,6 +244,8 @@ files:
 - lib/statraptor/version.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/statrapator/client/adapters/rest_client_spec.rb
+- spec/statrapator/client/adapters/typhoeus_spec.rb
 - spec/statrapator/client/graphs_spec.rb
 - spec/statrapator/client/projects_spec.rb
 - spec/statrapator/client/user_spec.rb
@@ -257,6 +293,8 @@ summary: A StatRaptor API wrapper for Ruby
 test_files: 
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/statrapator/client/adapters/rest_client_spec.rb
+- spec/statrapator/client/adapters/typhoeus_spec.rb
 - spec/statrapator/client/graphs_spec.rb
 - spec/statrapator/client/projects_spec.rb
 - spec/statrapator/client/user_spec.rb