statsmix 0.0.5 → 0.0.6

data/README.rdoc

@@ -4,6 +4,10 @@ A Ruby gem for the StatsMix API - http://www.statsmix.com/developers
 
 WARNING: This is currently experimental and not recommend for production use.
 
+StatsMix makes it easy to track, chart, and share application and business metrics.
+
+To get started, you'll need a API key for StatsMix. You can get a free developer account here: http://www.statsmix.com/try?plan=developer
+
 
 == Contributing to statsmix
  
@@ -15,6 +19,7 @@ WARNING: This is currently experimental and not recommend for production use.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+
 == Copyright
 
-Copyright (c) 2011 StatsMix, Inc. See LICENSE.txt for further details.
+Copyright (c) 2011 StatsMix, Inc. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/statsmix.rb

@@ -3,6 +3,7 @@ require 'net/http'
 class StatsMix
   
   BASE_URI = 'http://www.statsmix.com/api/v2/'
+  # BASE_URI = 'http://localhost:3000/api/v2/'
   
   GEM_VERSION = File.exist?('../VERSION') ? File.read('../VERSION') : ""
   
@@ -12,17 +13,22 @@ class StatsMix
     @user_agent = "StatsMix Ruby Gem " + GEM_VERSION
   end
   
-  # -- Stats --
+  def connect(resource)
+    # Resources available: stats, metrics, TODO: profiles
+    @url = URI.parse(BASE_URI + resource)
+    @connection = Net::HTTP.new(@url.host, @url.port)
+    
+  end
+  
+  # Stats
   
   # List stats (index)
   # 
   # Required: metric_id
   # Optional: limit
   def list_stats(metric_id, limit = nil)
-    url = URI.parse(BASE_URI + "stats")
-    http = Net::HTTP.new(url.host, url.port)
-    
-    request = Net::HTTP::Get.new(url.path + '.' + @format)
+    connect('stats')
+    request = Net::HTTP::Get.new(@url.path + '.' + @format)
     request["User-Agent"] = @user_agent
     
     form_hash = Hash.new
@@ -34,8 +40,8 @@ class StatsMix
     
     request.set_form_data(form_hash)
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Get stat
@@ -43,16 +49,14 @@ class StatsMix
   # Required: stat_id
   # Optional: none
   def get_stat(stat_id)
-    url = URI.parse(BASE_URI + "stats")
-    http = Net::HTTP.new(url.host, url.port)
-    
-    request = Net::HTTP::Get.new(url.path + '/' + stat_id.to_s + '.' + @format)
+    connect('stats')
+    request = Net::HTTP::Get.new(@url.path + '/' + stat_id.to_s + '.' + @format)
     request["User-Agent"] = @user_agent
     
     request.set_form_data({"api_key" => @api_key})
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Create stat
@@ -60,10 +64,8 @@ class StatsMix
   # Required: metric_id
   # Optional: value, generated_at, meta
   def create_stat(metric_id, value = 1, generated_at = Time.now, meta = nil)
-    url = URI.parse(BASE_URI + "stats")
-    http = Net::HTTP.new(url.host, url.port)
-
-    request = Net::HTTP::Post.new(url.path + '.' + @format)
+    connect('stats')
+    request = Net::HTTP::Post.new(@url.path + '.' + @format)
     request["User-Agent"] = @user_agent
 
     form_hash = Hash.new
@@ -77,8 +79,8 @@ class StatsMix
     
     request.set_form_data(form_hash)
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Update stat
@@ -86,10 +88,8 @@ class StatsMix
   # Required: stat_id
   # Optional: value, generated_at, meta
   def update_stat(stat_id, value = nil, generated_at = nil, meta = nil)  
-    url = URI.parse(BASE_URI + "stats")
-    http = Net::HTTP.new(url.host, url.port)
-  
-    request = Net::HTTP::Put.new(url.path + '/' + stat_id.to_s + '.' + @format)
+    connect('stats')
+    request = Net::HTTP::Put.new(@url.path + '/' + stat_id.to_s + '.' + @format)
     request["User-Agent"] = @user_agent
 
     form_hash = Hash.new
