rest-client 2.0.0.rc3 → 2.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00d482930d5a23ea6691e9cd260234e0b83bb124
-  data.tar.gz: 734cde1c12c43e1bd3cbaad9067e2be8e8436249
+  metadata.gz: 68b80b5b33ba926c8c3a2b4c0aac27b4e7f756f0
+  data.tar.gz: ba56b4b86dc27028889674a840132c6f88671f9f
 SHA512:
-  metadata.gz: 96b11113afe2fd9031994baa142c3a3d9888019de75bcc81aba15c98867a73a786cc04402810dfd6163f4ae50657770b709df70fb6d5e02d26e646416ca9ae8f
-  data.tar.gz: e53c56269bc64ba6bdbe333e58832f298e77bd0017f4645f679e0f660f4f8bca8fa5d78bcbbfe69aa9b24542483786ea93322054e1c40f671b7742f81b3b7a31
+  metadata.gz: c83b06c417fd471f0c80ad5a7f93c645a5748ebec48785269c8af59e198c8cb9b7b6b52c0c36be48c6c9c0cee61e9faacafe5e4012ca8be655b0edf739d0b799
+  data.tar.gz: cea931e95b38351d4c6236189fbb781a1f2e0067eb95e3d65d94bae1eddeff7217158d1a3ca5875747371d7ceb5cd98fe2cb3fd0e189ed0db322cc913c1428b8

data/README.md

@@ -177,6 +177,38 @@ end
 ➔ 404 Resource Not Found | text/html 282 bytes
 ```
 
+### Manually following redirection
+
+To disable automatic redirection, set `:max_redirects => 0`.
+
+```ruby
+>> RestClient::Request.execute(method: :get, url: 'http://httpbin.org/redirect/1')
+=> RestClient::Response 200 "{\n  "args":..."
+
+>> RestClient::Request.execute(method: :get, url: 'http://httpbin.org/redirect/1', max_redirects: 0)
+RestClient::Found: 302 Found
+```
+
+To manually follow redirection, you can call `Response#follow_redirection`. Or
+you could of course inspect the result and choose custom behavior.
+
+```ruby
+>> RestClient::Request.execute(method: :get, url: 'http://httpbin.org/redirect/1', max_redirects: 0)
+RestClient::Found: 302 Found
+>> begin
+       RestClient::Request.execute(method: :get, url: 'http://httpbin.org/redirect/1', max_redirects: 0)
+   rescue RestClient::ExceptionWithResponse => err
+   end
+>> err
+=> #<RestClient::Found: 302 Found>
+>> err.response
+=> RestClient::Response 302 "<!DOCTYPE H..."
+>> err.response.headers[:location]
+=> "/get"
+>> err.response.follow_redirection
+=> RestClient::Response 200 "{\n  "args":..."
+```
+
 ## Result handling
 
 The result of a `RestClient::Request` is a `RestClient::Response` object.

data/history.md

@@ -8,7 +8,7 @@ This release is largely API compatible, but makes several breaking changes.
   rest-client would not override the string encoding chosen by Net::HTTP. Now
   responses that specify a charset will yield a body string in that encoding.
   For example, `Content-Type: text/plain; charset=EUC-JP` will return a String
-  encoded with `Encoding::EUC_JP`.
+  encoded with `Encoding::EUC_JP`. (#361)
 - Change exceptions raised on request timeout. Instead of
   `RestClient::RequestTimeout` (which is still used for HTTP 408), network
   timeouts will now raise either `RestClient::Exceptions::ReadTimeout` or
@@ -48,8 +48,8 @@ This release is largely API compatible, but makes several breaking changes.
   Set-Cookie, which is special) by joining the values with a comma space,
   compliant with RFC 7230
 - Rewrite cookie support to be much smarter and to use cookie jars consistently
-  for requests, responses, and redirection (resolving long-standing complaints
-  about the previously broken behavior):
+  for requests, responses, and redirection in order to resolve long-standing
+  complaints about the previously broken behavior: (#498)
   - The `:cookies` option may now be a Hash of Strings, an Array of
     HTTP::Cookie objects, or a full HTTP::CookieJar.
   - Add `RestClient::Request#cookie_jar` and reimplement `Request#cookies` to
@@ -73,7 +73,7 @@ This release is largely API compatible, but makes several breaking changes.
   treat any object that responds to `.read` as a streaming payload and pass it
   through to `.body_stream=` on the Net:HTTP object. This massively reduces the
   memory required for large file uploads.
-- Changes to redirection behavior:
+- Changes to redirection behavior: (#381, #484)
   - Remove `RestClient::MaxRedirectsReached` in favor of the normal
     `ExceptionWithResponse` subclasses. This makes the response accessible on
     the exception object as `.response`, making it possible for callers to tell
@@ -90,7 +90,14 @@ This release is largely API compatible, but makes several breaking changes.
 - Run tests on Travis's beta OS X support.
 - Make `Request#transmit` a private method, along with a few others.
 - Refactor URI parsing to happen earlier, in Request initialization.
-- When adding URL params, handle URLs that already contain params.
+- Improve consistency and functionality of complex URL parameter handling:
+  - When adding URL params, handle URLs that already contain params.
+  - Add new convention for handling URL params containing deeply nested arrays
+    and hashes, unify handling of null/empty values, and use the same code for
+    GET and POST params. (#437)
+  - Add the RestClient::ParamsArray class, a simple array-like container that
+    can be used to pass multiple keys with same name or keys where the ordering
+    is significant.
 - Add a few more exception classes for obscure HTTP status codes.
 - Multipart: use a much more robust multipart boundary with greater entropy.
 - Make `RestClient::Payload::Base#inspect` stop pretending to be a String.

data/lib/restclient/request.rb

@@ -132,8 +132,10 @@ module RestClient
       @cookie_jar = process_cookie_args!(@uri, @headers, args)
 
       @payload = Payload.generate(args[:payload])
-      @user = args[:user]
-      @password = args[:password]
+
+      @user = args[:user] if args.include?(:user)
+      @password = args[:password] if args.include?(:password)
+
       if args.include?(:timeout)
         @read_timeout = args[:timeout]
         @open_timeout = args[:timeout]

data/lib/restclient/version.rb

@@ -1,5 +1,5 @@
 module RestClient
-  VERSION_INFO = [2, 0, 0, 'rc3'] unless defined?(self::VERSION_INFO)
+  VERSION_INFO = [2, 0, 0, 'rc4'] unless defined?(self::VERSION_INFO)
   VERSION = VERSION_INFO.map(&:to_s).join('.') unless defined?(self::VERSION)
 
   def self.version

data/spec/integration/httpbin_spec.rb

@@ -68,5 +68,19 @@ describe RestClient::Request do
         expect(ex.response.cookies['foo']).to eq '"bar:baz"'
       }
     end
+
+    it 'sends basic auth' do
+      user = 'user'
+      pass = 'pass'
+
+      data = execute_httpbin_json("basic-auth/#{user}/#{pass}", method: :get, user: user, password: pass)
+      expect(data).to eq({'authenticated' => true, 'user' => user})
+
+      expect {
+        execute_httpbin_json("basic-auth/#{user}/#{pass}", method: :get, user: user, password: 'badpass')
+      }.to raise_error(RestClient::Unauthorized) { |ex|
+        expect(ex.http_code).to eq 401
+      }
+    end
   end
 end

data/spec/unit/request_spec.rb

@@ -103,25 +103,33 @@ describe RestClient::Request, :include_helpers do
 
   describe "user - password" do
     it "extracts the username and password when parsing http://user:password@example.com/" do
-      allow(URI).to receive(:parse).and_return(double('uri', user: 'joe', password: 'pass1', hostname: 'example.com'))
       @request.send(:parse_url_with_auth!, 'http://joe:pass1@example.com/resource')
       expect(@request.user).to eq 'joe'
       expect(@request.password).to eq 'pass1'
     end
 
     it "extracts with escaping the username and password when parsing http://user:password@example.com/" do
-      allow(URI).to receive(:parse).and_return(double('uri', user: 'joe%20', password: 'pass1', hostname: 'example.com'))
       @request.send(:parse_url_with_auth!, 'http://joe%20:pass1@example.com/resource')
       expect(@request.user).to eq 'joe '
       expect(@request.password).to eq 'pass1'
     end
 
     it "doesn't overwrite user and password (which may have already been set by the Resource constructor) if there is no user/password in the url" do
-      allow(URI).to receive(:parse).and_return(double('uri', user: nil, password: nil, hostname: 'example.com'))
-      @request = RestClient::Request.new(:method => 'get', :url => 'example.com', :user => 'beth', :password => 'pass2')
-      @request.send(:parse_url_with_auth!, 'http://example.com/resource')
-      expect(@request.user).to eq 'beth'
-      expect(@request.password).to eq 'pass2'
+      request = RestClient::Request.new(method: :get, url: 'http://example.com/resource', user: 'beth', password: 'pass2')
+      expect(request.user).to eq 'beth'
+      expect(request.password).to eq 'pass2'
+    end
+
+    it 'uses the username and password from the URL' do
+      request = RestClient::Request.new(method: :get, url: 'http://person:secret@example.com/resource')
+      expect(request.user).to eq 'person'
+      expect(request.password).to eq 'secret'
+    end
+
+    it 'overrides URL user/pass with explicit options' do
+      request = RestClient::Request.new(method: :get, url: 'http://person:secret@example.com/resource', user: 'beth', password: 'pass2')
+      expect(request.user).to eq 'beth'
+      expect(request.password).to eq 'pass2'
     end
   end
 
@@ -253,19 +261,17 @@ describe RestClient::Request, :include_helpers do
   end
 
   it "uses netrc credentials" do
-    allow(URI).to receive(:parse).and_return(double('uri', :user => nil, :password => nil, :hostname => 'example.com'))
-    allow(Netrc).to receive(:read).and_return('example.com' => ['a', 'b'])
-    @request.send(:parse_url_with_auth!, 'http://example.com/resource')
-    expect(@request.user).to eq 'a'
-    expect(@request.password).to eq 'b'
+    expect(Netrc).to receive(:read).and_return('example.com' => ['a', 'b'])
+    request = RestClient::Request.new(:method => :put, :url => 'http://example.com/', :payload => 'payload')
+    expect(request.user).to eq 'a'
+    expect(request.password).to eq 'b'
   end
 
   it "uses credentials in the url in preference to netrc" do
-    allow(URI).to receive(:parse).and_return(double('uri', :user => 'joe%20', :password => 'pass1', :hostname => 'example.com'))
     allow(Netrc).to receive(:read).and_return('example.com' => ['a', 'b'])
-    @request.send(:parse_url_with_auth!, 'http://joe%20:pass1@example.com/resource')
-    expect(@request.user).to eq 'joe '
-    expect(@request.password).to eq 'pass1'
+    request = RestClient::Request.new(:method => :put, :url =>  'http://joe%20:pass1@example.com/', :payload => 'payload')
+    expect(request.user).to eq 'joe '
+    expect(request.password).to eq 'pass1'
   end
 
   it "determines the Net::HTTP class to instantiate by the method name" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-client
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc3
+  version: 2.0.0.rc4
 platform: ruby
 authors:
 - REST Client Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock