esse 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f309243fb21b878b0d14b85c16a2d344dd595659d7972cadc7cd40c246ffd9a
-  data.tar.gz: 670f66a022b7fe568fe9f995c0d8cd9832d65da5a9bfb21490a4a7e222540023
+  metadata.gz: 6d7f91a4ecb008fe3d8849175cb6f1bb08605d56432b7bc7f52ca9df0c55e77e
+  data.tar.gz: a9b4143597ca2ca571360814b381e8398bd3ac8b45134fc5b3086dfc8a33f0a1
 SHA512:
-  metadata.gz: 99b6fa0017361c185cdf71c7505f6a37dcfc28127f04504496dc1fbdddf8b7ca4a2c06e6c2e56dd30464c90f3b2012fc982bcdb3ed5159a1b331bfbe3c2e30d1
-  data.tar.gz: db75895be7643f9bbedb9c81c071b4438e1f277637b2447dd7d8444c719820c41a97bdf69f0230e422a60412b2de93b674d2e459d0a324cb21bd49cbf2763f91
+  metadata.gz: ef25dc5238beea72d67eeaf146dad16184cd8d78c76fc84516154e8ddd5cb93f2c5f1fd84574359147d6428dbdb1d25f037d0dce004f79e4e22cbbf1dcc2a30b
+  data.tar.gz: 6c5237fc9f5b59376ef6e948132c5a78200f4f849acab591ba603b3c5173d95c6179dfec3844331a6ba30f41ae519515b12c3f3396d80e4bff5dd3445525faad

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esse (0.0.1)
+    esse (0.0.2)
       elasticsearch
       multi_json
       thor (>= 0.19)
@@ -29,7 +29,7 @@ GEM
     pry (0.12.0)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -53,7 +53,7 @@ DEPENDENCIES
   dotenv
   esse!
   pry
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,7 @@
 # esse
 
+**This project is under development and may suffer constant structural changes. I don't recommend using it right now**
+
 Simple and efficient way to organize queries/mapping/indices/tasks based on the official elasticsearch-ruby.
 
 ## Why to use it?

data/esse.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/esse.rb

@@ -3,5 +3,8 @@
 require 'esse/index'
 
 module Esse
+  SETTING_ROOT_KEY = 'settings'
+  MAPPING_ROOT_KEY = 'mappings'
+
   class Error < StandardError; end
 end

data/lib/esse/backend/index.rb

@@ -11,6 +11,8 @@ module Esse
       require_relative 'index/existance'
       require_relative 'index/update'
       require_relative 'index/documents'
+      require_relative 'index/open'
+      require_relative 'index/close'
 
       extend Forwardable
 

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Esse
+  module Backend
+    class Index
+      module InstanceMethods
+        # Close an index (keep the data on disk, but deny operations with the 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-close.html
+        def close!(suffix: index_version, **options)
+          name = suffix ? real_index_name(suffix) : index_name
+
+          client.indices.close(options.merge(index: name))
+        end
+
+        # Close an index (keep the data on disk, but deny operations with the 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, false] the elasticsearch response, or false in case of failure
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html
+        def close(suffix: index_version, **options)
+          close!(suffix: suffix, **options)
+        rescue Elasticsearch::Transport::Transport::ServerError
+          false
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module Esse
 
         # Creates index and applies mappings and settings.
         #
-        #   UsersIndex.backend.create # creates index named `<prefix_>users_<suffix|index_version|timestamp>`
+        #   UsersIndex.backend.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
@@ -19,15 +19,15 @@ module Esse
         # @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)
