rsolr 1.0.2 → 1.0.3

data/README.rdoc

@@ -2,13 +2,13 @@
 
 A simple, extensible Ruby client for Apache Solr.
 
-Notice: This document is only for the the 1.0 in the master. The last pre-1.0 gem release documentation can be found here: http://github.com/mwmitchell/rsolr/tree/v0.12.1
+Notice: This document is only for the the 1.0 in the master. The last pre 1.0 gem release documentation can be found here: http://github.com/mwmitchell/rsolr/tree/v0.12.1
 
 ==Documentation
-The code docs can be viewed here : http://rdoc.info/projects/mwmitchell/rsolr
+The code docs for the last *release* can be viewed here : http://rdoc.info/projects/mwmitchell/rsolr
 
 == Installation:
-  sudo gem install rsolr --pre
+  sudo gem install rsolr
 
 == Example:
   require 'rubygems'
@@ -184,7 +184,12 @@ The default response format is Ruby. When the :wt param is set to :ruby, the res
 * Send me a pull request. Bonus points for topic branches.
 
 ==Contributors
+* Jonathan Rochkind
+* Chris Beer
+* Craig Smith
+* Randy Souza
 * Colin Steele
+* Peter Kieltyka
 * Lorenzo Riccucci
 * Mike Perham
 * Mat Brown
@@ -193,7 +198,7 @@ The default response format is Ruby. When the :wt param is set to :ruby, the res
 * Fouad Mardini
 * Jeremy Hinegardner
 * Nathan Witmer
-* Craig Smith
+* "shima"
 
 ==Author
 

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/lib/rsolr/char.rb

@@ -4,7 +4,7 @@ module RSolr::Char
   # backslash everything
   # that isn't a word character
   def escape value
-    value.gsub /(\W)/, '\\\\\1'
+    value.gsub(/(\W)/, '\\\\\1')
   end
   
   # LUCENE_CHAR_RX = /([\+\-\!\(\)\[\]\^\"\~\*\?\:\\]+)/

data/lib/rsolr/client.rb

@@ -3,6 +3,7 @@ class RSolr::Client
   attr_reader :connection, :uri, :proxy, :options
   
   def initialize connection, options = {}
+    @proxy = @uri = nil
     @connection = connection
     unless false === options[:url]
       url = options[:url] ? options[:url].dup : 'http://127.0.0.1:8983/solr/'
@@ -15,10 +16,9 @@ class RSolr::Client
       end
     end
     @options = options
-    extend RSolr::Pagination::Client
   end
   
-  # returns the actual request uri object.
+  # returns the request uri object.
   def base_request_uri
     base_uri.request_uri if base_uri
   end
@@ -26,7 +26,7 @@ class RSolr::Client
   # returns the uri proxy if present,
   # otherwise just the uri object.
   def base_uri
-    @proxy || @uri
+    @proxy ? @proxy : @uri
   end
   
   # Create the get, post, and head methods
@@ -38,6 +38,16 @@ class RSolr::Client
     RUBY
   end
   
+  # A paginated request method.
+  # Converts the page and per_page
+  # arguments into "rows" and "start".
+  def paginate page, per_page, path, opts = nil
+    opts ||= {}
+    opts[:params] ||= {}
+    raise "'rows' or 'start' params should not be set when using +paginate+" if ["start", "rows"].include?(opts[:params].keys)
+    execute build_paginated_request(page, per_page, path, opts)
+  end
+  
   # POST XML messages to /update with optional params.
   # 
   # http://wiki.apache.org/solr/UpdateXmlMessages#add.2BAC8-update
@@ -187,10 +197,16 @@ class RSolr::Client
     opts
   end
   
+  def build_paginated_request page, per_page, path, opts
+    per_page = per_page.to_s.to_i
+    page = page.to_s.to_i-1
+    page = page < 1 ? 0 : page
+    opts[:params]["start"] = page * per_page
+    opts[:params]["rows"] = per_page
+    build_request path, opts
+  end
+  
   #  A mixin for used by #adapt_response
-  # This module essentially
-  # allows the raw response access to
-  # the original response and request.
   module Context
     attr_accessor :request, :response
   end
@@ -208,20 +224,22 @@ class RSolr::Client
   def adapt_response request, response
     raise "The response does not have the correct keys => :body, :headers, :status" unless
       %W(body headers status) == response.keys.map{|k|k.to_s}.sort
-    raise RSolr::Error::Http.new request, response unless
-      [200,302].include? response[:status]
+    raise RSolr::Error::Http.new request, response unless [200,302].include? response[:status]
     result = request[:params][:wt] == :ruby ? evaluate_ruby_response(request, response) : response[:body]
     result.extend Context
-    result.request = request
-    result.response = response
-    result
+    result.request, result.response = request, response
+    result.is_a?(Hash) ? result.extend(RSolr::Response) : result
   end
   
   protected
   
   # converts the method name for the solr request handler path.
   def method_missing name, *args
-    send_and_receive name, *args
+    if name.to_s =~ /^paginated?_(.+)$/
+      paginate args[0], args[1], $1, *args[2..-1]
+    else
+      send_and_receive name, *args
+    end
   end
   
   # evaluates the response[:body],

data/lib/rsolr/connection.rb

@@ -3,7 +3,7 @@ require 'net/https'
 
 # The default/Net::Http adapter for RSolr.
 class RSolr::Connection
-  
+
   # using the request_context hash,
   # send a request,
   # then return the standard rsolr response hash {:status, :body, :headers}
@@ -13,7 +13,8 @@ class RSolr::Connection
     request.body = request_context[:data] if request_context[:method] == :post and request_context[:data]
     begin
       response = h.request request
-      {:status => response.code.to_i, :headers => response.to_hash, :body => response.body}
+      charset = response.type_params["charset"]
+      {:status => response.code.to_i, :headers => response.to_hash, :body => force_charset(response.body, charset)}
     # catch the undefined closed? exception -- this is a confirmed ruby bug
     rescue NoMethodError
       $!.message == "undefined method `closed?' for nil:NilClass" ?
@@ -21,9 +22,9 @@ class RSolr::Connection
         raise($!)
     end
   end
-  
+
   protected
-  
+
   # This returns a singleton of a Net::HTTP or Net::HTTP.Proxy request object.
   def http uri, proxy = nil
     @http ||= (
@@ -33,12 +34,12 @@ class RSolr::Connection
       else
         Net::HTTP.new uri.host, uri.port
       end
-      http.use_ssl = uri.port == 443 || uri.instance_of?(URI::HTTPS)      
+      http.use_ssl = uri.port == 443 || uri.instance_of?(URI::HTTPS)
       http
     )
   end
-  
-  # 
+
+  #
   def setup_raw_request request_context
     http_method = case request_context[:method]
     when :get
@@ -66,5 +67,12 @@ class RSolr::Connection
     raw_request.initialize_http_header headers
     raw_request
   end
-  
-end
+
+  private
+
+  def force_charset body, charset
+    return body unless charset and body.respond_to?(:force_encoding)
+    body.force_encoding(charset)
+  end
+
+end

data/lib/rsolr/response.rb

@@ -0,0 +1,51 @@
+module RSolr::Response
+  
+  def self.extended base
+    if base["response"] && base["response"]["docs"]
+      base["response"]["docs"].tap do |d|
+        d.extend PaginatedDocSet
+        d.per_page = base.request[:params]["rows"]
+        d.start = base.request[:params]["start"]
+        d.total = base["response"]["numFound"].to_s.to_i
+      end
+    end
+  end
+  
+  # A response module which gets mixed into the solr ["response"]["docs"] array.
+  module PaginatedDocSet
+
+    attr_accessor :start, :per_page, :total
+
+    # Returns the current page calculated from 'rows' and 'start'
+    def current_page
+      return 1 if start < 1
+      per_page_normalized = per_page < 1 ? 1 : per_page
+      @current_page ||= (start / per_page_normalized).ceil + 1
+    end
+
+    # Calcuates the total pages from 'numFound' and 'rows'
+    def total_pages
+      @total_pages ||= per_page > 0 ? (total / per_page.to_f).ceil : 1
+    end
+
+    # returns the previous page number or 1
+    def previous_page
+      @previous_page ||= (current_page > 1) ? current_page - 1 : 1
+    end
+
+    # returns the next page number or the last
+    def next_page
+      @next_page ||= (current_page == total_pages) ? total_pages : current_page+1
+    end
+
+    def has_next?
+      current_page < total_pages
+    end
+
+    def has_previous?
+      current_page > 1
+    end
+
+  end
+  
+end

data/lib/rsolr/xml.rb

@@ -73,7 +73,6 @@ module RSolr::Xml
   class Generator
     
     def build &block
-      require 'builder'
       b = ::Builder::XmlMarkup.new(:indent => 0, :margin => 0, :encoding => 'UTF-8')
       b.instruct!
       block_given? ? yield(b) : b

data/lib/rsolr.rb

@@ -4,7 +4,7 @@ require 'rubygems'
 
 module RSolr
   
-  %W(Char Client Error Connection Pagination Uri Xml).each{|n|autoload n.to_sym, "rsolr/#{n.downcase}"}
+  %W(Response Char Client Error Connection Uri Xml).each{|n|autoload n.to_sym, "rsolr/#{n.downcase}"}
   
   def self.version
     @version ||= File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).chomp

data/spec/api/pagination_spec.rb

@@ -1,38 +1,26 @@
 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)
+      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[: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 = RSolr::Client.new(nil, {})#.extend(RSolr::Pagination::Client)
       c.should_receive(:execute).with(hash_including({
-        :page => 1,
-        :per_page => 10,
+        #:page => 1,
+        #:per_page => 10,
         :params => {
-          :rows => 10,
-          :start => 0,
+          "rows" => 10,
+          "start" => 0,
           :wt => :ruby
         }
       }))

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsolr
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -25,13 +25,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-06 00:00:00 -04:00
-default_executable: 
+date: 2011-11-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  version_requirements: *id001
   name: builder
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id002
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  version_requirements: *id003
+  name: rake
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 3
+        - 9
+        - 4
+        version: 3.9.4
+  version_requirements: *id004
+  name: rdoc
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -42,8 +103,10 @@ dependencies:
         - 1
         - 2
         version: 2.1.2
+  version_requirements: *id005
+  name: builder
+  prerelease: false
   type: :runtime
-  version_requirements: *id001
 description: RSolr aims to provide a simple and extensible library for working with Solr
 email: goodieboy@gmail.com
 executables: []
@@ -63,7 +126,7 @@ files:
 - lib/rsolr/client.rb
 - lib/rsolr/connection.rb
 - lib/rsolr/error.rb
-- lib/rsolr/pagination.rb
+- lib/rsolr/response.rb
 - lib/rsolr/uri.rb
 - lib/rsolr/xml.rb
 - spec/api/char_spec.rb
@@ -78,7 +141,6 @@ files:
 - Rakefile
 - tasks/spec.rake
 - tasks/rdoc.rake
-has_rdoc: true
 homepage: http://github.com/mwmitchell/rsolr
 licenses: []
 
@@ -108,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A Ruby client for Apache Solr

data/lib/rsolr/pagination.rb

@@ -1,122 +0,0 @@
-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 = per_page.to_s.to_i
-    page = page.to_s.to_i-1
-    page = page < 1 ? 0 : page
-    start = page * per_page
-    [start, per_page]
-  end
-  
-  # A mixin module for RSolr::Client
-  # -- note, this must mixed-in via
-  # "extend" on a RSolr::Client instance.
-  module Client
-    
-    # A paginated request method.
-    def paginate page, per_page, path, opts = nil
-      @warned ||= begin
-        warn "DEPRECATION WARNING: RSolr::Pagination / pagination functionality will be removed in 1.1.0."
-        true
-      end
-      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 = nil
-      opts ||= {}
-      opts[:page] = page
-      opts[:per_page] = per_page
-      opts[:params] ||= {}
-      values = RSolr::Pagination.calculate_start_and_rows(page, per_page)
-      opts[:params][:start] = values[0]
-      opts[:params][:rows] = values[1]
-      build_request path, opts
-    end
-    
-    protected
-    
-    # Checks if the called method starts
-    # with "paginate_*" and
-    # converts the * to the solr
-    # request path. It then calls paginate
-    # with the appropriate arguments.
-    # If the called method doesn't
-    # start with "paginate_",
-    # the original/super
-    # RSolr::Client #method_missing
-    # method is called.
-    def method_missing name, *args
-      if name.to_s =~ /^paginated?_(.+)$/
-        paginate args[0], args[1], $1, *args[2..-1]
-      else
-        super name, *args
-      end
-    end
-    
-    # Overrides the RSolr::Client #evaluate_ruby_response method.
-    # Calls the original/super
-    # RSolr::Client #evaluate_ruby_response method.
-    # 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
-      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
-  
-  # A response module which gets mixed into the solr ["response"]["docs"] array.
-  module PaginatedDocSet
-
-    attr_accessor :start, :per_page, :total
-
-    # Returns the current page calculated from 'rows' and 'start'
-    # WillPaginate hook
-    def current_page
-      return 1 if start < 1
-      per_page_normalized = per_page < 1 ? 1 : per_page
-      @current_page ||= (start / per_page_normalized).ceil + 1
-    end
-
-    # Calcuates the total pages from 'numFound' and 'rows'
-    # WillPaginate hook
-    def total_pages
-      @total_pages ||= per_page > 0 ? (total / per_page.to_f).ceil : 1
-    end
-
-    # returns the previous page number or 1
-    # WillPaginate hook
-    def previous_page
-      @previous_page ||= (current_page > 1) ? current_page - 1 : 1
-    end
-
-    # returns the next page number or the last
-    # WillPaginate hook
-    def next_page
-      @next_page ||= (current_page == total_pages) ? total_pages : current_page+1
-    end
-
-    def has_next?
-      current_page < total_pages
-    end
-
-    def has_previous?
-      current_page > 1
-    end
-
-  end
-  
-end