Merge pull request rest-client#499 from rest-client/ab-rspec-3

Upgrade to RSpec 3.0

Author: ab

.rubocop-disables.yml

@@ -21,6 +21,14 @@ Lint/Eval:
   Exclude:
   - rest-client.windows.gemspec
 
+Lint/HandleExceptions:
+  Exclude:
+  - lib/restclient/utils.rb
+
+Lint/UselessAccessModifier:
+  Exclude:
+  - lib/restclient/windows/root_certs.rb
+
 # Offense count: 4
 # Cop supports --auto-correct.
 Style/Alias:
@@ -35,7 +43,7 @@ Style/AndOr:
 # TODO
 # Offense count: 3
 # Cop supports --auto-correct.
-Style/Blocks:
+Style/BlockDelimiters:
   Enabled: false
 
 # Offense count: 48
@@ -90,6 +98,9 @@ Style/CollectionMethods:
 Style/ColonMethodCall:
   Enabled: false
 
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_inside_condition
+
 # Offense count: 2
 Style/ConstantName:
   Enabled: false
@@ -161,12 +172,11 @@ Style/FileName:
 Style/FormatString:
   Enabled: false
 
-# TODO: configure
-# Offense count: 514
+# TODO: enable
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles.
 Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+  Enabled: false
 
 # NOTABUG
 # Offense count: 8
@@ -337,10 +347,9 @@ Style/SpaceInsideParens:
 Style/StringLiterals:
   Enabled: false
 
-# NOTABUG
-# Offense count: 14
-# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
-Style/TrailingComma:
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
   Enabled: false
 
 # TODO: configure

lib/restclient.rb

@@ -94,8 +94,9 @@ def self.options(url, headers={}, &block)
   # A global proxy URL to use for all requests. This can be overridden on a
   # per-request basis by passing `:proxy` to RestClient::Request.
   def self.proxy
-    @proxy
+    @proxy ||= nil
   end
+
   def self.proxy=(value)
     @proxy = value
     @proxy_set = true

lib/restclient/abstract_response.rb

@@ -64,7 +64,7 @@ def cookies
     # @return [HTTP::CookieJar]
     #
     def cookie_jar
-      return @cookie_jar if @cookie_jar
+      return @cookie_jar if defined?(@cookie_jar) && @cookie_jar
 
       jar = @request.cookie_jar.dup
       headers.fetch(:set_cookie, []).each do |cookie|
@@ -152,7 +152,7 @@ def follow_get_redirection(&block)
     #
     def self.beautify_headers(headers)
       headers.inject({}) do |out, (key, value)|
-        key_sym = key.gsub(/-/, '_').downcase.to_sym
+        key_sym = key.tr('-', '_').downcase.to_sym
 
         # Handle Set-Cookie specially since it cannot be joined by comma.
         if key.downcase == 'set-cookie'

lib/restclient/payload.rb

@@ -174,7 +174,7 @@ def mime_for(path)
       end
 
       def boundary
-        return @boundary if @boundary
+        return @boundary if defined?(@boundary) && @boundary
 
         # Use the same algorithm used by WebKit: generate 16 random
         # alphanumeric characters, replacing `+` `/` with `A` `B` (included in

lib/restclient/request.rb

@@ -124,6 +124,8 @@ def initialize args
       else
         raise ArgumentError, "must pass :url"
       end
+
+      @user = @password = nil
       parse_url_with_auth!(url)
 
       # process cookie arguments found in headers or args
@@ -815,7 +817,7 @@ def fetch_body(http_response)
         # Kudos to _why!
         @tf = Tempfile.new('rest-client.')
         @tf.binmode
-        size, total = 0, http_response.header['Content-Length'].to_i
+        size, total = 0, http_response['Content-Length'].to_i
         http_response.read_body do |chunk|
           @tf.write chunk
           size += chunk.size

lib/restclient/response.rb

@@ -47,8 +47,6 @@ def self.create(body, net_http_res, request)
       result
     end
 
-    private
-
     def self.fix_encoding(response)
       charset = RestClient::Utils.get_encoding_from_headers(response.headers)
       encoding = nil
@@ -68,6 +66,8 @@ def self.fix_encoding(response)
       response
     end
 
+    private
+
     def body_truncated(length)
       b = body
       if b.length > length

rest-client.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.summary = 'Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions.'
 
   s.add_development_dependency('webmock', '~> 2.0')
-  s.add_development_dependency('rspec', '~> 2.99')
+  s.add_development_dependency('rspec', '~> 3.0')
   s.add_development_dependency('pry', '~> 0')
   s.add_development_dependency('pry-doc', '~> 0')
   s.add_development_dependency('rdoc', '>= 2.4.2', '< 5.0')

spec/integration/httpbin_spec.rb

@@ -41,31 +41,31 @@ def execute_httpbin_json(suffix, opts={})
   describe '.execute' do
     it 'sends a user agent' do
       data = execute_httpbin_json('user-agent', method: :get)
-      data['user-agent'].should match(/rest-client/)
+      expect(data['user-agent']).to match(/rest-client/)
     end
 
     it 'receives cookies on 302' do
       expect {
         execute_httpbin('cookies/set?foo=bar', method: :get, max_redirects: 0)
       }.to raise_error(RestClient::Found) { |ex|
-        ex.http_code.should eq 302
-        ex.response.cookies['foo'].should eq 'bar'
+        expect(ex.http_code).to eq 302
+        expect(ex.response.cookies['foo']).to eq 'bar'
       }
     end
 
     it 'passes along cookies through 302' do
       data = execute_httpbin_json('cookies/set?foo=bar', method: :get)
-      data.should have_key('cookies')
-      data['cookies']['foo'].should eq 'bar'
+      expect(data).to have_key('cookies')
+      expect(data['cookies']['foo']).to eq 'bar'
     end
 
     it 'handles quote wrapped cookies' do
       expect {
         execute_httpbin('cookies/set?foo=' + CGI.escape('"bar:baz"'),
                         method: :get, max_redirects: 0)
       }.to raise_error(RestClient::Found) { |ex|
-        ex.http_code.should eq 302
-        ex.response.cookies['foo'].should eq '"bar:baz"'
+        expect(ex.http_code).to eq 302
+        expect(ex.response.cookies['foo']).to eq '"bar:baz"'
       }
     end
   end

spec/integration/integration_spec.rb

@@ -8,15 +8,15 @@
     body = 'abc'
     stub_request(:get, "www.example.com").to_return(:body => body, :status => 200)
     response = RestClient.get "www.example.com"
-    response.code.should eq 200
-    response.body.should eq body
+    expect(response.code).to eq 200
+    expect(response.body).to eq body
   end
 
   it "a simple request with gzipped content" do
     stub_request(:get, "www.example.com").with(:headers => { 'Accept-Encoding' => 'gzip, deflate' }).to_return(:body => "\037\213\b\b\006'\252H\000\003t\000\313T\317UH\257\312,HM\341\002\000G\242(\r\v\000\000\000", :status => 200,  :headers => { 'Content-Encoding' => 'gzip' } )
     response = RestClient.get "www.example.com"
-    response.code.should eq 200
-    response.body.should eq "i'm gziped\n"
+    expect(response.code).to eq 200
+    expect(response.body).to eq "i'm gziped\n"
   end
 
   it "a 404" do
@@ -26,10 +26,10 @@
       RestClient.get "www.example.com"
       raise
     rescue RestClient::ResourceNotFound => e
-      e.http_code.should eq 404
-      e.response.code.should eq 404
-      e.response.body.should eq body
-      e.http_body.should eq body
+      expect(e.http_code).to eq 404
+      expect(e.response.code).to eq 404
+      expect(e.response.body).to eq body
+      expect(e.http_body).to eq body
     end
   end
 
@@ -41,8 +41,8 @@
           'Content-Type' => 'text/plain; charset=UTF-8'
       })
       response = RestClient.get "www.example.com"
-      response.encoding.should eq Encoding::UTF_8
-      response.valid_encoding?.should eq true
+      expect(response.encoding).to eq Encoding::UTF_8
+      expect(response.valid_encoding?).to eq true
     end
 
     it 'handles windows-1252' do
@@ -52,9 +52,9 @@
           'Content-Type' => 'text/plain; charset=windows-1252'
       })
       response = RestClient.get "www.example.com"
-      response.encoding.should eq Encoding::WINDOWS_1252
-      response.encode('utf-8').should eq "ÿ"
-      response.valid_encoding?.should eq true
+      expect(response.encoding).to eq Encoding::WINDOWS_1252
+      expect(response.encode('utf-8')).to eq "ÿ"
+      expect(response.valid_encoding?).to eq true
     end
 
     it 'handles binary' do
@@ -64,28 +64,28 @@
           'Content-Type' => 'application/octet-stream; charset=binary'
       })
       response = RestClient.get "www.example.com"
-      response.encoding.should eq Encoding::BINARY
-      lambda {
+      expect(response.encoding).to eq Encoding::BINARY
+      expect {
         response.encode('utf-8')
-      }.should raise_error(Encoding::UndefinedConversionError)
-      response.valid_encoding?.should eq true
+      }.to raise_error(Encoding::UndefinedConversionError)
+      expect(response.valid_encoding?).to eq true
     end
 
     it 'handles euc-jp' do
       body = "\xA4\xA2\xA4\xA4\xA4\xA6\xA4\xA8\xA4\xAA".
         force_encoding(Encoding::BINARY)
       body_utf8 = 'あいうえお'
-      body_utf8.encoding.should eq Encoding::UTF_8
+      expect(body_utf8.encoding).to eq Encoding::UTF_8
 
       stub_request(:get, 'www.example.com').to_return(
         :body => body, :status => 200, :headers => {
           'Content-Type' => 'text/plain; charset=EUC-JP'
       })
       response = RestClient.get 'www.example.com'
-      response.encoding.should eq Encoding::EUC_JP
-      response.valid_encoding?.should eq true
-      response.length.should eq 5
-      response.encode('utf-8').should eq body_utf8
+      expect(response.encoding).to eq Encoding::EUC_JP
+      expect(response.valid_encoding?).to eq true
+      expect(response.length).to eq 5
+      expect(response.encode('utf-8')).to eq body_utf8
     end
 
     it 'defaults to Encoding.default_external' do
@@ -95,7 +95,7 @@
         })
 
       response = RestClient.get 'www.example.com'
-      response.encoding.should eq Encoding.default_external
+      expect(response.encoding).to eq Encoding.default_external
     end
 
     it 'handles invalid encoding' do
@@ -105,7 +105,7 @@
         })
 
       response = RestClient.get 'www.example.com'
-      response.encoding.should eq Encoding.default_external
+      expect(response.encoding).to eq Encoding.default_external
     end
 
     it 'leaves images as binary' do
@@ -117,7 +117,7 @@
         })
 
       response = RestClient.get 'www.example.com'
-      response.encoding.should eq Encoding::BINARY
+      expect(response.encoding).to eq Encoding::BINARY
     end
   end
 end

spec/integration/request_spec.rb

@@ -75,7 +75,7 @@
         },
       )
       expect {request.execute }.to_not raise_error
-      ran_callback.should eq(true)
+      expect(ran_callback).to eq(true)
     end
 
     it "fails verification when the callback returns false",