keen 0.9.9 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38dbcdb5882d0ecaca4d8a069ba569b12ed28fc7
-  data.tar.gz: 9a5278be0634db7ca4658b9dff70c46b0750e77e
+  metadata.gz: e480ce2b302b1c4176b0d7af6860fdcadab0d18c
+  data.tar.gz: 9e6563894e8ca2c84e6e1812e251d3ad4c792bcd
 SHA512:
-  metadata.gz: ce6065efb92a0ec0aa8073a43ee0f7a3df9da5dd412ed967b84ae88af4e51c3ca8043cfe10f85635e5aa6978fba720ff6d11a8deabd8a3547d3529f3358ea791
-  data.tar.gz: d1a51bd9f953b0d401654b28e1ccc08623cba520a978db467d0ab146d30c15d0dae221ac41e57529bbb6e987b0376a067fe9cb201fee51f3b6d834a45fe20363
+  metadata.gz: be393227858df11b2ef2f8a1b87326747e13285d318d9fc627ebd8449e816ec80788a19ca70c576599b6be201cfddb45617572d773dc2fa2c7da4b92d8f1ea26
+  data.tar.gz: 33fa125a869b6969587a0f5e32c0e09b665f98b1f8e3ea7342c3d1d11e1f7ce3c5361edd8e2db5a919060325e8464e0c727bceac74348b492eb8e27d30613380

data/README.md

@@ -375,12 +375,19 @@ You can use the scoped key created in Ruby for API requests from any client. Sco
 
 ##### HTTP Read Timeout
 
-The default `Net:HTTP` timeout is 60 seconds. That's usually enough, but if you're querying over a large collection you may need to increase it. The timeout on the API side is 300 seconds, so that's as far as you'd want to go. You can configure a read timeout (in seconds) by setting a `KEEN_READ_TIMEOUT` environment variable, or by passing in a `read_timeout` option to the client constructor as follows:
+The default `Net::HTTP` timeout is 60 seconds. That's usually enough, but if you're querying over a large collection you may need to increase it. The timeout on the API side is 300 seconds, so that's as far as you'd want to go. You can configure a read timeout (in seconds) by setting a `KEEN_READ_TIMEOUT` environment variable, or by passing in a `read_timeout` option to the client constructor as follows:
 
 ``` ruby
 keen = Keen::Client.new(:read_timeout => 300)
 ```
 
+You can also configure the `NET::HTTP` open timeout, default is 60 seconds. To configure the timeout (in seconds) either set `KEEN_OPEN_TIMEOUT` environment variable, or by passing in a `open_timeout` option to the client constructor as follows:
+
+``` ruby
+keen = Keen::Client.new(:open_timeout => 30)
+```
+
+
 ##### HTTP Proxy
 
 You can set the `KEEN_PROXY_TYPE` and `KEEN_PROXY_URL` environment variables to enable HTTP proxying. `KEEN_PROXY_TYPE` should be set to `socks5`. You can also configure this on client instances by passing in `proxy_type` and `proxy_url` keys.
@@ -412,6 +419,9 @@ If you want some bot protection, check out the [Voight-Kampff](https://github.co
 
 ### Changelog
 
+##### 0.9.10
++ Add ability to set the `open_time` setting for the http client.
+
 ##### 0.9.9
 + Added the ability to send additional optional headers.
 
@@ -419,7 +429,7 @@ If you want some bot protection, check out the [Voight-Kampff](https://github.co
 + Added a new header `Keen-Sdk` that sends the SDK version information on all requests.
 
 ##### 0.9.6
-+ Updated behavior of saved queries to allow fetching results using the READ KEY as opposed to requiring the MASTER KEY, making the gem consistent with https://keen.io/docs/api/#getting-saved-query-results 
++ Updated behavior of saved queries to allow fetching results using the READ KEY as opposed to requiring the MASTER KEY, making the gem consistent with https://keen.io/docs/api/#getting-saved-query-results
 
 ##### 0.9.5
 + Fix bug with scoped key generation not working with newer Keen projects.

data/lib/keen.rb

@@ -75,7 +75,8 @@ module Keen
         :api_url => ENV['KEEN_API_URL'],
         :proxy_url => ENV['KEEN_PROXY_URL'],
         :proxy_type => ENV['KEEN_PROXY_TYPE'],
-        :read_timeout => ENV['KEEN_READ_TIMEOUT']
+        :read_timeout => ENV['KEEN_READ_TIMEOUT'],
+        :open_timeout => ENV['KEEN_OPEN_TIMEOUT']
       )
     end
   end

data/lib/keen/client.rb

@@ -17,7 +17,7 @@ module Keen
     include Keen::Client::QueryingMethods
     include Keen::Client::MaintenanceMethods
 
-    attr_accessor :project_id, :write_key, :read_key, :master_key, :api_url, :proxy_url, :proxy_type, :read_timeout
+    attr_accessor :project_id, :write_key, :read_key, :master_key, :api_url, :proxy_url, :proxy_type, :read_timeout, :open_timeout
 
     CONFIG = {
       :api_url => "https://api.keen.io",
@@ -54,6 +54,8 @@ module Keen
       self.proxy_url, self.proxy_type = options.values_at(:proxy_url, :proxy_type)
 
       self.read_timeout = options[:read_timeout].to_f unless options[:read_timeout].nil?
+
+      self.open_timeout = options[:open_timeout].to_f unless options[:open_timeout].nil?
     end
 
     def saved_queries

data/lib/keen/client/maintenance_methods.rb

@@ -87,7 +87,7 @@ module Keen
       private
 
       def http_sync
-        @http_sync ||= Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout)
+        @http_sync ||= Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout, self.open_timeout)
       end
 
     end

data/lib/keen/client/publishing_methods.rb

@@ -161,7 +161,7 @@ module Keen
       def publish_body(path, body, error_method)
         begin
           response = Keen::HTTP::Sync.new(
-            self.api_url, self.proxy_url, self.read_timeout).post(
+            self.api_url, self.proxy_url, self.read_timeout, self.open_timeout).post(
               :path => path,
               :headers => api_headers(self.write_key, "sync"),
               :body => body)

data/lib/keen/client/querying_methods.rb

@@ -242,7 +242,7 @@ module Keen
 
         query_params = params.dup
         query_params[:event_collection] = event_collection.to_s if event_collection
-        Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout).post(
+        Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout, self.open_timeout).post(
           :path => api_query_resource_path(analysis_type),
           :headers => request_headers(options),
           :body => MultiJson.encode(query_params)
@@ -262,7 +262,7 @@ module Keen
 
       def get_response(url, options={})
         uri = URI.parse(url)
-        Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout).get(
+        Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout, self.open_timeout).get(
           :path => "#{uri.path}?#{uri.query}",
           :headers => request_headers(options)
         )

data/lib/keen/client/saved_queries.rb

@@ -25,7 +25,7 @@ class SavedQueries
   end
 
   def create(saved_query_name, saved_query_body)
-    response = Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout).put(
+    response = Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout, client.open_timeout).put(
       path: "#{saved_query_base_url}/#{saved_query_name}",
       headers: api_headers(client.master_key, "sync"),
       body: saved_query_body
@@ -35,7 +35,7 @@ class SavedQueries
   alias_method :update, :create
 
   def delete(saved_query_name)
-    response = Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout).delete(
+    response = Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout, client.open_timeout).delete(
       path: "#{saved_query_base_url}/#{saved_query_name}",
       headers: api_headers(client.master_key, "sync")
     )
@@ -47,7 +47,7 @@ class SavedQueries
   attr_reader :client
 
   def saved_query_response(api_key, path = "")
-    Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout).get(
+    Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout, client.open_timeout).get(
       path: saved_query_base_url + path,
       headers: api_headers(api_key, "sync")
     )

data/lib/keen/http.rb

@@ -1,7 +1,7 @@
 module Keen
   module HTTP
     class Sync
-      def initialize(base_url, proxy_url=nil, read_timeout=nil)
+      def initialize(base_url, proxy_url=nil, read_timeout=nil, open_timeout=nil)
         require 'uri'
         require 'net/http'
 
@@ -10,6 +10,7 @@ module Keen
         arguments+= proxy_arguments_for(proxy_url) if proxy_url
 
         @http = Net::HTTP.new(*arguments)
+        @http.open_timeout = open_timeout if open_timeout
         @http.read_timeout = read_timeout if read_timeout
 
         if uri.scheme == "https"

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.9.9"
+  VERSION = "0.9.10"
 end

data/spec/keen/client_spec.rb

@@ -7,6 +7,7 @@ describe Keen::Client do
   let(:api_url) { "http://fake.keen.io:fakeport" }
   let(:client) { Keen::Client.new(:project_id => project_id) }
   let(:read_timeout) { 40 }
+  let(:open_timeout) { 10 }
 
   before do
     ENV["KEEN_PROJECT_ID"] = nil
@@ -14,6 +15,7 @@ describe Keen::Client do
     ENV["KEEN_READ_KEY"] = nil
     ENV["KEEN_API_URL"] = nil
     ENV["KEEN_READ_TIMEOUT"] = nil
+    ENV["KEEN_OPEN_TIMEOUT"] = nil
   end
 
   describe "#initialize" do
@@ -32,12 +34,14 @@ describe Keen::Client do
         :write_key => write_key,
         :read_key => read_key,
         :api_url => api_url,
-        :read_timeout => read_timeout)
+        :read_timeout => read_timeout,
+        :open_timeout => open_timeout)
       expect(client.write_key).to eq(write_key)
       expect(client.read_key).to eq(read_key)
       expect(client.project_id).to eq(project_id)
       expect(client.api_url).to eq(api_url)
       expect(client.read_timeout).to eq(read_timeout)
+      expect(client.open_timeout).to eq(open_timeout)
     end
 
     it "should set a default api_url" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors:
 - Alex Kleissner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-03 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json