search_flip 4.0.0.beta7 → 4.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9fcc6487802a3f4f2c26081fbb09a22cad112284a4faee6c144320c044fbbcd
-  data.tar.gz: 0caa17894a15d7eb03ad0a3e171ad94f80d85998caaa80b88162e5fc04a5bf97
+  metadata.gz: d63abc415f8eaad5ade7de6fc4ca424a8695b72016266a49a1d221f49530ca49
+  data.tar.gz: a6170648ed2663b769b123ae443c5d0863a4456ec39be35c2762186b93383cff
 SHA512:
-  metadata.gz: 2cf53c265c31136c50a0158f96f2c143a053304656dfcb7db3dd8ca3344031ebd724b3c3f5382451cfd6a805149619fe892b28eb47c2275d86bda042f4dfe526
-  data.tar.gz: e3ffe6f6ba945c62b45379607295af790df866b86489cc9d9f63fdf91f528e071b9da93d7067b16fab93e509e8acf87644de303bd7a63b6010e18b5439507fc3
+  metadata.gz: 7c7879bcf95f3e53c5186ec50592cf7e46b703b819c34e7d7e91229972652daf132b7a73b3f85051c6d86117f66278f83b5ac2f2b12c23272bb36130b0e7aa72
+  data.tar.gz: a04b20cbcf16eceb905798d1e5e2ea8dd60bb27b45bee9a0ab6f52aaed7d58e648a2f3139981117332a9824570db429f069ed749873dffd27ceb7cc274b3a7b4

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

@@ -11,6 +11,16 @@
 * Added `SearchFlip::Connection#get_cluster_settings` and
   `#update_cluster_settings`
 
+## v3.4.0
+
+* Expose `Http#timeout` via `SearchFlip::HTTPClient`
+
+## v3.3.0
+
+* Update httprb
+* Changed oj default options
+* Allow to set oj json options
+
 ## v3.2.1
 
 * Fix `refresh` having a empty body breaking in elasticsearch 7.11

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 = "4.0.0.beta7"
+  VERSION = "4.0.0.beta8"
 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: 4.0.0.beta7
+  version: 4.0.0.beta8
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord