swiftype 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add2978c79c2494fc993252665bc65af92383ad5a00dc8e86eaae70114059aac
-  data.tar.gz: 5b03ebc6b72eca5793c0264c03db5b18150cc6de88daeabebb6d95fbc352c463
+  metadata.gz: bd466837b8766de157a54c3b8524e148ffde51c647e09ad4094cee027af6e105
+  data.tar.gz: 21f8de0c94f70755db7534181bc653ecabb85f6f94a824176f2cc8887e87a271
 SHA512:
-  metadata.gz: 4b5db4bfafb4975ed03ae34ebcdd86ce13aa8e5ccad65260608626dab59e4a61de4a56fda4731472289a758e0cf2d0a286f496ab90baa4a2841a9e1e9b04634f
-  data.tar.gz: b6d111e80d985366e60ed382d37183bd1fa72dd5fed5e8661f04ef4ef6d9f255cc6ebe121f2e1a96c10fa2532e27126effc4f5969579d841f0fe2e90ef507867
+  metadata.gz: '049de7bc87c7421f72018cdca475f2e877d7a21c112430f27254944fdd1acda197dfe04f7209391e257313a290bbd9aa8f183ec45343f6ad8f55a70a3fc403a2'
+  data.tar.gz: 2f45c1a6fc68d64c0968ee3567b10d98cbebc6a326ba06c07f719886151226b1fa656daace9cb21837b8bd2eaa0c8c3f58c08a6b2024447e64f3d7bc69b85199

data/README.md

@@ -52,6 +52,12 @@ You can also provide the API key when creating the client instance:
 
 If the API key is provided as an option to constructor, it will override the globally configured Swiftype API key (if any).
 
+### Specifying an HTTP Proxy
+
+    client = Swiftype::Client.new(:api_key => 'api_key', :proxy => 'http://localhost:8888')
+
+This client will also support configuring a proxy via the environment variable `http_proxy`.
+
 ### Full-text search
 
 If you want to search for `cat` on your engine, you can use:
@@ -185,7 +191,7 @@ Update multiple Documents at once:
     ])
 
 All methods above will have a return in the following format:
-    
+
     [
       {
         "id": "5473d6142ed96065a9000001",
@@ -410,4 +416,3 @@ or simply `Swiftype.api_key = 'your_api_key'`.
 You can run tests with `rspec`. All HTTP interactions are stubbed out using VCR.
 
 To contribute code to this gem, please fork the repository and submit a pull request.
-

data/lib/swiftype/client.rb

@@ -21,6 +21,7 @@ module Swiftype
     # @option options [String] :platform_access_token a user's access token, will be used instead of API key for authenticating requests
     # @option options [Numeric] :overall_timeout overall timeout for requests in seconds (default: 15s)
     # @option options [Numeric] :open_timeout the number of seconds Net::HTTP (default: 15s)
+    # @option options [String] :proxy url of proxy to use, ex: "http://localhost:8888"
     #   will wait while opening a connection before raising a Timeout::Error
 
     def initialize(options={})
@@ -35,6 +36,10 @@ module Swiftype
       @options[:platform_access_token]
     end
 
+    def proxy
+      @options[:proxy]
+    end
+
     def open_timeout
       @options[:open_timeout] || DEFAULT_TIMEOUT
     end

data/lib/swiftype/request.rb

@@ -57,7 +57,14 @@ module Swiftype
         uri = URI.parse("#{Swiftype.endpoint}#{path}")
 
         request = build_request(method, uri, params)
-        http = Net::HTTP.new(uri.host, uri.port)
+
+        if proxy
+          proxy_parts = URI.parse(proxy)
+          http = Net::HTTP.new(uri.host, uri.port, proxy_parts.host, proxy_parts.port)
+        else
+          http = Net::HTTP.new(uri.host, uri.port)
+        end
+
         http.open_timeout = open_timeout
         http.read_timeout = overall_timeout
 

data/lib/swiftype/version.rb

@@ -1,3 +1,3 @@
 module Swiftype
-  VERSION = "1.2.3"
+  VERSION = "1.3.0"
 end

data/spec/client_spec.rb

@@ -101,6 +101,23 @@ describe Swiftype::Client do
           end
         end
       end
+
+      context 'with proxy specified' do
+        let(:options) { { :proxy => 'http://localhost:8888' } }
+
+        it 'will set proxy' do
+          expect(options_client.proxy).to eq('http://localhost:8888')
+        end
+
+        # There doesn't seem to be an elgant way to test that a request actually uses a proxy, so the best
+        # we can do here is ensure that the behavior for methods operates normally
+        it 'will execute methods with proxy' do
+          VCR.use_cassette(:engine_search) do
+            results = options_client.search(engine_slug, 'cat')
+            expect(results.document_types.size).to eq(2)
+          end
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swiftype
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Quin Hoxie
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec