elastomer-client 3.2.2 → 6.2.0

data/lib/elastomer/client/warmer.rb

@@ -1,98 +0,0 @@
-module Elastomer
-  class Client
-
-    # DEPRECATED: Warmers have been removed from Elasticsearch as of 5.0.
-    # See https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-warmers.html
-    class Warmer
-
-      # Create a new Warmer helper for making warmer API requests.
-      #
-      # client     - Elastomer::Client used for HTTP requests to the server
-      # index_name - The name of the index as a String
-      # name       - The name of the warmer as a String
-      def initialize(client, index_name, name)
-        unless client.version_support.supports_warmers?
-          raise IncompatibleVersionException, "ES #{client.version} does not support warmers"
-        end
-
-        @client     = client
-        @index_name = @client.assert_param_presence(index_name, "index name")
-        @name       = @client.assert_param_presence(name, "warmer name")
-      end
-
-      attr_reader :client, :index_name, :name
-
-      # Create a warmer.
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
-      #
-      # query  - The query the warmer should run
-      # params - Parameters Hash
-      #
-      # Examples
-      #
-      #   warmer.create(:query => {:match_all => {}})
-      #
-      # Returns the response body as a Hash
-      def create(query, params = {})
-        response = client.put "/{index}{/type}/_warmer/{warmer}", update_params(params, body: query, action: "warmer.create", rest_api: "indices.put_warmer")
-        response.body
-      end
-
-      # Delete a warmer.
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html#removing
-      #
-      # params   - Parameters Hash
-      #
-      # Returns the response body as a Hash
-      def delete(params = {})
-        response = client.delete "/{index}{/type}/_warmer/{warmer}", update_params(params, action: "warmer.delete", rest_api: "indices.delete_warmer")
-        response.body
-      end
-
-      # Get a warmer.
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html#warmer-retrieving
-      #
-      # params   - Parameters Hash
-      #
-      # Returns the response body as a Hash
-      def get(params = {})
-        response = client.get "/{index}{/type}/_warmer/{warmer}", update_params(params, action: "warmer.get", rest_api: "indices.get_warmer")
-        response.body
-      end
-
-      # Check whether a warmer exists. Also aliased as exist?
-      #
-      # Since there is no native warmer exists api, this method executes
-      # a get and watches for an IndexWarmerMissingException error.
-      #
-      # Returns true if the warmer exists, false if not.
-      #COMPATIBILITY warmer response differs in ES 1.0
-      # ES 1.0: missing warmer returns {} with 200 status
-      # ES 0.90: missing warmer returns IndexWarmerMissingException error
-      # See https://github.com/elasticsearch/elasticsearch/issues/5155
-      def exists?
-        response = get
-        response != {}
-      rescue Elastomer::Client::Error => exception
-        if exception.message =~ /IndexWarmerMissingException/
-          false
-        else
-          raise exception
-        end
-      end
-      alias_method :exist?, :exists?
-
-      # Internal:
-      def update_params(params, overrides = nil)
-        h = defaults.update params
-        h.update overrides unless overrides.nil?
-        h
-      end
-
-      # Internal: Returns a Hash containing default parameters.
-      def defaults
-        {index: index_name, warmer: name}
-      end
-    end
-  end
-end

data/lib/elastomer/version.rb

@@ -1,7 +0,0 @@
-module Elastomer
-  VERSION = "3.2.2"
-
-  def self.version
-    VERSION
-  end
-end

data/lib/elastomer/version_support.rb

@@ -1,182 +0,0 @@
-module Elastomer
-  # VersionSupport holds methods that (a) encapsulate version differences; or
-  # (b) give an intention-revealing name to a conditional check.
-  class VersionSupport
-
-    attr_reader :version
-
-    # version - an Elasticsearch version string e.g., 2.3.5 or 5.3.0
-    #
-    # Raises ArgumentError if version is unsupported.
-    def initialize(version)
-      if version < "2.3" || version >= "5.7"
-        raise ArgumentError, "Elasticsearch version #{version} is not supported by elastomer-client"
-      end
-
-      @version = version
-    end
-
-    # COMPATIBILITY: Return a boolean indicating if this version supports warmers.
-    # Warmers were removed in ES 5.0.
-    def supports_warmers?
-      es_version_2_x?
-    end
-
-    # COMPATIBILITY: The Tasks API is evolving quickly; features, and request/response
-    # structure can differ across ES versions
-    def tasks_new_response_format?
-      es_version_5_x?
-    end
-
-    # COMPATIBILITY: Return a boolean indicating if this version supports the
-    # `tasks.get` API - https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html
-    def supports_tasks_get?
-      es_version_5_x?
-    end
-
-    # COMPATIBILITY: Return a boolean indicating if this version supports the
-    # `parent_task_id` param in the tasks API - https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html
-    def supports_parent_task_id?
-      es_version_5_x?
-    end
-
-    # COMPATIBILITY: Return a "text"-type mapping for a field.
-    #
-    # On ES 2.x, this will be a string field. On ES 5+, it will be a text field.
-    def text(**args)
-      reject_args!(args, :type, :index)
-
-      if es_version_2_x?
-        {type: "string"}.merge(args)
-      else
-        {type: "text"}.merge(args)
-      end
-    end
-
-    # COMPATIBILITY: Return a "keyword"-type mapping for a field.
-    #
-    # On ES 2.x, this will be a string field with not_analyzed=true. On ES 5+,
-    # it will be a keyword field.
-    def keyword(**args)
-      reject_args!(args, :type, :index)
-
-      if es_version_2_x?
-        {type: "string", index: "not_analyzed"}.merge(args)
-      else
-        {type: "keyword"}.merge(args)
-      end
-    end
-
-    # COMPATIBILITY: return a simple boolean value or legacy {"enabled": true/false}.
-    #
-    # https://www.elastic.co/guide/en/elasticsearch/reference/5.5/breaking_50_mapping_changes.html#_literal_norms_literal
-    def strict_boolean(b)
-      if es_version_2_x?
-        {enabled: b}
-      else
-        b
-      end
-    end
-
-    # COMPATIBILITY: handle _op_type -> op_type request param conversion for put-if-absent bnehavior
-    # Returns the (possibly mutated) params hash supplied by the caller.
-    #
-    # https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#operation-type
-    def op_type(params = {})
-      if es_version_5_x? && (params.key?(:_op_type) || params.key?("_op_type"))
-        params[:op_type] = params.delete(:_op_type)
-      end
-      params
-    end
-
-    # Elasticsearch 2.0 changed some request formats in a non-backward-compatible
-    # way. Some tests need to know what version is running to structure requests
-    # as expected.
-    #
-    # Returns true if Elasticsearch version is 2.x.
-    def es_version_2_x?
-      version >= "2.0.0" && version <  "3.0.0"
-    end
-
-    # Elasticsearch 5.0 changed some request formats in a non-backward-compatible
-    # way. Some tests need to know what version is running to structure requests
-    # as expected.
-    #
-    # Returns true if Elasticsearch version is 5.x.
-    def es_version_5_x?
-      version >= "5.0.0" && version < "6.0.0"
-    end
-
-    # Wraps version check and param gen where ES version >= 5.x requires
-    # percolator type + field defined in mappings
-    def percolator_type
-      if es_version_5_x?
-        "percolator"
-      else
-        ".percolator"
-      end
-    end
-
-    # COMPATIBILITY
-    # ES 2.x reports query parsing exceptions as query_parse_exception whereas
-    # ES 5.x reports them as query_shard_exception or parsing_exception
-    # depending on when the error occurs.
-    #
-    # Returns an Array of Strings to match.
-    def query_parse_exception
-      if es_version_2_x?
-        ["query_parsing_exception"]
-      else
-        ["query_shard_exception", "parsing_exception"]
-      end
-    end
-
-    # COMPATIBILITY
-    #
-    # ES5 doesn't accept/ignore ambiguous or unexpected req params any more
-    alias :strict_request_params? :es_version_5_x?
-
-    # COMPATIBILITY
-    # ES 5.X supports `delete_by_query` natively again.
-    alias :native_delete_by_query? :es_version_5_x?
-
-    # COMPATIBILITY
-    # Internal: VersionSupport maintains dynamically-created lists of acceptable and unacceptable
-    # request params by ES version. This just shims that list since those params have leading
-    # underscores by default. If we end up with >1 such param, let's make a real thing to handle this.
-    def fix_op_type!(params = {})
-      if es_version_5_x? && params.key?(:op_type)
-        params[:op_type] = "op_type"
-      end
-    end
-
-    # COMPATIBILITY
-    # Return a symbol representing the best supported delete_by_query
-    # implementation for this version of Elasticsearch.
-    def delete_by_query_method
-      if es_version_2_x?
-        :app_delete_by_query
-      else
-        :native_delete_by_query
-      end
-    end
-
-    # ES 5.X supports GZip-compressed request bodies, but ES 2.4 doesn't?
-    def supports_gzip?
-      es_version_5_x?
-    end
-
-    private
-
-    # Internal: Helper to reject arguments that shouldn't be passed because
-    # merging them in would defeat the purpose of a compatibility layer.
-    def reject_args!(args, *names)
-      names.each do |name|
-        if args.include?(name.to_s) || args.include?(name.to_sym)
-          raise ArgumentError, "Argument '#{name}' is not allowed"
-        end
-      end
-    end
-
-  end
-end

data/script/cibuild

@@ -1,103 +0,0 @@
-#!/bin/bash
-# Usage: script/cibuild
-# CI build script
-# This is tailored for the janky build machines.
-
-set -ue
-
-# Only echo the tags when in CI_MODE
-begin_fold() {
-  local tag="$1"
-  if [ "${CI_MODE:-}" ]; then
-    echo "%%%FOLD {${tag}}%%%"
-  fi
-}
-
-# Only echo the tags when in CI_MODE
-end_fold() {
-  if [ "${CI_MODE:-}" ]; then
-    echo "%%%END FOLD%%%"
-  fi
-}
-
-function cleanup() {
-  echo
-  begin_fold "Shutting down services..."
-  $docker_compose down -v
-  end_fold
-}
-
-# Borrowed from script/bintools in github/ci
-output_fold() {
-  # Exit early if no label provided
-  if [ -z "$1" ]; then
-    echo "output_fold(): requires a label argument."
-    return
-  fi
-
-  exit_value=0  # exit_value is used to record exit status of the given command
-  label=$1      # human-readable label describing what's being folded up
-  shift 1       # having retrieved the output_fold()-specific arguments, strip them off $@
-
-  begin_fold "$label"
-
-  # run the remaining arguments. If the command exits non-0, the `||` will
-  # prevent the `-e` flag from seeing the failure exit code, and we'll see
-  # the second echo execute
-  "$@" || exit_value=$?
-
-  end_fold
-
-  # preserve the exit code from the subcommand.
-  return $exit_value
-}
-
-trap cleanup EXIT
-
-export ES_PORT=${ES_PORT:-19200}
-
-es_version=${ES_VERSION:-24}
-docker_compose="docker-compose --file docker/docker-compose.es${es_version}.yml"
-
-if [ "${CI_MODE:-}" ]; then
-  docker_compose="${docker_compose} --file docker/docker-compose.cibuild.yml"
-#  docker_compose="${docker_compose} --no-ansi"
-fi
-
-# change into root dir and setup path
-cd $(dirname "$0")/..
-PATH="$(pwd)/bin:$(pwd)/script:/usr/share/rbenv/shims:$PATH"
-
-echo "hostname: $(hostname)"
-
-# Write commit we're building at
-output_fold "Commit info..." git log -n 1 || true
-echo
-
-output_fold "Bootstrapping container..." $docker_compose build
-output_fold "Bringing up services..." $docker_compose up -d
-output_fold "Waiting for Elasticsearch..." script/poll-for-es
-echo
-
-result=0
-
-begin_fold "Ruby environment setup..."
-export RBENV_VERSION="2.3.3"
-if [ -d /usr/share/rbenv/shims ]; then
-  export PATH=/usr/share/rbenv/shims:$PATH
-fi
-ruby -v
-rm -f Gemfile.lock
-script/bootstrap
-end_fold
-echo
-
-bundle exec rake test || result=$?
-
-if [ $result -ne 0 ]; then
-  exit $result
-fi
-
-# echo
-# echo "Running benchmarks"
-# script/benchmark

data/script/cibuild-elastomer-client

@@ -1 +0,0 @@
-script/cibuild-elastomer-client-es24

data/script/cibuild-elastomer-client-es24

@@ -1,8 +0,0 @@
-#!/bin/bash
-# Usage: script/cibuild-es24
-# CI build script targeting Elasticsearch 2.4
-
-export ES_VERSION=24
-export CI_MODE=true
-
-script/cibuild

data/script/cibuild-elastomer-client-es56

@@ -1,8 +0,0 @@
-#!/bin/bash
-# Usage: script/cibuild-es56
-# CI build script targeting Elasticsearch 5.6
-
-export ES_VERSION=56
-export CI_MODE=true
-
-script/cibuild

data/test/client/app_delete_by_query_test.rb

@@ -1,192 +0,0 @@
-require_relative "../test_helper"
-
-describe Elastomer::Client::AppDeleteByQuery do
-
-  before do
-    @index = $client.index "elastomer-delete-by-query-test"
-    @index.delete if @index.exists?
-    @docs = @index.docs("docs")
-  end
-
-  after do
-    @index.delete if @index.exists?
-  end
-
-  describe "when an index with documents exists" do
-    before do
-      @index.create(nil)
-      wait_for_index(@index.name)
-    end
-
-    it "deletes by query" do
-      @docs.index({ :_id => 0, :name => "mittens" })
-      @docs.index({ :_id => 1, :name => "luna" })
-
-      @index.refresh
-      response = @index.app_delete_by_query(nil, :q => "name:mittens")
-      assert_equal({
-        "_all" => {
-          "found" => 1,
-          "deleted" => 1,
-          "missing" => 0,
-          "failed" => 0,
-        },
-        @index.name => {
-          "found" => 1,
-          "deleted" => 1,
-          "missing" => 0,
-          "failed" => 0,
-        },
-      }, response["_indices"])
-
-      @index.refresh
-      response = @docs.multi_get :ids => [0, 1]
-      refute_found response["docs"][0]
-      assert_found response["docs"][1]
-    end
-
-    it "respects action_count" do
-      @docs.index({ :_id => 0, :name => "mittens" })
-      @docs.index({ :_id => 1, :name => "luna" })
-      @index.refresh
-
-      response = @index.app_delete_by_query(nil, :action_count => 1)
-
-      assert_requested(:post, /_bulk/, :times => 2)
-
-      assert_equal({
-        "_all" => {
-          "found" => 2,
-          "deleted" => 2,
-          "missing" => 0,
-          "failed" => 0,
-        },
-        @index.name => {
-          "found" => 2,
-          "deleted" => 2,
-          "missing" => 0,
-          "failed" => 0,
-        },
-      }, response["_indices"])
-
-      @index.refresh
-      response = @docs.multi_get :ids => [0, 1]
-      refute_found response["docs"][0]
-      refute_found response["docs"][1]
-    end
-
-    it "counts missing documents" do
-      @docs.index({ :_id => 0 })
-
-      stub_request(:post, /_bulk/).
-        to_return(lambda do |request|
-          {
-            :body => MultiJson.dump({
-              "took" => 0,
-              "errors" => false,
-              "items" => [{
-                "delete" => {
-                  "_index" => @index.name,
-                  "_type" => @docs.name,
-                  "_id" => 0,
-                  "_version" => 1,
-                  "status" => 404,
-                  "found" => false } }] }) }
-        end)
-
-      @index.refresh
-      response = @index.app_delete_by_query(nil, :action_count => 1)
-      assert_equal({
-        "_all" => {
-          "found" => 0,
-          "deleted" => 0,
-          "missing" => 1,
-          "failed" => 0,
-        },
-        @index.name => {
-          "found" => 0,
-          "deleted" => 0,
-          "missing" => 1,
-          "failed" => 0,
-        },
-      }, response["_indices"])
-    end
-
-    it "counts failed operations" do
-      @docs.index({ :_id => 0 })
-
-      stub_request(:post, /_bulk/).
-        to_return(lambda do |request|
-          {
-            :body => MultiJson.dump({
-              "took" => 0,
-              "errors" => false,
-              "items" => [{
-                "delete" => {
-                  "_index" => @index.name,
-                  "_type" => @docs.name,
-                  "_id" => 0,
-                  "status" => 409,
-                  "error" => "VersionConflictEngineException" } }] }) }
-        end)
-
-      @index.refresh
-      response = @index.app_delete_by_query(nil, :action_count => 1)
-      assert_equal({
-        "_all" => {
-          "found" => 1,
-          "deleted" => 0,
-          "missing" => 0,
-          "failed" => 1,
-        },
-        @index.name => {
-          "found" => 1,
-          "deleted" => 0,
-          "missing" => 0,
-          "failed" => 1,
-        },
-      }, response["_indices"])
-    end
-
-    it "deletes by query when routing is specified" do
-      index = $client.index "elastomer-delete-by-query-routing-test"
-      index.delete if index.exists?
-      type = "docs"
-      index.create({ :mappings => { type => { :_routing => { :required => true } } } })
-      wait_for_index(@index.name)
-      docs = index.docs(type)
-
-      docs.index({ :_id => 0, :_routing => "cat", :name => "mittens" })
-      docs.index({ :_id => 1, :_routing => "cat", :name => "luna" })
-
-      index.refresh
-      response = index.app_delete_by_query(nil, :q => "name:mittens")
-      assert_equal({
-        "_all" => {
-          "found" => 1,
-          "deleted" => 1,
-          "missing" => 0,
-          "failed" => 0,
-        },
-        index.name => {
-          "found" => 1,
-          "deleted" => 1,
-          "missing" => 0,
-          "failed" => 0,
-        },
-      }, response["_indices"])
-
-      index.refresh
-      response = docs.multi_get({
-        :docs => [
-          { :_id => 0, :_routing => "cat" },
-          { :_id => 1, :_routing => "cat" },
-        ]
-      })
-      refute_found response["docs"][0]
-      assert_found response["docs"][1]
-
-      index.delete if index.exists?
-    end
-  end
-end

data/test/client/es_5_x_warmer_test.rb

@@ -1,13 +0,0 @@
-require_relative "../test_helper"
-
-describe "Elastomer::Client::Warmer under ES 5.x" do
-  it "cannot be instantiated" do
-    if $client.version_support.supports_warmers?
-      skip "warmers are still supported in ES #{$client.version}."
-    end
-
-    assert_raises(Elastomer::Client::IncompatibleVersionException) do
-      Elastomer::Client::Warmer.new($client, "index", "warmer")
-    end
-  end
-end

data/test/client/warmer_test.rb

@@ -1,60 +0,0 @@
-require_relative "../test_helper"
-
-describe Elastomer::Client::Warmer do
-  before do
-    unless $client.version_support.supports_warmers?
-      skip "warmers are not supported in ES #{$client.version}"
-    end
-
-    @name  = "elastomer-warmer-test"
-    @index = $client.index(@name)
-
-    unless @index.exists?
-      @index.create(
-        :settings => { "index.number_of_shards" => 1, "index.number_of_replicas" => 0 },
-        :mappings => {
-          :tweet => {
-            :_source => { :enabled => true }, :_all => { :enabled => false },
-            :properties => {
-              :message => $client.version_support.text(analyzer: "standard"),
-              :author  => $client.version_support.keyword
-            }
-          }
-        }
-      )
-      wait_for_index(@name)
-    end
-  end
-
-  after do
-    @index.delete if defined?(@index) && @index.exists?
-  end
-
-  it "creates warmers" do
-    h = @index.warmer("test1").create(:query => { :match_all => {}})
-    assert_acknowledged h
-  end
-
-  it "deletes warmers" do
-    @index.warmer("test1").create(:query => { :match_all => {}})
-
-    h = @index.warmer("test1").delete
-    assert_acknowledged h
-  end
-
-  it "gets warmers" do
-    body = { "query" => {"match_all" => {}}}
-    @index.warmer("test1").create(body)
-
-    h = @index.warmer("test1").get
-    assert_equal body, h[@name]["warmers"]["test1"]["source"]
-  end
-
-  it "knows when warmers exist" do
-    assert_equal false, @index.warmer("test1").exists?
-    assert_equal false, @index.warmer("test1").exist?
-
-    @index.warmer("test1").create(:query => { :match_all => {}})
-    assert_equal true, @index.warmer("test1").exists?
-  end
-end