search_flip 1.1.0 → 2.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62b02c26a3579fdda9d1eca222c6c1eb19b28382
-  data.tar.gz: fc3fe009dc1c8d84d03ab497c5302922474282c5
+SHA256:
+  metadata.gz: 823b618d9cd15618f5e44b441644f281f1b5598feb11f52db75a538df78761ba
+  data.tar.gz: 3812f77dbcd670d76f9ae641f574035ff847c97b6c151f70f3fa663edf9619a6
 SHA512:
-  metadata.gz: f6cee1c3258c0ff0662cec18d72313552706054e55a08c2f14003999c6d0d4bb910112507da340ad9dc1510b9f3f4b422ce11b0ec1b7eea8481450d430436bfc
-  data.tar.gz: 9062e11098ab36c5063f992284a1d94ea27b422fabb0d4e94aa5b1c5b37da8c0508326d20566ab155f649034e2f924e739795b4ab89ab06ca6b2fa107f0e3bd3
+  metadata.gz: 2698a48a6c9e880a57776bd9bd39b21fdcbace96c5e1e50d12f81064dd3fb095d35c528c792d4f40951a9debde33dae4620928934e98596b3a32b2e9bb406c80
+  data.tar.gz: c4ba2b7c24f4096c98e3458e6c289c1ea7f9519f3f29ebf87d882f4d7600839c8ee96eb3c07efb76ff1fe3b738b39a0f7d9036a3682d86bc5751c71f26acdcc2

data/.rubocop.yml

@@ -0,0 +1,110 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/ClassLength:
+  Enabled: false
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+Layout/LeadingBlankLines:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Layout/TrailingBlankLines:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Layout/IndentArray:
+  EnforcedStyle: consistent

data/.travis.yml

@@ -1,36 +1,17 @@
 
+sudo: false
+language: ruby
+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
 rvm:
-  - 2.3.3
   - ruby-head
-
-dist: trusty
-
-jdk:
-  - openjdk8
-
-env:
-  - ES_VERSION=1
-  - ES_VERSION=2
-  - ES_VERSION=5
-  - ES_VERSION=6
-
+before_install:
+  - docker-compose up -d
+  - sleep 10
 install:
   - travis_retry bundle install
-  - sh -c "if [ '$ES_VERSION' = '6' ]; then (curl -s https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.2.2.tar.gz | tar xz -C /tmp); fi"
-  - sh -c "if [ '$ES_VERSION' = '6' ]; then /tmp/elasticsearch-6.2.2/bin/elasticsearch -d; fi"
-  - sh -c "if [ '$ES_VERSION' = '5' ]; then (curl -s https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.4.0.tar.gz | tar xz -C /tmp); fi"
-  - sh -c "if [ '$ES_VERSION' = '5' ]; then /tmp/elasticsearch-5.4.0/bin/elasticsearch -d; fi"
-  - sh -c "if [ '$ES_VERSION' = '2' ]; then (curl -s https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/tar/elasticsearch/2.4.1/elasticsearch-2.4.1.tar.gz | tar xz -C /tmp); fi"
-  - sh -c "if [ '$ES_VERSION' = '2' ]; then /tmp/elasticsearch-2.4.1/bin/plugin install delete-by-query; fi"
-  - sh -c "if [ '$ES_VERSION' = '2' ]; then /tmp/elasticsearch-2.4.1/bin/elasticsearch -d; fi"
-  - sh -c "if [ '$ES_VERSION' = '1' ]; then (curl -s https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-1.7.4.tar.gz | tar xz -C /tmp); fi"
-  - sh -c "if [ '$ES_VERSION' = '1' ]; then /tmp/elasticsearch-1.7.4/bin/elasticsearch -d; fi"
-
-before_script:
-  - sleep 30
-
-script:
-  - rake test --trace
-
-sudo: false
+script: rake test --trace
 

data/CHANGELOG.md

@@ -1,10 +1,22 @@
 
 # CHANGELOG
 
-* Version 1.1.0
+## v2.0.0
 
