mixpanel_client 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ad60587553d1e52a0c6d6a1ec10979df8cc8631
-  data.tar.gz: 7c41a327214234103fe8d4c55176f77d5f1e1263
+  metadata.gz: 5db50334f0523f186df3366c7e79565ea7eca601
+  data.tar.gz: e28c9cf521c8d160a6d3b6ef1086bf7de6efb4a5
 SHA512:
-  metadata.gz: 276355241d2ca211363a21065ab30b30e48a2d97edbef1f13e92b797393f14c46ae276e8f8ce48706bc300beadc968c98d7cb47e19d577932c0dfc2246abda4c
-  data.tar.gz: 778fa6fce160a6b2092177f11165e71823cf4348c3bea51e75b6bd037f25f8ce1bc09caadca64af91deaf3a8d4080654ab5522c93e26243558eab7714132f7cb
+  metadata.gz: 4b07b4bdc7b798cc10fda6e61502ed858a0530b24b9404a9ac5fc266c130c0e3829c0c19de28b694f8de2f8eab174bac186a80d97a28e5e0d3d8243272869d39
+  data.tar.gz: 28924015e8b5fc7f5b1404821e54ba9c474ce94edc84c8b12d18bfb628931c1ff1a768b36f43c4775abcec021c8fdc12024e5bec8b61d7507f8d10df0d8d3f92

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # 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
+#inherit_from: rubocop-todo.yml
 
 AllCops:
   Includes:

data/changelog.md

@@ -1,3 +1,6 @@
+### v4.0.1
+ * Raise ConfigurationError if api_key or api_secret are not present
+
 ### v4.0.0
  * Dropped support for Ruby 1.8.x
  * Code cleanup via rubocop
@@ -66,5 +69,3 @@
 ### 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

@@ -19,29 +19,32 @@ module Mixpanel
     # Configure the client
     #
     # @example
-    #   config = {'api_key' => '123', 'api_secret' => '456'}
+    #   config = {api_key: '123', api_secret: '456'}
     #   client = Mixpanel::Client.new(config)
     #
     # @param [Hash] config consisting of an 'api_key' and an 'api_secret'
     def initialize(config)
-      @api_key    = config[:api_key]
-      @api_secret = config[:api_secret]
-      @parallel = config[:parallel] || false
+      @api_key    = config[:api_key]    || config['api_key']
+      @api_secret = config[:api_secret] || config['api_secret']
+      @parallel   = config[:parallel]   || config['parallel']   || false
+
+      fail ConfigurationError if @api_key.nil? || @api_secret.nil?
     end
 
     # Return mixpanel data as a JSON object or CSV string
     #
     # @example
-    #   data = client.request('events/properties', {
+    #   data = client.request(
+    #     'events/properties',
     #     event:    '["test-event"]',
     #     name:     'hello',
     #     values:   '["uno", "dos"]',
     #     type:     'general',
     #     unit:     'hour',
-    #     interval:  24,
-    #     limit:     5,
+    #     interval: 24,
+    #     limit:    5,
     #     bucket:   'contents'
-    #   })
+    #   )
     #
     # @resource [String] mixpanel api resource endpoint
     # @options  [Hash] options variables used to make a specific request for
@@ -71,16 +74,17 @@ module Mixpanel
     # Return mixpanel URI to the data
     #
     # @example
-    #   uri = client.request_uri('events/properties', {
+    #   uri = client.request_uri(
+    #     'events/properties',
     #     event:    '["test-event"]',
     #     name:     'hello',
     #     values:   '["uno", "dos"]',
     #     type:     'general',
     #     unit:     'hour',
-    #     interval:  24,
-    #     limit:     5,
+    #     interval: 24,
+    #     limit:    5,
     #     bucket:   'contents'
-    #   })
+    #   )
     #
     # @resource [String] mixpanel api resource endpoint
     # @options  [Hash] options variables used to make a specific request for

data/lib/mixpanel/exceptions.rb

@@ -12,4 +12,5 @@ module Mixpanel
   class HTTPError < Error; end
   class TimeoutError < Error; end
   class ParseError < Error; end
+  class ConfigurationError < 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 = '4.0.0'
+    VERSION = '4.0.1'
   end
 end

data/license

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Keolo Keagy
+Copyright (c) 2009+ Keolo Keagy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/manual_test/parallel.rb

@@ -13,20 +13,22 @@ config = YAML.load_file(File.join(
 ))['mixpanel']
 
 client = Mixpanel::Client.new(
-  api_key: config[:api_key],
+  api_key:    config[:api_key],
   api_secret: config[:api_secret],
-  parallel: true
+  parallel:   true
 )
 
-f = client.request('events/top',
-                   type: 'general'
+uno = client.request(
+  'events/top',
+  type: 'general'
 )
 
-s = client.request('events/names',
-                   type: 'general'
+dos = client.request(
+  'events/names',
+  type: 'general'
 )
 
 client.run_parallel_requests
 
-puts f.response.handled_response.inspect
-puts s.response.handled_response.inspect
+puts uno.response.handled_response.inspect
+puts dos.response.handled_response.inspect

data/mixpanel_client.gemspec

@@ -19,7 +19,6 @@ 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.6.7')
   s.add_development_dependency('bundler', '>=1.5.3')
   s.add_development_dependency('rake',    '>=10.1.1')

data/readme.md

@@ -1,4 +1,6 @@
-# Mixpanel API Client (for API version 2.0)
+# Mixpanel Data API Client
+
+[![Gem Version](https://badge.fury.io/rb/mixpanel_client.png)](http://badge.fury.io/rb/mixpanel_client)
 
 Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
 
@@ -17,10 +19,13 @@ or if you use a Gemfile
     require 'rubygems'
     require 'mixpanel_client'
 
-    config = {api_key: 'changeme', api_secret: 'changeme'}
-    client = Mixpanel::Client.new(config)
+    client = Mixpanel::Client.new(
+      api_key:    'changeme', 
+      api_secret: 'changeme'
+    )
 
-    data = client.request('events/properties', {
+    data = client.request(
+      'events/properties',
       event:     'splash features',
       name:      'feature',
       values:    '["uno", "dos"]',
@@ -28,21 +33,22 @@ or if you use a Gemfile
       unit:      'day',
       from_date: '2013-12-1',
       to_date:   '2014-3-1',
-      limit:      5,
-    })
+      limit:     5
+    )
 
     puts data.inspect
 
     # The API also supports passing a time interval rather than an explicit date range
-    data = client.request('events/properties', {
-      event:     'splash features',
-      name:      'feature',
-      values:    '["uno", "dos"]',
-      type:      'unique',
-      unit:      'day',
-      interval:   7,
-      limit:      5,
-    })
+    data = client.request(
+      'events/properties',
+      event:    'splash features',
+      name:     'feature',
+      values:   '["uno", "dos"]',
+      type:     'unique',
+      unit:     'day',
+      interval: 7,
+      limit:    5
+    )
 
 
     # use the import API, which allows one to specify a time in the past, unlike the track API.
@@ -56,23 +62,31 @@ or if you use a Gemfile
 
 ## Parallel
 
+You may also make requests in parallel by passing in the `parallel: true` option.
+
     require 'rubygems'
     require 'mixpanel_client'
 
-    config = {api_key: 'changeme', api_secret: 'changeme', parallel: true}    
-    client = Mixpanel::Client.new(config)
+    client = Mixpanel::Client.new(
+      api_key:    'changeme', 
+      api_secret: 'changeme',
+      parallel:   true
+    )
 
-    first_request = client.request('events/properties', {
-    ...
-    })
+    first_request = client.request(
+      'events/properties',
+      ...
+    )
 
-    second_request = client.request('events/properties', {
-    ...
-    })
+    second_request = client.request(
+      'events/properties',
+      ...
+    )
 
-    third_request = client.request('events/properties', {
-    ...
-    })
+    third_request = client.request(
+      'events/properties',
+      ...
+    )
 
     ...
     
@@ -98,20 +112,9 @@ Run external specs.
     vi config/mixpanel.yml
     rake spec:externals
 
-## Releasing Gem
-Update version
-  
-    vi lib/mixpanel/version.rb
-
-Commit and push local changes
-    
-    git commit -am "Some message."
-    git push
-    git status
+Run rubocop and fix offences.
 
-Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems
-  
-    rake release
+    rubocop
 
 
 ## Changelog
@@ -136,4 +139,4 @@ Feel free to add your name and link here.
 
 ## Copyright
 
-Copyright (c) 2009+ Keolo Keagy. See LICENSE for details.
+Copyright (c) 2009+ Keolo Keagy. See [license](license) for details.

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -35,6 +35,24 @@ describe Mixpanel::Client do
   end
 
   context 'when making an invalid request' do
+    it 'should raise an error when API key is null' do
+      expect do
+        Mixpanel::Client.new(
+          api_key:    nil,
+          api_secret: 'test_secret'
+        )
+      end.to raise_error
+    end
+
+    it 'should raise an error when API secret is null' do
+      expect do
+        Mixpanel::Client.new(
+          api_key:    'test_key',
+          api_secret: nil
+        )
+      end.to raise_error
+    end
+
     it 'should return an argument error "Wrong number of arguments" if using
         the deprecated usage' do
       # Stub Mixpanel request
@@ -43,12 +61,16 @@ describe Mixpanel::Client do
           body: '{"legend_size": 0, "data": {"series": [], "values": {}}}'
         )
 
-      data = lambda do@client.request(nil, :events,
-                                      event: '["test-event"]',
-                                      unit: 'hour',
-                                      interval: 24
+      data = lambda do
+        @client.request(
+          nil,
+          :events,
+          event: '["test-event"]',
+          unit: 'hour',
+          interval: 24
         )
       end
+
       data.should raise_error(ArgumentError)
     end
   end
@@ -62,11 +84,13 @@ describe Mixpanel::Client do
         )
 
       # No endpoint
-      data = @client.request('events',
-                             event: '["test-event"]',
-                             unit: 'hour',
-                             interval: 24
+      data = @client.request(
+        'events',
+        event: '["test-event"]',
+        unit: 'hour',
+        interval: 24
       )
+
       data.should eq(
         'data' => {
           'series' => [],
@@ -81,10 +105,12 @@ describe Mixpanel::Client do
       # 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 = @client.request(
+        'import',
+        data: 'base64_encoded_data',
+        api_key: 'test_key'
       )
+
       data.should == [1]
     end
 
@@ -153,9 +179,11 @@ describe Mixpanel::Client do
           args.pop[:expire].should eq expiry.to_i
           true
         end.and_return(fake_url)
-        @client.request('events/top',
-                        type: 'general',
-                        expire: expiry
+
+        @client.request(
+          'events/top',
+          type: 'general',
+          expire: expiry
         )
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel_client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Keolo Keagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-15 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -176,7 +176,6 @@ files:
 - manual_test/parallel.rb
 - mixpanel_client.gemspec
 - readme.md
-- rubocop-todo.yml
 - spec/mixpanel_client/events_externalspec.rb
 - spec/mixpanel_client/mixpanel_client_spec.rb
 - spec/mixpanel_client/properties_externalspec.rb

data/rubocop-todo.yml

@@ -1,10 +0,0 @@
-# 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