diff --git a/HISTORY b/CHANGELOG.md similarity index 67% rename from HISTORY rename to CHANGELOG.md index 54c19dd3..eb439afe 100644 --- a/HISTORY +++ b/CHANGELOG.md @@ -1,171 +1,276 @@ -=== CURRENT +# Changelog +All notable changes to this project will be documented in this file. -=== 0.5.6 2021-04-02 +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] +### Added + +* Setup Rubocop (#205, #208) + +### Changed + +* Switch from TravisCI to Github Actions (#202, #207, #176) +* Upgrade webmock to v3.14.0 (#196) +* Upgrade em-http-request to v1.1.7 (#173) +* Upgrade mocha to v1.13.0 (#193) + +### Fixed + +* Fixed Infinite Redirect in v0.5.5, v0.5.6 (#186, #210) +* Fixed NoMethodError on missing leading slash in path (#194, #211) +* Fixed NoMethodError on nil request object (#165, #212) +* Fixed Unsafe String Comparison (#156, #209) +* Fixed typos in Gemspec (#204, #203, #208) + +### Removed + +* Remove direct development dependency on nokogiri (#299) + +## [0.5.6] 2021-04-02 +### Added * Add metadata to Gemspec file -* Change default timeout to be the same as Net::HTTP default, 60 seconds instead of 30 seconds. * Add support for PUT requests with Action Controller (#181) -=== 0.5.5 2020-01-19 +### Changed + +* Change default timeout to be the same as Net::HTTP default, 60 seconds instead of 30 seconds. + +## [0.5.5] 2020-01-19 +### Added -* Allow redirect to different host but same path * Add :allow_empty_params option (#155) -* Fixes ssl-noverify + +### Changed + +* Allow redirect to different host but same path * Various cleanups -=== 0.5.4 2017-12-08 +### Fixed + +* Fixes ssl-noverify + +## [0.5.4] 2017-12-08 +### Changed -* Fixes UnknownRequestType on Rails 5.1 for ActionDispatch::Request (xprazak2) * Various cleanups (charliesome) -=== 0.5.3 2017-05-24 +### Fixed + +* Fixes UnknownRequestType on Rails 5.1 for ActionDispatch::Request (xprazak2) + +## [0.5.3] 2017-05-24 +### Fixed -* Removing legacy scripts (James Pinto) * Fix #145 - broken CLI required loading active_support (James Pinto) -=== 0.5.2 2017-05-17 +### Changed + +* Removing legacy scripts (James Pinto) + +## [0.5.2] 2017-05-17 +### Added * Adding a development dependency that had not been mentioned (James Pinto) +* Adding CodeClimate (James Pinto) +* Adding support to Ruby 2.4 and head (James Pinto) + +### Changed + * Use assert_nil so as to silence a Minitest 6 deprecation warning (James Pinto) * Stop bundling tests files in the gem (Michal Papis) * Minor cleanup on tests (James Pinto) * TravisCI no longer needs libcurl-dev (James Pinto) * Nokogiri 1.7 does not accept Ruby 2.0 (James Pinto) * Upgrading to CodeClimate 1.0 (James Pinto) -* Adding support to Ruby 2.4 and head (James Pinto) * Locking gemspec to Rails 4 so as to allow our next version for Rails 5 (James Pinto) -* Fix #113 adding paths when a full URL has been specified (James Pinto) * moving development dependency to gemspec (James Pinto) * Silencing 'Net::HTTPResponse#header is obsolete' (James Pinto) * Silencing some test warnings (James Pinto) * Silencing 'loading in progress, circular require considered harmful' (James Pinto) * Silence 'URI.escape obsolete' (James Pinto) * Refactored CLI (James Pinto) -* Bug Fix, webmock 2.0 has introduced a new bug (James Pinto) * Moving test files into test/units/ (James Pinto) -* Adding CodeClimate (James Pinto) * Reimplementing #82 - Debug Output Option (James Pinto) + +### Fixed + +* Fix #113 adding paths when a full URL has been specified (James Pinto) +* Bug Fix, webmock 2.0 has introduced a new bug (James Pinto) * Making a test/support dir (James Pinto) * Fix #177 - Adjusting to webmock latest recommended implementation for minitest (James Pinto) -* Adding support to Ruby 2.4 and head (James Pinto) -* Upgrading to CodeClimate 1.0 (James Pinto) -* Nokogiri 1.7 does not accept Ruby 2.0 (James Pinto) -=== 0.5.1 2016-02-29 +## [0.5.1] 2016-02-29 +### Added + +* Add license info to the gemspec (Robert Reiz) + +### Fixed * Proper handling for empty query string in RequestToken#build_authorize_url (midchildan, Harald Sitter) +* Replace calls to String#blank? with its implementation (Sergio Gil Pérez de la Manga) + +### Changed + * Loosen some development dependencies. Add libcurl-dev to travis -* Add license info to the gemspec (Robert Reiz) * Fixes to travis config. Switch to rubygems for installation and loading + +### Removed + * Remove obsolete comment (Arthur Nogueira Neves) * Remove jeweler from gemspec -* Replace calls to String#blank? with its implementation (Sergio Gil Pérez de la Manga) -=== 0.5.0 2016-02-20 +## [0.5.0] 2016-02-20 +### Added -* Fix ability to pass in an authorize url with a query string (Roger Smith) * Add support for HTTP PATCH method (Richard Huang) * Allow reading private key from a string (Khaja Minhajuddin) +* Add rest-client proxy (Khem Veasna) +* Add byebug. (Kevin Hughes) +* Allow reading certificate file path from environment variable. Add CentOS cert file path (Danil Vlasov) + +### Changed + +* Replace jeweler with real spec and bundler tasks +* Extract version to separate file +* Use OpenSSL for all digest and hashing. Remove signature methods not defined by OAuth spec. (Kevin Hughes) +* Change token requests to exclude `oauth_body_hash`. Update doc links in comments. (John Remmen) + +### Fixed + +* Fix ability to pass in an authorize url with a query string (Roger Smith) * Fix bug in signature verification (r-stu31) * Use standard key name (`oauth_token_secret`) in Token#to_query (Craig Walker) * Fix error in CLI when using `query` without supplying a method (grafikchaos) * Compatibility fix for Typhoeus >= 0.5.0 (Chad Feller) -* Add rest-client proxy (Khem Veasna) * Rails 3+ / ActiveSupport::SafeBuffer patch (Clif Reeder) * Handle `nil` token gracefully for RequestToken#authorize_url (Brian John) -* Replace jeweler with real spec and bundler tasks -* Extract version to separate file * Fix typhoeus compatibility (Vladimir Mikhailov) -* Use OpenSSL for all digest and hashing. Remove signature methods not defined by OAuth spec. - Add byebug. (Kevin Hughes) * Fix oauth cli option parser on Ruby 2.2 (Felix Bünemann) -* Change token requests to exclude `oauth_body_hash`. Update doc links in comments. (John Remmen) * Update gemspec for security fixes. Convert to Minitest. Add .travis.yml. (Kevin Hughes) -* Allow reading certificate file path from environment variable. Add CentOS cert file path - (Danil Vlasov) * Fix some warnings (amatsuda) * Various fixes/updates to README (Evan Arnold, Jonathan Camenisch, Brian John, Ankur Sethi) -=== 0.4.7 2012-09-03 +## [0.4.7] 2012-09-03 +### Added -* Fix merging paths if the path is not empty * Set a configurable timeout for all requests (Rick Olson) + +### Fixed + +* Fix merging paths if the path is not empty * Fix nested hash params in Consumer#request (Ernie Miller) -=== 0.4.6 2012-04-21 +## [0.4.6] 2012-04-21 +### Changed -* Fixed nested attributes in #normalize (Shaliko Usubov) * Make use the path component of the :site parameter (Jonathon M. Abbott) + +### Fixed + +* Fixed nested attributes in #normalize (Shaliko Usubov) * Fixed post body's being dropped in 1.9 (Steven Hammond) * Fixed PUT request handling (Anton Panasenko) -=== 0.4.5 2011-06-25 +## [0.4.5] 2011-06-25 +### Added * Add explicit require for rsa/sha1 (Juris Galang) -* Use webmock to mock all http-requests in tests (Adrian Feldman) * Add gemtest support (Adrian Feldman) -* Fix POST Requests with Typhoeus proxy (niedhui) + +### Changed +* Use webmock to mock all http-requests in tests (Adrian Feldman) * Mention Typhoeus require in the README (Kim Ahlström) -* Fix incorrect hardcoded port (Ian Taylor) * Use Net::HTTPGenericRequest (Jakub Kuźma) -=== 0.4.4 2010-10-31 +### Fixed + +* Fix POST Requests with Typhoeus proxy (niedhui) +* Fix incorrect hardcoded port (Ian Taylor) + +## [0.4.4] 2010-10-31 +### Added + +* Added support for Rails 3 in client/action_controller_request (Pelle) + +### Fixed * Fix LoadError rescue in tests: return can't be used in this context (Hans de Graaff) * HTTP headers should be strings. (seancribbs) * ensure consumer uri gets set back to original config even if an error occurs (Brian Finney) * Yahoo uses & to split records in OAuth headers (Brian Finney) -* Added support for Rails 3 in client/action_controller_request (Pelle) -== 0.4.3 2010-09-01 +## [0.4.3] 2010-09-01 +### Fixed * Fix for em-http proxy (ichverstehe) -== 0.4.2 2010-08-13 +## [0.4.2] 2010-08-13 +### Added + +* Added Bundler (rc) Gemfile for easier dev/testing + +### Fixed * Fixed compatibility with Ruby 1.9.2 (ecavazos) * Fixed the em-http request proxy (Joshua Hull) * Fix for oauth proxy string manipulation (Jakub Suder) -* Added Bundler (rc) Gemfile for easier dev/testing -== 0.4.1 2010-06-16 +## [0.4.1] 2010-06-16 +### Added * Added support for using OAuth with proxies (Marsh Gardiner) + +### Fixed + * Rails 3 Compatibility fixes (Pelle Braendgaard) * Fixed load errors on tests for missing (non-required) libraries -== 0.4.0 2010-04-22 +## [0.4.0] 2010-04-22 +### Added -* Added computation of oauth_body_hash as per OAuth Request Body Hash 1.0 - Draft 4 (Michael Reinsch) +* Added computation of oauth_body_hash as per OAuth Request Body Hash 1.0 Draft 4 (Michael Reinsch) * Added the optional `oauth_session_handle` parameter for the Yahoo implementation (Will Bailey) -* Better marshalling implementation (Yoan Blanc) * Added optional block to OAuth::Consumer.get_*_token (Neill Pearman) * Exclude `oauth_callback` with :exclude_callback (Neill Pearman) -* Strip extraneous spaces and line breaks from access_token responses - (observed in the wild with Yahoo!'s OAuth+OpenID hybrid) (Eric Hartmann) -* Stop double-escaping PLAINTEXT signatures (Jimmy Zimmerman) -* OAuth::Client::Helper won't override the specified `oauth_version` - (Philip Kromer) * Support for Ruby 1.9 (Aaron Quint, Corey Donahoe, et al) -* Fixed an encoding / multibyte issue (成田 一生) -* Replaced hoe with Jeweler (Aaron Quint) * Support for Typhoeus (Bill Kocik) * Support for em-http (EventMachine) (Darcy Laycock) * Support for curb (André Luis Leal Cardoso Junior) * New website (Aaron Quint) -== 0.3.6 2009-09-14 +### Changed + +* Better marshalling implementation (Yoan Blanc) +* Replaced hoe with Jeweler (Aaron Quint) + +### Fixed + +* Strip extraneous spaces and line breaks from access_token responses (observed in the wild with Yahoo!'s OAuth+OpenID hybrid) (Eric Hartmann) +* Stop double-escaping PLAINTEXT signatures (Jimmy Zimmerman) +* OAuth::Client::Helper won't override the specified `oauth_version` (Philip Kromer) +* Fixed an encoding / multibyte issue (成田 一生) + +## [0.3.6] 2009-09-14 +### Added * Added -B CLI option to use the :body authentication scheme (Seth) -* Respect `--method` in `authorize` CLI command (Seth) * Support POST and PUT with raw bodies (Yu-Shan Fung et al) +* Added :ca_file consumer option to allow consumer specific certificate override. (Pelle) + +### Changed + * Test clean-up (Xavier Shay, Hannes Tydén) -* Added :ca_file consumer option to allow consumer specific certificate - override. (Pelle) -== 0.3.5 2009-06-03 +### Fixed + +* Respect `--method` in `authorize` CLI command (Seth) + +## [0.3.5] 2009-06-03 +### Added * `query` CLI command to access protected resources (Seth) * Added -H, -Q CLI options for specifying the authentication scheme (Seth) @@ -175,88 +280,165 @@ * Added proxy support to OAuth::Consumer (Marshall Huss) * Added --scope CLI option for Google's 'scope' parameter (Seth) -== 0.3.4 2009-05-06 +## [0.3.4] 2009-05-06 +### Changed * OAuth::Client::Helper uses OAuth::VERSION (chadisfaction) -* Fix OAuth::RequestProxy::ActionControllerRequest's handling of params - (Tristan Groléat) -== 0.3.3 2009-05-04 +### Fixed + +* Fix OAuth::RequestProxy::ActionControllerRequest's handling of params (Tristan Groléat) + +## [0.3.3] 2009-05-04 +### Added -* Corrected OAuth XMPP namespace (Seth) -* Improved error handling for invalid Authorization headers (Matt Sanford) -* Fixed signatures for non-ASCII under $KCODE other than 'u' (Matt Sanford) -* Fixed edge cases in ActionControllerRequestProxy where params were being - incorrectly signed (Marcos Wright Kuhns) * Support for arguments in OAuth::Consumer#get_access_token (Matt Sanford) * Add gem version to user-agent header (Matt Sanford) + +### Changed + +* Improved error handling for invalid Authorization headers (Matt Sanford) * Handle input from aggressive form encoding libraries (Matt Wood) -== 0.3.2 2009-03-23 +### Fixed + +* Corrected OAuth XMPP namespace (Seth) +* Fixed signatures for non-ASCII under $KCODE other than 'u' (Matt Sanford) +* Fixed edge cases in ActionControllerRequestProxy where params were being incorrectly signed (Marcos Wright Kuhns) + +## [0.3.2] 2009-03-23 +### Added -* 2xx statuses should be treated as success (Anders Conbere) * Support applications using the MethodOverride Rack middleware (László Bácsi) * `authorize` command for `oauth` CLI (Seth) * Initial support for Problem Reporting extension (Seth) * Verify SSL certificates if CA certificates are available (Seth) -* Fixed ActionController parameter escaping behavior (Thiago Arrais, László - Bácsi, Brett Gibson, et al) -* Fixed signature calculation when both options and a block were provided to - OAuth::Signature::Base#initialize (Seth) * Added help to the 'oauth' CLI (Seth) + +### Fixed + +* 2xx statuses should be treated as success (Anders Conbere) +* Fixed ActionController parameter escaping behavior (Thiago Arrais, László Bácsi, Brett Gibson, et al) +* Fixed signature calculation when both options and a block were provided to OAuth::Signature::Base#initialize (Seth) * Fixed a problem when attempting to normalize MockRequest URIs (Seth) -== 0.3.1 2009-1-26 +## [0.3.1] 2009-01-26 +### Fixed * Fixed a problem with relative and absolute token request paths. (Michael Wood) -== 0.3.0 2009-1-25 +## [0.3.0] 2009-01-25 +### Added * Support ActionController::Request from Edge Rails (László Bácsi) -* Correctly handle multi-valued parameters (Seth) * Added #normalized_parameters to OAuth::RequestProxy::Base (Pelle) -* OAuth::Signature.sign and friends now yield the RequestProxy instead of the - token when the passed block's arity is 1. (Seth) -* Token requests are made to the configured URL rather than generating a - potentially incorrect one. (Kellan Elliott-McCrea) * Command-line app for generating signatures. (Seth) + +### Changed + +* OAuth::Signature.sign and friends now yield the RequestProxy instead of the token when the passed block's arity is 1. (Seth) * Improved test-cases and compatibility for encoding issues. (Pelle) -== 0.2.7 2008-9-10 The lets fix the last release release +### Fixed + +* Correctly handle multi-valued parameters (Seth) +* Token requests are made to the configured URL rather than generating a potentially incorrect one. (Kellan Elliott-McCrea) + +## 0.2.7 2008-09-10 +The lets fix the last release release + +### Fixed * Fixed plain text signatures (Andrew Arrow) * Fixed RSA requests using OAuthTokens. (Philip Lipu Tsai) -== 0.2.6 2008-9-9 The lets RSA release +## 0.2.6 2008-09-09 +The lets RSA release + +### Added * Improved support for Ruby 1.8.7 (Bill Kocik) -* Fixed RSA verification to support RSA providers - now using Ruby and RSA +* Added support for 'private_key_file' option for RSA signatures (Chris Mear) + +### Changed + * Improved RSA testing * Omit token when signing with RSA -* Added support for 'private_key_file' option for RSA signatures (Chris Mear) -* Fixed several edge cases where params were being incorrectly signed (Scott - Hill) + +### Fixed + +* Fixed RSA verification to support RSA providers now using Ruby and RSA +* Fixed several edge cases where params were being incorrectly signed (Scott Hill) * Fixed RSA signing (choonkeat) -== 0.2.2 2008-2-22 Lets actually support SSL release +## 0.2.2 2008-02-22 +Lets actually support SSL release + +### Fixed * Use HTTPS when required. -== 0.2 2008-1-19 All together now release +## 0.2 2008-1-19 +All together now release This is a big release, where we have merged the efforts of various parties into one common library. This means there are definitely some API changes you should be aware of. They should be minimal but please have a look at the unit tests. -== 0.1.2 2007-12-1 +## 0.1.2 2007-12-1 +### Fixed * Fixed checks for missing OAuth params to improve performance * Includes Pat's fix for getting the realm out. -== 0.1.1 2007-11-26 +## 0.1.1 2007-11-26 +### Added * First release as a GEM * Moved all non-Rails functionality from the Rails plugin: http://code.google.com/p/oauth-plugin/ + +[Unreleased]: https://github.com/oauth-xx/oauth-ruby/compare/v0.5.6...HEAD + +[0.3.0]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.3.0 + +[0.3.1]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.3.1 + +[0.3.2]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.3.2 + +[0.3.3]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.3.3 + +[0.3.4]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.3.4 + +[0.3.5]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.3.5 + +[0.3.6]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.3.6 + +[0.4.0]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.0 + +[0.4.1]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.1 + +[0.4.2]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.2 + +[0.4.3]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.3 + +[0.4.4]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.4 + +[0.4.5]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.5 + +[0.4.6]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.6 + +[0.4.7]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.4.7 + +[0.5.0]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.0 + +[0.5.1]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.1 + +[0.5.2]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.2 + +[0.5.3]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.3 + +[0.5.4]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.4 + +[0.5.6]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.6 diff --git a/oauth.gemspec b/oauth.gemspec index 3dd95656..51a3f0a7 100644 --- a/oauth.gemspec +++ b/oauth.gemspec @@ -18,12 +18,12 @@ Gem::Specification.new do |spec| spec.homepage = "https://github.com/oauth-xx/oauth-ruby" spec.metadata = { "bug_tracker_uri" => "#{spec.homepage}/issues", - "changelog_uri" => "#{spec.homepage}/blob/master/HISTORY", + "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md", "documentation_uri" => "https://rubydoc.info/github/oauth-xx/oauth-ruby/master", "homepage_uri" => spec.homepage, "source_code_uri" => spec.homepage } - spec.files = Dir.glob("lib/**/*.rb") + ["LICENSE", "README.rdoc", "HISTORY"] + spec.files = Dir.glob("lib/**/*.rb") + ["LICENSE", "README.rdoc", "CHANGELOG.md"] #spec.test_files = Dir.glob("test/**/*.rb") + Dir.glob('test/keys/*') spec.extra_rdoc_files = [ "LICENSE", "README.rdoc", "TODO" ]