mixpanel_client 4.1.3 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16219b0342a1de3526173fec4cef7b177c7d3d90
-  data.tar.gz: d294629422b0281940850d1ae049d599f3d40bca
+  metadata.gz: 20fdfa3521f3281e6319ae41fa6d15e99dc37db2
+  data.tar.gz: 377594c3362e46afcdd5c8c29cd5f68fbe665a4d
 SHA512:
-  metadata.gz: 54d1c6e37edcac2164bf8916c413e441dbf961fcb7f57ccb2e5a8deaf5f1937d2461f866e5ed38e6ada430a608ed3f3ceaed227a00bad3b86bad9ef77aeea216
-  data.tar.gz: a8c5fc45ecebb8ed674a99fd34c2aded7ae1af0764c4ed765139e3d039fde35b14d04346d014bbbb8aeefc432928ad83800655e94e063bdaba49c80940b8730f
+  metadata.gz: f46b04fae019e68ed8160c165652e99d5ce53cfcfc9da77f9f1099e0104260ce79cae277f8d09f74390751591f8ff83752d88e0d66400c2e9d2671785577698f
+  data.tar.gz: da3cf583fa0a6a5ffb1d83095b402332fa53735a863a1d22176e950215510fe72cf830f047a3e454c095ded8d42fb6252f81a0d20a90049c6f832ff2263bf8fa

data/changelog.md

@@ -1,3 +1,6 @@
+### v4.1.4
+ * Add timeout option: Merged PR #48
+
 ### v4.1.3
  * Make request options optional. Closes #46.
 

data/lib/mixpanel/client.rb

@@ -14,7 +14,7 @@ module Mixpanel
     IMPORT_URI = 'https://api.mixpanel.com'
 
     attr_reader   :uri
-    attr_accessor :api_key, :api_secret, :parallel
+    attr_accessor :api_key, :api_secret, :parallel, :timeout
 
     # Configure the client
     #
@@ -27,6 +27,7 @@ module Mixpanel
       @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?
     end
@@ -63,7 +64,7 @@ module Mixpanel
     end
 
     def make_normal_request(resource)
-      response = URI.get(@uri)
+      response = URI.get(@uri, @timeout)
 
       if %w(export import).include?(resource) && @format != 'raw'
         response = %Q([#{response.split("\n").join(',')}])

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)
-      ::URI.parse(uri).read
+    def self.get(uri, timeout)
+      ::URI.parse(uri).read(read_timeout: timeout)
     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.3'
+    VERSION = '4.1.4'
   end
 end

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -25,6 +25,21 @@ describe Mixpanel::Client do
         parallel: true
       ).parallel.should eq true
     end
+
+    it 'should set a timeout option as nil by default' do
+      Mixpanel::Client.new(
+        api_key: 'test_key',
+        api_secret: 'test_secret'
+      ).timeout.should be_nil
+    end
+
+    it 'should be able to set a timeout option when passed' do
+      Mixpanel::Client.new(
+        api_key: 'test_key',
+        api_secret: 'test_secret',
+        timeout: 3
+      ).timeout.should eql 3
+    end
   end
 
   context 'when making an invalid request' do

data/spec/mixpanel_client/uri_spec.rb

@@ -53,7 +53,29 @@ 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').should eq 'something'
+      Mixpanel::URI.get('http://example.com', nil).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)
+          end.to raise_error Timeout::Error
+        end
+      end
+
+      context 'when the request does not timeout' 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'
+        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.3
+  version: 4.1.4
 platform: ruby
 authors:
 - Keolo Keagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mixpanel_client
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Mixpanel API Client Library