mixpanel_client 4.1.5 → 4.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 276a112f1f0c83a360953fb404392ba687bbaa5d
-  data.tar.gz: 1c0a5f3b4d551b3529282a449ffff42f52d1fc0e
+  metadata.gz: a0b1c877cdcf416ba164f8e7b9fe9ab31857b090
+  data.tar.gz: bfd32fe4693da8458500b26fe18e2143dd03359b
 SHA512:
-  metadata.gz: c6416ca4b99f358b9eeeecdeee63932299e83251b68e38b80d5e50196cdd3809c627d525515b483b2d0267d3694961a6539ba76ad3de8714c5b944e5878bfef9
-  data.tar.gz: b241d59a34c755e505fb28cb63501f8da0414fa66fcfe2be27d14be536b7b17f359a62ad880da8a4b7936ec893b08196f9fed441f057fc2c51aaa4c9263bf73d
+  metadata.gz: 2b6d2372e919718d682ade39e7edf8740e31685c2e6272418c022e2b3374d53927a47e0dfd5a5c72d39a0df4bde2ad2c18943eed0acf01ea7708634989f372ff
+  data.tar.gz: 330f9bd86e8436c439944fced484d8919c07279ad7ce1dff5023e15e99a2aa7b9dde581e7cfbb5be71a6029d898be5ab8b9ef7b6cf1489d5cb026c266f82eb65

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  markdownlint:
+    enabled: true
+  reek:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- config/
+- spec/

data/changelog.md

@@ -1,3 +1,8 @@
+### v4.1.6
+ * Remove deprecated authentication options. Fixes #55.
+ * Use `expect` rspec syntax
+ * Added codeclimate config
+
 ### v4.1.5
  * Use new authentication method for mixpanel. Fixes #52.
  * Use `expect` rspec syntax

data/config/mixpanel.template.yml

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

data/lib/mixpanel/client.rb

@@ -9,27 +9,36 @@
 module Mixpanel
   # Return metrics from Mixpanel Data API
   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'
+    BASE_URI   = 'https://mixpanel.com/api/2.0'.freeze
+    DATA_URI   = 'https://data.mixpanel.com/api/2.0'.freeze
+    IMPORT_URI = 'https://api.mixpanel.com'.freeze
 
     attr_reader :uri
-    attr_accessor :api_key, :api_secret, :parallel, :timeout
+    attr_accessor :api_secret, :parallel, :timeout
+
+    def self.base_uri_for_resource(resource)
+      if resource == 'export'
+        DATA_URI
+      elsif resource == 'import'
+        IMPORT_URI
+      else
+        BASE_URI
+      end
+    end
 
     # Configure the client
     #
     # @example
-    #   config = {api_key: '123', api_secret: '456'}
+    #   config = {api_secret: '456'}
     #   client = Mixpanel::Client.new(config)
     #
-    # @param [Hash] config consisting of an 'api_key' and an 'api_secret'
+    # @param [Hash] config consisting of an 'api_secret' and additonal options
     def initialize(config)
-      @api_key    = config[:api_key]
       @api_secret = config[:api_secret]
       @parallel   = config[:parallel] || false
       @timeout    = config[:timeout] || nil
 
-      fail ConfigurationError if @api_key.nil? || @api_secret.nil?
+      raise ConfigurationError, 'api_secret is required' if @api_secret.nil?
     end
 
     # Return mixpanel data as a JSON object or CSV string
@@ -97,6 +106,7 @@ module Mixpanel
       URI.mixpanel(resource, normalize_options(options))
     end
 
+    # TODO: Extract and refactor
     # rubocop:disable MethodLength
     def prepare_parallel_request
       request = ::Typhoeus::Request.new(@uri, userpwd: "#{@api_secret}:")
@@ -105,19 +115,19 @@ module Mixpanel
         if response.success?
           Utils.to_hash(response.body, @format)
         elsif response.timed_out?
-          fail TimeoutError
+          raise TimeoutError
         elsif response.code == 0
           # Could not get an http response, something's wrong
-          fail HTTPError, response.curl_error_message
+          raise HTTPError, response.curl_error_message
         else
           # Received a non-successful http response
-          if response.body && response.body != ''
-            error_message = JSON.parse(response.body)['error']
-          else
-            error_message = response.code.to_s
-          end
+          error_message = if response.body && response.body != ''
+                            JSON.parse(response.body)['error']
+                          else
+                            response.code.to_s
+                          end
 
-          fail HTTPError, error_message
+          raise HTTPError, error_message
         end
       end
 
@@ -141,27 +151,7 @@ module Mixpanel
     #         signature
     def normalize_options(options)
       normalized_options = options.dup
-
-      normalized_options
-        .merge!(
-          format:  @format,
-          expire:  request_expires_at(normalized_options)
-        )
-    end
-
-    def request_expires_at(options)
-      ten_minutes_from_now = Time.now.to_i + 600
-      options[:expire] ? options[:expire].to_i : ten_minutes_from_now
-    end
-
-    def self.base_uri_for_resource(resource)
-      if resource == 'export'
-        DATA_URI
-      elsif resource == 'import'
-        IMPORT_URI
-      else
-        BASE_URI
-      end
+      normalized_options.merge!(format: @format)
     end
   end
 end

data/lib/mixpanel/uri.rb

@@ -19,7 +19,10 @@ module Mixpanel
     end
 
     def self.get(uri, timeout, secret)
-      ::URI.parse(uri).read(read_timeout: timeout, http_basic_authentication: [secret, nil])
+      ::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.5'
+    VERSION = '4.1.6'.freeze
   end
 end

data/manual_test/basic.rb

@@ -12,7 +12,6 @@ config = YAML.load_file(File.join(
 ))['mixpanel']
 
 client = Mixpanel::Client.new(
-  api_key: config[:api_key],
   api_secret: config[:api_secret]
 )
 
@@ -20,7 +19,6 @@ data = client.request('events/properties',
                       event:    '["test-event"]',
                       type:     'general',
                       unit:     'hour',
-                      name:     'test'
-                     )
+                      name:     'test')
 
 puts data.inspect

data/manual_test/parallel.rb

@@ -11,10 +11,10 @@ config = YAML.load_file(
     '..',
     'config',
     'mixpanel.yml'
-))['mixpanel']
+  )
+)['mixpanel']
 
 client = Mixpanel::Client.new(
-  api_key:    config[:api_key],
   api_secret: config[:api_secret],
   parallel:   true
 )

data/readme.md

@@ -22,7 +22,6 @@ or if you use a Gemfile
     require 'mixpanel_client'
 
     client = Mixpanel::Client.new(
-      api_key:    'changeme',
       api_secret: 'changeme'
     )
 
@@ -69,7 +68,6 @@ You may also make requests in parallel by passing in the `parallel: true` option
     require 'mixpanel_client'
 
     client = Mixpanel::Client.new(
-      api_key:    'changeme',
       api_secret: 'changeme',
       parallel:   true
     )

data/spec/mixpanel_client/events_externalspec.rb

@@ -29,8 +29,7 @@ describe 'External calls to mixpanel' do
                              event: '["test-event"]',
                              type: 'general',
                              unit: 'hour',
-                             interval: 24
-                            )
+                             interval: 24)
       expect(data).to_not be_a Exception
     end
 
@@ -40,8 +39,7 @@ describe 'External calls to mixpanel' do
                              type: 'general',
                              unit: 'hour',
                              interval: 24,
-                             format: 'csv'
-                            )
+                             format: 'csv')
       expect(data).to_not be_a Exception
     end
 
@@ -51,16 +49,14 @@ describe 'External calls to mixpanel' do
                              type: 'general',
                              unit: 'hour',
                              interval: 24,
-                             bucket: 'test'
-                            )
+                             bucket: 'test')
       expect(data).to_not be_a Exception
     end
 
     it 'should return top events' do
       data = @client.request('events/top',
                              type: 'general',
-                             limit: 10
-                            )
+                             limit: 10)
       expect(data).to_not be_a Exception
     end
 
@@ -69,8 +65,7 @@ describe 'External calls to mixpanel' do
                              type: 'general',
                              unit: 'hour',
                              interval: 24,
-                             limit: 10
-                            )
+                             limit: 10)
       expect(data).to_not be_a Exception
     end
 
@@ -80,8 +75,7 @@ describe 'External calls to mixpanel' do
                              event: '["test-event"]',
                              type: 'general',
                              unit: 'hour',
-                             interval: 24
-                            )
+                             interval: 24)
       expect(data).to_not be_a Exception
     end
 
@@ -92,8 +86,7 @@ describe 'External calls to mixpanel' do
                              type: 'general',
                              unit: 'hour',
                              interval: 24,
-                             format: 'csv'
-                            )
+                             format: 'csv')
       expect(data).to_not be_a Exception
     end
   end

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -3,7 +3,6 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Mixpanel::Client do
   before :all do
     @client = Mixpanel::Client.new(
-      api_key: 'test_key',
       api_secret: 'test_secret'
     )
 
@@ -13,14 +12,12 @@ describe Mixpanel::Client do
   context 'when initializing a new Mixpanel::Client' do
     it 'should set a parallel option as false by default' do
       expect(Mixpanel::Client.new(
-        api_key: 'test_key',
         api_secret: 'test_secret'
       ).parallel).to eq(false)
     end
 
     it 'should be able to set a parallel option when passed' do
       expect(Mixpanel::Client.new(
-        api_key: 'test_key',
         api_secret: 'test_secret',
         parallel: true
       ).parallel).to eq(true)
@@ -28,14 +25,12 @@ describe Mixpanel::Client do
 
     it 'should set a timeout option as nil by default' do
       expect(Mixpanel::Client.new(
-        api_key: 'test_key',
         api_secret: 'test_secret'
       ).timeout).to be_nil
     end
 
     it 'should be able to set a timeout option when passed' do
       expect(Mixpanel::Client.new(
-        api_key: 'test_key',
         api_secret: 'test_secret',
         timeout: 3
       ).timeout).to eql(3)
@@ -43,22 +38,12 @@ 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.to raise_error(Mixpanel::ConfigurationError)
     end
 
     it 'should return an argument error "Wrong number of arguments" if using
@@ -154,52 +139,9 @@ describe Mixpanel::Client do
       end.to_not change { options }
     end
 
-    context 'with a custom expiry time' do
-      # Stub Mixpanel request
-      before do
-        stub_request(:get, /^#{@uri}.*/)
-          .to_return(
-            body: '{"events": [], "type": "general"}'
-          )
-      end
-
-      let(:expiry)   { Time.now + 100_000 }
-      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 eq(
-          'events' => [],
-          'type'   => 'general'
-        )
-      end
-
-      specify 'Mixpanel::URI instance should receive the custom expiry time in
-               the options[:expiry] instead of 600s' do
-        expect(Mixpanel::URI).to receive(:mixpanel) do |*args|
-          args.pop[:expire].should eq 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
         @parallel_client = Mixpanel::Client.new(
-          api_key: 'test_key',
           api_secret: 'test_secret',
           parallel: true
         )
@@ -225,7 +167,7 @@ describe Mixpanel::Client do
 
       describe '#hydra' do
         it 'should return a Typhoeus::Hydra object' do
-          @parallel_client.hydra.should be_a Typhoeus::Hydra
+          expect(@parallel_client.hydra).to be_a Typhoeus::Hydra
         end
       end
 
@@ -282,7 +224,7 @@ describe Mixpanel::Client do
 
           @parallel_client.run_parallel_requests
 
-          first_request.response.handled_response.should eq(
+          expect(first_request.response.handled_response).to eq(
             'data' => {
               'series' => %w(2010-05-29 2010-05-30 2010-05-31),
               'values' => {
@@ -299,7 +241,7 @@ describe Mixpanel::Client do
             'legend_size' => 1
           )
 
-          second_request.response.handled_response.should eq(
+          expect(second_request.response.handled_response).to eq(
             'data' => {
               'series' => %w(2010-05-29 2010-05-30 2010-05-31),
               'values' => {
@@ -335,15 +277,15 @@ describe Mixpanel::Client do
         @client.api_secret
       )
 
-      unsorted_signature.should eq sorted_signature
+      expect(unsorted_signature).to eq sorted_signature
     end
   end
 
   describe '#to_hash' do
     it 'should return a ruby hash given json as a string' do
       expect(Mixpanel::Client::Utils.to_hash(
-        '{"a" : "ey", "b" : "bee"}',
-        :json
+               '{"a" : "ey", "b" : "bee"}',
+               :json
       )).to eq(
         'a' => 'ey',
         'b' => 'bee'

data/spec/mixpanel_client/properties_externalspec.rb

@@ -12,7 +12,7 @@ describe 'External calls to mixpanel' do
                               'mixpanel.yml'
     ))['mixpanel']
 
-    config.should_not be_nil
+    expect(config).not_to be_nil
     @client = Mixpanel::Client.new(config)
   end
 
@@ -21,7 +21,7 @@ describe 'External calls to mixpanel' do
       data = lambda do
         @client.request('properties', {})
       end
-      data.should raise_error(Mixpanel::HTTPError)
+      expect(data).to raise_error(Mixpanel::HTTPError)
     end
 
     it 'should return events' do
@@ -33,9 +33,8 @@ describe 'External calls to mixpanel' do
                              unit: 'hour',
                              interval: 24,
                              limit: 5,
-                             bucket: 'kicked'
-                            )
-      data.should_not be_a Exception
+                             bucket: 'kicked')
+      expect(data).not_to be_a Exception
     end
   end
 end

data/spec/mixpanel_client/uri_spec.rb

@@ -8,7 +8,7 @@ describe Mixpanel::URI do
       resource = 'events'
       params = { c: 'see', a: 'ey' }
 
-      Mixpanel::URI.mixpanel(resource, params).should eq(
+      expect(Mixpanel::URI.mixpanel(resource, params)).to eq(
         "#{Mixpanel::Client::BASE_URI}/events?a=ey&c=see"
       )
     end
@@ -18,7 +18,7 @@ describe Mixpanel::URI do
       resource = 'events/top'
       params = { c: 'see', a: 'ey' }
 
-      Mixpanel::URI.mixpanel(resource, params).should eq(
+      expect(Mixpanel::URI.mixpanel(resource, params)).to eq(
         "#{Mixpanel::Client::BASE_URI}/events/top?a=ey&c=see"
       )
     end
@@ -28,7 +28,7 @@ describe Mixpanel::URI do
       resource = 'export'
       params = { c: 'see', a: 'ey' }
 
-      Mixpanel::URI.mixpanel(resource, params).should eq(
+      expect(Mixpanel::URI.mixpanel(resource, params)).to eq(
         "#{Mixpanel::Client::DATA_URI}/export?a=ey&c=see"
       )
     end
@@ -37,7 +37,7 @@ describe Mixpanel::URI do
         import' do
       resource = 'import'
       params = { c: 'see', a: 'ey' }
-      Mixpanel::URI.mixpanel(resource, params).should eq(
+      expect(Mixpanel::URI.mixpanel(resource, params)).to eq(
         "#{Mixpanel::Client::IMPORT_URI}/import?a=ey&c=see"
       )
     end
@@ -47,8 +47,9 @@ describe Mixpanel::URI do
     it 'should return a string with url encoded values.' do
       params = { hey: '!@#$%^&*()\/"Ü', soo: 'hëllö?' }
 
-      Mixpanel::URI.encode(params).should eq(
-        'hey=%21%40%23%24%25%5E%26%2A%28%29%5C%2F%22%C3%9C&soo=h%C3%ABll%C3%B6%3F' # rubocop:disable LineLength
+      expect(Mixpanel::URI.encode(params)).to eq(
+        'hey=%21%40%23%24%25%5E%26%2A%28%29%5C%2F%22%C3%9C&' +
+        'soo=h%C3%ABll%C3%B6%3F'
       )
     end
   end
@@ -57,7 +58,8 @@ 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, 'secret').should eq 'something'
+      expect(Mixpanel::URI.get('http://example.com', nil, 'secret')).to \
+      eq('something')
     end
 
     context 'when timeout is not nil' do
@@ -75,7 +77,8 @@ 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, 'secret').should eq 'something'
+          expect(Mixpanel::URI.get('http://example.com', 3, 'secret')).to \
+          eq('something')
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel_client
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.1.6
 platform: ruby
 authors:
 - Keolo Keagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -157,6 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".document"
 - ".gitignore"
 - ".rubocop.yml"