oauth 0.5.7 → 0.5.10

data/README.md

@@ -1,59 +1,240 @@
+<p align="center">
+    <a href="http://oauth.net/core/1.0/" target="_blank" rel="noopener">
+      <img width="124px" src="https://github.com/oauth-xx/oauth-ruby/raw/master/docs/images/logo/Oauth_logo.svg?raw=true" alt="OAuth 1.0 Logo by Chris Messina, CC BY-SA 3.0, via Wikimedia Commons">
+    </a>
+    <a href="https://www.ruby-lang.org/" target="_blank" rel="noopener">
+      <img width="124px" src="https://github.com/oauth-xx/oauth-ruby/raw/master/docs/images/logo/ruby-logo-198px.svg?raw=true" alt="Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5">
+    </a>
+</p>
+
 # Ruby OAuth
 
+OAuth 1.0 is an industry-standard protocol for authorization.
+
+This is a RubyGem for implementing both OAuth 1.0 clients and servers in Ruby applications.
+See the sibling `oauth2` gem for OAuth 2.0 implementations in Ruby.
+
+* [OAuth 1.0 Spec][oauth1-spec]
+* [oauth2 sibling gem][sibling-gem] for OAuth 2.0 implementations in Ruby.
+
+[oauth1-spec]: http://oauth.net/core/1.0/
+[sibling-gem]: https://github.com/oauth-xx/oauth-ruby
+
 **NOTE**
 
-This README, on branch `v0.5-maintenance`, targets 0.5.x series releases.  For later releases please see the `msater` branch README.
+This README, on branch `v0.5-maintenance`, targets 0.5.x series releases.  For later releases please see the `master` branch README.
 
 ## Status
 
-| Project                    |  Ruby Oauth                |
-|--------------------------- |--------------------------- |
-| name, license, docs        |  [![RubyGems.org](https://img.shields.io/badge/name-oauth-brightgreen.svg?style=flat)][rubygems] [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)][license-ref] [![RubyDoc.info](https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat)][documentation] |
-| version & downloads        |  [![Version](https://img.shields.io/gem/v/oauth.svg)][rubygems] [![Downloads Today](https://img.shields.io/gem/rd/oauth.svg)][rubygems] [![Homepage](https://img.shields.io/badge/source-github-brightgreen.svg?style=flat)][source] |
-| dependencies & linting     |  [![Depfu](https://badges.depfu.com/badges/d570491bac0ad3b0b65deb3c82028327/count.svg)][depfu] [![lint status](https://github.com/oauth-xx/oauth-ruby/actions/workflows/style.yml/badge.svg)][actions] |
-| unit tests                 |  [![supported rubies](https://github.com/oauth-xx/oauth-ruby/actions/workflows/supported.yml/badge.svg)][actions] [![unsupported status](https://github.com/oauth-xx/oauth-ruby/actions/workflows/unsupported.yml/badge.svg)][actions] |
-| coverage & maintainability |  [![Test Coverage](https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/test_coverage)][climate_coverage] [![codecov](https://codecov.io/gh/oauth-xx/oauth-ruby/branch/master/graph/badge.svg?token=4ZNAWNxrf9)][codecov_coverage] [![Maintainability](https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/maintainability)][climate_maintainability] |
-| resources                  |  [![Discussion](https://img.shields.io/badge/discussions-github-brightgreen.svg?style=flat)][gh_discussions] [![Mailing List](https://img.shields.io/badge/group-mailinglist-violet.svg?style=social&logo=google)][mailinglist] [![Join the chat at https://gitter.im/oauth-xx/oauth-ruby](https://badges.gitter.im/Join%20Chat.svg)][chat] [![Blog](https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat)][blogpage] |
-| Spread ~♡ⓛⓞⓥⓔ♡~         |  [![Open Source Helpers](https://www.codetriage.com/oauth-xx/oauth-ruby/badges/users.svg)][code_triage] [![Liberapay Patrons](https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay)][liberapay_donate] [🌏][aboutme] [👼][angelme] [💻][coderme] [🌹][politicme] [![Tweet @ Peter][followme-img]][tweetme] |
+<!--
+Numbering rows and badges in each row as a visual "database" lookup,
+    as the table is extremely dense, and it can be very difficult to find anything
+Putting one on each row here, to document the emoji that should be used, and for ease of copy/paste.
+
+row #s:
+1️⃣
+2️⃣
+3️⃣
+4️⃣
+5️⃣
+6️⃣
+7️⃣
+
+badge #s:
+⛳️
+🖇
+🏘
+🚎
+🖐
+🧮
+📗
+
+appended indicators:
+♻️ - URL needs to be updated from SASS integration. Find / Replace is insufficient.
+-->
+
+|     | Project               | bundle add oauth2                                                                                                                                                                                                                                                                               |
+|:----|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 1️⃣ | name, license, docs   | [![RubyGems.org][⛳️name-img]][⛳️gem] [![License: MIT][🖇src-license-img]][🖇src-license] [![FOSSA][🏘fossa-img]][🏘fossa] [![RubyDoc.info][🚎yard-img]][🚎yard] [![InchCI][🖐inch-ci-img]][🚎yard]                                                                                              |
+| 2️⃣ | version & activity    | [![Gem Version][⛳️version-img]][⛳️gem] [![Total Downloads][🖇DL-total-img]][⛳️gem] [![Download Rank][🏘DL-rank-img]][⛳️gem] [![Source Code][🚎src-home-img]][🚎src-home] [![Open PRs][🖐prs-o-img]][🖐prs-o] [![Closed PRs][🧮prs-c-img]][🧮prs-c] <!--[![Next Version][📗next-img]][📗next]--> |
+| 3️⃣ | maintanence & linting | [![Maintainability][⛳cclim-maint-img♻️]][⛳cclim-maint] [![Helpers][🖇triage-help-img]][🖇triage-help] [![Depfu][🏘depfu-img♻️]][🏘depfu♻️] [![Contributors][🚎contributors-img]][🚎contributors] [![Style][🖐style-wf-img]][🖐style-wf] [![Kloc Roll][🧮kloc-img]][🧮kloc]                      |
+| 4️⃣ | testing               | [![Open Issues][⛳iss-o-img]][⛳iss-o] [![Closed Issues][🖇iss-c-img]][🖇iss-c] [![Supported][🏘sup-wf-img]][🏘sup-wf] [![Heads][🚎heads-wf-img]][🚎heads-wf] [![Unofficial Support][🖐uns-wf-img]][🖐uns-wf] [![MacOS][🧮mac-wf-img]][🧮mac-wf] [![Windows][📗win-wf-img]][📗win-wf]             |
+| 5️⃣ | coverage & security   | [![CodeClimate][⛳cclim-cov-img♻️]][⛳cclim-cov] [![CodeCov][🖇codecov-img♻️]][🖇codecov] [![Coveralls][🏘coveralls-img]][🏘coveralls] [![Security Policy][🚎sec-pol-img]][🚎sec-pol] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Code Coverage][🧮cov-wf-img]][🧮cov-wf]                              |
+| 6️⃣ | resources             | [![Discussion][⛳gh-discussions-img]][⛳gh-discussions] [![Get help on Codementor][🖇codementor-img]][🖇codementor] [![Chat][🏘chat-img]][🏘chat] [![Blog][🚎blog-img]][🚎blog] [![Blog][🖐wiki-img]][🖐wiki]                                                                                     |
+| 7️⃣ | spread 💖             | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Tweet @ Peter][🏘tweet-img]][🏘tweet] [🌏][aboutme] [👼][angelme] [💻][coderme] [🌹][politicme]                                                                                                 |
+
+<!--
+The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
+-->
+
+<!-- 1️⃣ name, license, docs -->
+[⛳️gem]: https://rubygems.org/gems/oauth
+[⛳️name-img]: https://img.shields.io/badge/name-oauth-brightgreen.svg?style=flat
+[🖇src-license]: https://opensource.org/licenses/MIT
+[🖇src-license-img]: https://img.shields.io/badge/License-MIT-green.svg
+[🏘fossa]: https://app.fossa.io/projects/git%2Bgithub.com%2Foauth-xx%2Foauth-ruby?ref=badge_shield
+[🏘fossa-img]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Foauth-xx%2Foauth-ruby.svg?type=shield
+[🚎yard]: https://www.rubydoc.info/github/oauth-xx/oauth-ruby
+[🚎yard-img]: https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat
+[🖐inch-ci-img]: http://inch-ci.org/github/oauth-xx/oauth-ruby.png
+
+<!-- 2️⃣ version & activity -->
+[⛳️version-img]: http://img.shields.io/gem/v/oauth.svg
+[🖇DL-total-img]: https://img.shields.io/gem/dt/oauth.svg
+[🏘DL-rank-img]: https://img.shields.io/gem/rt/oauth.svg
+[🚎src-home]: https://github.com/oauth-xx/oauth-ruby
+[🚎src-home-img]: https://img.shields.io/badge/source-github-brightgreen.svg?style=flat
+[🖐prs-o]: https://github.com/oauth-xx/oauth-ruby/pulls
+[🖐prs-o-img]: https://img.shields.io/github/issues-pr/oauth-xx/oauth-ruby
+[🧮prs-c]: https://github.com/oauth-xx/oauth-ruby/pulls?q=is%3Apr+is%3Aclosed
+[🧮prs-c-img]: https://img.shields.io/github/issues-pr-closed/oauth-xx/oauth-ruby
+[📗next]: https://github.com/oauth-xx/oauth-ruby/milestone/1
+[📗next-img]: https://img.shields.io/github/milestones/progress/oauth-xx/oauth-ruby/1?label=Next%20Version
+
+<!-- 3️⃣ maintanence & linting -->
+[⛳cclim-maint]: https://codeclimate.com/github/oauth-xx/oauth-ruby/maintainability
+[⛳cclim-maint-img♻️]: https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/maintainability
+[🖇triage-help]: https://www.codetriage.com/oauth-xx/oauth-ruby
+[🖇triage-help-img]: https://www.codetriage.com/oauth-xx/oauth-ruby/badges/users.svg
+[🏘depfu♻️]: https://depfu.com/github/oauth-xx/oauth-ruby?project_id=22868
+[🏘depfu-img♻️]: https://badges.depfu.com/badges/d570491bac0ad3b0b65deb3c82028327/count.svg
+[🚎contributors]: https://github.com/oauth-xx/oauth-ruby/graphs/contributors
+[🚎contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby
+[🖐style-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/style.yml
+[🖐style-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/style.yml/badge.svg
+[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
+[🧮kloc-img]: https://img.shields.io/tokei/lines/github.com/oauth-xx/oauth-ruby
+
+<!-- 4️⃣ testing -->
+[⛳iss-o]: https://github.com/oauth-xx/oauth-ruby/issues
+[⛳iss-o-img]: https://img.shields.io/github/issues-raw/oauth-xx/oauth-ruby
+[🖇iss-c]: https://github.com/oauth-xx/oauth-ruby/issues?q=is%3Aissue+is%3Aclosed
+[🖇iss-c-img]: https://img.shields.io/github/issues-closed-raw/oauth-xx/oauth-ruby
+[🏘sup-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/supported.yml
+[🏘sup-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/supported.yml/badge.svg
+[🚎heads-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/heads.yml
+[🚎heads-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/heads.yml/badge.svg
+[🖐uns-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/unsupported.yml
+[🖐uns-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/unsupported.yml/badge.svg
+[🧮mac-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/macos.yml
+[🧮mac-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/macos.yml/badge.svg
+[📗win-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/windows.yml
+[📗win-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/windows.yml/badge.svg
+
+<!-- 5️⃣ coverage & security -->
+[⛳cclim-cov]: https://codeclimate.com/github/oauth-xx/oauth-ruby/test_coverage
+[⛳cclim-cov-img♻️]: https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/test_coverage
+[🖇codecov-img♻️]: https://codecov.io/gh/oauth-xx/oauth-ruby/branch/v0.5-maintenance/graph/badge.svg?token=4ZNAWNxrf9
+[🖇codecov]: https://codecov.io/gh/oauth-xx/oauth-ruby
+[🏘coveralls]: https://coveralls.io/github/oauth-xx/oauth-ruby?branch=v0.5-maintenance
+[🏘coveralls-img]: https://coveralls.io/repos/github/oauth-xx/oauth-ruby/badge.svg?branch=v0.5-maintenance
+[🚎sec-pol]: https://github.com/oauth-xx/oauth-ruby/blob/master/SECURITY.md
+[🚎sec-pol-img]: https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat
+[🖐codeQL]: https://github.com/oauth-xx/oauth-ruby/security/code-scanning
+[🖐codeQL-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/codeql-analysis.yml/badge.svg
+[🧮cov-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/coverage.yml
+[🧮cov-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/coverage.yml/badge.svg
+
+<!-- 6️⃣ resources -->
+[⛳gh-discussions]: https://github.com/oauth-xx/oauth-ruby/discussions
+[⛳gh-discussions-img]: https://img.shields.io/github/discussions/oauth-xx/oauth-ruby
+[🖇codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
+[🖇codementor-img]: https://cdn.codementor.io/badges/get_help_github.svg
+[🏘chat]: https://gitter.im/oauth-xx/oauth-ruby
+[🏘chat-img]: https://img.shields.io/gitter/room/oauth-xx/oauth-ruby.svg
+[🚎blog]: http://www.railsbling.com/tags/oauth-ruby/
+[🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
+[🖐wiki]: https://github.com/oauth-xx/oauth-ruby/wiki
+[🖐wiki-img]: https://img.shields.io/badge/wiki-examples-brightgreen.svg?style=flat
+
+<!-- 7️⃣ spread 💖 -->
+[⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
+[⛳liberapay]: https://liberapay.com/pboling/donate
+[🖇sponsor-img]: https://img.shields.io/badge/sponsor-pboling.svg?style=social&logo=github
+[🖇sponsor]: https://github.com/sponsors/pboling
+[🏘tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
+[🏘tweet]: http://twitter.com/galtzo
+
+<!-- Maintainer Contact Links -->
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[aboutme]: https://about.me/peter.boling
+[angelme]: https://angel.co/peter-boling
+[coderme]:http://coderwall.com/pboling
+[politicme]: https://nationalprogressiveparty.org
+
 
-## What
+## Installation
 
-This is a RubyGem for implementing both OAuth 1.0 clients and servers in Ruby
-applications.
+Install the gem and add to the application's Gemfile by executing:
 
-See the OAuth 1.0 spec http://oauth.net/core/1.0/
+    $ bundle add oauth
 
-See the sibling gem [oauth2](https://github.com/oauth-xx/oauth2) for OAuth 2.0 implementations in Ruby.
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-## Installation
+    $ gem install oauth
 
-Add this line to your application's Gemfile:
+## OAuth for Enterprise
 
-```ruby
-gem "oauth"
-```
+Available as part of the Tidelift Subscription.
 
-And then execute:
+The maintainers of OAuth2 and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=enterprise)
 
-    $ bundle install
+## Security contact information [![Security Policy][🚎sec-pol-img]][🚎sec-pol]
 
-Or install it yourself as:
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
 
-    $ gem install oauth
+For more see [SECURITY.md][🚎sec-pol].
 
 ## Compatibility
 
-Targeted ruby compatibility is non-EOL versions of Ruby, currently 2.6, 2.7, and
-3.0. Ruby is limited to 2.0+ in the gemspec, and this may change while the gem is
-still at version 0.x.  The `master` branch currently targets 0.6.x releases.
+Targeted ruby compatibility is non-EOL versions of Ruby, currently 2.7, 3.0, and
+3.1. Ruby is limited to 2.0+ in the gemspec on this `v0.5-maintenance` branch, and
+this will change with minor version bumps, while the gem is still in 0.x,
+in accordance with the SemVer spec.
+
+The `master` branch now targets 0.6.x releases.
+See `v0.5-maintenance` branch for older rubies.
+
+NOTE: If there is another 0.5.x release it is anticipated to be the last of the 0.5.x series.
+
+<details>
+  <summary>Ruby Engine Compatibility Policy</summary>
+
+This gem is tested against MRI, JRuby, and Truffleruby.
+Each of those has varying versions that target a specific version of MRI Ruby.
+This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below.
+If you would like to add support for additional engines,
+first make sure Github Actions supports the engine,
+then submit a PR to the correct maintenance branch as according to the table below.
+</details>
 
-| Ruby OAuth Version   | Maintenance Branch | Officially Supported Rubies                 | Unofficially Supported Rubies |
-|--------------------- | ------------------ | ------------------------------------------- | ----------------------------- |
-| 0.7.x (hypothetical) | N/A                | 2.7, 3.0, 3.1                               | 2.6                           |
-| 0.6.x                | `master`           | 2.6, 2.7, 3.0                               | 2.3, 2.4, 2.5                 |
-| 0.5.x                | `v0.5-maintenance` | 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0 |                               |
+<details>
+  <summary>Ruby Version Compatibility Policy</summary>
 
-NOTE: 0.5.7 is anticipated as last release of the 0.5.x series.
+If something doesn't work on one of these interpreters, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+implementation, you will be responsible for providing patches in a timely
+fashion. If critical issues for a particular implementation exist at the time
+of a major release, support for that Ruby version may be dropped.
+</details>
+
+|     | Ruby OAuth Version | Maintenance Branch | Supported Officially | Supported Unofficially       | Supported Incidentally |
+|:----|--------------------|--------------------|----------------------|------------------------------|------------------------|
+| 1️⃣ | 0.6.x (unreleased) | `master`           | 2.7, 3.0, 3.1        | 2.5, 2.6                     | 2.4                    |
+| 2️⃣ | 0.5.x              | `v0.5-maintenance` | 2.7, 3.0, 3.1        | 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 | 2.0                    |
+| 3️⃣ | older              | N/A                | Best of luck to you! | Please upgrade!              |                        |
+
+NOTE: Once 1.0 is released, the 0.x series will only receive critical bug and security updates.
+See [SECURITY.md][🚎sec-pol]
 
 ## Basics
 
@@ -117,34 +298,29 @@ OAuth provider if you choose.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/oauth-xx/oauth-ruby][source]. This project is
-intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
-the [code of conduct][conduct].
-
-To submit a patch, please fork the oauth project and create a patch with
-tests. Once you're happy with it send a pull request and post a message to the
-[google group][mailinglist].
+See [CONTRIBUTING.md][contributing]
 
 ## Contributors
 
-[![Contributors](https://contrib.rocks/image?repo=oauth-xx/oauth-ruby)]("https://github.com/oauth-xx/oauth-ruby/graphs/contributors")
+[![Contributors](https://contrib.rocks/image?repo=oauth-xx/oauth-ruby)][contributors]
 
-Made with [contributors-img](https://contrib.rocks).
+Made with [contributors-img][contrib-rocks].
 
 ## Versioning
 
 This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations of this scheme should be reported as
 bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be
 immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new
-major versions.
+major versions.  Compatibility with a major and minor versions of Ruby will only be changed with a major version bump.
 
 As a result of this policy, you can (and should) specify a dependency on this gem using
-the [Pessimistic Version Constraint][pvc] with two digits of precision.
+the [Pessimistic Version Constraint][pvc] with two digits of precision once it hits a 1.0 release.
+While on 0.x releases three digits of precision should be used.
 
 For example:
 
 ```ruby
-spec.add_dependency "oauth", "~> 0.5"
+spec.add_dependency "oauth", "~> 0.5.9"
 ```
 
 ## License
@@ -160,64 +336,37 @@ individuals. The current maintainer is Peter Boling ([@pboling][gh_sponsors]).
 
 Comments are welcome. Contact the [OAuth Ruby mailing list (Google Group)][mailinglist] or [GitHub Discussions][gh_discussions].
 
-[copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
-
-[gh_discussions]: https://github.com/oauth-xx/oauth-ruby/discussions
-
-[mailinglist]: http://groups.google.com/group/oauth-ruby
+[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
 
 [conduct]: https://github.com/oauth-xx/oauth-ruby/blob/master/CODE_OF_CONDUCT.md
+[contributing]: https://github.com/oauth-xx/oauth-ruby/blob/master/CONTRIBUTING.md
+[contributors]: https://github.com/oauth-xx/oauth-ruby/graphs/contributors
+[mailinglist]: http://groups.google.com/group/oauth-ruby
+[source]: https://github.com/oauth-xx/oauth-ruby/
 
-[license]: LICENSE
-
-[license-ref]: https://opensource.org/licenses/MIT
-
-[semver]: http://semver.org/
-
-[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
-
-[railsbling]: http://www.railsbling.com
-
-[peterboling]: http://www.peterboling.com
+[comment]: <> (Following links are used by README, Homepage)
 
 [aboutme]: https://about.me/peter.boling
-
-[angelme]: https://angel.co/peter-boling
-
-[coderme]:http://coderwall.com/pboling
-
-[followme-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
-
-[tweetme]: http://twitter.com/galtzo
-
-[politicme]: https://nationalprogressiveparty.org
-
-[documentation]: https://rubydoc.info/github/oauth-xx/oauth-ruby/main
-
-[source]: https://github.com/oauth-xx/oauth-ruby/
-
 [actions]: https://github.com/oauth-xx/oauth-ruby/actions
-
-[issues]: https://github.com/oauth-xx/oauth-ruby/issues
-
-[climate_maintainability]: https://codeclimate.com/github/oauth-xx/oauth-ruby/maintainability
-
+[angelme]: https://angel.co/peter-boling
+[blogpage]: http://www.railsbling.com/tags/oauth/
+[chat]: https://gitter.im/oauth-xx/oauth-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
 [climate_coverage]: https://codeclimate.com/github/oauth-xx/oauth-ruby/test_coverage
-
-[codecov_coverage]: https://codecov.io/gh/oauth-xx/oauth-ruby
-
+[climate_maintainability]: https://codeclimate.com/github/oauth-xx/oauth-ruby/maintainability
 [code_triage]: https://www.codetriage.com/oauth-xx/oauth-ruby
-
+[codecov_coverage]: https://codecov.io/gh/oauth-xx/oauth-ruby
+[coderme]:http://coderwall.com/pboling
 [depfu]: https://depfu.com/github/oauth-xx/oauth-ruby?project_id=22868
-
-[blogpage]: http://www.railsbling.com/tags/oauth/
-
-[rubygems]: https://rubygems.org/gems/oauth
-
-[chat]: https://gitter.im/oauth-xx/oauth-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
-
-[maintenancee_policy]: https://guides.rubyonrails.org/maintenance_policy.html#security-issues
-
+[documentation]: https://rubydoc.info/github/oauth-xx/oauth-ruby
+[followme-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
+[gh_discussions]: https://github.com/oauth-xx/oauth-ruby/discussions
+[gh_sponsors]: https://github.com/sponsors/pboling
+[license]: https://github.com/oauth-xx/oauth-ruby/blob/master/LICENSE
+[license-ref]: https://opensource.org/licenses/MIT
 [liberapay_donate]: https://liberapay.com/pboling/donate
-
-[gh_sponsors]: https://github.com/sponsors/pboling
+[politicme]: https://nationalprogressiveparty.org
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[rubygems]: https://rubygems.org/gems/oauth
+[security]: https://github.com/oauth-xx/oauth-ruby/blob/master/SECURITY.md
+[semver]: http://semver.org/
+[tweetme]: http://twitter.com/galtzo

data/SECURITY.md

@@ -0,0 +1,16 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.7.x   | :white_check_mark: |
+| 0.6.x   | :white_check_mark: |
+| 0.5.x   | :white_check_mark: |
+| <= 0.5  | :x:                |
+
+## Reporting a Vulnerability
+
+Peter Boling is the primary maintainer of the this gem.  Please find a way to [contact him directly][contact] to report the issue.  Include as much relevant information as possible.
+
+[contact]: https://railsbling.com/contact

data/lib/oauth/cli/authorize_command.rb

@@ -1,6 +1,5 @@
 class OAuth::CLI
   class AuthorizeCommand < BaseCommand
-
     def required_options
       [:uri]
     end
@@ -25,7 +24,7 @@ class OAuth::CLI
     def get_request_token
       consumer = get_consumer
       scope_options = options[:scope] ? { "scope" => options[:scope] } : {}
-      consumer.get_request_token({ :oauth_callback => options[:oauth_callback] }, scope_options)
+      consumer.get_request_token({ oauth_callback: options[:oauth_callback] }, scope_options)
     rescue OAuth::Unauthorized => e
       alert "A problem occurred while attempting to authorize:"
       alert e
@@ -36,14 +35,13 @@ class OAuth::CLI
       OAuth::Consumer.new \
         options[:oauth_consumer_key],
         options[:oauth_consumer_secret],
-        :access_token_url  => options[:access_token_url],
-        :authorize_url     => options[:authorize_url],
-        :request_token_url => options[:request_token_url],
-        :scheme            => options[:scheme],
-        :http_method       => options[:method].to_s.downcase.to_sym
+        access_token_url: options[:access_token_url],
+        authorize_url: options[:authorize_url],
+        request_token_url: options[:request_token_url],
+        scheme: options[:scheme],
+        http_method: options[:method].to_s.downcase.to_sym
     end
 
-
     def ask_user_for_verifier
       if options[:version] == "1.0a"
         puts "Please enter the verification code provided by the SP (oauth_verifier):"
@@ -56,10 +54,10 @@ class OAuth::CLI
     end
 
     def verbosely_get_access_token(request_token, oauth_verifier)
-      access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
+      access_token = request_token.get_access_token(oauth_verifier: oauth_verifier)
 
       puts "Response:"
-      access_token.params.each do |k,v|
+      access_token.params.each do |k, v|
         puts "  #{k}: #{v}" unless k.is_a?(Symbol)
       end
     rescue OAuth::Unauthorized => e

data/lib/oauth/cli/base_command.rb

@@ -1,7 +1,9 @@
 class OAuth::CLI
   class BaseCommand
     def initialize(stdout, stdin, stderr, arguments)
-      @stdout, @stdin, @stderr = stdout, stdin, stderr
+      @stdout = stdout
+      @stdin = stdin
+      @stderr = stderr
 
       @options = {}
       option_parser.parse!(arguments)
@@ -38,11 +40,11 @@ class OAuth::CLI
       options[:verbose]
     end
 
-    def puts(string=nil)
+    def puts(string = nil)
       @stdout.puts(string)
     end
 
-    def alert(string=nil)
+    def alert(string = nil)
       @stderr.puts(string)
     end
 
@@ -50,8 +52,8 @@ class OAuth::CLI
       @parameters ||= begin
         escaped_pairs = options[:params].collect do |pair|
           if pair =~ /:/
-            Hash[*pair.split(":", 2)].collect do |k,v|
-              [CGI.escape(k.strip), CGI.escape(v.strip)] * "="
+            Hash[*pair.split(":", 2)].collect do |k, v|
+              [CGI.escape(k.strip), CGI.escape(v.strip)].join("=")
             end
           else
             pair
@@ -68,7 +70,7 @@ class OAuth::CLI
           "oauth_token"            => options[:oauth_token],
           "oauth_signature_method" => options[:oauth_signature_method],
           "oauth_version"          => options[:oauth_version]
-        }.reject { |_k,v| v.nil? || v == "" }.merge(cli_params)
+        }.reject { |_k, v| v.nil? || v == "" }.merge(cli_params)
       end
     end
 

data/lib/oauth/cli/query_command.rb

@@ -3,7 +3,7 @@ class OAuth::CLI
     extend OAuth::Helper
 
     def required_options
-      [:oauth_consumer_key, :oauth_consumer_secret, :oauth_token, :oauth_token_secret]
+      %i[oauth_consumer_key oauth_consumer_secret oauth_token oauth_token_secret]
     end
 
     def _run
@@ -13,8 +13,8 @@ class OAuth::CLI
 
       # append params to the URL
       uri = URI.parse(options[:uri])
-      params = parameters.map { |k,v| Array(v).map { |v2| "#{OAuth::Helper.escape(k)}=#{OAuth::Helper.escape(v2)}" } * "&" }
-      uri.query = [uri.query, *params].reject { |x| x.nil? } * "&"
+      params = parameters.map { |k, v| Array(v).map { |v2| "#{OAuth::Helper.escape(k)}=#{OAuth::Helper.escape(v2)}" } * "&" }
+      uri.query = [uri.query, *params].reject(&:nil?) * "&"
       puts uri.to_s
 
       response = access_token.request(options[:method].to_s.downcase.to_sym, uri.to_s)

data/lib/oauth/cli/sign_command.rb

@@ -1,23 +1,20 @@
 class OAuth::CLI
   class SignCommand < BaseCommand
-
     def required_options
-      [:oauth_consumer_key, :oauth_consumer_secret, :oauth_token, :oauth_token_secret]
+      %i[oauth_consumer_key oauth_consumer_secret oauth_token oauth_token_secret]
     end
 
     def _run
       request = OAuth::RequestProxy.proxy \
-         "method"     => options[:method],
-         "uri"        => options[:uri],
-         "parameters" => parameters
+        "method"     => options[:method],
+        "uri"        => options[:uri],
+        "parameters" => parameters
 
-      if verbose?
-        puts_verbose_parameters(request)
-      end
+      puts_verbose_parameters(request) if verbose?
 
       request.sign! \
-        :consumer_secret => options[:oauth_consumer_secret],
-        :token_secret    => options[:oauth_token_secret]
+        consumer_secret: options[:oauth_consumer_secret],
+        token_secret: options[:oauth_token_secret]
 
       if verbose?
         puts_verbose_request(request)
@@ -28,15 +25,15 @@ class OAuth::CLI
 
     def puts_verbose_parameters(request)
       puts "OAuth parameters:"
-      request.oauth_parameters.each do |k,v|
-        puts "  " + [k, v] * ": "
+      request.oauth_parameters.each do |k, v|
+        puts "  " + [k, v].join(": ")
       end
       puts
 
       if request.non_oauth_parameters.any?
         puts "Parameters:"
-        request.non_oauth_parameters.each do |k,v|
-          puts "  " + [k, v] * ": "
+        request.non_oauth_parameters.each do |k, v|
+          puts "  " + [k, v].join(": ")
         end
         puts
       end
@@ -58,7 +55,7 @@ class OAuth::CLI
       else
         puts "OAuth Request URI: #{request.signed_uri}"
         puts "Request URI: #{request.signed_uri(false)}"
-        puts "Authorization header: #{request.oauth_header(:realm => options[:realm])}"
+        puts "Authorization header: #{request.oauth_header(realm: options[:realm])}"
       end
       puts "Signature:         #{request.oauth_signature}"
       puts "Escaped signature: #{OAuth::Helper.escape(request.oauth_signature)}"

data/lib/oauth/cli.rb

@@ -18,8 +18,8 @@ module OAuth
       "v" => "version",
       "q" => "query",
       "a" => "authorize",
-      "s" => "sign",
-    }
+      "s" => "sign"
+    }.freeze
 
     def initialize(stdout, stdin, stderr, command, arguments)
       klass = get_command_class(parse_command(command))