swiftype 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54e1e3d18b1ef0d4ac96736071a83904c332fa62
-  data.tar.gz: 7c387aedb4ccca99caef021296dc6f9f2adad14f
+  metadata.gz: f11f2ce09ccdf271510c73431424c332a41182b9
+  data.tar.gz: e83507c697bbca3b65df19a806b9a99d93881d2b
 SHA512:
-  metadata.gz: 380b9b2cd117f33f243386e1b5dac701ceb460d6ffd4f5f898bdedd5717d77585f1049f07b396613ce18dbc5add22487f6444d07f062f069cceedce02e717576
-  data.tar.gz: ccf234d1156a1338b9c11f12c2e68b06fb7b0b58b94118c8c60c9fb80d67f5e994c7f138fdbc914ced223351c73e3945aa8d07559917ec7d382dc938fd258318
+  metadata.gz: 0cafb2792d12bdc1bbfef1e814c9c050a88318b17252e149f2caf989bc8a2baeeb5bd28a901cb46f17a7ef47d924195a8fe68dd230c5c428ca80585e2e14d814
+  data.tar.gz: 51c46e6e9f9bdc2f2055338bb5bb6e552908e177bbbf9c2a4fdf23c286da0e5f6f8ce16f3d13fb025c259ae3538695c954651e0192e25b8bd600d6eac87be7bf

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-script: rspec 
+script: rspec
 rvm:
   - 1.8.7
   - 1.9.3
@@ -10,3 +10,4 @@ rvm:
 before_install:
   - gem update --system
   - gem --version
+  - gem update bundler

data/lib/swiftype/client.rb

@@ -17,7 +17,8 @@ module Swiftype
     # @param options [Hash] a hash of configuration options that will override what is set on the Swiftype class.
     # @option options [String] :api_key an API Key to use for this client
     # @option options [String] :platform_access_token a user's access token, will be used instead of API key for authenticating requests
-    # @option options [Fixnum] :open_timeout the number of seconds Net::HTTP
+    # @option options [Numeric] :overall_timeout overall timeout for requests in seconds
+    # @option options [Numeric] :open_timeout the number of seconds Net::HTTP
     #   will wait while opening a connection before raising a Timeout::Error
 
     def initialize(options={})
@@ -36,6 +37,11 @@ module Swiftype
       @options[:open_timeout]
     end
 
+    def overall_timeout
+      @options[:overall_timeout].to_f
+    end
+
+
     # Methods wrapping the Swiftype private search and API endpoints. Using these methods, you can perform full-text
     # and prefix searches over the Documents in your Engine, in a specific DocumentType, or any subset of DocumentTypes.
     # You can also filter results and get faceted counts for results.

data/lib/swiftype/request.rb

@@ -1,5 +1,5 @@
 require 'net/https'
-if RUBY_VERSION < "1.9"
+if RUBY_VERSION < '1.9'
   require 'swiftype/ext/backport-uri'
 else
   require 'uri'
@@ -49,12 +49,15 @@ module Swiftype
       end
     end
 
+    # Construct and send a request to the API.
+    #
+    # @raise [Timeout::Error] when the timeout expires
     def request(method, path, params={})
       uri = URI.parse("#{Swiftype.endpoint}#{path}")
 
       request = build_request(method, uri, params)
       http = Net::HTTP.new(uri.host, uri.port)
-      http.open_timeout = @options[:open_timeout]
+      http.open_timeout = open_timeout
 
       if uri.scheme == 'https'
         http.use_ssl = true
@@ -62,7 +65,10 @@ module Swiftype
         http.ca_file = File.join(File.dirname(__FILE__), '..', 'data', 'ca-bundle.crt')
       end
 
-      response = http.request(request)
+      response = nil
+      Timeout.timeout(overall_timeout) do
+        response = http.request(request)
+      end
 
       handle_errors(response)
 

data/lib/swiftype/version.rb

@@ -1,3 +1,3 @@
 module Swiftype
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/spec/client_spec.rb

@@ -71,9 +71,35 @@ describe Swiftype::Client do
     let(:options_client) { Swiftype::Client.new(options) }
 
     context '#request' do
-      let(:options) { { :open_timeout => 3 } }
-      it 'respects the Net::HTTP open_timeout option' do
-        expect(options_client.open_timeout).to eq(3)
+      context 'open_timeout' do
+        let(:options) { { :open_timeout => 3 } }
+        it 'respects the Net::HTTP open_timeout option' do
+          expect(options_client.open_timeout).to eq(3)
+        end
+      end
+
+      context 'overall_timeout' do
+        context 'with timeout specified' do
+          let(:options) { { :overall_timeout => 0.001 } }
+          it 'respects the overall timeout option' do
+            expect(options_client.overall_timeout).to eq(0.001)
+            allow_any_instance_of(Net::HTTP).to receive(:request) { sleep 3 }
+            expect {
+              options_client.search(engine_slug, 'cat')
+            }.to raise_error(Timeout::Error)
+          end
+        end
+
+        context 'without timeout specified' do
+          let(:options) { Hash.new }
+          it 'omits the option' do
+            expect(options_client.overall_timeout).to eq(0.0)
+            expect(Timeout).to receive(:timeout).with(0.0).and_call_original
+            VCR.use_cassette(:engine_search) do
+              options_client.search(engine_slug, 'cat')
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swiftype
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Quin Hoxie
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: API client for accessing the Swiftype Search API with no dependencies
@@ -75,8 +75,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -181,17 +181,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Swiftype Search API
@@ -276,4 +276,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/ssl_spec.rb
 - spec/sso_spec.rb
-has_rdoc: