search_flip 2.0.0.beta7 → 2.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf6b3a5f6bfc602628bc76ea55253357e36fde027c3b203c4755c7521694241d
-  data.tar.gz: de3a3de47e38a52bf780cc0d51f3dbf22287f57864ac99888832145b22d556ba
+  metadata.gz: 8f9a9b030a56e1b3688964be50aed6c66cbe367239a7377c37ebc2045180d4ed
+  data.tar.gz: d1a90f539bf2b63d708bcc415b1fb5fae95d967fd539a73f716e10ef04c86754
 SHA512:
-  metadata.gz: 7ec3e29db16f930294bd138196c12dbb52be7ceb5ab6198964a7910ad88dd791d4c6ff689758587c29e113d20b05fa5a75d717b0524e482052ee1cca629d466a
-  data.tar.gz: f0cd3bf68475fbd49d2e977e503029022104425f909bf21299319cd70e78a8cceddef102523d9b3c563954f9294eb0da704c8bc5ed7b9946b8e7abf370f3b5a2
+  metadata.gz: '08a14b0c86bcf6744c4dfba020959c6c2fe9002a20ae8c2866cbc745cbe7ea002369c954a3441caaaf07d31bdcc4e68e8ab0ad6a52c236d5bb5f994db6643c5e'
+  data.tar.gz: bd9f9aa18dc818bd1da8a2ce9d70e38abc6919bf359508b4d0344195cff9546964bfcfa30345fd8b7ff28c86746b352e21c78530f2e3e0522d108e1bc5338574

data/.rubocop.yml

@@ -115,3 +115,5 @@ Style/IfUnlessModifier:
 Style/RedundantBegin:
   Enabled: false
 
+Style/OptionalArguments:
+  Enabled: false

data/.travis.yml

@@ -5,7 +5,8 @@ env:
   - ES_IMAGE=elasticsearch:1
   - ES_IMAGE=plainpicture/elasticsearch:2.4.1_delete-by-query
   - ES_IMAGE=elasticsearch:5.4
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:6.5.0
+  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:6.7.0
+  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.0.0
 rvm:
   - ruby-head
 before_install:

data/CHANGELOG.md

@@ -9,10 +9,20 @@
 * [BREAKING] Changed `SearchFlip.aliases` to `SearchFlip::Connection#update_aliases`
 * [BREAKING] Changed `SearchFlip.msearch` to `SearchFlip::Connection#msearch`
 * [BREAKING] Removed `base_url` param from `SearchFlip::Critiera#execute`
+* [BREAKING] `SearchFlip::Index.index_name` no longer defaults to `SearchFlip::Index.type_name`
+* [BREAKING] No longer include the type name in `SearchFlip::Index.mapping`
 * Added `SearchFlip::Connection#get_aliases`
 * Added `SearchFlip::Connection#get_indices`
 * Added `SearchFlip::Connection#alias_exists?`
 * Added `SearchFlip::Index#with_settings` and `SearchFlip::Criteria#with_settings`
+* Added `SearchFlip::Aggregation#merge`
+* Added `bulk_max_mb` config and option
+* Added `SearchFlip::Index.analyze`
+* Added `SearchFlip::Criteria#preference`
+* Added `SearchFlip::Criteria#search_type`
+* Added `SearchFlip::Criteria#routing`
+* Added `SearchFlip::Index.open_index` and `SearchFlip::Index.close_index`
+* Added `SearchFlip::Index.mget`
 
 ## v1.1.0
 

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 1.x, 2.x, 5.x, 6.x. Check section
+SearchFlip supports ElasticSearch 1.x, 2.x, 5.x, 6.x, 7.x. Check section
 [Feature Support](#feature-support) for version dependent features.
 
 ```ruby
@@ -51,6 +51,9 @@ CommentIndex.where(available: true).search("hello world").sort(id: "desc").aggre
 
 ```
 
+Finally, SearchFlip comes with a minimal set of dependencies (http-rb, hashie
+and oj only).
+
 ## Reference Docs
 
 SearchFlip has a great documentation.
@@ -89,10 +92,10 @@ Available config options are:
 
 * `index_prefix` to have a prefix added to your index names automatically. This
   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
+* `base_url` to tell SearchFlip 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
+* `auto_refresh` tells SearchFlip to automatically refresh an index after
   import, index, delete, etc operations. This is e.g. usuful for testing, etc.
   Defaults to false.
 
@@ -106,14 +109,14 @@ class CommentIndex
 end
 ```
 
-Then tell the Index about the type name, the correspoding model and how to
+Then tell the Index about the index name, the correspoding model and how to
 serialize the model for indexing.
 
 ```ruby
 class CommentIndex
   include SearchFlip::Index
 
-  def self.type_name
+  def self.index_name
     "comments"
   end
 
@@ -132,42 +135,37 @@ class CommentIndex
 end
 ```
 
-You can additionally specify an `index_scope` which will automatically be
-applied to scopes, eg. ActiveRecord::Relation objects, passed to `#import`,
-`#index`, etc. This can be used to preload associations that are used when
-serializing records or to restrict the records you want to index.
+Optionally, you can specify a custom `type_name`, but note that starting with
+Elasticsearch 7, types are deprecated.
 
 ```ruby
 class CommentIndex
   # ...
 
-  def self.index_scope(scope)
-    scope.preload(:user)
+  def self.type_name
+    "comment"
   end
 end
-
-CommentIndex.import(Comment.all) # => CommentIndex.import(Comment.all.preload(:user))
 ```
 
-Please note, ElasticSearch allows to have multiple types per index. However,
-this forces to have the same mapping for fields having the same name even
-though the fields live in different types of the same index. Thus, this gem is
-using a different index for each type by default, but you can change that.
-Simply supply a custom `index_name`.
+You can additionally specify an `index_scope` which will automatically be
+applied to scopes, eg. ActiveRecord::Relation objects, passed to `#import`,
+`#index`, etc. This can be used to preload associations that are used when
+serializing records or to restrict the records you want to index.
 
 ```ruby
 class CommentIndex
   # ...
 
-  def self.index_name
-    "custom_index_name"
+  def self.index_scope(scope)
+    scope.preload(:user)
   end
-
-  # ...
 end
+
+CommentIndex.import(Comment.all) # => CommentIndex.import(Comment.all.preload(:user))
 ```
 
-Optionally, specify a custom mapping:
+To specify a custom mapping:
 
 ```ruby
 class CommentIndex
@@ -175,10 +173,8 @@ class CommentIndex
 
   def self.mapping
     {
-      comments: {
-        properties: {
-          # ...
-        }
+      properties: {
+        # ...
       }
     }
   end
@@ -187,7 +183,11 @@ class CommentIndex
 end
 ```
 
-or index settings:
+Please note that you need to specify the mapping without a type name, even for
+Elasticsearch versions before 7, as SearchFlip will add the type name
+automatically if neccessary.
+
+To specify index settings:
 
 ```ruby
 def self.index_settings
@@ -250,8 +250,8 @@ CommentIndex.match_all.delete
 
 # or delete manually via the bulk API:
 
-CommentIndex.match_all.find_each do |record|
-  CommentIndex.bulk do |indexer|
+CommentIndex.bulk do |indexer|
+  CommentIndex.match_all.find_each do |record|
     indexer.delete record.id
   end
 end

data/UPDATING.md

@@ -3,6 +3,46 @@
 
 ## Update 1.x to 2.x
 
+* **[BREAKING]** No longer include the mapping in `SearchFlip::Index.mapping`
+
+1.x:
+
+```ruby
+class MyIndex
+  include SearchFlip::Index
+
+  # ...
+
+  def self.mapping
+    {
+      type_name: {
+        properties: {
+          # ...
+        }
+      }
+    }
+  end
+end
+```
+
+2.x:
+
+```ruby
+class MyIndex
+  include SearchFlip::Index
+
+  # ...
+
+  def self.mapping
+    {
+      properties: {
+        # ...
+      }
+    }
+  end
+end
+```
+
 * **[BREAKING]** Changed `SearchFlip::Index.base_url` to `SearchFlip::Index.connection`
 
 1.x:

data/docker-compose.yml

@@ -2,5 +2,7 @@ version: '2'
 services:
   elasticsearch:
     image: $ES_IMAGE
+    environment:
+      - discovery.type=single-node
     ports:
       - 9200:9200

data/lib/search_flip/connection.rb

@@ -171,11 +171,12 @@ module SearchFlip
     #
     # @param index_name [String] The index name
     # @param index_settings [Hash] The index settings
+    # @param params [Hash] Optional url params
     #
     # @return [Boolean] Returns true or raises SearchFlip::ResponseError
 
-    def create_index(index_name, index_settings = {})
-      http_client.put(index_url(index_name), json: index_settings)
+    def create_index(index_name, index_settings = {}, params = {})
+      http_client.put(index_url(index_name), params: params, json: index_settings)
 
       true
     end
@@ -250,13 +251,17 @@ module SearchFlip
     # SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_name [String] The index name
-    # @param type_name [String] The type name
     # @param mapping [Hash] The mapping
+    # @param type_name [String] The type name. Starting with Elasticsearch 7,
+    #   the type name is optional.
     #
     # @return [Boolean] Returns true or raises SearchFlip::ResponseError
 
-    def update_mapping(index_name, type_name, mapping)
-      http_client.put("#{type_url(index_name, type_name)}/_mapping", json: mapping)
+    def update_mapping(index_name, mapping, type_name: nil)
+      url = type_name ? type_url(index_name, type_name) : index_url(index_name)
+      params = type_name && version.to_f >= 6.7 ? { include_type_name: true } : {}
+
+      http_client.put("#{url}/_mapping", params: params, json: mapping)
 
       true
     end
@@ -265,12 +270,16 @@ module SearchFlip
     # ElasticSearch. Raises SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_name [String] The index name
-    # @param type_name [String] The type name
+    # @param type_name [String] The type name. Starting with Elasticsearch 7,
+    #   the type name is optional.
     #
     # @return [Hash] The current type mapping
 
-    def get_mapping(index_name, type_name)
-      http_client.headers(accept: "application/json").get("#{type_url(index_name, type_name)}/_mapping").parse
+    def get_mapping(index_name, type_name: nil)
+      url = type_name ? type_url(index_name, type_name) : index_url(index_name)
+      params = type_name && version.to_f >= 6.7 ? { include_type_name: true } : {}
+
+      http_client.headers(accept: "application/json").get("#{url}/_mapping", params: params).parse
     end
 
     # Deletes the specified index from ElasticSearch. Raises

data/lib/search_flip/index.rb

@@ -262,11 +262,11 @@ module SearchFlip
       # @return [String] The name used for the type within the index
 
       def type_name
-        raise SearchFlip::MethodNotImplemented, "You must implement #{name}::type_name"
+        "_doc"
       end
 
       # Returns the base name of the index within ElasticSearch, ie the index
-      # name without prefix. Equals #type_name by default.
+      # name without prefix.
       #
       # @return [String] The base name of the index, ie without prefix
 
@@ -327,15 +327,10 @@ module SearchFlip
       # specified. Raises SearchFlip::ResponseError in case any errors
       # occur.
       #
-      # @param include_mapping [Boolean] Whether or not to include the mapping
-      #
       # @return [Boolean] Returns true or false
 
-      def create_index(include_mapping: false)
-        json = index_settings
-        json = json.merge(mappings: mapping) if include_mapping
-
-        connection.create_index(index_name_with_prefix, json)
+      def create_index
+        connection.create_index(index_name_with_prefix, index_settings)
       end
 
       # Closes the index within ElasticSearch. Raises SearchFlip::ResponseError
@@ -373,24 +368,22 @@ module SearchFlip
         connection.delete_index(index_name_with_prefix)
       end
 
-      # Specifies a type mapping. Override to specify a custom mapping.
+      # Specifies a type mapping. Override to specify a custom mapping. Please
+      # note that you don't have to include the type name, even for
+      # Elasticsearch versions before 7, as SearchFlip automatically adds the
+      # type name if neccessary.
       #
       # @example
       #   def self.mapping
       #     {
-      #       comments: {
-      #         _all: {
-      #           enabled: false
-      #         },
-      #         properties: {
-      #           email: { type: "string", analyzer: "custom_analyzer" }
-      #         }
+      #       properties: {
+      #         email: { type: "string", analyzer: "custom_analyzer" }
       #       }
       #     }
       #   end
 
       def mapping
-        { type_name => {} }
+        {}
       end
 
       # Updates the type mapping within ElasticSearch according to the mapping
@@ -398,7 +391,11 @@ module SearchFlip
       # errors occur.
 
       def update_mapping
-        connection.update_mapping(index_name_with_prefix, type_name, mapping)
+        if include_type_name?
+          connection.update_mapping(index_name_with_prefix, { type_name => mapping }, type_name: type_name)
+        else
+          connection.update_mapping(index_name_with_prefix, mapping)
+        end
       end
 
       # Retrieves the current type mapping from ElasticSearch. Raises
@@ -407,7 +404,21 @@ module SearchFlip
       # @return [Hash] The current type mapping
 
       def get_mapping
-        connection.get_mapping(index_name_with_prefix, type_name)
+        if include_type_name?
+          connection.get_mapping(index_name_with_prefix, type_name: type_name)
+        else
+          connection.get_mapping(index_name_with_prefix)
+        end
+      end
+
+      # Returns whether or not to include a type name. As types are deprecated
+      # in Elasticsearch 7, this method controls whether or not to include the
+      # type name. By default, the method returns true for Elasticsearch
+      # versions before 7 or if the specified type name for the index is not
+      # equal to _doc.
+
+      def include_type_name?
+        type_name != "_doc" || connection.version.to_i < 7
       end
 
       # Retrieves the document specified by id from ElasticSearch. Raises

data/lib/search_flip/response.rb

@@ -40,7 +40,7 @@ module SearchFlip
     # @return [Fixnum] The total number of results
 
     def total_entries
-      hits["total"]
+      hits["total"].is_a?(Hash) ? hits["total"]["value"] : hits["total"]
     end
 
     alias_method :total_count, :total_entries

data/lib/search_flip/version.rb

@@ -1,5 +1,5 @@
 
 module SearchFlip
-  VERSION = "2.0.0.beta7"
+  VERSION = "2.0.0.beta8"
 end
 

data/spec/search_flip/connection_spec.rb

@@ -199,6 +199,23 @@ RSpec.describe SearchFlip::Connection do
   end
 
   describe "#update_mapping" do
+    if SearchFlip::Connection.new.version.to_i >= 7
+      it "updates the mapping of an index without type name" do
+        begin
+          connection = SearchFlip::Connection.new
+
+          mapping = { "properties" => { "id" => { "type" => "long" } } }
+
+          connection.create_index("index_name")
+          connection.update_mapping("index_name", mapping)
+
+          expect(connection.get_mapping("index_name")).to eq("index_name" => { "mappings" => mapping })
+        ensure
+          connection.delete_index("index_name") if connection.index_exists?("index_name")
+        end
+      end
+    end
+
     it "updates the mapping of an index" do
       begin
         connection = SearchFlip::Connection.new
@@ -206,9 +223,9 @@ RSpec.describe SearchFlip::Connection do
         mapping = { "type_name" => { "properties" => { "id" => { "type" => "long" } } } }
 
         connection.create_index("index_name")
-        connection.update_mapping("index_name", "type_name", mapping)
+        connection.update_mapping("index_name", mapping, type_name: "type_name")
 
-        expect(connection.get_mapping("index_name", "type_name")).to eq("index_name" => { "mappings" => mapping })
+        expect(connection.get_mapping("index_name", type_name: "type_name")).to eq("index_name" => { "mappings" => mapping })
       ensure
         connection.delete_index("index_name") if connection.index_exists?("index_name")
       end

data/spec/search_flip/index_spec.rb

@@ -33,16 +33,16 @@ RSpec.describe SearchFlip::Index do
   end
 
   describe ".type_name" do
-    it "raises a SearchFlip::MethodNotImplemented by default" do
+    it "returns _doc by default" do
       klass = Class.new do
         include SearchFlip::Index
       end
 
-      expect { klass.type_name }.to raise_error(SearchFlip::MethodNotImplemented)
+      expect(klass.type_name).to eq("_doc")
     end
   end
 
-  describe ".type_name" do
+  describe ".index_name" do
     it "raises a SearchFlip::MethodNotImplemented by default" do
       klass = Class.new do
         include SearchFlip::Index
@@ -61,24 +61,35 @@ RSpec.describe SearchFlip::Index do
       expect(TestIndex.connection).to have_received(:create_index).with("test", {})
     end
 
-    it "includes the mapping if specified" do
-      mapping = { test: { properties: { id: { type: "long" } } } }
-
-      allow(TestIndex).to receive(:mapping).and_return(mapping)
+    it "includes the index settings" do
+      allow(TestIndex).to receive(:index_settings).and_return(settings: { number_of_shards: 2 })
       allow(TestIndex.connection).to receive(:create_index).and_call_original
 
-      TestIndex.create_index(include_mapping: true)
+      TestIndex.create_index
 
-      expect(TestIndex.connection).to have_received(:create_index).with("test", mappings: mapping)
+      expect(TestIndex.connection).to have_received(:create_index).with("test", { settings: { number_of_shards: 2 } })
     end
+  end
 
-    it "includes the index settings" do
-      allow(TestIndex).to receive(:index_settings).and_return(number_of_shards: 2)
-      allow(TestIndex.connection).to receive(:create_index).and_call_original
+  describe ".include_type_name?" do
+    it "returns true for Elasticsearch before version 7 and the default type name" do
+      klass = Class.new do
+        include SearchFlip::Index
+      end
 
-      TestIndex.create_index
+      expect(klass.include_type_name?).to eq(klass.connection.version.to_i < 7)
+    end
 
-      expect(TestIndex.connection).to have_received(:create_index).with("test", number_of_shards: 2)
+    it "returns true if the type name is not equal to _doc" do
+      klass = Class.new do
+        include SearchFlip::Index
+
+        def self.type_name
+          "type_name"
+        end
+      end
+
+      expect(klass.include_type_name?).to eq(true)
     end
   end
 
@@ -160,30 +171,85 @@ RSpec.describe SearchFlip::Index do
   end
 
   describe ".update_mapping" do
-    it "delegates to connection" do
-      TestIndex.create_index
+    if TestIndex.connection.version.to_i >= 7
+      context "without type name" do
+        it "delegates to connection" do
+          TestIndex.create_index
+
+          allow(TestIndex).to receive(:include_type_name?).and_return(false)
 
-      mapping = { test: { properties: { id: { type: "long" } } } }
+          mapping = { properties: { id: { type: "long" } } }
 
-      allow(TestIndex).to receive(:mapping).and_return(mapping)
-      allow(TestIndex.connection).to receive(:update_mapping).and_call_original
+          allow(TestIndex).to receive(:mapping).and_return(mapping)
+          allow(TestIndex.connection).to receive(:update_mapping).and_call_original
 
-      TestIndex.update_mapping
+          TestIndex.update_mapping
 
-      expect(TestIndex.connection).to have_received(:update_mapping).with("test", "test", mapping)
+          expect(TestIndex.connection).to have_received(:update_mapping).with("test", mapping)
+        end
+      end
+    end
+
+    context "with type name" do
+      it "delegates to connection" do
+        TestIndex.create_index
+
+        mapping = { properties: { id: { type: "long" } } }
+
+        allow(TestIndex).to receive(:mapping).and_return(mapping)
+        allow(TestIndex.connection).to receive(:update_mapping).and_call_original
+
+        TestIndex.update_mapping
+
+        expect(TestIndex.connection).to have_received(:update_mapping).with("test", { "test" => mapping }, type_name: "test")
+      end
+    end
+  end
+
+  describe ".mapping" do
+    it "returns an empty mapping" do
+      klass = Class.new do
+        include SearchFlip::Index
+
+        def self.include_type_name?
+          true
+        end
+      end
+
+      expect(klass.mapping).to eq({})
     end
   end
 
   describe ".get_mapping" do
-    it "delegates to connection" do
-      TestIndex.create_index
-      TestIndex.update_mapping
+    if TestIndex.connection.version.to_i >= 7
+      context "without type name" do
+        it "delegates to connection" do
+          allow(TestIndex).to receive(:include_type_name?).and_return(false)
+          allow(TestIndex).to receive(:mapping).and_return({})
+
+          TestIndex.create_index
+          TestIndex.update_mapping
+
+          allow(TestIndex.connection).to receive(:get_mapping).and_call_original
+
+          TestIndex.get_mapping
 
-      allow(TestIndex.connection).to receive(:get_mapping).and_call_original
+          expect(TestIndex.connection).to have_received(:get_mapping).with("test")
+        end
+      end
+    end
 
-      TestIndex.get_mapping
+    context "with type name" do
+      it "delegates to connection" do
+        TestIndex.create_index
+        TestIndex.update_mapping
 
-      expect(TestIndex.connection).to have_received(:get_mapping).with("test", "test")
+        allow(TestIndex.connection).to receive(:get_mapping).and_call_original
+
+        TestIndex.get_mapping
+
+        expect(TestIndex.connection).to have_received(:get_mapping).with("test", type_name: "test")
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -114,25 +114,23 @@ class ProductIndex
   def self.mapping
     if ProductIndex.connection.version.to_i >= 5
       {
-        products: {
-          properties: {
-            category: {
-              type: "text",
-              fielddata: true
-            },
-            title: {
-              type: "text",
-              fielddata: true
-            },
-            description: {
-              type: "text",
-              fielddata: true
-            }
+        properties: {
+          category: {
+            type: "text",
+            fielddata: true
+          },
+          title: {
+            type: "text",
+            fielddata: true
+          },
+          description: {
+            type: "text",
+            fielddata: true
           }
         }
       }
     else
-      { products: {} }
+      { }
     end
   end
 
@@ -171,10 +169,8 @@ class TestIndex
 
   def self.mapping
     {
-      test: {
-        properties: {
-          test_field: { type: "date" }
-        }
+      properties: {
+        test_field: { type: "date" }
       }
     }
   end

metadata

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