daedal 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01d15eb052c93f8a9dedb824873a533e876c5eee
-  data.tar.gz: d3408e2da2b82d8c35bf1cb07330fdb62e09c547
+  metadata.gz: 591b82d1a7aec22b940c410fd2d5afe79877e24f
+  data.tar.gz: 16e8916ccff2aef76cc75f1052085ffe3d08527f
 SHA512:
-  metadata.gz: 1d850b9dd24946209c622306d762e8aa228994de8bdb303e19a0f572b118f42d7a6ee7df0c4ca87c17d32c512ed53f68f541e13c49bf8b28037d42072626762a
-  data.tar.gz: 3eb44d37d68e10dc6cec2c3a5a76b3cf9e146a8c612ed4628c36818aec056a45ab587f94577380a522c484bc60db3b9ad0df4c3b97a9e2bc545f92ef7e15b701
+  metadata.gz: f0a6a7d9a161c54625c7dffd3ed1040ba7aee46e13b960ce5caaf56b0be2afa24bfb4dbd5ab9f6b2f2d0a81ee58fa51d4db03c1f4fe324644360dfc930dca525
+  data.tar.gz: e4bc1ce204ce207255e1ebd1c5c1311fd80744fcd323cd737fce6e5fd2ffeb7d1150700d881124576d11fb738e1056a8d16835dbd34b00548429acd432e46527

data/Gemfile

@@ -6,4 +6,4 @@ gem 'guard-rspec'
 gem 'require_all'
 gem 'fuubar'
 gem 'debugger'
-gem 'virtus', '1.0.0'
+gem 'virtus', '>= 1.0.0'

data/Gemfile.lock

@@ -79,4 +79,4 @@ DEPENDENCIES
   guard-rspec
   require_all
   rspec
-  virtus (= 1.0.0)
+  virtus (>= 1.0.0)

data/README.md

@@ -67,6 +67,25 @@ To date (12/8/2013), I have implemented the following queries:
 * [match all query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html)
 * [match query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-match-query.html)
 * [multi match query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html)
+* [nested query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html)
+* [prefix query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html)
+
+To be implemented next:
+* [function score query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html)
+* [fuzzy query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html)
+* [query string query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
+* [range query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-range-query.html)
+* [regexp query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html)
+* [term query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-query.html)
+* [terms query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html)
+* [wildcard query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html)
+
+Queries I'm not planning on implementing at all, since they're deprecated:
+* [custom filters score query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-custom-filters-score-query.html)
+* [custom score query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-custom-score-query.html)
+* [custom boost factor query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-custom-boost-factor-query.html)
+* [text query](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-text-query.html)
+
 
 ### Filters
 
@@ -82,7 +101,16 @@ term_filter.to_json # => "{\"term\":{\"foo\":\"bar\"}}"
 ```
 
 To date (12/8/2013), I have implemented the following filters:
+* [and filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-and-filter.html)
+* [geo distance filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-filter.html)
+* [range filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-range-filter.html)
 * [term filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-filter.html)
+* [terms filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-terms-filter.html)
+
+To be implemented next:
+* [bool filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-bool-filter.html)
+* [nested filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-nested-filter.html)
+* [or filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-or-filter.html)
 
 ### Type checking and attribute coercion
 
@@ -91,7 +119,7 @@ assign an invalid value to a specific field, which would then result in
 an error response when sending the query to the server. For instance, the query:
 
 ``` ruby
-constant_score_query = {'constant_score' => {'boost' => 'foo', 'query': {'match_all': {}}}}
+constant_score_query = {'constant_score' => {'boost' => 'foo', 'query' => {'match_all' => {}}}}
 ```
 
 would yield a server error, since the `boost` parameter must be a number.

data/daedal.gemspec

@@ -14,5 +14,5 @@ Gem::Specification.new do |s|
   s.homepage    =
     'https://github.com/cschuch/daedal'
 
-  s.add_dependency('virtus', '~> 1.0.0')
+  s.add_dependency('virtus', '>= 1.0.0')
 end

data/lib/daedal/attributes.rb

@@ -2,7 +2,12 @@ require 'virtus'
 require 'daedal/attributes/operator'
 require 'daedal/attributes/match_type'
 require 'daedal/attributes/query_array'
+require 'daedal/attributes/filter_array'
 require 'daedal/attributes/score_mode'
+require 'daedal/attributes/lower_case_string'
+require 'daedal/attributes/distance_unit'
+require 'daedal/attributes/query'
+require 'daedal/attributes/filter'
 
 module Daedal
   module Attributes

data/lib/daedal/attributes/distance_unit.rb

@@ -0,0 +1,15 @@
+module Daedal
+  module Attributes
+    """Custom coercer for the type attribute"""
+    class DistanceUnit < Virtus::Attribute
+      ALLOWED_DISTANCE_UNITS = ['mi', 'km']
+      def coerce(value)
+        if value.nil? or !ALLOWED_DISTANCE_UNITS.include? value.to_s
+          raise Virtus::CoercionError.new(value, 'Daedal::Attributes::DistanceUnit')
+        end
+
+        value.to_s
+      end
+    end
+  end
+end

data/lib/daedal/attributes/filter.rb

@@ -0,0 +1,13 @@
+module Daedal
+  module Attributes
+    class Filter < Virtus::Attribute
+      def coerce(f)
+        unless f.is_a? Daedal::Filters::BaseFilter or !required? && f.nil?
+          raise Virtus::CoercionError.new(f, 'Daedal::Filters::BaseFilter')
+        end
+
+        f
+      end
+    end
+  end
+end

data/lib/daedal/attributes/filter_array.rb

@@ -0,0 +1,24 @@
+module Daedal
+  module Attributes
+    """Custom attribute for an array of queries"""
+    class FilterArray < Array
+      # override the << method so that you throw
+      # an error if you don't try to append a query
+      def <<(f)
+        if f.is_a? Daedal::Filters::BaseFilter
+          super f
+        else
+          raise Virtus::CoercionError.new(f, 'Daedal::Filters::BaseFilter')
+        end
+      end
+
+      def unshift(f)
+        if f.is_a? Daedal::Filters::BaseFilter
+          super f
+        else
+          raise Virtus::CoercionError.new(f, 'Daedal::Filters::BaseFilter')
+        end
+      end
+    end
+  end
+end

data/lib/daedal/attributes/lower_case_string.rb

@@ -0,0 +1,14 @@
+module Daedal
+  module Attributes
+    """Custom coercer for the type attribute"""
+    class LowerCaseString < Virtus::Attribute
+      def coerce(value)
+        value = value.to_s
+        if value.empty?
+          raise Virtus::CoercionError.new(value, 'Daedal::Attributes::LowerCaseString')
+        end
+        value.downcase
+      end
+    end
+  end
+end

data/lib/daedal/attributes/query.rb

@@ -0,0 +1,13 @@
+module Daedal
+  module Attributes
+    class Query < Virtus::Attribute
+      def coerce(q)
+        unless q.is_a? Daedal::Queries::BaseQuery or !required? && q.nil?
+          raise Virtus::CoercionError.new(q, 'Daedal::Queries::BaseQuery')
+        end
+
+        q
+      end
+    end
+  end
+end

data/lib/daedal/attributes/query_array.rb

@@ -2,8 +2,10 @@ module Daedal
   module Attributes
     """Custom attribute for an array of queries"""
     class QueryArray < Array
+
       # override the << method so that you throw
       # an error if you don't try to append a query
+
       def <<(q)
         if q.is_a? Daedal::Queries::BaseQuery
           super q

data/lib/daedal/filters.rb

@@ -1,6 +1,9 @@
 require 'daedal/filters/base_filter'
 require 'daedal/filters/term_filter'
 require 'daedal/filters/terms_filter'
+require 'daedal/filters/range_filter'
+require 'daedal/filters/geo_distance_filter'
+require 'daedal/filters/and_filter'
 
 module Daedal
   module Filters

data/lib/daedal/filters/and_filter.rb

@@ -0,0 +1,21 @@
+require 'daedal/filters/base_filter'
+require 'daedal/attributes'
+
+module Daedal
+  module Filters
+    """Class for the basic term filter"""
+    class AndFilter < BaseFilter
+  
+      # required attributes
+      attribute :filters, Attributes::FilterArray
+  
+      def to_hash
+        unless filters.empty?
+          {:and => filters.map {|f| f.to_hash}}
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/daedal/filters/base_filter.rb

@@ -6,7 +6,7 @@ module Daedal
       include Virtus.model strict: true
 
       def to_hash
-        {}
+        nil
       end
 
       def to_json

data/lib/daedal/filters/geo_distance_filter.rb

@@ -0,0 +1,27 @@
+require 'daedal/filters/base_filter'
+require 'daedal/attributes'
+
+module Daedal
+  module Filters
+    """Class for the basic term filter"""
+    class GeoDistanceFilter < BaseFilter
+  
+      # required attributes
+      attribute :field, Symbol
+      attribute :lat, Float
+      attribute :lon, Float
+      attribute :distance, Float
+
+      # non required attributes
+      attribute :unit, Attributes::DistanceUnit, default: 'km'
+  
+      def full_distance
+        "#{distance}#{unit}"
+      end
+
+      def to_hash
+        {geo_distance: {distance: full_distance, field => {lat: lat, lon: lon}}}
+      end
+    end
+  end
+end

data/lib/daedal/filters/range_filter.rb

@@ -0,0 +1,27 @@
+require 'daedal/filters/base_filter'
+
+module Daedal
+  module Filters
+    """Class for the basic term filter"""
+    class RangeFilter < BaseFilter
+  
+      # required attributes
+      attribute :field, Symbol
+      attribute :gte
+      attribute :lte
+      attribute :gt
+      attribute :lt
+
+      def initialize(options={})
+        super options
+        unless !gte.nil? or !gt.nil? or !lt.nil? or !lte.nil?
+          raise "Must give at least one of gte, gt, lt, or lte"
+        end
+      end
+  
+      def to_hash
+        {range: {field => {gte: gte, lte: lte, lt: lt, gt: gt}.select {|k,v| !v.nil?}}}
+      end
+    end
+  end
+end

data/lib/daedal/queries.rb

@@ -7,6 +7,7 @@ require 'daedal/queries/match_all_query'
 require 'daedal/queries/match_query'
 require 'daedal/queries/multi_match_query'
 require 'daedal/queries/nested_query'
+require 'daedal/queries/prefix_query'
 
 module Daedal
   module Queries

data/lib/daedal/queries/bool_query.rb

@@ -10,18 +10,19 @@ module Daedal
 
       # should, must, and must_not must be an array of queries
       # these queries must inherit from the BaseQuery class
-      attribute :should, Attributes::QueryArray[Daedal::Queries::BaseQuery], default: Array.new
-      attribute :must, Attributes::QueryArray[Daedal::Queries::BaseQuery], default: Array.new
-      attribute :must_not, Attributes::QueryArray[Daedal::Queries::BaseQuery], default: Array.new
+      attribute :should, Attributes::QueryArray, default: Array.new
+      attribute :must, Attributes::QueryArray, default: Array.new
+      attribute :must_not, Attributes::QueryArray, default: Array.new
   
       # non required attributes
       attribute :minimum_should_match, Integer, required: false
       attribute :boost, Integer, required: false
       attribute :name, Symbol, required: false
+      attribute :disable_coord, Boolean, required: false
   
       def to_hash
         result = {bool: {should: should.map {|q| q.to_hash}, must: must.map {|q| q.to_hash}, must_not: must_not.map {|q| q.to_hash}}}
-        options = {minimum_should_match: minimum_should_match, boost: boost, _name: name}
+        options = {minimum_should_match: minimum_should_match, boost: boost, _name: name, disable_coord: disable_coord}
         result[:bool].merge!(options.select { |k,v| !v.nil? })
   
         result

data/lib/daedal/queries/constant_score_query.rb

@@ -11,8 +11,8 @@ module Daedal
       attribute :boost, Float
 
       # non required attributes, but one must be required of the two
-      attribute :query, Daedal::Queries::BaseQuery, required: false
-      attribute :filter, Daedal::Filters::BaseFilter, required: false
+      attribute :query, Attributes::Query, required: false
+      attribute :filter, Attributes::Filter, required: false
 
       # you must require *one of* query or filter in order for this to be valid
       def initialize(options={})

data/lib/daedal/queries/dis_max_query.rb

@@ -8,15 +8,16 @@ module Daedal
     class DisMaxQuery < BaseQuery
   
       # required attributes
-      attribute :queries, Attributes::QueryArray[Daedal::Queries::BaseQuery], default: Array.new
+      attribute :queries, Attributes::QueryArray, default: Array.new
   
       # non required attributes
       attribute :tie_breaker, Float, required: false
       attribute :boost, Integer, required: false
+      attribute :name, Symbol, required: false
   
       def to_hash
         result = {dis_max: {queries: queries.map {|q| q.to_hash }}}
-        options = {tie_breaker: tie_breaker, boost: boost}
+        options = {tie_breaker: tie_breaker, boost: boost, _name: name}
         result[:dis_max].merge!(options.select { |k,v| !v.nil? })
   
         result

data/lib/daedal/queries/filtered_query.rb

@@ -9,8 +9,8 @@ module Daedal
     class FilteredQuery < BaseQuery
   
       # required attributes
-      attribute :query, Daedal::Queries::BaseQuery, default: Daedal::Queries::MatchAllQuery.new
-      attribute :filter, Daedal::Filters::BaseFilter, default: Daedal::Filters::BaseFilter.new
+      attribute :query, Attributes::Query, default: Daedal::Queries::MatchAllQuery.new
+      attribute :filter, Attributes::Filter, default: Daedal::Filters::BaseFilter.new
   
       def to_hash
         {filtered: {query: query.to_hash, filter: filter.to_hash}}

data/lib/daedal/queries/match_query.rb

@@ -19,11 +19,12 @@ module Daedal
       attribute :analyzer, Symbol, required: false
       attribute :boost, Integer, required: false
       attribute :fuzziness, Float, required: false
+      attribute :slop, Integer, required: false
   
       def to_hash
   
         result = {match: {field => {query: query}}}
-        options = {minimum_should_match: minimum_should_match, cutoff_frequency: cutoff_frequency, type: type, analyzer: analyzer, boost: boost, fuzziness: fuzziness, operator: operator}
+        options = {minimum_should_match: minimum_should_match, cutoff_frequency: cutoff_frequency, type: type, analyzer: analyzer, boost: boost, fuzziness: fuzziness, operator: operator, slop: slop}
         result[:match][field].merge! options.select {|k,v| !v.nil?}
   
         result

data/lib/daedal/queries/nested_query.rb

@@ -8,16 +8,16 @@ module Daedal
   
       # required attributes
       attribute :path, Symbol
-      attribute :query, Daedal::Queries::BaseQuery
+      attribute :query, Attributes::Query
   
       # non required attributes
       attribute :score_mode, Attributes::ScoreMode, required: false
+      attribute :name, Symbol, required: false
   
       def to_hash
         result = {nested: {path: path, query: query.to_hash}}
-        unless score_mode.nil?
-          result[:nested][:score_mode] = score_mode
-        end
+        options = {score_mode: score_mode, _name: name}
+        result[:nested].merge!(options.select { |k,v| !v.nil? })
 
         result
       end

data/lib/daedal/queries/prefix_query.rb

@@ -0,0 +1,25 @@
+require 'daedal/queries/base_query'
+require 'daedal/attributes'
+
+module Daedal
+  module Queries
+    """Class for the prefix query"""
+    class PrefixQuery < BaseQuery
+  
+      # required attributes
+      attribute :field, Symbol
+      attribute :query, Attributes::LowerCaseString
+
+      # non required attributes
+      attribute :boost, Float, required: false
+  
+      def to_hash
+        result = {prefix: {field => query}}
+        options = {boost: boost}
+        result[:prefix].merge!(options.select { |k,v| !v.nil? })
+
+        result
+      end
+    end
+  end
+end