realm-elasticsearch 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0bdbf9e0dd47a5bf591f0336e92461449ee4e10e460a277a114f1dd457eb77c5
+  data.tar.gz: b2c421396d4408724ae61918b62521cb6c1bf320450b246d9cd58f10bf321edd
+SHA512:
+  metadata.gz: 2cf0977b9f7a3962519ded00de041b7e0b8e3c9f54259a6907130bfed7ae3cfc1a825e92137477ccddf45dbbb690de8bbc291b5e4184ff5b5c7adb60cb1b250b
+  data.tar.gz: b7dcccfcbe26ce6cb68dee2176fd3489a05a2626ad8e77d1426a3d54879152d0329abe52f8b2128d1b17a5a51d608f0dab26665553c3427ff4ed69024ab9ad8c

data/lib/realm-elasticsearch.rb

@@ -0,0 +1,8 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+Dir[File.join(File.dirname(__FILE__), 'realm', '**', '*.rb')].sort.each do |f|
+  require f
+end
+
+# rubocop:enable Naming/FileName

data/lib/realm/elasticsearch/gateway.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'typhoeus'
+require 'elasticsearch'
+require 'realm/health_status'
+require_relative 'repository'
+
+module Realm
+  module Elasticsearch
+    class Gateway
+      def initialize(url:, **options)
+        @url = url
+        @client_options = options.slice(:adapter, :retry_on_failure, :request_timeout)
+      end
+
+      def health
+        issues = []
+        index_names = Repository.subclasses.map(&:index_name)
+        begin
+          issues << 'One or more indexes missing' unless client.indices.exists(index: index_names)
+        rescue StandardError => e
+          issues << "Elasticsearch connection error: #{e.full_message}"
+        end
+        HealthStatus.from_issues(issues)
+      end
+
+      def method_missing(...)
+        client.send(...)
+      end
+
+      def respond_to_missing?(...)
+        client.respond_to?(...)
+      end
+
+      private
+
+      def client
+        @client ||= ::Elasticsearch::Client.new(default_config.merge(@client_options))
+      end
+
+      def default_config
+        {
+          url: @url,
+          adapter: :typhoeus,
+          retry_on_failure: 3,
+          request_timeout: 30,
+        }
+      end
+    end
+  end
+end

data/lib/realm/elasticsearch/plugin.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'realm/plugin'
+require_relative 'gateway'
+
+module Realm
+  module Elasticsearch
+    class Plugin < Realm::Plugin
+      def self.setup(config, container)
+        return unless config.persistence_gateway[:type] == :elasticsearch
+
+        container.register_factory(Gateway, **config.persistence_gateway, as: 'persistence.gateway')
+      end
+    end
+  end
+end

data/lib/realm/elasticsearch/rake_tasks.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Realm
+  module Elasticsearch
+    module RakeTasks
+      class << self
+        def setup(engine_name, engine_root: nil, url: ENV['ELASTICSEARCH_URL'])
+          return unless url
+
+          client = ::Elasticsearch::Client.new(url: url)
+
+          Rake.application.in_namespace(:es) do
+            Rake::Task.define_task(:create_indexes) do
+              with_definitions(engine_name, engine_root) do |index, config|
+                client.indices.create(index: index, body: config) unless client.indices.exists(index: index)
+              end
+            end
+
+            Rake::Task.define_task(:drop_indexes) do
+              with_definitions(engine_name, engine_root) do |index, _config|
+                client.indices.delete(index: index) if client.indices.exists(index: index)
+              end
+            end
+          end
+        end
+
+        private
+
+        def with_definitions(engine_name, engine_root)
+          engine_root ||= Rails.root.join('engines', engine_name.to_s)
+          Dir.glob(File.join(engine_root, 'elasticsearch/indexes/*.yaml')).each do |path|
+            yield File.basename(path, '.yaml'), YAML.safe_load(File.read(path))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/realm/elasticsearch/repository.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'active_support/core_ext/string'
+
+module Realm
+  module Elasticsearch
+    class Repository
+      def self.repo_name(value = :not_provided)
+        @repo_name = value.to_sym unless value == :not_provided
+        @repo_name = name.demodulize.underscore unless defined?(@repo_name)
+        @repo_name
+      end
+
+      def self.index_name(value = :not_provided)
+        @index_name = value.to_sym unless value == :not_provided
+        @index_name = repo_name.pluralize unless defined?(@index_name)
+        @index_name
+      end
+
+      def initialize(client)
+        @client = client
+      end
+
+      def find(id:)
+        single(client.get(index: index_name, id: id))
+      rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
+        nil
+      end
+
+      def all
+        multiple(raw_search(query: { match_all: {} }))
+      end
+
+      def create(id: nil, **attrs)
+        client.index(index: index_name, type: '_doc', id: id, body: attrs, refresh: refresh?)
+      rescue ::Elasticsearch::Transport::Transport::Errors::Conflict
+        raise Realm::Persistence::Conflict
+      end
+
+      def update(id:, **attrs)
+        raw_update(id, doc: attrs)
+      end
+
+      def upsert(id:, **attrs)
+        raw_update(id, doc: attrs, doc_as_upsert: true)
+      end
+
+      def delete(id:)
+        client.delete(index: index_name, type: '_doc', id: id, refresh: refresh?)
+        true
+      rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
+        false
+      end
+
+      def search_by(params)
+        multiple(raw_search(query: { bool: { must: match_params(params) } }))
+      end
+
+      def delete_by(params)
+        client.delete_by_query(
+          index: index_name,
+          refresh: refresh?,
+          body: { query: {
+            bool: {
+              must: match_params(params),
+            },
+          } },
+        )
+      end
+
+      def raw_update(id, body = {})
+        client.update(index: index_name, type: '_doc', id: id, body: body, refresh: refresh?)
+      end
+
+      def raw_search(yaml: nil, options: {}, **body)
+        client.search(index: index_name, body: yaml ? YAML.safe_load(yaml) : body, **options)
+      end
+
+      def truncate!
+        client.delete_by_query(
+          index: index_name,
+          body: { query: { match_all: {} } },
+          conflicts: 'proceed',
+          refresh: refresh?,
+        )
+      end
+
+      private
+
+      attr_reader :client
+
+      def refresh?
+        # impacts performance so should be used only in TEST env
+        # TODO: remove dependency on Rails
+        defined?(::Rails) && ::Rails.env.test?
+      end
+
+      def single(result)
+        id = result['_id'].then { |i| i.to_i.positive? ? i.to_i : i }
+        result['_source'].merge(id: id).deep_symbolize_keys
+      end
+
+      def multiple(results)
+        docs = results.dig('hits', 'hits').map { |doc| single(doc) }
+        { docs: docs }
+      end
+
+      def match_params(params)
+        params.map { |(key, value)| { match: { key => value } } }
+      end
+
+      def index_name
+        self.class.index_name
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: realm-elasticsearch
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- developers@reevoo.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.11'
+- !ruby/object:Gem::Dependency
+  name: realm-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/realm-elasticsearch.rb
+- lib/realm/elasticsearch/gateway.rb
+- lib/realm/elasticsearch/plugin.rb
+- lib/realm/elasticsearch/rake_tasks.rb
+- lib/realm/elasticsearch/repository.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Elasticsearch plugin for Realm
+test_files: []