rsolr 1.0.6 → 1.0.7

data/CHANGES.txt

@@ -1,3 +1,10 @@
+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
+1.0.6
+   - More dependency fixups
+1.0.5
+   - Dependency fixups
 1.0.4
    - The "builder" gem dependency is less strict: ~> 2.1.2
    - RSolr.version is no longer read from a file

data/README.rdoc

@@ -2,10 +2,8 @@
 
 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
-
 ==Documentation
-The code docs for the last *release* can be viewed here : http://rdoc.info/projects/mwmitchell/rsolr
+The code docs for the last *release* can be viewed here: http://rubydoc.info/gems/rsolr/1.0.6/frames
 
 == Installation:
   sudo gem install rsolr
@@ -34,6 +32,10 @@ The :request attribute contains the original request context. You can use this f
 
 The :response attribute contains the original response. This object contains the :status, :body and :headers keys.
 
+== Timeouts
+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)
+
 == Querying
 Use the #get / #post method to send search requests to the /select handler:
   response = solr.get 'select', :params => {
@@ -173,17 +175,13 @@ The default response format is Ruby. When the :wt param is set to :ruby, the res
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
 ==Contributors
+* Antoine Latter
+* Dmitry Lihachev
+* Lucas Souza
+* Peter Kieltyka
+* Rob Di Marco
+* Magnus Bergmark
 * Jonathan Rochkind
 * Chris Beer
 * Craig Smith

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.6" end
+  def self.version; "1.0.7" end
   
   VERSION = self.version
   

data/lib/rsolr/client.rb

@@ -142,7 +142,7 @@ class RSolr::Client
   # "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 : optional - post data -- if a hash is given, it's sent as "application/x-www-form-urlencoded; charset=UTF-8"
   #   :headers : optional - hash of request headers
   # All other options are passed right along to the connection's +send_and_receive+ method (:get, :post, or :head)
   # 
@@ -155,6 +155,9 @@ 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|
+      request_context[k] = @options[k]
+    end
     execute request_context
   end
   
@@ -190,7 +193,7 @@ class RSolr::Client
     if opts[:data].is_a? Hash
       opts[:data] = RSolr::Uri.params_to_solr opts[:data]
       opts[:headers] ||= {}
-      opts[:headers]['Content-Type'] ||= 'application/x-www-form-urlencoded'
+      opts[:headers]['Content-Type'] ||= 'application/x-www-form-urlencoded; charset=UTF-8'
     end
     opts[:path] = path
     opts[:uri] = base_uri.merge(path.to_s + (query ? "?#{query}" : "")) if base_uri

data/lib/rsolr/connection.rb

@@ -8,7 +8,7 @@ class RSolr::Connection
   # send a request,
   # then return the standard rsolr response hash {:status, :body, :headers}
   def execute client, request_context
-    h = http request_context[:uri], request_context[:proxy]
+    h = http request_context[:uri], request_context[:proxy], request_context[:read_timeout], request_context[:open_timeout]
     request = setup_raw_request request_context
     request.body = request_context[:data] if request_context[:method] == :post and request_context[:data]
     begin
@@ -26,7 +26,7 @@ class RSolr::Connection
   protected
 
   # This returns a singleton of a Net::HTTP or Net::HTTP.Proxy request object.
-  def http uri, proxy = nil
+  def http uri, proxy = nil, read_timeout = nil, open_timeout = nil
     @http ||= (
       http = if proxy
         proxy_user, proxy_pass = proxy.userinfo.split(/:/) if proxy.userinfo
@@ -35,6 +35,8 @@ class RSolr::Connection
         Net::HTTP.new uri.host, uri.port
       end
       http.use_ssl = uri.port == 443 || uri.instance_of?(URI::HTTPS)
+      http.read_timeout = read_timeout if read_timeout
+      http.open_timeout = open_timeout if open_timeout
       http
     )
   end

data/rsolr.gemspec

@@ -8,7 +8,17 @@ Gem::Specification.new do |s|
   s.summary     = "A Ruby client for Apache Solr"
   s.description = %q{RSolr aims to provide a simple and extensible library for working with Solr}
   s.version     = RSolr.version
-  s.authors     = ["Matt Mitchell", "Jeremy Hinegardner", "Mat Brown", "Mike Perham", "Nathan Witmer", "Peter Kieltyka", "Randy Souza", "shairon toledo", "shima", "Chris Beer", "Jonathan Rochkind"]
+  s.authors     = ["Antoine Latter", "Dmitry Lihachev",
+                  "Lucas Souza", "Peter Kieltyka",
+                  "Rob Di Marco", "Magnus Bergmark",
+                  "Jonathan Rochkind", "Chris Beer",
+                  "Craig Smith", "Randy Souza",
+                  "Colin Steele", "Peter Kieltyka",
+                  "Lorenzo Riccucci", "Mike Perham",
+                  "Mat Brown", "Shairon Toledo",
+                  "Matthew Rudy", "Fouad Mardini",
+                  "Jeremy Hinegardner", "Nathan Witmer",
+                  "\"shima\""]
   s.email       = ["goodieboy@gmail.com"]
   s.homepage    = "https://github.com/mwmitchell/rsolr"
   s.rubyforge_project = "rsolr"

data/spec/api/client_spec.rb

@@ -5,7 +5,7 @@ describe "RSolr::Client" do
     def client
       @client ||= (
         connection = RSolr::Connection.new
-        RSolr::Client.new connection, :url => "http://localhost:9999/solr"
+        RSolr::Client.new connection, :url => "http://localhost:9999/solr", :read_timeout => 42, :open_timeout=>43
       )
     end
   end
@@ -25,6 +25,13 @@ describe "RSolr::Client" do
         client.send_and_receive '', :method => meth, :params => {}, :data => nil, :headers => {}
       end
     end
+
+    it "should be timeout aware" do
+      [:get, :post, :head].each do |meth|
+        client.connection.should_receive(:execute).with(client, hash_including(:read_timeout => 42, :open_timeout=>43))
+        client.send_and_receive '', :method => meth, :params => {}, :data => nil, :headers => {}
+      end
+    end
   end
 
   context "post" do
@@ -197,7 +204,7 @@ describe "RSolr::Client" do
       result[:headers].should == {}
     end
     
-    it "should set the Content-Type header to application/x-www-form-urlencoded if a hash is passed in to the data arg" do
+    it "should set the Content-Type header to application/x-www-form-urlencoded; charset=UTF-8 if a hash is passed in to the data arg" do
       result = client.build_request('select',
         :method => :post,
         :data => {:q=>'test', :fq=>[0,1]},
@@ -208,9 +215,9 @@ describe "RSolr::Client" do
         result[:data].should match pattern
       end
       result[:data].should_not match /wt=ruby/
-      result[:headers].should == {"Content-Type" => "application/x-www-form-urlencoded"}
+      result[:headers].should == {"Content-Type" => "application/x-www-form-urlencoded; charset=UTF-8"}
     end
     
   end
   
-end
+end

data/spec/api/connection_spec.rb

@@ -11,5 +11,41 @@ describe "RSolr::Connection" do
     req.each_header{|k,v| headers[k] = v}
     headers.should == {"content-type"=>"text/xml"}
   end
+
+  context "read timeout configuration" do
+    let(:client) { mock.as_null_object }
+
+    subject { RSolr::Connection.new } 
+
+    it "should configure Net:HTTP read_timeout" do
+      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get, :read_timeout => 42}
+      http = subject.instance_variable_get(:@http)
+      http.read_timeout.should == 42
+    end
+
+    it "should use Net:HTTP default read_timeout if not specified" do
+      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get}
+      http = subject.instance_variable_get(:@http)
+      http.read_timeout.should == 60
+    end
+  end
+
+  context "open timeout configuration" do
+    let(:client) { mock.as_null_object }
+
+    subject { RSolr::Connection.new } 
+
+    it "should configure Net:HTTP open_timeout" do
+      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get, :open_timeout => 42}
+      http = subject.instance_variable_get(:@http)
+      http.open_timeout.should == 42
+    end
+
+    it "should use Net:HTTP default open_timeout if not specified" do
+      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get}
+      http = subject.instance_variable_get(:@http)
+      http.open_timeout.should == nil
+    end
+  end
   
-end
+end

metadata

@@ -1,29 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: rsolr
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
   prerelease: 
 platform: ruby
 authors:
-- Matt Mitchell
-- Jeremy Hinegardner
-- Mat Brown
-- Mike Perham
-- Nathan Witmer
+- Antoine Latter
+- Dmitry Lihachev
+- Lucas Souza
 - Peter Kieltyka
-- Randy Souza
-- shairon toledo
-- shima
-- Chris Beer
+- Rob Di Marco
+- Magnus Bergmark
 - Jonathan Rochkind
+- Chris Beer
+- Craig Smith
+- Randy Souza
+- Colin Steele
+- Peter Kieltyka
+- Lorenzo Riccucci
+- Mike Perham
+- Mat Brown
+- Shairon Toledo
+- Matthew Rudy
+- Fouad Mardini
+- Jeremy Hinegardner
+- Nathan Witmer
+- ! '"shima"'
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-26 00:00:00.000000000Z
+date: 2012-02-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70159987765860 !ruby/object:Gem::Requirement
+  requirement: &70108731684080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -31,10 +41,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70159987765860
+  version_requirements: *70108731684080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70159987765360 !ruby/object:Gem::Requirement
+  requirement: &70108731667240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -42,10 +52,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70159987765360
+  version_requirements: *70108731667240
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70159987764860 !ruby/object:Gem::Requirement
+  requirement: &70108731666080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -53,10 +63,10 @@ dependencies:
         version: 3.9.4
   type: :development
   prerelease: false
-  version_requirements: *70159987764860
+  version_requirements: *70108731666080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70159987764380 !ruby/object:Gem::Requirement
+  requirement: &70108731665120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -64,7 +74,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70159987764380
+  version_requirements: *70108731665120
 description: RSolr aims to provide a simple and extensible library for working with
   Solr
 email:
@@ -113,12 +123,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -700646824116965374
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -700646824116965374
 requirements: []
 rubyforge_project: rsolr
 rubygems_version: 1.8.11