Skip to content

Commit 12a681c

Browse files
committed
✏️ Fixing typos
1 parent b49bfc5 commit 12a681c

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ authors:
1616
identifiers:
1717
- type: url
1818
value: 'https://github.com/oauth-xx/oauth2'
19-
description: oath2
19+
description: oauth2
2020
repository-code: 'https://github.com/oauth-xx/oauth2'
2121
abstract: >-
2222
oauth2

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -336,13 +336,15 @@ For more see [SECURITY.md][🔐security].
336336
- Adds new option to `OAuth2::AccessToken#initialize`:
337337
- `:expires_latency` (`nil`); number of seconds by which AccessToken validity will be reduced to offset latency
338338
- By default, keys are transformed to snake case.
339-
- Original keys will still work as previously, in most scenarios, thanks to [snaky_hash](https://gitlab.com/oauth-xx/snaky_hash) gem.
339+
- Original keys will still work as previously, in most scenarios, thanks to [snaky_hash][snaky_hash] gem.
340340
- However, this is a _breaking_ change if you rely on `response.parsed.to_h` to retain the original case, and the original wasn't snake case, as the keys in the result will be snake case.
341341
- As of version 2.0.4 you can turn key transformation off with the `snaky: false` option.
342342
- By default, the `:auth_scheme` is now `:basic_auth` (instead of `:request_body`)
343343
- Third-party strategies and gems may need to be updated if a provider was requiring client id/secret in the request body
344344
- [... A lot more](https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md#200-2022-06-21-tag)
345345

346+
[snaky_hash]: https://gitlab.com/oauth-xx/snaky_hash
347+
346348
## Compatibility
347349

348350
Targeted ruby compatibility is non-EOL versions of Ruby, currently 3.2, 3.3, and 3.4.
@@ -488,7 +490,7 @@ response.parsed.class.name # => Hash (just, regular old Hash)
488490
<details>
489491
<summary>Debugging</summary>
490492

491-
Set an environment variable, however you would [normally do that](https://github.com/bkeepers/dotenv).
493+
Set an environment variable as per usual (e.g. with [dotenv](https://github.com/bkeepers/dotenv)).
492494

493495
```ruby
494496
# will log both request and response, including bodies
@@ -515,7 +517,7 @@ The `AccessToken` methods `#get`, `#post`, `#put` and `#delete` and the generic
515517
will return an instance of the #OAuth2::Response class.
516518

517519
This instance contains a `#parsed` method that will parse the response body and
518-
return a Hash-like [`OAuth2::SnakyHash`](https://gitlab.com/oauth-xx/oauth2/-/blob/main/lib/oauth2/snaky_hash.rb) if the `Content-Type` is `application/x-www-form-urlencoded` or if
520+
return a Hash-like [`SnakyHash::StringKeyed`](https://gitlab.com/oauth-xx/snaky_hash/-/blob/main/lib/snaky_hash/string_keyed.rb) if the `Content-Type` is `application/x-www-form-urlencoded` or if
519521
the body is a JSON object. It will return an Array if the body is a JSON
520522
array. Otherwise, it will return the original body string.
521523

@@ -543,7 +545,7 @@ Response instance will contain the `OAuth2::Error` instance.
543545

544546
### Authorization Grants
545547

546-
Currently the Authorization Code, Implicit, Resource Owner Password Credentials, Client Credentials, and Assertion
548+
Currently, the Authorization Code, Implicit, Resource Owner Password Credentials, Client Credentials, and Assertion
547549
authentication grant types have helper strategy classes that simplify client
548550
use. They are available via the [`#auth_code`](https://gitlab.com/oauth-xx/oauth2/-/blob/main/lib/oauth2/strategy/auth_code.rb),
549551
[`#implicit`](https://gitlab.com/oauth-xx/oauth2/-/blob/main/lib/oauth2/strategy/implicit.rb),

oauth2.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
gem_version =
55
if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.1")
6-
# Loading version into an anonymous module allows version.rb to get code coverage from SimpleCov!
6+
# Loading Version into an anonymous module allows version.rb to get code coverage from SimpleCov!
77
# See: https://github.com/simplecov-ruby/simplecov/issues/557#issuecomment-2630782358
88
Module.new.tap { |mod| Kernel.load("lib/oauth2/version.rb", mod) }::OAuth2::Version::VERSION
99
else

0 commit comments

Comments
 (0)