mixpanel_client 4.1.4 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20fdfa3521f3281e6319ae41fa6d15e99dc37db2
-  data.tar.gz: 377594c3362e46afcdd5c8c29cd5f68fbe665a4d
+  metadata.gz: 276a112f1f0c83a360953fb404392ba687bbaa5d
+  data.tar.gz: 1c0a5f3b4d551b3529282a449ffff42f52d1fc0e
 SHA512:
-  metadata.gz: f46b04fae019e68ed8160c165652e99d5ce53cfcfc9da77f9f1099e0104260ce79cae277f8d09f74390751591f8ff83752d88e0d66400c2e9d2671785577698f
-  data.tar.gz: da3cf583fa0a6a5ffb1d83095b402332fa53735a863a1d22176e950215510fe72cf830f047a3e454c095ded8d42fb6252f81a0d20a90049c6f832ff2263bf8fa
+  metadata.gz: c6416ca4b99f358b9eeeecdeee63932299e83251b68e38b80d5e50196cdd3809c627d525515b483b2d0267d3694961a6539ba76ad3de8714c5b944e5878bfef9
+  data.tar.gz: b241d59a34c755e505fb28cb63501f8da0414fa66fcfe2be27d14be536b7b17f359a62ad880da8a4b7936ec893b08196f9fed441f057fc2c51aaa4c9263bf73d

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/changelog.md

@@ -1,3 +1,7 @@
+### v4.1.5
+ * Use new authentication method for mixpanel. Fixes #52.
+ * Use `expect` rspec syntax
+
 ### v4.1.4
  * Add timeout option: Merged PR #48
 

data/config/mixpanel.template.yml

@@ -1,3 +1,3 @@
 mixpanel:
-  api_key:    'changeme'
-  api_secret: 'changeme'
+  :api_key:    'changeme'
+  :api_secret: 'changeme'

data/lib/mixpanel/client.rb

@@ -13,7 +13,7 @@ module Mixpanel
     DATA_URI   = 'https://data.mixpanel.com/api/2.0'
     IMPORT_URI = 'https://api.mixpanel.com'
 
-    attr_reader   :uri
+    attr_reader :uri
     attr_accessor :api_key, :api_secret, :parallel, :timeout
 
     # Configure the client
@@ -26,8 +26,8 @@ module Mixpanel
     def initialize(config)
       @api_key    = config[:api_key]
       @api_secret = config[:api_secret]
-      @parallel   = config[:parallel]   || false
-      @timeout    = config[:timeout]    || nil
+      @parallel   = config[:parallel] || false
+      @timeout    = config[:timeout] || nil
 
       fail ConfigurationError if @api_key.nil? || @api_secret.nil?
     end
@@ -64,10 +64,10 @@ module Mixpanel
     end
 
     def make_normal_request(resource)
-      response = URI.get(@uri, @timeout)
+      response = URI.get(@uri, @timeout, @api_secret)
 
       if %w(export import).include?(resource) && @format != 'raw'
-        response = %Q([#{response.split("\n").join(',')}])
+        response = %([#{response.split("\n").join(',')}])
       end
 
       Utils.to_hash(response, @format)
@@ -92,14 +92,14 @@ module Mixpanel
     # @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 = {} )
+    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 = ::Typhoeus::Request.new(@uri, userpwd: "#{@api_secret}:")
 
       request.on_complete do |response|
         if response.success?
@@ -145,12 +145,8 @@ module Mixpanel
       normalized_options
         .merge!(
           format:  @format,
-          api_key: @api_key,
           expire:  request_expires_at(normalized_options)
         )
-        .merge!(
-          sig: Utils.generate_signature(normalized_options, @api_secret)
-        )
     end
 
     def request_expires_at(options)

data/lib/mixpanel/uri.rb

@@ -18,8 +18,8 @@ module Mixpanel
       params.map { |key, val| "#{key}=#{CGI.escape(val.to_s)}" }.sort.join('&')
     end
 
-    def self.get(uri, timeout)
-      ::URI.parse(uri).read(read_timeout: timeout)
+    def self.get(uri, timeout, secret)
+      ::URI.parse(uri).read(read_timeout: timeout, http_basic_authentication: [secret, nil])
     rescue OpenURI::HTTPError => error
       raise HTTPError, JSON.parse(error.io.read)['error']
     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.1.4'
+    VERSION = '4.1.5'
   end
 end

data/manual_test/basic.rb

@@ -5,10 +5,10 @@ require 'mixpanel_client'
 require 'yaml'
 
 config = YAML.load_file(File.join(
-  File.dirname(__FILE__),
-  '..',
-  'config',
-  'mixpanel.yml'
+                          File.dirname(__FILE__),
+                          '..',
+                          'config',
+                          'mixpanel.yml'
 ))['mixpanel']
 
 client = Mixpanel::Client.new(
@@ -21,6 +21,6 @@ data = client.request('events/properties',
                       type:     'general',
                       unit:     'hour',
                       name:     'test'
-)
+                     )
 
 puts data.inspect

data/manual_test/parallel.rb

@@ -5,11 +5,12 @@ require 'mixpanel_client'
 require 'yaml'
 require 'typhoeus'
 
-config = YAML.load_file(File.join(
-  File.dirname(__FILE__),
-  '..',
-  'config',
-  'mixpanel.yml'
+config = YAML.load_file(
+  File.join(
+    File.dirname(__FILE__),
+    '..',
+    'config',
+    'mixpanel.yml'
 ))['mixpanel']
 
 client = Mixpanel::Client.new(

data/readme.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/mixpanel_client.svg)](http://badge.fury.io/rb/mixpanel_client)
 [![Code Climate](https://codeclimate.com/github/keolo/mixpanel_client/badges/gpa.svg)](https://codeclimate.com/github/keolo/mixpanel_client)
+[ ![Codeship Status for keolo/mixpanel_client](https://codeship.com/projects/4d247060-1ad9-0134-e1c3-0e8ad2af7d49/status?branch=master)](https://codeship.com/projects/159479)
 
 Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
 

data/spec/mixpanel_client/events_externalspec.rb

@@ -5,14 +5,14 @@ WebMock.allow_net_connect!
 describe 'External calls to mixpanel' do
   before :all do
     config = YAML.load_file(File.join(
-      File.dirname(__FILE__),
-      '..',
-      '..',
-      'config',
-      'mixpanel.yml'
+                              File.dirname(__FILE__),
+                              '..',
+                              '..',
+                              'config',
+                              'mixpanel.yml'
     ))['mixpanel']
 
-    config.should_not be_nil
+    expect(config).to_not be_nil
     @client = Mixpanel::Client.new(config)
   end
 
@@ -21,7 +21,7 @@ describe 'External calls to mixpanel' do
       data = lambda do
         @client.request('events', {})
       end
-      data.should raise_error(Mixpanel::HTTPError)
+      expect(data).to raise_error(Mixpanel::HTTPError)
     end
 
     it 'should return events' do
@@ -30,8 +30,8 @@ describe 'External calls to mixpanel' do
                              type: 'general',
                              unit: 'hour',
                              interval: 24
-      )
-      data.should_not be_a Exception
+                            )
+      expect(data).to_not be_a Exception
     end
 
     it 'should return events in csv format' do
@@ -41,8 +41,8 @@ describe 'External calls to mixpanel' do
                              unit: 'hour',
                              interval: 24,
                              format: 'csv'
-      )
-      data.should_not be_a Exception
+                            )
+      expect(data).to_not be_a Exception
     end
 
     it 'should return events with optional bucket' do
@@ -52,16 +52,16 @@ describe 'External calls to mixpanel' do
                              unit: 'hour',
                              interval: 24,
                              bucket: 'test'
-      )
-      data.should_not be_a Exception
+                            )
+      expect(data).to_not be_a Exception
     end
 
     it 'should return top events' do
       data = @client.request('events/top',
                              type: 'general',
                              limit: 10
-      )
-      data.should_not be_a Exception
+                            )
+      expect(data).to_not be_a Exception
     end
 
     it 'should return names' do
@@ -70,8 +70,8 @@ describe 'External calls to mixpanel' do
                              unit: 'hour',
                              interval: 24,
                              limit: 10
-      )
-      data.should_not be_a Exception
+                            )
+      expect(data).to_not be_a Exception
     end
 
     it 'should return retention' do
@@ -81,8 +81,8 @@ describe 'External calls to mixpanel' do
                              type: 'general',
                              unit: 'hour',
                              interval: 24
-      )
-      data.should_not be_a Exception
+                            )
+      expect(data).to_not be_a Exception
     end
 
     it 'should return retention in csv format' do
@@ -93,8 +93,8 @@ describe 'External calls to mixpanel' do
                              unit: 'hour',
                              interval: 24,
                              format: 'csv'
-      )
-      data.should_not be_a Exception
+                            )
+      expect(data).to_not be_a Exception
     end
   end
 end

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -12,33 +12,33 @@ describe Mixpanel::Client do
 
   context 'when initializing a new Mixpanel::Client' do
     it 'should set a parallel option as false by default' do
-      Mixpanel::Client.new(
+      expect(Mixpanel::Client.new(
         api_key: 'test_key',
         api_secret: 'test_secret'
-      ).parallel.should eq false
+      ).parallel).to eq(false)
     end
 
     it 'should be able to set a parallel option when passed' do
-      Mixpanel::Client.new(
+      expect(Mixpanel::Client.new(
         api_key: 'test_key',
         api_secret: 'test_secret',
         parallel: true
-      ).parallel.should eq true
+      ).parallel).to eq(true)
     end
 
     it 'should set a timeout option as nil by default' do
-      Mixpanel::Client.new(
+      expect(Mixpanel::Client.new(
         api_key: 'test_key',
         api_secret: 'test_secret'
-      ).timeout.should be_nil
+      ).timeout).to be_nil
     end
 
     it 'should be able to set a timeout option when passed' do
-      Mixpanel::Client.new(
+      expect(Mixpanel::Client.new(
         api_key: 'test_key',
         api_secret: 'test_secret',
         timeout: 3
-      ).timeout.should eql 3
+      ).timeout).to eql(3)
     end
   end
 
@@ -79,7 +79,7 @@ describe Mixpanel::Client do
         )
       end
 
-      data.should raise_error(ArgumentError)
+      expect(data).to raise_error(ArgumentError)
     end
   end
 
@@ -99,7 +99,7 @@ describe Mixpanel::Client do
         interval: 24
       )
 
-      data.should eq(
+      expect(data).to eq(
         'data' => {
           'series' => [],
           'values' => {}
@@ -119,7 +119,7 @@ describe Mixpanel::Client do
         api_key: 'test_key'
       )
 
-      data.should == [1]
+      expect(data).to eq([1])
     end
 
     it 'should work with an endpoint, method, and type' do
@@ -135,7 +135,7 @@ describe Mixpanel::Client do
         type: 'general'
       )
 
-      data.should eq(
+      expect(data).to eq(
         'events' => [],
         'type'   => 'general'
       )
@@ -183,7 +183,7 @@ describe Mixpanel::Client do
 
       specify 'Mixpanel::URI instance should receive the custom expiry time in
                the options[:expiry] instead of 600s' do
-        Mixpanel::URI.should_receive(:mixpanel) do |*args|
+        expect(Mixpanel::URI).to receive(:mixpanel) do |*args|
           args.pop[:expire].should eq expiry.to_i
           true
         end.and_return(fake_url)
@@ -220,7 +220,7 @@ describe Mixpanel::Client do
           interval: 24
         )
 
-        data.should be_a Typhoeus::Request
+        expect(data).to be_a Typhoeus::Request
       end
 
       describe '#hydra' do
@@ -331,9 +331,9 @@ describe Mixpanel::Client do
       )
 
       sorted_signature = Mixpanel::Client::Utils.generate_signature(
-          args_alpha_sorted,
-          @client.api_secret
-        )
+        args_alpha_sorted,
+        @client.api_secret
+      )
 
       unsorted_signature.should eq sorted_signature
     end
@@ -341,10 +341,10 @@ describe Mixpanel::Client do
 
   describe '#to_hash' do
     it 'should return a ruby hash given json as a string' do
