esse 0.0.2

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

@@ -0,0 +1,56 @@
+# 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.backend.create # 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, false] the elasticsearch response or false in case of unsuccessful creation.
+        #
+        # @see http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
+        def create(suffix: nil, **options)
+          create!(suffix: suffix, **options)
+        rescue Elasticsearch::Transport::Transport::Errors::BadRequest
+          false
+        end
+
+        # Creates index and applies mappings and settings.
+        #
+        #   UsersIndex.backend.create! # 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.
+        # @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!(suffix: nil, **options)
+          options = DEFAULT_OPTIONS.merge(options)
+          name = real_index_name(suffix)
+          definition = [settings_hash, mappings_hash].reduce(&:merge)
+
+          if options[:alias] && name != index_name
+            definition[:aliases] = { index_name => {} }
+          end
+
+          client.indices.create(index: name, body: definition)
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Esse
+  module Backend
+    class Index
+      module InstanceMethods
+        # Deletes ES index
+        #
+        #   UsersIndex.backend.delete! # deletes `<prefix_>users<_suffix|_index_version|_timestamp>` index
+        #
+        # @param options [Hash] Options hash
+        # @option [String, nil] :suffix 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!(suffix:)
+          name = suffix ? real_index_name(suffix) : index_name
+
+          client.indices.delete(index: name)
+        end
+
+        # Deletes ES index
+        #
+        #   UsersIndex.backend.delete # deletes `<prefix_>users<_suffix|_index_version|_timestamp>` index
+        #
+        # @param options [Hash] Options hash
+        # @option [String] :suffix The index suffix. Use nil if you want to delete the current index.
+        # @return [Hash, false] elasticsearch response, of false in case of error.
+        def delete(suffix: index_version)
+          delete!(suffix: suffix)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          false
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Esse
+  module Backend
+    class Index
+      module InstanceMethods
+        # Checks the index existance. Returns true or false
+        #
+        #   UsersIndex.backend.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)
+          name = suffix ? real_index_name(suffix) : index_name
+          client.indices.exists(index: name)
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Esse
+  module Backend
+    class Index
+      module InstanceMethods
+        def update_mapping!(**options)
+          # @TODO
+        end
+
+        def update_settings!(**options)
+          # @TODO
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

data/lib/esse/backend/index_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Esse
+  module Backend
+    class IndexType
+      require_relative 'index_type/documents'
+
+      extend Forwardable
+
+      # Type delegators
+      def_delegators :@index_type, :type_name, :each_serialized_batch, :serialize
+      # Index delegators
+      def_delegators :index_class, :index_name
+
+      def initialize(type)
+        @index_type = type
+      end
+
+      protected
+
+      def index_class
+        @index_type.index
+      end
+
+      def client
+        index_class.cluster.client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Esse
+  module Backend
+    class IndexType
+      module InstanceMethods
+        # Resolve collection and index data
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @option [Hash] :context The collection context. This value will be passed as argument to the collection
+        #   May be SQL condition or any other filter you have defined on the collection.
+        def import(context: {}, **options)
+          each_serialized_batch(context || {}) do |batch|
+            bulk(index: batch, **options)
+          end
+        end
+        alias import! import
+
+        # Performs multiple indexing or delete operations in a single API call.
+        # This reduces overhead and can greatly increase indexing speed.
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [Array] :index list of serialized documents to be indexed(Optional)
+        # @param options [Array] :delete list of serialized documents to be deleted(Optional)
+        # @param options [Array] :create list of serialized documents to be created(Optional)
+        # @return [Hash, nil] the elasticsearch response or nil if there is no data.
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-bulk.html
+        def bulk(index: nil, delete: nil, create: nil, **options)
+          body = []
+          Array(index).each do |entry|
+            id, data = Esse.doc_id!(entry)
+            body << { index: { _id: id, data: data } } if id
+          end
+          Array(create).each do |entry|
+            id, data = Esse.doc_id!(entry)
+            body << { create: { _id: id, data: data } } if id
+          end
+          Array(delete).each do |entry|
+            id, _data = Esse.doc_id!(entry, delete: [], keep: %w[_id id])
+            body << { delete: { _id: id } } if id
+          end
+
+          return if body.empty?
+
+          definition = {
+            index: index_name,
+            type: type_name,
+            body: body,
+          }.merge(options)
+
+          client.bulk(definition)
+        end
+        alias bulk! bulk
+
+        # Adds a JSON document to the specified index and makes it searchable. If the document
+        # already exists, updates the document and increments its version.
+        #
+        #   UsersIndex::User.index(id: 1, body: { name: 'name' }) # { '_id' => 1, ...}
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [Hash] :body The JSON document that will be indexed (Required)
+        # @return [Hash] the elasticsearch response Hash
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-index_.html
+        def index(id:, body:, **options)
+          client.index(
+            options.merge(index: index_name, type: type_name, id: id, body: body),
+          )
+        end
+        alias index! index
+
+        # Updates a document using the specified script.
+        #
+        #   UsersIndex::User.update!(id: 1, body: { doc: { ... } }) # { '_id' => 1, ...}
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [Hash] :body the body of the request
+        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
+        # @return [Hash] elasticsearch response hash
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-update.html
+        def update!(id:, body:, **options)
+          client.update(
+            options.merge(index: index_name, type: type_name, id: id, body: body),
+          )
+        end
+
+        # Updates a document using the specified script.
+        #
+        #   UsersIndex::User.update(id: 1, body: { doc: { ... } }) # { '_id' => 1, ...}
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [Hash] :body the body of the request
+        # @return [Hash, false] the elasticsearch response hash, or false in case of failure
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-update.html
+        def update(id:, body:, **options)
+          update!(id: id, body: body, **options)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          false
+        end
+
+        # Removes a JSON document from the specified index.
+        #
+        #   UsersIndex::User.delete!(id: 1) # true
+        #   UsersIndex::User.delete!(id: 'missing') # raise Elasticsearch::Transport::Transport::Errors::NotFound
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
+        # @return [Boolean] true when the operation is successfully completed
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete.html
+        def delete!(id:, **options)
+          client.delete(options.merge(index: index_name, type: type_name, id: id))
+        end
+
+        # Removes a JSON document from the specified index.
+        #
+        #   UsersIndex::User.delete(id: 1) # true
+        #   UsersIndex::User.delete(id: 'missing') # false
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
+        # @return [Boolean] true when the operation is successfully completed
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete.html
+        def delete(id:, **options)
+          delete!(id: id, **options)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          false
+        end
+
+        # Gets the number of matches for a search query.
+        #
+        #   UsersIndex::User.count # 999
+        #   UsersIndex::User.count(body: { ... }) # 32
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [Hash] :body A query to restrict the results specified with the Query DSL (optional)
+        # @return [Integer] amount of documents found
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-count.html
+        def count(**options)
+          response = client.count(options.merge(index: index_name, type: type_name))
+          response['count']
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          0
+        end
+
+        # Check if a JSON document exists
+        #
+        #   UsersIndex::User.exist?(id: 1) # true
+        #   UsersIndex::User.exist?(id: 'missing') # false
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @return [Boolean] true if the document exists
+        def exist?(id:, **options)
+          client.exists(options.merge(index: index_name, type: type_name, id: id))
+        end
+
+        # Retrieves the specified JSON document from an index.
+        #
+        #   UsersIndex::User.find!(id: 1) # { '_id' => 1, ... }
+        #   UsersIndex::User.find!(id: 'missing') # raise Elasticsearch::Transport::Transport::Errors::NotFound
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
+        # @return [Hash] The elasticsearch document.
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
+        def find!(id:, **options)
+          client.get(options.merge(index: index_name, type: type_name, id: id))
+        end
+
+        # Retrieves the specified JSON document from an index.
+        #
+        #   UsersIndex::User.find(id: 1) # { '_id' => 1, ... }
+        #   UsersIndex::User.find(id: 'missing') # nil
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @return [Hash, nil] The elasticsearch document
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
+        def find(id:, **options)
+          find!(id: id, **options)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          nil
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

data/lib/esse/cli.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require_relative 'cli/index'
+require_relative 'cli/generate'
+
+module Esse
+  module CLI
+    def self.start(*args)
+      Root.start(*args)
+    end
+
+    class Root < Thor
+      map %w[--version -v] => :version
+
+      desc 'index SUBCOMMAND ...ARGS', 'Manage indices'
+      subcommand 'index', Index
+
+      desc 'generate SUBCOMMAND ...ARGS', 'Run generators'
+      subcommand 'generate', Generate
+
+      desc '--version, -v', 'Show package version'
+      def version
+        puts format('Esse version: %<version>s', version: Esse::VERSION)
+      end
+    end
+  end
+end

data/lib/esse/cli/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Esse
+  module CLI
+    class Base < Thor
+      include Thor::Actions
+    end
+  end
+end