rsolr 1.0.8 → 1.0.9

data/CHANGES.txt

@@ -1,5 +1,7 @@
 1.0.8
    -  Fix connection refused errors in specs + add basic auth support (Denis Goeury)
+   - Ability to set :retry_503, the number of retry attempts for a 503 response
+     with a Retry-After header.
 1.0.7
    - Response body encoding is set to response charset in Ruby >= 1.9
    - Ability to set :read_timeout and :open_timeout when creating new instance of RSolr
@@ -14,4 +16,4 @@
    - Jeweler is no longer used for building the gemspec
 1.0.3
    - Proper encodings in Ruby 1.9
-   - Applied pull request from https://github.com/mwmitchell/rsolr/pull/20
+   - Applied pull request from https://github.com/mwmitchell/rsolr/pull/20

data/README.rdoc

@@ -36,6 +36,13 @@ The :response attribute contains the original response. This object contains the
 The read and connect timeout settings can be set when creating a new instance of RSolr:
   solr = RSolr.connect(:read_timeout => 120, :open_timeout => 120)
 
+== Retry 503s
+A 503 is usually a temporary error which RSolr may retry if requested. You may specify the number of retry attempts with the :retry_503 option.
+
+Only requests which specify a Retry-After header will be retried, after waiting the indicated retry interval, otherwise RSolr will treat the request as a 500. You may specify a maximum Retry-After interval to wait with the :retry_after_limit option (default: one second).
+  solr = RSolr.connect(:retry_503 => 1, :retry_after_limit => 1)
+
+
 == Querying
 Use the #get / #post method to send search requests to the /select handler:
   response = solr.get 'select', :params => {
@@ -176,27 +183,20 @@ 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
-* Antoine Latter
-* Dmitry Lihachev
-* Lucas Souza
-* Peter Kieltyka
-* Rob Di Marco
+* Nathan Witmer
 * Magnus Bergmark
-* Jonathan Rochkind
-* Chris Beer
-* Craig Smith
+* shima
 * Randy Souza
-* Colin Steele
-* Peter Kieltyka
-* Lorenzo Riccucci
-* Mike Perham
 * Mat Brown
-* Shairon Toledo
-* Matthew Rudy
-* Fouad Mardini
 * Jeremy Hinegardner
-* Nathan Witmer
-* "shima"
+* Denis Goeury
+* shairon toledo
+* Rob Di Marco
+* Peter Kieltyka
+* Mike Perham
+* Lucas Souza
+* Dmitry Lihachev
+* Antoine Latter
 
 ==Author
 
@@ -204,4 +204,4 @@ Matt Mitchell <mailto:goodieboy@gmail.com>
 
 ==Copyright
 
-Copyright (c) 2008-2010 Matt Mitchell. See LICENSE for details.
+Copyright (c) 2008-2010 Matt Mitchell. See LICENSE for details.

data/lib/rsolr/client.rb

@@ -155,7 +155,7 @@ class RSolr::Client
   # then passes the request/response into +adapt_response+.
   def send_and_receive path, opts
     request_context = build_request path, opts
-    [:open_timeout, :read_timeout].each do |k|
+    [:open_timeout, :read_timeout, :retry_503, :retry_after_limit].each do |k|
       request_context[k] = @options[k]
     end
     execute request_context
@@ -163,9 +163,47 @@ class RSolr::Client
   
   # 
   def execute request_context
+
     raw_response = connection.execute self, request_context
+
+    while retry_503?(request_context, raw_response)
+      request_context[:retry_503] -= 1
+      sleep retry_after(raw_response)
+      raw_response = connection.execute self, request_context
+    end
+
     adapt_response(request_context, raw_response) unless raw_response.nil?
   end
+
+  def retry_503?(request_context, response)
+    return false if response.nil?
+    status = response[:status] && response[:status].to_i
+    return false unless status == 503
+    retry_503 = request_context[:retry_503]
+    return false unless retry_503 && retry_503 > 0
+    retry_after_limit = request_context[:retry_after_limit] || 1
+    retry_after = retry_after(response)
+    return false unless retry_after && retry_after <= retry_after_limit
+    true
+  end
+
+  # Retry-After can be a relative number of seconds from now, or an RFC 1123 Date.
+  # If the latter, attempt to convert it to a relative time in seconds.
+  def retry_after(response)
+    retry_after = Array(response[:headers]['Retry-After'] || response[:headers]['retry-after']).flatten.first.to_s
+    if retry_after =~ /\A[0-9]+\Z/
+      retry_after = retry_after.to_i
+    else
+      begin
+        retry_after_date = DateTime.parse(retry_after)
+        retry_after = retry_after_date.to_time - Time.now
+        retry_after = nil if retry_after < 0
+      rescue ArgumentError => e
+        retry_after = retry_after.to_i
+      end
+    end
+    retry_after
+  end
   
   # +build_request+ accepts a path and options hash,
   # then prepares a normalized hash to return for sending

data/lib/rsolr/connection.rb

@@ -15,6 +15,8 @@ class RSolr::Connection
       response = h.request request
       charset = response.type_params["charset"]
       {:status => response.code.to_i, :headers => response.to_hash, :body => force_charset(response.body, charset)}
+    rescue Errno::ECONNREFUSED => e
+      raise(Errno::ECONNREFUSED.new(request_context.inspect))
     # catch the undefined closed? exception -- this is a confirmed ruby bug
     rescue NoMethodError
       $!.message == "undefined method `closed?' for nil:NilClass" ?

data/lib/rsolr/response.rb

@@ -5,8 +5,8 @@ module RSolr::Response
       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
+        d.page_start = base.request[:params]["start"]
+        d.page_total = base["response"]["numFound"].to_s.to_i
       end
     end
   end
@@ -14,7 +14,13 @@ module RSolr::Response
   # A response module which gets mixed into the solr ["response"]["docs"] array.
   module PaginatedDocSet
 
-    attr_accessor :start, :per_page, :total
+    attr_accessor :page_start, :per_page, :page_total
+    if not (Object.const_defined?("RUBY_ENGINE") and Object::RUBY_ENGINE=='rbx')
+      alias_method(:start,:page_start)
+      alias_method(:start=,:page_start=)
+      alias_method(:total,:page_total)
+      alias_method(:total=,:page_total=)
+    end
 
     # Returns the current page calculated from 'rows' and 'start'
     def current_page
@@ -48,4 +54,4 @@ module RSolr::Response
 
   end
   
-end
+end

data/lib/rsolr.rb

@@ -6,7 +6,7 @@ module RSolr
   
   %W(Response Char Client Error Connection Uri Xml).each{|n|autoload n.to_sym, "rsolr/#{n.downcase}"}
   
-  def self.version; "1.0.8" end
+  def self.version; "1.0.9" end
   
   VERSION = self.version
   
@@ -19,4 +19,4 @@ module RSolr
   # RSolr.escape
   extend Char
   
-end
+end

data/spec/api/client_spec.rb

@@ -34,6 +34,38 @@ describe "RSolr::Client" do
     end
   end
 
+  context "execute" do
+    include ClientHelper
+    let :request_context do
+      {
+        :method => :post,
+        :params => {},
+        :data => nil,
+        :headers => {},
+        :path => '',
+        :uri => client.base_uri,
+        :retry_503 => 1
+      }
+    end
+    it "should retry 503s if requested" do
+      client.connection.should_receive(:execute).exactly(2).times.and_return(
+        {:status => 503, :body => "{}", :headers => {'Retry-After' => 0}},
+        {:status => 200, :body => "{}", :headers => {}}
+      )
+      client.execute request_context
+    end
+    it "should not retry a 503 if the retry-after is too large" do
+      client.connection.should_receive(:execute).exactly(1).times.and_return(
+        {:status => 503, :body => "{}", :headers => {'Retry-After' => 10}}
+      )
+      lambda {
+        Timeout.timeout(0.5) do
+          client.execute({:retry_after_limit => 0}.merge(request_context))
+        end
+      }.should raise_error(RSolr::Error::Http)
+    end
+  end
+
   context "post" do
     include ClientHelper
     it "should pass the expected params to the connection's #execute method" do

data/spec/api/connection_spec.rb

@@ -57,6 +57,27 @@ describe "RSolr::Connection" do
       subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get}
     end
   end
+
+  context "connection refused" do
+    let(:client) { mock.as_null_object }
+
+    let(:http) { mock(Net::HTTP).as_null_object }
+    let(:request_context) {
+      {:uri => URI.parse("http://localhost/some_uri"), :method => :get, :open_timeout => 42}
+    }
+    subject { RSolr::Connection.new } 
+
+    before do
+      Net::HTTP.stub(:new) { http }
+    end
+
+    it "should configure Net:HTTP open_timeout" do
+      http.should_receive(:request).and_raise(Errno::ECONNREFUSED)
+      lambda {
+        subject.execute client, request_context
+      }.should raise_error(Errno::ECONNREFUSED, /#{request_context}/)
+    end
+  end
   
   describe "basic auth support" do
     let(:http) { mock(Net::HTTP).as_null_object }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsolr
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -29,11 +29,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-22 00:00:00.000000000Z
+date: 2013-03-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70327300845420 !ruby/object:Gem::Requirement
+  requirement: &70317957140320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -41,10 +41,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70327300845420
+  version_requirements: *70317957140320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70327300844920 !ruby/object:Gem::Requirement
+  requirement: &70317957139580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -52,10 +52,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70327300844920
+  version_requirements: *70317957139580
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70327300844460 !ruby/object:Gem::Requirement
+  requirement: &70317957138980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -63,10 +63,10 @@ dependencies:
         version: 3.9.4
   type: :development
   prerelease: false
-  version_requirements: *70327300844460
+  version_requirements: *70317957138980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70327300844000 !ruby/object:Gem::Requirement
+  requirement: &70317957138400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -74,7 +74,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70327300844000
+  version_requirements: *70317957138400
 description: RSolr aims to provide a simple and extensible library for working with
   Solr
 email: