stretchy 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 213d84388de53cfe8d9b815d34ef544349cb2bd0
-  data.tar.gz: 5cdfb873ac77da2e9815c7ac3f36da1dc27889e8
+  metadata.gz: 28c98af055eaf32fb6c23460780f168e66c894bb
+  data.tar.gz: 54af860b9fca236b64c2d95f3acbd13bde7b5f47
 SHA512:
-  metadata.gz: 590ee2ca8abb6251effe21b6561a29459f80a6e4361158c9d0103c80dc0594a97b00c5c8b77b51beea296ce21350274b5a4ab128e40e010b5fb00b8cb289449b
-  data.tar.gz: e60c32da5e5cf45553f9f2163c0764d6ba0653b22d1e1942a28d777e61f81dca8585dd43c24ac9390a89a13ffe9be954bf598f11b0bf0e817555b43d535d399a
+  metadata.gz: b1a8077918cd57cb1294f9340716d2b20d14ce4ebaf01c96eb6e535011ebe4dafcccc013ae4ce201120f5fabe75498c823b29825a1471bf8cdc11cbe99204b23
+  data.tar.gz: ab509f01cfc5f0a97dd522a3ad1bd9ba34bd1c0bbdc4b863d81b78ec386f8f86fc1d3d947d53c748af5ba71f4e27ed195b80f5000e64da8be8ec8c098381064a

data/lib/stretchy/boosts/base.rb

@@ -0,0 +1,17 @@
+module Stretchy
+  module Boosts
+    class Base
+
+      include Stretchy::Utils::Contract
+
+      def initialize
+        raise "Override this in subclass"
+      end
+
+      def to_search
+        raise "Override this in subclass"
+      end
+
+    end
+  end
+end

data/lib/stretchy/boosts/filter_boost.rb

@@ -1,12 +1,16 @@
 module Stretchy
   module Boosts
-    class FilterBoost
+    class FilterBoost < Base
 
       DEFAULT_WEIGHT = 1.2
 
+      contract filter: {type: Stretchy::Filters::Base},
+               weight: {type: Numeric}
+
       def initialize(filter:, weight: DEFAULT_WEIGHT)
         @filter = filter
         @weight = weight
+        validate!
       end
 
       def to_search

data/lib/stretchy/boosts/geo_boost.rb

@@ -1,6 +1,6 @@
 module Stretchy
   module Boosts
-    class GeoBoost
+    class GeoBoost < Base
 
       DEFAULTS = {
         field: 'coords',
@@ -10,6 +10,13 @@ module Stretchy
         weight: 1.2
       }.freeze
 
+      contract offset: {type: :distance},
+                scale: {type: :distance},
+                decay: {type: Numeric},
+               weight: {type: Numeric},
+                  lat: {type: :lat},
+                  lng: {type: :lng}
+
       def initialize(options = {})
         @field  = options[:field]   || DEFAULTS[:field]
         @offset = options[:offset]  || DEFAULTS[:offset]
@@ -18,6 +25,7 @@ module Stretchy
         @weight = options[:weight]  || DEFAULTS[:weight]
         @lat    = options[:lat]
         @lng    = options[:lng]
+        validate!
       end
 
       def to_search

data/lib/stretchy/boosts/random_boost.rb

@@ -1,15 +1,19 @@
 module Stretchy
   module Boosts
-    class RandomBoost
+    class RandomBoost < Base
 
       DEFAULT_WEIGHT = 1.2
 
+      contract seed: {type: Numeric},
+             weight: {type: Numeric}
+
       # randomizes order (somewhat) consistently per-user
       # http://www.elastic.co/guide/en/elasticsearch/guide/current/random-scoring.html
 
       def initialize(seed, weight = DEFAULT_WEIGHT)
         @seed   = seed
         @weight = weight
+        validate!
       end
 
       def to_search

data/lib/stretchy/errors/contract_error.rb

@@ -0,0 +1,5 @@
+module Stretchy
+  module Errors
+    class ContractError < StandardError ; end
+  end
+end

data/lib/stretchy/filters/and_filter.rb

@@ -1,9 +1,12 @@
 module Stretchy
   module Filters
-    class AndFilter
+    class AndFilter < Base
+
+      contract filters: {type: Stretchy::Filters::Base, array: true}
 
       def initialize(filters)
         @filters = Array(filters)
+        validate!
       end
 
       def to_search

data/lib/stretchy/filters/base.rb

@@ -0,0 +1,17 @@
+module Stretchy
+  module Filters
+    class Base
+
+      include Stretchy::Utils::Contract
+
+      def initialize
+        raise "Override this in subclass"
+      end
+
+      def to_search
+        raise "Override this in subclass"
+      end
+
+    end
+  end
+end

data/lib/stretchy/filters/bool_filter.rb

@@ -1,10 +1,16 @@
 module Stretchy
   module Filters
-    class BoolFilter
+    class BoolFilter < Base
+
+      contract must: {type: Base, array: true},
+           must_not: {type: Base, array: true},
+             should: {type: Base, array: true}
+
       def initialize(must:, must_not:, should: nil)
         @must     = Array(must)
         @must_not = Array(must_not)
         @should   = Array(should)
+        validate!
       end
 
       def to_search

data/lib/stretchy/filters/exists_filter.rb

@@ -1,6 +1,6 @@
 module Stretchy
   module Filters
-    class ExistsFilter
+    class ExistsFilter < Base
 
       # CAUTION: this will match empty strings
       # see http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-filter.html

data/lib/stretchy/filters/geo_filter.rb

@@ -1,11 +1,18 @@
 module Stretchy
   module Filters
-    class GeoFilter
+    class GeoFilter < Base
+
+      contract distance: {type: :distance},
+                    lat: {type: :lat},
+                    lng: {type: :lng},
+                  field: {type: :field}
+
       def initialize(field: 'coords', distance: '50km', lat:, lng:)
         @field    = field
         @distance = distance
         @lat      = lat
         @lng      = lng
+        validate!
       end
 
       def to_search

data/lib/stretchy/filters/not_filter.rb

@@ -1,6 +1,8 @@
 module Stretchy
   module Filters
-    class NotFilter
+    class NotFilter < Base
+
+      contract :filter, type: Base
 
       def initialize(filters)
         filters = Array(filters)
@@ -10,6 +12,8 @@ module Stretchy
         else
           @filter = AndFilter.new(filters)
         end
+
+        validate!
       end
 
       def to_search

data/lib/stretchy/filters/query_filter.rb

@@ -1,9 +1,12 @@
 module Stretchy
   module Filters
-    class QueryFilter
+    class QueryFilter < Base
+
+      contract :query, type: Stretchy::Queries::Base
 
       def initialize(query)
         @query = query
+        validate!
       end
 
       def to_search

data/lib/stretchy/filters/range_filter.rb

@@ -1,6 +1,11 @@
 module Stretchy
   module Filters
-    class RangeFilter
+    class RangeFilter < Base
+
+      contract field: {type: :field},
+                 min: {type: Numeric},
+                 max: {type: Numeric}
+
       def initialize(field:, min:, max:)
         @field = field
         @min   = min

data/lib/stretchy/filters/terms_filter.rb

@@ -1,10 +1,14 @@
 module Stretchy
   module Filters
-    class TermsFilter
+    class TermsFilter < Base
+
+      contract field: {type: :field},
+              values: {type: Array}
 
       def initialize(field:, values:)
         @field = field
         @values = Array(values)
+        validate!
       end
 
       def to_search

data/lib/stretchy/queries/base.rb

@@ -0,0 +1,17 @@
+module Stretchy
+  module Queries
+    class Base
+
+      include Stretchy::Utils::Contract
+
+      def initialize
+        raise "Override this in subclass"
+      end
+
+      def to_search
+        raise "Override this in subclass"
+      end
+
+    end
+  end
+end

data/lib/stretchy/queries/filtered_query.rb

@@ -1,10 +1,14 @@
 module Stretchy
   module Queries
-    class FilteredQuery
+    class FilteredQuery < Base
+
+      contract query: {type: Base},
+              filter: {type: Stretchy::Filters::Base}
 
       def initialize(query: nil, filter:)
         @query  = query
         @filter = filter
+        validate!
       end
 
       def to_search

data/lib/stretchy/queries/function_score_query.rb

@@ -1,10 +1,19 @@
 module Stretchy
   module Queries
-    class FunctionScoreQuery
+    class FunctionScoreQuery < Base
 
       SCORE_MODES = %w(multiply sum avg first max min)
       BOOST_MODES = %w(multiply replace sum avg max min)
 
+      contract functions: {responds_to: :to_search, array: true},
+                   query: {type: Base},
+                  filter: {type: Stretchy::Filters::Base},
+              score_mode: {type: String, in: SCORE_MODES},
+              boost_mode: {type: String, in: BOOST_MODES},
+               min_score: {type: Numeric},
+               max_boost: {type: Numeric},
+                   boost: {type: Numeric}
+
       def initialize(options = {})
         @functions  = Array(options[:functions])
         @query      = options[:query]