-      Mixpanel::Client::Utils.to_hash(
+      expect(Mixpanel::Client::Utils.to_hash(
         '{"a" : "ey", "b" : "bee"}',
         :json
-      ).should eq(
+      )).to eq(
         'a' => 'ey',
         'b' => 'bee'
       )

data/spec/mixpanel_client/properties_externalspec.rb

@@ -5,11 +5,11 @@ WebMock.allow_net_connect!
 describe 'External calls to mixpanel' do
   before :all do
     config = YAML.load_file(File.join(
-      File.dirname(__FILE__),
-      '..',
-      '..',
-      'config',
-      'mixpanel.yml'
+                              File.dirname(__FILE__),
+                              '..',
+                              '..',
+                              'config',
+                              'mixpanel.yml'
     ))['mixpanel']
 
     config.should_not be_nil
@@ -34,7 +34,7 @@ describe 'External calls to mixpanel' do
                              interval: 24,
                              limit: 5,
                              bucket: 'kicked'
-      )
+                            )
       data.should_not be_a Exception
     end
   end

data/spec/mixpanel_client/uri_spec.rb

@@ -5,7 +5,8 @@ describe Mixpanel::URI do
   describe '.mixpanel' do
     it 'should return a properly formatted mixpanel uri as a string (without an
         endpoint)' do
-      resource, params  = ['events', { c: 'see', a: 'ey' }]
+      resource = 'events'
+      params = { c: 'see', a: 'ey' }
 
       Mixpanel::URI.mixpanel(resource, params).should eq(
         "#{Mixpanel::Client::BASE_URI}/events?a=ey&c=see"
@@ -14,7 +15,8 @@ describe Mixpanel::URI do
 
     it 'should return a properly formatted mixpanel uri as a string (with an
         endpoint)' do
-      resource, params  = ['events/top', { c: 'see', a: 'ey' }]
+      resource = 'events/top'
+      params = { c: 'see', a: 'ey' }
 
       Mixpanel::URI.mixpanel(resource, params).should eq(
         "#{Mixpanel::Client::BASE_URI}/events/top?a=ey&c=see"
@@ -23,7 +25,8 @@ describe Mixpanel::URI do
 
     it 'should return a uri with a different endpoint when doing a raw data
         export' do
-      resource, params  = ['export', { c: 'see', a: 'ey' }]
+      resource = 'export'
+      params = { c: 'see', a: 'ey' }
 
       Mixpanel::URI.mixpanel(resource, params).should eq(
         "#{Mixpanel::Client::DATA_URI}/export?a=ey&c=see"
@@ -32,7 +35,8 @@ describe Mixpanel::URI do
 
     it 'should return a uri with a the correct endpoint when doing an
         import' do
-      resource, params  = ['import', { c: 'see', a: 'ey' }]
+      resource = 'import'
+      params = { c: 'see', a: 'ey' }
       Mixpanel::URI.mixpanel(resource, params).should eq(
         "#{Mixpanel::Client::IMPORT_URI}/import?a=ey&c=see"
       )
@@ -53,17 +57,16 @@ describe Mixpanel::URI do
     it 'should return a string response' do
       stub_request(:get, 'http://example.com').to_return(body: 'something')
 
-      Mixpanel::URI.get('http://example.com', nil).should eq 'something'
+      Mixpanel::URI.get('http://example.com', nil, 'secret').should eq 'something'
     end
 
     context 'when timeout is not nil' do
-
       context 'when the request times out' do
         it 'should return a timeout error' do
           stub_request(:get, 'http://example.com').to_timeout
 
           expect do
-            Mixpanel::URI.get('http://example.com', 3)
+            Mixpanel::URI.get('http://example.com', 3, 'secret')
           end.to raise_error Timeout::Error
         end
       end
@@ -72,10 +75,9 @@ describe Mixpanel::URI do
         it 'should return a string response' do
           stub_request(:get, 'http://example.com').to_return(body: 'something')
 
-          Mixpanel::URI.get('http://example.com', 3).should eq 'something'
+          Mixpanel::URI.get('http://example.com', 3, 'secret').should eq 'something'
         end
       end
-
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel_client
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 4.1.5
 platform: ruby
 authors:
 - Keolo Keagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -160,6 +160,7 @@ files:
 - ".document"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".rvmrc"
 - Gemfile
 - Rakefile