esse 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f309243fb21b878b0d14b85c16a2d344dd595659d7972cadc7cd40c246ffd9a
+  data.tar.gz: 670f66a022b7fe568fe9f995c0d8cd9832d65da5a9bfb21490a4a7e222540023
+SHA512:
+  metadata.gz: 99b6fa0017361c185cdf71c7505f6a37dcfc28127f04504496dc1fbdddf8b7ca4a2c06e6c2e56dd30464c90f3b2012fc982bcdb3ed5159a1b331bfbe3c2e30d1
+  data.tar.gz: db75895be7643f9bbedb9c81c071b4438e1f277637b2447dd7d8444c719820c41a97bdf69f0230e422a60412b2de93b674d2e459d0a324cb21bd49cbf2763f91

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/.rspec_status
+/tmp/
+esse-*.gem
+/app
+/.env

data/.rubocop.yml

@@ -0,0 +1,128 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'log/**/*'
+    - 'tmp/**/*'
+
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Metrics/ClassLength:
+  Max: 100
+
+Layout/LineLength:
+  Max: 130
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 20
+
+Metrics/ModuleLength:
+  Max: 100
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+      collect: map
+      collect!: map!
+      detect: find
+      find_all: select
+      inject: reduce
+      length: size
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: format
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+Style/WordArray:
+  Enabled: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    esse (0.0.1)
+      elasticsearch
+      multi_json
+      thor (>= 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    elasticsearch (7.6.0)
+      elasticsearch-api (= 7.6.0)
+      elasticsearch-transport (= 7.6.0)
+    elasticsearch-api (7.6.0)
+      multi_json
+    elasticsearch-transport (7.6.0)
+      faraday (~> 1)
+      multi_json
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.9.1)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    pry (0.12.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  dotenv
+  esse!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marcos G. Zimmermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# esse
+
+Simple and efficient way to organize queries/mapping/indices/tasks based on the official elasticsearch-ruby.
+
+## Why to use it?
+Some facts to use this library:
+
+### Don't spend time learning our DLS
+You don't need to spend time learning our DSL or gem usage to start using it. All you need know is the elasticsearch syntax. You are free to build your queries/mappings/settings using JSON/RubyHash flexibility. And keeping simple any elasticsearch upgrade and its syntax changes.
+
+### Multiple ElasticSearch Versions
+You can use multiple elasticsearch servers with different versions in an elegant way. Take a look at [LINK TO TOPIC](#anchors-id-here) for more details.
+
+### It's pure Ruby
+Yeah!! Nor [activesupport](http://github.com/rails/rails/tree/master/activesupport) dependency and all its monkey patchings. But if you are using rails, suggest install `esse-rails` extension that makes things even easier. Use the [Get started with esse-rails](#anchors-id-here) for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esse'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install esse
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcosgz/esse.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dotenv/load'
+require 'esse'
+require 'pry'
+require 'awesome_print'
+
+Esse.config.clusters.client = { url: ENV.fetch('ELASTICSEARCH_URL', 'http://localhost:9200') }
+Esse.config.clusters.index_prefix = 'esse_console'
+
+class ApplicationIndex < Esse::Index
+  self.abstract_class = true
+end
+class GeosIndex < ApplicationIndex
+  self.index_version = 'v1'
+
+  define_type :county
+  define_type :city
+end
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/esse.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/esse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'esse'
+  spec.version       = Esse::VERSION
+  spec.authors       = ['Marcos G. Zimmermann']
+  spec.email         = ['mgzmaster@gmail.com']
+
+  spec.summary       = %[Pure Ruby toolkit based on official elasticsearch-ruby library. (No! It isn't a new DSL)]
+  spec.description   = 'All the elegance of ruby with the elasticsearch flexibility. This gem is a pretty simple ' \
+                       'but excential helpers to deal with mapping, indexing, serialization and search.'
+  spec.homepage      = 'https://github.com/marcosgz/esse'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/marcosgz/esse'
+  spec.metadata['changelog_uri'] = 'https://github.com/marcosgz/esse/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'elasticsearch'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'thor', '>= 0.19'
+  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 'rspec', '~> 3.0'
+end

data/exec/esse

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'esse'
+require 'esse/cli'
+
+Esse::CLI.start(ARGV)

data/lib/esse.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'esse/index'
+
+module Esse
+  class Error < StandardError; end
+end

data/lib/esse/backend/index.rb

@@ -0,0 +1,38 @@
+# 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/documents'
+
+      extend Forwardable
+
+      NAMING = %i[index_name 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 real_index_name(suffix = nil)
+        suffix = Hstring.new(suffix).underscore.presence || index_version || Esse.timestamp
+        [index_name, suffix].compact.join('_')
+      end
+
+      def client
+        @index.cluster.client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Esse
+  module Backend
+    class Index
+      module InstanceMethods
+        # Return a list of index aliases.
+        #
+        # @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)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-aliases.html
+        def aliases(**options)
+          response = client.indices.get_alias({ index: index_name, name: '*' }.merge(options))
+          idx_name = response.keys.find { |idx| idx.start_with?(index_name) }
+          return [] unless idx_name
+
+          response.dig(idx_name, 'aliases')&.keys || []
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          []
+        end
+
+        # Returns a list of indices.
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @return [Array] list of indices that match with `index_name`.
+        def indices(**options)
+          client.indices.get_alias({ name: index_name }.merge(options)).keys
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          []
+        end
+
+        # Replaces all existing aliases by the respective suffixed index from argument.
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @option [String] :suffix The suffix of the index used for versioning.
+        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] in case of failure
+        # @return [Hash] the elasticsearch response
+        def update_aliases!(suffix:, **options)
+          raise(ArgumentError, 'index suffix cannot be nil') if suffix.nil?
+
+          options[:body] = {
+            actions: [
+              *indices.map do |index|
+                { remove: { index: index, alias: index_name } }
+              end,
+              { add: {index: real_index_name(suffix), alias: index_name } }
+            ],
+          }
+          client.indices.update_aliases(options)
+        end
+
+        # Replaces all existing aliases by the respective suffixed index from argument.
+        #
+        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @option [String] :suffix The suffix of the index used for versioning.
+        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] in case of failure
+        # @return [Hash, false] the elasticsearch response, or false in case of failure
+        def update_aliases(suffix:, **options)
+          update_aliases!(suffix: suffix, **options)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          false
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end