httparty 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2e263bc6000ec32578c99ef814398a9742be7a7
-  data.tar.gz: 9f8eb0a8ddb0100669e3f08c86fbde96b7c538d7
+  metadata.gz: 3ce26387d700f484cf57204fb8257bee96a79694
+  data.tar.gz: 6ba64cf5e2c870f84860b29b17fa1699480754d1
 SHA512:
-  metadata.gz: 4e02f9c9aab76af35b66bc0421d7322357a3a180f55cb50434259ce907d9cb536adaef681312fdee37648d8b558731c1c003d5bb57caa0000a187d24377449b3
-  data.tar.gz: 39286a8c98a2375f4fa60c98fb0ec3a5dd8828760029fcdefa054acce0da38cc20eb113cfbb6759a6df3f7ffaf7a9d62021c17ddb599318cf557ab70fdfedfad
+  metadata.gz: 727c7ec279835747b7da0fc3173fd7d3b260677f8eadb1a80251bbb093eb92f9e3fb999af539a55467b55aa3d119b78182497289b03cabf43026f8cdc594d900
+  data.tar.gz: 015463cb6bb232327e126308257dccff62d08cde88eb7dd57730f9dad28626e685464dc030c0ca3b4048424316ae97676b0ea6738ca74541daf5777bf0aeff17

data/README.md

@@ -18,37 +18,31 @@ gem install httparty
 
 ```ruby
 # Use the class methods to get down to business quickly
-response = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
-puts response.body, response.code, response.message, response.headers.inspect
+response = HTTParty.get('https://api.stackexchange.com/2.2/questions?site=stackoverflow')
 
-response.each do |item|
-  puts item['user']['screen_name']
-end
+puts response.body, response.code, response.message, response.headers.inspect
 
 # Or wrap things up in your own class
-class Twitter
+class StackExchange
   include HTTParty
-  base_uri 'twitter.com'
+  base_uri 'api.stackexchange.com'
 
-  def initialize(u, p)
-    @auth = {:username => u, :password => p}
+  def initialize(service, page)
+    @options = { :query => {:site => service, :page => page} }
   end
 
-  # which can be :friends, :user or :public
-  # options[:query] can be things like since, since_id, count, etc.
-  def timeline(which=:friends, options={})
-    options.merge!({:basic_auth => @auth})
-    self.class.get("/statuses/#{which}_timeline.json", options)
+  def questions
+    self.class.get("/2.2/questions", @options)
   end
 
-  def post(text)
-    options = { :body => {:status => text}, :basic_auth => @auth }
-    self.class.post('/statuses/update.json', options)
+  def users
+    self.class.get("/2.2/users", @options)
   end
 end
 
-twitter = Twitter.new(config['email'], config['password'])
-pp twitter.timeline
+stack_exchange = StackExchange.new("stackoverflow", 1)
+puts stack_exchange.questions
+puts stack_exchange.users
 ```
 
 See the [examples directory](http://github.com/jnunemaker/httparty/tree/master/examples) for even more goodies.
@@ -63,7 +57,7 @@ formatted XML or JSON. Execute `httparty --help` for all the
 options. Below is an example of how easy it is.
 
 ```
-httparty "http://twitter.com/statuses/public_timeline.json"
+httparty "https://api.stackexchange.com/2.2/questions?site=stackoverflow"
 ```
 
 ## Help and Docs

data/examples/basic.rb

@@ -3,13 +3,9 @@ require File.join(dir, 'httparty')
 require 'pp'
 
 # You can also use post, put, delete, head, options in the same fashion
-response = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
+response = HTTParty.get('https://api.stackexchange.com/2.2/questions?site=stackoverflow')
 puts response.body, response.code, response.message, response.headers.inspect
 
-response.each do |item|
-  puts item['user']['screen_name']
-end
-
 # An example post to a minimal rails app in the development environment
 # Note that "skip_before_filter :verify_authenticity_token" must be set in the
 # "pears" controller for this example

data/examples/stackexchange.rb

@@ -0,0 +1,24 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class StackExchange
+  include HTTParty
+  base_uri 'api.stackexchange.com'
+
+  def initialize(service, page)
+    @options = { :query => {:site => service, :page => page} }
+  end
+
+  def questions
+    self.class.get("/2.2/questions", @options)
+  end
+
+  def users
+    self.class.get("/2.2/users", @options)
+  end
+end
+
+stack_exchange = StackExchange.new("stackoverflow", 1)
+pp stack_exchange.questions
+pp stack_exchange.users

data/features/steps/httparty_steps.rb

@@ -2,6 +2,14 @@ When /^I set my HTTParty timeout option to (\d+)$/ do |timeout|
   @request_options[:timeout] = timeout.to_i
 end
 
+When /^I set my HTTParty open_timeout option to (\d+)$/ do |timeout|
+  @request_options[:open_timeout] = timeout.to_i
+end
+
+When /^I set my HTTParty read_timeout option to (\d+)$/ do |timeout|
+  @request_options[:read_timeout] = timeout.to_i
+end
+
 When /I call HTTParty#get with '(.*)'$/ do |url|
   begin
     @response_from_httparty = HTTParty.get("http://#{@host_and_port}#{url}", @request_options)

data/features/supports_read_timeout_option.feature

@@ -0,0 +1,13 @@
+Feature: Supports the read timeout option
+  In order to handle inappropriately slow response times
+  As a developer
+  I want my request to raise an exception after my specified read_timeout as elapsed
+
+  Scenario: A long running response
+    Given a remote service that returns '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/long_running_service.html'
+    And that service takes 2 seconds to generate a response
+    When I set my HTTParty read_timeout option to 1
+    And I call HTTParty#get with '/long_running_service.html'
+    Then it should raise a Timeout::Error exception
+    And I wait for the server to recover

data/lib/httparty.rb

@@ -176,6 +176,28 @@ module HTTParty
       default_options[:timeout] = t
     end
 
+    # Allows setting a default open_timeout for all HTTP calls in seconds
+    #
+    #   class Foo
+    #     include HTTParty
+    #     open_timeout 10
+    #   end
+    def open_timeout(t)
+      raise ArgumentError, 'open_timeout must be an integer or float' unless t && (t.is_a?(Integer) || t.is_a?(Float))
+      default_options[:open_timeout] = t
+    end
+
+    # Allows setting a default read_timeout for all HTTP calls in seconds
+    #
+    #   class Foo
+    #     include HTTParty
+    #     read_timeout 10
+    #   end
+    def read_timeout(t)
+      raise ArgumentError, 'read_timeout must be an integer or float' unless t && (t.is_a?(Integer) || t.is_a?(Float))
+      default_options[:read_timeout] = t
+    end
+
     # Set an output stream for debugging, defaults to $stderr.
     # The output stream is passed on to Net::HTTP#set_debug_output.
     #

data/lib/httparty/connection_adapter.rb

@@ -38,13 +38,16 @@ module HTTParty
   # in the #options attribute. It is up to you to interpret them within your
   # connection adapter. Take a look at the implementation of
   # HTTParty::ConnectionAdapter#connection for examples of how they are used.
-  # Something are probably interesting are as follows:
+  # Some things that are probably interesting are as follows:
   # * :+timeout+: timeout in seconds
+  # * :+open_timeout+: http connection open_timeout in seconds, overrides timeout if set
+  # * :+read_timeout+: http connection read_timeout in seconds, overrides timeout if set
   # * :+debug_output+: see HTTParty::ClassMethods.debug_output.
   # * :+pem+: contains pem data. see HTTParty::ClassMethods.pem.
+  # * :+verify+: verify the server’s certificate against the ca certificate.
   # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file.
   # * :+ssl_ca_path+: see HTTParty::ClassMethods.ssl_ca_path.
-  # * :+connection_adapter_options+: contains the hash your passed to HTTParty.connection_adapter when you configured your connection adapter
+  # * :+connection_adapter_options+: contains the hash you passed to HTTParty.connection_adapter when you configured your connection adapter
   class ConnectionAdapter
 
     # Private: Regex used to strip brackets from IPv6 URIs.
@@ -81,6 +84,14 @@ module HTTParty
         http.read_timeout = options[:timeout]
       end
 
+      if options[:read_timeout] && (options[:read_timeout].is_a?(Integer) || options[:read_timeout].is_a?(Float))
+        http.read_timeout = options[:read_timeout]
+      end
+
+      if options[:open_timeout] && (options[:open_timeout].is_a?(Integer) || options[:open_timeout].is_a?(Float))
+        http.open_timeout = options[:open_timeout]
+      end
+
       if options[:debug_output]
         http.set_debug_output(options[:debug_output])
       end

data/lib/httparty/request.rb

@@ -43,7 +43,7 @@ module HTTParty
     end
 
     def path=(uri)
-      @path = URI.parse(uri)
+      @path = URI(uri)
     end
 
     def request_uri(uri)
@@ -148,6 +148,7 @@ module HTTParty
     def setup_raw_request
       @raw_request = http_method.new(request_uri(uri))
       @raw_request.body = body if body
+      @raw_request.body_stream = options[:body_stream] if options[:body_stream]
       @raw_request.initialize_http_header(options[:headers])
       @raw_request.basic_auth(username, password) if options[:basic_auth]
       setup_digest_auth if options[:digest_auth]

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty
-  VERSION = "0.13.0"
+  VERSION = "0.13.1"
 end

data/spec/httparty/connection_adapter_spec.rb

@@ -153,6 +153,62 @@ describe HTTParty::ConnectionAdapter do
         end
       end
 
+      context "when timeout is not set and read_timeout is set to 6 seconds" do
+        let(:options) { {:read_timeout => 6} }
+
+        its(:read_timeout) { should == 6 }
+
+        it "should not set the open_timeout" do
+          http = mock("http", :null_object => true)
+          http.should_not_receive(:open_timeout=)
+          Net::HTTP.stub(:new => http)
+          adapter.connection
+        end
+      end
+
+      context "when timeout is set and read_timeout is set to 6 seconds" do
+        let(:options) { {:timeout => 5, :read_timeout => 6} }
+
+        its(:open_timeout) { should == 5 }
+        its(:read_timeout) { should == 6 }
+
+        it "should override the timeout option" do
+          http = mock("http", :null_object => true)
+          http.should_receive(:open_timeout=)
+          http.should_receive(:read_timeout=).twice
+          Net::HTTP.stub(:new => http)
+          adapter.connection
+        end
+      end
+
+      context "when timeout is not set and open_timeout is set to 7 seconds" do
+        let(:options) { {:open_timeout => 7} }
+
+        its(:open_timeout) { should == 7 }
+
+        it "should not set the read_timeout" do
+          http = mock("http", :null_object => true)
+          http.should_not_receive(:read_timeout=)
+          Net::HTTP.stub(:new => http)
+          adapter.connection
+        end
+      end
+
+      context "when timeout is set and open_timeout is set to 7 seconds" do
+        let(:options) { {:timeout => 5, :open_timeout => 7} }
+
+        its(:open_timeout) { should == 7 }
+        its(:read_timeout) { should == 5 }
+
+        it "should override the timeout option" do
+          http = mock("http", :null_object => true)
+          http.should_receive(:open_timeout=).twice
+          http.should_receive(:read_timeout=)
+          Net::HTTP.stub(:new => http)
+          adapter.connection
+        end
+      end
+
       context "when debug_output" do
         let(:http) { Net::HTTP.new(uri) }
         before do

data/spec/httparty/request_spec.rb

@@ -117,6 +117,13 @@ describe HTTParty::Request do
       @post_request.options[:digest_auth] = {:username => 'foobar', :password => 'secret'}
       @post_request.send(:setup_raw_request)
     end
+
+    it 'should use body_stream when configured' do
+      stream = StringIO.new('foo')
+      request = HTTParty::Request.new(Net::HTTP::Post, 'http://api.foo.com/v1', body_stream: stream)
+      request.send(:setup_raw_request)
+      request.instance_variable_get(:@raw_request).body_stream.should == stream
+    end
   end
 
   describe "#uri" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httparty
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - John Nunemaker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,6 +66,7 @@ files:
 - examples/headers_and_user_agents.rb
 - examples/nokogiri_html_parser.rb
 - examples/rubyurl.rb
+- examples/stackexchange.rb
 - examples/tripit_sign_in.rb
 - examples/twitter.rb
 - examples/whoismyrep.rb
@@ -80,6 +81,7 @@ files:
 - features/steps/httparty_steps.rb
 - features/steps/mongrel_helper.rb
 - features/steps/remote_service_steps.rb
+- features/supports_read_timeout_option.feature
 - features/supports_redirection.feature
 - features/supports_timeout_option.feature
 - httparty.gemspec
@@ -170,6 +172,7 @@ test_files:
 - features/steps/httparty_steps.rb
 - features/steps/mongrel_helper.rb
 - features/steps/remote_service_steps.rb
+- features/supports_read_timeout_option.feature
 - features/supports_redirection.feature
 - features/supports_timeout_option.feature
 - spec/fixtures/delicious.xml