es-elasticity 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e94caa98bd83150c6799ad689e65a7c8e66816e6
-  data.tar.gz: 1d3114e6576347abf45dac9c41dc449cd0b298e2
+  metadata.gz: 72fe553f4fcf606f9a2582cc1563a78905b03c84
+  data.tar.gz: 010cfafae1a421bd9dabf6449a7a6108b3938ac0
 SHA512:
-  metadata.gz: f4601bdaa5a6d904c6374ae2b733473258e2e5bf8dbc343114a7d8b9e0a230074e2206adb15123371ce7bd9bed3ac633454e6bd8809877fde26175d9adf603c1
-  data.tar.gz: 37019fb734b5694b722bc6175ab4ebe41835cedcf06eff307e1408c6db3ce74c1c6680d2ebe1be4c8624e6e4ef594c5383d2b642fc0a6bc5ec55afb588114eb2
+  metadata.gz: 068104bc862fb6a45c2ebbb1eab66b11429ff6a995353ed5c3f889de3ebc6359d77c83adf3e4fb09a3ef2e175e6421ec0e061b1b73e60ad7c7bbec2e3a1a3a78
+  data.tar.gz: 27454507647e48494a1d02566fcefea35ee63e1662fab5307dcf0c019aa88d12b3f47c4b0c56cadfcc20d8fb27a54242f7c5ad09f48a13da5b89d0bae9ea88f0

data/README.md

@@ -26,6 +26,21 @@ Or install it yourself as:
 
 ## Usage
 
+### Configuration
+
+It is recommended you use Typhoeus for HTTP connections to Elasticsearch.
+
+```ruby
+# config/initializers/es-elasticity.rb
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+Elasticity.configure do |config|
+  config.client = Elasticsearch::Client.new
+  config.namespace = Rails.env.to_s.downcase
+end
+```
+
 ### Document model definition
 
 The first thing to do, is setup a model representing your documents. The class level represents the index, while the instance level represents each Document stored in the index. This is similar to how ActiveRecord maps tables vs rows.
@@ -58,21 +73,23 @@ class Search::User < Elasticity::Document
   def self.adults
     date = Date.today - 21.years
 
-    # This is the query that will be submited to ES, same format ES would 
-    # expect, translated to a Ruby hash.
+    # This is the query that will be submited to ES, same format ES would
+    # expect, translated to a Ruby hash, note the pagination params.
     body = {
+      from: 0,
+      size: 10,
       filter: {
         { range: { birthdate: { gte: date.iso8601 }}},
       },
     }
 
-    # Creates a search object from the body and return it. 
-    # The returned object # is a lazy evaluated search that behaves like a collection, being 
+    # Creates a search object from the body and return it.
+    # The returned object # is a lazy evaluated search that behaves like a collection, being
     # automatically triggered when data is iterated over.
     self.search(body)
   end
 
-  # All models automatically have the id attribute but you need to define the 
+  # All models automatically have the id attribute but you need to define the
   # other accessors so that they can be set and get properly.
   attr_accessor :name, :birthdate
 
@@ -128,12 +145,15 @@ adults = User.adults
 adults.each do |user|
   # do something with user
 end
+
+# Or get the count
+adults.count
 ```
 
 It also has some pretty interesting methods that affects the way the query is performed. Here is a list of available search types:
 
 ```ruby
-# Returns an array of document instances, this is the default and what the 
+# Returns an array of document instances, this is the default and what the
 # enumerable methods will delegate to.
 adults.documents
 
@@ -141,7 +161,7 @@ adults.documents
 adults.document_hashes
 
 # Performs the search using scan&scroll. It returns a cursor that will lazily
-# fetch all the pages of the search. It can be iterated by batch/page or by 
+# fetch all the pages of the search. It can be iterated by batch/page or by
 # document.
 cursor = adults.scan_documents
 cursor.each_batch { |batch| ... }
@@ -170,7 +190,7 @@ Here is what it looks like:
                                        |    Index    |
 |¯¯¯¯¯¯¯¯¯¯¯¯¯|         |------------> |_____________|
 | UpdateAlias |---------|
-|_____________| 
+|_____________|
 ```
 
 Everytime a search operation is performed, it is performed against the main alias; when an update operation is performed, it is performed against the update alias; and, when a delete operation is performed, it is performed against the indexes pointed by both aliases.
@@ -184,7 +204,7 @@ When the mapping needs to change, a hot remapping can be performed by doing the
   |¯¯¯¯¯¯¯¯¯¯¯¯¯|----------------------> |¯¯¯¯¯¯¯¯¯¯¯¯¯|
   |  MainAlias  |                        |  Old Index  |
   |_____________|----------|             |_____________|
-                           |                           
+                           |
   |¯¯¯¯¯¯¯¯¯¯¯¯¯|          |-----------> |¯¯¯¯¯¯¯¯¯¯¯¯¯|
   | UpdateAlias |----------------------> |  New Index  |
   |_____________|                        |_____________|
@@ -247,7 +267,7 @@ To extend on the previous example, imagine the `Search::User` class also have th
 ```ruby
 def self.adults
   date = Date.today - 21.years
-  
+
   body = {
     filter: {
       { range: { birthdate: { gte: date.iso8601 }}},

data/elasticity.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", "~> 4.0"
   spec.add_dependency "activemodel",   "~> 4.0"
-  spec.add_dependency "elasticsearch", "~> 1.0.5"
+  spec.add_dependency "elasticsearch", "~> 1.0.12"
 end

data/lib/elasticity/document.rb

@@ -27,7 +27,7 @@ module Elasticity
         index_base_name = "#{namespace}_#{@config.index_base_name}"
       end
 
-      @strategy = @config.strategy.new(Elasticity.config.client, index_base_name)
+      @strategy = @config.strategy.new(Elasticity.config.client, index_base_name, document_type)
     end
 
     # Document type

data/lib/elasticity/instrumented_client.rb

@@ -16,7 +16,7 @@ module Elasticity
     end
 
     # Generate wrapper methods for @client
-    %w(index delete get mget search msearch scroll delete_by_query bulk).each do |method_name|
+    %w(index delete get mget search count msearch scroll delete_by_query bulk).each do |method_name|
       define_method(method_name) do |*args, &block|
         instrument(method_name, args) do
           @client.public_send(method_name, *args, &block)

data/lib/elasticity/search.rb

@@ -99,6 +99,10 @@ module Elasticity
         response["hits"]["suggest"] ||= {}
       end
 
+      def count(args = {})
+        @client.count(@search_definition.to_search_args.reverse_merge(args))["count"]
+      end
+
       def search_results
         return @search_results if defined?(@search_results)
 

data/lib/elasticity/strategies.rb

@@ -4,8 +4,8 @@ module Elasticity
       attr_reader :index_base_name
 
       def initialize(index_base_name, message)
-        @index_name = index_name
-        super("#{index_name}: #{message}")
+        @index_base_name = index_base_name
+        super("#{index_base_name}: #{message}")
       end
     end
 

data/lib/elasticity/strategies/alias_index.rb

@@ -6,10 +6,11 @@ module Elasticity
     class AliasIndex
       STATUSES = [:missing, :ok]
 
-      def initialize(client, index_base_name)
+      def initialize(client, index_base_name, document_type)
         @client       = client
         @main_alias   = index_base_name
         @update_alias = "#{index_base_name}_update"
+        @document_type = document_type
       end
 
       def ref_index_name
@@ -231,17 +232,13 @@ module Elasticity
       end
 
       def settings
-        args = { index: @main_alias }
-        settings = @client.index_get_settings(index: @main_alias)
-        settings[@main_alias]["settings"]
+        @client.index_get_settings(index: @main_alias, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
         nil
       end
 
       def mappings
-        args = { index: @main_alias }
-        mapping = @client.index_get_mapping(index: @main_alias)
-        mapping[@main_alias]["mappings"]
+        @client.index_get_mapping(index: @main_alias, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
         nil
       end

data/lib/elasticity/strategies/single_index.rb

@@ -3,9 +3,10 @@ module Elasticity
     class SingleIndex
       STATUSES = [:missing, :ok]
 
-      def initialize(client, index_name)
-        @client     = client
-        @index_name = index_name
+      def initialize(client, index_name, document_type)
+        @client        = client
+        @index_name    = index_name
+        @document_type = document_type
       end
 
       def ref_index_name
@@ -78,17 +79,13 @@ module Elasticity
       end
 
       def settings
-        args = { index: @index_name }
-        settings = @client.index_get_settings(index: @index_name)
-        settings[@index_name]["settings"]
+        @client.index_get_settings(index: @index_name, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
         nil
       end
 
       def mappings
-        args = { index: @index_name }
-        mapping = @client.index_get_mapping(index: @index_name)
-        mapping[@index_name]["mappings"]
+        @client.index_get_mapping(index: @index_name, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
         nil
       end

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

data/spec/functional/persistence_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe "Persistence", elasticsearch: true do
       subject.delete_index
     end
 
-    it "successfully index, update, search and delete" do
+    it "successfully index, update, search, count and delete" do
       john = subject.new(name: "John", birthdate: "1985-10-31")
       mari = subject.new(name: "Mari", birthdate: "1986-09-24")
 
@@ -46,6 +46,8 @@ RSpec.describe "Persistence", elasticsearch: true do
       expect(results[0]).to eq(john)
       expect(results[1]).to eq(mari)
 
+      expect(subject.search({query: {filtered: { query: { match_all: {} } } } }).count).to eq(2)
+
       john.update
       mari.delete
 

data/spec/units/strategies/single_index_spec.rb

@@ -1,14 +1,14 @@
 RSpec.describe Elasticity::Strategies::SingleIndex, elasticsearch: true do
   subject do
-    described_class.new(Elasticity.config.client, "test_index_name")
+    described_class.new(Elasticity.config.client, "test_index_name", "document")
   end
 
   let :index_def do
     {
-      mappings: {
-        document: {
-          properties: {
-            name: { type: "string" }
+      "mappings" => {
+        "document" => {
+          "properties" => {
+            "name" => { "type" => "string" }
           }
         }
       }
@@ -21,10 +21,10 @@ RSpec.describe Elasticity::Strategies::SingleIndex, elasticsearch: true do
 
   it "allows creating, recreating and deleting an index" do
     subject.create(index_def)
-    expect(subject.mappings).to eq({"document"=>{"properties"=>{"name"=>{"type"=>"string"}}}})
+    expect(subject.mappings).to eq(index_def)
 
     subject.recreate(index_def)
-    expect(subject.mappings).to eq({"document"=>{"properties"=>{"name"=>{"type"=>"string"}}}})
+    expect(subject.mappings).to eq(index_def)
 
     subject.delete
     expect(subject.mappings).to be nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es-elasticity
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Rodrigo Kochenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.12
 description: Elasticity provides a higher level abstraction on top of [elasticsearch-ruby](https://github.com/elasticsearch/elasticsearch-ruby)
   gem
 email:
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ActiveModel-based library for working with Elasticsearch