mixpanel_client 3.1.4 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ad60587553d1e52a0c6d6a1ec10979df8cc8631
+  data.tar.gz: 7c41a327214234103fe8d4c55176f77d5f1e1263
+SHA512:
+  metadata.gz: 276355241d2ca211363a21065ab30b30e48a2d97edbef1f13e92b797393f14c46ae276e8f8ce48706bc300beadc968c98d7cb47e19d577932c0dfc2246abda4c
+  data.tar.gz: 778fa6fce160a6b2092177f11165e71823cf4348c3bea51e75b6bd037f25f8ce1bc09caadca64af91deaf3a8d4080654ab5522c93e26243558eab7714132f7cb

data/.rubocop.yml

@@ -0,0 +1,9 @@
+# For now we're ignoring rules in the following file. We should gradually
+# remove rules over time so that we don't need this file anymore.
+inherit_from: rubocop-todo.yml
+
+AllCops:
+  Includes:
+    - Rakefile
+  Excludes:
+    - bin/**

data/.rvmrc

@@ -6,5 +6,5 @@ rvm_gemset_create_on_use_flag=1
 rvm_project_rvmrc_default=1
 
 # Use rvm with a specific version of ruby and gemset
-rvm use ruby-1.9.3-p392
-rvm gemset use mixpanel_client_1.9.3-p392
+rvm use ruby-2.0.0-p195
+rvm gemset use mixpanel_client_2.0.0-p195

data/Rakefile

@@ -23,8 +23,8 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec 
-task :default => :spec
+task :spec
+task default: :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|

data/changelog.md

@@ -0,0 +1,70 @@
+### v4.0.0
+ * Dropped support for Ruby 1.8.x
+ * Code cleanup via rubocop
+
+### v3.1.4
+ * Updated docs
+ * Updated to latest typhoeus gem
+
+### v3.1.3
+ * 	Added support for the import API.
+ * 	Allow setting of custom expiry.
+
+### v3.1.2
+ * Gem updates
+
+### v3.1.1
+ * Avoid overriding the arg of client.request
+ * Allow retrieving the request_uri of a Mixpanel request
+
+### v3.1.0
+ * Parallel requests option.
+
+### v3.0.0
+ * NOTE: This version breaks backwards compatibility.
+ * Use a regular ruby hash instead of metaprogramming for mixpanel options.
+
+### v2.2.3
+ * 	Added some more options.
+
+### v2.2.2
+ * 	Added some more options.
+
+### v2.2.1
+ * 	Added support for the raw data export API.
+
+### v2.2.0
+  * BASE_URI is now https.
+  * Changed funnel to funnel_id.
+
+### v2.1.0
+ * Updated json dependency to 1.6.
+
+### v2.0.2
+ * Added timezone to available options.
+ * All exceptions can be caught under Mixpanel::Error.
+
+### v2.0.1
+ * Added options used in segmentation resources.
+
+### v2.0.0
+ * Manually tested compatibility with Mixpanel gem. 
+
+### v2.0.0.beta2
+ * Added JSON to gemspec for ruby versions less than 1.9.
+
+### v2.0.0.beta1
+ * Reverted to namespacing via module name because it's a better practice.
+   I.e. Use `Mixpanel::Client` instead of `MixpanelClient`.
+ * Added 'values' as an optional parameter
+ * `gem install mixpanel_client --pre`
+
+### v1.0.1
+ * Minor housekeeping and organizing
+ * Refactored specs
+
+### v1.0.0
+ * Changed "Mixpanel" class name to "MixpanelClient" to prevent naming collision in other 
+   libraries. [a710a84e8ba4b6f018b7](https://github.com/keolo/mixpanel_client/commit/a710a84e8ba4b6f018b7404ab9fabc8f08b4a4f3)
+
+

data/lib/mixpanel/client.rb

@@ -44,19 +44,28 @@ module Mixpanel
     #   })
     #
     # @resource [String] mixpanel api resource endpoint
-    # @options  [Hash] options variables used to make a specific request for mixpanel data
+    # @options  [Hash] options variables used to make a specific request for
+    #           mixpanel data
     # @return   [JSON, String] mixpanel response as a JSON object or CSV string
     def request(resource, options)
       @uri = request_uri(resource, options)
-      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 %w(export import).include?(resource)
-        Utils.to_hash(response, @format)
+      @parallel ? make_parallel_request : make_normal_request(resource)
+    end
+
+    def make_parallel_request
+      parallel_request = prepare_parallel_request
+      hydra.queue parallel_request
+      parallel_request
+    end
+
+    def make_normal_request(resource)
+      response = URI.get(@uri)
+
+      if %w(export import).include?(resource)
+        response = %Q([#{response.split("\n").join(',')}])
       end
+
+      Utils.to_hash(response, @format)
     end
 
     # Return mixpanel URI to the data
@@ -74,30 +83,41 @@ module Mixpanel
     #   })
     #
     # @resource [String] mixpanel api resource endpoint
-    # @options  [Hash] options variables used to make a specific request for mixpanel data
+    # @options  [Hash] options variables used to make a specific request for
+    #           mixpanel data
     # @return   [JSON, String] mixpanel response as a JSON object or CSV string
     def request_uri(resource, options)
       @format = options[:format] || :json
       URI.mixpanel(resource, normalize_options(options))
     end
 
+    # rubocop:disable MethodLength
     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
+          fail TimeoutError
         elsif response.code == 0
           # Could not get an http response, something's wrong.
-          raise HTTPError, response.curl_error_message
+          fail 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
+          if response.body && response.body != ''
+            error_message = JSON.parse(response.body)['error']
+          else
+            error_message = response.code.to_s
+          end
+
+          fail HTTPError, error_message
         end
       end
+
       request
     end
+    # rubocop:enable MethodLength
 
     def run_parallel_requests
       hydra.run
@@ -111,14 +131,15 @@ module Mixpanel
 
     # Return a hash of options along with defaults and a generated signature
     #
-    # @return [Hash] collection of options including defaults and generated signature
+    # @return [Hash] collection of options including defaults and generated
+    #         signature
     def normalize_options(options)
       normalized_options = options.dup
       normalized_options.merge!(
-        :format  => @format,
-        :api_key => @api_key,
-        :expire  => options[:expire] ? options[:expire].to_i : Time.now.to_i + 600
-      ).merge!(:sig => Utils.generate_signature(normalized_options, @api_secret))
+        format: @format,
+        api_key: @api_key,
+        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)

data/lib/mixpanel/uri.rb

@@ -11,11 +11,11 @@ module Mixpanel
   class URI
     def self.mixpanel(resource, params)
       base = Mixpanel::Client.base_uri_for_resource(resource)
-      "#{File.join([base, resource.to_s])}?#{self.encode(params)}"
+      "#{File.join([base, resource.to_s])}?#{encode(params)}"
     end
 
     def self.encode(params)
-      params.map{|key,val| "#{key}=#{CGI.escape(val.to_s)}"}.sort.join('&')
+      params.map { |key, val| "#{key}=#{CGI.escape(val.to_s)}" }.sort.join('&')
     end
 
     def self.get(uri)

data/lib/mixpanel/utils.rb

@@ -9,12 +9,24 @@
 module Mixpanel
   # Utility methods for Mixpanel::Client
   class Client
+    # Mixpanel API Ruby Client Library
+    #
+    # Utility helpers
+    #
+    # Copyright (c) 2009+ Keolo Keagy
+    # See LICENSE for details
     module Utils
-      # Return a string composed of hashed values specified by the mixpanel data API
+      # Return a string composed of hashed values specified by the mixpanel
+      # data API
       #
       # @return [String] md5 hash signature required by mixpanel data API
       def self.generate_signature(args, api_secret)
-        Digest::MD5.hexdigest(args.map{|key,val| "#{key}=#{val}"}.sort.join + api_secret)
+        Digest::MD5.hexdigest(
+          args.map { |key, val| "#{key}=#{val}" }
+          .sort
+          .join +
+          api_secret
+        )
       end
 
       # Return a JSON object or a string depending on a given format

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.4'
+    VERSION = '4.0.0'
   end
 end

data/manual_test/basic.rb

@@ -4,15 +4,23 @@ require 'rubygems'
 require 'mixpanel_client'
 require 'yaml'
 
-config = YAML.load_file(File.dirname(__FILE__) + '/../config/mixpanel.yml')['mixpanel']
+config = YAML.load_file(File.join(
+  File.dirname(__FILE__),
+  '..',
+  'config',
+  'mixpanel.yml'
+))['mixpanel']
 
-client = Mixpanel::Client.new({api_key: config['api_key'], api_secret: config['api_secret']})
+client = Mixpanel::Client.new(
+  api_key: config[:api_key],
+  api_secret: config[:api_secret]
+)
 
-data = client.request('events/properties', {
-  event:    '["test-event"]',
-  type:     'general',
-  unit:     'hour',
-  name:     'test'
-})
+data = client.request('events/properties',
+                      event:    '["test-event"]',
+                      type:     'general',
+                      unit:     'hour',
+                      name:     'test'
+)
 
 puts data.inspect

data/manual_test/parallel.rb

@@ -5,21 +5,28 @@ 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'
-})
+config = YAML.load_file(File.join(
+  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

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version     = Mixpanel::Client::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Keolo Keagy']
-  s.email       = ['keolo@dreampointmedia.com']
+  s.email       = ['keolo@kea.gy']
   s.homepage    = 'http://github.com/keolo/mixpanel_client' 
   s.summary     = %q{Ruby Mixpanel API Client Library}
   s.description = %q{Simple ruby client interface to the Mixpanel API.}
@@ -21,11 +21,13 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.add_runtime_dependency('json',        '~> 1.6') if RUBY_VERSION < '1.9'
   s.add_runtime_dependency('typhoeus',    '~> 0.6.7')
-  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('bundler', '>=1.5.3')
+  s.add_development_dependency('rake',    '>=10.1.1')
+  s.add_development_dependency('rdoc',    '>=4.1.1')
   s.add_development_dependency('rspec',   '>=2.5.0')
-  s.add_development_dependency('webmock', '>=1.9.0')
+  s.add_development_dependency('webmock', '>=1.17.4')
   s.add_development_dependency('pry',     '>=0.9.12.6')
+  s.add_development_dependency('pry-byebug', '>=1.3.2') if RUBY_VERSION >= '2.0'
+  s.add_development_dependency('pry-stack_explorer', '>=0.4.9')
   s.add_development_dependency('rubocop', '>=0.19.0')
 end

data/{README.md → readme.md}

@@ -115,71 +115,8 @@ Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems
 
 
 ## Changelog
+[Changelog](changelog.md)
 
-### v3.1.4
- * Updated docs
- * Updated to latest typhoeus gem
-
-### v3.1.3
- * 	Added support for the import API.
- * 	Allow setting of custom expiry.
-
-### v3.1.2
- * Gem updates
-
-### v3.1.1
- * Avoid overriding the arg of client.request
- * Allow retrieving the request_uri of a Mixpanel request
-
-### v3.1.0
- * Parallel requests option.
-
-### v3.0.0
- * NOTE: This version breaks backwards compatibility.
- * Use a regular ruby hash instead of metaprogramming for mixpanel options.
-
-### v2.2.3
- * 	Added some more options.
-
-### v2.2.2
- * 	Added some more options.
-
-### v2.2.1
- * 	Added support for the raw data export API.
-
-### v2.2.0
-  * BASE_URI is now https.
-  * Changed funnel to funnel_id.
-
-### v2.1.0
- * Updated json dependency to 1.6.
-
-### v2.0.2
- * Added timezone to available options.
- * All exceptions can be caught under Mixpanel::Error.
-
-### v2.0.1
- * Added options used in segmentation resources.
-
-### v2.0.0
- * Manually tested compatibility with Mixpanel gem. 
-
-### v2.0.0.beta2
- * Added JSON to gemspec for ruby versions less than 1.9.
-
-### v2.0.0.beta1
- * Reverted to namespacing via module name because it's a better practice.
-   I.e. Use `Mixpanel::Client` instead of `MixpanelClient`.
- * Added 'values' as an optional parameter
- * `gem install mixpanel_client --pre`
-
-### v1.0.1
- * Minor housekeeping and organizing
- * Refactored specs
-
-### v1.0.0
- * Changed "Mixpanel" class name to "MixpanelClient" to prevent naming collision in other 
-   libraries. [a710a84e8ba4b6f018b7](https://github.com/keolo/mixpanel_client/commit/a710a84e8ba4b6f018b7404ab9fabc8f08b4a4f3)
 
 ## Collaborators and Maintainers
 Feel free to add your name and link here.

data/rubocop-todo.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-03-15 09:50:10 -0700 using RuboCop version 0.19.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 60
+#LineLength:
+#  Max: 262

data/spec/mixpanel_client/events_externalspec.rb

@@ -4,89 +4,96 @@ WebMock.allow_net_connect!
 
 describe 'External calls to mixpanel' do
   before :all do
-    config = YAML.load_file(File.dirname(__FILE__) + '/../../config/mixpanel.yml')['mixpanel']
+    config = YAML.load_file(File.join(
+      File.dirname(__FILE__),
+      '..',
+      '..',
+      'config',
+      'mixpanel.yml'
+    ))['mixpanel']
+
     config.should_not be_nil
     @client = Mixpanel::Client.new(config)
   end
 
   context 'when requesting events' do
     it 'should raise an error for bad requests' do
-      data = lambda {
+      data = lambda do
         @client.request('events', {})
-      }
+      end
       data.should raise_error(Mixpanel::HTTPError)
     end
 
     it 'should return events' do
-      data = @client.request('events', {
-        :event    => '["test-event"]',
-        :type     => 'general',
-        :unit     => 'hour',
-        :interval =>  24
-      })
+      data = @client.request('events',
+                             event: '["test-event"]',
+                             type: 'general',
+                             unit: 'hour',
+                             interval: 24
+      )
       data.should_not be_a Exception
     end
 
     it 'should return events in csv format' do
-      data = @client.request('events', {
-        :event    => '["test-event"]',
-        :type     => 'general',
-        :unit     => 'hour',
-        :interval =>  24,
-        :format   => 'csv'
-      })
+      data = @client.request('events',
+                             event: '["test-event"]',
+                             type: 'general',
+                             unit: 'hour',
+                             interval: 24,
+                             format: 'csv'
+      )
       data.should_not be_a Exception
     end
 
     it 'should return events with optional bucket' do
-      data = @client.request('events', {
-        :event    => '["test-event"]',
-        :type     => 'general',
-        :unit     => 'hour',
-        :interval =>  24,
-        :bucket   => 'test'
-      })
+      data = @client.request('events',
+                             event: '["test-event"]',
+                             type: 'general',
+                             unit: 'hour',
+                             interval: 24,
+                             bucket: 'test'
+      )
       data.should_not be_a Exception
     end
 
     it 'should return top events' do
-      data = @client.request('events/top', {
-        :type     => 'general',
-        :limit    => 10
-      })
+      data = @client.request('events/top',
+                             type: 'general',
+                             limit: 10
+      )
       data.should_not be_a Exception
     end
 
     it 'should return names' do
-      data = @client.request('events/names', {
-        :type     => 'general',
-        :unit     => 'hour',
-        :interval =>  24,
-        :limit    => 10
-      })
+      data = @client.request('events/names',
+                             type: 'general',
+                             unit: 'hour',
+                             interval: 24,
+                             limit: 10
+      )
       data.should_not be_a Exception
     end
 
     it 'should return retention' do
       pending 'Retention now has its own endpoint.'
-      data = @client.request('events/retention', {
-        :event    => '["test-event"]',
-        :type     => 'general',
-        :unit     => 'hour',
-        :interval =>  24
-      })
+      data = @client.request('events/retention',
+                             event: '["test-event"]',
+                             type: 'general',
+                             unit: 'hour',
+                             interval: 24
+      )
       data.should_not be_a Exception
     end
 
     it 'should return retention in csv format' do
       pending 'Retention now has its own endpoint.'
-      data = @client.request('events/retention', {
-        :event    => '["test-event"]',
-        :type     => 'general',
-        :unit     => 'hour',
-        :interval =>  24,
-        :format   => 'csv'
-      })
+      data = @client.request('events/retention',
+                             event: '["test-event"]',
+                             type: 'general',
+                             unit: 'hour',
+                             interval: 24,
+                             format: 'csv'
+      )
       data.should_not be_a Exception
     end
   end