esse 0.2.0 → 0.2.3

data/lib/esse/backend/index/create.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        DEFAULT_OPTIONS = {
-          alias: true,
-        }.freeze
-
-        # Creates index and applies mappings and settings.
-        #
-        #   UsersIndex.elasticsearch.create_index # creates index named `<prefix_>users_<suffix|index_version|timestamp>`
-        #
-        # @param options [Hash] Options hash
-        # @option options [Boolean] :alias Update `index_name` alias along with the new index
-        # @option options [String] :suffix The index suffix. Defaults to the `IndexClass#index_version` or
-        #   `Esse.timestamp`. Suffixed index names might be used for zero-downtime mapping change.
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        #
-        # @see http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
-        def create_index(suffix: index_version, **options)
-          create_index!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::Errors::BadRequest
-          { 'errors' => true }
-        end
-
-        # Creates index and applies mappings and settings.
-        #
-        #   UsersIndex.elasticsearch.create_index! # creates index named `<prefix_>users_<suffix|index_version|timestamp>`
-        #
-        # @param options [Hash] Options hash
-        # @option options [Boolean] :alias Update `index_name` alias along with the new index
-        # @option options [String] :suffix The index suffix. Defaults to the `IndexClass#index_version` or
-        #   `Esse.timestamp`. Suffixed index names might be used for zero-downtime mapping change.
-        # @option arguments [String] :wait_for_active_shards Set the number of active shards
-        #    to wait for before the operation returns.
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The configuration for the index (`settings` and `mappings`)
-        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when index already exists
-        # @return [Hash] the elasticsearch response
-        #
-        # @see http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
-        def create_index!(suffix: index_version, **options)
-          options = DEFAULT_OPTIONS.merge(options)
-          name = build_real_index_name(suffix)
-          definition = [settings_hash, mappings_hash].reduce(&:merge)
-
-          if options.delete(:alias) && name != index_name
-            definition[:aliases] = { index_name => {} }
-          end
-
-          Esse::Events.instrument('elasticsearch.create_index') do |payload|
-            payload[:request] = opts = options.merge(index: name, body: definition)
-            payload[:response] = response = client.indices.create(**opts)
-            cluster.wait_for_status! if response
-            response
-          end
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/delete.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Deletes ES index
-        #
-        #   UsersIndex.elasticsearch.delete_index! # deletes `<prefix_>users<_suffix|_index_version|_timestamp>` index
-        #
-        # @param suffix [String, nil] The index suffix Use nil if you want to delete the current index.
-        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when index does not exists
-        # @return [Hash] elasticsearch response
-        def delete_index!(suffix: index_version, **options)
-          Esse::Events.instrument('elasticsearch.delete_index') do |payload|
-            payload[:request] = opts = options.merge(index: index_name(suffix: suffix))
-            payload[:response] = response = client.indices.delete(**opts)
-            cluster.wait_for_status! if response
-            response
-          end
-        end
-
-        # Deletes ES index
-        #
-        #   UsersIndex.elasticsearch.delete_index # deletes `<prefix_>users<_suffix|_index_version|_timestamp>` index
-        #
-        # @param suffix [String, nil] The index suffix Use nil if you want to delete the current index.
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        def delete_index(suffix: index_version, **options)
-          delete_index!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
-          { 'errors' => true }
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/documents.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        def import!(**options)
-          type_hash.each_value do |type|
-            type.elasticsearch.import!(**options)
-          end
-        end
-
-        def import(**options)
-          type_hash.each_value do |type|
-            type.elasticsearch.import(**options)
-          end
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/existance.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Checks the index existance. Returns true or false
-        #
-        #   UsersIndex.elasticsearch.exist? #=> true
-        #
-        # @param options [Hash] Options hash
-        # @option options [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   Use nil if you want to check existence of the `index_name` index or alias.
-        def exist?(suffix: index_version)
-          client.indices.exists(index: index_name(suffix: suffix))
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/open.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Open a previously closed index
-        #
-        # @option options [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   Use nil if you want to check existence of the `index_name` index or alias.
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Time] :timeout Explicit operation timeout
-        # @raise [Elasticsearch::Transport::Transport::Errors::BadRequest, Elasticsearch::Transport::Transport::Errors::NotFound]
-        #   in case of failure
-        # @return [Hash] the elasticsearch response
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-open.html
-        def open!(suffix: index_version, **options)
-          Esse::Events.instrument('elasticsearch.open') do |payload|
-            payload[:request] = attributes = options.merge(index: index_name(suffix: suffix))
-            payload[:response] = client.indices.open(**attributes)
-          end
-        end
-
-        # Open a previously closed index
-        #
-        # @option options [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   Use nil if you want to check existence of the `index_name` index or alias.
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Time] :timeout Explicit operation timeout
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-open.html
-        def open(suffix: index_version, **options)
-          open!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::ServerError
-          { 'errors' => true }
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/refresh.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Performs the refresh operation in one or more indices.
-        #
-        # @note The refresh operation can adversely affect indexing throughput when used too frequently.
-        # @param :suffix [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   A uniq index name will be generated if one index already exist with the given alias.
-        # @param options [Hash] Options hash
-        # @raise [Elasticsearch::Transport::Transport::Errors::BadRequest, Elasticsearch::Transport::Transport::Errors::NotFound]
-        #   in case of failure
-        # @return [Hash] the elasticsearch response
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html
-        def refresh!(suffix: index_version, **options)
-          client.indices.refresh(
-            options.merge(index: index_name(suffix: suffix)),
-          )
-        end
-
-        # Performs the refresh operation in one or more indices.
-        #
-        # @note The refresh operation can adversely affect indexing throughput when used too frequently.
-        # @param :suffix [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   A uniq index name will be generated if one index already exist with the given alias.
-        # @param options [Hash] Options hash
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html
-        def refresh(suffix: index_version, **options)
-          refresh!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::ServerError
-          { 'errors' => true }
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/reset.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Deletes, creates and imports data to the index. Performs zero-downtime index resetting.
-        #
-        # @option options [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   A uniq index name will be generated if one index already exist with the given alias.
-        # @option options [Time] :timeout Explicit operation timeout
-        # @raise [Elasticsearch::Transport::Transport::Errors::BadRequest, Elasticsearch::Transport::Transport::Errors::NotFound]
-        #   in case of failure
-        # @return [Hash] the elasticsearch response
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html
-        def reset_index!(suffix: index_version, **options)
-          existing = []
-          suffix ||= Esse.timestamp
-          suffix = Esse.timestamp while exist?(suffix: suffix).tap { |exist| existing << suffix if exist }
-
-          create_index!(**options, suffix: suffix, alias: false)
-          import!(**options, suffix: suffix)
-          update_aliases!(suffix: suffix)
-          existing.each { |_s| delete_index!(**options, suffix: suffix) }
-          true
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/update.rb

@@ -1,143 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Create or update a mapping
-        #
-        # @option options [String] :type The name of the document type. This field is required for some elasticsearch versions
-        # @option options [Boolean] :ignore_conflicts Specify whether to ignore conflicts while updating the mapping
-        #   (default: false)
-        # @option options [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
-        #   no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Boolean] :update_all_types Whether to update the mapping for all fields
-        #   with the same name across all types
-        # @option options [Time] :timeout Explicit operation timeout
-        # @option options [Boolean] :master_timeout Timeout for connection to master
-        # @raise [Elasticsearch::Transport::Transport::Errors::BadRequest, Elasticsearch::Transport::Transport::Errors::NotFound]
-        #   in case of failure
-        # @return [Hash] the elasticsearch response
-        #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/
-        def update_mapping!(suffix: index_version, **options)
-          Esse::Events.instrument('elasticsearch.update_mapping') do |payload|
-            body = mappings_hash.fetch(Esse::MAPPING_ROOT_KEY)
-            if (type = options[:type])
-              body = body[type.to_s] || body[type.to_sym]
-            end
-            payload[:request] = opts = options.merge(index: index_name(suffix: suffix), body: body)
-            payload[:response] = client.indices.put_mapping(**opts)
-          end
-        end
-
-        # Create or update a mapping
-        #
-        # @option options [String] :type The name of the document type. This field is required for some elasticsearch versions
-        # @option options [Boolean] :ignore_conflicts Specify whether to ignore conflicts while updating the mapping
-        #   (default: false)
-        # @option options [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
-        #   no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Boolean] :update_all_types Whether to update the mapping for all fields
-        #   with the same name across all types
-        # @option options [Time] :timeout Explicit operation timeout
-        # @option options [Boolean] :master_timeout Timeout for connection to master
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/
-        def update_mapping(suffix: index_version, **options)
-          update_mapping!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::ServerError
-          { 'errors' => true }
-        end
-
-        # Closes the index for read/write operations, updates the index settings, and open it again
-        #
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Boolean] :include_defaults Whether to return all default clusters setting
-        # @option options [Boolean] :preserve_existing Whether to update existing settings.
-        #   If set to `true` existing settings on an index remain unchanged, the default is `false`
-        # @option options [Time] :master_timeout Specify timeout for connection to master
-        # @option options [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @raise [Elasticsearch::Transport::Transport::Errors::BadRequest, Elasticsearch::Transport::Transport::Errors::NotFound]
-        #   in case of failure
-        # @return [Hash] the elasticsearch response
-        #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
-        def update_settings!(suffix: index_version, **options)
-          response = nil
-
-          settings = settings_hash.fetch(Esse::SETTING_ROOT_KEY).transform_keys(&:to_s)
-          settings.delete('number_of_shards') # Can't change number of shards for an index
-          analysis = settings.delete('analysis')
-
-          if settings.any?
-            # When changing the number of replicas the index needs to be open. Changing the number of replicas on a
-            # closed index might prevent the index to be opened correctly again.
-            Esse::Events.instrument('elasticsearch.update_settings') do |payload|
-              payload[:request] = opts = options.merge(index: index_name(suffix: suffix), body: { index: settings })
-              payload[:response] = response = client.indices.put_settings(**opts)
-            end
-          end
-
-          if analysis
-            # It is also possible to define new analyzers for the index. But it is required to close the
-            # index first and open it after the changes are made.
-            close!(suffix: suffix)
-            begin
-              Esse::Events.instrument('elasticsearch.update_settings') do |payload|
-                payload[:request] = opts = options.merge(index: index_name(suffix: suffix), body: { analysis: analysis })
-                payload[:response] = response = client.indices.put_settings(**opts)
-              end
-            ensure
-              open!(suffix: suffix)
-            end
-          end
-
-          response
-        end
-
-        # Closes the index for read/write operations, updates the index settings, and open it again
-        #
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Boolean] :include_defaults Whether to return all default clusters setting
-        # @option options [Boolean] :preserve_existing Whether to update existing settings.
-        #   If set to `true` existing settings on an index remain unchanged, the default is `false`
-        # @option options [Time] :master_timeout Specify timeout for connection to master
-        # @option options [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
-        def update_settings(suffix: index_version, **options)
-          update_settings!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::ServerError
-          { 'errors' => true }
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-module Esse
-  module Backend
-    class Index
-      require_relative 'index/aliases'
-      require_relative 'index/create'
-      require_relative 'index/delete'
-      require_relative 'index/existance'
-      require_relative 'index/update'
-      require_relative 'index/refresh'
-      require_relative 'index/reset'
-      require_relative 'index/documents'
-      require_relative 'index/open'
-      require_relative 'index/close'
-
-      extend Forwardable
-
-      NAMING = %i[index_version].freeze
-      DEFINITION = %i[settings_hash mappings_hash].freeze
-
-      def_delegators :@index, :type_hash, *(NAMING + DEFINITION)
-
-      def initialize(index)
-        @index = index
-      end
-
-      protected
-
-      def index_name(suffix: nil)
-        suffix = Hstring.new(suffix).underscore.presence
-        return @index.index_name unless suffix
-
-        [@index.index_name, suffix].join('_')
-      end
-
-      def build_real_index_name(suffix = nil)
-        suffix = Hstring.new(suffix).underscore.presence || index_version || Esse.timestamp
-
-        index_name(suffix: suffix)
-      end
-
-      def client
-        cluster.client
-      end
-
-      def cluster
-        @index.cluster
-      end
-    end
-  end
-end