-- Added `Criteria#find_results_in_batches` to scroll through the raw results
-- Fixed bug in `Criteria#find_in_batches` which possibly stopped scrolling too early
-- Added delegation for `should`, `should_not`, `must` and `must_not`
-- Migrated To FactoryBot
+* **BREAKING**: Migration steps
+  * Change `SearchFlip.version` to `SearchFlip::Connection#version`
+  * Change `SearchFlip.msearch` to `SearchFlip::Connection#msearch`
+  * Change `SearchFlip.aliases` to `SearchFlip::Connection#update_aliases`
+  * Change `SearchFlip::Criteria#execute(base_url: '...')` to `SearchFlip::Criteria#execute(connection: SearchFlip::Connection.new(base_url: '...'))`
+* Added `SearchFlip::Connection`
+* Added `SearchFlip::Connection#update_aliases`
+* Added `SearchFlip::Connection#get_aliases`
+* Added `SearchFlip::Connection#alias_exists?`
+
+## v1.1.0
+
+* Added `Criteria#find_results_in_batches` to scroll through the raw results
+* Fixed bug in `Criteria#find_in_batches` which possibly stopped scrolling too early
+* Added delegation for `should`, `should_not`, `must` and `must_not`
+* Migrated To FactoryBot
 

data/README.md

@@ -501,6 +501,24 @@ CommentIndex.terminate_after(10).execute
 
 For further details and a full list of methods, check out the reference docs.
 
+## Using multiple Elasticsearch clusters
+
+To use multiple Elasticsearch clusters, specify a connection within your
+indices:
+
+```ruby
+class MyIndex
+  include SearchFlip::Index
+
+  def self.connection
+    @connection ||= SearchFlip::Connection.new(base_url: "http://elasticsearch.host:9200")
+  end
+end
+```
+
+This allows to use different clusters per index e.g. when migrating indices to
+new versions of Elasticsearch.
+
 ## Non-ActiveRecord models
 
 SearchFlip ships with built-in support for ActiveRecord models, but using
@@ -618,3 +636,17 @@ model changes.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Running the test suite
+
+Running the tests is super easy. The test suite uses sqlite, such that you only
+need to install ElasticSearch. You can install ElasticSearch on your own, or
+you can e.g. use docker-compose:
+
+```
+$ cd search_flip
+$ sudo ES_IMAGE=elasticsearch:5.4 docker-compose up
+$ rake test
+```
+
+That's it.
+

data/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '2' 
+services:
+  elasticsearch:
+    image: $ES_IMAGE
+    ports:
+      - 9200:9200

data/lib/search_flip.rb

@@ -6,9 +6,11 @@ require "oj"
 require "set"
 
 require "search_flip/version"
+require "search_flip/exceptions"
 require "search_flip/json"
 require "search_flip/http_client"
 require "search_flip/config"
+require "search_flip/connection"
 require "search_flip/bulk"
 require "search_flip/filterable"
 require "search_flip/post_filterable"
@@ -36,47 +38,5 @@ module SearchFlip
       "#{self.class.name} (#{code}): #{body}"
     end
   end
-
-  # Uses the ElasticSearch Multi Search API to execute multiple search requests
-  # within a single request. Raises SearchFlip::ResponseError in case any
-  # errors occur.
-  #
-  # @example
-  #   SearchFlip.msearch [ProductIndex.match_all, CommentIndex.match_all]
-  #
-  # @param criterias [Array<SearchFlip::Criteria>] An array of search
-  #   queries to execute in parallel
-  #
-  # @return [Array<SearchFlip::Response>] An array of responses
-
-  def self.msearch(criterias)
-    payload = criterias.flat_map do |criteria|
-      [SearchFlip::JSON.generate(index: criteria.target.index_name_with_prefix, type: criteria.target.type_name), SearchFlip::JSON.generate(criteria.request)]
-    end
-
-    payload = payload.join("\n")
-    payload << "\n"
-
-    SearchFlip::HTTPClient.headers(accept: "application/json", content_type: "application/x-ndjson").post("#{SearchFlip::Config[:base_url]}/_msearch", body: payload).parse["responses"].map.with_index do |response, index|
-      SearchFlip::Response.new(criterias[index], response)
-    end
-  end
-
-  # Used to manipulate, ie add and remove index aliases. Raises an
-  # SearchFlip::ResponseError in case any errors occur.
-  #
-  # @example
-  #   ElasticSearch.post_aliases(actions: [
-  #     { remove: { index: "test1", alias: "alias1" }},
-  #     { add: { index: "test2", alias: "alias1" }}
-  #   ])
-  #
-  # @param payload [Hash] The raw request payload
-  #
-  # @return [SearchFlip::Response] The raw response
-
-  def self.aliases(payload)
-    SearchFlip::HTTPClient.headers(accept: "application/json", content_type: "application/json").post("#{SearchFlip::Config[:base_url]}/_aliases", body: SearchFlip::JSON.generate(payload))
-  end
 end
 

data/lib/search_flip/aggregatable.rb

@@ -56,7 +56,7 @@ module SearchFlip
         hash = field_or_hash.is_a?(Hash) ? field_or_hash : { field_or_hash => { terms: { field: field_or_hash }.merge(options) } }
 
         if block
-          aggregation = block.call(SearchFlip::Aggregation.new)
+          aggregation = yield(SearchFlip::Aggregation.new(target: target))
 
           field_or_hash.is_a?(Hash) ? hash[field_or_hash.keys.first].merge!(aggregation.to_hash) : hash[field_or_hash].merge!(aggregation.to_hash)
         end

data/lib/search_flip/aggregation.rb

@@ -8,6 +8,12 @@ module SearchFlip
     include SearchFlip::Filterable
     include SearchFlip::Aggregatable
 
+    attr_reader :target
+
+    def initialize(target:)
+      @target = target
+    end
+
     # @api private
     #
     # Converts the aggregation to a hash format that can be used in the request.
@@ -19,20 +25,20 @@ module SearchFlip
       res[:aggregations] = aggregation_values if aggregation_values
 
       if must_values || search_values || must_not_values || should_values || filter_values
-        if SearchFlip.version.to_i >= 2
+        if target.connection.version.to_i >= 2
           res[:filter] = {
-            bool: {}.
-              merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {}).
-              merge(must_not_values ? { must_not: must_not_values } : {}).
-              merge(should_values ? { should: should_values } : {}).
-              merge(filter_values ? { filter: filter_values } : {})
+            bool: {}
+              .merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {})
+              .merge(must_not_values ? { must_not: must_not_values } : {})
+              .merge(should_values ? { should: should_values } : {})
+              .merge(filter_values ? { filter: filter_values } : {})
           }
         else
           filters = (filter_values || []) + (must_not_values || []).map { |must_not_value| { not: must_not_value } }
 
-          queries = {}.
-            merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {}).
-            merge(should_values ? { should: should_values } : {})
+          queries = {}
+            .merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {})
+            .merge(should_values ? { should: should_values } : {})
 
           filters_and_queries = filters + (queries.size > 0 ? [bool: queries] : [])
 

data/lib/search_flip/bulk.rb

@@ -113,7 +113,10 @@ module SearchFlip
     end
 
     def upload
-      response = SearchFlip::HTTPClient.headers(accept: "application/json", content_type: "application/x-ndjson").put(url, body: @payload, params: ignore_errors ? {} : { filter_path: "errors" })
+      response =
+        SearchFlip::HTTPClient
+          .headers(accept: "application/json", content_type: "application/x-ndjson")
+          .put(url, body: @payload, params: ignore_errors ? {} : { filter_path: "errors" })
 
       return if options[:raise] == false
 
@@ -121,13 +124,13 @@ module SearchFlip
 
       return unless parsed_response["errors"]
 
-      raise(SearchFlip::Bulk::Error, response[0 .. 30]) unless ignore_errors
+      raise(SearchFlip::Bulk::Error, response[0..30]) unless ignore_errors
 
       parsed_response["items"].each do |item|
-        item.each do |_, _item|
-          status = _item["status"]
+        item.each do |_, element|
+          status = element["status"]
 
-          raise(SearchFlip::Bulk::Error, SearchFlip::JSON.generate(_item)) if !status.between?(200, 299) && !ignore_errors.include?(status)
+          raise(SearchFlip::Bulk::Error, SearchFlip::JSON.generate(element)) if !status.between?(200, 299) && !ignore_errors.include?(status)
         end
       end
     ensure

data/lib/search_flip/config.rb

@@ -1,16 +1,5 @@
 
 module SearchFlip
-  # Queries and returns the ElasticSearch version used.
-  #
-  # @example
-  #   SearchFlip.version # => e.g. 2.4.1
-  #
-  # @return [String] The ElasticSearch version
-
-  def self.version
-    @version ||= SearchFlip::HTTPClient.get("#{Config[:base_url]}/").parse["version"]["number"]
-  end
-
   Config = {
     index_prefix: nil,
     base_url: "http://127.0.0.1:9200",

data/lib/search_flip/connection.rb

@@ -0,0 +1,131 @@
+
+module SearchFlip
+  class Connection
+    attr_reader :base_url
+
+    def initialize(base_url: SearchFlip::Config[:base_url])
+      @base_url = base_url
+    end
+
+    # Queries and returns the ElasticSearch version used.
+    #
+    # @example
+    #   connection.version # => e.g. 2.4.1
+    #
+    # @return [String] The ElasticSearch version
+
+    def version
+      @version ||= SearchFlip::HTTPClient.get("#{base_url}/").parse["version"]["number"]
+    end
+
+    # Uses the ElasticSearch Multi Search API to execute multiple search requests
+    # within a single request. Raises SearchFlip::ResponseError in case any
+    # errors occur.
+    #
+    # @example
+    #   connection.msearch [ProductIndex.match_all, CommentIndex.match_all]
+    #
+    # @param criterias [Array<SearchFlip::Criteria>] An array of search
+    #   queries to execute in parallel
+    #
+    # @return [Array<SearchFlip::Response>] An array of responses
+
+    def msearch(criterias)
+      payload = criterias.flat_map do |criteria|
+        [
+          SearchFlip::JSON.generate(index: criteria.target.index_name_with_prefix, type: criteria.target.type_name),
+          SearchFlip::JSON.generate(criteria.request)
+        ]
+      end
+
+      payload = payload.join("\n")
+      payload << "\n"
+
+      raw_response =
+        SearchFlip::HTTPClient
+          .headers(accept: "application/json", content_type: "application/x-ndjson")
+          .post("#{base_url}/_msearch", body: payload)
+
+      raw_response.parse["responses"].map.with_index do |response, index|
+        SearchFlip::Response.new(criterias[index], response)
+      end
+    end
+
+    # Used to manipulate, ie add and remove index aliases. Raises an
+    # SearchFlip::ResponseError in case any errors occur.
+    #
+    # @example
+    #   connection.update_aliases(actions: [
+    #     { remove: { index: "test1", alias: "alias1" }},
+    #     { add: { index: "test2", alias: "alias1" }}
+    #   ])
+    #
+    # @param payload [Hash] The raw request payload
+    #
+    # @return [Hash] The raw response
+
+    def update_aliases(payload)
+      SearchFlip::HTTPClient
+        .headers(accept: "application/json", content_type: "application/json")
+        .post("#{base_url}/_aliases", body: SearchFlip::JSON.generate(payload))
+        .parse
+    end
+
+    # Fetches information about the specified index aliases. Raises
+    # SearchFlip::ResponseError in case any errors occur.
+    #
+    # @example
+    #   connection.get_aliases(alias_name: "some_alias")
+    #   connection.get_aliases(index_name: "index1,index2")
+    #
+    # @param alias_name [String] The alias or comma separated list of alias names
+    # @param index_name [String] The index or comma separated list of index names
+    #
+    # @return [Hash] The raw response
+
+    def get_aliases(index_name: "*", alias_name: "*")
+      res = SearchFlip::HTTPClient
+        .headers(accept: "application/json", content_type: "application/json")
+        .get("#{base_url}/#{index_name}/_alias/#{alias_name}")
+        .parse
+
+      Hashie::Mash.new(res)
+    end
+
+    # Returns whether or not the associated ElasticSearch alias already
+    # exists.
+    #
+    # @example
+    #   connection.alias_exists?("some_alias")
+    #
+    # @return [Boolean] Whether or not the alias exists
+
+    def alias_exists?(alias_name)
+      SearchFlip::HTTPClient
+        .headers(accept: "application/json", content_type: "application/json")
+        .get("#{base_url}/_alias/#{alias_name}")
+
+      true
+    rescue SearchFlip::ResponseError => e
+      return false if e.code == 404
+
+      raise e
+    end
+
+    # Fetches information about the specified indices. Raises
+    # SearchFlip::ResponseError in case any errors occur.
+    #
+    # @example
+    #   connection.get_indices('prefix*')
+    #
+    # @return [Array] The raw response
+
+    def get_indices(name = "*")
+      SearchFlip::HTTPClient
+        .headers(accept: "application/json", content_type: "application/json")
+        .get("#{base_url}/_cat/indices/#{name}")
+        .parse
+    end
+  end
+end
+