es_searchable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb43d18c820180b2f727faa7bd5438b0c700ed47
+  data.tar.gz: b26088eac28c5da9feebe4eeb191a3640720ab44
+SHA512:
+  metadata.gz: 21192fc7a0f1fe59aea51f36d8de27abe14e7c0293105dcfae5933f0398fbbdf2fa676f1d6d53b62a777c7ae4d5131f1fadc3a6ec7d3996b482d636c69d8c646
+  data.tar.gz: 51007ee5bb2508902500d6acc6d938c310920c1ebfe070494098b8ca9297498b3a5b611e5897173a356d95c292f5c0466ec7c48090564ff607e6169d6149b11a

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in es_searchable.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+gem 'ffaker'
+gem 'pry'
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,145 @@
+PATH
+  remote: .
+  specs:
+    es_searchable (0.1.0)
+      bundler (~> 1.6)
+      elasticsearch
+      elasticsearch-model (~> 0.1.8)
+      elasticsearch-rails (~> 0.1.7)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.5.2)
+      actionpack (= 4.2.5.2)
+      actionview (= 4.2.5.2)
+      activejob (= 4.2.5.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5.2)
+      actionview (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.2)
+      activesupport (= 4.2.5.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5.2)
+      activesupport (= 4.2.5.2)
+      globalid (>= 0.3.0)
+    activemodel (4.2.5.2)
+      activesupport (= 4.2.5.2)
+      builder (~> 3.1)
+    activerecord (4.2.5.2)
+      activemodel (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      arel (~> 6.0)
+    activesupport (4.2.5.2)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    coderay (1.1.0)
+    concurrent-ruby (1.0.1)
+    elasticsearch (1.0.14)
+      elasticsearch-api (= 1.0.14)
+      elasticsearch-transport (= 1.0.14)
+    elasticsearch-api (1.0.14)
+      multi_json
+    elasticsearch-model (0.1.8)
+      activesupport (> 3)
+      elasticsearch (> 0.4)
+      hashie
+    elasticsearch-rails (0.1.8)
+    elasticsearch-transport (1.0.14)
+      faraday
+      multi_json
+    erubis (2.7.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffaker (2.2.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    hashie (3.4.3)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mime-types (2.99.1)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.11.2)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.5.2)
+      actionmailer (= 4.2.5.2)
+      actionpack (= 4.2.5.2)
+      actionview (= 4.2.5.2)
+      activejob (= 4.2.5.2)
+      activemodel (= 4.2.5.2)
+      activerecord (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.5.2)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.2)
+      actionpack (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    slop (3.6.0)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.3)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  es_searchable!
+  ffaker
+  mocha
+  pry
+  rails
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 zuozuo
+
+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,281 @@
+# es_searchable 
+es_searchable implemented an ActiveRecord like search api for Elasticsearch. 
+
+## Install 
+
+`gem 'es_searchable', git: 'git@github.com:rongchain/es_searchable.git'`
+
+or
+
+`gem install es_searchable`
+
+And then execute: 
+
+`bundle`
+
+## Configure 
+
+```ruby
+
+# config/initializers/es_searchable.rb
+
+EsSearchable.configure do |config|
+  config.logger = Logger.new("log/es_searchable.log")
+  config.hosts = ["localhost:9200"]
+end
+
+```
+
+## Use es_searchable
+
+```ruby
+class User
+  include EsSearchable
+end
+
+search_collection = User.es_where(id: 1)
+pp search_collection
+=> #<EsSearchable::SearchCollection:0x007fa64361be08
+ @conditions=
+  {:query=>{:filtered=>{:filter=>{:bool=>{:must=>[{:term=>{:id=>1}}]}}}}},
+ @klass=User>
+
+search_collection.class
+ => EsSearchable::SearchCollection
+
+search_params = search_collection.search_params
+ => {:query=>{:filtered=>{:filter=>{:bool=>{:must=>[{:term=>{:id=>1}}]}}}}}
+```
+
+call `load` on `search_collection` to perform the search
+
+```ruby
+search_response = search_collection.load     #perform search
+pp search_response
+=> #<EsSearchable::SearchCollection:0x007fa64288bf18
+ @collections=
+  [{"id"=>1,
+    "name"=>"Arnaldo Powlowski PhD",
+    "email"=>"charley_walsh@weber.co.uk",
+    "created_at"=>"2016-03-04T06:47:58.999Z",
+    "updated_at"=>"2016-03-04T06:47:58.999Z",
+    "is_admin"=>true}],
+ @conditions=
+  {:query=>{:filtered=>{:filter=>{:bool=>{:must=>[{:term=>{:id=>1}}]}}}},
+   :fields=>{}},
+ @count=1,
+ @klass=User,
+ @response=
+  {"took"=>1,
+   "timed_out"=>false,
+   "_shards"=>{"total"=>1, "successful"=>1, "failed"=>0},
+   "hits"=>
+    {"total"=>1,
+     "max_score"=>1.0,
+     "hits"=>
+      [{"_index"=>"users",
+        "_type"=>"user",
+        "_id"=>"1",
+        "_score"=>1.0,
+        "_source"=>
+         {"id"=>1,
+          "name"=>"Arnaldo Powlowski PhD",
+          "email"=>"charley_walsh@weber.co.uk",
+          "created_at"=>"2016-03-04T06:47:58.999Z",
+          "updated_at"=>"2016-03-04T06:47:58.999Z",
+          "is_admin"=>true}}]}},
+ @time=1>
+
+pp search_response.collections     #return search results as an Array of hash
+=> [{"id"=>1,
+  "name"=>"Arnaldo Powlowski PhD",
+  "email"=>"charley_walsh@weber.co.uk",
+  "created_at"=>"2016-03-04T06:47:58.999Z",
+  "updated_at"=>"2016-03-04T06:47:58.999Z",
+  "is_admin"=>true}}]
+
+search_response.time      #time consumed by the search
+ => 1
+
+search_response.count      #count of search results
+ => 1
+
+pp search_response.response       #response hash from elasticsearch
+=> {"took"=>1,
+ "timed_out"=>false,
+ "_shards"=>{"total"=>1, "successful"=>1, "failed"=>0},
+ "hits"=>
+  {"total"=>1,
+   "max_score"=>1.0,
+   "hits"=>
+    [{"_index"=>"users",
+      "_type"=>"user",
+      "_id"=>"1",
+      "_score"=>1.0,
+      "_source"=>
+       {"id"=>1,
+        "name"=>"Arnaldo Powlowski PhD",
+        "email"=>"charley_walsh@weber.co.uk",
+        "created_at"=>"2016-03-04T06:47:58.999Z",
+        "updated_at"=>"2016-03-04T06:47:58.999Z",
+        "is_admin"=>true}}}]}}
+```
+
+### #es_where
+```ruby
+# Like ActiveRecord, es_searchable use es_where for exact matching, 
+pp User.es_where(id: 1).load.collections
+=> [{"id"=>1,
+  "name"=>"Arnaldo Powlowski PhD",
+  "email"=>"charley_walsh@weber.co.uk",
+  "created_at"=>"2016-03-04T06:47:58.999Z",
+  "updated_at"=>"2016-03-04T06:47:58.999Z",
+  "is_admin"=>true}}]
+
+pp User.es_where(id: [1,2]).load.collections
+=> [{"id"=>1,
+  "name"=>"Arnaldo Powlowski PhD",
+  "email"=>"charley_walsh@weber.co.uk",
+  "created_at"=>"2016-03-04T06:47:58.999Z",
+  "updated_at"=>"2016-03-04T06:47:58.999Z",
+  "is_admin"=>true}},
+ {"id"=>2,
+  "name"=>"Chanel Robel",
+  "email"=>"wilma@rice.com",
+  "created_at"=>"2016-03-04T06:47:59.008Z",
+  "updated_at"=>"2016-03-04T06:47:59.008Z",
+  "is_admin"=>false}}]
+
+# #es_where with multiple search conditions
+User.es_where(id: 1, is_admin: false).load.collections
+=> []
+
+pp User.es_where(id: 1, is_admin: true).load.collections
+=> [{"id"=>1,
+  "name"=>"Arnaldo Powlowski PhD",
+  "email"=>"charley_walsh@weber.co.uk",
+  "created_at"=>"2016-03-04T06:47:58.999Z",
+  "updated_at"=>"2016-03-04T10:03:39.102Z",
+  "is_admin"=>true}]
+```
+
+### #es_select
+```ruby
+# use es_select to select the attribtues you want
+pp User.es_where(id: 1).es_select(:id,:name).load.collections
+=> [{"id"=>1, "name"=>"Arnaldo Powlowski PhD"},
+ {"id"=>2, "name"=>"Chanel Robel"}]
+```
+
+### #es_like
+```ruby
+# use es_like to perform keyword matching
+pp User.es_like(name: 'Mr. Su').select(:name).load.collections
+=> [{"name"=>"Mr. Marquise Goodwin"},
+ {"name"=>"Mr. Stephanie Carter"},
+ {"name"=>"Mr. Susana Jerde"},
+ {"name"=>"Mrs. Earline Thompson"},
+ {"name"=>"Mrs. Eunice Bergnaum"}]
+pp User.es_like(name: 'Mr. Su').select(:name).search_params
+=> {:query=>
+  {:filtered=>{:query=>{:bool=>{:must=>[{:match=>{:name=>"Mr. Su"}}]}}}},
+ :fields=>[:name]}
+
+pp User.es_like(name: {or: 'Mr. Su'}).select(:name).load.collections
+=> [{"name"=>"Mr. Marquise Goodwin"},
+ {"name"=>"Mr. Stephanie Carter"},
+ {"name"=>"Mr. Susana Jerde"},
+ {"name"=>"Mrs. Earline Thompson"},
+ {"name"=>"Mrs. Eunice Bergnaum"}]
+pp User.es_like(name: {or: 'Mr. Su'}).select(:name).search_params
+=> {:query=>
+  {:filtered=>
+    {:query=>
+      {:bool=>
+        {:must=>[{:match=>{:name=>{:operator=>:or, :query=>"Mr. Su"}}}]}}}},
+ :fields=>[:name]}
+
+pp User.es_like(name: {and: 'Mr. Su'}).select(:name).load.collections
+=> []
+pp User.es_like(name: {and: 'Mr. Su'}).select(:name).search_params
+=> {:query=>
+  {:filtered=>
+    {:query=>
+      {:bool=>
+        {:must=>[{:match=>{:name=>{:operator=>:and, :query=>"Mr. Su"}}}]}}}},
+ :fields=>[:name]}
+```
+### #use :like in #es_where
+```ruby
+# the following search are equal
+User.es_like(name: "test").es_where(id:1)
+User.es_where(id:1, name: {like: "test"})
+
+pp User.es_where(id: 1, email: {like: 'charley_walsh'}).select(:id,:email).load.collections
+=> [{"id"=>1, "email"=>"charley_walsh@weber.co.uk"}]
+pp User.es_where(id: 1).es_like(email: 'charley_walsh').select(:id,:email).load.collections
+=> [{"id"=>1, "email"=>"charley_walsh@weber.co.uk"}]
+
+```
+### #es_or, #es_and
+```
+# use es_or to perform OR condition search
+User.es_or(id:2, is_admin: true).select(:id,:is_admin).load.collections
+=> [{"id"=>1, "is_admin"=>true}, {"id"=>2, "is_admin"=>false}]
+
+# use es_and to perform AND condition search
+User.es_and(id:2, is_admin: true).select(:id,:is_admin).load.collections
+=> []
+User.es_and(id:1, is_admin: true).select(:id,:is_admin).load.collections
+=> [{"id"=>1, "is_admin"=>true}]
+
+# es_and is alias of es_where
+```
+
+### #es_or and #es_where for nested condition search
+```ruby
+User.es_and(id: 1, or: {email: {like: 'brennon'}, is_admin: true})
+# the condictions of the search above is  
+tel=18510705036 and ( email like 'edaixi.com' or is_admin=true)
+```
+
+### #es_not
+```ruby
+#use es_not to perform not equal condition search
+User.es_where({}).load.count
+=> 100
+User.es_not({id: 1}).load.count
+=> 99
+```
+
+### #range search
+```ruby
+# use the following syntax to perform range search
+User.es_where(id: {lt: 3, gt:1  }).select(:id).load.collections
+ => [{"id"=>2}]
+
+User.es_where(id: {lte: 2, gte: 1 }).select(:id).load.collections
+ => [{"id"=>1}, {"id"=>2}]
+
+#   lt   =>    less than   <
+#   gt  =>    greater than >
+#   lte =>    less than equal  <= 
+#   gte =>   greater than equal >=
+
+### #es_limit and #es_offset
+
+# es_limit and es_offset work the same as limit and offset methods of ActiveRecor
+
+User.es_where({}).select(:id).limit(3).load.collections
+ => [{"id"=>1}, {"id"=>2}, {"id"=>3}]
+
+User.es_where({}).select(:id).limit(3).offset(2).load.collections
+ => [{"id"=>3}, {"id"=>4}, {"id"=>5}]
+```
+
+### *_like, *_between, *_gt, *_lt, *_gte, *_lte
+```ruby
+User.name_like('test')   <=>    User.like(name: 'test')
+User.id_lte(10)          <=>    User.lte(id: 10)
+User.id_between(1,3)     <=>    User.where(id: {gte: 1, lte: 2})
+```

data/README.rdoc

@@ -0,0 +1,3 @@
+= EsSearchable
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EsSearchable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/es_searchable.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_searchable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "es_searchable"
+  spec.version       = EsSearchable::VERSION
+  spec.authors       = ["zuozuo"]
+  spec.email         = ["c_yzuo@groupon.com"]
+  spec.summary       = %q{A small wrapper of elasticsearch search api}
+  spec.description   = %q{A small wrapper of elasticsearch search api}
+  spec.homepage      = ""
+  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_dependency "bundler", "~> 1.6"
+	spec.add_dependency "rake"
+	spec.add_dependency "elasticsearch"
+	spec.add_dependency "elasticsearch-rails", "~> 0.1.7"
+	spec.add_dependency "elasticsearch-model", "~> 0.1.8"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "mocha"
+end

data/lib/es_searchable/configurable.rb

@@ -0,0 +1,43 @@
+module EsSearchable
+	module Configurable
+		def self.extended(base)
+			base.const_set :SearchMethods,
+				[:where, :like, :limit, :offset, :or, :not, :select, :and]
+			
+			base.const_set :DEFAULTS, { 
+				log: true,
+				retry_on_failure: 5, 
+				async_callback: true,
+				queue: 'elasticsearch',
+				reload_on_failure: true, 
+				hosts: ['localhost:9200'], 
+				logger: defined?(Rails) ? Logger.new($stdout) : nil,
+			}
+				
+			base.class_eval do
+				DEFAULTS.each do |k, v|
+					self.define_singleton_method "#{k}=" do |value|
+						self.options.merge!(k => value)
+					end
+
+					self.define_singleton_method k do
+						self.options[k]
+					end
+				end
+			end
+		end
+
+		def configure
+			yield self
+		end
+
+		def options
+			@options ||= DEFAULTS.dup
+		end
+
+		def options=(opts)
+			@options = opts
+		end
+
+	end
+end