esse 0.2.0 → 0.2.3

data/lib/esse/deprecations/index_backend_delegator.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module Esse
+  module Deprecations
+    class IndexBackendDelegator
+      extend Esse::Deprecations::Deprecate
+
+      def initialize(namespace, index)
+        @namespace = namespace
+        @index = index
+      end
+
+      def aliases(**kwargs)
+        warning("#{@index}.#{@namespace}.aliases", "#{@index}.aliases", 2023, 12)
+        @index.aliases(**kwargs)
+      end
+
+      def indices(**kwargs)
+        warning("#{@index}.#{@namespace}.indices", "#{@index}.indices_pointing_to_alias", 2023, 12)
+        @index.indices_pointing_to_alias(**kwargs)
+      end
+
+      def update_aliases!(**kwargs)
+        warning("#{@index}.#{@namespace}.update_aliases!", "#{@index}.update_aliases", 2023, 12)
+        @index.update_aliases(**kwargs)
+      end
+
+      def update_aliases(**kwargs)
+        warning("#{@index}.#{@namespace}.update_aliases", "#{@index}.update_aliases", 2023, 12)
+
+        @index.update_aliases(**kwargs)
+      rescue Esse::Transport::NotFoundError
+        { 'errors' => true }
+      end
+
+      def create_index(**kwargs)
+        warning("#{@index}.#{@namespace}.create_index", "#{@index}.create_index", 2023, 12)
+
+        @index.create_index(**kwargs)
+      end
+
+      def create_index!(**kwargs)
+        warning("#{@index}.#{@namespace}.create_index!", "#{@index}.create_index", 2023, 12)
+
+        @index.create_index(**kwargs)
+      end
+
+      def close(**kwargs)
+        warning("#{@index}.#{@namespace}.close", "#{@index}.close", 2023, 12)
+
+        @index.close(**kwargs)
+      end
+
+      def close!(**kwargs)
+        warning("#{@index}.#{@namespace}.close!", "#{@index}.close", 2023, 12)
+
+        @index.close(**kwargs)
+      end
+
+      def open(**kwargs)
+        warning("#{@index}.#{@namespace}.open", "#{@index}.open", 2023, 12)
+
+        @index.open(**kwargs)
+      end
+
+      def open!(**kwargs)
+        warning("#{@index}.#{@namespace}.open!", "#{@index}.open", 2023, 12)
+
+        @index.open(**kwargs)
+      end
+
+      def refresh(**kwargs)
+        warning("#{@index}.#{@namespace}.refresh", "#{@index}.refresh", 2023, 12)
+
+        @index.refresh(**kwargs)
+      end
+
+      def refresh!(**kwargs)
+        warning("#{@index}.#{@namespace}.refresh!", "#{@index}.refresh", 2023, 12)
+
+        @index.refresh(**kwargs)
+      end
+
+      def delete_index(**kwargs)
+        warning("#{@index}.#{@namespace}.delete_index", "#{@index}.delete_index", 2023, 12)
+
+        @index.delete_index(**kwargs)
+      end
+
+      def delete_index!(**kwargs)
+        warning("#{@index}.#{@namespace}.delete_index!", "#{@index}.delete_index", 2023, 12)
+
+        @index.delete_index(**kwargs)
+      end
+
+      def index_exist?(**kwargs)
+        warning("#{@index}.#{@namespace}.index_exist?", "#{@index}.index_exist?", 2023, 12)
+
+        @index.index_exist?(**kwargs)
+      end
+
+      def update_mapping!(**kwargs)
+        warning("#{@index}.#{@namespace}.update_mapping!", "#{@index}.update_mapping", 2023, 12)
+
+        @index.update_mapping(**kwargs)
+      end
+
+      def update_mapping(**kwargs)
+        warning("#{@index}.#{@namespace}.update_mapping", "#{@index}.update_mapping", 2023, 12)
+
+        @index.update_mapping(**kwargs)
+      end
+
+      def update_settings!(**kwargs)
+        warning("#{@index}.#{@namespace}.update_settings!", "#{@index}.update_settings", 2023, 12)
+
+        @index.update_settings(**kwargs)
+      end
+
+      def update_settings(**kwargs)
+        warning("#{@index}.#{@namespace}.update_settings", "#{@index}.update_settings", 2023, 12)
+
+        @index.update_settings(**kwargs)
+      end
+
+      def reset_index!(**kwargs)
+        warning("#{@index}.#{@namespace}.reset_index!", "#{@index}.reset_index", 2023, 12)
+
+        @index.reset_index(**kwargs)
+      end
+
+      def import(**kwargs)
+        warning("#{@index}.#{@namespace}.import", "#{@index}.import", 2023, 12)
+
+        @index.import(**kwargs)
+      end
+
+      def import!(**kwargs)
+        warning("#{@index}.#{@namespace}.import!", "#{@index}.import", 2023, 12)
+
+        @index.import(**kwargs)
+      end
+
+      def bulk!(**kwargs)
+        warning("#{@index}.#{@namespace}.bulk!", "#{@index}.bulk", 2023, 12)
+
+        @index.bulk(**kwargs)
+      end
+
+      def bulk(**kwargs)
+        warning("#{@index}.#{@namespace}.bulk", "#{@index}.bulk", 2023, 12)
+
+        @index.bulk(**kwargs)
+      end
+
+      def index!(**kwargs)
+        warning("#{@index}.#{@namespace}.index!", "#{@index}.index", 2023, 12)
+
+        @index.index(**kwargs)
+      end
+
+      def index(**kwargs)
+        warning("#{@index}.#{@namespace}.index", "#{@index}.index", 2023, 12)
+
+        @index.index(**kwargs)
+      end
+
+      def update!(**kwargs)
+        warning("#{@index}.#{@namespace}.update!", "#{@index}.update", 2023, 12)
+
+        @index.update(**kwargs)
+      end
+
+      def update(**kwargs)
+        warning("#{@index}.#{@namespace}.update", "#{@index}.update", 2023, 12)
+
+        @index.update(**kwargs)
+      end
+
+      def delete!(**kwargs)
+        warning("#{@index}.#{@namespace}.delete!", "#{@index}.delete", 2023, 12)
+
+        @index.delete(**kwargs)
+      end
+
+      def delete(**kwargs)
+        warning("#{@index}.#{@namespace}.delete", "#{@index}.delete", 2023, 12)
+
+        @index.delete(**kwargs)
+      end
+
+      def count(**kwargs)
+        warning("#{@index}.#{@namespace}.count", "#{@index}.count", 2023, 12)
+
+        @index.count(**kwargs)
+      end
+
+      def exist?(**kwargs)
+        warning("#{@index}.#{@namespace}.exist?", "#{@index}.exist?", 2023, 12)
+
+        @index.exist?(**kwargs)
+      end
+
+      def find!(**kwargs)
+        warning("#{@index}.#{@namespace}.find!", "#{@index}.get", 2023, 12)
+
+        @index.get(**kwargs)
+      end
+
+      def find(**kwargs)
+        warning("#{@index}.#{@namespace}.find", "#{@index}.get", 2023, 12)
+
+        @index.get(**kwargs)
+      end
+    end
+  end
+end

data/lib/esse/deprecations/repository.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Esse
+  class Repository
+    class << self
+      extend Esse::Deprecations::Deprecate
+
+      def type_name
+        repo_name
+      end
+      deprecate :type_name, :repo_type, 2023, 12
+
+      def mappings(*args, &block)
+        warning("#{self}.mappings", "#{index}.mappings", 2023, 12)
+
+        index.mappings(*args, &block)
+      end
+
+      def serializer(*args, **kwargs, &block)
+        warning("#{self}.serializer", "#{self}.document", 2023, 12)
+
+        document(*args, **kwargs, &block)
+      end
+
+      def elasticsearch
+        Esse::Deprecations::RepositoryBackendDelegator.new(:elasticsearch, self)
+      end
+
+      def backend
+        Esse::Deprecations::RepositoryBackendDelegator.new(:backend, self)
+      end
+    end
+  end
+end

data/lib/esse/deprecations/repository_backend_delegator.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Esse
+  module Deprecations
+    class RepositoryBackendDelegator
+      extend Esse::Deprecations::Deprecate
+
+      def initialize(namespace, repo)
+        @namespace = namespace
+        @repo = repo
+      end
+
+      def import(**kwargs)
+        warning("#{@repo}.#{@namespace}.import", "#{@repo}.import", 2023, 12)
+
+        @repo.import(**kwargs)
+      end
+
+      def import!(**kwargs)
+        warning("#{@repo}.#{@namespace}.import!", "#{@repo}.import", 2023, 12)
+
+        @repo.import(**kwargs)
+      end
+
+      def bulk(**kwargs)
+        warning("#{@repo}.#{@namespace}.bulk", "#{@repo.index}.bulk", 2023, 12)
+
+        @repo.index.bulk(**kwargs)
+      end
+
+      def bulk!(**kwargs)
+        warning("#{@repo}.#{@namespace}.bulk!", "#{@repo.index}.bulk", 2023, 12)
+
+        @repo.index.bulk(**kwargs)
+      end
+
+      def index(**kwargs)
+        warning("#{@repo}.#{@namespace}.index", "#{@repo.index}.index", 2023, 12)
+
+        @repo.index.index(**kwargs)
+      end
+
+      def index!(**kwargs)
+        warning("#{@repo}.#{@namespace}.index!", "#{@repo.index}.index", 2023, 12)
+
+        @repo.index.index(**kwargs)
+      end
+
+      def index_document(*args, **kwargs)
+        warning("#{@repo}.#{@namespace}.index_document", "#{@repo.index}.index", 2023, 12)
+
+        @repo.index.index(*args, **kwargs)
+      end
+
+      def update!(**kwargs)
+        warning("#{@repo}.#{@namespace}.update!", "#{@repo.index}.update", 2023, 12)
+
+        @repo.index.update(**kwargs)
+      end
+
+      def update(**kwargs)
+        warning("#{@repo}.#{@namespace}.update", "#{@repo.index}.update", 2023, 12)
+
+        @repo.index.update(**kwargs)
+      end
+
+      def delete!(**kwargs)
+        warning("#{@repo}.#{@namespace}.delete!", "#{@repo.index}.delete", 2023, 12)
+
+        @repo.index.delete(**kwargs)
+      end
+
+      def delete(**kwargs)
+        warning("#{@repo}.#{@namespace}.delete", "#{@repo.index}.delete", 2023, 12)
+
+        @repo.index.delete(**kwargs)
+      end
+
+      def delete_document(*args, **kwargs)
+        warning("#{@repo}.#{@namespace}.delete_document", "#{@repo.index}.delete", 2023, 12)
+
+        @repo.index.delete(*args, **kwargs)
+      end
+
+      def count(**kwargs)
+        warning("#{@repo}.#{@namespace}.count", "#{@repo.index}.count", 2023, 12)
+
+        @repo.index.count(**kwargs)
+      end
+
+      def exist?(**kwargs)
+        warning("#{@repo}.#{@namespace}.exist?", "#{@repo.index}.exist?", 2023, 12)
+
+        @repo.index.exist?(**kwargs)
+      end
+
+      def find!(**kwargs)
+        warning("#{@repo}.#{@namespace}.find!", "#{@repo.index}.get", 2023, 12)
+
+        @repo.index.get(**kwargs)
+      end
+
+      def find(**kwargs)
+        warning("#{@repo}.#{@namespace}.find", "#{@repo.index}.get", 2023, 12)
+
+        @repo.index.get(**kwargs)
+      end
+    end
+  end
+end

data/lib/esse/deprecations/serializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Esse
+  class Serializer < Esse::Document
+    class << self
+      extend Esse::Deprecations::Deprecate
+
+      def inherited(subclass)
+        warning 'Esse::Serializer', 'Esse::Document', 2023, 12
+        super(subclass)
+      end
+    end
+  end
+end

data/lib/esse/deprecations.rb

@@ -0,0 +1,7 @@
+require_relative 'deprecations/deprecate'
+require_relative 'deprecations/serializer'
+require_relative 'deprecations/index_backend_delegator'
+require_relative 'deprecations/index'
+require_relative 'deprecations/cluster'
+require_relative 'deprecations/repository_backend_delegator'
+require_relative 'deprecations/repository'

data/lib/esse/document.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Esse
+  class Document
+    attr_reader :object, :options
+
+    def initialize(object, **options)
+      @object = object
+      @options = options
+    end
+
+    # @return [String, Number] the document ID
+    # @abstract Override this method to return the document ID
+    def id
+      raise NotImplementedError, 'Override this method to return the document ID'
+    end
+
+    # @return [String, nil] the document type
+    # @abstract Override this method to return the document type
+    def type
+      nil
+    end
+
+    # @return [Boolean] whether the document has type
+    def type?
+      !type.nil?
+    end
+
+    # @return [String, nil] the document routing
+    # @abstract Override this method to return the document routing
+    def routing
+      nil
+    end
+
+    # @return [Boolean] whether the document has routing
+    def routing?
+      !routing.nil?
+    end
+
+    # @TODO allow import, index, bulk to accept a suffix to tell which index to use
+    # def index_suffix
+    #   nil
+    # end
+
+    # @return [Hash] the document meta
+    # @abstract Override this method to return the document meta
+    def meta
+      {}
+    end
+
+    # @return [Hash] the document source
+    # @abstract Override this method to return the document source
+    def source
+      {}
+    end
+
+    # @return [Hash] the document data
+    def to_h
+      source.merge(
+        _id: id,
+      ).tap do |hash|
+        hash[:_type] = type if type
+        hash[:_routing] = routing if routing
+        hash.merge!(meta)
+      end
+    end
+
+    def to_bulk(data: true)
+      { _id: id }.tap do |h|
+        h[:data] = source&.to_h if data
+        h[:_type] = type if type
+        h[:routing] = routing if routing?
+        h.merge!(meta)
+      end
+    end
+
+    def ignore_on_index?
+      id.nil?
+    end
+
+    def ignore_on_delete?
+      id.nil?
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && (
+        id == other.id && type == other.type && routing == other.routing && meta == other.meta && source == other.source
+      )
+    end
+  end
+end

data/lib/esse/dynamic_template.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Esse
+  class DynamicTemplate
+    # @param [Array, Hash] value The list of dynamic_templates for mapping
+    def initialize(value)
+      @hash = normalize(value)
+    end
+
+    def merge!(value)
+      @hash = HashUtils.deep_merge(@hash, normalize(value))
+    end
+
+    def []=(key, value)
+      merge!(key => value)
+    end
+
+    def to_a
+      @hash.map do |name, value|
+        { name => value }
+      end
+    end
+
+    def any?
+      @hash.any?
+    end
+
+    def dup
+      self.class.new(@hash.dup)
+    end
+
+    private
+
+    def normalize(value)
+      case value
+      when Array
+        value.map { |v| normalize(v) }.reduce(&:merge)
+      when Hash
+        HashUtils.deep_transform_keys(value, &:to_sym)
+      end || {}
+    end
+  end
+end

data/lib/esse/errors.rb

@@ -4,6 +4,66 @@ module Esse
   class Error < StandardError
   end
 
+  # @todo Rename this
+  class Transport
+    class ServerError < ::Esse::Error; end
+
+    # exception to raise when the cluster is readonly
+    class ReadonlyClusterError < ::Esse::Error
+      def initialize
+        super('You cannot perform this operation on a readonly cluster')
+      end
+    end
+
+    ES_TRANSPORT_ERRORS = {
+      'MultipleChoices' => 'MultipleChoicesError', # 300
+      'MovedPermanently' => 'MovedPermanentlyError', # 301
+      'Found' => 'FoundError', # 302
+      'SeeOther' => 'SeeOtherError', # 303
+      'NotModified' => 'NotModifiedError', # 304
+      'UseProxy' => 'UseProxyError', # 305
+      'TemporaryRedirect' => 'TemporaryRedirectError', # 307
+      'PermanentRedirect' => 'PermanentRedirectError', # 308
+      'BadRequest' => 'BadRequestError', # 400
+      'Unauthorized' => 'UnauthorizedError', # 401
+      'PaymentRequired' => 'PaymentRequiredError', # 402
+      'Forbidden' => 'ForbiddenError', # 403
+      'NotFound' => 'NotFoundError', # 404
+      'MethodNotAllowed' => 'MethodNotAllowedError', # 405
+      'NotAcceptable' => 'NotAcceptableError', # 406
+      'ProxyAuthenticationRequired' => 'ProxyAuthenticationRequiredError', # 407
+      'RequestTimeout' => 'RequestTimeoutError', # 408
+      'Conflict' => 'ConflictError', # 409
+      'Gone' => 'GoneError', # 410
+      'LengthRequired' => 'LengthRequiredError', # 411
+      'PreconditionFailed' => 'PreconditionFailedError', # 412
+      'RequestEntityTooLarge' => 'RequestEntityTooLargeError', # 413
+      'RequestURITooLong' => 'RequestURITooLongError', # 414
+      'UnsupportedMediaType' => 'UnsupportedMediaTypeError', # 415
+      'RequestedRangeNotSatisfiable' => 'RequestedRangeNotSatisfiableError', # 416
+      'ExpectationFailed' => 'ExpectationFailedError', # 417
+      'ImATeapot' => 'ImATeapotError', # 418
+      'TooManyConnectionsFromThisIP' => 'TooManyConnectionsFromThisIPError', # 421
+      'UpgradeRequired' => 'UpgradeRequiredError', # 426
+      'BlockedByWindowsParentalControls' => 'BlockedByWindowsParentalControlsError', # 450
+      'RequestHeaderTooLarge' => 'RequestHeaderTooLargeError', # 494
+      'HTTPToHTTPS' => 'HTTPToHTTPSError', # 497
+      'ClientClosedRequest' => 'ClientClosedRequestError', # 499
+      'InternalServerError' => 'InternalServerError', # 500
+      'NotImplemented' => 'NotImplementedError', # 501
+      'BadGateway' => 'BadGatewayError', # 502
+      'ServiceUnavailable' => 'ServiceUnavailableError', # 503
+      'GatewayTimeout' => 'GatewayTimeoutError', # 504
+      'HTTPVersionNotSupported' => 'HTTPVersionNotSupportedError', # 505
+      'VariantAlsoNegotiates' => 'VariantAlsoNegotiatesError', # 506
+      'NotExtended' => 'NotExtendedError', # 510
+    }
+
+    ERRORS = ES_TRANSPORT_ERRORS.each_with_object({}) do |(transport_name, esse_name), memo|
+      memo[transport_name] = const_set esse_name, Class.new(ServerError)
+    end
+  end
+
   module Events
     class UnregisteredEventError < ::Esse::Error
       def initialize(object_or_event_id)
@@ -42,6 +102,4 @@ module Esse
     class InvalidOption < Error
     end
   end
-
-  # Elasticsearch::Transport::Transport::Errors::NotFound
 end

data/lib/esse/events/event.rb

@@ -3,6 +3,10 @@
 module Esse
   module Events
     class Event
+      extend Forwardable
+      def_delegators :@payload, :[], :fetch, :to_h, :key?
+      alias_method :to_hash, :to_h
+
       attr_reader :id
 
       # Initialize a new event
@@ -18,25 +22,6 @@ module Esse
         @payload = payload
       end
 
-      # Get data from the payload
-      #
-      # @param [String,Symbol] name
-      #
-      # @api public
-      def [](name)
-        @payload.fetch(name)
-      end
-
-      # Coerce an event to a hash
-      #
-      # @return [Hash]
-      #
-      # @api public
-      def to_h
-        @payload
-      end
-      alias_method :to_hash, :to_h
-
       # Get or set a payload
       #
       # @overload

data/lib/esse/events.rb

@@ -38,12 +38,23 @@ module Esse
   module Events
     include Publisher
 
+    register_event 'elasticsearch.bulk'
     register_event 'elasticsearch.close'
-    register_event 'elasticsearch.open'
     register_event 'elasticsearch.create_index'
     register_event 'elasticsearch.delete_index'
+    register_event 'elasticsearch.execute_search_query'
+    register_event 'elasticsearch.index_exist'
+    register_event 'elasticsearch.open'
+    register_event 'elasticsearch.refresh'
+    register_event 'elasticsearch.search'
+    register_event 'elasticsearch.update_aliases'
     register_event 'elasticsearch.update_mapping'
     register_event 'elasticsearch.update_settings'
-    register_event 'elasticsearch.update_aliases'
+    register_event 'elasticsearch.index'
+    register_event 'elasticsearch.update'
+    register_event 'elasticsearch.delete'
+    register_event 'elasticsearch.exist'
+    register_event 'elasticsearch.count'
+    register_event 'elasticsearch.get'
   end
 end

data/lib/esse/hash_document.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Esse
+  class HashDocument < Esse::Document
+    META_KEYS = %i[_id _type _routing routing].freeze
+
+    def initialize(object)
+      @object = object
+      @options = {}
+    end
+
+    # @return [String, Number] the document ID
+    def id
+      object['_id'] || object[:_id] || object['id'] || object[:id]
+    end
+
+    # @return [String, nil] the document type
+    def type
+      object['_type'] || object[:_type]
+    end
+
+    # @return [String, nil] the document routing
+    def routing
+      object['_routing'] || object[:_routing] || object['routing'] || object[:routing]
+    end
+
+    # @return [Hash] the document meta
+    def meta
+      {}
+    end
+
+    # @return [Hash] the document source
+    # @abstract Override this method to return the document source
+    def source
+      object.reject { |key, _| META_KEYS.include?(key.to_sym) }
+    end
+  end
+end