statsmix 0.0.6 → 0.1.3

data/README.rdoc

@@ -8,6 +8,38 @@ StatsMix makes it easy to track, chart, and share application and business metri
 
 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
 
+Detail documentation is at  http://www.statsmix.com/developers/ruby_gem
+
+== Quick Start ==
+
+require "statsmix"
+StatsMix.api_key = "YOUR API KEY"
+
+#push a stat with the value 1 (default) to a metric called "My First Metric"
+StatsMix.track("My First Metric")
+
+#push the value 20
+StatsMix.track("My First Metric",20)
+
+#add metadata - you can use this to add granularity to your chart via Chart Settings in StatsMix
+#this example tracks file uploads by file type
+StatsMix.track("File Uploads", 1, {:meta => {"file type" => "PDF"}})
+
+#if you need the ability to update a stat after the fact, you can pass in a unique identifier ref_id (scoped to that metric)
+StatsMix.track("File Uploads", 1, {:ref_id => "abc123", :meta => {"file type" => "PDF"}})
+
+#if you need to timestamp the stat for something other than now, pass in a UTC datetime called generated_at
+StatsMix.track("File Uploads", 1, {:generated_at => 1.days.ago })
+
+#to turn off tracking in your development environment
+StatsMix.ignore = true
+
+#to redirect all stats in dev environment to a test metric
+StatsMix.test_metric_name = "My Test Metric"
+
+== More Documentation ==
+
+The StatsMix gem supports all the methods documented at http://www.statsmix.com/developers/documentation
 
 == Contributing to statsmix
  

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.license = "MIT"
   gem.summary = %Q{A Ruby gem for the StatsMix API.}
   gem.description = %Q{A Ruby gem for the StatsMix API - http://www.statsmix.com/developers}
-  gem.email = "tmarkiewicz@gmail.com"
-  gem.authors = ["Tom Markiewicz"]
+  gem.email = ["tmarkiewicz@gmail.com","me@derekscruggs.com"]
+  gem.authors = ["Tom Markiewicz","Derek Scruggs"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.3

data/lib/statsmix.rb

@@ -1,128 +1,102 @@
 require 'net/http'
+require 'rubygems'
+require 'json'
 
 class StatsMix
   
-  BASE_URI = 'http://www.statsmix.com/api/v2/'
-  # BASE_URI = 'http://localhost:3000/api/v2/'
+  BASE_URI = 'https://statsmix.com/api/v2/'
   
   GEM_VERSION = File.exist?('../VERSION') ? File.read('../VERSION') : ""
-  
-  def initialize(api_key, format = 'xml')
-    @api_key = api_key
-    @format = format
-    @user_agent = "StatsMix Ruby Gem " + GEM_VERSION
-  end
-  
-  def connect(resource)
-    # Resources available: stats, metrics, TODO: profiles
-    @url = URI.parse(BASE_URI + resource)
-    @connection = Net::HTTP.new(@url.host, @url.port)
-    
+
+  # Track an event
+  # 
+  # Required: name of metric
+  # Optional: value, options {:generated_at}
+  # Returns: Net::HTTP object
+  def self.track(name, value = nil, options = {})
+    self.connect('track')
+    @request_uri = @url.path + '.' + @format
+    @request = Net::HTTP::Get.new(@request_uri)
+    @params[:name] = name
+    if @test_metric_name
+      @params[:name] = @test_metric_name
+    end
+    @params[:value] = value if value != nil
+    @params.merge!(options)
+    @params[:meta] =
+    if @params[:meta] && !@params[:meta].is_a?(String)
+      if @params[:meta].respond_to?('to_json')
+        @params[:meta] = @params[:meta].to_json
+      end
+    end
+    return do_request
   end
-  
   # Stats
   
   # List stats (index)
   # 
   # Required: metric_id
   # Optional: limit
-  def list_stats(metric_id, limit = nil)
-    connect('stats')
-    request = Net::HTTP::Get.new(@url.path + '.' + @format)
-    request["User-Agent"] = @user_agent
-    
-    form_hash = Hash.new
-    form_hash["api_key"] = @api_key
-    form_hash["metric_id"] = metric_id
-    if limit != nil
-      form_hash["limit"] = limit
-    end
-    
-    request.set_form_data(form_hash)
-    
-    response = @connection.request(request)
-    return response.body
+  # Returns: Net::HTTP object
+  def self.list_stats(metric_id, limit = nil)
+    self.connect('stats')
+    @request_uri = @url.path + '.' + @format
+    @request = Net::HTTP::Get.new(@request_uri)
+    @params[:metric_id] = metric_id
+    @params[:limit] = limit if limit != nil
+    return do_request
   end
   
   # Get stat
   # 
   # Required: stat_id
   # Optional: none
-  def get_stat(stat_id)
+  # Returns: Net::HTTP object
+  def self.get_stat(stat_id)
     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 = @connection.request(request)
-    return response.body
+    @request_uri = @url.path + '/' + stat_id.to_s + '.' + @format
+    @request = Net::HTTP::Get.new(@request_uri)
+    return do_request
   end
   
   # Create stat
   # 
   # Required: metric_id
-  # Optional: value, generated_at, meta
-  def create_stat(metric_id, value = 1, generated_at = Time.now, meta = nil)
+  # Optional: value, params[:generated_at, :meta]
+  # Returns: Net::HTTP object
+  def self.create_stat(metric_id, value = nil, params = {})
     connect('stats')
-    request = Net::HTTP::Post.new(@url.path + '.' + @format)
-    request["User-Agent"] = @user_agent
-
-    form_hash = Hash.new
-    form_hash["api_key"] = @api_key
-    form_hash["value"] = value
-    form_hash["metric_id"] = metric_id
-    form_hash["generated_at"] = generated_at
-    if meta != nil
-      form_hash["meta"] = meta
-    end
-    
-    request.set_form_data(form_hash)
-    
-    response = @connection.request(request)
-    return response.body
+    @request_uri = @url.path + '.' + @format
+    @request = Net::HTTP::Post.new(@request_uri)
+    @params.merge!(params)
+    @params[:value] = value if value
+    return do_request
   end
   
   # Update stat
   # 
   # Required: stat_id
   # Optional: value, generated_at, meta
-  def update_stat(stat_id, value = nil, generated_at = nil, meta = nil)  
+  # Returns: Net::HTTP object
+  def self.update_stat(stat_id, value = nil, params = {})  
     connect('stats')
-    request = Net::HTTP::Put.new(@url.path + '/' + stat_id.to_s + '.' + @format)
-    request["User-Agent"] = @user_agent
-
-    form_hash = Hash.new
-    form_hash["api_key"] = @api_key
-    if value != nil
-      form_hash["value"] = value
-    end
-    if generated_at != nil
-      form_hash["generated_at"] = generated_at
-    end
-    if meta != nil
-      form_hash["meta"] = meta
-    end
-    
-    request.set_form_data(form_hash)
-
-    response = @connection.request(request)
-    return response.body
+    @request_uri = @url.path + '/' + stat_id.to_s + '.' + @format
+    @request = Net::HTTP::Put.new(@request_uri)
+    @params.merge!(params)
+    @params[:value] = value if value != nil
+    return do_request
   end
   
   # Delete stat
   # 
   # Required: stat_id
   # Optional: none
-  def delete_stat(stat_id)    
+  # Returns: Net::HTTP object
+  def self.delete_stat(stat_id)    
     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 = @connection.request(request)
-    return response.body
+    @request_uri = @url.path + '/' + stat_id.to_s + '.' + @format
+    @request = Net::HTTP::Delete.new(@request_uri)
+    return do_request
   end
   
   # Metrics
@@ -131,102 +105,194 @@ class StatsMix
   # 
   # Required: none
   # Optional: profile_id, limit
-  def list_metrics(profile_id = nil, limit = nil)
+  # Returns: Net::HTTP object
+  def self.list_metrics(profile_id = nil, limit = nil)
     connect('metrics')
-    request = Net::HTTP::Get.new(@url.path + '.' + @format)
-    request["User-Agent"] = @user_agent
-    
-    form_hash = Hash.new
-    form_hash["api_key"] = @api_key
-    if profile_id != nil
-      form_hash["profile_id"] = profile_id
-    end
-    if limit != nil
-      form_hash["limit"] = limit
-    end
-    
-    request.set_form_data(form_hash)
+    @request_uri = @url.path + '.' + @format
+    @request = Net::HTTP::Get.new(@request_uri)
+
+    @params[:profile_id] = profile_id if profile_id  != nil
+    @params[:limit] = limit if limit != nil
     
-    response = @connection.request(request)
-    return response.body
+    return do_request
   end
   
   # Get metric
   # 
   # Required: metric_id
   # Optional: none
-  def get_metric(metric_id)
+  # Returns: Net::HTTP object
+  def self.get_metric(metric_id)
     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 = @connection.request(request)
-    return response.body
+    @request_uri = @url.path + '/' + metric_id.to_s + '.' + @format
+    @request = Net::HTTP::Get.new(@request_uri)
+    return do_request
   end
   
   # Create metric
   # 
   # Required: name
-  # Optional: profile_id, generated_at
-  def create_metric(name, profile_id = nil)
+  # Optional: params[:profile_id, :sharing, :include_in_email]
+  # Returns: Net::HTTP object
+  def self.create_metric(name,params={})
     connect('metrics')
-    request = Net::HTTP::Post.new(@url.path + '.' + @format)
-    request["User-Agent"] = @user_agent
-
-    form_hash = Hash.new
-    form_hash["api_key"] = @api_key
-    form_hash["name"] = name
-    if profile_id != nil
-      form_hash["profile_id"] = profile_id
-    end
-    
-    request.set_form_data(form_hash)
-    
-    response = @connection.request(request)
-    return response.body
+    @params.merge!(params)
+    @params[:name] = name
+    @request_uri = @url.path + '.' + @format
+    @request = Net::HTTP::Post.new(@request_uri)
+    return do_request
   end
   
   # Update metric
   # 
   # Required: metric_id
-  # Optional: name, sharing, include_in_email
-  def update_metric(metric_id, name = nil, sharing = nil, include_in_email = nil)  
+  # Optional: params[:profile_id, :sharing, :include_in_email]
+  # Returns: Net::HTTP object
+  def self.update_metric(metric_id, params = {})  
     connect('metrics')
-    request = Net::HTTP::Put.new(@url.path + '/' + metric_id.to_s + '.' + @format)
-    request["User-Agent"] = @user_agent
-
-    form_hash = Hash.new
-    form_hash["api_key"] = @api_key
-    if name != nil
-      form_hash["name"] = name
-    end
-    if sharing != nil
-      form_hash["sharing"] = sharing
-    end
-    if include_in_email != nil
-      form_hash["include_in_email"] = include_in_email
-    end
-    
-    request.set_form_data(form_hash)
+    @params = [] if @params.nil?
+    @params.merge!(params)
+    @request_uri = @url.path + '/' + metric_id.to_s + '.' + @format
+    @request = Net::HTTP::Put.new(@request_uri)
 
-    response = @connection.request(request)
-    return response.body
+    return do_request
   end
   
   # Delete metric
   # 
   # Required: metric_id
   # Optional: none
-  def delete_metric(metric_id)    
+  # Returns: Net::HTTP object
+  def self.delete_metric(metric_id)    
     connect('metrics')
-    request = Net::HTTP::Delete.new(@url.path + '/' + metric_id.to_s + '.' + @format)
-    request["User-Agent"] = @user_agent
+    @request_uri = @url.path + '/' + metric_id.to_s + '.' + @format
+    @request = Net::HTTP::Delete.new(@request_uri)
+    return do_request
+  end
+  
+  def initialize(api_key = nil)
+    self.setup(api_key)
+  end
+  
+  # Returns: Net::HTTP object
+  def self.response
+    @response
+  end
+  
+  # Returns: string or boolean false
+  def self.error
+    @error
+  end
+  
+  # Returns: hash
+  def self.params
+    @params
+  end
+  
+  def self.api_key=(string)
+    @api_key = string
+  end
+  
+  # Returns: string
+  def self.api_key
+    @api_key
+  end
+  
+  def self.ignore=(boolean)
+    @ignore = boolean ? true : false
+  end
+  
+  #Returns: boolean
+  def self.ignore
+    @ignore
+  end
+  
+  def self.test_metric_name=(name)
+    @test_metric_name = name
+  end
+  
+  #Returns: string or nil
+  def self.test_metric_name
+    @test_metric_name
+  end
+  
+  # Returns: string
+  def self.api_key
+    @api_key
+  end
+  
+  def self.api_from_env
+    return nil if ENV['STATSMIX_URL'].nil?
+    url = ENV['STATSMIX_URL']
+    pieces = url.gsub('http://','').gsub('https://','').split('/')
+    @api_key = pieces[2]
+  end
+  
+  def self.format=(string)
+    string.downcase!
+    if string != 'json' && string != 'xml'
+      raise "format MUST be either xml or json"
+    end
+    @format = string
+  end
+  
+  # Returns: string
+  def self.format
+    @format
+  end
+  
+  # Returns: string
+  def self.request_uri
+    @request_uri
+  end
+  private
+  
+  def self.setup(api_key = nil)
+    return if @initiliazed
+    if !api_key.nil?
+      @api_key = api_key
+    end
+    @format = 'xml' if @format.nil?
+    @ignore = false if @ignore.nil?
+    @user_agent = "StatsMix Ruby Gem " + GEM_VERSION
+    @initiliazed = true
+    @error = false
+  end
+  
+  def self.connect(resource)
+    self.setup
     
-    request.set_form_data({"api_key" => @api_key})
+    if @api_key.nil?
+      raise "API key not set. You must set it frist with StatsMix.api_key = [your api key]"
+    end
+    # Resources available: stats, metrics, TODO: profiles
+    @url = URI.parse(BASE_URI + resource)
+    @connection = Net::HTTP.new(@url.host, @url.port)
     
-    response = @connection.request(request)
-    return response.body
+    @request = Hash.new
+    @request["User-Agent"] = @user_agent
+    @params = Hash.new
+    @params[:api_key] = @api_key
   end
-end
+  
+  def self.do_request
+    @error = false
+    return if @ignore
+    @request.set_form_data(@params)
+    @response = @connection.request(@request)
+    if @response.is_a?(Net::HTTPClientError)
+      if 'xml' == @format
+        begin
+          @error = @response.body.match('<error>(.)+</error>')[0].gsub('<error>','').gsub('</error>','')
+        rescue
+          @error = 'Unable to parse error message. Check StatsMix.response for more information'
+        end
+      else
+        @error = JSON.parse(@response.body)['errors']['error']
+      end
+    end
+    @response.body
+  end
+end
+
+StatsMix.api_from_env

data/statsmix.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{statsmix}
-  s.version = "0.0.6"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Tom Markiewicz"]
-  s.date = %q{2011-06-22}
+  s.authors = ["Tom Markiewicz", "Derek Scruggs"]
+  s.date = %q{2011-07-05}
   s.description = %q{A Ruby gem for the StatsMix API - http://www.statsmix.com/developers}
-  s.email = %q{tmarkiewicz@gmail.com}
+  s.email = ["tmarkiewicz@gmail.com", "me@derekscruggs.com"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"

data/test/test_statsmix.rb

@@ -3,7 +3,7 @@ require 'statsmix'
 
 class TestStatsmix < Test::Unit::TestCase
   
-  # TODO use fakwweb gem for testing
+  # 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/
@@ -12,51 +12,16 @@ class TestStatsmix < Test::Unit::TestCase
   # 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
-    statsmix = StatsMix.new('59f08613db2691f28afe', 'xml')
-    response = statsmix.list_metrics
-    puts response
+  should "Track a stat and view the results in xml" do
+    StatsMix.api_key = '59f08613db2691f28afe'
+    result = StatsMix.track('Ruby Gem Testing')
+    assert_response 200
+    if StatsMix.error
+      raise "Error in gem: #{StatsMix.error}"
+    end
+    assert !StatsMix.error
+    puts result
   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

metadata

@@ -1,28 +1,26 @@
 --- !ruby/object:Gem::Specification 
 name: statsmix
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 29
   prerelease: false
   segments: 
   - 0
-  - 0
-  - 6
-  version: 0.0.6
+  - 1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Tom Markiewicz
+- Derek Scruggs
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-06-22 00:00:00 -06:00
+date: 2011-07-05 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  name: shoulda
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,12 +29,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
   type: :development
+  name: shoulda
   prerelease: false
-  name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +45,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
   type: :development
+  name: bundler
   prerelease: false
-  name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +61,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   type: :development
+  name: jeweler
   prerelease: false
-  name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,9 +75,14 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id004
 description: A Ruby gem for the StatsMix API - http://www.statsmix.com/developers
-email: tmarkiewicz@gmail.com
+email: 
+- tmarkiewicz@gmail.com
+- me@derekscruggs.com
 executables: []
 
 extensions: []