elasticsearch-dsl 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055ca5865485c8f28e21edaab8e8cdf51d3f066b
-  data.tar.gz: 12b1be97400b1f7b4f0bca1ddb8b77731a7c6ef4
+  metadata.gz: c2037d3abda2b5b40dab3cd2618751d20c0fcc06
+  data.tar.gz: b31c3b77ac4628ea87e96f85b9e06b2f8a592b91
 SHA512:
-  metadata.gz: 091cda1600fb6848d0f1ebfc7be9fde2220f2600d073b896b37a091887527212f2506860f7dc9b1a6bf02e0271479dc46ab4cb8df9e8e7db9e806aa006cc2c36
-  data.tar.gz: f6afafb234bbad0efbd2f82a7da7d02766206d8b757e824f8dd17de2c1438db2e8d146c15ea424dc73fdf4609a59bab927720b6d6a3619baf4536f9cad1f1e04
+  metadata.gz: 8c7b217d8851ccb1f90263a48f05dff3517dca17d57296acbb750d2fd5232f35c7ed8f6cd5e060e6a30eb93937975c03c04dacd85006ca9fbe9827478471fab8
+  data.tar.gz: 1c8efb817f44b4ce94d08c56aaa43b4eb74b6a348e2b55582d70a3325f437271a1bb602c7fec4a5d0e4124ab3d2987fb2176b9aa34ad95c4ed1f8b9f37f76c28

data/README.md

@@ -108,7 +108,11 @@ All Elasticsearch DSL features are supported, namely:
 * [Pagination](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-from-size.html)
 * [Options](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html) (source filtering, highlighting, etc)
 
-An example of a complex search definition would look like this:
+An example of a complex search definition is below.
+
+**NOTE:** In order to run the example, you have to allow restoring from the `data.elasticsearch.org`
+         repository by adding this configuration to your `elasticsearch.yml`:
+         `repositories.url.allowed_urls: ["https://s3.amazonaws.com/data.elasticsearch.org/*"]`
 
 ```ruby
 require 'awesome_print'
@@ -120,18 +124,17 @@ include Elasticsearch::DSL
 
 client = Elasticsearch::Client.new transport_options: { request: { timeout: 3600, open_timeout: 3600 } }
 
-# Restore an index from a snapshot
-#
+puts "Recovering the 'bicycles.stackexchange.com' index...".yellow
+
 client.indices.delete index: 'bicycles.stackexchange.com', ignore: 404
 
-puts "Recovering the 'bicycles.stackexchange.com' index...".gray
 client.snapshot.create_repository repository: 'data.elasticsearch.org', body: { type: 'url', settings: { url: 'https://s3.amazonaws.com/data.elasticsearch.org/bicycles.stackexchange.com/' } }
 client.snapshot.restore repository: 'data.elasticsearch.org', snapshot: 'bicycles.stackexchange.com', body: { indices: 'bicycles.stackexchange.com' }
 until client.cluster.health(level: 'indices')['indices']['bicycles.stackexchange.com']['status'] == 'green'
-  r = client.indices.status(index: 'bicycles.stackexchange.com', human: true, recovery: true)['indices']['bicycles.stackexchange.com']['shards']['0'][0]
-  print "\r#{r['index']['size']} of #{r['gateway_recovery']['index']['expected_recovered_size']}".ljust(52).gray
+  r = client.indices.recovery(index: 'bicycles.stackexchange.com', human: true)['bicycles.stackexchange.com']['shards'][0] rescue nil
+  print "\r#{r['index']['size']['recovered'] rescue '0b'} of #{r['index']['size']['total'] rescue 'N/A'}".ljust(52).gray
   sleep 1
-end
+end; puts
 
 # The search definition
 #
@@ -164,9 +167,9 @@ definition = search {
         end
       end
 
-      # Multiply the default `_score` by a (slightly normalized) document rating
+      # Multiply the default `_score` by the document rating
       #
-      functions << { script_score: { script: '_score * log10( doc["rating"].value )' } }
+      functions << { script_score: { script: '_score * doc["rating"].value' } }
     end
   end
 
@@ -175,6 +178,12 @@ definition = search {
   aggregation :tags do
     terms do
       field 'tags'
+
+      # Calculate average view count per tag (inner aggregation)
+      #
+      aggregation :avg_view_count do
+        avg field: 'view_count'
+      end
     end
   end
 
@@ -185,6 +194,12 @@ definition = search {
       field    'creation_date'
       interval 'month'
       format   'yyyy-MM'
+
+      # Calculate the statistics on comment count per day (inner aggregation)
+      #
+      aggregation :comments do
+        stats field: 'comment_count'
+      end
     end
   end
 
@@ -206,14 +221,14 @@ definition = search {
   source ['title', 'tags', 'creation_date', 'rating', 'user.location', 'user.display_name']
 }
 
-puts "Search definition #{'-'*63}\n".gray
+puts "Search definition #{'-'*63}\n".yellow
 ap   definition.to_hash
 
 # Execute the search request
 #
 response = client.search index: 'bicycles.stackexchange.com', type: ['question','answer'], body: definition
 
-puts "\nSearch results #{'-'*66}\n".gray
+puts "\nSearch results #{'-'*66}\n".yellow
 ap   response
 ```
 

data/lib/elasticsearch/dsl/search/aggregation.rb

@@ -28,7 +28,7 @@ module Elasticsearch
           end
         end
 
-        # Defines a nested aggregation
+        # Defines an aggregation nested in another one
         #
         def aggregation(*args, &block)
           call

data/lib/elasticsearch/dsl/search/aggregations/global.rb

@@ -9,14 +9,18 @@ module Elasticsearch
         #
         #     search do
         #       aggregation :all_documents do
-        #         global
+        #         global do
+        #           aggregation :avg_clicks do
+        #             avg field: 'clicks'
+        #           end
+        #         end
         #       end
         #     end
         #
-        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html
         #
         class Global
-          include BaseComponent
+          include BaseAggregationComponent
         end
 
       end

data/lib/elasticsearch/dsl/search/aggregations/stats.rb

@@ -5,7 +5,7 @@ module Elasticsearch
 
         # A multi-value metrics aggregation which returns statistical information on numeric values
         #
-        # @example
+        # @example Passing the options as a Hash
         #
         #     search do
         #       aggregation :clicks_stats do
@@ -13,10 +13,23 @@ module Elasticsearch
         #       end
         #     end
         #
-        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html
+        # @example Passing the options as a block
+        #
+        #     search do
+        #       aggregation :clicks_stats do
+        #         stats do
+        #           field 'clicks'
+        #         end
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html
         #
         class Stats
           include BaseComponent
+
+          option_method :field
+          option_method :script
         end
 
       end

data/lib/elasticsearch/dsl/search/aggregations/terms.rb

@@ -5,13 +5,23 @@ module Elasticsearch
 
         # A multi-bucket aggregation which returns the collection of terms and their document counts
         #
-        # @example
+        # @example Passing the options as a Hash
         #
         #     aggregation :tags do
         #       terms field: 'tags'
         #     end
         #
-        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html
+        # @example Passing the options as a block
+        #
+        #     search do
+        #       aggregation :tags do
+        #         terms do
+        #           field 'tags'
+        #         end
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html
         #
         class Terms
           include BaseAggregationComponent

data/lib/elasticsearch/dsl/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module DSL
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/test/integration/search_aggregation_geo_test.rb

@@ -15,7 +15,7 @@ module Elasticsearch
             mappings: {
               venue: {
                 properties: {
-                  location: { type: 'geo_point', normalize: false, validate: true }
+                  location: { type: 'geo_point' }
                 }
               }
             }

data/test/integration/search_aggregations_test.rb

@@ -36,7 +36,7 @@ module Elasticsearch
             assert_equal 3, response['aggregations']['tags']['value']
           end
 
-          should "return tag counts per clicks range" do
+          should "return tag counts per clicks range as an inner (nested) aggregation" do
             response = @client.search index: 'test', body: search {
               aggregation :clicks do
                 range field: 'clicks' do
@@ -95,6 +95,29 @@ module Elasticsearch
             assert_equal 13, response['aggregations']['avg_clicks']['value'].to_i
           end
 
+          should "define a global aggregation" do
+            response = @client.search index: 'test', body: search {
+                query do
+                  filtered filter: { terms: { tags: ['two'] } }
+                end
+
+                aggregation :avg_clicks do
+                  avg field: 'clicks'
+                end
+
+                aggregation :all_documents do
+                  global do
+                    aggregation :avg_clicks do
+                      avg field: 'clicks'
+                    end
+                  end
+                end
+            }.to_hash
+
+            assert_equal 15, response['aggregations']['avg_clicks']['value'].to_i
+            assert_equal 13, response['aggregations']['all_documents']['avg_clicks']['value'].to_i
+          end
+
           should "return statistics on clicks" do
             response = @client.search index: 'test', body: search {
               aggregation :stats_clicks do

data/test/unit/aggregations/global_test.rb

@@ -12,7 +12,25 @@ module Elasticsearch
           should "be converted to a Hash" do
             assert_equal({ global: {} }, subject.to_hash)
           end
-          
+
+          should "take a block" do
+            subject = Global.new do
+            end
+            assert_equal({global: {} }, subject.to_hash)
+          end
+
+          should "define aggregations" do
+            subject = Global.new do
+              aggregation :foo do
+                terms field: "bar"
+              end
+            end
+            expected = {
+              aggregations: { foo: { terms: { field: "bar" } } },
+              global: {}
+            }
+            assert_equal(expected, subject.to_hash)
+          end
         end
       end
     end

data/test/unit/aggregations/stats_test.rb

@@ -17,6 +17,14 @@ module Elasticsearch
             subject = Stats.new foo: 'bar'
             assert_equal({ stats: { foo: 'bar' } }, subject.to_hash)
           end
+
+          should "take a block" do
+            subject = Stats.new do
+              field 'bar'
+            end
+
+            assert_equal({stats: { field: 'bar' } }, subject.to_hash)
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-dsl
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler