search_flip 2.0.0.beta5 → 2.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0d1ed2d2431d99cbe9949cb24154bfda3c2188713eb7432a6a8f1c6d5e45fe8
-  data.tar.gz: fbb8f6f7989552d6944a3d238ab3ca22c5ff2ca2c2c3ca7dddf1a3d8c4825ecc
+  metadata.gz: 47ca9a2ae9454e232a82a2d0ca91d58cb0f8d79e087795c0e9dbae5ad9ac6216
+  data.tar.gz: 721e6a0b0cc6abbf8d501e09903a1c9a3cb0ba526f1c9a403461ec38c3607f15
 SHA512:
-  metadata.gz: 2f72caff2b7806d19d88d31ea8900fa739d10975d121d83245e7111552cbfc95fda81dde504f8b235ed4fdc6a9a6a3056029c404a638045d86a6c9fc606a23fd
-  data.tar.gz: ea91ff174b46ad96bb29a94a9173ba9295ec503e731abc6e0956b1788dd73197aebc75c43eb302f59c6554822c5ebf2c7dee6006878462137ad1e57b1c512dad
+  metadata.gz: d0b4d33d00bb54b2d0b16fd1df450f93a412097312ac8726ab5f3d76bfd5c4c89a1374d6f61cf62920ebd4d86f209da330b20dd61a446c0d3bf5b25036b4cee3
+  data.tar.gz: 4d18ae080aa3dbdbdd024e5a3ce33529c002162bf9b5057848c7813546aab64dc82d2cd0ff91de26b155898559834bb8aabec961bea51488abe829ca5782dc52

data/README.md

@@ -91,6 +91,7 @@ Available config options are:
   can be useful to separate the indices of e.g. testing and development environments.
 * `base_url` to tell search_flip how to connect to your cluster
 * `bulk_limit` a global limit for bulk requests
+* `bulk_max_mb` a global limit for the payload of bulk requests
 * `auto_refresh` tells search_flip to automatically refresh an index after
   import, index, delete, etc operations. This is e.g. usuful for testing, etc.
   Defaults to false.

data/lib/search_flip/aggregation.rb

@@ -65,7 +65,8 @@ module SearchFlip
           :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value, :limit_value,
           :scroll_args, :highlight_values, :suggest_values, :custom_value, :source_value, :sort_values,
           :includes_values, :preload_values, :eager_load_values, :post_search_values, :post_must_values,
-          :post_must_not_values, :post_should_values, :post_filter_values
+          :post_must_not_values, :post_should_values, :post_filter_values, :preference_value,
+          :search_type_value, :routing_value
         ]
 
         unsupported_methods.each do |unsupported_method|

data/lib/search_flip/bulk.rb

@@ -1,5 +1,7 @@
 
 module SearchFlip
+  # @api private
+  #
   # The SearchFlip::Bulk class implements the bulk support, ie it collects
   # single requests and emits batches of requests.
   #
@@ -16,6 +18,8 @@ module SearchFlip
 
     attr_reader :url, :options, :ignore_errors
 
+    # @api private
+    #
     # Builds and yields a new Bulk object, ie initiates the buffer, yields,
     # sends batches of records each time the buffer is full, and sends a final
     # batch after the yielded code returns and there are still documents
@@ -33,8 +37,10 @@ module SearchFlip
     #
     # @param url [String] The endpoint to send bulk requests to
     # @param options [Hash] Options for the bulk requests
-    # @option options batch_size [Fixnum] The maximum number of documents per bulk
+    # @option options bulk_limit [Fixnum] The maximum number of documents per bulk
     #   request
+    # @option bulk_max_mb [Fixnum] The maximum payload size in megabytes per
+    #   bulk request
     # @option options ignore_errors [Array, Fixnum] Errors that should be
     #   ignored. If you eg want to ignore errors resulting from conflicts,
     #   you can specify to ignore 409 here.
@@ -62,6 +68,8 @@ module SearchFlip
       upload if @num > 0
     end
 
+    # @api private
+    #
     # Adds an index request to the bulk batch.
     #
     # @param id [Fixnum, String] The document/record id
@@ -73,6 +81,8 @@ module SearchFlip
       perform :index, id, SearchFlip::JSON.generate(object), options
     end
 
+    # @api private
+    #
     # Adds an index request to the bulk batch
     #
     # @see #index
@@ -81,6 +91,8 @@ module SearchFlip
       index(*args)
     end
 
+    # @api private
+    #
     # Adds a create request to the bulk batch.
     #
     # @param id [Fixnum, String] The document/record id
@@ -92,6 +104,8 @@ module SearchFlip
       perform :create, id, SearchFlip::JSON.generate(object), options
     end
 
+    # @api private
+    #
     # Adds a update request to the bulk batch.
     #
     # @param id [Fixnum, String] The document/record id
@@ -103,6 +117,8 @@ module SearchFlip
       perform :update, id, SearchFlip::JSON.generate(object), options
     end
 
+    # @api private
+    #
     # Adds a delete request to the bulk batch.
     #
     # @param id [Fixnum, String] The document/record id

data/lib/search_flip/criteria.rb

@@ -19,8 +19,10 @@ module SearchFlip
     include SearchFlip::Aggregatable
     extend Forwardable
 
-    attr_accessor :target, :profile_value, :source_value, :sort_values, :highlight_values, :suggest_values, :offset_value, :limit_value,
-      :includes_values, :eager_load_values, :preload_values, :failsafe_value, :scroll_args, :custom_value, :terminate_after_value, :timeout_value
+    attr_accessor :target, :profile_value, :source_value, :sort_values, :highlight_values, :suggest_values,
+      :offset_value, :limit_value, :includes_values, :eager_load_values, :preload_values, :failsafe_value,
+      :scroll_args, :custom_value, :terminate_after_value, :timeout_value, :preference_value,
+      :search_type_value, :routing_value
 
     # Creates a new criteria while merging the attributes (constraints,
     # settings, etc) of the current criteria with the attributes of another one
@@ -46,6 +48,9 @@ module SearchFlip
         criteria.limit_value = other.limit_value if other.limit_value
         criteria.scroll_args = other.scroll_args if other.scroll_args
         criteria.source_value = other.source_value if other.source_value
+        criteria.preference_value = other.preference_value if other.preference_value
+        criteria.search_type_value = other.search_type_value if other.search_type_value
+        criteria.routing_value = other.routing_value if other.routing_value
 
         criteria.sort_values = (criteria.sort_values || []) + other.sort_values if other.sort_values
         criteria.includes_values = (criteria.includes_values || []) + other.includes_values if other.includes_values
@@ -69,6 +74,54 @@ module SearchFlip
       end
     end
 
+    # Specifies a preference value for the request. Check out the elasticsearch
+    # docs for further details.
+    #
+    # @example
+    #   CommentIndex.preference("_primary")
+    #
+    # @param value The preference value
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def preference(value)
+      fresh.tap do |criteria|
+        criteria.preference_value = value
+      end
+    end
+
+    # Specifies the search type value for the request. Check out the elasticsearch
+    # docs for further details.
+    #
+    # @example
+    #   CommentIndex.search_type("dfs_query_then_fetch")
+    #
+    # @param value The search type value
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def search_type(value)
+      fresh.tap do |criteria|
+        criteria.search_type_value = value
+      end
+    end
+
+    # Specifies the routing value for the request. Check out the elasticsearch
+    # docs for further details.
+    #
+    # @example
+    #   CommentIndex.routing("user_id")
+    #
+    # @param value The search type value
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def routing(value)
+      fresh.tap do |criteria|
+        criteria.routing_value = value
+      end
+    end
+
     # Specifies a query timeout, such that the processing will be stopped after
     # that timeout and only the results calculated up to that point will be
     # processed and returned.
@@ -360,9 +413,9 @@ module SearchFlip
       dupped_request.delete(:size)
 
       if connection.version.to_i >= 5
-        connection.http_client.post("#{target.type_url}/_delete_by_query", json: dupped_request)
+        connection.http_client.post("#{target.type_url}/_delete_by_query", params: request_params, json: dupped_request)
       else
-        connection.http_client.delete("#{target.type_url}/_query", json: dupped_request)
+        connection.http_client.delete("#{target.type_url}/_query", params: request_params, json: dupped_request)
       end
 
       target.refresh if SearchFlip::Config[:auto_refresh]
@@ -722,21 +775,22 @@ module SearchFlip
             if connection.version.to_i >= 2
               http_request.post(
                 "#{connection.base_url}/_search/scroll",
+                params: request_params,
                 json: { scroll: scroll_args[:timeout], scroll_id: scroll_args[:id] }
               )
             else
               http_request
                 .headers(content_type: "text/plain")
-                .post("#{connection.base_url}/_search/scroll", params: { scroll: scroll_args[:timeout] }, body: scroll_args[:id])
+                .post("#{connection.base_url}/_search/scroll", params: request_params.merge(scroll: scroll_args[:timeout]), body: scroll_args[:id])
             end
           elsif scroll_args
             http_request.post(
               "#{target.type_url}/_search",
-              params: { scroll: scroll_args[:timeout] },
+              params: request_params.merge(scroll: scroll_args[:timeout]),
               json: request
             )
           else
-            http_request.post("#{target.type_url}/_search", json: request)
+            http_request.post("#{target.type_url}/_search", params: request_params, json: request)
           end
 
         SearchFlip::Response.new(self, http_response.parse)
@@ -824,5 +878,13 @@ module SearchFlip
         criteria = criteria.scroll(id: criteria.scroll_id, timeout: timeout)
       end
     end
+
+    def request_params
+      res = {}
+      res[:preference] = preference_value if preference_value
+      res[:search_type] = search_type_value if search_type_value
+      res[:routing] = routing_value if routing_value
+      res
+    end
   end
 end

data/lib/search_flip/index.rb

@@ -252,7 +252,7 @@ module SearchFlip
         :includes, :eager_load, :preload, :sort, :resort, :order, :reorder, :offset, :limit, :paginate,
         :page, :per, :search, :highlight, :suggest, :custom, :find_in_batches, :find_results_in_batches,
         :find_each, :find_each_result, :failsafe, :total_entries, :total_count, :timeout, :terminate_after,
-        :records, :results, :should, :should_not, :must, :must_not
+        :records, :results, :should, :should_not, :must, :must_not, :preference, :search_type, :routing
 
       # Override to specify the type name used within ElasticSearch. Recap,
       # this gem uses an individual index for each index class, because

data/lib/search_flip/version.rb

@@ -1,5 +1,5 @@
 
 module SearchFlip
-  VERSION = "2.0.0.beta5"
+  VERSION = "2.0.0.beta6"
 end
 

data/spec/search_flip/aggregation_spec.rb

@@ -288,7 +288,8 @@ RSpec.describe SearchFlip::Aggregation do
         :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value, :limit_value,
         :scroll_args, :highlight_values, :suggest_values, :custom_value, :source_value, :sort_values,
         :includes_values, :preload_values, :eager_load_values, :post_search_values, :post_must_values,
-        :post_must_not_values, :post_should_values, :post_filter_values
+        :post_must_not_values, :post_should_values, :post_filter_values, :preference_value,
+        :search_type_value, :routing_value
       ]
 
       unsupported_methods.each do |unsupported_method|

data/spec/search_flip/bulk_spec.rb

@@ -98,7 +98,7 @@ RSpec.describe SearchFlip::Bulk do
         end
       end
 
-      expect(&block).not_to raise_error #(SearchFlip::ResponseError)
+      expect(&block).not_to raise_error
     end
   end
 end

data/spec/search_flip/criteria_spec.rb

@@ -35,7 +35,8 @@ RSpec.describe SearchFlip::Criteria do
     describe "assignments" do
       methods = [
         :profile_value, :failsafe_value, :terminate_after_value, :timeout_value,
-        :offset_value, :limit_value, :scroll_args, :source_value
+        :offset_value, :limit_value, :scroll_args, :source_value, :preference_value,
+        :search_type_value, :routing_value
       ]
 
       methods.each do |method|
@@ -1023,5 +1024,32 @@ RSpec.describe SearchFlip::Criteria do
       expect(request[:custom_key]).to eq("custom_value")
     end
   end
+
+  describe "#preference" do
+    it "sets the preference" do
+      stub_request(:post, "http://127.0.0.1:9200/products/products/_search?preference=value")
+        .to_return(status: 200, headers: { content_type: "application/json" }, body: "{}")
+
+      ProductIndex.preference("value").execute
+    end
+  end
+
+  describe "#search_type" do
+    it "sets the search_type" do
+      stub_request(:post, "http://127.0.0.1:9200/products/products/_search?search_type=value")
+        .to_return(status: 200, headers: { content_type: "application/json" }, body: "{}")
+
+      ProductIndex.search_type("value").execute
+    end
+  end
+
+  describe "#routing" do
+    it "sets the search_type" do
+      stub_request(:post, "http://127.0.0.1:9200/products/products/_search?routing=value")
+        .to_return(status: 200, headers: { content_type: "application/json" }, body: "{}")
+
+      ProductIndex.routing("value").execute
+    end
+  end
 end
 

data/spec/search_flip/index_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe SearchFlip::Index do
       :find_in_batches, :highlight, :suggest, :custom, :find_each, :failsafe,
       :total_entries, :total_count, :terminate_after, :timeout, :records, :results,
       :should, :should_not, :must, :must_not, :find_each_result,
-      :find_results_in_batches
+      :find_results_in_batches, :preference, :search_type, :routing
     ]
 
     methods.each do |method|
@@ -448,6 +448,39 @@ RSpec.describe SearchFlip::Index do
 
       expect(&bulk).not_to(change { ProductIndex.total_count })
     end
+
+    it "passes default options" do
+      allow(SearchFlip::Bulk).to receive(:new)
+
+      ProductIndex.bulk do |indexer|
+        indexer.index 1, id: 1
+      end
+
+      connection = ProductIndex.connection
+
+      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)
+
+      options = {
+        bulk_limit: "bulk limit",
+        bulk_max_mb: "bulk max mb",
+        http_client: "http client"
+      }
+
+      ProductIndex.bulk(options) do |indexer|
+        indexer.index 1, id: 1
+      end
+
+      expect(SearchFlip::Bulk).to have_received(:new).with(anything, options)
+    end
   end
 
   describe ".connection" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta5
+  version: 2.0.0.beta6
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord