search_flip 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021f5dd6d172381d777444631e96f2ebff0759b002f38b9ca555f844184d5dd9
-  data.tar.gz: ded7bbcab491ca187a68214377aa1f6ab2e3774739224744181aca16cf81e504
+  metadata.gz: 6722b210d8b3d0baa98e3370f26e2f293a21ea7db15dd08ba47deb2a1dba4e1c
+  data.tar.gz: a66d9f5482e06ae11cffeece148a8eb290523ee6ec4c91f510c1258b1c780225
 SHA512:
-  metadata.gz: adc9acf973b399aa0595bdc42705516f9a13cb4cfbd18b5ee5db613d8c91261c3bba80834848b8079c4569431dfcbcff0368787b5edeb42f517e864721a54bef
-  data.tar.gz: 0b8769e3c59d1953036b2fc1618cfbd15db7bc4d19beef0a71e24aeb82830b499eff820e061b397ee20c15d4942941df69cc4dff2b20e4b35119193e78af74b7
+  metadata.gz: 4e60dbae8d1bf0c4be3964bd0daf0740c4dd89827d61481d21960af17f34b237b512dde09f08111949d9b728bc3290c59a535930e168aaa562c30c9f74faa841
+  data.tar.gz: 3b7d941dee59924dc47b486e5cd3d88af8a3a9a42e8f6952e14934087e2a0acbe0014ee09caabec373640c35c5ae1d72a433e2100fcd2257e8d920c09f39e3b6

data/.github/workflows/test.yml

@@ -13,9 +13,9 @@ jobs:
         - docker.elastic.co/elasticsearch/elasticsearch:7.0.0
         - docker.elastic.co/elasticsearch/elasticsearch:7.11.2
         ruby:
-        - 2.5
         - 2.6
         - 2.7
+        - 3.0
     services:
       elasticsearch:
         image: ${{ matrix.elasticsearch }}

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 
 # CHANGELOG
 
+## v3.4.0
+
+* Expose `Http#timeout` via `SearchFlip::HTTPClient`
+
 ## v3.3.0
 
 * Update httprb

data/README.md

@@ -756,7 +756,7 @@ end
 This allows to use different clusters per index e.g. when migrating indices to
 new versions of Elasticsearch.
 
-You can specify basic auth, additional headers, etc via:
+You can specify basic auth, additional headers, request timeouts, etc via:
 
 ```ruby
 http_client = SearchFlip::HTTPClient.new
@@ -773,6 +773,9 @@ http_client = http_client.via("proxy.host", 8080)
 # Custom headers
 http_client = http_client.headers(key: "value")
 
+# Timeouts
+http_client = http_client.timeout(20)
+
 SearchFlip::Connection.new(base_url: "...", http_client: http_client)
 ```
 

data/lib/search_flip/http_client.rb

@@ -1,7 +1,28 @@
 module SearchFlip
-  # The SearchFlip::HTTPClient class wraps the http gem, is for internal use
-  # and responsible for the http request/response handling, ie communicating
-  # with Elasticsearch.
+  # The SearchFlip::HTTPClient class wraps the http gem and responsible for the
+  # http request/response handling, ie communicating with Elasticsearch. You
+  # only need to use it directly if you need authentication to communicate with
+  # Elasticsearch or if you want to set some custom http settings.
+  #
+  # @example
+  #   http_client = SearchFlip::HTTPClient.new
+  #
+  #   # Basic Auth
+  #   http_client = http_client.basic_auth(user: "username", pass: "password")
+  #
+  #   # Raw Auth Header
+  #   http_client = http_client.auth("Bearer VGhlIEhUVFAgR2VtLCBST0NLUw")
+  #
+  #   # Proxy Settings
+  #   http_client = http_client.via("proxy.host", 8080)
+  #
+  #   # Custom headers
+  #   http_client = http_client.headers(key: "value")
+  #
+  #   # Timeouts
+  #   http_client = http_client.timeout(20)
+  #
+  #   SearchFlip::Connection.new(base_url: "...", http_client: http_client)
 
   class HTTPClient
     attr_accessor :request, :plugins
@@ -14,11 +35,11 @@ module SearchFlip
     class << self
       extend Forwardable
 
-      def_delegators :new, :headers, :via, :basic_auth, :auth
+      def_delegators :new, :headers, :via, :basic_auth, :auth, :timeout
       def_delegators :new, :get, :post, :put, :delete, :head
     end
 
-    [:headers, :via, :basic_auth, :auth].each do |method|
+    [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
       define_method method do |*args|
         dup.tap do |client|
           client.request = request.send(method, *args)

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.3.0"
+  VERSION = "3.4.0"
 end

data/spec/search_flip/http_client_spec.rb

@@ -7,7 +7,7 @@ class HttpTestRequest
     self.calls = []
   end
 
-  [:via, :basic_auth, :auth].each do |method|
+  [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
     define_method method do |*args|
       dup.tap do |request|
         request.calls = calls + [[method, args]]
@@ -20,7 +20,7 @@ RSpec.describe SearchFlip::HTTPClient do
   describe "delegation" do
     subject { SearchFlip::HTTPClient }
 
-    [:headers, :via, :basic_auth, :auth].each do |method|
+    [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
       it { should delegate(method).to(:new) }
     end
 
@@ -56,8 +56,12 @@ RSpec.describe SearchFlip::HTTPClient do
     end
   end
 
-  [:via, :basic_auth, :auth].each do |method|
+  [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
     describe "##{method}" do
+      it "is understood by HTTP" do
+        expect(HTTP.respond_to?(method)).to eq(true)
+      end
+
       it "creates a dupped instance" do
         client = SearchFlip::HTTPClient.new
         client.request = HttpTestRequest.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord