es-elasticity 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8f22efbfa1c08ea072b29ab855c27ac110d1704
-  data.tar.gz: 934d6ec4117475deb51496588301e1f1f8fce84d
+  metadata.gz: bf031d70eec61e290731d0e3c92aa70d369052ed
+  data.tar.gz: 6340aec039146f81aeadcfee37feaa388beb63c8
 SHA512:
-  metadata.gz: 6f8d4cc458979c125047deae5c8cc1638f6891d13eeb1b5cd3eb0b2ee634e7dab8ce32dd567080fd093901345a76659f0499ae75d12e715d75325206195fee32
-  data.tar.gz: 96ea9b7cea8666887f8d7f453d5b0f10b1cae8d225a7a3da24f72e9782f33a483bc07ab8e8ee7c0b9b5335c447d258c1c9502ad6e267b2c579668992fc2a3b30
+  metadata.gz: f4d8a7fd73ae3724848e194d7850ab178bd62e39bd9c806a609adf3e460792ffc3fe3bdaaf330331950fa5762c7721f23304c2316a1c0c90c8c0929c04b0d9cb
+  data.tar.gz: b0ed024340bc2e8df1bccbd4bd2618016a61db97bc16e7ed7c1d292457dadd3d56a881c609fcb63c5184232412df211576f0b874e5a290ac0dca9c2711cce565

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.6.5
+	- update search and multi search interfaces to allow passing of general
+	search definition arguments found in https://github.com/elastic/elasticsearch-ruby/blob/bdf5e145e5acc21726dddcd34492debbbddde568/elasticsearch-api/lib/elasticsearch/api/actions/search.rb#L125-L162
 v0.6.4
 	- update suggestions to pull from the proper key
 v0.6.3

data/README.md

@@ -181,10 +181,10 @@ cursor.each_batch { |batch| ... }
 cursor.each { |doc| ... }
 
 # Lastly, a search that maps back to an ActiveRecord::Relation.
-adults = adults.active_record(User)
+adults = adults.active_records(User)
 ```
 
-For more information about the `active_record` method, read [ActiveRecord integration](#activerecord-integration).
+For more information about the `active_records` method, read [ActiveRecord integration](#activerecord-integration).
 
 ### Segmented Documents
 
@@ -378,7 +378,7 @@ end
 Because the return of that method is a lazy-evaluated search, it allows specific search strategies to be used, one of them being ActiveRecord specific:
 
 ```ruby
-adults = Search::User.adults.active_record(User)
+adults = Search::User.adults.active_records(User)
 adults.class # => ActiveRecord::Relation
 adults.all   # => [#<User: id: 1, name: "John", birthdate: 1985-10-31>, ...]
 ```
@@ -386,7 +386,7 @@ adults.all   # => [#<User: id: 1, name: "John", birthdate: 1985-10-31>, ...]
 Note that the method takes a relation and not a class, so the following is also possible:
 
 ```ruby
-Search::User.adults.active_record(User.where(active: true))
+Search::User.adults.active_records(User.where(active: true))
 ```
 
 ## Roadmap

data/lib/elasticity/multi_search.rb

@@ -1,9 +1,10 @@
 module Elasticity
   class MultiSearch
 
-    def initialize
+    def initialize(msearch_args = {})
       @searches = {}
       @mappers  = {}
+      @msearch_args = msearch_args
       yield self if block_given?
     end
 
@@ -25,8 +26,6 @@ module Elasticity
 
     def [](name)
       results_collection[name]
-    rescue NoMethodError => e
-      raise "#{e.inspect} with key #{name}"
     end
 
     private
@@ -41,7 +40,8 @@ module Elasticity
       end
 
       response = ActiveSupport::Notifications.instrument("multi_search.elasticity", args: { body: bodies }) do
-        Elasticity.config.client.msearch(body: bodies.map(&:dup))
+        args = { body: bodies.map(&:dup) }.reverse_merge(@msearch_args)
+        Elasticity.config.client.msearch(args)
       end
       results = {}
 

data/lib/elasticity/search.rb

@@ -11,9 +11,9 @@ module Elasticity
       attr_accessor :index_name, :document_types, :body
 
       def initialize(index_name, document_types, body)
-        @index_name    = index_name
+        @index_name     = index_name
         @document_types = document_types
-        @body          = body.deep_symbolize_keys!
+        @body           = body.deep_symbolize_keys!
       end
 
       def update(body_changes)
@@ -51,16 +51,16 @@ module Elasticity
 
       # Performs the search using the default search type and returning an iterator that will yield
       # hash representations of the documents.
-      def document_hashes
+      def document_hashes(search_args = {})
         return @document_hashes if defined?(@document_hashes)
-        @document_hashes = LazySearch.new(@client, @search_definition)
+        @document_hashes = LazySearch.new(@client, @search_definition, search_args)
       end
 
       # Performs the search using the default search type and returning an iterator that will yield
       # each document, converted using the provided mapper
-      def documents(mapper)
+      def documents(mapper, search_args = {})
         return @documents if defined?(@documents)
-        @documents = LazySearch.new(@client, @search_definition) do |hit|
+        @documents = LazySearch.new(@client, @search_definition, search_args) do |hit|
           mapper.(hit)
         end
       end
@@ -89,10 +89,11 @@ module Elasticity
 
       attr_accessor :search_definition
 
-      def initialize(client, search_definition, &mapper)
+      def initialize(client, search_definition, search_args, &mapper)
         @client            = client
         @search_definition = search_definition
         @mapper            = mapper
+        @search_args       = search_args
       end
 
       def empty?
@@ -119,7 +120,7 @@ module Elasticity
 
       def response
         return @response if defined?(@response)
-        @response = @client.search(@search_definition.to_search_args)
+        @response = @client.search(@search_definition.to_search_args.reverse_merge(@search_args))
       end
     end
 
@@ -263,8 +264,8 @@ module Elasticity
 
       delegate :search_definition, :active_records, to: :@search
 
-      def documents
-        @search.documents(@document_klass)
+      def documents(search_args = {})
+        @search.documents(@document_klass, search_args)
       end
 
       def scan_documents(**options)

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 end

data/spec/units/multi_search_spec.rb

@@ -96,4 +96,17 @@ RSpec.describe Elasticity::MultiSearch do
     expect(subject[:first].aggregations).to eq aggregations["aggregations"]
     expect(subject[:second].aggregations).to eq Hash.new
   end
+
+  it "performs multi search with additional arguments" do
+    msearch = Elasticity::MultiSearch.new(search_type: :dfs_query_then_fetch)
+    msearch.add(:first, Elasticity::Search::Facade.new(client, Elasticity::Search::Definition.new("index_first", "document_first", { search: :first, size: 2 })), documents: klass)
+    msearch.add(:second, Elasticity::Search::Facade.new(client, Elasticity::Search::Definition.new("index_second", "document_second", { search: :second })), documents: klass)
+
+    expect(Elasticity.config.client).to receive(:msearch).with(search_type: :dfs_query_then_fetch, body: [
+      { index: "index_first", type: "document_first", search: { search: :first, size: 2 } },
+      { index: "index_second", type: "document_second", search: { search: :second } },
+    ]).and_return(response)
+
+    expect(Array(msearch[:first])).to eq([klass.new(_id: 1, name: "foo"), klass.new(_id: 2, name: "bar")])
+  end
 end

data/spec/units/search_spec.rb

@@ -179,6 +179,22 @@ RSpec.describe "Search" do
       expect(docs.next_page).to eq(3)
       expect(docs.previous_page).to eq(1)
     end
+
+    it "merges in additional arguments for search" do
+      results = double(:results, :[] => { "hits" => [] })
+      subject = Elasticity::Search::Facade.new(
+        client,
+        Elasticity::Search::Definition.new(index_name, document_type, {})
+      )
+
+      expect(client).to receive(:search).with(
+        index: index_name,
+        type: document_type,
+        body: {},
+        search_type: :dfs_query_and_fetch
+      ).and_return(results)
+      subject.documents(mapper, search_type: :dfs_query_and_fetch).search_results
+    end
   end
 
   describe Elasticity::Search::DocumentProxy do
@@ -201,5 +217,13 @@ RSpec.describe "Search" do
       expect(search).to receive(:active_records).with(rel).and_return(records)
       expect(subject.active_records(rel)).to be records
     end
+
+    it "accepts additional arguments for a search" do
+      results = double(:results)
+
+      expect(search).to receive(:documents).with(mapper, search_type: :dfs_query_then_fetch).and_return(results)
+      expect(subject.documents(search_type: :dfs_query_then_fetch)).to eq(results)
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es-elasticity
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Rodrigo Kochenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler