daedal 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee41dfa3c33abb94b45a246a59dd12b9ed45a278
+  data.tar.gz: 4ec21b922bb6b1e9fcd5cb94f6effad2159d8d70
+SHA512:
+  metadata.gz: 0676d06f03db74a4cf9fe0fa016f0d7197d75fc1a1c2acb21780e5b22191ff9a487f9022580a412943b62f968b8d19f9264b3a3ece0cc719475e5a70a74c47d2
+  data.tar.gz: c7a4f7ece2fa6d1aebc00fdad3b095ff22b529a84aba9440124b6d5b607da38ce62c117cad8905a1b476fb8cfdee085e94dc27a3e9b86f09c446224f7279c0b8

data/.gitignore

@@ -0,0 +1,14 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+.rvmrc
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--profile
+--color
+--format Fuubar

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'guard'
+gem 'guard-rspec'
+gem 'require_all'
+gem 'fuubar'
+gem 'debugger'
+gem 'virtus', '1.0.0'

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    axiom-types (0.0.5)
+      descendants_tracker (~> 0.0.1)
+      ice_nine (~> 0.9)
+    backports (3.3.5)
+    coderay (1.0.9)
+    coercible (0.2.0)
+      backports (~> 3.0, >= 3.1.0)
+      descendants_tracker (~> 0.0.1)
+    columnize (0.3.6)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.4)
+    equalizer (0.0.8)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    fuubar (1.2.1)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    ice_nine (0.10.0)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    require_all (1.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.14.3)
+    ruby-progressbar (1.2.0)
+    slop (3.4.6)
+    thor (0.18.1)
+    virtus (1.0.0)
+      axiom-types (~> 0.0.5)
+      coercible (~> 0.2)
+      descendants_tracker (~> 0.0.1)
+      equalizer (~> 0.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  fuubar
+  guard
+  guard-rspec
+  require_all
+  rspec
+  virtus (= 1.0.0)

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 cschuch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+Daedal
+=====================
+
+Ruby classes for easier ElasticSearch query building

data/daedal.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'daedal'
+  s.version     = '0.0.2'
+  s.date        = '2013-12-06'
+  s.summary     = "ElasticSearch Query DSL Builders"
+  s.description = "Classes for easier ElasticSearch query creation"
+  s.authors     = ["Christopher Schuch"]
+  s.email       = 'cas13091@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.license     = 'MIT'
+  s.homepage    =
+    'https://github.com/cschuch/daedal'
+end

data/lib/daedal.rb

@@ -0,0 +1,8 @@
+require 'json'
+require 'daedal/queries'
+require 'daedal/filters'
+require 'daedal/attributes'
+
+module Daedal
+
+end

data/lib/daedal/attributes.rb

@@ -0,0 +1,94 @@
+require 'virtus'
+require 'daedal/queries/base_query'
+require 'daedal/filters/base_filter'
+
+module Daedal
+  module Attributes
+
+    """Custom coercer for a query, allowing nil"""
+    class QueryOrNil < Virtus::Attribute
+      def coerce(value)
+        unless value.is_a? Daedal::Queries::BaseQuery or value.nil?
+          raise "Invalid query"
+        end
+        value
+      end
+    end
+
+    """Custom coercer for a filter, allowing nil"""
+    class FilterOrNil < Virtus::Attribute
+      def coerce(value)
+        unless value.is_a? Daedal::Filters::BaseFilter or value.nil?
+          raise "Invalid filter"
+        end
+        value
+      end
+    end
+
+    """Custom coercer for a query"""
+    class Query < Virtus::Attribute
+      def coerce(value)
+        unless value.is_a? Daedal::Queries::BaseQuery
+          raise "Must give a query"
+        end
+        value
+      end
+    end
+
+    """Custom coercer for a filter"""
+    class Filter < Virtus::Attribute
+      def coerce(value)
+        unless value.is_a? Daedal::Filters::BaseFilter
+          raise "Must give a filter"
+        end
+        value
+      end
+    end
+
+    """Custom coercer for an array of queries"""
+    class QueryArray < Virtus::Attribute
+      def coerce(value)
+        unless value.is_a? Array
+          value = [value]
+        end
+
+        value.each do |q|
+          unless q.is_a? Daedal::Queries::BaseQuery
+            raise "Must give an array of queries"
+          end
+        end
+
+        value
+      end
+    end
+
+    """Custom coercer for the operator attribute"""
+    class Operator < Virtus::Attribute
+      ALLOWED_MATCH_OPERATORS = [:or, :and]
+      def coerce(value)
+        unless value.nil?
+          value = value.to_sym
+          unless ALLOWED_MATCH_OPERATORS.include? value
+            raise "#{value} is not a valid operator. Allowed values are #{ALLOWED_MATCH_OPERATORS}."
+          end
+        end
+        value
+      end
+    end
+  
+    """Custom coercer for the type attribute"""
+    class MatchType < Virtus::Attribute
+      ALLOWED_MATCH_TYPES = [:phrase, :phrase_prefix]
+      def coerce(value)
+        unless value.nil?
+          value = value.to_sym
+          unless ALLOWED_MATCH_TYPES.include? value
+            raise "#{value} is not a valid type. Allowed values are #{ALLOWED_MATCH_TYPES}."
+          end
+        end
+        value
+      end
+    end
+
+  end
+end

data/lib/daedal/filters.rb

@@ -0,0 +1,7 @@
+require 'daedal/filters/base_filter'
+require 'daedal/filters/term_filter'
+
+module Daedal
+  module Filters
+  end
+end

data/lib/daedal/filters/base_filter.rb

@@ -0,0 +1,17 @@
+require 'virtus'
+
+module Daedal
+  module Filters
+    class BaseFilter
+      include Virtus.model strict: true
+
+      def to_hash
+        {}
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+    end
+  end
+end

data/lib/daedal/filters/term_filter.rb

@@ -0,0 +1,18 @@
+require 'daedal/filters/base_filter'
+require 'daedal/attributes'
+
+module Daedal
+  module Filters
+    """Class for the basic match query"""
+    class TermFilter < BaseFilter
+  
+      # required attributes
+      attribute :field, Symbol
+      attribute :term, Symbol
+  
+      def to_hash
+        {term: {field => term}}
+      end
+    end
+  end
+end

data/lib/daedal/queries.rb

@@ -0,0 +1,13 @@
+require 'daedal/queries/base_query'
+require 'daedal/queries/bool_query'
+require 'daedal/queries/constant_score_query'
+require 'daedal/queries/dis_max_query'
+require 'daedal/queries/filtered_query'
+require 'daedal/queries/match_all_query'
+require 'daedal/queries/match_query'
+require 'daedal/queries/multi_match_query'
+
+module Daedal
+  module Queries
+  end
+end

data/lib/daedal/queries/base_query.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+
+module Daedal
+  module Queries
+    class BaseQuery
+      include Virtus.model strict: true
+
+      def to_json
+        to_hash.to_json
+      end
+    end
+  end
+end

data/lib/daedal/queries/bool_query.rb

@@ -0,0 +1,48 @@
+require 'daedal/queries/base_query'
+require 'daedal/attributes'
+
+module Daedal
+  module Queries
+    """Class for the basic match query"""
+    class BoolQuery < BaseQuery
+  
+      # required attributes
+      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
+  
+      def verify_query(q)
+        unless q.is_a? Daedal::Queries::BaseQuery
+          raise "Must give a valid query"
+        end
+      end
+  
+      def add_should_query(q)
+        verify_query(q)
+        should << q
+      end
+  
+      def add_must_query(q)
+        verify_query(q)
+        must << q
+      end
+  
+      def add_must_not_query(q)
+        verify_query(q)
+        must_not << q
+      end
+  
+      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}
+        result[:bool].merge!(options.select { |k,v| !v.nil? })
+  
+        result
+      end
+    end
+  end
+end

data/lib/daedal/queries/constant_score_query.rb

@@ -0,0 +1,35 @@
+require 'daedal/queries/base_query'
+require 'daedal/attributes'
+
+module Daedal
+  module Queries
+    """Class for the basic match query"""
+    class ConstantScoreQuery < BaseQuery
+
+      # required attributes
+      attribute :boost, Float
+
+      # non required attributes, but one must be required of the two
+      attribute :query, Attributes::QueryOrNil
+      attribute :filter, Attributes::FilterOrNil
+
+      def initialize(options={})
+        super options
+        if query.nil? && filter.nil?
+          raise "Must give a query or a filter"
+        end
+      end
+  
+      def to_hash
+        result = {constant_score: {boost: boost}}
+        if !query.nil?
+          result[:constant_score][:query] = query.to_hash
+        elsif !filter.nil?
+          result[:constant_score][:filter] = filter.to_hash
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/daedal/queries/dis_max_query.rb

@@ -0,0 +1,37 @@
+require 'daedal/queries/base_query'
+require 'daedal/attributes'
+
+module Daedal
+  module Queries
+
+    """Class for the basic match query"""
+    class DisMaxQuery < BaseQuery
+  
+      # required attributes
+      attribute :queries, Attributes::QueryArray, default: Array.new
+  
+      # non required attributes
+      attribute :tie_breaker, Float, required: false
+      attribute :boost, Integer, required: false
+  
+      def verify_query(q)
+        unless q.is_a? Daedal::Queries::BaseQuery
+          raise "Must give a valid query"
+        end
+      end
+  
+      def add_query(q)
+        verify_query(q)
+        queries << q
+      end
+  
+      def to_hash
+        result = {dis_max: {queries: queries.map {|q| q.to_hash }}}
+        options = {tie_breaker: tie_breaker, boost: boost}
+        result[:dis_max].merge!(options.select { |k,v| !v.nil? })
+  
+        result
+      end
+    end
+  end
+end