mixpanel_client 3.1.2 → 3.1.3

data/README.md

@@ -32,6 +32,16 @@ or if you use a Gemfile
 
     puts data.inspect
 
+
+    # use the import API, which allows one to specify a time in the past, unlike the track API.
+    # note that you need to include your api token in the data. More details at:
+    # https://mixpanel.com/docs/api-documentation/importing-events-older-than-31-days
+    data_to_import = {'event' => 'firstLogin', 'properties' => {'distinct_id' => guid, 'time' => time_as_integer_seconds_since_epoch, 'token' => api_token}}
+    require 'base64' # co-located with the Base64 call below for clarity
+    encoded_data = Base64.encode64(data_to_import.to_json)
+    data = client.request('import', {:data => encoded_data, :api_key => api_key})
+    # data == [1] # => true # you can only import one event at a time
+
 ## Parallel
 
     require 'rubygems'
@@ -94,6 +104,10 @@ Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems
 
 ## Changelog
 
+### v3.1.3
+ * 	Added support for the import API.
+ * 	Allow setting of custom expiry.
+
 ### v3.1.2
  * Gem updates
 
@@ -164,7 +178,8 @@ Feel free to add your name and link here.
 [Grzegorz Forysinski](http://github.com/railwaymen)  
 [Nathan Chong](http://github.com/paramaw)  
 [Paul McMahon](http://github.com/pwim)  
-[Chad Etzel](http://github.com/jazzychad)
+[Chad Etzel](http://github.com/jazzychad)  
+[Kevin Burnett](http://github.com/burnettk)  
 
 ## Copyright
 

data/lib/mixpanel/client.rb

@@ -11,6 +11,7 @@ module Mixpanel
   class Client
     BASE_URI = 'https://mixpanel.com/api/2.0'
     DATA_URI = 'https://data.mixpanel.com/api/2.0'
+    IMPORT_URI = 'https://api.mixpanel.com'
 
     attr_reader   :uri
     attr_accessor :api_key, :api_secret, :parallel
@@ -53,7 +54,7 @@ module Mixpanel
         parallel_request
       else
         response = URI.get(@uri)
-        response = %Q|[#{response.split("\n").join(',')}]| if resource == 'export'
+        response = %Q|[#{response.split("\n").join(',')}]| if %w(export import).include?(resource)
         Utils.to_hash(response, @format)
       end
     end
@@ -103,7 +104,7 @@ module Mixpanel
     end
 
     def hydra
-      @hydra ||= ::Typhoeus::Hydra.new      
+      @hydra ||= ::Typhoeus::Hydra.new
     end
 
     private
@@ -116,12 +117,18 @@ module Mixpanel
       normalized_options.merge!(
         :format  => @format,
         :api_key => @api_key,
-        :expire  => Time.now.to_i + 600 # Grant this request 10 minutes
+        :expire  => options[:expire] ? options[:expire].to_i : Time.now.to_i + 600
       ).merge!(:sig => Utils.generate_signature(normalized_options, @api_secret))
     end
 
     def self.base_uri_for_resource(resource)
-      resource == 'export' ? DATA_URI : BASE_URI
+      if resource == 'export'
+        DATA_URI
+      elsif resource == 'import'
+        IMPORT_URI
+      else
+        BASE_URI
+      end
     end
   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.1.2'
+    VERSION = '3.1.3'
   end
 end

data/mixpanel_client.gemspec

@@ -3,6 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 require 'mixpanel/version'
 
 Gem::Specification.new do |s|
+  s.license     = 'MIT'
   s.name        = 'mixpanel_client'
   s.version     = Mixpanel::Client::VERSION
   s.platform    = Gem::Platform::RUBY

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -48,6 +48,18 @@ describe Mixpanel::Client do
       data.should == {"data"=>{"series"=>[], "values"=>{}}, "legend_size"=>0}
     end
 
+    it 'should work when it receives an integer response on import' do
+      @import_uri = Regexp.escape(Mixpanel::Client::IMPORT_URI)
+      # Stub Mixpanel import request to return a realistic response
+      stub_request(:get, /^#{@import_uri}.*/).to_return(:body => '1')
+
+      data = @client.request('import', {
+        :data    => 'base64_encoded_data',
+        :api_key => 'test_key'
+      })
+      data.should == [1]
+    end
+
     it 'should work with an endpoint, method, and type' do
       # Stub Mixpanel request
       stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"events": [], "type": "general"}')
@@ -68,6 +80,32 @@ describe Mixpanel::Client do
       }.to_not change { options }
     end
 
+    context 'with a custom expiry time' do
+      # Stub Mixpanel request
+      before { stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"events": [], "type": "general"}') }
+      let(:expiry)   { Time.now + 100000 }
+      let(:fake_url) { Mixpanel::Client::BASE_URI }
+
+      specify 'Client#request should return a hash with empty events and type' do
+        # With endpoint
+        data = @client.request('events/top', {
+          :type   => 'general',
+          :expire => expiry
+        })
+        data.should == {"events"=>[], "type"=>"general"}
+      end
+
+      specify 'Mixpanel::URI instance should receive the custom expiry time in the options[:expiry] instead of 600s' do
+        Mixpanel::URI.should_receive(:mixpanel).with do |*args|
+          args.pop[:expire].should == expiry.to_i
+          true
+        end.and_return(fake_url)
+        @client.request('events/top', {
+          :type   => 'general',
+          :expire => expiry
+        })
+      end
+    end
 
     context "with parallel option enabled" do
       before :all do

data/spec/mixpanel_client/uri_spec.rb

@@ -15,6 +15,10 @@ describe Mixpanel::URI do
       resource, params  = ['export', {:c => 'see', :a => 'ey'}]
       Mixpanel::URI.mixpanel(resource, params).should == "#{Mixpanel::Client::DATA_URI}/export?a=ey&c=see"
     end
+    it 'should return a uri with a the correct endpoint when doing an import' do
+      resource, params  = ['import', {:c => 'see', :a => 'ey'}]
+      Mixpanel::URI.mixpanel(resource, params).should == "#{Mixpanel::Client::IMPORT_URI}/import?a=ey&c=see"
+    end
   end
 
   describe '.encode' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel_client
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2014-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
-  requirement: &70317251021340 !ruby/object:Gem::Requirement
+  requirement: &70291980662280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.5.4
   type: :runtime
   prerelease: false
-  version_requirements: *70317251021340
+  version_requirements: *70291980662280
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70317251020820 !ruby/object:Gem::Requirement
+  requirement: &70291980661760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70317251020820
+  version_requirements: *70291980661760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70317251020360 !ruby/object:Gem::Requirement
+  requirement: &70291980661280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70317251020360
+  version_requirements: *70291980661280
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70317251019820 !ruby/object:Gem::Requirement
+  requirement: &70291980660640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *70317251019820
+  version_requirements: *70291980660640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70317251019120 !ruby/object:Gem::Requirement
+  requirement: &70291980659940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *70317251019120
+  version_requirements: *70291980659940
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70317251018440 !ruby/object:Gem::Requirement
+  requirement: &70291980659300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: 1.9.0
   type: :development
   prerelease: false
-  version_requirements: *70317251018440
+  version_requirements: *70291980659300
 description: Simple ruby client interface to the Mixpanel API.
 email:
 - keolo@dreampointmedia.com
@@ -107,7 +107,8 @@ files:
 - spec/mixpanel_client/uri_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/keolo/mixpanel_client
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: