search_flip 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a241c0ab86244a53caab6b7d8dbcd8f441d9e7fc40837cc9afa7f57e6c7e5da0
-  data.tar.gz: f42562bd8af88780accd33c91c112c9f81b42de8945aa956c118b7faff75c6f6
+  metadata.gz: 06f3e293add0a92612ea73a6b8d448cc3866f30c908d96af5700466254b779d1
+  data.tar.gz: 158f3cf97a4ac2443a38d71f61764e7b10e9ba9df21883722e1fa5e300f5d9ca
 SHA512:
-  metadata.gz: ad60516d947d060ca1fe049a80059c18e9deb76f7c380b0279cd11cd5b5e0fb811d3a46a12220fd731b793ce1a6728f23e6cb242410f584d040e874a2bed7d78
-  data.tar.gz: 415962179b2e3ead79296851746b5f4892bdfbce64d09ae6ef2a2f0df83fa265b1c00a8a549d42013911eaff7ecc0b0460d20ef5c72d096f070d1adce4d0797c
+  metadata.gz: 83e349b1b4f9a67335b71e2d818649e4550fe42ae39d354aae9ca078f7c484e37169e33eea5bd7802002e09e7efbc41f09e67fbb7024d7541037af7dd7081d8f
+  data.tar.gz: 559742084c2374b6c66f1ec3c9edd3c4193d897b3b2df2c3935e5a2587bf558aaf062fcb9428b2601b33abe0ab79c6b46e6c100ef3b1a25e845461a053da293f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 
 # CHANGELOG
 
+## v3.7.0
+
+* Add `SearchFlip::Connection#bulk` to allow more clean bulk indexing to
+  multiple indices at once
+
 ## v3.6.0
 
 * Support Elasticsearch v8

data/README.md

@@ -9,7 +9,7 @@
 Using SearchFlip it is dead-simple to create index classes that correspond to
 [Elasticsearch](https://www.elastic.co/) indices and to manipulate, query and
 aggregate these indices using a chainable, concise, yet powerful DSL. Finally,
-SearchFlip supports Elasticsearch 2.x, 5.x, 6.x, 7.x. Check section
+SearchFlip supports Elasticsearch 2.x, 5.x, 6.x, 7.x and 8.x. Check section
 [Feature Support](#feature-support) for version dependent features.
 
 ```ruby

data/lib/search_flip/connection.rb

@@ -355,6 +355,51 @@ module SearchFlip
       raise e
     end
 
+    # Initiates and yields a bulk object, such that index, import, create,
+    # update and delete requests can be appended to the bulk request. Please
+    # note that you need to manually pass the desired index name as well as
+    # type name (depending on the Elasticsearch version) when using #bulk on a
+    # connection object or Elasticsearch will return an error. After the bulk
+    # requests are successfully processed all existing indices will
+    # subsequently be refreshed when auto_refresh is enabled.
+    #
+    # @see SearchFlip::Config See SearchFlip::Config for auto_refresh
+    #
+    # @example
+    #   connection = SearchFlip::Connection.new
+    #
+    #   connection.bulk ignore_errors: [409] do |bulk|
+    #     bulk.create comment.id, CommentIndex.serialize(comment),
+    #       _index: CommentIndex.index_name, version: comment.version, version_type: "external_gte"
+    #
+    #     bulk.delete product.id, _index: ProductIndex.index_name, routing: product.user_id
+    #
+    #     # ...
+    #   end
+    #
+    # @param options [Hash] Specifies options regarding the bulk indexing
+    # @option options ignore_errors [Array] Specifies an array of http status
+    #   codes that shouldn't raise any exceptions, like eg 409 for conflicts,
+    #   ie when optimistic concurrency control is used.
+    # @option options raise [Boolean] Prevents any exceptions from being
+    #   raised. Please note that this only applies to the bulk response, not to
+    #   the request in general, such that connection errors, etc will still
+    #   raise.
+
+    def bulk(options = {})
+      default_options = {
+        http_client: http_client,
+        bulk_limit: bulk_limit,
+        bulk_max_mb: bulk_max_mb
+      }
+
+      SearchFlip::Bulk.new("#{base_url}/_bulk", default_options.merge(options)) do |indexer|
+        yield indexer
+      end
+
+      refresh if SearchFlip::Config[:auto_refresh]
+    end
+
     # Returns the full Elasticsearch type URL, ie base URL, index name with
     # prefix and type name.
     #

data/lib/search_flip/index.rb

@@ -601,7 +601,7 @@ module SearchFlip
         scope
       end
 
-      # Initiates and yields the bulk object, such that index, import, create,
+      # Initiates and yields a bulk object, such that index, import, create,
       # update and delete requests can be appended to the bulk request. Sends a
       # refresh request afterwards if auto_refresh is enabled.
       #

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.6.0"
+  VERSION = "3.7.0"
 end

data/search_flip.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.post_install_message = <<~MESSAGE

data/spec/search_flip/connection_spec.rb

@@ -315,6 +315,96 @@ RSpec.describe SearchFlip::Connection do
     end
   end
 
+  describe "#bulk" do
+    it "imports objects to the specified indices" do
+      connection = SearchFlip::Connection.new
+
+      bulk = proc do
+        connection.bulk do |indexer|
+          indexer.index 1, { id: 1 }, _index: ProductIndex.index_name, ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+          indexer.index 2, { id: 2 }, _index: ProductIndex.index_name, ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+          indexer.index 1, { id: 1 }, _index: CommentIndex.index_name, ** connection.version.to_i < 8 ? { _type: CommentIndex.type_name } : {}
+        end
+      end
+
+      expect(&bulk).to(change { CommentIndex.total_count }.by(1).and(change { CommentIndex.total_count }.by(1)))
+    end
+
+    it "raises when no index is given" do
+      connection = SearchFlip::Connection.new
+
+      bulk = proc do
+        connection.bulk do |indexer|
+          indexer.index 1, id: 1
+        end
+      end
+
+      expect(&bulk).to raise_error(SearchFlip::ResponseError)
+    end
+
+    it "respects options" do
+      connection = SearchFlip::Connection.new
+
+      connection.bulk do |indexer|
+        indexer.index 1, { id: 1 }, _index: ProductIndex.index_name, ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+        indexer.index 2, { id: 2 }, _index: ProductIndex.index_name, ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+      end
+
+      bulk = proc do
+        connection.bulk do |indexer|
+          indexer.index 1, { id: 1 }, _index: ProductIndex.index_name, version: 1, version_type: "external", ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+          indexer.index 2, { id: 2 }, _index: ProductIndex.index_name, version: 1, version_type: "external", ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+        end
+      end
+
+      expect(&bulk).to raise_error(SearchFlip::Bulk::Error)
+
+      bulk = proc do
+        connection.bulk ignore_errors: [409] do |indexer|
+          indexer.index 1, { id: 1 }, _index: ProductIndex.index_name, version: 1, version_type: "external", ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+          indexer.index 2, { id: 2 }, _index: ProductIndex.index_name, version: 1, version_type: "external", ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+        end
+      end
+
+      expect(&bulk).not_to(change { ProductIndex.total_count })
+    end
+
+    it "passes default options" do
+      allow(SearchFlip::Bulk).to receive(:new)
+
+      connection = SearchFlip::Connection.new
+
+      connection.bulk do |indexer|
+        indexer.index 1, { id: 1 }, _index: ProductIndex.index_name, ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+      end
+
+      expect(SearchFlip::Bulk).to have_received(:new).with(
+        anything,
+        http_client: connection.http_client,
+        bulk_limit: connection.bulk_limit,
+        bulk_max_mb: connection.bulk_max_mb
+      )
+    end
+
+    it "passes custom options" do
+      allow(SearchFlip::Bulk).to receive(:new)
+
+      connection = SearchFlip::Connection.new
+
+      options = {
+        bulk_limit: "bulk limit",
+        bulk_max_mb: "bulk max mb",
+        http_client: "http client"
+      }
+
+      connection.bulk(options) do |indexer|
+        indexer.index 1, { id: 1 }, _index: ProductIndex.index_name, ** connection.version.to_i < 8 ? { _type: ProductIndex.type_name } : {}
+      end
+
+      expect(SearchFlip::Bulk).to have_received(:new).with(anything, options)
+    end
+  end
+
   describe "#index_url" do
     it "returns the index url for the specified index" do
       connection = SearchFlip::Connection.new(base_url: "base_url")

data/spec/spec_helper.rb

@@ -16,6 +16,8 @@ RSpec.configure do |config|
     TestIndex.delete_index if TestIndex.index_exists?
     ProductIndex.match_all.delete
     Product.delete_all
+    CommentIndex.match_all.delete
+    Comment.delete_all
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-27 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -305,18 +305,4 @@ rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Full-Featured Elasticsearch Ruby Client with a Chainable DSL
-test_files:
-- spec/delegate_matcher.rb
-- spec/search_flip/aggregation_spec.rb
-- spec/search_flip/aws_sigv4_plugin_spec.rb
-- spec/search_flip/bulk_spec.rb
-- spec/search_flip/connection_spec.rb
-- spec/search_flip/criteria_spec.rb
-- spec/search_flip/http_client_spec.rb
-- spec/search_flip/index_spec.rb
-- spec/search_flip/json_spec.rb
-- spec/search_flip/model_spec.rb
-- spec/search_flip/null_instrumenter_spec.rb
-- spec/search_flip/response_spec.rb
-- spec/search_flip/result_spec.rb
-- spec/spec_helper.rb
+test_files: []