slingshot-rb 0.0.8 → 0.0.9

data/lib/slingshot/model/persistence/finders.rb

@@ -0,0 +1,61 @@
+module Slingshot
+  module Model
+
+    module Persistence
+
+      module Finders
+
+        module ClassMethods
+
+          def find *args
+            # TODO: Options like `sort`
+            old_wrapper = Slingshot::Configuration.wrapper
+            Slingshot::Configuration.wrapper self
+            options = args.pop if args.last.is_a?(Hash)
+            args.flatten!
+            if args.size > 1
+              Slingshot::Search::Search.new(index.name).query do |query|
+                query.ids(args, document_type)
+              end.perform.results
+            else
+              case args = args.pop
+                when Fixnum, String
+                  Index.new(index_name).retrieve document_type, args
+                when :all, :first
+                  send(args)
+                else
+                  raise ArgumentError, "Please pass either ID as Fixnum or String, or :all, :first as an argument"
+              end
+            end
+          ensure
+            Slingshot::Configuration.wrapper old_wrapper
+          end
+
+          def all
+            # TODO: Options like `sort`; Possibly `filters`
+            old_wrapper = Slingshot::Configuration.wrapper
+            Slingshot::Configuration.wrapper self
+            s = Slingshot::Search::Search.new(index_name).query { all }
+            s.perform.results
+          ensure
+            Slingshot::Configuration.wrapper old_wrapper
+          end
+
+          def first
+            # TODO: Options like `sort`; Possibly `filters`
+            old_wrapper = Slingshot::Configuration.wrapper
+            Slingshot::Configuration.wrapper self
+            s = Slingshot::Search::Search.new(index_name).query { all }.size(1)
+            s.perform.results.first
+          ensure
+            Slingshot::Configuration.wrapper old_wrapper
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/slingshot/model/persistence/storage.rb

@@ -0,0 +1,75 @@
+module Slingshot
+  module Model
+
+    module Persistence
+
+      module Storage
+
+        def self.included(base)
+
+          base.class_eval do
+            extend  ClassMethods
+            include InstanceMethods            
+          end
+
+        end
+
+        module ClassMethods
+
+          def create(args={})
+            document    = new(args)
+            return false unless document.valid?
+            document.save
+            document
+          end
+
+          def index
+            @index = Index.new(index_name)
+          end
+
+        end
+
+        module InstanceMethods
+
+          def update_attribute(name, value)
+            send("#{name}=", value)
+            save
+          end
+
+          def update_attributes(attributes={})
+            attributes.each do |name, value|
+              send("#{name}=", value)
+            end
+            save
+          end
+
+          def save
+            return false unless valid?
+            run_callbacks :save do
+              # Document#id is set in the +update_elastic_search_index+ method,
+              # where we have access to the JSON response
+            end
+            self
+          end
+
+          def destroy
+            run_callbacks :destroy do
+              @destroyed = true
+            end
+            self.freeze
+          end
+
+          # TODO: Implement `new_record?` and clean up
+
+          def destroyed?; !!@destroyed; end
+
+          def persisted?; !!id;           end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/slingshot/model/search.rb

@@ -0,0 +1,97 @@
+module Slingshot
+  module Model
+
+    module Search
+
+      def self.included(base)
+        base.class_eval do
+          extend  Slingshot::Model::Naming::ClassMethods
+          include Slingshot::Model::Naming::InstanceMethods
+
+          extend  Slingshot::Model::Indexing::ClassMethods
+          extend  Slingshot::Model::Import::ClassMethods
+
+          extend  ClassMethods
+          include InstanceMethods
+
+          ['_score', '_type', '_index', '_version', 'sort', 'highlight'].each do |attr|
+            # TODO: Find a sane way to add attributes like _score for ActiveRecord -
+            #       `define_attribute_methods [attr]` does not work in AR.
+            define_method("#{attr}=") { |value| @attributes ||= {}; @attributes[attr] = value }
+            define_method("#{attr}")  { @attributes[attr] }
+          end
+        end
+      end
+
+      module ClassMethods
+
+        def search(query=nil, options={}, &block)
+          old_wrapper = Slingshot::Configuration.wrapper
+          Slingshot::Configuration.wrapper self
+          sort  = options[:order] || options[:sort]
+          sort  = Array(sort)
+          unless block_given?
+            s = Slingshot::Search::Search.new(index.name, options)
+            s.query { string query }
+            s.sort do
+              sort.each do |t|
+                field_name, direction = t.split(' ')
+                field_name.include?('.') ? field(field_name, direction) : send(field_name, direction)
+              end
+            end unless sort.empty?
+            s.size( options[:per_page].to_i ) if options[:per_page]
+            s.from( options[:page].to_i <= 1 ? 0 : (options[:per_page].to_i * (options[:page].to_i-1)) ) if options[:page] && options[:per_page]
+            s.perform.results
+          else
+            s = Slingshot::Search::Search.new(index.name, options)
+            block.arity < 1 ? s.instance_eval(&block) : block.call(s)
+            s.perform.results
+          end
+        ensure
+          Slingshot::Configuration.wrapper old_wrapper
+        end
+
+        def index
+          @index = Index.new(index_name)
+        end
+
+      end
+
+      module InstanceMethods
+
+        def score
+          attributes['_score']
+        end
+
+        def index
+          self.class.index
+        end
+
+        def update_elastic_search_index
+          if destroyed?
+            self.class.index.remove document_type, self
+          else
+            response  = self.class.index.store  document_type, self
+            self.id ||= response['_id'] if self.respond_to?(:id=)
+            self
+          end
+        end
+
+        def to_indexed_json
+          if self.class.mapping.empty?
+            self.serializable_hash.
+              to_json
+          else
+            self.serializable_hash.
+              reject { |key, value| ! self.class.mapping.keys.map(&:to_s).include?(key.to_s) }.
+              to_json
+          end
+        end
+
+      end
+
+      extend ClassMethods
+    end
+
+  end
+end

data/lib/slingshot/results/collection.rb

@@ -3,19 +3,32 @@ module Slingshot
 
     class Collection
       include Enumerable
-      attr_reader :time, :total, :results, :facets
+      include Pagination
 
-      def initialize(response)
-        @time    = response['took']
-        @total   = response['hits']['total']
+      attr_reader :time, :total, :options, :results, :facets
+
+      def initialize(response, options={})
+        @options = options
+        @time    = response['took'].to_i
+        @total   = response['hits']['total'].to_i
         @results = response['hits']['hits'].map do |h|
-                     if Configuration.wrapper == Hash
-                       h
+                     if Configuration.wrapper == Hash then h
                      else
-                       document = h['_source'] ? h['_source'] : h['fields']
-                       document['highlight'] = h['highlight'] if h['highlight']
-                       h.update document if document
-                       Configuration.wrapper.new(h)
+                       document = {}
+
+                       # Update the document with content and ID
+                       document = h['_source'] ? document.update( h['_source'] || {} ) : document.update( h['fields'] || {} )
+                       document.update( {'id' => h['_id']} )
+
+                       # Update the document with meta information
+                       ['_score', '_version', 'sort', 'highlight'].each { |key| document.update( {key => h[key]} || {} ) }
+
+                       object = Configuration.wrapper.new(document)
+                       # TODO: Figure out how to circumvent mass assignment protection for id in ActiveRecord
+                       object.id = h['_id'] if object.respond_to?(:id=)
+                       # TODO: Figure out how mark record as "not new record" in ActiveRecord
+                       object.instance_variable_set(:@new_record, false) if object.respond_to?(:new_record?)
+                       object
                      end
                    end
         @facets  = response['facets']
@@ -25,6 +38,18 @@ module Slingshot
         @results.each(&block)
       end
 
+      def empty?
+        @results.empty?
+      end
+
+      def size
+        @results.size
+      end
+
+      def to_ary
+        self
+      end
+
     end
 
   end

data/lib/slingshot/results/item.rb

@@ -7,13 +7,9 @@ module Slingshot
       # and leaving everything else alone.
       #
       def initialize(args={})
-        if args.is_a? Hash
-          args.each_pair do |key, value|
-            self[key.to_sym] = value.is_a?(Hash) ? self.class.new(value) : value
-          end
-          super.replace self
-        else
-          super
+        raise ArgumentError, "Please pass a Hash-like object" unless args.respond_to?(:each_pair)
+        args.each_pair do |key, value|
+          self[key.to_sym] = value.respond_to?(:to_hash) ? self.class.new(value) : value
         end
       end
 
@@ -24,12 +20,19 @@ module Slingshot
         self.has_key?(method_name.to_sym) ? self[method_name.to_sym] : nil
       end
 
+      # Get ID
+      #
+      def id
+        self[:id]
+      end
+
       def inspect
         s = []; self.each { |k,v| s << "#{k}: #{v.inspect}" }
         %Q|<Item #{s.join(', ')}>|
       end
 
       alias_method :to_indexed_json, :to_json
+
     end
 
   end

data/lib/slingshot/results/pagination.rb

@@ -0,0 +1,30 @@
+module Slingshot
+  module Results
+
+    module Pagination
+
+      def total_entries
+        @total
+      end
+
+      def total_pages
+        result = @total.to_f / (@options[:per_page] ? @options[:per_page].to_i : 10 )
+        result < 1 ? 1 : result.round
+      end
+
+      def current_page
+        @options[:page].to_i
+      end
+
+      def previous_page
+        @options[:page].to_i - 1
+      end
+
+      def next_page
+        @options[:page].to_i + 1
+      end
+
+    end
+
+  end
+end

data/lib/slingshot/rubyext/symbol.rb

@@ -0,0 +1,11 @@
+# ActiveModel::Serialization Ruby < 1.9.x compatibility
+
+class Symbol
+  def <=> other
+    self.to_s <=> other.to_s
+  end unless method_defined?(:'<=>')
+
+  def capitalize
+    to_s.capitalize
+  end unless method_defined?(:capitalize)
+end

data/lib/slingshot/search.rb

@@ -16,7 +16,8 @@ module Slingshot
       end
 
       def query(&block)
-        @query = Query.new(&block)
+        @query = Query.new
+        block.arity < 1 ? @query.instance_eval(&block) : block.call(@query)
         self
       end
 
@@ -65,7 +66,7 @@ module Slingshot
         @url      = "#{Configuration.url}/#{indices.join(',')}/_search"
         @response = Configuration.client.post(@url, self.to_json)
         @json     = Yajl::Parser.parse(@response.body)
-        @results  = Results::Collection.new(@json)
+        @results  = Results::Collection.new(@json, @options)
         self
       rescue Exception => error
         STDERR.puts "[REQUEST FAILED] #{self.to_curl}\n"

data/lib/slingshot/search/facet.rb

@@ -14,12 +14,15 @@ module Slingshot
         self.instance_eval(&block) if block_given?
       end
 
-      def terms(field, size=10, options={})
-        @value = { :terms => { :field => field, :size => size } }.update(options)
+      def terms(field, options={})
+        size      = options.delete(:size) || 10
+        all_terms = options.delete(:all_terms) || false
+        @value = { :terms => { :field => field, :size => size, :all_terms => all_terms } }.update(options)
         self
       end
 
-      def date(field, interval='day', options={})
+      def date(field, options={})
+        interval = options.delete(:interval) || 'day'
         @value = { :date_histogram => { :field => field, :interval => interval } }.update(options)
         self
       end
@@ -29,9 +32,8 @@ module Slingshot
       end
 
       def to_hash
-        h = { @name => @value }
-        h[@name].update @options
-        return h
+        @value.update @options
+        { @name => @value }
       end
     end
 

data/lib/slingshot/search/filter.rb

@@ -7,8 +7,12 @@ module Slingshot
     class Filter
 
       def initialize(type, *options)
-        @type    = type
-        @options = options || []
+        value = if options.size < 2
+          options.first || {}
+        else
+          options # An +or+ filter encodes multiple filters as an array
+        end
+        @hash = { type => value }
       end
 
       def to_json
@@ -16,12 +20,7 @@ module Slingshot
       end
 
       def to_hash
-        initial = @options.size > 1 ? { @type => [] } : { @type => {} }
-        method  = initial[@type].is_a?(Hash) ? :update : :push
-        @options.inject(initial) do |hash, option|
-          hash[@type].send(method, option)
-          hash
-        end
+        @hash
       end
     end