es_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 843f33d86423abe66668f3a433877678d0e82435
+  data.tar.gz: 785f403f7aae35ac33896e67b82b03e809d36c05
+SHA512:
+  metadata.gz: 647d9d56a31b29d570fc2e0cf175a2a717aa0e055acaf2ecb6ad84414d5b16761eac264a4de07f33d86e5ff1248dc30112f95552964dbdf499cf314615b95cfb
+  data.tar.gz: 6943f76a4645317c49c196ab678a1ee108089516f9a73cc3850b98ad161d261387479e5a37e131357752cb55e747c0645fda60aa842526c6d3494a85195479d5

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version
+/etc
+/log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in es_client.gemspec
+gemspec
+
+gem 'byebug'
+gem 'guard-rspec', require: false
+gem 'growl'

data/Guardfile

@@ -0,0 +1,48 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  watch(%r{^lib/(.+)\.rb$}) { |m| ["spec/#{m[1]}_spec.rb", "spec/integration/#{m[1]}_spec.rb"] }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alex Leschenko
+
+MIT License
+
+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,99 @@
+# EsClient
+
+This elasticsearch client is just all you need to index and search your data with persistent http connection.
+It don't tend to wrap [elasticsearch](http://elasticsearch.org) dsl into ruby style dsl.
+[Excon](https://github.com/excon/excon) used for http staff.
+There is adapter for ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'es_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install es_client
+
+## Usage
+
+Create index:
+```ruby
+index = EsClient::Index.new('products', mappings: {product: {properties: {sku: {type: 'string'}}}}, settings: {number_of_shards: 1})
+index.create
+```
+
+Add document to index:
+```ruby
+index.save_document('product', 1, {id: 1, name: 'Table', sku: '123'})
+```
+
+Fetch document:
+```ruby
+index.find('product', 1)
+```
+
+Add few document with one query i.e. bulk index:
+```ruby
+index.bulk(:index, 'product', [{id: 2, name: 'Chair'}, {id: 2, name: 'Lamp'}])
+```
+
+And, of course, search:
+```ruby
+index.search(query: {query_string: {query: 'table OR chair'}}).decoded
+```
+
+## With ActiveRecord model:
+
+Include EsClient modules:
+```ruby
+class User
+  include ::EsClient::ActiveRecord::Glue
+  include ::EsClient::ActiveRecord::Shortcuts
+end
+```
+
+Create index:
+```ruby
+User.es_client.index.create
+```
+
+Indexing performed on `save` and `destroy` callbacks:
+```ruby
+user = User.create(name: 'alex')
+```
+
+Fetch record elasticsearch document:
+```ruby
+user.es_doc
+```
+
+Search:
+```ruby
+User.es_client.search(query: {query_string: {query: 'table OR chair'}})
+```
+
+Reindex all your data:
+```ruby
+User.es_client_reindex
+```
+
+Or with progressbar (requires `ruby-progressbar` gem):
+```ruby
+User.es_client_reindex_with_progress
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/es_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/ROADMAP.md

@@ -0,0 +1,9 @@
+- [x] HTTP transport
+- [x] Logger
+- [x] Index
+- [x] Importing
+- [x] Search
+- [x] ActiveRecord adapter
+- [ ] TireAdapter
+  - [ ] settings
+  - [ ] mapping

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/es_client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'es_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'es_client'
+  spec.version       = EsClient::VERSION
+  spec.authors       = ['Alex Leschenko']
+  spec.email         = ['leschenko.al@gmail.com']
+  spec.summary       = 'Simple and robust elasticsearch client'
+  spec.description   = 'This elasticsearch client is just all you need to search and index your data with persistent http connection'
+  spec.homepage      = 'https://github.com/leschenko/es_client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'activemodel'
+  spec.add_development_dependency 'ruby-progressbar'
+
+  spec.add_dependency 'excon'
+  spec.add_dependency 'activesupport'
+end

data/lib/es_client.rb

@@ -0,0 +1,45 @@
+require 'es_client/version'
+require 'excon'
+require 'active_support/all'
+
+module EsClient
+  autoload :Client, 'es_client/client'
+  autoload :Response, 'es_client/response'
+  autoload :Logger, 'es_client/logger'
+  autoload :Index, 'es_client/index'
+
+  module ActiveRecord
+    autoload :Adapter, 'es_client/active_record/adapter'
+    autoload :Glue, 'es_client/active_record/glue'
+    autoload :Shortcuts, 'es_client/active_record/shortcuts'
+  end
+
+  mattr_accessor :callbacks_enabled, :logger, :logger_options, :host, :http_client_options, :index_prefix
+
+  @@host = 'http://localhost:9200'
+  @@http_client_options = {persistent: true}
+  @@logger_options = {log_binary: true, log_response: true, pretty: true}
+  @@callbacks_enabled = true
+
+  def self.log_path=(path)
+    self.logger = ::EsClient::Logger.new(path, logger_options)
+  end
+
+  def self.client
+    @client ||= ::EsClient::Client.new(host, http_client_options)
+  end
+
+  def self.with_log_level(level)
+    old_level = logger.level
+    begin
+      self.logger.level = level.is_a?(Integer) ? level : logger.class.const_get(level.to_s.upcase)
+      yield
+    ensure
+      self.logger.level = old_level
+    end
+  end
+
+  def self.setup
+    yield self
+  end
+end

data/lib/es_client/active_record/adapter.rb

@@ -0,0 +1,81 @@
+module EsClient
+  module ActiveRecord
+    class Adapter
+      attr_reader :index, :index_name, :document_type, :mapping, :settings
+
+      def initialize(model)
+        @model = model
+      end
+
+      def index
+        @index ||= ::EsClient::Index.new(index_name)
+      end
+
+      def index_name(value=nil)
+        if value
+          @index_name = value
+        else
+          @index_name || @model.model_name.plural
+        end
+      end
+
+      def document_type(value=nil)
+        if value
+          @document_type = value
+        else
+          @document_type || @model.model_name.singular
+        end
+      end
+
+      def mapping(value=nil)
+        if value
+          @index.options[:mappings] ||= {}
+          @index.options[:mappings].deep_merge!(value)
+        else
+          index.get_mapping
+        end
+      end
+
+      def settings(value=nil)
+        if value
+          @index.options[:settings] ||= {}
+          @index.options[:settings].deep_merge!(value)
+        else
+          index.get_settings
+        end
+      end
+
+      def save_document(record)
+        index.save_document(document_type, record.id, record.as_indexed_json)
+      end
+
+      def update_document(record, additional_doc=nil)
+        doc = record.changes.map { |k, v| [k, v.last] }.to_h
+        doc.deep_merge!(additional_doc) if additional_doc
+        index.update_document(document_type, record.id, doc)
+      end
+
+      def destroy_document(id)
+        index.destroy_document(document_type, id)
+      end
+
+      def find(id)
+        if id.is_a?(Array)
+          query = {query: {ids: {values: id, type: document_type}}, size: id.length}
+          index.search(query, type: document_type)
+        else
+          index.find(document_type, id)
+        end
+      end
+
+      def import(records)
+        index.bulk :index, document_type, records.map(&:as_indexed_json)
+      end
+
+      def search(query, options={})
+        options[:type] = document_type
+        index.search(query, options)
+      end
+    end
+  end
+end

data/lib/es_client/active_record/glue.rb

@@ -0,0 +1,72 @@
+module EsClient
+  module ActiveRecord
+    module Glue
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :es_client
+        self.es_client = ::EsClient::ActiveRecord::Adapter.new(self)
+        after_save :es_client_save, if: :es_client_callbacks_enabled?
+        after_destroy :es_client_destroy, if: :es_client_callbacks_enabled?
+      end
+
+      def es_client_save
+        es_client.save_document(self)
+      end
+
+      def es_client_update(additional_doc=nil)
+        return if new_record?
+        es_client.update_document(self, additional_doc)
+      end
+
+      def es_client_destroy
+        return if new_record?
+        es_client.destroy_document(id)
+      end
+
+      def es_client_document(force=false)
+        return @es_client_document if !force && defined?(@es_client_document)
+        @es_client_document = es_client.find(id)
+      end
+
+      def es_client_callbacks_enabled?
+        EsClient.callbacks_enabled
+      end
+
+      def as_indexed_json
+        as_json
+      end
+
+      module ClassMethods
+        def es_client_reindex(options={})
+          find_in_batches(options) do |batch|
+            es_client.import(batch)
+          end
+        end
+
+        def es_client_reindex_with_progress(options={})
+          find_in_batches_with_progress(options) do |batch|
+            es_client.import(batch)
+          end
+        end
+
+        def find_in_batches_with_progress(options = {})
+          unless defined? ProgressBar
+            warn "Install 'ruby-progressbar' gem to use '#{__method__}' method"
+            return
+          end
+          options[:batch_size] ||= 1000
+          total = (count / options[:batch_size].to_f).ceil
+          title = options.delete(:name) || "#{name} batch_size:#{options[:batch_size]}"
+          bar = ProgressBar.create(title: title, total: total, format: '%c of %C - %a %e |%b>>%i| %p%% %t')
+          bar.progress_mark = '='
+          find_in_batches(options) do |r|
+            yield r
+            bar.increment
+          end
+          bar.finish
+        end unless respond_to?(:find_in_batches_with_progress)
+      end
+    end
+  end
+end