+        def create_index(suffix: nil, **options)
+          create_index!(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>`
+        #   UsersIndex.backend.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
@@ -37,7 +37,7 @@ module Esse
         # @return [Hash] the elasticsearch response
         #
         # @see http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
-        def create!(suffix: nil, **options)
+        def create_index!(suffix: nil, **options)
           options = DEFAULT_OPTIONS.merge(options)
           name = real_index_name(suffix)
           definition = [settings_hash, mappings_hash].reduce(&:merge)

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

@@ -6,13 +6,13 @@ module Esse
       module InstanceMethods
         # Deletes ES index
         #
-        #   UsersIndex.backend.delete! # deletes `<prefix_>users<_suffix|_index_version|_timestamp>` index
+        #   UsersIndex.backend.delete_index! # 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:)
+        def delete_index!(suffix:)
           name = suffix ? real_index_name(suffix) : index_name
 
           client.indices.delete(index: name)
@@ -20,13 +20,13 @@ module Esse
 
         # Deletes ES index
         #
-        #   UsersIndex.backend.delete # deletes `<prefix_>users<_suffix|_index_version|_timestamp>` index
+        #   UsersIndex.backend.delete_index # 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)
+        def delete_index(suffix: index_version)
+          delete_index!(suffix: suffix)
         rescue Elasticsearch::Transport::Transport::Errors::NotFound
           false
         end

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

@@ -0,0 +1,53 @@
+# 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)
+          name = suffix ? real_index_name(suffix) : index_name
+
+          client.indices.open(options.merge(index: name))
+        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, false] the elasticsearch response, or false 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
+          false
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

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

@@ -4,12 +4,114 @@ module Esse
   module Backend
     class Index
       module InstanceMethods
-        def update_mapping!(**options)
-          # @TODO
+        # 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)
+          name = suffix ? real_index_name(suffix) : index_name
+
+          client.indices.put_mapping(options.merge(index: name, body: mappings_hash.fetch(Esse::MAPPING_ROOT_KEY)))
+        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, false] the elasticsearch response, or false 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
+          false
+        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)
+          name = suffix ? real_index_name(suffix) : index_name
+          response = nil
+
+          close!(suffix: suffix)
+          begin
+            body = settings_hash(cluster_settings: false).fetch(Esse::SETTING_ROOT_KEY)
+            response = client.indices.put_settings(options.merge(index: name, body: body))
+          ensure
+            open!(suffix: suffix)
+          end
+
+          response
         end
 
-        def update_settings!(**options)
-          # @TODO
+        # 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, false] the elasticsearch response, false 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
+          false
         end
       end
 

data/lib/esse/index/mappings.rb

@@ -7,11 +7,10 @@
 module Esse
   class Index
     module ClassMethods
-      MAPPING_ROOT_KEY = 'mappings'
 
       # This is the actually content that will be passed through the ES api
       def mappings_hash
-        { MAPPING_ROOT_KEY => (index_mapping || type_mapping) }
+        { Esse::MAPPING_ROOT_KEY => (index_mapping || type_mapping) }
       end
 
       # This method is only used to define mapping
@@ -32,7 +31,7 @@ module Esse
         return if mapping.empty?
 
         hash = mapping.body
-        hash.key?(MAPPING_ROOT_KEY) ? hash[MAPPING_ROOT_KEY] : hash
+        hash.key?(Esse::MAPPING_ROOT_KEY) ? hash[Esse::MAPPING_ROOT_KEY] : hash
       end
 
       def type_mapping

data/lib/esse/index/settings.rb

@@ -4,11 +4,10 @@ module Esse
   # https://github.com/elastic/elasticsearch-ruby/blob/master/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb
   class Index
     module ClassMethods
-      SETTING_ROOT_KEY = 'settings'
 
-      def settings_hash
-        hash = setting.body
-        { SETTING_ROOT_KEY => (hash.key?(SETTING_ROOT_KEY) ? hash[SETTING_ROOT_KEY] : hash) }
+      def settings_hash(cluster_settings: true)
+        hash = cluster_settings ? cluster.index_settings.merge(setting.body) : setting.body
+        { Esse::SETTING_ROOT_KEY => (hash.key?(Esse::SETTING_ROOT_KEY) ? hash[Esse::SETTING_ROOT_KEY] : hash) }
       end
 
       # Define /_settings definition by each index.

data/lib/esse/index_type/mappings.rb

@@ -2,7 +2,7 @@
 
 module Esse
   class IndexType
-    # https://github.com/elastic/elasticsearch-ruby/blob/master/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb
+    # https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html
     module ClassMethods
       # This method is only used to define mapping
       def mappings(hash = {}, &block)

data/lib/esse/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esse
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,10 +146,12 @@ files:
 - lib/esse.rb
 - lib/esse/backend/index.rb
 - lib/esse/backend/index/aliases.rb
+- lib/esse/backend/index/close.rb
 - lib/esse/backend/index/create.rb
 - lib/esse/backend/index/delete.rb
 - lib/esse/backend/index/documents.rb
 - lib/esse/backend/index/existance.rb
+- lib/esse/backend/index/open.rb
 - lib/esse/backend/index/update.rb
 - lib/esse/backend/index_type.rb
 - lib/esse/backend/index_type/documents.rb
@@ -183,7 +185,6 @@ files:
 - lib/esse/primitives.rb
 - lib/esse/primitives/hstring.rb
 - lib/esse/template_loader.rb
-- lib/esse/types/mapping.rb
 - lib/esse/version.rb
 homepage: https://github.com/marcosgz/esse
 licenses: