oauth 0.5.8 → 0.6.0

data/README.md

@@ -1,59 +1,234 @@
+<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
 
-**NOTE**
+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.
 
-This README, on branch `v0.5-maintenance`, targets 0.5.x series releases.  For later releases please see the `msater` branch README.
+* [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
 
 ## 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] [![Total Downloads](https://img.shields.io/gem/dt/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] [![Maintenance Policy](https://img.shields.io/badge/maintenance-policy-brightgreen.svg?style=flat)][security] |
-| resources                  |  [![Discussion](https://img.shields.io/badge/discussions-github-brightgreen.svg?style=flat)][gh_discussions] [![Mailing List](https://img.shields.io/badge/group-mailinglist.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] [![Sponsor Me](https://img.shields.io/badge/sponsor-pboling.svg?style=social&logo=github)][gh_sponsors] [🌏][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️⃣ | maintenance & 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]                                                                                                 |
+
+<!--
+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/master/graph/badge.svg?token=4ZNAWNxrf9
+[🖇codecov]: https://codecov.io/gh/oauth-xx/oauth-ruby
+[🏘coveralls]: https://coveralls.io/github/oauth-xx/oauth-ruby?branch=master
+[🏘coveralls-img]: https://coveralls.io/repos/github/oauth-xx/oauth-ruby/badge.svg?branch=master
+[🚎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
 
-## 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.4+ in the gemspec, 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 1.0.x releases.
+See `v0.6-maintenance` branch for Ruby >= 2.4.
+See `v0.5-maintenance` branch for Ruby >= 2.0.
+
+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, and to a lesser extent, against 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>
+
+<details>
+  <summary>Ruby Version Compatibility Policy</summary>
+
+If something doesn't work on one of these interpreters, it's a bug.
 
-| 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 |                               |
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
 
-NOTE: 0.5.7 is anticipated as last release of the 0.5.x series.
+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 | 🚂 Compatibility       | Official 💎          | Unofficial 💎                | Incidental 💎 |
+|:----|--------------------|--------------------|------------------------|----------------------|------------------------------|---------------|
+| 1️⃣ | 1.0.x              | `master`           | Rails 6, 7             | 2.7, 3.0, 3.1        | sorry, not sorry             | nope          |
+| 2️⃣ | 0.6.x              | `v0.6-maintenance` | Rails 5, 6, 7          | 2.7, 3.0, 3.1        | 2.5, 2.6                     | 2.4           |
+| 3️⃣ | 0.5.x              | `v0.5-maintenance` | Rails 2, 3, 4, 5, 6, 7 | 2.7, 3.0, 3.1        | 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 | 2.0           |
+| 4️⃣ | older              | N/A                |                        | Best of luck to you! | Please upgrade!              | noop          |
+
+NOTE: Once 1.0 is released, the 0.x series will only receive critical bug and security updates.
+See [SECURITY.md][🚎sec-pol]
+
+🚂 NOTE: See notes on Rails in next section.
 
 ## Basics
 
@@ -61,51 +236,64 @@ This is a ruby library which is intended to be used in creating Ruby Consumer
 and Service Provider applications. It is NOT a Rails plugin, but could easily
 be used for the foundation for such a Rails plugin.
 
-As a matter of fact it has been pulled out from an OAuth Rails GEM
-(https://rubygems.org/gems/oauth-plugin https://github.com/pelle/oauth-plugin)
-which now uses this gem as a dependency.
+This gem was originally extracted from @pelle's [oauth-plugin](https://github.com/pelle/oauth-plugin)
+gem. After extraction that gem was made to depend on this gem.
+
+Unfortunately, this gem does have some Rails related bits that are
+**optional** to load. You don't need Rails! The Rails bits may be pulled out
+into a separate gem after the release of version 1.0 of this gem.
 
 ## Usage
 
-We need to specify the oauth_callback url explicitly, otherwise it defaults to
+We need to specify the `oauth_callback` url explicitly, otherwise it defaults to
 "oob" (Out of Band)
 
-    callback_url = "http://127.0.0.1:3000/oauth/callback"
+```ruby
+callback_url = "http://127.0.0.1:3000/oauth/callback"
+```
 
 Create a new `OAuth::Consumer` instance by passing it a configuration hash:
 
-    oauth_consumer = OAuth::Consumer.new("key", "secret", :site => "https://agree2")
+```ruby
+oauth_consumer = OAuth::Consumer.new("key", "secret", site: "https://agree2")
+```
 
 Start the process by requesting a token
 
-    request_token = oauth_consumer.get_request_token(:oauth_callback => callback_url)
+```ruby
+request_token = oauth_consumer.get_request_token(oauth_callback: callback_url)
 
-    session[:token] = request_token.token
-    session[:token_secret] = request_token.secret
-    redirect_to request_token.authorize_url(:oauth_callback => callback_url)
+session[:token] = request_token.token
+session[:token_secret] = request_token.secret
+redirect_to request_token.authorize_url(oauth_callback: callback_url)
+```
 
 When user returns create an access_token
 
-    hash = { oauth_token: session[:token], oauth_token_secret: session[:token_secret]}
-    request_token  = OAuth::RequestToken.from_hash(oauth_consumer, hash)
-    access_token = request_token.get_access_token
-    # For 3-legged authorization, flow oauth_verifier is passed as param in callback
-    # access_token = request_token.get_access_token(oauth_verifier: params[:oauth_verifier])
-    @photos = access_token.get('/photos.xml')
+```ruby
+hash = { oauth_token: session[:token], oauth_token_secret: session[:token_secret] }
+request_token = OAuth::RequestToken.from_hash(oauth_consumer, hash)
+access_token = request_token.get_access_token
+# For 3-legged authorization, flow oauth_verifier is passed as param in callback
+# access_token = request_token.get_access_token(oauth_verifier: params[:oauth_verifier])
+@photos = access_token.get("/photos.xml")
+```
 
 Now that you have an access token, you can use Typhoeus to interact with the
 OAuth provider if you choose.
 
-    require 'typhoeus'
-    require 'oauth/request_proxy/typhoeus_request'
-    oauth_params = {:consumer => oauth_consumer, :token => access_token}
-    hydra = Typhoeus::Hydra.new
-    req = Typhoeus::Request.new(uri, options) # :method needs to be specified in options
-    oauth_helper = OAuth::Client::Helper.new(req, oauth_params.merge(:request_uri => uri))
-    req.options[:headers].merge!({"Authorization" => oauth_helper.header}) # Signs the request
-    hydra.queue(req)
-    hydra.run
-    @response = req.response
+```ruby
+require "typhoeus"
+require "oauth/request_proxy/typhoeus_request"
+oauth_params = { consumer: oauth_consumer, token: access_token }
+hydra = Typhoeus::Hydra.new
+req = Typhoeus::Request.new(uri, options) # :method needs to be specified in options
+oauth_helper = OAuth::Client::Helper.new(req, oauth_params.merge(request_uri: uri))
+req.options[:headers]["Authorization"] = oauth_helper.header # Signs the request
+hydra.queue(req)
+hydra.run
+@response = req.response
+```
 
 ## More Information
 
@@ -130,7 +318,7 @@ Made with [contributors-img][contrib-rocks].
 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.
@@ -138,7 +326,7 @@ the [Pessimistic Version Constraint][pvc] with two digits of precision.
 For example:
 
 ```ruby
-spec.add_dependency "oauth", "~> 0.5"
+spec.add_dependency "oauth", "~> 0.6.0"
 ```
 
 ## License
@@ -182,7 +370,6 @@ Comments are welcome. Contact the [OAuth Ruby mailing list (Google Group)][maili
 [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
-[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

data/SECURITY.md

@@ -2,15 +2,13 @@
 
 ## 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:                |
+| Version            | Supported          |
+|--------------------| ------------------ |
+| 0.6.x (unreleased) | :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
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.

data/bin/oauth

@@ -1,11 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative "../lib/oauth"
+require "oauth"
 require "oauth/cli"
 
-Signal.trap("INT") { puts; exit(1) } # don't dump a backtrace on a ^C
-
+# don't dump a backtrace on a ^C
+Signal.trap("INT") do
+  puts
+  exit(1)
+end
 ARGV << "help" if ARGV.empty?
 command = ARGV.shift
 
-OAuth::CLI.new(STDOUT, STDIN, STDERR, command, ARGV).run
+OAuth::CLI.new($stdout, $stdin, $stderr, command, ARGV).run

data/lib/oauth/cli/authorize_command.rb

@@ -1,71 +1,73 @@
-class OAuth::CLI
-  class AuthorizeCommand < BaseCommand
+# frozen_string_literal: true
 
-    def required_options
-      [:uri]
-    end
-
-    def _run
-      request_token = get_request_token
-
-      if request_token.callback_confirmed?
-        puts "Server appears to support OAuth 1.0a; enabling support."
-        options[:version] = "1.0a"
+module OAuth
+  class CLI
+    class AuthorizeCommand < BaseCommand
+      def required_options
+        [:uri]
       end
 
-      puts "Please visit this url to authorize:"
-      puts request_token.authorize_url
+      def _run
+        request_token = get_request_token
 
-      # parameters for OAuth 1.0a
-      oauth_verifier = ask_user_for_verifier
+        if request_token.callback_confirmed?
+          puts "Server appears to support OAuth 1.0a; enabling support."
+          options[:version] = "1.0a"
+        end
 
-      verbosely_get_access_token(request_token, oauth_verifier)
-    end
+        puts "Please visit this url to authorize:"
+        puts request_token.authorize_url
 
-    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)
-    rescue OAuth::Unauthorized => e
-      alert "A problem occurred while attempting to authorize:"
-      alert e
-      alert e.request.body
-    end
+        # parameters for OAuth 1.0a
+        oauth_verifier = ask_user_for_verifier
 
-    def get_consumer
-      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
-    end
+        verbosely_get_access_token(request_token, oauth_verifier)
+      end
 
+      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)
+      rescue OAuth::Unauthorized => e
+        alert "A problem occurred while attempting to authorize:"
+        alert e
+        alert e.request.body
+      end
 
-    def ask_user_for_verifier
-      if options[:version] == "1.0a"
-        puts "Please enter the verification code provided by the SP (oauth_verifier):"
-        @stdin.gets.chomp
-      else
-        puts "Press return to continue..."
-        @stdin.gets
-        nil
+      def get_consumer
+        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
+      end
+
+      def ask_user_for_verifier
+        if options[:version] == "1.0a"
+          puts "Please enter the verification code provided by the SP (oauth_verifier):"
+          @stdin.gets.chomp
+        else
+          puts "Press return to continue..."
+          @stdin.gets
+          nil
+        end
       end
-    end
 
-    def verbosely_get_access_token(request_token, oauth_verifier)
-      access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
+      def verbosely_get_access_token(request_token, oauth_verifier)
+        access_token = request_token.get_access_token(oauth_verifier: oauth_verifier)
 
-      puts "Response:"
-      access_token.params.each do |k,v|
-        puts "  #{k}: #{v}" unless k.is_a?(Symbol)
+        puts "Response:"
+        access_token.params.each do |k, v|
+          puts "  #{k}: #{v}" unless k.is_a?(Symbol)
+        end
+      rescue OAuth::Unauthorized => e
+        alert "A problem occurred while attempting to obtain an access token:"
+        alert e
+        alert e.request.body
       end
-    rescue OAuth::Unauthorized => e
-      alert "A problem occurred while attempting to obtain an access token:"
-      alert e
-      alert e.request.body
     end
   end
 end