@@ -13,36 +22,17 @@ module Stretchy
         self.class.attributes.map do |field|
           instance_variable_set("@#{field}", options[field])
         end
-        validate
+        validate!
+        validate_query_or_filter
       end
 
       def self.attributes
         [:boost, :max_boost, :score_mode, :boost_mode, :min_score]
       end
 
-      def validate
+      def validate_query_or_filter
         if @query && @filter
-          raise ArgumentError.new("Cannot have both query and filter -- combine using a FilteredQuery")
-        end
-
-        if @boost && !@boost.is_a?(Numeric)
-          raise ArgumentError.new("Boost must be a number - it is the global boost for the whole query")
-        end
-
-        if @max_boost && !@max_boost.is_a?(Numeric)
-          raise ArgumentError.new("Max boost must be a number")
-        end
-
-        if @min_score && !@min_score.is_a?(Numeric)
-          raise ArgumentError.new("min_score must be a number - it is the global boost for the whole query")
-        end
-
-        if @score_mode && !SCORE_MODES.include?(@score_mode)
-          raise ArgumentError.new("Score mode must be one of #{SCORE_MODES.join(', ')}")
-        end
-
-        if @boost_mode && !BOOST_MODES.include?(@boost_mode)
-          raise ArgumentError.new("Score mode must be one of #{BOOST_MODES.join(', ')}")
+          raise Stretchy::Errors::ContractError.new "Cannot have both query and filter -- combine using a FilteredQuery"
         end
       end
 

data/lib/stretchy/queries/match_all_query.rb

@@ -1,6 +1,10 @@
 module Stretchy
   module Queries
-    class MatchAllQuery
+    class MatchAllQuery < Base
+
+      def initialize
+      end
+      
       def to_search
         { match_all: {} }
       end

data/lib/stretchy/queries/match_query.rb

@@ -1,11 +1,18 @@
 module Stretchy
   module Queries
-    class MatchQuery
+    class MatchQuery < Base
+
+      OPERATORS = ['and', 'or']
+
+      contract field: {type: :field},
+            operator: {type: String, in: OPERATORS},
+              string: {type: String}
 
       def initialize(string, field: '_all', operator: 'and')
         @field    = field
         @operator = operator
         @string   = string
+        validate!
       end
 
       def to_search

data/lib/stretchy/query.rb

@@ -145,7 +145,7 @@ module Stretchy
     end
 
     def match(string, options = {})
-      return self if string.empty?
+      return self if string.nil? || string.empty?
       field     = options[:field] || '_all'
       operator  = options[:operator] || 'and'
       clone_with(match: Queries::MatchQuery.new(string, field: field, operator: operator))

data/lib/stretchy/utils/client_actions.rb

@@ -0,0 +1,63 @@
+require 'json'
+module Stretchy
+  module Utils
+    module ClientActions
+
+      def self.extended(base)
+        unless base.respond_to?(:client) && base.respond_to?(:index_name)
+          raise "ClientActions requires methods 'client' and 'index_name'"
+        end
+      end
+
+      # used for ensuring a concistent index in specs
+      def refresh
+        client.indices.refresh index: index_name
+      end
+
+      def count
+        client.cat.count(index: index_name).split(' ')[2].to_i
+      end
+
+      def search(type:, body:, fields: nil)
+        options = { index: index_name, type: type, body: body }
+        options[:fields] = fields if fields.is_a?(Array)
+
+        client.search(options)
+      end
+
+      def index(type:, body:, id: nil)
+        id ||= body['id'] || body['_id'] || body[:id] || body[:_id]
+        client.index(index: index_name, type: type, id: id, body: body)
+      end
+
+      def bulk(type:, documents:)
+        requests = documents.flat_map do |document|
+          id = document['id'] || document['_id'] || document[:id] || document[:_id]
+          [
+            { index: { '_index' => index_name, '_type' => type, '_id' => id } },
+            document
+          ]
+        end
+        client.bulk body: requests
+      end
+
+      def exists(_index_name = index_name)
+        client.indices.exists(index: _index_name)
+      end
+      alias :exists? :exists
+
+      def delete(_index_name = index_name)
+        client.indices.delete(index: _index_name) if exists?(_index_name)
+      end
+
+      def create(_index_name = index_name)
+        client.indices.create(index: _index_name) unless exists?(_index_name)
+      end
+
+      def mapping(_index_name, _type, _body)
+        client.indices.put_mapping(index: _index_name, type: _type, body: _body)
+      end
+
+    end
+  end
+end

data/lib/stretchy/utils/configuration.rb

@@ -0,0 +1,36 @@
+module Stretchy
+  module Utils
+    module Configuration
+      
+      attr_accessor :index_name, :logger, :url, :adapter, :client
+
+      def self.extended(base)
+        base.set_default_configuration
+      end
+
+      def configure
+        yield self
+      end
+
+      def set_default_configuration
+        self.index_name = 'myapp'
+        self.adapter =    :excon
+        self.url =        ENV['ELASTICSEARCH_URL']
+      end
+
+      def client_options
+        Hash[
+          index_name: index_name,
+          log:        !!logger,
+          logger:     logger,
+          adapter:    adapter,
+          url:        url
+        ]
+      end
+
+      def client(options = {})
+        @client ||= Elasticsearch::Client.new(client_options.merge(options))
+      end
+    end
+  end
+end

data/lib/stretchy/utils/contract.rb

@@ -0,0 +1,100 @@
+module Stretchy
+  module Utils
+    module Contract
+
+      ASSERTIONS = [:type, :responds_to, :in, :matches, :required]
+      DISTANCE_FORMAT = /^(\d+)(km|mi)$/
+
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+
+      def validate!
+        self.class.contracts.each do |name, options|
+          value = instance_variable_get("@#{name}")
+          next if value.nil? && !options[:required]
+          
+          if options[:array]
+            self.class.assert_type(name, value, type: Array)
+          end
+
+          ASSERTIONS.each do |assertion|
+            assertion_method = "assert_#{assertion}"
+            if options[:array]
+              value.each {|v| self.class.send(assertion_method, name, v, options) } unless options[assertion].nil?
+            else
+              self.class.send(assertion_method, name, value, options) unless options[assertion].nil?
+            end
+          end
+        end
+      end
+
+      module ClassMethods
+
+        attr_reader :contracts
+
+        def contract(var, options = {})
+          @contracts ||= {}
+          if var.is_a?(Hash)
+            var.each {|k,v| @contracts[k] = v }
+          else
+            @contracts[var] = options
+          end
+        end
+
+        def fail_assertion(msg)
+          raise Stretchy::Errors::ContractError.new(msg)
+        end
+
+        def assert_required(name, value, options)
+          msg = "Expected to have param #{name}, but got nil"
+          fail_assertion(msg) if msg.nil?
+        end
+
+        def assert_type(name, value, options)
+          type = options[:type]
+          case type
+          when :distance
+            msg = "Expected #{name} to be a distance measure, but #{value} is not a valid distance"
+            fail_assertion(msg) unless value.match(DISTANCE_FORMAT)
+          when :lat
+            msg = "Expected #{name} to be between 90 and -90, but was #{value}"
+            value = Float(value) rescue nil
+            fail_assertion(msg) unless value && value <= 90 && value >= -90
+          when :lng 
+            msg = "Expected #{name} to be between 180 and -180, but was #{value}"
+            value = Float(value) rescue nil
+            fail_assertion(msg) unless value && value.to_f <= 180 && value.to_f >= -180
+          when :field
+            msg = "Expected #{name} to be a string, symbol, or number, but got #{value.class.name}"
+            fail_assertion(msg) unless value.is_a?(String) || value.is_a?(Symbol) || value.is_a?(Numeric)
+
+            msg = "Expected #{name} to be a string, symbol, or number, but was blank"
+            fail_assertion(msg) if value.is_a?(String) && value.empty?
+          else
+            msg = "Expected #{name} to be of type #{type}, but found #{value.class.name}"
+            fail_assertion(msg) unless value.is_a?(type)
+          end
+        end
+
+        def assert_responds_to(name, value, options)
+          method = options[:responds_to]
+          msg = "Expected #{name} to respond_to #{method}, but #{value.class.name} does not"
+          fail_assertion(msg) unless value.respond_to?(method)
+        end
+
+        def assert_in(name, value, options)
+          collection = options[:in]
+          msg = "Expected #{name} to be one of #{collection}, but got #{value}"
+          fail_assertion(msg) unless collection.include?(value)
+        end
+
+        def assert_matches(name, value, options)
+          matcher = options[:matches]
+          msg = "Expected #{name} to match #{matcher}, but #{value} does not"
+          fail_assertion(msg) unless matcher.match(value)
+        end
+      end
+    end
+  end
+end

data/lib/stretchy/version.rb

@@ -1,3 +1,3 @@
 module Stretchy
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/stretchy.rb

@@ -3,12 +3,20 @@ require 'logger'
 require 'excon'
 require 'elasticsearch'
 
+require 'stretchy/utils/contract'
+require 'stretchy/utils/configuration'
+require 'stretchy/utils/client_actions'
+require 'stretchy/boosts/base'
+require 'stretchy/filters/base'
+require 'stretchy/queries/base'
+
 Dir[File.join(File.dirname(__FILE__), 'stretchy', '**', '*.rb')].each do |path|
-  require path
+  require path unless path =~ /utils/ || path =~ /base/
 end
 
 module Stretchy
-  extend Configuration
-  extend ClientActions
+
+  extend Utils::Configuration
+  extend Utils::ClientActions
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - agius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -109,12 +109,13 @@ files:
 - bin/console
 - bin/setup
 - lib/stretchy.rb
+- lib/stretchy/boosts/base.rb
 - lib/stretchy/boosts/filter_boost.rb
 - lib/stretchy/boosts/geo_boost.rb
 - lib/stretchy/boosts/random_boost.rb
-- lib/stretchy/client_actions.rb
-- lib/stretchy/configuration.rb
+- lib/stretchy/errors/contract_error.rb
 - lib/stretchy/filters/and_filter.rb
+- lib/stretchy/filters/base.rb
 - lib/stretchy/filters/bool_filter.rb
 - lib/stretchy/filters/exists_filter.rb
 - lib/stretchy/filters/geo_filter.rb
@@ -123,12 +124,16 @@ files:
 - lib/stretchy/filters/range_filter.rb
 - lib/stretchy/filters/terms_filter.rb
 - lib/stretchy/null_query.rb
+- lib/stretchy/queries/base.rb
 - lib/stretchy/queries/filtered_query.rb
 - lib/stretchy/queries/function_score_query.rb
 - lib/stretchy/queries/match_all_query.rb
 - lib/stretchy/queries/match_query.rb
 - lib/stretchy/query.rb
 - lib/stretchy/request_body.rb
+- lib/stretchy/utils/client_actions.rb
+- lib/stretchy/utils/configuration.rb
+- lib/stretchy/utils/contract.rb
 - lib/stretchy/version.rb
 - stretchy.gemspec
 homepage: https://github.com/hired/stretchy

data/lib/stretchy/client_actions.rb

@@ -1,61 +0,0 @@
-require 'json'
-module Stretchy
-  module ClientActions
-
-    def self.extended(base)
-      unless base.respond_to?(:client) && base.respond_to?(:index_name)
-        raise "ClientActions requires methods 'client' and 'index_name'"
-      end
-    end
-
-    # used for ensuring a concistent index in specs
-    def refresh
-      client.indices.refresh index: index_name
-    end
-
-    def count
-      client.cat.count(index: index_name).split(' ')[2].to_i
-    end
-
-    def search(type:, body:, fields: nil)
-      options = { index: index_name, type: type, body: body }
-      options[:fields] = fields if fields.is_a?(Array)
-
-      client.search(options)
-    end
-
-    def index(type:, body:, id: nil)
-      id ||= body['id'] || body['_id'] || body[:id] || body[:_id]
-      client.index(index: index_name, type: type, id: id, body: body)
-    end
-
-    def bulk(type:, documents:)
-      requests = documents.flat_map do |document|
-        id = document['id'] || document['_id'] || document[:id] || document[:_id]
-        [
-          { index: { '_index' => index_name, '_type' => type, '_id' => id } },
-          document
-        ]
-      end
-      client.bulk body: requests
-    end
-
-    def exists(_index_name = index_name)
-      client.indices.exists(index: _index_name)
-    end
-    alias :exists? :exists
-
-    def delete(_index_name = index_name)
-      client.indices.delete(index: _index_name) if exists?(_index_name)
-    end
-
-    def create(_index_name = index_name)
-      client.indices.create(index: _index_name) unless exists?(_index_name)
-    end
-
-    def mapping(_index_name, _type, _body)
-      client.indices.put_mapping(index: _index_name, type: _type, body: _body)
-    end
-
-  end
-end

data/lib/stretchy/configuration.rb

@@ -1,34 +0,0 @@
-module Stretchy
-  module Configuration
-    
-    attr_accessor :index_name, :logger, :url, :adapter, :client
-
-    def self.extended(base)
-      base.set_default_configuration
-    end
-
-    def configure
-      yield self
-    end
-
-    def set_default_configuration
-      self.index_name = 'myapp'
-      self.adapter =    :excon
-      self.url =        ENV['ELASTICSEARCH_URL']
-    end
-
-    def client_options
-      Hash[
-        index_name: index_name,
-        log:        !!logger,
-        logger:     logger,
-        adapter:    adapter,
-        url:        url
-      ]
-    end
-
-    def client(options = {})
-      @client ||= Elasticsearch::Client.new(client_options.merge(options))
-    end
-  end
-end