delsolr 0.0.5 → 0.0.6

data/lib/delsolr.rb

@@ -22,7 +22,7 @@ module DelSolr
   
   class Client
     
-    attr_reader :configuration
+    attr_reader :configuration, :logger
     
     #
     # [<b><tt>:server</tt></b>]
@@ -39,9 +39,13 @@ module DelSolr
     #
     # [<b><tt>:path</tt></b>]
     #   (optional) the path of the solr install (defaults to "/solr")
+    #
+    # [<b><tt>:logger</tt></b>]
+    #   (optional) Log4r logger object
     def initialize(options = {})
       @configuration = DelSolr::Client::Configuration.new(options[:server], options[:port], options[:timeout], options[:path])
       @cache = options[:cache]
+      @logger = options[:logger]
       @shortcuts = options[:shortcuts]
     end
     
@@ -155,12 +159,19 @@ module DelSolr
 
       # if we're caching, first try looking in the cache
       if enable_caching
+        t1 = Time.now
         body = @cache.get(cache_key) rescue body = nil
         from_cache = true unless body.blank?
+        cache_time = (Time.now - t1).to_i * 1000 # retrieval time from the cache in ms
       end
 
       if body.blank? # cache miss (or wasn't enabled)
-        header, body = connection.get(configuration.path + query_builder.request_string)
+        begin
+          header, body = connection.get(configuration.path + query_builder.request_string)
+        rescue Timeout::Error
+          # If we timed out, just return nil and let the client decide what to do
+          return nil
+        end
 
         # We get UTF-8 from Solr back, make sure the string knows about it
         # when running on Ruby >= 1.9
@@ -177,7 +188,9 @@ module DelSolr
         end
       end
 
-      DelSolr::Client::Response.new(body, query_builder, :from_cache => from_cache, :shortcuts => @shortcuts)
+      response = DelSolr::Client::Response.new(body, query_builder, :logger => logger, :from_cache => from_cache, :shortcuts => @shortcuts)
+      logger.info "#{from_cache ? 'C' : 'S'},#{from_cache ? cache_time : response.qtime},#{response.total},http://#{configuration.server}:#{configuration.port}#{response.request_url}" if logger && response && response.success?
+      response
     end
     
     # Adds a document to the buffer to be posted to solr (NOTE: does not perform the actual post)

data/lib/delsolr/document.rb

@@ -37,6 +37,10 @@ module DelSolr
   #
   class Document
 
+    def initialize(options={})
+      @options = options
+    end
+
     # [<b><tt>field_mame</tt></b>]
     #         is the name of the field in your schema.xml
     # [<b><tt>value</tt></b>]
@@ -50,7 +54,7 @@ module DelSolr
     end
 
     def xml
-      "<doc>\n" + field_buffer + "</doc>"
+      "<doc#{opts2str(@options)}>\n" + field_buffer + "</doc>"
     end
 
     private
@@ -59,14 +63,8 @@ module DelSolr
     def construct_field_tag(name, value, options={})
       options[:name] = name.to_s
       use_cdata = options.delete(:cdata)
-      opts = []
-      options.each do |k,v| 
-        opts.push "#{k}=\"#{v}\""
-      end
-      opts = opts.join(" ")
-      opts = " " + opts if opts
 
-      return "<field#{opts}>#{use_cdata ? cdata(value) : value}</field>\n"
+      return "<field#{opts2str(options)}>#{use_cdata ? cdata(value) : value}</field>\n"
     end  
 
     def cdata(str)
@@ -77,6 +75,16 @@ module DelSolr
       @buffer ||= ""
     end
 
+    def opts2str(options)
+      opts = []
+      options.each do |k,v|
+        opts.push "#{k}=\"#{v}\""
+      end
+      opts = opts.join(" ")
+      opts = " " + opts unless opts.blank?
+      opts
+    end
+
   end
   
 end

data/lib/delsolr/query_builder.rb

@@ -41,12 +41,13 @@ module DelSolr
         opts[:q] ||= opts[:query]
         opts[:rows] ||= opts[:limit] || 10
         opts[:start] ||= opts[:offset] || 0
+        opts[:start] = 0 if opts[:start].to_i < 0
         opts[:fl] ||= opts[:fields] || FL_DEFAULTS
         opts[:bq] ||= opts[:boost]
         opts[:suggestionCount] ||= opts[:suggestion_count]
         opts[:onlyMorePopular] ||= opts[:only_more_popular]
         
-        raise ":query or :q must be set" if opts[:q].blank?
+        raise ":query or :q must be set" if opts[:q].nil? || opts[:q].empty?
         
         # clear out the "rubyish" versions, what's left will go straight to solr
         opts.delete(:query)
@@ -123,21 +124,36 @@ module DelSolr
         when Hash
           query_string_array = []
           queries.each do |k,v|
-            if v.is_a?(Array) # add a filter for each value
-              v.each do |val|
-                query_string_array << "#{k}:#{val}"
-              end
-            elsif v.is_a?(Range)
-              query_string_array << "#{k}:[#{v.begin} TO #{v.end}]"
-            else
-              query_string_array << "#{k}:#{v}"
-            end
+            query_string_array << key_value_pair_string(k, v)
           end
           query_string = query_string_array.join(' ')
         end
         
         {key => query_string}
       end
+
+      def key_value_pair_string(k, v)
+        str = ''
+        if v.is_a?(Array) # add a filter for each value
+          str_ary = []
+          v.each do |val|
+            str_ary << key_value_pair_string(k, val)
+          end
+          str = str_ary.join(' ')
+        elsif v.is_a?(Range)
+          str = "#{k}:[#{v.begin} TO #{v.end}]"
+        elsif v.is_a?(String)
+          if v =~ /\s/ && # if it contains a space, we may need to quote it
+             !(v =~ /^\[.+ TO .+\]$/) # HACK: if the string is a range query, do not wrap it in quotes
+            str = "#{k}:\"#{v}\""
+          else
+            str = "#{k}:#{v}"
+          end
+        else
+          str = "#{k}:#{v}"
+        end
+        str
+      end
       
       def build_filters(key, filters)
         params = []
@@ -147,18 +163,12 @@ module DelSolr
         when String
           params << {key => filters}
         when Array
-          filters.each { |f| params << {key => f} }
+          filters.each do |f|
+            params += build_filters(key, f) # recusively add all the filters in the array
+          end
         when Hash
           filters.each do |k,v|
-            if v.is_a?(Array) # add a filter for each value
-              v.each do |val|
-                params << {key => "#{k}:#{val}"}
-              end
-            elsif v.is_a?(Range)
-              params << {key => "#{k}:[#{v.begin} TO #{v.end}]"}
-            else
-              params << {key => "#{k}:#{v}"}
-            end
+            params << {key => key_value_pair_string(k, v)} unless v.nil?
           end
         end
         params

data/lib/delsolr/response.rb

@@ -9,9 +9,12 @@ module DelSolr
       def initialize(solr_response_buffer, query_builder, options = {})
         @query_builder = query_builder
         @from_cache = options[:from_cache]
+        @logger = options[:logger]
         begin
           @raw_response = eval(solr_response_buffer)
-        rescue
+        rescue SyntaxError, Exception => e
+          @logger.error(solr_response_buffer) if @logger
+          @logger.error(e) if @logger
           @raw_response = nil
         end
 
@@ -30,6 +33,11 @@ module DelSolr
       def raw_response
         @raw_response
       end
+
+      # Did we get some kind of valid response back from solr?
+      def success?
+        !raw_response.nil?
+      end
       
       # Returns the total number of matches
       def total
@@ -38,7 +46,7 @@ module DelSolr
       
       # Returns true if there no results
       def blank?
-        total.zero?
+        raw_response.blank? || total < 1
       end
       
       alias_method :empty?, :blank?
@@ -74,6 +82,21 @@ module DelSolr
         raw_response['highlighting'][unique_id] ||= {}
         raw_response['highlighting'][unique_id][field]
       end
+
+      def suggestions
+        @suggestions ||= raw_response['spellcheck']['suggestions'] if raw_response && raw_response['spellcheck']
+      end
+
+      # solr is super-weird about the way it returns suggestions,
+      # hence this strangeness:
+      # 'spellcheck'=>{'suggestions'=>['fishh',{'numFound'=>1,'startOffset'=>0,'endOffset'=>4,'suggestion'=>['fish']},'collation','fish']}
+      def collation
+        @collation ||= begin
+          collation = nil
+          suggestions.in_groups_of(2) {|k,v| collation = v if k == 'collation'} if suggestions
+          collation
+        end
+      end
       
       # Returns the query time in ms
       def qtime
@@ -125,7 +148,7 @@ module DelSolr
       
       # Returns an array of value/counts for a given field (ie: ['true', 123, 'false', 20]
       def facet_field(field)
-        facet_fields[field.to_s]
+        facet_fields[field.to_s] || []
       end
       
       # Returns the array of field values for the given field in the order they were returned from solr
@@ -142,7 +165,7 @@ module DelSolr
       
       # Returns a hash of value/counts for a given field (ie: {'true' => 123, 'false' => 20}
       def facet_field_by_hash(field)
-        facet_fields_by_hash(field.to_s)
+        facet_fields_by_hash[field.to_s]
       end
       
       # Returns the count for the given field/value pair

data/test/test_client.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
 require 'rubygems'
 gem 'mocha', '>=0.9.0'
 require 'mocha'

data/test/test_helper.rb

@@ -1,2 +1,2 @@
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/delsolr'
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/delsolr'

data/test/test_query_builder.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
 
 class QueryBuilderTest < Test::Unit::TestCase
 

data/test/test_response.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
 
 class ResponseTest < Test::Unit::TestCase
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: delsolr
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Ben VandenBos
@@ -14,14 +19,19 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 0
         version: 0.9.0
-    version: 
+  type: :development
+  version_requirements: *id001
 description: Ruby wrapper for Lucene Solr
 email: 
 executables: []
@@ -39,6 +49,10 @@ files:
 - lib/delsolr/query_builder.rb
 - lib/delsolr/response.rb
 - lib/delsolr/document.rb
+- test/test_client.rb
+- test/test_helper.rb
+- test/test_query_builder.rb
+- test/test_response.rb
 has_rdoc: true
 homepage: http://github.com/avvo/delsolr
 licenses: []
@@ -49,21 +63,25 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: DelSolr is a light weight ruby wrapper for solr.  It's intention is to expose the full power of solr queries while keeping the interface as ruby-esque as possible.