rest-client 2.0.0.rc4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68b80b5b33ba926c8c3a2b4c0aac27b4e7f756f0
-  data.tar.gz: ba56b4b86dc27028889674a840132c6f88671f9f
+  metadata.gz: 9f1a91416eb9ce25f4334a31215472eee28d3835
+  data.tar.gz: 6cbd00246b48690123c0fe37ddc2aa2d279fce29
 SHA512:
-  metadata.gz: c83b06c417fd471f0c80ad5a7f93c645a5748ebec48785269c8af59e198c8cb9b7b6b52c0c36be48c6c9c0cee61e9faacafe5e4012ca8be655b0edf739d0b799
-  data.tar.gz: cea931e95b38351d4c6236189fbb781a1f2e0067eb95e3d65d94bae1eddeff7217158d1a3ca5875747371d7ceb5cd98fe2cb3fd0e189ed0db322cc913c1428b8
+  metadata.gz: 985246f04e76d0fd7c191b8c0d8d83ae8a173d6369b96142a038c7b320b1af2123f80e265b7a2b5e82966570bec794b467e5df72f0196003611f791ed6826454
+  data.tar.gz: 80f8d55c65385636b7381861a9f8dd9df2c35afe0940656e2f391715cd1526bb9d6dc75db51bed0b83ae55d954d7b8e9604c3ce8075a776b92d7e2601d048413

data/README.md

@@ -45,6 +45,35 @@ There are also several development dependencies. It's recommended to use
 [bundler](http://bundler.io/) to manage these dependencies for hacking on
 rest-client.
 
+### Upgrading to rest-client 2.0 from 1.x
+
+Users are encouraged to upgrade to rest-client 2.0, which cleans up a number of
+API warts and wrinkles, making rest-client generally more useful. Usage is
+largely compatible, so many applications will be able to upgrade with no
+changes.
+
+Overview of significant changes:
+
+* requires Ruby >= 2.0
+* `RestClient::Response` objects are a subclass of `String` rather than a
+  Frankenstein monster. And `#body` or `#to_s` return a true `String` object.
+* cleanup of exception classes, including new `RestClient::Exceptions::Timeout`
+* improvements to handling of redirects: responses and history are properly
+  exposed
+* major changes to cookie support: cookie jars are used for browser-like
+  behavior throughout
+* encoding: Content-Type charset response headers are used to automatically set
+  the encoding of the response string
+* HTTP params: handling of GET/POST params is more consistent and sophisticated
+  for deeply nested hash objects, and `ParamsArray` can be used to pass ordered
+  params
+* improved proxy support with per-request proxy configuration, plus the ability
+  to disable proxies set by environment variables
+* default request headers: rest-client sets `Accept: */*` and
+  `User-Agent: rest-client/...`
+
+See [history.md](./history.md) for a more complete description of changes.
+
 ## Usage: Raw URL
 ```ruby
 require 'rest-client'
@@ -177,10 +206,38 @@ end
 ➔ 404 Resource Not Found | text/html 282 bytes
 ```
 
-### Manually following redirection
+### Redirection
+
+By default, rest-client will follow HTTP 30x redirection requests.
+
+__New in 2.0:__ `RestClient::Response` exposes a `#history` method that returns
+a list of each response received in a redirection chain.
+
+```ruby
+>> r = RestClient.get('http://httpbin.org/redirect/2')
+=> <RestClient::Response 200 "{\n  \"args\":...">
+
+# see each response in the redirect chain
+>> r.history
+=> [<RestClient::Response 302 "<!DOCTYPE H...">, <RestClient::Response 302 "">]
+
+# see each requested URL
+>> r.request.url
+=> "http://httpbin.org/get"
+>> r.history.map {|x| x.request.url}
+=> ["http://httpbin.org/redirect/2", "http://httpbin.org/relative-redirect/1"]
+```
+
+#### Manually following redirection
 
 To disable automatic redirection, set `:max_redirects => 0`.
 
+__New in 2.0:__ Prior versions of rest-client would raise
+`RestClient::MaxRedirectsReached`, with no easy way to access the server's
+response. In 2.0, rest-client raises the normal
+`RestClient::ExceptionWithResponse` as it would with any other non-HTTP-20x
+response.
+
 ```ruby
 >> RestClient::Request.execute(method: :get, url: 'http://httpbin.org/redirect/1')
 => RestClient::Response 200 "{\n  "args":..."
@@ -226,7 +283,7 @@ Response objects have several useful methods. (See the class rdoc for more detai
 - `Response#cookies`: A hash of HTTP cookies set by the server
 - `Response#cookie_jar`: <em>New in 1.8</em> An HTTP::CookieJar of cookies
 - `Response#request`: The RestClient::Request object used to make the request
-- `Response#history`: If redirection was followed, a list of prior Response objects
+- `Response#history`: <em>New in 2.0</em> If redirection was followed, a list of prior Response objects
 
 ```ruby
 RestClient.get('http://example.com')

data/lib/restclient/request.rb

@@ -59,6 +59,10 @@ module RestClient
     #
     # This list will be used by default if the Ruby global OpenSSL default
     # ciphers appear to be a weak list.
+    #
+    # TODO: either remove this code or always use it, since Ruby uses a decent
+    # cipher list in versions >= 2.0.
+    #
     DefaultCiphers = %w{
       !aNULL
       !eNULL

data/lib/restclient/utils.rb

@@ -8,8 +8,8 @@ module RestClient
     # text. This differs from the older RFC 2616 behavior, which specifies
     # using ISO-8859-1 for text/* content types without a charset.
     #
-    # Strings will effectively end up using `Encoding.default_external` when
-    # this method returns nil.
+    # Strings will use the default encoding when this method returns nil. This
+    # default is likely to be UTF-8 for Ruby >= 2.0
     #
     # @param headers [Hash<Symbol,String>]
     #

data/lib/restclient/version.rb

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

data/spec/integration/integration_spec.rb

@@ -88,14 +88,15 @@ describe RestClient do
       expect(response.encode('utf-8')).to eq body_utf8
     end
 
-    it 'defaults to Encoding.default_external' do
+    it 'defaults to the default encoding' do
       stub_request(:get, 'www.example.com').to_return(
         body: 'abc', status: 200, headers: {
           'Content-Type' => 'text/plain'
         })
 
       response = RestClient.get 'www.example.com'
-      expect(response.encoding).to eq Encoding.default_external
+      # expect(response.encoding).to eq Encoding.default_external
+      expect(response.encoding).to eq Encoding::UTF_8
     end
 
     it 'handles invalid encoding' do
@@ -105,7 +106,8 @@ describe RestClient do
         })
 
       response = RestClient.get 'www.example.com'
-      expect(response.encoding).to eq Encoding.default_external
+      # expect(response.encoding).to eq Encoding.default_external
+      expect(response.encoding).to eq Encoding::UTF_8
     end
 
     it 'leaves images as binary' do

data/spec/unit/request_spec.rb

@@ -567,7 +567,8 @@ describe RestClient::Request, :include_helpers do
       allow(ENV).to receive(:[]).with("http_proxy").and_return("http://127.0.0.1")
       allow(ENV).to receive(:[]).with("no_proxy").and_return(nil)
       allow(ENV).to receive(:[]).with("NO_PROXY").and_return(nil)
-      allow(ENV).to receive(:[]).with("NETRC").and_return(nil)
+      allow(Netrc).to receive(:read).and_return({})
+
       req = RestClient::Request.new(:method => :put, :url => 'http://some/resource', :payload => 'payload')
       obj = req.net_http_object('host', 80)
       expect(obj.proxy?).to be true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-client
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc4
+  version: 2.0.0
 platform: ruby
 authors:
 - REST Client Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-19 00:00:00.000000000 Z
+date: 2016-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -239,9 +239,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1