elastic_search_framework 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb31cdcff7f6e3f40501c7dcadba923be7582ff8d91daec8e52d7dd8689e8da
-  data.tar.gz: b5c57937085a1719aae84d24fb10a93fbb582ec12ebe6f6b8c15f3aa987c053e
+  metadata.gz: fcc1601dc419b4ad4233065024791ad1199077c2622d243ef4192780eefae4aa
+  data.tar.gz: a66d974b4015cfc9fe4c16022ff5123aceaa147ecda5288b865d8ba7cdab3d88
 SHA512:
-  metadata.gz: 214b8d927d48733fc52a98c7667621529efb9d68e331d8f4b3e4e70c76a2b72fd2e5d56f749cd5d0b2a6002316fd56bc77d9b68bf8091fe0402ea7c7f994db61
-  data.tar.gz: 8151848be2786d442eea281aa10e89338d06109b20bde72de2df87fd2f0b31a8a2279a9d560a035f66af92333657890cd5a34ed22dbb828a25e9d3003886d459
+  metadata.gz: 235055cf6c16281b2f1f6ded4b71f37e1c72e6e6a1de0f820c186b86ae72c2d6885aee4bd4ddbb1e36e5648f834698f0e4c2e6869f693230794838066b49274a
+  data.tar.gz: 7df89d3968eb81751e8ee316c9a321da04b2b891130fcbef78fe24b4a3e7d5c8b29350abb56dc7f9f95fa1636510268b774231cd5d8c8c878d4c0ea3c622d6ef

data/lib/elastic_search_framework.rb

@@ -8,6 +8,7 @@ require_relative 'elastic_search_framework/logger'
 require_relative 'elastic_search_framework/exceptions'
 require_relative 'elastic_search_framework/repository'
 require_relative 'elastic_search_framework/index'
+require_relative 'elastic_search_framework/index_alias'
 require_relative 'elastic_search_framework/query'
 
 module ElasticSearchFramework

data/lib/elastic_search_framework/index.rb

@@ -2,14 +2,19 @@ module ElasticSearchFramework
   module Index
     attr_accessor :index_settings
 
-    def index(name:)
+    def index(name:, version: nil)
       unless instance_variable_defined?(:@elastic_search_index_def)
-        instance_variable_set(:@elastic_search_index_def, name: "#{name}")
+        instance_variable_set(:@elastic_search_index_def, name: "#{name}#{version}")
+        instance_variable_set(:@elastic_search_index_version, version: version) unless version.nil?
       else
         raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self.class}] - Duplicate index description. Name: #{name}.")
       end
     end
 
+    def version
+      instance_variable_defined?(:@elastic_search_index_version) ? instance_variable_get(:@elastic_search_index_version) : 0
+    end
+
     def id(field)
       unless instance_variable_defined?(:@elastic_search_index_id)
         instance_variable_set(:@elastic_search_index_id, field)
@@ -160,7 +165,7 @@ module ElasticSearchFramework
     end
 
     def repository
-      ElasticSearchFramework::Repository.new
+      @repository ||= ElasticSearchFramework::Repository.new
     end
 
     def get_item(id:, type: 'default')

data/lib/elastic_search_framework/index_alias.rb

@@ -0,0 +1,146 @@
+module ElasticSearchFramework
+  module IndexAlias
+    def index(klass, active:)
+      unless instance_variable_defined?(:@elastic_search_indexes)
+        instance_variable_set(:@elastic_search_indexes, [])
+      end
+      indexes = self.instance_variable_get(:@elastic_search_indexes)
+      indexes << {klass: klass, active: active}
+      instance_variable_set(:@elastic_search_indexes, indexes)
+    end
+
+    def indexes
+      self.instance_variable_get(:@elastic_search_indexes)
+    end
+
+    def name(name)
+      unless instance_variable_defined?(:@elastic_search_index_alias_name)
+        instance_variable_set(:@elastic_search_index_alias_name, "#{name}")
+      else
+        raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self.class}] - Duplicate index alias name: #{name}.")
+      end
+    end
+
+    def valid?
+      indexes.select { |i| i[:active] == true }.length == 1
+    end
+
+    def create
+      if !valid?
+        raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self.class}] - Invalid Index alias.")
+      end
+
+      uri = URI("#{host}/_aliases")
+
+      payload = {
+        actions: [],
+      }
+
+      indexes.each do |index|
+        action = nil
+        if exists?(index: index[:klass])
+          action = "remove" if !index[:active]
+        else
+          action = "add" if index[:active]
+        end
+        next if action.nil?
+
+        payload[:actions] << {action => {index: index[:klass].full_name, alias: self.full_name}}
+      end
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = JSON.dump(payload)
+      request.content_type = "application/json"
+
+      response = repository.with_client do |client|
+        client.request(request)
+      end
+
+      is_valid_response?(response.code) || Integer(response.code) == 404
+    end
+
+    def delete
+      uri = URI("#{host}/_all/_aliases/#{full_name}")
+
+      request = Net::HTTP::Delete.new(uri.request_uri)
+
+      response = repository.with_client do |client|
+        client.request(request)
+      end
+
+      is_valid_response?(response.code) || Integer(response.code) == 404
+    end
+
+    def exists?(index:)
+      uri = URI("#{host}/#{index.full_name}/_alias/#{full_name}")
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+
+      response = repository.with_client do |client|
+        client.request(request)
+      end
+
+      return false if response.code == "404"
+
+      result = nil
+      if is_valid_response?(response.code)
+        result = JSON.parse(response.body)
+      end
+
+      return true if !result.nil? && result[index.full_name]["aliases"] != nil
+      return false
+    end
+
+    def is_valid_response?(code)
+      [200, 201, 202].include?(Integer(code))
+    end
+
+    def full_name
+      name = instance_variable_get(:@elastic_search_index_alias_name)
+      if ElasticSearchFramework.namespace != nil
+        "#{ElasticSearchFramework.namespace}#{ElasticSearchFramework.namespace_delimiter}#{name.downcase}"
+      else
+        name.downcase
+      end
+    end
+
+    def description
+      index = indexes.last[:klass]
+      hash = index.instance_variable_get(:@elastic_search_index_def)
+      if index.instance_variable_defined?(:@elastic_search_index_id)
+        hash[:id] = index.instance_variable_get(:@elastic_search_index_id)
+      else
+        hash[:id] = :id
+      end
+      hash
+    end
+
+    def host
+      "#{ElasticSearchFramework.host}:#{ElasticSearchFramework.port}"
+    end
+
+    def repository
+      @repository ||= ElasticSearchFramework::Repository.new
+    end
+
+    def get_item(id:, type: "default")
+      repository.get(index: self, id: id, type: type)
+    end
+
+    def put_item(type: "default", item:)
+      indexes.each do |index|
+        repository.set(entity: item, index: index[:klass], type: type)
+      end
+    end
+
+    def delete_item(id:, type: "default")
+      indexes.each do |index|
+        repository.drop(index: index[:klass], id: id, type: type)
+      end
+    end
+
+    def query
+      ElasticSearchFramework::Query.new(index: self)
+    end
+  end
+end

data/lib/elastic_search_framework/version.rb

@@ -1,3 +1,3 @@
 module ElasticSearchFramework
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/spec/elastic_search_framework/index_alias_spec.rb

@@ -0,0 +1,144 @@
+RSpec.describe ElasticSearchFramework::Index do
+  describe '#full_name' do
+    let(:namespace) { 'uat' }
+    let(:namespace_delimiter) { '.' }
+    before do
+      ElasticSearchFramework.namespace = namespace
+      ElasticSearchFramework.namespace_delimiter = namespace_delimiter
+    end
+    it 'should return the full index name including namespace and delimiter' do
+      expect(ExampleIndexAlias.full_name).to eq "#{ElasticSearchFramework.namespace}#{ElasticSearchFramework.namespace_delimiter}example"
+    end
+
+    context 'when the namespace is nil' do
+      before { ElasticSearchFramework.namespace = nil }
+
+      it 'returns the description name downcased' do
+        expect(ExampleIndexAlias.full_name).to eq 'example'
+      end
+    end
+  end
+
+  describe '#valid?' do
+    context 'for a valid index definition' do
+      it 'should return true' do
+        expect(ExampleIndexAlias.valid?).to be true
+      end
+    end
+    context 'for an invalid index definition' do
+      it 'should return true' do
+        expect(InvalidIndexAlias.valid?).to be false
+      end
+    end
+  end
+
+  describe '#create' do
+    context 'when alias is valid and does not exist' do
+      before do
+        ExampleIndexAlias.delete
+        ExampleIndex.delete if ExampleIndex.exists?
+        ExampleIndex.create
+      end
+
+      it 'creates an alias for the active index' do
+        expect(ExampleIndexAlias.exists?(index: ExampleIndex)).to be false
+        ExampleIndexAlias.create
+        expect(ExampleIndexAlias.exists?(index: ExampleIndex)).to be true
+      end
+
+      after do
+        ExampleIndexAlias.delete
+        ExampleIndex.delete
+      end
+    end
+
+    context 'when alias is not valid' do
+      before { allow(ExampleIndexAlias).to receive(:valid?).and_return(false) }
+
+      it 'raises an error' do
+        expect(ExampleIndexAlias.exists?(index: ExampleIndex)).to be false
+        expect { ExampleIndexAlias.create }.to raise_error(
+          ElasticSearchFramework::Exceptions::IndexError
+        )
+      end
+    end
+
+    context 'when alias is valid but already exists' do
+      before do
+        ExampleIndex.delete if ExampleIndex.exists?
+        ExampleIndex.create
+        ExampleIndexAlias.create
+      end
+
+      it 'does not try to create a new alias' do
+        ExampleIndexAlias.create
+      end
+
+      after do
+        ExampleIndexAlias.delete
+        ExampleIndex.delete
+      end
+    end
+
+    context 'when alias is valid and does not exist and requires updating' do
+      before do
+        ExampleIndexAlias.delete
+        ExampleIndex.delete if ExampleIndex.exists?
+        ExampleIndex2.delete if ExampleIndex2.exists?
+        ExampleIndex.create
+        ExampleIndex2.create
+        ExampleIndexAlias.create
+      end
+
+      it 'modifies the alias to the active index' do
+        expect(ExampleIndexAlias.exists?(index: ExampleIndex)).to be true
+        ExampleIndexAlias2.create
+        expect(ExampleIndexAlias.exists?(index: ExampleIndex)).to be false
+        expect(ExampleIndexAlias2.exists?(index: ExampleIndex2)).to be true
+      end
+
+      after do
+        ExampleIndexAlias.delete
+        ExampleIndex.delete
+        ExampleIndex2.delete
+      end
+    end
+  end
+
+  describe '#get_item' do
+    let(:id) { 10 }
+    let(:type) { 'default' }
+    it 'should call get on the repository' do
+      expect(ExampleIndexAlias.repository).to receive(:get).with(index: ExampleIndexAlias, id: id, type: type).once
+      ExampleIndexAlias.get_item(id: id, type: type)
+    end
+  end
+
+  describe '#put_item' do
+    let(:id) { 10 }
+    let(:type) { 'default' }
+    let(:item) do
+      TestItem.new.tap do |i|
+        i.id = id
+        i.name = 'abc'
+        i.timestamp = Time.now.to_i
+        i.number = 5
+      end
+    end
+    it 'should call set on the repository for each index of the alias' do
+      expect(ExampleIndexAlias.repository).to receive(:set).with(entity: item, index: ExampleIndex, type: type).once
+      expect(ExampleIndexAlias.repository).to receive(:set).with(entity: item, index: ExampleIndex2, type: type).once
+      ExampleIndexAlias.put_item(type: type, item: item)
+    end
+  end
+
+  describe '#delete_item' do
+    let(:id) { 10 }
+    let(:type) { 'default' }
+    it 'should call drop on the repository for each index of the alias' do
+      expect(ExampleIndexAlias.repository).to receive(:drop).with(index: ExampleIndex, id: id, type: type).once
+      expect(ExampleIndexAlias.repository).to receive(:drop).with(index: ExampleIndex2, id: id, type: type).once
+      ExampleIndexAlias.delete_item(id: id, type: type)
+    end
+  end
+end

data/spec/elastic_search_framework/index_spec.rb

@@ -83,13 +83,13 @@ RSpec.describe ElasticSearchFramework::Index do
               'type' => 'custom'
             }
           },
-          'analyzer'=>{
-              'custom_analyzer'=>{
-                'filter'=>['lowercase'],
-                'type'=>'custom',
-                'tokenizer'=>'standard'
-              }
+          'analyzer' => {
+            'custom_analyzer' => {
+              'filter' => ['lowercase'],
+              'type' => 'custom',
+              'tokenizer' => 'standard'
             }
+          }
         }
       end
 
@@ -276,8 +276,8 @@ RSpec.describe ElasticSearchFramework::Index do
     it 'should return a ElasticSearchFramework::Repository instance' do
       expect(ExampleIndex.repository).to be_a(ElasticSearchFramework::Repository)
     end
-    it 'should return a unique ElasticSearchFramework::Repository instance' do
-      expect(ExampleIndex.repository).not_to eq ExampleIndex.repository
+    it 'should return the same ElasticSearchFramework::Repository instance for multiple calls' do
+      expect(ExampleIndex.repository).to eq ExampleIndex.repository
     end
   end
 

data/spec/example_index_2.rb

@@ -0,0 +1,31 @@
+class ExampleIndex2
+  extend ElasticSearchFramework::Index
+
+  index name: 'example_index', version: 2
+
+  mapping name: 'default', field: :name, type: :keyword, index: true
+end
+
+class ExampleIndexWithId2
+  extend ElasticSearchFramework::Index
+
+  index name: 'example_index', version: 2
+
+  id :number
+
+  mapping name: 'default', field: :name, type: :keyword, index: true
+end
+
+class ExampleIndexWithSettings2
+  extend ElasticSearchFramework::Index
+
+  index name: 'example_index', version: 2
+
+  normalizer_value = { custom_normalizer: { type: 'custom', char_filter: [], filter: ['lowercase'] } }
+  analyzer_value = { custom_analyzer: { type: 'custom', tokenizer: 'standard', filter: %w(lowercase) } }
+
+  settings name: :number_of_shards, value: 1
+  settings name: :analysis, type: :normalizer, value: normalizer_value
+  settings name: :analysis, type: :analyzer, value: analyzer_value
+  mapping name: 'default', field: :name, type: :keyword, index: true
+end

data/spec/example_index_alias.rb

@@ -0,0 +1,17 @@
+class ExampleIndexAlias
+  extend ElasticSearchFramework::IndexAlias
+
+  index ExampleIndex, active: true
+  index ExampleIndex2, active: false
+
+  name :example
+end
+
+class InvalidIndexAlias
+  extend ElasticSearchFramework::IndexAlias
+
+  index ExampleIndex, active: false
+  index ExampleIndex2, active: false
+
+  name :example
+end

data/spec/example_index_alias_2.rb

@@ -0,0 +1,8 @@
+class ExampleIndexAlias2
+  extend ElasticSearchFramework::IndexAlias
+
+  index ExampleIndex, active: false
+  index ExampleIndex2, active: true
+
+  name :example
+end

data/spec/spec_helper.rb

@@ -9,6 +9,9 @@ end
 require 'elastic_search_framework'
 require_relative '../spec/test_item.rb'
 require_relative '../spec/example_index'
+require_relative '../spec/example_index_2'
+require_relative '../spec/example_index_alias'
+require_relative '../spec/example_index_alias_2'
 require 'pry'
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_search_framework
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-17 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,14 +119,19 @@ files:
 - lib/elastic_search_framework/exceptions.rb
 - lib/elastic_search_framework/exceptions/index_error.rb
 - lib/elastic_search_framework/index.rb
+- lib/elastic_search_framework/index_alias.rb
 - lib/elastic_search_framework/logger.rb
 - lib/elastic_search_framework/query.rb
 - lib/elastic_search_framework/repository.rb
 - lib/elastic_search_framework/version.rb
+- spec/elastic_search_framework/index_alias_spec.rb
 - spec/elastic_search_framework/index_spec.rb
 - spec/elastic_search_framework/query_spec.rb
 - spec/elastic_search_framework/repository_spec.rb
 - spec/example_index.rb
+- spec/example_index_2.rb
+- spec/example_index_alias.rb
+- spec/example_index_alias_2.rb
 - spec/spec_helper.rb
 - spec/test_item.rb
 homepage: https://github.com/sage/elastic_search_framework