elasticsearch-dsl 0.0.0 → 0.1.0

data/lib/elasticsearch/dsl/search/queries/template.rb

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Queries
+
+        # A query which allows to use Mustache templates for query definitions
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         template do
+        #           query  match: { content: '{query_string}' }
+        #           params query_string: 'twitter'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-template-query.html
+        #
+        class Template
+          include BaseComponent
+
+          option_method :query
+          option_method :params
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/queries/term.rb

@@ -0,0 +1,27 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Queries
+
+        # A query which returns documents matching the specified term
+        #
+        # @note The specified term is *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         term category: 'Opinion'
+        #       end
+        #     end
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-query.html
+        #
+        class Term
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Queries
+
+        # A query which returns documents matching the specified terms
+        #
+        # @note The specified terms are *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         terms categories: ['World', 'Opinion']
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-common-terms-query.html
+        #
+        class Terms
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/queries/top_children.rb

@@ -0,0 +1,58 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Queries
+
+        # A filter which returns parent documents for children documents matching a query
+        #
+        # @example Return articles with comments mentioning 'twitter', summing the score
+        #
+        #     search do
+        #       query do
+        #         top_children do
+        #           type  'comment'
+        #           query match: { body: 'twitter' }
+        #           score 'sum'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-top-children-query.html
+        #
+        class TopChildren
+          include BaseComponent
+
+          option_method :type
+          option_method :score
+          option_method :factor
+          option_method :incremental_factor
+          option_method :_scope
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = Query.new(*args, &block) : args.first
+            self
+          end
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @query
+              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
+              hash[self.name].update(query: _query)
+            end
+            hash
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/queries/wildcard.rb

@@ -0,0 +1,30 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Queries
+
+        # A query which returns documents matching a wildcard expression
+        #
+        # @note The expression is *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #        wildcard title: 'tw*'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html
+        #
+        class Wildcard
+          include BaseComponent
+
+          option_method :value
+          option_method :boost
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Elasticsearch
+  module DSL
+    module Search
+
+      # Contains the classes for Elasticsearch queries
+      #
+      module Queries;end
+
+      # Wraps the `query` part of a search definition
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html
+      #
+      class Query
+        def initialize(*args, &block)
+          @block = block
+        end
+
+        # Looks up the corresponding class for a method being invoked, and initializes it
+        #
+        # @raise [NoMethodError] When the corresponding class cannot be found
+        #
+        def method_missing(name, *args, &block)
+          klass = Utils.__camelize(name)
+          if Queries.const_defined? klass
+            @value = Queries.const_get(klass).new *args, &block
+          else
+            raise NoMethodError, "undefined method '#{name}' for #{self}"
+          end
+        end
+
+        # Evaluates any block passed to the query
+        #
+        # @return [self]
+        #
+        def call
+          @block.arity < 1 ? self.instance_eval(&@block) : @block.call(self) if @block
+          self
+        end
+
+        # Converts the query definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash(options={})
+          call
+          if @value
+            @value.to_hash
+          else
+            {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Elasticsearch
+  module DSL
+    module Search
+
+      # Wraps the `sort` part of a search definition
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html
+      #
+      class Sort
+        include BaseComponent
+
+        def initialize(*args, &block)
+          @value ||= []
+          super
+        end
+
+        # DSL method to specify sorting item
+        #
+        # @example
+        #
+        #     search do
+        #       sort do
+        #         by :category
+        #         by :clicks, order: 'desc'
+        #       end
+        #     end
+        #
+        def by(name, direction=nil)
+          @value << ( direction ? { name => direction } : name )
+          self
+        end
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          if @block
+            call
+          else
+            @value << @args if @args
+          end
+
+          @hash = @value.flatten
+          @hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Elasticsearch
+  module DSL
+    module Search
+
+      # Wraps the `suggest` part of a search definition
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters.html
+      #
+      class Suggest
+        include BaseComponent
+
+        def initialize(key, options={}, &block)
+          @key     = key
+          @options = options
+          @block   = block
+        end
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          { @key => @options }
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/utils.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module DSL
+
+    # Generic utility methods
+    #
+    module Utils
+
+      # Camelize an underscored string
+      #
+      # A lightweight version of ActiveSupport's `camelize`
+      #
+      # @example
+      #     __camelize('query_string')
+      #     # => 'QueryString'
+      #
+      # @api private
+      #
+      def __camelize(string)
+        string.to_s.split('_').map(&:capitalize).join
+      end
+
+      extend self
+    end
+  end
+end

data/lib/elasticsearch/dsl/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
-  module Dsl
-    VERSION = "0.0.0"
+  module DSL
+    VERSION = "0.1.0"
   end
 end

data/test/integration/search_aggregation_children_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class ChildrenAggregationIntegrationTest < ::Elasticsearch::Test::IntegrationTestCase
+      include Elasticsearch::DSL::Search
+
+      context "A children aggregation" do
+        startup do
+          Elasticsearch::Extensions::Test::Cluster.start(nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?
+        end
+
+        setup do
+          @client.indices.create index: 'articles-test', body: {
+            mappings: {
+              article: {},
+              comment: {
+                _routing: { required: true },
+                _parent:  { type: 'article' },
+                properties: {
+                  author: { type: 'string', analyzer: 'keyword' }
+                }
+              }
+            }
+          }
+          @client.index index: 'articles-test', type: 'article', id: 1,
+                        body: { title: 'A', category: 'one'  }
+          @client.index index: 'articles-test', type: 'article', id: 2,
+                        body: { title: 'B', category: 'one'  }
+          @client.index index: 'articles-test', type: 'article', id: 3,
+                        body: { title: 'C', category: 'two'  }
+
+          @client.index index: 'articles-test', type: 'comment', parent: '1',
+                        body: { author: 'John' }
+          @client.index index: 'articles-test', type: 'comment', parent: '1',
+                        body: { author: 'Mary' }
+          @client.index index: 'articles-test', type: 'comment', parent: '2',
+                        body: { author: 'John' }
+          @client.index index: 'articles-test', type: 'comment', parent: '2',
+                        body: { author: 'Dave' }
+          @client.index index: 'articles-test', type: 'comment', parent: '3',
+                        body: { author: 'Ruth' }
+          @client.indices.refresh index: 'articles-test'
+        end
+
+        should "return the top commenters per article category" do
+          response = @client.search index: 'articles-test', size: 0, body: search {
+            aggregation :top_categories do
+              terms field: 'category' do
+                aggregation :comments do
+                  children type: 'comment' do
+                    aggregation :top_authors do
+                      terms field: 'author'
+                    end
+                  end
+                end
+              end
+            end
+          }.to_hash
+
+          assert_equal 'one',  response['aggregations']['top_categories']['buckets'][0]['key']
+          assert_equal 3,      response['aggregations']['top_categories']['buckets'][0]['comments']['top_authors']['buckets'].size
+          assert_equal 'John', response['aggregations']['top_categories']['buckets'][0]['comments']['top_authors']['buckets'][0]['key']
+
+        end
+      end
+    end
+  end
+end

data/test/integration/search_aggregation_geo_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class GeoAggregationIntegrationTest < ::Elasticsearch::Test::IntegrationTestCase
+      include Elasticsearch::DSL::Search
+
+      context "A geo aggregation" do
+        startup do
+          Elasticsearch::Extensions::Test::Cluster.start(nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?
+        end
+
+        setup do
+          @client.indices.create index: 'venues-test', body: {
+            mappings: {
+              venue: {
+                properties: {
+                  location: { type: 'geo_point', normalize: false, validate: true }
+                }
+              }
+            }
+          }
+          @client.index index: 'venues-test', type: 'venue',
+                        body: { name: 'Space', location: "38.886214,1.403889" }
+          @client.index index: 'venues-test', type: 'venue',
+                        body: { name: 'Pacha', location: "38.9184427,1.4433646" }
+          @client.index index: 'venues-test', type: 'venue',
+                        body: { name: 'Amnesia', location: "38.948045,1.408341" }
+          @client.index index: 'venues-test', type: 'venue',
+                        body: { name: 'Privilege', location: "38.958082,1.408288" }
+          @client.index index: 'venues-test', type: 'venue',
+                        body: { name: 'Es Paradis', location: "38.979071,1.307394" }
+          @client.indices.refresh index: 'venues-test'
+        end
+
+        should "return the geo distances from a location" do
+          response = @client.search index: 'venues-test', size: 0, body: search {
+            aggregation :venue_distances do
+              geo_distance do
+                field  :location
+                origin '38.9126352,1.4350621'
+                unit   'km'
+                ranges [ { to: 1 }, { from: 1, to: 5 }, { from: 5, to: 10 }, { from: 10 } ]
+
+                aggregation :top_venues do
+                  top_hits _source: { include: 'name' }
+                end
+              end
+            end
+          }.to_hash
+
+          result = response['aggregations']['venue_distances']
+
+          assert_equal 4,       result['buckets'].size
+          assert_equal 1,       result['buckets'][0]['doc_count']
+          assert_equal 'Pacha', result['buckets'][0]['top_venues']['hits']['hits'][0]['_source']['name']
+
+          assert_equal 2,       result['buckets'][1]['top_venues']['hits']['total']
+        end
+
+        should "return the geohash grid distribution" do
+          #
+          # See the geohash plot eg. at http://openlocation.org/geohash/geohash-js/
+          # See the locations visually eg. at http://geohash.org/sncj8h17r2
+          #
+          response = @client.search index: 'venues-test', size: 0, body: search {
+            aggregation :venue_distributions do
+              geohash_grid do
+                field     :location
+                precision 5
+
+                aggregation :top_venues do
+                  top_hits _source: { include: 'name' }
+                end
+              end
+            end
+          }.to_hash
+
+          result = response['aggregations']['venue_distributions']
+
+          assert_equal 4,       result['buckets'].size
+          assert_equal 'sncj8', result['buckets'][0]['key']
+          assert_equal 2,       result['buckets'][0]['doc_count']
+
+          assert_same_elements %w[ Privilege Amnesia ], result['buckets'][0]['top_venues']['hits']['hits'].map { |h| h['_source']['name'] }
+        end
+      end
+    end
+  end
+end