statsmix 0.1.10 → 0.2.1

data/README.md

@@ -1,4 +1,4 @@
-A Ruby gem for the StatsMix API - http://www.statsmix.com/developers
+A Ruby gem for the StatsMix API - [http://www.statsmix.com/developers](http://www.statsmix.com/developers)
 
 ## What is StatsMix?
 
@@ -8,12 +8,14 @@ StatsMix makes it easy to track, chart, and share application and business metri
 * View a real-time chart of these application events in StatsMix's web UI
 * Share the charts with users inside and outside your organization
 * Create and share custom dashboards that aggregate multiple metrics together
-    * Example dashboard: http://www.statsmix.com/d/0e788d59208900e7e3bc
-    * Example embedded dashboard: http://www.statsmix.com/example-embedded
+    * Example dashboard: [http://www.statsmix.com/d/0e788d59208900e7e3bc](http://www.statsmix.com/d/0e788d59208900e7e3bc)
+    * Example embedded dashboard: [http://www.statsmix.com/example-embedded](http://www.statsmix.com/example-embedded)
 
-To get started, you'll need an API key for StatsMix. You can get a free developer account here: http://www.statsmix.com/try?plan=developer
+To get started, you'll need an API key for StatsMix. You can get a free developer account here: [http://www.statsmix.com/try?plan=developer](http://www.statsmix.com/try?plan=developer)
 
-Full gem documentation is at  http://www.statsmix.com/developers/ruby_gem
+Full gem documentation is at  [http://www.statsmix.com/developers/ruby_gem](http://www.statsmix.com/developers/ruby_gem)
+
+Partner API documentation is at [http://www.statsmix.com/developers/partner_api](http://www.statsmix.com/developers/partner_api)
 
 ## Quick Start
 
@@ -57,7 +59,19 @@ To redirect all stats in dev environment to a test metric:
 
 ## More Documentation
 
-The StatsMix gem supports all the methods documented at http://www.statsmix.com/developers/documentation
+The StatsMix gem supports all the methods documented at [http://www.statsmix.com/developers/documentation](http://www.statsmix.com/developers/documentation)
+
+## Partner API
+We recently added ALPHA-LEVEL support for our Partner API, which allows you to provision users and metrics in StatsMix. The methods are:
+
+	
+	StatsMix.create_user({}) 
+	StatsMix.update_user(id,{})  
+	StatsMix.delete_user(id) 
+
+In all cases, the affected user's api key will be available via `StatsMix.user_api_key`. You can use the api key for updating and deleting users as well. In other words, __there is no need to store another identifier besides the user's api key.__
+
+Full Partner API documentation is at [http://www.statsmix.com/developers/partner_api](http://www.statsmix.com/developers/partner_api)
 
 ## Contributing to statsmix
  

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.2.1

data/lib/statsmix.rb

@@ -14,6 +14,9 @@ class StatsMix
   # Optional: value, options {:generated_at}
   # Returns: Net::HTTP object
   def self.track(name, value = nil, options = {})
+    if options.respond_to?('with_indifferent_access')
+      options = options.with_indifferent_access
+    end
     self.connect('track')
     @request_uri = @url.path + '.' + @format
     @request = Net::HTTP::Get.new(@request_uri)
@@ -23,12 +26,7 @@ class StatsMix
     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
+    self.check_meta
     return do_request
   end
   # Stats
@@ -40,6 +38,9 @@ class StatsMix
   # Use start_date and end_date as has keys in the third param to scope the date range of stats based on the generated_at timestamp of a stat
   # Returns: Net::HTTP object
   def self.list_stats(metric_id, limit = nil, options = {})
+    if options.respond_to?('with_indifferent_access')
+      options = options.with_indifferent_access
+    end
     self.connect('stats')
     @request_uri = @url.path + '.' + @format
     @request = Net::HTTP::Get.new(@request_uri)
@@ -73,26 +74,34 @@ class StatsMix
   # Optional: value, params[:generated_at, :meta]
   # Returns: Net::HTTP object
   def self.create_stat(metric_id, value = nil, params = {})
+    if params.respond_to?('with_indifferent_access')
+      params = params.with_indifferent_access
+    end
     connect('stats')
     @request_uri = @url.path + '.' + @format
     @request = Net::HTTP::Post.new(@request_uri)
     @params[:metric_id] = metric_id
-    @params.merge!(params)
     @params[:value] = value if value
+    @params.merge!(params)
+    self.check_meta
     return do_request
   end
   
   # Update stat
   # 
   # Required: stat_id
-  # Optional: value, generated_at, meta
+  # Optional: value, params[:generated_at, :meta]
   # Returns: Net::HTTP object
   def self.update_stat(stat_id, value = nil, params = {})  
+    if params.respond_to?('with_indifferent_access')
+      params = params.with_indifferent_access
+    end
     connect('stats')
     @request_uri = @url.path + '/' + stat_id.to_s + '.' + @format
     @request = Net::HTTP::Put.new(@request_uri)
+    @params[:value] = value if value
     @params.merge!(params)
-    @params[:value] = value if value != nil
+    self.check_meta
     return do_request
   end
   
@@ -144,6 +153,9 @@ class StatsMix
   # Optional: params[:profile_id, :sharing, :include_in_email]
   # Returns: Net::HTTP object
   def self.create_metric(name, params = {})
+    if params.respond_to?('with_indifferent_access')
+      params = params.with_indifferent_access
+    end
     connect('metrics')
     @params.merge!(params)
     @params[:name] = name
@@ -157,7 +169,10 @@ class StatsMix
   # Required: metric_id
   # Optional: params[:profile_id, :sharing, :include_in_email]
   # Returns: Net::HTTP object
-  def self.update_metric(metric_id, params = {})  
+  def self.update_metric(metric_id, params = {})
+    if params.respond_to?('with_indifferent_access')
+      params = params.with_indifferent_access
+    end
     connect('metrics')
     @params = [] if @params.nil?
     @params.merge!(params)
@@ -179,6 +194,82 @@ class StatsMix
     return do_request
   end
   
+  # partner api methods
+  # see http://www.statsmix.com/developers/partner_api
+  
+  # list users
+  # 
+  # Optional: none
+  # Returns: Net::HTTP object
+  def self.list_users
+    connect('partners/users')
+    @request_uri = @url.path
+    @request = Net::HTTP::Get.new(@request_uri)
+    return do_request
+  end
+  
+  # Get user
+  # 
+  # Required: id_or_api_key - id or api key of the user to get
+  # Optional: none
+  # Returns: Net::HTTP object
+  def self.get_user(id_or_api_key)
+    connect('partners/users')
+    @request_uri = @url.path + '/' + id_or_api_key.to_s + '.' + @format
+    @request = Net::HTTP::Get.new(@request_uri)
+    return do_request
+  end
+  
+  # Create user
+  # 
+  # Required: {:email => 'user@example.com'} - if the email already exists in our system, we will return the existing user
+  # Optional: :email,:name,:plan,:company,:url, :metrics[]
+  # Returns: Net::HTTP object
+  def self.create_user(params = {})
+    connect('partners/users')
+    @request_uri = @url.path + '.' + @format
+    @request = Net::HTTP::Post.new(@request_uri)
+    @params.merge!(params)
+    result = do_request
+    unless self.error
+      @user_api_key = result.scan(/<api_key>[0-9a-zA-Z]*<\/api_key>/)[0].gsub(/<\/?api_key>/,'')
+    end
+    return result
+  end
+  
+  # Update user
+  # 
+  # Required: id_or_api_key - id or api key of the user to get
+  # Optional: params with keys :email,:name,:plan,:company,:url
+  # Returns: Net::HTTP object
+  def self.update_user(id_or_api_key, params = {})  
+    connect('partners/users')
+    @request_uri = @url.path + '/' + id_or_api_key.to_s + '.' + @format
+    @request = Net::HTTP::Put.new(@request_uri)
+    @params.merge!(params)
+    result = do_request
+    unless self.error
+      @user_api_key = result.scan(/<api_key>[0-9a-zA-Z]*<\/api_key>/)[0].gsub(/<\/?api_key>/,'')
+    end
+    return result
+  end
+  
+  # Delete user
+  # 
+  # Required: id_or_api_key - id or api key of the user to get
+  # Optional: none
+  # Returns: Net::HTTP object
+  def self.delete_user(id_or_api_key)    
+    connect('partners/users')
+    @request_uri = @url.path + '/' + id_or_api_key.to_s + '.' + @format
+    @request = Net::HTTP::Delete.new(@request_uri)
+    result = do_request
+    unless self.error
+      @user_api_key = result.scan(/<api_key>[0-9a-zA-Z]*<\/api_key>/)[0].gsub(/<\/?api_key>/,'')
+    end
+    return result
+  end
+  
   # Returns: Net::HTTP object
   def self.response
     @response
@@ -212,6 +303,11 @@ class StatsMix
     @ignore
   end
   
+  #Return: string
+  def self.user_api_key
+    @user_api_key
+  end
+  
   def self.test_metric_name=(name)
     @test_metric_name = name
   end
@@ -281,13 +377,17 @@ class StatsMix
     @request = Hash.new
     @request["User-Agent"] = @user_agent
     @params = Hash.new
+    if @params.respond_to?('with_indifferent_access')
+      @params = @params.with_indifferent_access
+    end
     @params[:api_key] = @api_key
   end
   
   def self.do_request
     @error = false
     return if @ignore
-    @request.set_form_data(@params)
+    #had to add code to support properly encoding array values.  See http://blog.assimov.net/post/653645115/post-put-arrays-with-ruby-net-http-set-form-data
+    self.set_form_data(@params)
     @response = @connection.request(@request)
     if @response.is_a?(Net::HTTPClientError)
       if 'xml' == @format
@@ -302,6 +402,32 @@ class StatsMix
     end
     @response.body
   end
+  #based on http://blog.assimov.net/post/653645115/post-put-arrays-with-ruby-net-http-set-form-data
+  def self.set_form_data(params, sep = '&')
+    @request.body = params.map {|k,v|
+      if v.instance_of?(Array)
+        v.map {|e| "#{self.urlencode(k.to_s)}[]=#{urlencode(e.to_s)}"}.join(sep)
+      else
+        "#{self.urlencode(k.to_s)}=#{self.urlencode(v.to_s)}"
+      end
+    }.join(sep)
+    @request.content_type = 'application/x-www-form-urlencoded'
+  end
+
+  def self.urlencode(str)
+    str.gsub(/[^a-zA-Z0-9_\.\-]/n) {|s| sprintf('%%%02x', s[0]) }
+  end
+  
+  def self.check_meta
+    if @params[:meta] && !@params[:meta].is_a?(String) && !@params[:meta].is_a?(Hash)
+      raise "Invalid data . :meta should be a hash or a json-encoded string. You passed an object of type: #{@params[:meta].type}"
+    end
+    if @params[:meta] && !@params[:meta].is_a?(String)
+      if @params[:meta].respond_to?('to_json')
+        @params[:meta] = @params[:meta].to_json
+      end
+    end
+  end
 end
 
 StatsMix.api_from_env

data/statsmix.gemspec

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

data/test/test_statsmix.rb

@@ -12,10 +12,21 @@ 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 "Track a stat and view the results in xml" do
+  should "Track a stat and view the result in xml" do
     StatsMix.api_key = '59f08613db2691f28afe'
+    StatsMix.format = 'xml'
+    result = StatsMix.track('Ruby Gem Testing')
+    if StatsMix.error
+      raise "Error in gem: #{StatsMix.error}"
+    end
+    assert !StatsMix.error
+    puts result
+  end
+  
+  should "Track a stat and view the result in json" do
+    StatsMix.api_key = '59f08613db2691f28afe'
+    StatsMix.format = 'json'
     result = StatsMix.track('Ruby Gem Testing')
-    assert_response 200
     if StatsMix.error
       raise "Error in gem: #{StatsMix.error}"
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: statsmix
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 21
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 10
-  version: 0.1.10
+  version: 0.2.1
 platform: ruby
 authors: 
 - Tom Markiewicz
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 -06:00
+date: 2011-11-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency