rsolr 1.0.0.beta5 → 1.0.0

data/README.rdoc

@@ -8,7 +8,7 @@ Notice: This document is only for the the 1.0 (pre-release) in the master branch
 The code docs can be viewed here : http://rdoc.info/projects/mwmitchell/rsolr
 
 == Installation:
-  sudo gem install rsolr
+  sudo gem install rsolr --pre
 
 == Example:
   require 'rubygems'

data/VERSION

@@ -1 +1 @@
-1.0.0.beta5
+1.0.0

data/lib/rsolr/char.rb

@@ -1,9 +1,21 @@
 # A module that contains (1) string related methods
 module RSolr::Char
   
-  # backslash everything that isn't a word character
+  # backslash everything
+  # that isn't a word character
   def escape value
     value.gsub /(\W)/, '\\\\\1'
   end
   
+  # LUCENE_CHAR_RX = /([\+\-\!\(\)\[\]\^\"\~\*\?\:\\]+)/
+  # LUCENE_WORD_RX = /(OR|AND|NOT)/
+  # 
+  # # More specific/lucene escape sequence
+  # def lucene_escape string
+  #   delim = " "
+  #   string.gsub(LUCENE_CHAR_RX, '\\\\\1').split(delim).map { |v|
+  #     v.gsub(LUCENE_WORD_RX, '\\\\\1')
+  #   }.join(delim)
+  # end
+  
 end

data/lib/rsolr/client.rb

@@ -4,19 +4,21 @@ class RSolr::Client
   
   def initialize connection, options = {}
     @connection = connection
-    url = options[:url] || 'http://127.0.0.1:8983/solr/'
-    url << "/" unless url[-1] == ?/
-    proxy_url = options[:proxy]
-    proxy_url << "/" unless proxy_url.nil? or proxy_url[-1] == ?/
-    @uri = RSolr::Uri.create url
-    @proxy = RSolr::Uri.create proxy_url if proxy_url
+    unless false === options[:url]
+      url = options[:url] || 'http://127.0.0.1:8983/solr/'
+      url << "/" unless url[-1] == ?/
+      proxy_url = options[:proxy]
+      proxy_url << "/" unless proxy_url.nil? or proxy_url[-1] == ?/
+      @uri = RSolr::Uri.create url
+      @proxy = RSolr::Uri.create proxy_url if proxy_url
+    end
     @options = options
     extend RSolr::Pagination::Client
   end
   
   # returns the actual request uri object.
   def base_request_uri
-    base_uri.request_uri
+    base_uri.request_uri if base_uri
   end
   
   # returns the uri proxy if present,
@@ -117,7 +119,7 @@ class RSolr::Client
     update opts.merge(:data => xml.delete_by_query(query))
   end
   
-  # shortcut to RSolr::Message::Generator
+  # shortcut to RSolr::Xml::Generator
   def xml
     @xml ||= RSolr::Xml::Generator.new
   end
@@ -125,7 +127,7 @@ class RSolr::Client
   # +send_and_receive+ is the main request method responsible for sending requests to the +connection+ object.
   # 
   # "path" : A string value that usually represents a solr request handler
-  # "opt" : A hash, which can contain the following keys:
+  # "opts" : A hash, which can contain the following keys:
   #   :method : required - the http method (:get, :post or :head)
   #   :params : optional - the query string params in hash form
   #   :data : optional - post data -- if a hash is given, it's sent as "application/x-www-form-urlencoded"

data/lib/rsolr/connection.rb

@@ -44,6 +44,8 @@ class RSolr::Connection
     when :get
       Net::HTTP::Get
     when :post
+      #require 'net/http/post/multipart'
+      #File === request_context[:data] ? Net::HTTP::Post::Multipart : Net::HTTP::Post
       Net::HTTP::Post
     when :head
       Net::HTTP::Head
@@ -51,7 +53,16 @@ class RSolr::Connection
       raise "Only :get, :post and :head http method types are allowed."
     end
     headers = request_context[:headers] || {}
-    raw_request = http_method.new request_context[:uri].to_s
+    # if http_method.to_s == "Net::HTTP::Post::Multipart"
+    #   io = request_context[:data]
+    #   UploadIO.convert! io, request_context[:headers]["Content-Type"], io.path, io.path
+    #   raw_request =
+    #     Net::HTTP::Post::Multipart.new(
+    #       request_context[:path],
+    #       :file => io)
+    # else
+      raw_request = http_method.new request_context[:uri].to_s
+    # end
     raw_request.initialize_http_header headers
     raw_request
   end

data/lib/rsolr/pagination.rb

@@ -3,7 +3,7 @@ module RSolr::Pagination
   # Calculates the "start" and "rows" Solr params
   # by inspecting the :per_page and :page params.
   def self.calculate_start_and_rows page, per_page
-    per_page ||= 10
+    per_page = per_page.to_s.to_i
     page = page.to_s.to_i-1
     page = page < 1 ? 0 : page
     start = page * per_page
@@ -16,16 +16,16 @@ module RSolr::Pagination
   module Client
     
     # A paginated request method.
-    def paginate page, per_page, path, opts = {}
-      request_context = build_paginated_request page, per_page, path, opts = {}
-      puts request_context.inspect
+    def paginate page, per_page, path, opts = nil
+      request_context = build_paginated_request page, per_page, path, opts
       execute request_context
     end
     
     # Just like RSolr::Client #build_request
     # but converts the page and per_page
     # arguments into :rows and :start.
-    def build_paginated_request page, per_page, path, opts = {}
+    def build_paginated_request page, per_page, path, opts = nil
+      opts ||= {}
       opts[:page] = page
       opts[:per_page] = per_page
       opts[:params] ||= {}
@@ -48,7 +48,7 @@ module RSolr::Pagination
     # RSolr::Client #method_missing
     # method is called.
     def method_missing name, *args
-      if name.to_s =~ /^paginate_(.+)$/
+      if name.to_s =~ /^paginated?_(.+)$/
         paginate args[0], args[1], $1, *args[2..-1]
       else
         super name, *args
@@ -58,31 +58,22 @@ module RSolr::Pagination
     # Overrides the RSolr::Client #evaluate_ruby_response method.
     # Calls the original/super
     # RSolr::Client #evaluate_ruby_response method.
-    # Mixes in the PaginatedResponse if
+    # Mixes in the PaginatedDocSet if
     # the request[:page] and request[:per_page]
     # opts are set.
     def evaluate_ruby_response request, response
       result = super request, response
-      result.extend(PaginatedResponse) if request[:page] && request[:per_page]
+      if request[:page] && request[:per_page] && result["response"] && result["response"]["docs"]
+        d = result['response']['docs'].extend PaginatedDocSet
+        d.per_page = request[:per_page]
+        d.start = request[:params][:start]
+        d.total = result["response"]["numFound"].to_s.to_i
+      end
       result
     end
     
   end
   
-  module PaginatedResponse
-    # TODO: self["responseHeader"]["params"]["rows"]
-    # will not be available if omitHeader is false...
-    # so, a simple "extend" probably isn't going to cut it.
-    def self.extended base
-      return unless base["response"] && base["response"]["docs"]
-      d = base['response']['docs']
-      d.extend PaginatedDocSet
-      d.per_page = self["responseHeader"]["params"]["rows"].to_s.to_i rescue 10
-      d.start = base["response"]["start"].to_s.to_i
-      d.total = base["response"]["numFound"].to_s.to_i
-    end
-  end
-  
   # A response module which gets mixed into the solr ["response"]["docs"] array.
   module PaginatedDocSet
 

data/lib/rsolr/uri.rb

@@ -2,14 +2,16 @@ require 'uri'
 
 module RSolr::Uri
   
-  def self.create url
+  def create url
     ::URI.parse url[-1] == ?/ ? url : "#{url}/"
   end
   
   # Returns a query string param pair as a string.
   # Both key and value are escaped.
-  def build_param(k,v)
-    "#{escape_query_value(k)}=#{escape_query_value(v)}"
+  def build_param(k,v, escape = true)
+    escape ? 
+      "#{escape_query_value(k)}=#{escape_query_value(v)}" :
+      "#{k}=#{v}"
   end
 
   # Return the bytesize of String; uses String#size under Ruby 1.8 and
@@ -29,13 +31,13 @@ module RSolr::Uri
   #   params_to_solr(:q => 'query', :fq => ['a', 'b'])
   # is converted to:
   #   ?q=query&fq=a&fq=b
-  def params_to_solr(params)
+  def params_to_solr(params, escape = true)
     mapped = params.map do |k, v|
       next if v.to_s.empty?
       if v.class == Array
-        params_to_solr(v.map { |x| [k, x] })
+        params_to_solr(v.map { |x| [k, x] }, escape)
       else
-        build_param k, v
+        build_param k, v, escape
       end
     end
     mapped.compact.join("&")
@@ -46,8 +48,7 @@ module RSolr::Uri
   # version since it's faster.
   # (Stolen from Rack).
   def escape_query_value(s)
-    s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
-      #'%'+$1.unpack('H2'*$1.size).join('%').upcase
+    s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/u) {
       '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
     }.tr(' ', '+')
   end

data/spec/api/pagination_spec.rb

@@ -1,4 +1,42 @@
 require 'spec_helper'
 describe "RSolr::Pagination" do
-  
+  context "calculate_start_and_rows" do
+    it "should return an array with 2 ints" do
+      values = RSolr::Pagination.calculate_start_and_rows 2, 10
+      values[0].should == 10
+      values[1].should == 10
+    end
+    it "should handle string values" do
+      values = RSolr::Pagination.calculate_start_and_rows "1", "22"
+      values[0].should == 0
+      values[1].should == 22
+    end
+  end
+  context "build_paginated_request" do
+    it "should create the proper solr params and query string" do
+      c = RSolr::Client.new(nil, {}).extend(RSolr::Pagination::Client)
+      r = c.build_paginated_request 3, 25, "select", {:params => {:q => "test"}}
+      r[:page].should == 3
+      r[:per_page].should == 25
+      r[:params][:start].should == 50
+      r[:params][:rows].should == 25
+      r[:uri].query.should =~ /rows=25/
+      r[:uri].query.should =~ /start=50/
+    end
+  end
+  context "paginate" do
+    it "should build a paginated request context and call execute" do
+      c = RSolr::Client.new(nil, {}).extend(RSolr::Pagination::Client)
+      c.should_receive(:execute).with(hash_including({
+        :page => 1,
+        :per_page => 10,
+        :params => {
+          :rows => 10,
+          :start => 0,
+          :wt => :ruby
+        }
+      }))
+      c.paginate 1, 10, "select"
+    end
+  end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rsolr
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 1
   - 0
   - 0
-  - beta5
-  version: 1.0.0.beta5
+  version: 1.0.0
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-28 00:00:00 -04:00
+date: 2011-01-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,13 +70,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: