statraptor 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## 0.1.0 (February 13, 2012)
+## 0.1.0 (February 24, 2012)
 
-Features:
+* Added support for User, Project, and Graph resources
 
-  - added support for User, Project, and Graph resources
+
+## 0.2.0 (February 28, 2012)
+
+* Added support for listing users with `client.get_users`
+* Added StatRaptor.disable\_ssl\_peer\_verification config option
+* Implemented StatRaptor.timeout config option
+* Improve how errors are raised
+  * A 404 is now properly raised as a StatRaptor::Error::NotFound
+  * A 401 is now properly raised as a StatRaptor::Error::Unauthorized
+  * All other errors are raised as a generic StatRaptor::Error
+  * Errors now include a nice parsed error message if one exists in the StatRaptor response
+* All public methods now return a hash on success instead of JSON

data/README.md

@@ -17,6 +17,7 @@ client = StatRaptor::Client.new
 # Manage users
 client.create_user(:email => "timmy@example.com", :chargify_api_key => "XYZ456")
 client.delete_user("akskd8328389281728918")
+client.get_users
 
 # Manage projects
 client.create_project(:user_credentials => "3892839akslje",

data/lib/statraptor/client/graphs.rb

@@ -1,27 +1,26 @@
 module StatRaptor
   class Client
     module Graphs
-      def get_revenue_graph_data(params={})
+      def get_revenue_graph_data(params = {})
         graph_data("revenue", params)
       end
 
-      def get_subscribers_graph_data(params={})
+      def get_subscribers_graph_data(params = {})
         graph_data("subscribers", params)
       end
 
-      def get_average_lifetime_value_graph_data(params={})
+      def get_average_lifetime_value_graph_data(params = {})
         graph_data("average_lifetime_value", params)
       end
 
-      def get_churn_graph_data(params={})
+      def get_churn_graph_data(params = {})
         graph_data("churn", params)
       end
 
       private
 
-      def graph_data(type, params={})
-        response = Typhoeus::Request.get("#{StatRaptor.endpoint}/graphs/#{type}", :params => params)
-        response.body
+      def graph_data(type, params = {})
+        get("/graphs/#{type}.json", params)
       end
     end
   end

data/lib/statraptor/client/projects.rb

@@ -1,14 +1,12 @@
 module StatRaptor
   class Client
     module Projects
-      def create_project(params={})
-        response = Typhoeus::Request.post("#{StatRaptor.endpoint}/projects", :params => {:platform_credentials => StatRaptor.platform_credentials, :user_credentials => params[:user_credentials], :project => params[:project]})
-        response.body
+      def create_project(params = {})
+        post("/projects", params)
       end
 
-      def delete_project(params={})
-        response = Typhoeus::Request.delete("#{StatRaptor.endpoint}/projects/#{params[:subdomain]}", :params => {:platform_credentials => StatRaptor.platform_credentials, :user_credentials => params[:user_credentials]})
-        handle_response(response)
+      def delete_project(params = {})
+        delete("/projects/#{params[:subdomain]}", :user_credentials => params[:user_credentials])
       end
     end
   end

data/lib/statraptor/client/users.rb

@@ -1,16 +1,16 @@
-require 'statraptor/error/not_found'
-
 module StatRaptor
   class Client
     module Users
-      def create_user(params={})
-        response = Typhoeus::Request.post("#{StatRaptor.endpoint}/users", :params => {:platform_credentials => StatRaptor.platform_credentials, :user => params })
-        response.body
+      def create_user(params = {})
+        post("/users.json", :user => params)
       end
 
       def delete_user(user_credentials)
-        response = Typhoeus::Request.delete("#{StatRaptor.endpoint}/users/#{user_credentials}", :params => {:platform_credentials => StatRaptor.platform_credentials})
-        handle_response(response)
+        delete("/users/#{user_credentials}.json")
+      end
+
+      def get_users
+        get("/users.json")
       end
     end
   end

data/lib/statraptor/client.rb

@@ -1,5 +1,7 @@
 require 'statraptor/config'
 require 'statraptor/error'
+require 'statraptor/error/not_found'
+require 'statraptor/error/unauthorized'
 
 module StatRaptor
   class Client
@@ -26,15 +28,65 @@ module StatRaptor
       end
     end
 
+    private
+
+    def get(url, params = {})
+      request_and_parse :get, url, params
+    end
+
+    def post(url, params = {})
+      request_and_parse :post, url, params
+    end
+
+    def put(url, params = {})
+      request_and_parse :put, url, params
+    end
+
+    def delete(url, params = {})
+      request_and_parse :delete, url, params
+    end
+
+    def request_and_parse(method, url, params = {})
+      response = request_api_response(method, url, 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
+      {}
+    end
+
     def handle_response(response)
       case response.code
       when 200
         return true
-      when 422
-        message = JSON.parse(response.body)["errors"].join(",")
-        raise StatRaptor::Error::NotFound.new(message)
+      when 404
+        raise StatRaptor::Error::NotFound.new(format_error(response))
+      when 401
+        raise StatRaptor::Error::Unauthorized.new(format_error(response))
+      else
+        raise StatRaptor::Error.new(format_error(response))
       end
     end
 
+    def format_error(response)
+      parsed_response = parse_response(response)
+      parsed_response["errors"] ? parsed_response["errors"].join(", ") : ''
+    end
+
   end
 end

data/lib/statraptor/config.rb

@@ -11,18 +11,23 @@ module StatRaptor
     # The value sent in the 'User-Agent' header if none is set
     DEFAULT_USER_AGENT = "StatRaptor Ruby Gem #{StatRaptor::VERSION}"
 
-    # The timeout in seconds that will be used if none is set
-    DEFAULT_TIMEOUT = 2
+    # The timeout (in milliseconds) that will be used if none is set
+    DEFAULT_TIMEOUT = 5000 # 5 seconds
 
     # The default platform_credentials if none are set
     DEFAULT_PLATFORM_CREDENTIALS = nil
 
+    # If you’re hitting a non-verifiable SSL server
+    # then you’ll have to disable peer verification to make SSL work
+    DEFAULT_DISABLE_SSL_PEER_VERIFICATION = false
+
     # An array of valid keys in the options hash when configuring a {StatRaptor::Client}
     VALID_OPTIONS_KEYS = [
       :endpoint,
       :user_agent,
       :timeout,
-      :platform_credentials
+      :platform_credentials,
+      :disable_ssl_peer_verification
     ]
 
     attr_accessor *VALID_OPTIONS_KEYS
@@ -47,10 +52,11 @@ module StatRaptor
 
     # Reset all configuration options to defaults
     def reset
-      self.endpoint             = DEFAULT_ENDPOINT
-      self.user_agent           = DEFAULT_USER_AGENT
-      self.timeout              = DEFAULT_TIMEOUT
-      self.platform_credentials = DEFAULT_PLATFORM_CREDENTIALS
+      self.endpoint                      = DEFAULT_ENDPOINT
+      self.user_agent                    = DEFAULT_USER_AGENT
+      self.timeout                       = DEFAULT_TIMEOUT
+      self.platform_credentials          = DEFAULT_PLATFORM_CREDENTIALS
+      self.disable_ssl_peer_verification = DEFAULT_DISABLE_SSL_PEER_VERIFICATION
       self
     end
   end

data/lib/statraptor/error/unauthorized.rb

@@ -0,0 +1,5 @@
+module StatRaptor
+  # Raised when StatRaptor returns the HTTP status code 401
+  class Error::Unauthorized < StatRaptor::Error
+  end
+end

data/lib/statraptor/version.rb

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

data/spec/spec_helper.rb

@@ -24,6 +24,8 @@ RSpec.configure do |config|
   config.before(:all) do
     StatRaptor.configure do |config|
       config.platform_credentials = platform_credentials
+      config.endpoint = statraptor_endpoint
+      config.disable_ssl_peer_verification = true
     end
   end
 end
@@ -32,7 +34,7 @@ VCR.configure do |config|
   config.hook_into :webmock
   config.cassette_library_dir = 'spec/cassettes'
   config.configure_rspec_metadata!
-  config.default_cassette_options = {:record => :new_episodes, :match_requests_on => [:uri, :body, :headers]}
+  config.default_cassette_options = {:record => :once, :match_requests_on => [:uri, :body, :headers]}
 end
 
 def platform_credentials
@@ -51,6 +53,10 @@ def user_credentials
   remote_configuration["user_credentials"]
 end
 
+def statraptor_endpoint
+  remote_configuration["endpoint"]
+end
+
 private
 
 def remote_configuration

data/spec/statrapator/client/graphs_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe StatRaptor::Client::Graphs, :vcr do
+  let(:client) { StatRaptor::Client.new }
+
+  ["revenue", "subscribers", "average_lifetime_value", "churn"].each do |graph_name|
+    context "#get_#{graph_name}_graph_data" do
+      it "should return a hash of #{graph_name} graph data" do
+        graph = client.send("get_#{graph_name}_graph_data", :user_credentials => user_credentials, :subdomain => chargify_subdomain)
+        graph.should be_a(Hash)
+        graph["graph_data"].keys.should include("actual", "projected", "x_labels")
+      end
+    end
+  end
+
+end

data/spec/statrapator/client/projects_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe StatRaptor::Client::Projects do
+  let(:client) { StatRaptor::Client.new }
+
+  context "#create_project", :vcr do
+    before do
+      @user = client.create_user(:email => "tommy@example.com", :chargify_api_key => "ABC123")
+      @user["user_credentials"].should_not be_nil
+    end
+
+    it "returns a project hash on success" do
+      project = client.create_project(:user_credentials => @user["user_credentials"], :project => {
+       :name => "Zippy Sunday", :subdomain => "zippy-sunday", :component => "basic" 
+      })
+
+      project["name"].should == "Zippy Sunday"
+      project["subdomain"].should == "zippy-sunday"
+      project["component"].should == "basic"
+    end
+  end
+
+  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")
+      project = client.create_project(:user_credentials => user["user_credentials"], :project => {
+       :name => "Modern Marvels", :subdomain => "modern-marvels", :component => "advanced" 
+      })
+
+      deleted_project = client.delete_project(:user_credentials => user["user_credentials"], :subdomain => "modern-marvels")
+      deleted_project["name"].should == "Modern Marvels"
+      deleted_project["subdomain"].should == "modern-marvels"
+      deleted_project["component"].should == "advanced"
+    end
+
+    it "raises an unauthorized exception if the user credentials are incorrect" do
+      lambda {
+        client.delete_project(:user_credentials => "abc123", :subdomain => "modern-marvels")
+      }.should raise_error(StatRaptor::Error::Unauthorized, "Invalid user API key specified")
+    end
+  end
+end

data/spec/statrapator/client/user_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe StatRaptor::Client::Users do
+  let(:client) { StatRaptor::Client.new }
+
+  context "#create", :vcr do
+    it "returns a user hash on success" do
+      user = client.create_user(:email => "austin@example.com", :chargify_api_key => "ABC123")
+      user["user_credentials"].should_not be_nil
+      user["chargify_api_key"].should == "ABC123"
+      user["email"].should == "austin@example.com"
+    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")
+      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"
+    end
+  end
+
+  context "#get_users", :vcr do
+    it "returns an array of hashes" do
+      users = client.get_users
+      users.count.should > 1
+      users.should be_a(Array)
+      users.first.should be_a(Hash)
+    end
+  end
+end

data/spec/{client_spec.rb → statrapator/client_spec.rb}

@@ -33,7 +33,8 @@ describe StatRaptor::Client do
         :endpoint => "http://example.com",
         :timeout => 300,
         :platform_credentials => "ABC12345",
-        :user_agent => "Fu Manchu Ruby Gem 2.0.0"
+        :user_agent => "Fu Manchu Ruby Gem 2.0.0",
+        :disable_ssl_peer_verification => true
       }
     end
 

data/spec/{config_spec.rb → statrapator/config_spec.rb}

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe StatRaptor do
+  before do
+    StatRaptor.reset
+  end
+
   after do
     StatRaptor.reset
   end
@@ -51,12 +55,28 @@ describe StatRaptor do
   end
 
   describe ".timeout=" do
-    it "should return the timeout" do
+    it "should set the timeout" do
       StatRaptor.timeout = 15
       StatRaptor.timeout.should == 15
     end
   end
 
+  describe ".disable_ssl_peer_verification" do
+    it "should return the default setting" do
+      StatRaptor.disable_ssl_peer_verification.should == StatRaptor::Config::DEFAULT_DISABLE_SSL_PEER_VERIFICATION
+    end
+  end
+
+  describe ".disable_ssl_peer_verification=" do
+    it "should set the disable_ssl_peer_verification option" do
+      StatRaptor.disable_ssl_peer_verification = true
+      StatRaptor.disable_ssl_peer_verification.should be_true
+
+      StatRaptor.disable_ssl_peer_verification = false
+      StatRaptor.disable_ssl_peer_verification.should be_false
+    end
+  end
+
   describe ".configure" do
     StatRaptor::Config::VALID_OPTIONS_KEYS.each do |key|
       it "should set the #{key}" do

data/spec/statrapator/error_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe StatRaptor::Error do
+  context "#initialize" do
+    it "returns an instance of StatRaptor::Error" do
+      StatRaptor::Error.new("message").should be_a(StatRaptor::Error)
+    end
+
+    it "is a subclass of StandardError" do
+      StatRaptor::Error.superclass.should == StandardError
+    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-24"
+  s.date        = "2012-02-28"
   s.authors     = ["Shay Frendt"]
   s.email       = "shay.frendt@gmail.com"
   s.homepage    = "http://github.com/chargify/statraptor"

data/todo.taskpaper

@@ -0,0 +1,3 @@
+StatRaptor Todo:
+- Raise an error on a timeout
+- Set the user_agent for all HTTP calls

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: statraptor
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Shay Frendt
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-24 00:00:00 -05:00
+date: 2012-02-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,7 +106,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 3424234125
+        hash: -2355515322
         segments: 
         - 2
         - 0
@@ -206,15 +206,18 @@ files:
 - lib/statraptor/config.rb
 - lib/statraptor/error.rb
 - lib/statraptor/error/not_found.rb
+- lib/statraptor/error/unauthorized.rb
 - lib/statraptor/version.rb
-- spec/client/graphs_spec.rb
-- spec/client/projects_spec.rb
-- spec/client/user_spec.rb
-- spec/client_spec.rb
-- spec/config_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/statrapator/client/graphs_spec.rb
+- spec/statrapator/client/projects_spec.rb
+- spec/statrapator/client/user_spec.rb
+- spec/statrapator/client_spec.rb
+- spec/statrapator/config_spec.rb
+- spec/statrapator/error_spec.rb
 - statraptor.gemspec
+- todo.taskpaper
 has_rdoc: true
 homepage: http://github.com/chargify/statraptor
 licenses: []
@@ -252,10 +255,11 @@ signing_key:
 specification_version: 3
 summary: A StatRaptor API wrapper for Ruby
 test_files: 
-- spec/client/graphs_spec.rb
-- spec/client/projects_spec.rb
-- spec/client/user_spec.rb
-- spec/client_spec.rb
-- spec/config_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/statrapator/client/graphs_spec.rb
+- spec/statrapator/client/projects_spec.rb
+- spec/statrapator/client/user_spec.rb
+- spec/statrapator/client_spec.rb
+- spec/statrapator/config_spec.rb
+- spec/statrapator/error_spec.rb

data/spec/client/graphs_spec.rb

@@ -1,41 +0,0 @@
-require 'spec_helper'
-
-describe StatRaptor::Client::Graphs, :vcr do
-  let(:client) { StatRaptor::Client.new }
-
-  context "#get_revenue_graph_data" do
-    it "returns the revenue graph json" do
-      graph_json = client.get_revenue_graph_data(:user_credentials => user_credentials, :subdomain => chargify_subdomain)
-      graph_json.should == "{\"graph_data\":{\"actual\":[0,0,557,353,360,460,460,552,512,582,282,282,null,null,null,null],\"projected\":[null,null,null,null,null,null,null,null,null,null,null,282,282,282,282,282],\"x_labels\":[\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\",\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\"]}}"
-    end
-
-    it "raises an exception if the graph data is not found"
-  end
-
-  context "#get_subscribers_graph_data" do
-    it "returns the subscribers graph json" do
-      graph_json = client.get_subscribers_graph_data(:user_credentials => user_credentials, :subdomain => chargify_subdomain)
-      graph_json.should == "{\"graph_data\":{\"actual\":[0,0,8,8,8,10,10,13,14,16,9,6,null,null,null,null],\"projected\":[null,null,null,null,null,null,null,null,null,null,null,6,4,4,4,4],\"x_labels\":[\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\",\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\"]}}"
-    end
-
-    it "raises an exception if the graph data is not found"
-  end
-
-  context "#get_average_lifetime_value_graph_data" do
-    it "returns the average lifetime value graph json" do
-      graph_json = client.get_average_lifetime_value_graph_data(:user_credentials => user_credentials, :subdomain => chargify_subdomain)
-      graph_json.should == "{\"graph_data\":{\"actual\":[0,0,79,102,143,160,202,214,255,244,466,747,null,null,null,null],\"projected\":[null,null,null,null,null,null,null,null,null,null,null,747,1028,1309,1590,1871],\"x_labels\":[\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\",\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\"]}}"
-    end
-
-    it "raises an exception if the graph data is not found"
-  end
-
-  context "#get_churn_graph_data" do
-    it "returns the churn graph json" do
-      graph_json = client.get_churn_graph_data(:user_credentials => user_credentials, :subdomain => chargify_subdomain)
-      graph_json.should == "{\"graph_data\":{\"actual\":[0,0,20,0,0,33,0,0,50,0,200,200,null,null,null,null],\"projected\":[null,null,null,null,null,null,null,null,null,null,null,200,200,200,200,200],\"x_labels\":[\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\",\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\"]}}"
-    end
-
-    it "raises an exception if the graph data is not found"
-  end
-end

data/spec/client/projects_spec.rb

@@ -1,42 +0,0 @@
-require 'spec_helper'
-
-describe StatRaptor::Client::Projects do
-  let(:client) { StatRaptor::Client.new }
-
-  context "#create_project", :vcr do
-    it "returns the project json on success" do
-      user_json = client.create_user(:email => "zippy@example.com", :chargify_api_key => chargify_api_key)
-      user_hash = JSON.parse(user_json)
-
-      project_json = client.create_project(:user_credentials => user_hash["user_credentials"], :project => {
-       :name => "Zippy Sunday", :subdomain => "zippy-sunday", :component => "basic" 
-      })
-
-      project_hash = JSON.parse(project_json)
-      project_hash["name"].should == "Zippy Sunday"
-      project_hash["subdomain"].should == "zippy-sunday"
-      project_hash["component"].should == "basic"
-    end
-
-    it "raises an exception if the project was not created"
-  end
-
-  context "#delete_project", :vcr do
-    it "returns true on success" do
-      user_json = client.create_user(:email => "sammy@example.com", :chargify_api_key => chargify_api_key)
-      user_hash = JSON.parse(user_json)
-
-      project_json = client.create_project(:user_credentials => user_hash["user_credentials"], :project => {
-       :name => "Modern Marvels", :subdomain => "modern-marvels", :component => "advanced" 
-      })
-
-      client.delete_project(:user_credentials => user_hash["user_credentials"], :subdomain => "modern-marvels").should be_true
-    end
-
-    it "raises an exception if the project was not deleted" do
-      lambda {
-        client.delete_project(:user_credentials => "abc123", :subdomain => "modern-marvels")
-      }.should raise_error(StatRaptor::Error::NotFound)
-    end
-  end
-end

data/spec/client/user_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-describe StatRaptor::Client::Users do
-  let(:client) { StatRaptor::Client.new }
-
-  context "#create", :vcr do
-    it "returns the user json on success" do
-      user_json = client.create_user(:email => "timmy@example.com", :chargify_api_key => chargify_api_key)
-      user_hash = JSON.parse(user_json)
-      user_hash["user_credentials"].should_not be_nil
-      user_hash["chargify_api_key"].should == chargify_api_key
-      user_hash["email"].should == "timmy@example.com"
-    end
-
-    it "raises an exception if the user was not created"
-  end
-
-  context "#delete_user", :vcr do
-    it "returns true on success" do
-      user_json = client.create_user(:email => "ronny@example.com", :chargify_api_key => chargify_api_key)
-      user_hash = JSON.parse(user_json)
-      client.delete_user(user_hash["user_credentials"]).should be_true
-    end
-
-    it "raises an NotFound exception if the user does not exist" do
-      lambda {
-        client.delete_user("abc123")
-      }.should raise_error(StatRaptor::Error::NotFound)
-    end
-  end
-end