rest-client 2.0.2 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10312217af6f5a0312bdce748c8fd82f428fce64
-  data.tar.gz: 67846732a7926b335a7082eb1fba0b7178f0c5c4
+  metadata.gz: be555e32d656143a98153988f6758f7ca828a0b7
+  data.tar.gz: efde23cfc811c084a5a34e1b6584bac05871b500
 SHA512:
-  metadata.gz: 56d9d3140ee5418e9b4e877e9756bbb1a1858314c4487b5d7e41ca5fc72f70532f764dcf480c8c3098f4297025fa66c7d8db0bd890e9ae46459e7478a34a685a
-  data.tar.gz: 812f11c8a6c2c4ac5ec68852e75f64ae2d7416ae4683f5ff6525055dbf8e472baed3cc01a85eb76e5da2cb39233ff2dc2129cbdab7165dec89637987b346359b
+  metadata.gz: 7bad368b009578eb64f2194a5c6c2adddb908e16d2f6388a9cf8fc2a62da56adbdcaf15c1e9057a13fb9ddd4ee606b87213687c6934387cdf49e7e0c2819c093
+  data.tar.gz: 8ba37282e55441392e706a70d25ad73c2b24166d378167ae29e3389fd092c9f344248aaa2aab0d81d4f250e9240f8cd75cd10739fb09984e4293cf0ceac1d9e1

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg
 /rdoc
 /.yardoc
+/tmp

data/.mailmap

@@ -0,0 +1,10 @@
+Blake Mizerany <blake.mizerany@gmail.com>
+Lawrence Leonard Gilbert <larry@l2g.to>
+<larry@l2g.to> <larry@L2G.to>
+Marc-André Cournoyer <macournoyer@gmail.com>
+Matthew Manning <matt.manning@gmail.com>
+Nicholas Wieland <nicholas.wieland@gmail.com>
+Rafael Ssouza <rafael.ssouza@gmail.com>
+Richard Schneeman <richard.schneeman@gmail.com>
+Rick Olson <technoweenie@gmail.com>
+T. Watanabe <wtnabe@wt-srv.watanabe>

data/.rubocop

@@ -0,0 +1,2 @@
+--display-cop-names
+--fail-level=W

data/.rubocop-disables.yml

@@ -17,7 +17,7 @@ Lint/StringConversionInInterpolation:
 Lint/UnusedBlockArgument:
   Enabled: false
 
-Lint/Eval:
+Security/Eval:
   Exclude:
   - rest-client.windows.gemspec
 
@@ -110,10 +110,8 @@ Style/ConstantName:
 Metrics/CyclomaticComplexity:
   Max: 22
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/DeprecatedHashMethods:
-  Enabled: false
+Style/PreferredHashMethods:
+  EnforcedStyle: verbose
 
 # TODO: docs
 # Offense count: 17
@@ -122,7 +120,7 @@ Style/Documentation:
 
 # Offense count: 9
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/DotPosition:
+Layout/DotPosition:
   Enabled: false
 
 # Offense count: 1
@@ -136,24 +134,27 @@ Style/EachWithObject:
 
 # Offense count: 5
 # Cop supports --auto-correct.
-Style/EmptyLines:
+Layout/EmptyLines:
   Enabled: false
 
 # Offense count: 11
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundClassBody:
+Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
 # Offense count: 1
 # Cop supports --auto-correct.
-Style/EmptyLinesAroundMethodBody:
+Layout/EmptyLinesAroundMethodBody:
   Enabled: false
 
 # Offense count: 9
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundModuleBody:
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
   Enabled: false
 
 # Offense count: 31
@@ -188,7 +189,7 @@ Style/IfUnlessModifier:
 # Offense count: 6
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/IndentHash:
+Layout/IndentHash:
   Enabled: false
 
 # NOTABUG
@@ -199,14 +200,13 @@ Style/Lambda:
 # TODO
 # Offense count: 14
 # Cop supports --auto-correct.
-Style/LeadingCommentSpace:
+Layout/LeadingCommentSpace:
   Enabled: false
 
-# TODO
-# Offense count: 218
-# Configuration parameters: AllowURI.
 Metrics/LineLength:
-  Max: 340
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'Rakefile'
 
 # TODO
 # Offense count: 28
@@ -298,47 +298,50 @@ Style/SignalException:
 # TODO
 # Offense count: 2
 # Cop supports --auto-correct.
-Style/SpaceAfterNot:
+Layout/SpaceAfterNot:
   Enabled: false
 
 # Offense count: 19
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SpaceAroundEqualsInParameterDefault:
+Layout/SpaceAroundEqualsInParameterDefault:
   Enabled: false
 
 # Offense count: 20
 # Cop supports --auto-correct.
-Style/SpaceAroundOperators:
+Layout/SpaceAroundOperators:
   Enabled: false
 
 # Offense count: 9
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SpaceBeforeBlockBraces:
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 
 # Offense count: 37
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-Style/SpaceInsideBlockBraces:
+Layout/SpaceInsideBlockBraces:
   Enabled: false
 
 # Offense count: 6
 # Cop supports --auto-correct.
-Style/SpaceInsideBrackets:
+Layout/SpaceInsideBrackets:
   Enabled: false
 
 # Offense count: 181
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
 
 # TODO
 # Offense count: 9
 # Cop supports --auto-correct.
-Style/SpaceInsideParens:
+Layout/SpaceInsideParens:
   Enabled: false
 
 # Offense count: 414

data/.rubocop.yml

@@ -1,3 +1,8 @@
 ---
 inherit_from:
 - .rubocop-disables.yml
+
+AllCops:
+  Exclude:
+    - 'tmp/*.rb'
+    - 'vendor/**/*'

data/.travis.yml

@@ -20,7 +20,8 @@ rvm:
 cache: bundler
 
 script:
-  bundle exec rake test
+  - bundle exec rake test
+  - bundle exec rake rubocop
 
 branches:
   except:

data/AUTHORS

@@ -7,6 +7,7 @@ Adrian Rangel
 Alex Tomlins
 Aman Gupta
 Andy Brody
+Avi Deitcher
 Blake Mizerany
 Brad Ediger
 Braintree
@@ -38,10 +39,12 @@ Harm Aarts
 Hiro Asari
 Hugh McGowan
 Ian Warshak
+Igor Zubkov
 Ivan Makfinsky
 JH. Chabran
 James Edward Gray II
 Jari Bakken
+Jeff Pereira
 Jeff Remer
 Jeffrey Hardy
 Jeremy Kemper
@@ -59,12 +62,14 @@ Keith Rarick
 Kenichi Kamiya
 Kevin Read
 Kosuke Asami
+Kyle Meyer
 Kyle VanderBeek
 Lars Gierth
 Lawrence Leonard Gilbert
 Lee Jarvis
 Lennon Day-Reynolds
 Lin Jen-Shin
+Magne Matre Gåsland
 Marc-André Cournoyer
 Marius Butuc
 Matthew Manning
@@ -77,6 +82,7 @@ Nicholas Wieland
 Nick Hammond
 Nick Plante
 Niko Dittmann
+Nikolay Shebanov
 Oscar Del Ben
 Pablo Astigarraga
 Paul Dlug
@@ -85,9 +91,11 @@ Pedro Chambino
 Philip Corliss
 Pierre-Louis Gottfrois
 Rafael Ssouza
+Richard Schneeman
 Rick Olson
 Robert Eanes
 Rodrigo Panachi
+Sam Norbury
 Samuel Cochran
 Syl Turner
 T. Watanabe

data/README.md

