elasticsearch-dsl 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2037d3abda2b5b40dab3cd2618751d20c0fcc06
-  data.tar.gz: b31c3b77ac4628ea87e96f85b9e06b2f8a592b91
+  metadata.gz: 5e9bb408fa97be4d12b615340b7fa44090287e08
+  data.tar.gz: d4c70bf0fcc2864c11226855c471dc921d23687c
 SHA512:
-  metadata.gz: 8c7b217d8851ccb1f90263a48f05dff3517dca17d57296acbb750d2fd5232f35c7ed8f6cd5e060e6a30eb93937975c03c04dacd85006ca9fbe9827478471fab8
-  data.tar.gz: 1c8efb817f44b4ce94d08c56aaa43b4eb74b6a348e2b55582d70a3325f437271a1bb602c7fec4a5d0e4124ab3d2987fb2176b9aa34ad95c4ed1f8b9f37f76c28
+  metadata.gz: b0cdfe1bfb6786cffd3610c4fd9687fb86baf6b51c49d0282d867ebb4cf91fbd0aaa1c0594a572e01ad0ca34a2ce5fc56feff1761a319943fead579a1f4d1628
+  data.tar.gz: d721ec3d8824fff4598984d0292c07df508134d431264fe51a54404dec837e45de2d7ccb2fa4a6c07faf5000ee4842693ed80e344fb59118566c4b4895cae115

data/README.md

@@ -110,9 +110,11 @@ All Elasticsearch DSL features are supported, namely:
 
 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/*"]`
+**NOTE:** In order to run the example, you have to allow restoring from the `data.elasticsearch.org` repository by adding the following configuration line to your `elasticsearch.yml`:
+
+```yaml
+repositories.url.allowed_urls: ["https://s3.amazonaws.com/data.elasticsearch.org/*"]
+```
 
 ```ruby
 require 'awesome_print'

data/elasticsearch-dsl.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.rdoc_options      = [ "--charset=UTF-8" ]
 
   s.add_development_dependency "bundler", "~> 1.3"
-  s.add_development_dependency "rake"
+  s.add_development_dependency "rake", "~> 11.1"
 
   s.add_development_dependency "elasticsearch"
   s.add_development_dependency "elasticsearch-extensions"
@@ -37,4 +37,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'yard'
   s.add_development_dependency 'cane'
   s.add_development_dependency 'pry'
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    s.add_development_dependency "test-unit", '~> 2'
+  end
 end

data/lib/elasticsearch/dsl/search.rb

@@ -39,7 +39,7 @@ module Elasticsearch
 
         def initialize(*args, &block)
           @options = Options.new *args
-          instance_eval(&block) if block
+          block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block
         end
 
         # DSL method for building or accessing the `query` part of a search definition

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

@@ -0,0 +1,36 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single bucket aggregation that creates a bucket of all documents
+        # which are missing a value for the field
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :articles_without_tags do
+        #       missing field: 'tags'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     search do
+        #       aggregation :articles_without_tags do
+        #         missing do
+        #           field 'tags'
+        #         end
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-aggregations-bucket-missing-aggregation.html
+        #
+        class Missing
+          include BaseAggregationComponent
+
+          option_method :field
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/avg_bucket.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A sibling pipeline aggregation which calculates the (mean) average value of a specified metric in a sibling aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :avg_monthly_sales do
+        #       avg_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :avg_monthly_sales do
+        #       avg_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html
+        #
+        class AvgBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/bucket_script.rb

@@ -0,0 +1,36 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A parent pipeline aggregation which executes a script which can perform per bucket computations on specified metrics in the parent multi-bucket aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :t-shirt-percentage do
+        #       bucket_script buckets_path: { tShirtSales: 't-shirts>sales', totalSales: 'total_sales' }, script: 'tShirtSales / totalSales * 100'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :t-shirt-percentage do
+        #       bucket_script do
+        #         buckets_path tShirtSales: 't-shirts>sales', totalSales: 'total_sales'
+        #         script 'tShirtSales / totalSales * 100'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html
+        #
+        class BucketScript
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :script
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/bucket_selector.rb

@@ -0,0 +1,35 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A parent pipeline aggregation which executes a script which determines whether the current bucket will be retained in the parent multi-bucket aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sales_bucket_filter do
+        #       bucket_selector buckets_path: { totalSales: 'total_sales' }, script: 'totalSales <= 50'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sales_bucket_filter do
+        #       bucket_selector do
+        #         buckets_path totalSales: 'total_sales'
+        #         script 'totalSales <= 50'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html
+        #
+        class BucketSelector
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :script
+          option_method :gap_policy
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/cumulative_sum.rb

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent histogram (or date_histogram) aggregation. 
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :cumulative_sales do
+        #       cumulative_sum buckets_path: 'sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :cumulative_sales do
+        #       cumulative_sum do
+        #         buckets_path 'sales'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html
+        #
+        class CumulativeSum
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/derivative.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A parent pipeline aggregation which calculates the derivative of a specified metric in a parent histogram (or date_histogram) aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sales_deriv do
+        #       derivative buckets_path: 'sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sales_deriv do
+        #       derivative do
+        #         buckets_path 'sales'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html
+        #
+        class Derivative
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/extended_stats_bucket.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :stats_monthly_sales do
+        #       extended_stats_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :stats_monthly_sales do
+        #       extended_stats_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-extended-stats-bucket-aggregation.html
+        #
+        class ExtendedStatsBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/max_bucket.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :max_monthly_sales do
+        #       max_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :max_monthly_sales do
+        #       max_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html
+        #
+        class MaxBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/min_bucket.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :min_monthly_sales do
+        #       min_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :min_monthly_sales do
+        #       min_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html
+        #
+        class MinBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/moving_avg.rb

@@ -0,0 +1,42 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # Given an ordered series of data, the Moving Average aggregation will slide a window across the data and emit the average value of that window. 
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :the_movavg do
+        #       moving_avg buckets_path: 'the_sum'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :the_movavg do
+        #       moving_avg do
+        #         buckets_path 'the_sum'
+        #         model 'holt'
+        #         window 5
+        #         gap_policy 'insert_zero'
+        #         settings({ alpha: 0.5 })
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movavg-aggregation.html
+        #
+        class MovingAvg
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :model
+          option_method :gap_policy
+          option_method :window
+          option_method :format
+          option_method :minimize
+          option_method :settings
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/pipeline/percentiles_bucket.rb

@@ -0,0 +1,36 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation. 
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sum_monthly_sales do
+        #       percentiles_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sum_monthly_sales do
+        #       percentiles_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #         percents [25.0 50.0 75.0]
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html
+        #
+        class PercentilesBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+          option_method :percents
+        end
+      end
+    end
+  end
+end