mixpanel_client 3.0.0 → 3.1.0

data/README.md

@@ -21,26 +21,46 @@ or if you use a Gemfile
     client = Mixpanel::Client.new(config)
 
     data = client.request('events/properties', {
-      # Available options
-      event:     '["test-event"]',
-      name:      'hello',
+      event:     'splash features',
+      name:      'feature',
       values:    '["uno", "dos"]',
-      timezone:  '-8',
-      type:      'general',
-      unit:      'hour',
-      interval:   24,
+      type:      'unique',
+      unit:      'day',
+      interval:   7,
       limit:      5,
-      bucket:    'contents',
-      from_date: '2011-08-11',
-      to_date:   '2011-08-12',
-      on:        'properties["product_id"]',
-      where:     '1 in properties["product_id"]',
-      buckets:   '5',
-      # etc.
     })
 
     puts data.inspect
 
+## Parallel
+
+    require 'rubygems'
+    require 'mixpanel_client'
+
+    config = {api_key: 'changeme', api_secret: 'changeme', parallel: true}    
+    client = Mixpanel::Client.new(config)
+
+    first_request = client.request('events/properties', {
+    ...
+    })
+
+    second_request = client.request('events/properties', {
+    ...
+    })
+
+    third_request = client.request('events/properties', {
+    ...
+    })
+
+    ...
+    
+    client.run_parallel_requests
+    
+    puts first_request.response.handled_response
+    puts second_request.response.handled_response
+    puts third_request.response.handled_response    
+    
+
 ## Development
 List of rake tasks.
 
@@ -74,6 +94,10 @@ Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems
 
 ## Changelog
 
+
+### v3.1.0
+ * Parallel requests option.
+
 ### v.3.0.0
  * NOTE: This version breaks backwards compatibility.
  * Use a regular ruby hash instead of metaprogramming for mixpanel options.

data/lib/mixpanel/client.rb

@@ -13,7 +13,7 @@ module Mixpanel
     DATA_URI = 'https://data.mixpanel.com/api/2.0'
 
     attr_reader   :uri
-    attr_accessor :api_key, :api_secret
+    attr_accessor :api_key, :api_secret, :parallel
 
     # Configure the client
     #
@@ -25,6 +25,7 @@ module Mixpanel
     def initialize(config)
       @api_key    = config[:api_key]
       @api_secret = config[:api_secret]
+      @parallel = config[:parallel] || false
     end
 
     # Return mixpanel data as a JSON object or CSV string
@@ -47,9 +48,41 @@ module Mixpanel
     def request(resource, options)
       @format = options[:format] || :json
       @uri = URI.mixpanel(resource, normalize_options(options))
-      response = URI.get(@uri)
-      response = %Q|[#{response.split("\n").join(',')}]| if resource == 'export'
-      Utils.to_hash(response, @format)
+      if @parallel
+        parallel_request = prepare_parallel_request
+        hydra.queue parallel_request
+        parallel_request
+      else
+        response = URI.get(@uri)
+        response = %Q|[#{response.split("\n").join(',')}]| if resource == 'export'
+        Utils.to_hash(response, @format)
+      end
+    end
+
+    def prepare_parallel_request
+      request = ::Typhoeus::Request.new(@uri)
+      request.on_complete do |response|
+        if response.success?
+          Utils.to_hash(response.body, @format)
+        elsif response.timed_out?
+          raise TimeoutError
+        elsif response.code == 0
+          # Could not get an http response, something's wrong.
+          raise HTTPError, response.curl_error_message
+        else
+          # Received a non-successful http response.
+          raise HTTPError, response.body.present? ? JSON.parse(response.body)['error'] : response.code.to_s
+        end
+      end
+      request
+    end
+
+    def run_parallel_requests
+      hydra.run
+    end
+
+    def hydra
+      @hydra ||= ::Typhoeus::Hydra.new      
     end
 
     private

data/lib/mixpanel/exceptions.rb

@@ -10,5 +10,6 @@ module Mixpanel
   # URI related exceptions
   class Error < StandardError; end
   class HTTPError < Error; end
+  class TimeoutError < Error; end
   class ParseError < Error; end
 end

data/lib/mixpanel/version.rb

@@ -10,6 +10,6 @@ module Mixpanel
   # Return metrics from Mixpanel Data API
   class Client
     # Mixpanel::Client library version
-    VERSION = '3.0.0'
+    VERSION = '3.1.0'
   end
 end

data/manual_test/basic.rb

@@ -6,14 +6,13 @@ require 'yaml'
 
 config = YAML.load_file(File.dirname(__FILE__) + '/../config/mixpanel.yml')['mixpanel']
 
-client = Mixpanel::Client.new(config)
+client = Mixpanel::Client.new({api_key: config['api_key'], api_secret: config['api_secret']})
 
-data = client.request do
-  resource 'events/properties'
-  event    '["test-event"]'
-  type     'general'
-  unit     'hour'
-  name     'test'
-end
+data = client.request('events/properties', {
+  event:    '["test-event"]',
+  type:     'general',
+  unit:     'hour',
+  name:     'test'
+})
 
 puts data.inspect

data/manual_test/parallel.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'mixpanel_client'
+require 'yaml'
+require 'typhoeus'
+
+config = YAML.load_file(File.dirname(__FILE__) + '/../config/mixpanel.yml')['mixpanel']
+
+client = Mixpanel::Client.new({:api_key => config['api_key'], :api_secret => config['api_secret'], :parallel => true})
+
+f = client.request('events/top', {
+  :type =>     'general'
+})
+
+
+s = client.request('events/names', {
+  :type =>     'general'
+})
+
+client.run_parallel_requests
+
+puts f.response.handled_response.inspect
+puts s.response.handled_response.inspect
+

data/mixpanel_client.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
-
   s.add_runtime_dependency('json', '~> 1.6') if RUBY_VERSION < '1.9'
+  s.add_runtime_dependency('typhoeus', '~> 0.5.4')
   s.add_development_dependency('bundler', '>=1.2')
   s.add_development_dependency('rake',    '>=0.9.2.2')
   s.add_development_dependency('rdoc',    '>=3.11')
   s.add_development_dependency('rspec',   '>=2.5.0')
-  s.add_development_dependency('webmock', '>=1.6.2')
+  s.add_development_dependency('webmock', '>=1.9.0')
 end

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -10,6 +10,14 @@ describe Mixpanel::Client do
     it 'should not raise an exception if a hash is given' do
       Mixpanel::Client.new('api_key' => 'test_key', 'api_secret' => 'test_secret').should_not raise_error(ArgumentError)
     end
+
+    it 'should set a parallel option as false by default' do
+      Mixpanel::Client.new(:api_key => 'test_key', :api_secret => 'test_secret').parallel.should == false
+    end
+
+    it 'should be able to set a parallel option when passed' do
+      Mixpanel::Client.new(:api_key => 'test_key', :api_secret => 'test_secret', :parallel => true).parallel.should == true
+    end
   end
 
   context 'when making an invalid request' do
@@ -50,6 +58,76 @@ describe Mixpanel::Client do
       })
       data.should == {"events"=>[], "type"=>"general"}
     end
+
+    context "with parallel option enabled" do
+      before :all do
+        @parallel_client = Mixpanel::Client.new(:api_key => 'test_key', :api_secret => 'test_secret', :parallel => true)
+      end
+
+      it "should return Typhoeus::Request" do
+        # Stub Mixpanel request
+        stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"legend_size": 0, "data": {"series": [], "values": {}}}')
+
+        # No endpoint
+        data = @parallel_client.request('events', {
+          :event    => '["test-event"]',
+          :unit     => 'hour',
+          :interval => 24
+        })
+        data.should be_a Typhoeus::Request
+      end
+
+      describe '#hydra' do
+        it 'should return a Typhoeus::Hydra object' do     
+          @parallel_client.hydra.should be_a Typhoeus::Hydra  
+        end 
+      end
+
+      describe '#run_parallel_requests' do
+        it 'should run queued requests' do
+          # Stub Mixpanel request
+          stub_request(:any, /^#{@uri}.*/).to_return(:body => '{"legend_size": 1, "data": {"series": ["2010-05-29","2010-05-30","2010-05-31"], 
+                                                                                         "values": {
+                                                                                            "account-page": {"2010-05-30": 1},
+                                                                                            "splash features": {"2010-05-29": 6,
+                                                                                                                "2010-05-30": 4,
+                                                                                                                "2010-05-31": 5
+                                                                                                               }
+                                                                                         }
+                                                                                        }
+                                                             }')
+
+
+          stub_request(:any, /^#{@uri}.*secondevent.*/).to_return(:body => '{"legend_size": 2, "data": {"series": ["2010-05-29","2010-05-30","2010-05-31"], 
+                                                                                         "values": {
+                                                                                            "account-page": {"2010-05-30": 2},
+                                                                                            "splash features": {"2010-05-29": 8,
+                                                                                                                "2010-05-30": 6,
+                                                                                                                "2010-05-31": 7
+                                                                                                               }
+                                                                                         }
+                                                                                        }
+                                                             }')
+
+          first_request = @parallel_client.request('events', {
+            :event    => '["firstevent"]',
+            :unit     => 'day'
+          })
+
+
+          second_request = @parallel_client.request('events', {
+            :event    => '["secondevent"]',
+            :unit     => 'day'
+          })
+
+          @parallel_client.run_parallel_requests
+
+          first_request.response.handled_response.should == {"data"=>{"series"=>["2010-05-29", "2010-05-30", "2010-05-31"], "values"=>{"splash features"=>{"2010-05-29"=>6, "2010-05-30"=>4, "2010-05-31"=>5}, "account-page"=>{"2010-05-30"=>1}}}, "legend_size"=>1}
+
+          second_request.response.handled_response.should == {"data"=>{"series"=>["2010-05-29", "2010-05-30", "2010-05-31"], "values"=>{"splash features"=>{"2010-05-29"=>8, "2010-05-30"=>6, "2010-05-31"=>7}, "account-page"=>{"2010-05-30"=>2}}}, "legend_size"=>2}
+        end
+      end
+    end
   end
 
   describe '#hash_args' do
@@ -65,4 +143,5 @@ describe Mixpanel::Client do
       Mixpanel::Client::Utils.to_hash('{"a" : "ey", "b" : "bee"}', :json).should == {'a' => 'ey', 'b' => 'bee'}
     end
   end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel_client
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 3
+  - 1
   - 0
-  - 0
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors: 
 - Keolo Keagy
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-22 00:00:00 Z
+date: 2013-02-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -33,9 +33,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: typhoeus
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 5
+        - 4
+        version: 0.5.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,11 +62,11 @@ dependencies:
         - 2
         version: "1.2"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -63,11 +79,11 @@ dependencies:
         - 2
         version: 0.9.2.2
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rdoc
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -78,11 +94,11 @@ dependencies:
         - 11
         version: "3.11"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -94,23 +110,23 @@ dependencies:
         - 0
         version: 2.5.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 51
         segments: 
         - 1
-        - 6
-        - 2
-        version: 1.6.2
+        - 9
+        - 0
+        version: 1.9.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 description: Simple ruby client interface to the Mixpanel API.
 email: 
 - keolo@dreampointmedia.com
@@ -136,6 +152,7 @@ files:
 - lib/mixpanel/version.rb
 - lib/mixpanel_client.rb
 - manual_test/basic.rb
+- manual_test/parallel.rb
 - mixpanel_client.gemspec
 - spec/mixpanel_client/events_externalspec.rb
 - spec/mixpanel_client/mixpanel_client_spec.rb