@@ -106,8 +106,8 @@ class StatsMix
     
     request.set_form_data(form_hash)
 
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Delete stat
@@ -115,29 +115,25 @@ class StatsMix
   # Required: stat_id
   # Optional: none
   def delete_stat(stat_id)    
-    url = URI.parse(BASE_URI + "stats")
-    http = Net::HTTP.new(url.host, url.port)
-
-    request = Net::HTTP::Delete.new(url.path + '/' + stat_id.to_s + '.' + @format)
+    connect('stats')
+    request = Net::HTTP::Delete.new(@url.path + '/' + stat_id.to_s + '.' + @format)
     request["User-Agent"] = @user_agent
     
     request.set_form_data({"api_key" => @api_key})
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
-  # -- Metrics --
+  # Metrics
   
   # List metrics
   # 
   # Required: none
   # Optional: profile_id, limit
   def list_metrics(profile_id = nil, limit = nil)
-    url = URI.parse(BASE_URI + "metrics")
-    http = Net::HTTP.new(url.host, url.port)
-    
-    request = Net::HTTP::Get.new(url.path + '.' + @format)
+    connect('metrics')
+    request = Net::HTTP::Get.new(@url.path + '.' + @format)
     request["User-Agent"] = @user_agent
     
     form_hash = Hash.new
@@ -151,8 +147,8 @@ class StatsMix
     
     request.set_form_data(form_hash)
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Get metric
@@ -160,16 +156,14 @@ class StatsMix
   # Required: metric_id
   # Optional: none
   def get_metric(metric_id)
-    url = URI.parse(BASE_URI + "metrics")
-    http = Net::HTTP.new(url.host, url.port)
-    
-    request = Net::HTTP::Get.new(url.path + '/' + metric_id.to_s + '.' + @format)
+    connect('metrics')
+    request = Net::HTTP::Get.new(@url.path + '/' + metric_id.to_s + '.' + @format)
     request["User-Agent"] = @user_agent
     
     request.set_form_data({"api_key" => @api_key})
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Create metric
@@ -177,10 +171,8 @@ class StatsMix
   # Required: name
   # Optional: profile_id, generated_at
   def create_metric(name, profile_id = nil)
-    url = URI.parse(BASE_URI + "metrics")
-    http = Net::HTTP.new(url.host, url.port)
-
-    request = Net::HTTP::Post.new(url.path + '.' + @format)
+    connect('metrics')
+    request = Net::HTTP::Post.new(@url.path + '.' + @format)
     request["User-Agent"] = @user_agent
 
     form_hash = Hash.new
@@ -192,8 +184,8 @@ class StatsMix
     
     request.set_form_data(form_hash)
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Update metric
@@ -201,10 +193,8 @@ class StatsMix
   # Required: metric_id
   # Optional: name, sharing, include_in_email
   def update_metric(metric_id, name = nil, sharing = nil, include_in_email = nil)  
-    url = URI.parse(BASE_URI + "metrics")
-    http = Net::HTTP.new(url.host, url.port)
-  
-    request = Net::HTTP::Put.new(url.path + '/' + metric_id.to_s + '.' + @format)
+    connect('metrics')
+    request = Net::HTTP::Put.new(@url.path + '/' + metric_id.to_s + '.' + @format)
     request["User-Agent"] = @user_agent
 
     form_hash = Hash.new
@@ -221,8 +211,8 @@ class StatsMix
     
     request.set_form_data(form_hash)
 
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
   
   # Delete metric
@@ -230,15 +220,13 @@ class StatsMix
   # Required: metric_id
   # Optional: none
   def delete_metric(metric_id)    
-    url = URI.parse(BASE_URI + "metrics")
-    http = Net::HTTP.new(url.host, url.port)
-
-    request = Net::HTTP::Delete.new(url.path + '/' + metric_id.to_s + '.' + @format)
+    connect('metrics')
+    request = Net::HTTP::Delete.new(@url.path + '/' + metric_id.to_s + '.' + @format)
     request["User-Agent"] = @user_agent
     
     request.set_form_data({"api_key" => @api_key})
     
-    response = http.request(request)
-    puts response.body, response.code, response.message
+    response = @connection.request(request)
+    return response.body
   end
 end

data/statsmix.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{statsmix}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Markiewicz"]
-  s.date = %q{2011-06-20}
+  s.date = %q{2011-06-22}
   s.description = %q{A Ruby gem for the StatsMix API - http://www.statsmix.com/developers}
   s.email = %q{tmarkiewicz@gmail.com}
   s.extra_rdoc_files = [
@@ -27,7 +27,8 @@ Gem::Specification.new do |s|
     "lib/statsmix.rb",
     "statsmix.gemspec",
     "test/helper.rb",
-    "test/test_statsmix.rb"
+    "test/test_statsmix.rb",
+    "test/vcr_setup.rb"
   ]
   s.homepage = %q{http://github.com/tmarkiewicz/statsmix}
   s.licenses = ["MIT"]
@@ -36,7 +37,8 @@ Gem::Specification.new do |s|
   s.summary = %q{A Ruby gem for the StatsMix API.}
   s.test_files = [
     "test/helper.rb",
-    "test/test_statsmix.rb"
+    "test/test_statsmix.rb",
+    "test/vcr_setup.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/test_statsmix.rb

@@ -1,11 +1,62 @@
 require 'helper'
 require 'statsmix'
 
-class TestStatsmix < Test::Unit::TestCase  
+class TestStatsmix < Test::Unit::TestCase
+  
+  # TODO use fakwweb gem for testing
+  # http://technicalpickles.com/posts/stop-net-http-dead-in-its-tracks-with-fakeweb/
+  # https://github.com/chrisk/fakeweb
+  # http://fakeweb.rubyforge.org/
+  
+  # TODO use VCR for tests
+  # http://www.rubyinside.com/vcr-a-recorder-for-all-your-tests-http-interactions-4169.html
+  # https://github.com/myronmarston/vcr
+  
   should "initialize StatsMix API" do
-    # TODO setup a test account to be used for live testing of API
-    
-    # statsmix = StatsMix.new('api_key', 'xml')
-    # statsmix.list_metrics(11, 3)
+    statsmix = StatsMix.new('59f08613db2691f28afe', 'xml')
+    response = statsmix.list_metrics
+    puts response
   end
-end
+  
+  # # metrics
+  # should "create metric" do
+  #   
+  # end
+  # 
+  # should "get metric" do
+  # 
+  # end
+  # 
+  # should "list metrics" do
+  #   
+  # end
+  # 
+  # should "update metric" do
+  #   
+  # end
+  # 
+  # should "delete metric" do
+  #   
+  # end
+
+  # # stats
+  # should "create stat" do
+  #   
+  # end
+  # 
+  # should "get stat" do
+  #   
+  # end
+  # 
+  # should "list stats" do
+  #   
+  # end
+  # 
+  # should "update stat" do
+  #   
+  # end
+  # 
+  # should "delete stat" do
+  #   
+  # end
+end

data/test/vcr_setup.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'test/unit'
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.stub_with :fakeweb
+  # c.default_cassette_options = { :record => :none }
+end
+
+class VCRTest < Test::Unit::TestCase
+  def test_example_dot_com
+    VCR.use_cassette('synopsis') do
+      response = Net::HTTP.get_response(URI('http://www.iana.org/domains/example/'))
+      assert_match /Example Domains/, response.body
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: statsmix
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Tom Markiewicz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-20 00:00:00 -06:00
+date: 2011-06-22 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,6 +99,7 @@ files:
 - statsmix.gemspec
 - test/helper.rb
 - test/test_statsmix.rb
+- test/vcr_setup.rb
 has_rdoc: true
 homepage: http://github.com/tmarkiewicz/statsmix
 licenses: 
@@ -136,3 +137,4 @@ summary: A Ruby gem for the StatsMix API.
 test_files: 
 - test/helper.rb
 - test/test_statsmix.rb
+- test/vcr_setup.rb