search_flip 2.0.0.beta6 → 2.0.0.beta7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ca9a2ae9454e232a82a2d0ca91d58cb0f8d79e087795c0e9dbae5ad9ac6216
-  data.tar.gz: 721e6a0b0cc6abbf8d501e09903a1c9a3cb0ba526f1c9a403461ec38c3607f15
+  metadata.gz: cf6b3a5f6bfc602628bc76ea55253357e36fde027c3b203c4755c7521694241d
+  data.tar.gz: de3a3de47e38a52bf780cc0d51f3dbf22287f57864ac99888832145b22d556ba
 SHA512:
-  metadata.gz: d0b4d33d00bb54b2d0b16fd1df450f93a412097312ac8726ab5f3d76bfd5c4c89a1374d6f61cf62920ebd4d86f209da330b20dd61a446c0d3bf5b25036b4cee3
-  data.tar.gz: 4d18ae080aa3dbdbdd024e5a3ce33529c002162bf9b5057848c7813546aab64dc82d2cd0ff91de26b155898559834bb8aabec961bea51488abe829ca5782dc52
+  metadata.gz: 7ec3e29db16f930294bd138196c12dbb52be7ceb5ab6198964a7910ad88dd791d4c6ff689758587c29e113d20b05fa5a75d717b0524e482052ee1cca629d466a
+  data.tar.gz: f0cd3bf68475fbd49d2e977e503029022104425f909bf21299319cd70e78a8cceddef102523d9b3c563954f9294eb0da704c8bc5ed7b9946b8e7abf370f3b5a2

data/.travis.yml

@@ -13,5 +13,5 @@ before_install:
   - sleep 10
 install:
   - travis_retry bundle install
-script: rake test --trace
+script: rspec
 

data/README.md

@@ -207,6 +207,8 @@ CommentIndex.create_index
 CommentIndex.index_exists?
 CommentIndex.delete_index
 CommentIndex.update_mapping
+CommentIndex.close_index
+CommentIndex.open_index
 ```
 
 index records (automatically uses the bulk API):

data/lib/search_flip/connection.rb

@@ -30,6 +30,17 @@ module SearchFlip
       @version ||= http_client.headers(accept: "application/json").get("#{base_url}/").parse["version"]["number"]
     end
 
+    # Queries and returns the ElasticSearch cluster health.
+    #
+    # @example
+    #   connection.cluster_health # => { "status" => "green", ... }
+    #
+    # @return [Hash] The raw response
+
+    def cluster_health
+      http_client.headers(accept: "application/json").get("#{base_url}/_cluster/health").parse
+    end
+
     # Uses the ElasticSearch Multi Search API to execute multiple search requests
     # within a single request. Raises SearchFlip::ResponseError in case any
     # errors occur.
@@ -83,6 +94,18 @@ module SearchFlip
         .parse
     end
 
+    # Sends an analyze request to ElasticSearch. Raises
+    # SearchFlip::ResponseError in case any errors occur.
+    #
+    # @example
+    #   connection.analyze(analyzer: "standard", text: "this is a test")
+    #
+    # @return [Hash] The raw response
+
+    def analyze(request, params = {})
+      http_client.headers(accept: "application/json").post("#{base_url}/_analyze", json: request, params: params).parse
+    end
+
     # Fetches information about the specified index aliases. Raises
     # SearchFlip::ResponseError in case any errors occur.
     #
@@ -157,6 +180,32 @@ module SearchFlip
       true
     end
 
+    # Closes the specified index within ElasticSearch. Raises
+    # SearchFlip::ResponseError in case any errors occur
+    #
+    # @param index_name [String] The index name
+    #
+    # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+    def close_index(index_name)
+      http_client.post("#{index_url(index_name)}/_close")
+
+      true
+    end
+
+    # Opens the specified index within ElasticSearch. Raises
+    # SearchFlip::ResponseError in case any errors occur
+    #
+    # @param index_name [String] The index name
+    #
+    # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+    def open_index(index_name)
+      http_client.post("#{index_url(index_name)}/_open")
+
+      true
+    end
+
     # Updates the index settings within ElasticSearch according to the index
     # settings specified. Raises SearchFlip::ResponseError in case any
     # errors occur.

data/lib/search_flip/index.rb

@@ -338,6 +338,24 @@ module SearchFlip
         connection.create_index(index_name_with_prefix, json)
       end
 
+      # Closes the index within ElasticSearch. Raises SearchFlip::ResponseError
+      # in case any errors occur.
+      #
+      # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+      def close_index
+        connection.close_index(index_name_with_prefix)
+      end
+
+      # Opens the index within ElasticSearch. Raises SearchFlip::ResponseError
+      # in case any errors occur.
+      #
+      # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+      def open_index
+        connection.open_index(index_name_with_prefix)
+      end
+
       # Updates the index settings within ElasticSearch according to the index
       # settings specified. Raises SearchFlip::ResponseError in case any
       # errors occur.
@@ -396,6 +414,10 @@ module SearchFlip
       # SearchFlip::ResponseError specific exceptions in case any errors
       # occur.
       #
+      # @example
+      #   UserIndex.get(1)
+      #   UserIndex.get(1, routing: "key")
+      #
       # @param id [String, Fixnum] The id to get
       # @param params [Hash] Optional params for the request
       #
@@ -405,6 +427,34 @@ module SearchFlip
         connection.http_client.headers(accept: "application/json").get("#{type_url}/#{id}", params: params).parse
       end
 
+      # Retrieves the documents specified by ids from elasticsearch.
+      #
+      # @example
+      #   UserIndex.mget(ids: [1, 2, 3])
+      #   UserIndex.mget(docs: [{ _id: 1, routing: "key1" }, { _id: 2, routing: "key2" }])
+      #   UserIndex.mget({ ids: [1, 2, 3] }, stored_fields: "username,full_name")
+      #
+      # @param request [Hash] The raw request
+      # @param params [Hash] Optional params for the request
+      #
+      # @return [Hash] The raw response
+
+      def mget(request, params = {})
+        connection.http_client.headers(accept: "application/json").post("#{type_url}/_mget", json: request, params: params).parse
+      end
+
+      # Sends an analyze request to ElasticSearch. Raises
+      # SearchFlip::ResponseError in case any errors occur.
+      #
+      # @example
+      #   CommentIndex.analyze(analyzer: "standard", text: "this is a test")
+      #
+      # @return [Hash] The raw response
+
+      def analyze(request, params = {})
+        connection.http_client.headers(accept: "application/json").post("#{index_url}/_analyze", json: request, params: params).parse
+      end
+
       # Sends a index refresh request to ElasticSearch. Raises
       # SearchFlip::ResponseError in case any errors occur.
 

data/lib/search_flip/version.rb

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

data/spec/search_flip/bulk_spec.rb

@@ -82,17 +82,21 @@ RSpec.describe SearchFlip::Bulk do
 
       block = lambda do
         ProductIndex.bulk bulk_max_mb: 1_000 do |bulk|
-          100.times do
+          20.times do
             bulk.index product.id, ProductIndex.serialize(product)
           end
         end
       end
 
-      expect(&block).to raise_error(SearchFlip::ResponseError)
+      if ProductIndex.connection.version.to_i <= 2
+        expect(&block).to raise_error(SearchFlip::ConnectionError)
+      else
+        expect(&block).to raise_error(SearchFlip::ResponseError)
+      end
 
       block = lambda do
         ProductIndex.bulk bulk_max_mb: 100 do |bulk|
-          100.times do
+          20.times do
             bulk.index product.id, ProductIndex.serialize(product)
           end
         end

data/spec/search_flip/connection_spec.rb

@@ -2,6 +2,18 @@
 require File.expand_path("../spec_helper", __dir__)
 
 RSpec.describe SearchFlip::Connection do
+  describe "#version" do
+    it "returns the version" do
+      expect(SearchFlip::Connection.new.version).to match(/\A[0-9.]+\z/)
+    end
+  end
+
+  describe "#cluster_health" do
+    it "returns the cluster health" do
+      expect(["red", "yellow", "green"]).to include(SearchFlip::Connection.new.cluster_health["status"])
+    end
+  end
+
   describe "#base_url" do
     it "returns the correct url" do
       expect(SearchFlip::Connection.new(base_url: "base url").base_url).to eq("base url")
@@ -112,6 +124,51 @@ RSpec.describe SearchFlip::Connection do
     end
   end
 
+  describe "#close_index" do
+    it "closes the specified index" do
+      begin
+        connection = SearchFlip::Connection.new
+
+        connection.create_index("index_name")
+        sleep(0.1) while connection.cluster_health["status"] == "red"
+
+        connection.close_index("index_name")
+
+        expect(connection.get_indices("index_name").first["status"]).to eq("close")
+      ensure
+        connection.delete_index("index_name") if connection.index_exists?("index_name")
+      end
+    end
+  end
+
+  describe "#open_index" do
+    it "opens the specified index" do
+      begin
+        connection = SearchFlip::Connection.new
+
+        connection.create_index("index_name")
+        sleep(0.1) while connection.cluster_health["status"] == "red"
+        connection.close_index("index_name")
+
+        connection.open_index("index_name")
+
+        expect(connection.get_indices("index_name").first["status"]).to eq("open")
+      ensure
+        connection.delete_index("index_name") if connection.index_exists?("index_name")
+      end
+    end
+  end
+
+  describe ".analyze" do
+    it "analyzes the provided request" do
+      connection = SearchFlip::Connection.new
+
+      tokens = connection.analyze(analyzer: "standard", text: "some text")["tokens"].map { |token| token["token"] }
+
+      expect(tokens).to include("some", "text")
+    end
+  end
+
   describe "#update_index_settings" do
     it "updates the index settings" do
       begin

data/spec/search_flip/index_spec.rb

@@ -82,6 +82,32 @@ RSpec.describe SearchFlip::Index do
     end
   end
 
+  describe ".close_index" do
+    it "delegates to connection" do
+      allow(TestIndex.connection).to receive(:close_index).and_call_original
+
+      TestIndex.create_index
+      sleep(0.1) while TestIndex.connection.cluster_health["status"] == "red"
+      TestIndex.close_index
+
+      expect(TestIndex.connection).to have_received(:close_index).with("test")
+    end
+  end
+
+  describe ".open_index" do
+    it "delegates to connection" do
+      allow(TestIndex.connection).to receive(:open_index).and_call_original
+
+      TestIndex.create_index
+      sleep(0.1) while TestIndex.connection.cluster_health["status"] == "red"
+      TestIndex.close_index
+
+      TestIndex.open_index
+
+      expect(TestIndex.connection).to have_received(:open_index).with("test")
+    end
+  end
+
   describe ".index_exists?" do
     it "delegates to connection" do
       TestIndex.create_index
@@ -161,6 +187,16 @@ RSpec.describe SearchFlip::Index do
     end
   end
 
+  describe ".analyze" do
+    it "analyzes the provided request" do
+      ProductIndex.import create(:product)
+
+      tokens = ProductIndex.analyze(analyzer: "standard", text: "some text")["tokens"].map { |token| token["token"] }
+
+      expect(tokens).to include("some", "text")
+    end
+  end
+
   describe ".refresh" do
     it "delegates to connection" do
       TestIndex.create_index
@@ -389,6 +425,7 @@ RSpec.describe SearchFlip::Index do
 
     it "passes params" do
       product = create(:product)
+
       ProductIndex.import product
 
       expect(ProductIndex.get(product.id).keys).to include("_source")
@@ -396,6 +433,25 @@ RSpec.describe SearchFlip::Index do
     end
   end
 
+  describe ".mget" do
+    it "retrieves the documents" do
+      product1, product2, product3 = create_list(:product, 3)
+
+      ProductIndex.import [product1, product2, product3]
+
+      expect(ProductIndex.mget(ids: [product1.id, product2.id])["docs"].map { |doc| doc["found"] }).to eq([true, true])
+    end
+
+    it "passes params" do
+      product = create(:product)
+
+      ProductIndex.import product
+
+      expect(ProductIndex.mget({ ids: [product.id] }, _source: false)["docs"].map { |doc| doc["found"] }).to eq([true])
+      expect(ProductIndex.mget({ ids: [product.id] }, _source: false)["docs"].first).not_to include("_source")
+    end
+  end
+
   describe ".scope" do
     it "adds a scope" do
       temp_product_index = Class.new(ProductIndex)

data/spec/spec_helper.rb

@@ -186,6 +186,10 @@ class TestIndex
   def self.index_name
     "test"
   end
+
+  def self.serialize(object)
+    { id: object.id }
+  end
 end
 
 TestIndex.delete_index if TestIndex.index_exists?

metadata

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