mixpanel_client 0.2.0 → 0.2.2

data/README.md

@@ -1,20 +1,18 @@
-# Ruby Mixpanel API Client                                                                                           
+# Ruby Mixpanel API Client
 
-Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool. 
+Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
 
 ## Installation
-    # If you don't already have gemcutter as a rubygems source
-    gem install gemcutter
-    gem tumble
-
-    gem install mixpanel_client
+    $ gem install mixpanel_client
 
 ## Example Usage
     require 'rubygems'
     require 'mixpanel_client'
 
-    config = {:api_key => 'changeme123', :api_secret => '123changeme'}
+    config = {:api_key => 'changeme', :api_secret => 'changeme'}
+
     api = Mixpanel::Client.new(config)
+
     data = api.request(:events, :general, {
       :event    => '["test-event"]',
       :unit     => 'hour',

data/Rakefile

@@ -4,19 +4,19 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "mixpanel_client"
+    gem.name = 'mixpanel_client'
     gem.summary = 'Ruby Mixpanel API Client Library'
     gem.description = 'Simple ruby client interface to the Mixpanel API.'
-    gem.email = "keolo@dreampointmedia.com"
-    gem.homepage = "http://github.com/keolo/mixpanel_client"
-    gem.authors = ["Keolo Keagy"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "cucumber", ">= 0"
+    gem.email = 'keolo@dreampointmedia.com'
+    gem.homepage = 'http://github.com/keolo/mixpanel_client'
+    gem.authors = ['Keolo Keagy']
+    gem.add_development_dependency 'rspec', '>= 1.2.9'
+    gem.add_development_dependency 'cucumber', '>= 0'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
 end
 
 require 'spec/rake/spectask'
@@ -40,7 +40,7 @@ begin
   task :features => :check_dependencies
 rescue LoadError
   task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+    abort 'Cucumber is not available. In order to run features, you must: sudo gem install cucumber'
   end
 end
 
@@ -48,7 +48,7 @@ task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "mixpanel_client #{version}"

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.2

data/lib/mixpanel_client.rb

@@ -12,8 +12,6 @@
 require 'cgi'
 require 'digest/md5'
 require 'open-uri'
-require 'rubygems'
-require 'json'
 
 module Mixpanel
   class Client
@@ -28,14 +26,13 @@ module Mixpanel
     end
 
     def request(endpoint, meth, params)
-      params[:api_key]  = api_key
-      params[:expire]   = Time.now.to_i + 600 # Grant this request 10 minutes
-      params[:format] ||= :json
-      params[:sig]      = hash_args(params)
+      params[:api_key] = api_key
+      params[:expire]  = Time.now.to_i + 600 # Grant this request 10 minutes
+      params[:sig]     = hash_args(params)
 
       @format = params[:format]
 
-      response = URI.parse(mixpanel_uri(endpoint, meth, params)).read
+      response = get(mixpanel_uri(endpoint, meth, params))
       to_hash(response)
     end
 
@@ -43,6 +40,10 @@ module Mixpanel
       Digest::MD5.hexdigest(args.map{|k,v| "#{k}=#{v}"}.sort.to_s + api_secret)
     end
 
+    def get(uri)
+      URI.parse(uri).read
+    end
+
     def mixpanel_uri(endpoint, meth, params)
       %Q(#{BASE_URI}/#{endpoint}/#{VERSION}/#{meth}?#{urlencode(params)})
     end
@@ -51,12 +52,14 @@ module Mixpanel
       params.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.sort.join('&')
     end
 
-    protected
-      def to_hash(data)
-        case @format
-        when :json
-          JSON.parse(data)
-        end
+    def to_hash(data)
+      case @format
+      when :xml
+        # TODO: xml parsing
+      else :json
+        require 'json' unless defined?(JSON)
+        JSON.parse(data)
       end
+    end
   end
 end

data/mixpanel_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mixpanel_client}
-  s.version = "0.2.0"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Keolo Keagy"]
-  s.date = %q{2009-12-02}
+  s.date = %q{2010-01-13}
   s.description = %q{Simple ruby client interface to the Mixpanel API.}
   s.email = %q{keolo@dreampointmedia.com}
   s.extra_rdoc_files = [

data/spec/mixpanel_client_spec.rb

@@ -1,3 +1,5 @@
+require 'rubygems'
+
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe 'Mixpanel::Client' do
@@ -7,14 +9,16 @@ describe 'Mixpanel::Client' do
   end
 
   describe '#request' do
-    it 'should return a valid JSON result set.' do
-      pending 'Need to setup valid Mixpanel test account.'
+    it 'should return json and convert to a ruby hash' do
+      # Stub Mixpanel web service
+      @api.stub!(:get).and_return('{"some" : "thing"}')
+
       data = @api.request(:events, :general, {
         :event    => '["test-event"]',
         :unit     => 'hour',
         :interval =>  24
       })
-      data.should == {:some => 'thing'}
+      data.should == {'some' => 'thing'}
     end
   end
 
@@ -39,4 +43,10 @@ describe 'Mixpanel::Client' do
       @api.urlencode(params).should == 'hey=%21%40%23%24%25%5E%26%2A%28%29%5C%2F%22%C3%9C&soo=h%C3%ABll%C3%B6%3F'
     end
   end
+
+  describe '#to_hash' do
+    it 'should return a ruby hash given json as a string' do
+      @api.to_hash('{"a" : "aye", "b" : "bee"}').should == {'a' => 'aye', 'b' => 'bee'}
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel_client
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors: 
 - Keolo Keagy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-02 00:00:00 -08:00
+date: 2010-01-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency