elasticsearch_hermes 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f59f38fcf425e8d7895b3b44a32ed4013d9c552
-  data.tar.gz: 0a42e7b1b434136d7c7c3372ffe6e3c720a15b52
+  metadata.gz: 81930c441e75a5180feaf4c83e2bfd2c56c5b4ca
+  data.tar.gz: 68a12ce9d23fd52993aaa17107c7e0203c069a10
 SHA512:
-  metadata.gz: 27c21a254b77f5c5468dc91a33a696c509103cf9f2a5db00a4ddd4508d36b3b878000eeee216b6081ee9e493ef8f44f2bc462ca2834a43e04c729ffc0e6f97c9
-  data.tar.gz: 78746eadc2492afff69a76d007facc4e4188ed578f702ad4ae3d574424e9161dbb28701b65f3f890f996dd37836f307d838e62ad94f744cc72ffab28b84718af
+  metadata.gz: b849aaf675784c2c9ea8c45add69a5d8d2a1ecb766b7b48e4587a98c4740533069623d1bd0142b303a5e37b3b2004d1587e93f0d1303a9a9aaaea321b4771d92
+  data.tar.gz: 6ff1279329c4e213b7e660e9c4b4960a0a3e9425ca76774152fa2906cc49d33b39903924cd09681b10e47df179029d117ca204c0467dc7215937f4b75a163486

data/lib/elasticsearch_hermes.rb

@@ -1,39 +1,13 @@
 # frozen_string_literal: true
 
-require 'elasticsearch'
-require 'elasticsearch_hermes/configuration'
 require 'elasticsearch_hermes/version'
+require 'elasticsearch_hermes/railtie'
+require 'elasticsearch_hermes/errors'
+require 'elasticsearch_hermes/configuration'
 require 'elasticsearch_hermes/index'
-
-module ElasticsearchHermes
-  class << self
-    attr_writer :configuration
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.reset
-    @configuration = Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-  def self.default_connect_options
-    base_es_urls = configuration.elasticsearch_url
-    urls = base_es_urls.split(',').compact.uniq
-    options = { url: urls, retry_on_failure: 2, log: true }
-    options
-  end
-
-  def self.client
-    @client ||= ::Elasticsearch::Client.new(default_connect_options)
-  end
-
-  def self.refresh
-    client.indices.refresh
-  end
-end
+require 'elasticsearch_hermes/indexing'
+require 'elasticsearch_hermes/query'
+require 'elasticsearch_hermes/result/base'
+require 'elasticsearch_hermes/hook'
+require 'elasticsearch_hermes/logger'
+require 'elasticsearch_hermes/elasticsearch_hermes'

data/lib/elasticsearch_hermes/configuration.rb

@@ -2,15 +2,16 @@
 
 module ElasticsearchHermes
   class Configuration
-    attr_accessor :request_timeout, :retry_on_failure, :elasticsearch_user, :elasticsearch_password, :elasticsearch_url, :is_protected
-
+    attr_accessor :request_timeout, :retry_on_failure, :es_user, :es_password
+    attr_accessor :es_url, :enable_logs, :fields
     def initialize
       @request_timeout = nil
       @retry_on_failure = nil
-      @elasticsearch_user = nil
-      @elasticsearch_password = nil
-      @elasticsearch_url = nil
-      @is_protected = nil
+      @es_user = nil
+      @es_password = nil
+      @es_url = nil
+      @enable_logs = nil
+      @fields = nil
     end
   end
 end

data/lib/elasticsearch_hermes/elasticsearch_hermes.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'elasticsearch'
+
+module ElasticsearchHermes
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.setup
+    yield(configuration)
+  end
+
+  def self.default_connect_options
+    base_es_urls = configuration.es_url
+    urls = base_es_urls.split(',').compact.uniq
+    options = { url: urls, retry_on_failure: 2, log: true }
+    options
+  end
+
+  def self.client
+    @client ||= ::Elasticsearch::Client.new(default_connect_options)
+  end
+
+  def self.fields
+    configuration.fields
+  end
+
+
+  def self.connect!
+    return unless client
+
+
+    indices = fields.map { |field| field[:index_name] }.uniq
+
+    indices.each do |index|
+      Logger.log("Checking index #{index}")
+      index_s = ElasticsearchHermes::Index.new(index)
+      index_s.create unless index_s.exist?
+    end
+
+    info = @client.info
+    cluster_version = info['version']['number']
+    msg = "Connected to Elastic version #{cluster_version}."
+    Logger.log(msg)
+  end
+
+  def self.refresh
+    client.indices.refresh
+  end
+end

data/lib/elasticsearch_hermes/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ElasticsearchHermes
+  class HermesErrors < StandardError
+  end
+end

data/lib/elasticsearch_hermes/hook.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ElasticsearchHermes
+  module Hook
+  end
+end

data/lib/elasticsearch_hermes/index.rb

@@ -9,7 +9,89 @@ module ElasticsearchHermes
     end
 
     def create
-      client.indices.create index: name, body: {}
+      ElasticsearchHermes.client.indices.create index: @name, body: index_options
+    end
+
+    def exist?
+      ElasticsearchHermes.client.indices.exists? index: @name
+    end
+
+    def fields
+      ElasticsearchHermes.fields || []
+    end
+
+    def build_field_mappings
+      fields_to_index = fields.select { |field| field[:index_name] == @name }
+      properties = {}
+      analyzer = {}
+      tokenizer = {}
+      fields_to_index.each do |field|
+        # add checks for full_match
+        if field[:search_type] == :partial_match
+          @field_token = ngram_builder(field[:minimum_match], field[:field_name])
+          @field_analyzer = analyzer_builder(field[:field_name], 'custom', "#{field[:field_name]}_tokens", 'lowercase')
+        end
+
+        prop = {
+          "#{field[:field_name]}": {
+            type: field[:field_type],
+            analyzer: "#{field[:field_name]}_analyzer"
+          }
+        }
+
+        analyzer = analyzer.merge(@field_analyzer || {})
+        tokenizer = tokenizer.merge(@field_token || {})
+        properties = properties.merge(prop || {})
+      end
+
+      { properties: properties, analyzer: analyzer, tokenizer: tokenizer }
+    end
+
+    def index_options
+      field_mappings = build_field_mappings
+      {
+        settings: {
+          analysis: {
+            analyzer: field_mappings[:analyzer],
+            tokenizer: field_mappings[:tokenizer]
+          }
+        },
+        mappings: {
+          properties: field_mappings[:properties]
+        }
+      }
+    end
+
+    def field_mappings_builder(field_name, field_type, type_analyzer)
+      {
+        "#{field_name}": {
+          type: field_type,
+          analyzer: type_analyzer
+        }
+      }
+    end
+
+    def analyzer_builder(analyzer_name, analyzer_type, tokenizer, filter)
+      {
+        "#{analyzer_name}_analyzer": {
+          type: analyzer_type,
+          tokenizer: tokenizer,
+          filter: filter
+        }
+      }
+    end
+
+    def ngram_builder(number, field_name)
+      {
+        "#{field_name}_tokens": {
+          type: 'ngram',
+          min_gram: number,
+          max_gram: number,
+          token_chars: [
+            'letter'
+          ]
+        }
+      }
     end
   end
 end

data/lib/elasticsearch_hermes/indexing.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ElasticsearchHermes
+  module Indexing
+    def elastic_update(type: '_doc', index_name: self.class.to_s.underscore, id:, body:)
+      ElasticsearchHermes.client.index index_payload(
+        index_name: index_name,
+        type: type,
+        body: body,
+        id: id
+      )
+    end
+
+    def index_payload(index_name:, type:, id:, body:)
+      {
+        type: type,
+        index: index_name,
+        id: id,
+        body: body
+      }
+    end
+  end
+end

data/lib/elasticsearch_hermes/logger.rb

@@ -0,0 +1,7 @@
+module ElasticsearchHermes
+  class Logger
+    def self.log(msg)
+      Rails.logger.info(msg) && (Rails.env.development? && puts(msg))
+    end
+  end
+end

data/lib/elasticsearch_hermes/query.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ElasticsearchHermes
+  module Query
+    def search(query: '', index_name: to_s.underscore, fields: @hermes_search_on)
+      @results = ElasticsearchHermes.client.search query_payload(
+        query: query,
+        index_name: index_name,
+        fields: fields
+      )
+      ElasticsearchHermes::Result::Base.new(@results.symbolize_keys)
+    end
+
+    def hermes_search_on(fields: [])
+      @hermes_search_on ||= fields.map(&:to_s)
+    end
+
+    def search_type; end
+
+    def field_type; end
+
+    def minimum_match; end
+
+    def query_payload(query:, index_name:, fields:)
+      {
+        index: index_name,
+        body: {
+          query: {
+            multi_match: {
+              query: query,
+              fields: fields
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/lib/elasticsearch_hermes/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ElasticsearchHermes
+  class Railtie < Rails::Railtie
+    # Connect to Elasticsearch on server boot
+    config.to_prepare do
+      ElasticsearchHermes.connect!
+    end
+  end
+end

data/lib/elasticsearch_hermes/result/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ElasticsearchHermes
+  module Result
+    class Base
+      attr_reader :took, :timed_out, :shards, :hits
+
+      def initialize(took:, timed_out:, hits:, _shards:)
+        @took = took
+        @timed_out = timed_out
+        @shards = _shards
+        @hits = hits
+      end
+
+      def ids
+        @ids ||= @hits['hits'].map { |hit| hit['_id'] }
+      end
+
+      def models
+        @models ||= ''
+      end
+    end
+  end
+end

data/lib/elasticsearch_hermes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticsearchHermes
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_hermes
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Ronald Ekambi
@@ -9,7 +9,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-12-01 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.4.0
 description: 
 email: ronekambi@gmail.com
 executables: []
@@ -18,7 +38,16 @@ extra_rdoc_files: []
 files:
 - lib/elasticsearch_hermes.rb
 - lib/elasticsearch_hermes/configuration.rb
+- lib/elasticsearch_hermes/elasticsearch_hermes.rb
+- lib/elasticsearch_hermes/errors.rb
+- lib/elasticsearch_hermes/hook.rb
 - lib/elasticsearch_hermes/index.rb
+- lib/elasticsearch_hermes/indexing.rb
+- lib/elasticsearch_hermes/logger.rb
+- lib/elasticsearch_hermes/query.rb
+- lib/elasticsearch_hermes/railtie.rb
+- lib/elasticsearch_hermes/result/base.rb
+- lib/elasticsearch_hermes/result/hit.rb
 - lib/elasticsearch_hermes/version.rb
 homepage: https://github.com/roncodingenthusiast/elasticsearch_hermes
 licenses:
@@ -43,5 +72,5 @@ rubyforge_project:
 rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
-summary: elasticsearch_hermes is a layer on top of elasticsearch to handle searching
+summary: I will fix this eventually
 test_files: []