@@ -39,6 +39,7 @@ The rest-client gem depends on these other gems for usage at runtime:
 
 * [mime-types](http://rubygems.org/gems/mime-types)
 * [netrc](http://rubygems.org/gems/netrc)
+* [http-accept](https://rubygems.org/gems/http-accept)
 * [http-cookie](https://rubygems.org/gems/http-cookie)
 
 There are also several development dependencies. It's recommended to use
@@ -359,7 +360,7 @@ RestClient.get('http://example.com/resource') { |response, request, result, &blo
   when 423
     raise SomeCustomExceptionIfYouWant
   else
-    response.return!(request, result, &block)
+    response.return!(&block)
   end
 }
 ```
@@ -446,6 +447,106 @@ You can:
 
 See `RestClient::Request`'s documentation for more information.
 
+### Streaming request payload
+
+RestClient will try to stream any file-like payload rather than reading it into
+memory. This happens through `RestClient::Payload::Streamed`, which is
+automatically called internally by `RestClient::Payload.generate` on anything
+with a `read` method.
+
+```ruby
+>> r = RestClient.put('http://httpbin.org/put', File.open('/tmp/foo.txt', 'r'),
+                      content_type: 'text/plain')
+=> <RestClient::Response 200 "{\n  \"args\":...">
+```
+
+In Multipart requests, RestClient will also stream file handles passed as Hash
+(or __new in 2.1__ ParamsArray).
+
+```ruby
+>> r = RestClient.put('http://httpbin.org/put',
+                      {file_a: File.open('a.txt', 'r'),
+                       file_b: File.open('b.txt', 'r')})
+=> <RestClient::Response 200 "{\n  \"args\":...">
+
+# received by server as two file uploads with multipart/form-data
+>> JSON.parse(r)['files'].keys
+=> ['file_a', 'file_b']
+```
+
+### Streaming responses
+
+Normally, when you use `RestClient.get` or the lower level
+`RestClient::Request.execute method: :get` to retrieve data, the entire
+response is buffered in memory and returned as the response to the call.
+
+However, if you are retrieving a large amount of data, for example a Docker
+image, an iso, or any other large file, you may want to stream the response
+directly to disk rather than loading it in memory. If you have a very large
+file, it may become *impossible* to load it into memory.
+
+There are two main ways to do this:
+
+#### `raw_response`, saves into Tempfile
+
+If you pass `raw_response: true` to `RestClient::Request.execute`, it will save
+the response body to a temporary file (using `Tempfile`) and return a
+`RestClient::RawResponse` object rather than a `RestClient::Response`.
+
+Note that the tempfile created by `Tempfile.new` will be in `Dir.tmpdir`
+(usually `/tmp/`), which you can override to store temporary files in a
+different location. This file will be unlinked when it is dereferenced.
+
+If logging is enabled, this will also print download progress.
+__New in 2.1:__ Customize the interval with `:stream_log_percent` (defaults to
+10 for printing a message every 10% complete).
+
+For example:
+
+```ruby
+>> raw = RestClient::Request.execute(
+           method: :get,
+           url: 'http://releases.ubuntu.com/16.04.2/ubuntu-16.04.2-desktop-amd64.iso',
+           raw_response: true)
+=> <RestClient::RawResponse @code=200, @file=#<Tempfile:/tmp/rest-client.20170522-5346-1pptjm1>, @request=<RestClient::Request @method="get", @url="http://releases.ubuntu.com/16.04.2/ubuntu-16.04.2-desktop-amd64.iso">>
+>> raw.file.size
+=> 1554186240
+>> raw.file.path
+=> "/tmp/rest-client.20170522-5346-1pptjm1"
+raw.file.path
+=> "/tmp/rest-client.20170522-5346-1pptjm1"
+
+>> require 'digest/sha1'
+>> Digest::SHA1.file(raw.file.path).hexdigest
+=> "4375b73e3a1aa305a36320ffd7484682922262b3"
+```
+
+#### `block_response`, receives raw Net::HTTPResponse
+
+If you want to stream the data from the response to a file as it comes, rather
+than entirely in memory, you can also pass `RestClient::Request.execute` a
+parameter `:block_response` to which you pass a block/proc. This block receives
+the raw unmodified Net::HTTPResponse object from Net::HTTP, which you can use
+to stream directly to a file as each chunk is received.
+
+Note that this bypasses all the usual HTTP status code handling, so you will
+want to do you own checking for HTTP 20x response codes, redirects, etc.
+
+The following is an example:
+
+````ruby
+File.open('/some/output/file', 'w') {|f|
+  block = proc { |response|
+    response.read_body do |chunk|
+      f.write chunk
+    end
+  }
+  RestClient::Request.execute(method: :get,
+                              url: 'http://example.com/some/really/big/file.img',
+                              block_response: block)
+}
+````
+
 ## Shell
 
 The restclient shell command gives an IRB session with RestClient already loaded:
@@ -498,7 +599,7 @@ $ restclient put http://example.com/resource < input_body
 
 ## Logging
 
-To enable logging you can:
+To enable logging globally you can:
 
 - set RestClient.log with a Ruby Logger, or
 - set an environment variable to avoid modifying the code (in this case you can use a file name, "stdout" or "stderr"):
@@ -506,7 +607,19 @@ To enable logging you can:
 ```ruby
 $ RESTCLIENT_LOG=stdout path/to/my/program
 ```
-Either produces logs like this:
+
+You can also set individual loggers when instantiating a Resource or making an
+individual request:
+
+```ruby
+resource = RestClient::Resource.new 'http://example.com/resource', log: Logger.new(STDOUT)
+```
+
+```ruby
+RestClient::Request.execute(method: :get, url: 'http://example.com/foo', log: Logger.new(STDERR))
+```
+
+All options produce logs like this:
 
 ```ruby
 RestClient.get "http://some/resource"
@@ -774,11 +887,10 @@ See AUTHORS for the full list.
 
 ## Legal
 
-Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+Released under the MIT License: https://opensource.org/licenses/MIT
 
-"Master Shake" photo (http://www.flickr.com/photos/solgrundy/924205581/) by
-"SolGrundy"; used under terms of the Creative Commons Attribution-ShareAlike 2.0
-Generic license (http://creativecommons.org/licenses/by-sa/2.0/)
+Photo of the International Space Station was produced by NASA and is in the
+public domain.
 
 Code for reading Windows root certificate store derived from work by Puppet;
 used under terms of the Apache License, Version 2.0.

data/Rakefile

@@ -38,12 +38,11 @@ desc 'Regenerate authors file'
 task :authors do
   Dir.chdir(File.dirname(__FILE__)) do
     File.open('AUTHORS', 'w') do |f|
-      f.write( <<-EOM
+      f.write <<-EOM
 The Ruby REST Client would not be what it is today without the help of
 the following kind souls:
 
       EOM
-      )
     end
 
     sh 'git shortlog -s | cut -f 2 >> AUTHORS'
@@ -70,8 +69,8 @@ namespace :all do
   task :build => ['ruby:build'] + \
     WindowsPlatforms.map {|p| "windows:#{p}:build"}
 
-  desc "Create tag v#{RestClient::VERSION} and for all platforms build and push " \
-    "rest-client #{RestClient::VERSION} to Rubygems"
+  desc "Create tag v#{RestClient::VERSION} and for all platforms build and " \
+    "push rest-client #{RestClient::VERSION} to Rubygems"
   task :release => ['build', 'ruby:release'] + \
     WindowsPlatforms.map {|p| "windows:#{p}:push"}
 
@@ -130,3 +129,12 @@ Rake::RDocTask.new do |t|
   t.rdoc_files.include('README.md')
   t.rdoc_files.include('lib/*.rb')
 end
+
+############################
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+alias_task(:lint, :rubocop)