Skip to content

Commit

Permalink
Fix typos and add title to changelog
Browse files Browse the repository at this point in the history
Typos found via `typos --format brief`
  • Loading branch information
kianmeng committed Mar 13, 2024
1 parent 1322051 commit 989ad98
Showing 1 changed file with 72 additions and 70 deletions.
142 changes: 72 additions & 70 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,73 @@
# 2.5.0 (2021-05-11)
- Add support for Ruby 3.0 (#194 fwininger)
- Add support for Rails 6.1 (#194 fwininger)
- Drop support for Ruby 2.4 (#193 fwininger)
- Drop support for Rails 5.0 (#194 fwininger)
- Drop support for Rails 5.1 (#194 fwininger)
- Fix Faraday warning: `WARNING: Faraday::Request#method is deprecated` (#191 fwininger)

# 2.4.1 (2020-06-23)
- Fix inadvertant ActiveSupport dependecy (#189 taylorthurlow)

# 2.4.0 (2020-05-05)
- Improved support for Rails 6.0 (#179 taylorthurlow, #177 fwininger)
- Added Ruby 2.6.0 support (#174 fwininger)
- README updates (#186 iranthau)

# 2.3.1 (2018-11-06)
- Fixed a regression in the http.rb driver (#173 tycooon)

# 2.3.0 (2018-10-23)
- Added support for Grape API (#169 phuongnd08 & dunghuynh)
# Changelog

## 2.5.0 (2021-05-11)
- Add support for Ruby 3.0 (##194 fwininger)
- Add support for Rails 6.1 (##194 fwininger)
- Drop support for Ruby 2.4 (##193 fwininger)
- Drop support for Rails 5.0 (##194 fwininger)
- Drop support for Rails 5.1 (##194 fwininger)
- Fix Faraday warning: `WARNING: Faraday::Request##method is deprecated` (##191 fwininger)

## 2.4.1 (2020-06-23)
- Fix inadvertent ActiveSupport dependency (##189 taylorthurlow)

## 2.4.0 (2020-05-05)
- Improved support for Rails 6.0 (##179 taylorthurlow, ##177 fwininger)
- Added Ruby 2.6.0 support (##174 fwininger)
- README updates (##186 iranthau)

## 2.3.1 (2018-11-06)
- Fixed a regression in the http.rb driver (##173 tycooon)

## 2.3.0 (2018-10-23)
- Added support for Grape API (##169 phuongnd08 & dunghuynh)
- Added option for specifying customer headers to sign via new `headers_to_sign`
argument (#170 fakenine)
- Fix tests and drop support for Ruby < 2.3 (#171 fwininger)

# 2.2.0 (2018-03-12)
- Drop support ruby 1.x, rails 2.x, rails 3.x (#141 fwininger)
- Add http.rb request driver (#164 tycooon)
- Fix POST and PUT requests in RestClient (#151 fwininger)
- Allow clock skew to be user-defined (#136 mlarraz)
- Adds #original_uri method to all request drivers (#137 iMacTia)
argument (##170 fakenine)
- Fix tests and drop support for Ruby < 2.3 (##171 fwininger)

## 2.2.0 (2018-03-12)
- Drop support ruby 1.x, rails 2.x, rails 3.x (##141 fwininger)
- Add http.rb request driver (##164 tycooon)
- Fix POST and PUT requests in RestClient (##151 fwininger)
- Allow clock skew to be user-defined (##136 mlarraz)
- Adds ##original_uri method to all request drivers (##137 iMacTia)
- Rubocop and test fixes (fwininger & nicolasleger)
- Changed return type for request #content_md5 #timestamp #content_type (fwininger)
- Changed return type for request ##content_md5 ##timestamp ##content_type (fwininger)
- Fix URI edge case where a URI contains another URI (zfletch)
- Updates to the README (zfletch)

# 2.1.0 (2016-12-22)
- Fixed a NoMethodError that might occur when using the NetHttp Driver (#130 grahamkenville)
- More securely compare signatures in a way that prevents timing attacks (#56 leishman, #133 will0)
- Remove support for MD2 and MD4 hashing algorithms since they are insecure (#134 will0)
- Disallow requests that are too far in the future to limit the time available for a brute force signature guess (#119 fwininger)
## 2.1.0 (2016-12-22)
- Fixed a NoMethodError that might occur when using the NetHttp Driver (##130 grahamkenville)
- More securely compare signatures in a way that prevents timing attacks (##56 leishman, ##133 will0)
- Remove support for MD2 and MD4 hashing algorithms since they are insecure (##134 will0)
- Disallow requests that are too far in the future to limit the time available for a brute force signature guess (##119 fwininger)

# 2.0.1 (2016-07-25)
- Support of `api_auth_options` in ActiveResource integration (#102 fwininger)
- Replace use of `#blank?` with `#nil?` to not depend on ActiveSupport (#114 packrat386)
- Fix Auth header matching to not match invalid SHA algorithms (#115 packrat386)
## 2.0.1 (2016-07-25)
- Support of `api_auth_options` in ActiveResource integration (##102 fwininger)
- Replace use of `##blank?` with `##nil?` to not depend on ActiveSupport (##114 packrat386)
- Fix Auth header matching to not match invalid SHA algorithms (##115 packrat386)
- Replace `alias_method_chain` with `alias_method` in the railtie since
alias_method_chain is deprecated in Rails 5 (#118 mlarraz)
alias_method_chain is deprecated in Rails 5 (##118 mlarraz)

# 2.0.0 (2016-05-11)
## 2.0.0 (2016-05-11)
- IMPORTANT: 2.0.0 is backwards incompatible with the default settings of v1.x
v2.0.0 always includes the http method in the canonical string.
You can use the upgrade strategy in v1.4.x and above to migrate to v2.0.0
without any down time. Please see the 1.4.0 release nodes for more info
- Added support for other digest algorithms like SHA-256 (#98 fwininger)
- Added support for other digest algorithms like SHA-256 (##98 fwininger)

# 1.5.0 (2016-01-21)
## 1.5.0 (2016-01-21)
- Added a sign_with_http_method configuration option to the ActiveResource
rails tie to correspond to passing the `:with_http_method => true` into
`ApiAuth.sign!`

# 1.4.1 (2016-01-04)
## 1.4.1 (2016-01-04)
- Fixed an issue where getters wouldn't immediately have the correct value after
setting a date or content md5 in some of the request drivers (#91)
setting a date or content md5 in some of the request drivers (##91)

# 1.4.0 (2015-12-16)
## 1.4.0 (2015-12-16)

## IMPORTANT SECURITY FIX (with backwards compatible fallback)
#### IMPORTANT SECURITY FIX (with backwards compatible fallback)

This version introduces a security fix. In previous versions, the canonical
string does not include the http method used to make the request, this means
Expand Down Expand Up @@ -94,51 +96,51 @@
4. Update server side code to ApiAuth v2.0 (removes the ability to authenticate without the http method)
5. Update all client side code to ApiAuth v2.0 (forces all signatures to contain the http method)

## Additional changes
#### Additional changes

- Performance enhancement: reduce allocation of Headers object (#81 pd)
- Performance enhancement: avoid reallocating static Regexps (#82 pd)
- Performance enhancement: reduce allocation of Headers object (##81 pd)
- Performance enhancement: avoid reallocating static Regexps (##82 pd)

# 1.3.2 (2015-08-28)
## 1.3.2 (2015-08-28)
- Fixed a bug where some client adapters didn't treat an empty path as
"/" in the canonical string (#75 managr)
"/" in the canonical string (##75 managr)
# 1.3.1 (2015-03-13)
## 1.3.1 (2015-03-13)
- Fixed a bug where Faraday requests with no parameters were not signed
correctly (#65 nathanhoel)
correctly (##65 nathanhoel)
# 1.3.0 (2015-03-12)
- Add a Faraday Request Driver (#64 nathanhoel)
## 1.3.0 (2015-03-12)
- Add a Faraday Request Driver (##64 nathanhoel)
# 1.2.6 (2014-10-01)
## 1.2.6 (2014-10-01)
- Fix a bug in the ActionController request driver where calculated_md5 was
incorrect in certain scenarios. (#53 karl-petter)
incorrect in certain scenarios. (##53 karl-petter)
# 1.2.5 (2014-09-09)
## 1.2.5 (2014-09-09)
- Fix a bug where ApiAuth.authentic? would cause an ArgumentError when given a
request with an invalid date in the date header. It will now return false
instead. (#51 Nakort)
instead. (##51 Nakort)
# 1.2.4 (2014-08-27)
## 1.2.4 (2014-08-27)
- Fix a bug in the Net::HTTP request driver where the md5 isn't calculated
correctly when the content of the request is set with the `.body_stream`
method. (#49 adamcrown)
method. (##49 adamcrown)

# 1.2.3 (2014-08-01)
## 1.2.3 (2014-08-01)
- Update action controller request driver to fix a bug with OLD versions of
Rails using CGI

# 1.2.2 (2014-07-08)
## 1.2.2 (2014-07-08)
- Fix Rest Client driver to account for the generated date when signing (cjeeky)

# 1.2.1 (2014-07-03)
## 1.2.1 (2014-07-03)

- Fix Rest Client driver to account for the generated md5 when signing
(#45 cjeeky)
- Support for testing against Rails 4.1 (#42 awendt)
- Support all requests inheriting from Rack::Request (#43 mcls)
(##45 cjeeky)
- Support for testing against Rails 4.1 (##42 awendt)
- Support all requests inheriting from Rack::Request (##43 mcls)

# 1.2.0 (2014-05-16)
## 1.2.0 (2014-05-16)

- Fix ruby 1.8.7 support
- Test / support all major versions of rails 2.3 - 4.0
Expand Down

0 comments on commit 989ad98

Please sign in to comment.