oauth 0.5.9 → 0.5.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -1
- data/CONTRIBUTING.md +2 -2
- data/README.md +227 -48
- data/SECURITY.md +10 -4
- data/lib/oauth/version.rb +1 -1
- metadata +65 -37
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1383760af4fa4c23f17387391201215fae2fb7547e5416f47b293f53a1cf95a5
|
|
4
|
+
data.tar.gz: 60b6383d43251da5bd3f410fd08cb4b537b82bc9a4ceda74a18803deb5282781
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f4ccb62d26bcfa62ca0b7f1bf578d3e4f4d0a1c97c59289843450c67bfdf5dd3793eefc1fd4d6c533447f95bb229d85192677b8711bfdad56843ea0ddc82677f
|
|
7
|
+
data.tar.gz: eb3f300e571daee4cd9ca6fedf75eaefaf0a315469651949a24a8786d6474353b374121379dd52acd3a72b2f580a87fd2ac3443436d447083da87913784b16ec
|
data/CHANGELOG.md
CHANGED
|
@@ -13,6 +13,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
13
13
|
|
|
14
14
|
### Removed
|
|
15
15
|
|
|
16
|
+
## [0.5.11] 2022-08-23
|
|
17
|
+
The "Is this the last release with a silly name?" Release
|
|
18
|
+
|
|
19
|
+
### Added
|
|
20
|
+
* Post install note about EOL approaching in April, 2023
|
|
21
|
+
|
|
22
|
+
### Changed
|
|
23
|
+
* Improved documentation
|
|
24
|
+
* Switched branch references from master to main
|
|
25
|
+
* CI builds are now all green!
|
|
26
|
+
|
|
27
|
+
## [0.5.10] 2022-05-04
|
|
28
|
+
The "Can it be the end of the line for 0.5.x?" Release
|
|
29
|
+
|
|
30
|
+
### Added
|
|
31
|
+
* Major updates to Documentation
|
|
32
|
+
* More CI Hardening
|
|
33
|
+
* Align CI builds with official Ruby Compatibility Matrix
|
|
34
|
+
* Project tooling in preparation for final release of 0.5.x series
|
|
35
|
+
- diffend
|
|
36
|
+
|
|
16
37
|
## [0.5.9] 2022-05-03
|
|
17
38
|
### Added
|
|
18
39
|
* Documentation related to Ruby compatibility
|
|
@@ -376,7 +397,9 @@ but please have a look at the unit tests.
|
|
|
376
397
|
* Moved all non-Rails functionality from the Rails plugin:
|
|
377
398
|
http://code.google.com/p/oauth-plugin/
|
|
378
399
|
|
|
379
|
-
[Unreleased]: https://github.com/oauth-xx/oauth-ruby/compare/v0.5.
|
|
400
|
+
[Unreleased]: https://github.com/oauth-xx/oauth-ruby/compare/v0.5.11...v0.5-maintenance
|
|
401
|
+
[0.5.11]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.11
|
|
402
|
+
[0.5.10]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.10
|
|
380
403
|
[0.5.9]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.9
|
|
381
404
|
[0.5.8]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.8
|
|
382
405
|
[0.5.7]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.7
|
data/CONTRIBUTING.md
CHANGED
|
@@ -16,8 +16,8 @@ Made with [contributors-img][contrib-rocks].
|
|
|
16
16
|
|
|
17
17
|
[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
|
|
18
18
|
|
|
19
|
-
[conduct]: https://github.com/oauth-xx/oauth-ruby/blob/
|
|
20
|
-
[contributing]: https://github.com/oauth-xx/oauth-ruby/blob/
|
|
19
|
+
[conduct]: https://github.com/oauth-xx/oauth-ruby/blob/main/CODE_OF_CONDUCT.md
|
|
20
|
+
[contributing]: https://github.com/oauth-xx/oauth-ruby/blob/main/CONTRIBUTING.md
|
|
21
21
|
[contributors]: https://github.com/oauth-xx/oauth-ruby/graphs/contributors
|
|
22
22
|
[mailinglist]: http://groups.google.com/group/oauth-ruby
|
|
23
23
|
[source]: https://github.com/oauth-xx/oauth-ruby/
|
data/README.md
CHANGED
|
@@ -1,63 +1,237 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="http://oauth.net/core/1.0/" target="_blank" rel="noopener">
|
|
3
|
+
<img width="124px" src="https://github.com/oauth-xx/oauth-ruby/raw/main/docs/images/logo/Oauth_logo.svg?raw=true" alt="OAuth 1.0 Logo by Chris Messina, CC BY-SA 3.0, via Wikimedia Commons">
|
|
4
|
+
</a>
|
|
5
|
+
<a href="https://www.ruby-lang.org/" target="_blank" rel="noopener">
|
|
6
|
+
<img width="124px" src="https://github.com/oauth-xx/oauth-ruby/raw/main/docs/images/logo/ruby-logo-198px.svg?raw=true" alt="Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5">
|
|
7
|
+
</a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
1
10
|
# Ruby OAuth
|
|
2
11
|
|
|
12
|
+
OAuth 1.0 is an industry-standard protocol for authorization.
|
|
13
|
+
|
|
14
|
+
This is a RubyGem for implementing both OAuth 1.0 clients and servers in Ruby applications.
|
|
15
|
+
See the sibling `oauth2` gem for OAuth 2.0 implementations in Ruby.
|
|
16
|
+
|
|
17
|
+
* [OAuth 1.0 Spec][oauth1-spec]
|
|
18
|
+
* [oauth2 sibling gem][sibling-gem] for OAuth 2.0 implementations in Ruby.
|
|
19
|
+
|
|
20
|
+
[oauth1-spec]: http://oauth.net/core/1.0/
|
|
21
|
+
[sibling-gem]: https://github.com/oauth-xx/oauth-ruby
|
|
22
|
+
|
|
3
23
|
**NOTE**
|
|
4
24
|
|
|
5
|
-
This README, on branch `v0.5-maintenance`, targets 0.5.x series releases.
|
|
25
|
+
This README, on branch `v0.5-maintenance`, targets 0.5.x series releases.
|
|
26
|
+
The v0.5.x series of releases will be EOL no later than April, 2023.
|
|
27
|
+
For later releases please see the `main` branch README.
|
|
6
28
|
|
|
7
29
|
## Status
|
|
8
30
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
31
|
+
<!--
|
|
32
|
+
Numbering rows and badges in each row as a visual "database" lookup,
|
|
33
|
+
as the table is extremely dense, and it can be very difficult to find anything
|
|
34
|
+
Putting one on each row here, to document the emoji that should be used, and for ease of copy/paste.
|
|
35
|
+
|
|
36
|
+
row #s:
|
|
37
|
+
1️⃣
|
|
38
|
+
2️⃣
|
|
39
|
+
3️⃣
|
|
40
|
+
4️⃣
|
|
41
|
+
5️⃣
|
|
42
|
+
6️⃣
|
|
43
|
+
7️⃣
|
|
44
|
+
|
|
45
|
+
badge #s:
|
|
46
|
+
⛳️
|
|
47
|
+
🖇
|
|
48
|
+
🏘
|
|
49
|
+
🚎
|
|
50
|
+
🖐
|
|
51
|
+
🧮
|
|
52
|
+
📗
|
|
53
|
+
|
|
54
|
+
appended indicators:
|
|
55
|
+
♻️ - URL needs to be updated from SASS integration. Find / Replace is insufficient.
|
|
56
|
+
-->
|
|
57
|
+
|
|
58
|
+
| | Project | bundle add oauth2 |
|
|
59
|
+
|:----|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
60
|
+
| 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] |
|
|
61
|
+
| 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] |
|
|
62
|
+
| 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] |
|
|
63
|
+
| 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] |
|
|
64
|
+
| 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] |
|
|
65
|
+
| 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] |
|
|
66
|
+
| 7️⃣ | spread 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Tweet @ Peter][🏘tweet-img]][🏘tweet] [🌏][aboutme] [👼][angelme] [💻][coderme] |
|
|
67
|
+
|
|
68
|
+
<!--
|
|
69
|
+
The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
|
|
70
|
+
-->
|
|
71
|
+
|
|
72
|
+
<!-- 1️⃣ name, license, docs -->
|
|
73
|
+
[⛳️gem]: https://rubygems.org/gems/oauth
|
|
74
|
+
[⛳️name-img]: https://img.shields.io/badge/name-oauth-brightgreen.svg?style=flat
|
|
75
|
+
[🖇src-license]: https://opensource.org/licenses/MIT
|
|
76
|
+
[🖇src-license-img]: https://img.shields.io/badge/License-MIT-green.svg
|
|
77
|
+
[🏘fossa]: https://app.fossa.io/projects/git%2Bgithub.com%2Foauth-xx%2Foauth-ruby?ref=badge_shield
|
|
78
|
+
[🏘fossa-img]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Foauth-xx%2Foauth-ruby.svg?type=shield
|
|
79
|
+
[🚎yard]: https://www.rubydoc.info/github/oauth-xx/oauth-ruby
|
|
80
|
+
[🚎yard-img]: https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat
|
|
81
|
+
[🖐inch-ci-img]: http://inch-ci.org/github/oauth-xx/oauth-ruby.png
|
|
82
|
+
|
|
83
|
+
<!-- 2️⃣ version & activity -->
|
|
84
|
+
[⛳️version-img]: http://img.shields.io/gem/v/oauth.svg
|
|
85
|
+
[🖇DL-total-img]: https://img.shields.io/gem/dt/oauth.svg
|
|
86
|
+
[🏘DL-rank-img]: https://img.shields.io/gem/rt/oauth.svg
|
|
87
|
+
[🚎src-home]: https://github.com/oauth-xx/oauth-ruby
|
|
88
|
+
[🚎src-home-img]: https://img.shields.io/badge/source-github-brightgreen.svg?style=flat
|
|
89
|
+
[🖐prs-o]: https://github.com/oauth-xx/oauth-ruby/pulls
|
|
90
|
+
[🖐prs-o-img]: https://img.shields.io/github/issues-pr/oauth-xx/oauth-ruby
|
|
91
|
+
[🧮prs-c]: https://github.com/oauth-xx/oauth-ruby/pulls?q=is%3Apr+is%3Aclosed
|
|
92
|
+
[🧮prs-c-img]: https://img.shields.io/github/issues-pr-closed/oauth-xx/oauth-ruby
|
|
93
|
+
[📗next]: https://github.com/oauth-xx/oauth-ruby/milestone/1
|
|
94
|
+
[📗next-img]: https://img.shields.io/github/milestones/progress/oauth-xx/oauth-ruby/1?label=Next%20Version
|
|
95
|
+
|
|
96
|
+
<!-- 3️⃣ maintanence & linting -->
|
|
97
|
+
[⛳cclim-maint]: https://codeclimate.com/github/oauth-xx/oauth-ruby/maintainability
|
|
98
|
+
[⛳cclim-maint-img♻️]: https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/maintainability
|
|
99
|
+
[🖇triage-help]: https://www.codetriage.com/oauth-xx/oauth-ruby
|
|
100
|
+
[🖇triage-help-img]: https://www.codetriage.com/oauth-xx/oauth-ruby/badges/users.svg
|
|
101
|
+
[🏘depfu♻️]: https://depfu.com/github/oauth-xx/oauth-ruby?project_id=22868
|
|
102
|
+
[🏘depfu-img♻️]: https://badges.depfu.com/badges/d570491bac0ad3b0b65deb3c82028327/count.svg
|
|
103
|
+
[🚎contributors]: https://github.com/oauth-xx/oauth-ruby/graphs/contributors
|
|
104
|
+
[🚎contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby
|
|
105
|
+
[🖐style-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/style.yml
|
|
106
|
+
[🖐style-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/style.yml/badge.svg
|
|
107
|
+
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
108
|
+
[🧮kloc-img]: https://img.shields.io/tokei/lines/github.com/oauth-xx/oauth-ruby
|
|
109
|
+
|
|
110
|
+
<!-- 4️⃣ testing -->
|
|
111
|
+
[⛳iss-o]: https://github.com/oauth-xx/oauth-ruby/issues
|
|
112
|
+
[⛳iss-o-img]: https://img.shields.io/github/issues-raw/oauth-xx/oauth-ruby
|
|
113
|
+
[🖇iss-c]: https://github.com/oauth-xx/oauth-ruby/issues?q=is%3Aissue+is%3Aclosed
|
|
114
|
+
[🖇iss-c-img]: https://img.shields.io/github/issues-closed-raw/oauth-xx/oauth-ruby
|
|
115
|
+
[🏘sup-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/supported.yml
|
|
116
|
+
[🏘sup-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/supported.yml/badge.svg
|
|
117
|
+
[🚎heads-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/heads.yml
|
|
118
|
+
[🚎heads-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/heads.yml/badge.svg
|
|
119
|
+
[🖐uns-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/unsupported.yml
|
|
120
|
+
[🖐uns-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/unsupported.yml/badge.svg
|
|
121
|
+
[🧮mac-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/macos.yml
|
|
122
|
+
[🧮mac-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/macos.yml/badge.svg
|
|
123
|
+
[📗win-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/windows.yml
|
|
124
|
+
[📗win-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/windows.yml/badge.svg
|
|
125
|
+
|
|
126
|
+
<!-- 5️⃣ coverage & security -->
|
|
127
|
+
[⛳cclim-cov]: https://codeclimate.com/github/oauth-xx/oauth-ruby/test_coverage
|
|
128
|
+
[⛳cclim-cov-img♻️]: https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/test_coverage
|
|
129
|
+
[🖇codecov-img♻️]: https://codecov.io/gh/oauth-xx/oauth-ruby/branch/main/graph/badge.svg?token=4ZNAWNxrf9
|
|
130
|
+
[🖇codecov]: https://codecov.io/gh/oauth-xx/oauth-ruby
|
|
131
|
+
[🏘coveralls]: https://coveralls.io/github/oauth-xx/oauth-ruby?branch=main
|
|
132
|
+
[🏘coveralls-img]: https://coveralls.io/repos/github/oauth-xx/oauth-ruby/badge.svg?branch=main
|
|
133
|
+
[🚎sec-pol]: https://github.com/oauth-xx/oauth-ruby/blob/main/SECURITY.md
|
|
134
|
+
[🚎sec-pol-img]: https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat
|
|
135
|
+
[🖐codeQL]: https://github.com/oauth-xx/oauth-ruby/security/code-scanning
|
|
136
|
+
[🖐codeQL-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/codeql-analysis.yml/badge.svg
|
|
137
|
+
[🧮cov-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/coverage.yml
|
|
138
|
+
[🧮cov-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/coverage.yml/badge.svg
|
|
139
|
+
|
|
140
|
+
<!-- 6️⃣ resources -->
|
|
141
|
+
[⛳gh-discussions]: https://github.com/oauth-xx/oauth-ruby/discussions
|
|
142
|
+
[⛳gh-discussions-img]: https://img.shields.io/github/discussions/oauth-xx/oauth-ruby
|
|
143
|
+
[🖇codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
144
|
+
[🖇codementor-img]: https://cdn.codementor.io/badges/get_help_github.svg
|
|
145
|
+
[🏘chat]: https://gitter.im/oauth-xx/oauth-ruby
|
|
146
|
+
[🏘chat-img]: https://img.shields.io/gitter/room/oauth-xx/oauth-ruby.svg
|
|
147
|
+
[🚎blog]: http://www.railsbling.com/tags/oauth-ruby/
|
|
148
|
+
[🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
|
|
149
|
+
[🖐wiki]: https://github.com/oauth-xx/oauth-ruby/wiki
|
|
150
|
+
[🖐wiki-img]: https://img.shields.io/badge/wiki-examples-brightgreen.svg?style=flat
|
|
151
|
+
|
|
152
|
+
<!-- 7️⃣ spread 💖 -->
|
|
153
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
|
|
154
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
155
|
+
[🖇sponsor-img]: https://img.shields.io/badge/sponsor-pboling.svg?style=social&logo=github
|
|
156
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
157
|
+
[🏘tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
|
|
158
|
+
[🏘tweet]: http://twitter.com/galtzo
|
|
159
|
+
|
|
160
|
+
<!-- Maintainer Contact Links -->
|
|
161
|
+
[railsbling]: http://www.railsbling.com
|
|
162
|
+
[peterboling]: http://www.peterboling.com
|
|
18
163
|
|
|
19
|
-
##
|
|
164
|
+
## Installation
|
|
20
165
|
|
|
21
|
-
|
|
22
|
-
applications.
|
|
166
|
+
Install the gem and add to the application's Gemfile by executing:
|
|
23
167
|
|
|
24
|
-
|
|
168
|
+
$ bundle add oauth
|
|
25
169
|
|
|
26
|
-
|
|
170
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
27
171
|
|
|
28
|
-
|
|
172
|
+
$ gem install oauth
|
|
29
173
|
|
|
30
|
-
|
|
174
|
+
## OAuth for Enterprise
|
|
31
175
|
|
|
32
|
-
|
|
33
|
-
gem "oauth"
|
|
34
|
-
```
|
|
176
|
+
Available as part of the Tidelift Subscription.
|
|
35
177
|
|
|
36
|
-
|
|
178
|
+
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)
|
|
37
179
|
|
|
38
|
-
|
|
180
|
+
## Security contact information [![Security Policy][🚎sec-pol-img]][🚎sec-pol]
|
|
39
181
|
|
|
40
|
-
|
|
182
|
+
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
|
|
183
|
+
Tidelift will coordinate the fix and disclosure.
|
|
41
184
|
|
|
42
|
-
|
|
185
|
+
For more see [SECURITY.md][🚎sec-pol].
|
|
43
186
|
|
|
44
187
|
## Compatibility
|
|
45
188
|
|
|
46
189
|
Targeted ruby compatibility is non-EOL versions of Ruby, currently 2.7, 3.0, and
|
|
47
|
-
3.1. Ruby is limited to 2.0+ in the gemspec on this `v0.5-maintenance` branch
|
|
48
|
-
this will change with minor version bumps, while the gem is still in 0.x,
|
|
49
|
-
in accordance with the SemVer spec.
|
|
50
|
-
|
|
51
|
-
| | Ruby OAuth Version | Maintenance Branch | Supported Officially | Supported Unofficially | Supported Incidentally |
|
|
52
|
-
|:----|--------------------|--------------------|----------------------|------------------------------|------------------------|
|
|
53
|
-
| 1️⃣ | 0.6.x (unreleased) | `master` | 2.7, 3.0, 3.1 | 2.5, 2.6 | 2.3, 2.4 |
|
|
54
|
-
| 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 |
|
|
55
|
-
| 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! | |
|
|
190
|
+
3.1. Ruby is limited to 2.0+ in the gemspec on this `v0.5-maintenance` branch.
|
|
56
191
|
|
|
57
|
-
The `
|
|
192
|
+
The `v0.6-maintenance` branch targets 0.6.x releases.
|
|
58
193
|
See `v0.5-maintenance` branch for older rubies.
|
|
59
194
|
|
|
60
|
-
NOTE:
|
|
195
|
+
NOTE: No further releases of the 0.5.x series are anticipated.
|
|
196
|
+
|
|
197
|
+
<details>
|
|
198
|
+
<summary>Ruby Engine Compatibility Policy</summary>
|
|
199
|
+
|
|
200
|
+
This gem is tested against MRI, and to a lesser extent, against JRuby, and Truffleruby.
|
|
201
|
+
Each of those has varying versions that target a specific version of MRI Ruby.
|
|
202
|
+
This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below.
|
|
203
|
+
If you would like to add support for additional engines,
|
|
204
|
+
first make sure Github Actions supports the engine,
|
|
205
|
+
then submit a PR to the correct maintenance branch as according to the table below.
|
|
206
|
+
</details>
|
|
207
|
+
|
|
208
|
+
<details>
|
|
209
|
+
<summary>Ruby Version Compatibility Policy</summary>
|
|
210
|
+
|
|
211
|
+
If something doesn't work on one of these interpreters, it's a bug.
|
|
212
|
+
|
|
213
|
+
This library may inadvertently work (or seem to work) on other Ruby
|
|
214
|
+
implementations, however support will only be provided for the versions listed
|
|
215
|
+
above.
|
|
216
|
+
|
|
217
|
+
If you would like this library to support another Ruby version, you may
|
|
218
|
+
volunteer to be a maintainer. Being a maintainer entails making sure all tests
|
|
219
|
+
run and pass on that implementation. When something breaks on your
|
|
220
|
+
implementation, you will be responsible for providing patches in a timely
|
|
221
|
+
fashion. If critical issues for a particular implementation exist at the time
|
|
222
|
+
of a major release, support for that Ruby version may be dropped.
|
|
223
|
+
</details>
|
|
224
|
+
|
|
225
|
+
| | Ruby OAuth Version | Maintenance Branch | 🚂 Compatibility | Official 💎 | Unofficial 💎 | Incidental 💎 |
|
|
226
|
+
|:----|--------------------|--------------------|------------------------|----------------------|-------------------------|---------------|
|
|
227
|
+
| 1️⃣ | 1.0.x | `main` | Rails 6, 7 | 2.7, 3.0, 3.1 | sorry, not sorry | nope |
|
|
228
|
+
| 2️⃣ | 0.6.x | `v0.6-maintenance` | Rails 5, 6, 7 | 2.7, 3.0, 3.1 | 2.5, 2.6 | 2.4 |
|
|
229
|
+
| 3️⃣ | 0.5.x | `v0.5-maintenance` | Rails 2, 3, 4, 5, 6, 7 | 2.7, 3.0, 3.1 | 2.2, 2.3, 2.4, 2.5, 2.6 | 2.0, 2.1 |
|
|
230
|
+
| 4️⃣ | older | N/A | | Best of luck to you! | Please upgrade! | noop |
|
|
231
|
+
|
|
232
|
+
NOTE: Support for version 0.5.x will end in April, 2023
|
|
233
|
+
NOTE: Once 1.0 is released, the 0.x series will only receive critical bug and security updates.
|
|
234
|
+
See [SECURITY.md][🚎sec-pol]
|
|
61
235
|
|
|
62
236
|
## Basics
|
|
63
237
|
|
|
@@ -65,16 +239,21 @@ This is a ruby library which is intended to be used in creating Ruby Consumer
|
|
|
65
239
|
and Service Provider applications. It is NOT a Rails plugin, but could easily
|
|
66
240
|
be used for the foundation for such a Rails plugin.
|
|
67
241
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
242
|
+
This gem was originally extracted from @pelle's [oauth-plugin](https://github.com/pelle/oauth-plugin)
|
|
243
|
+
gem. After extraction that gem was made to depend on this gem.
|
|
244
|
+
|
|
245
|
+
Unfortunately, this gem does have some Rails related bits that are
|
|
246
|
+
**optional** to load. You don't need Rails! The Rails bits may be pulled out
|
|
247
|
+
into a separate gem with the release of version 1.0 of this gem.
|
|
71
248
|
|
|
72
249
|
## Usage
|
|
73
250
|
|
|
74
|
-
We need to specify the oauth_callback url explicitly, otherwise it defaults to
|
|
251
|
+
We need to specify the `oauth_callback` url explicitly, otherwise it defaults to
|
|
75
252
|
"oob" (Out of Band)
|
|
76
253
|
|
|
77
|
-
|
|
254
|
+
```ruby
|
|
255
|
+
callback_url = "http://127.0.0.1:3000/oauth/callback"
|
|
256
|
+
```
|
|
78
257
|
|
|
79
258
|
Create a new `OAuth::Consumer` instance by passing it a configuration hash:
|
|
80
259
|
|
|
@@ -134,15 +313,16 @@ Made with [contributors-img][contrib-rocks].
|
|
|
134
313
|
This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations of this scheme should be reported as
|
|
135
314
|
bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be
|
|
136
315
|
immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new
|
|
137
|
-
major versions.
|
|
316
|
+
major versions. Compatibility with a major and minor versions of Ruby will only be changed with a major version bump.
|
|
138
317
|
|
|
139
318
|
As a result of this policy, you can (and should) specify a dependency on this gem using
|
|
140
|
-
the [Pessimistic Version Constraint][pvc] with two digits of precision.
|
|
319
|
+
the [Pessimistic Version Constraint][pvc] with two digits of precision once it hits a 1.0 release.
|
|
320
|
+
While on 0.x releases three digits of precision should be used.
|
|
141
321
|
|
|
142
322
|
For example:
|
|
143
323
|
|
|
144
324
|
```ruby
|
|
145
|
-
spec.add_dependency "oauth", "~> 0.5"
|
|
325
|
+
spec.add_dependency "oauth", "~> 0.5.10"
|
|
146
326
|
```
|
|
147
327
|
|
|
148
328
|
## License
|
|
@@ -160,8 +340,8 @@ Comments are welcome. Contact the [OAuth Ruby mailing list (Google Group)][maili
|
|
|
160
340
|
|
|
161
341
|
[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
|
|
162
342
|
|
|
163
|
-
[conduct]: https://github.com/oauth-xx/oauth-ruby/blob/
|
|
164
|
-
[contributing]: https://github.com/oauth-xx/oauth-ruby/blob/
|
|
343
|
+
[conduct]: https://github.com/oauth-xx/oauth-ruby/blob/main/CODE_OF_CONDUCT.md
|
|
344
|
+
[contributing]: https://github.com/oauth-xx/oauth-ruby/blob/main/CONTRIBUTING.md
|
|
165
345
|
[contributors]: https://github.com/oauth-xx/oauth-ruby/graphs/contributors
|
|
166
346
|
[mailinglist]: http://groups.google.com/group/oauth-ruby
|
|
167
347
|
[source]: https://github.com/oauth-xx/oauth-ruby/
|
|
@@ -183,12 +363,11 @@ Comments are welcome. Contact the [OAuth Ruby mailing list (Google Group)][maili
|
|
|
183
363
|
[followme-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
|
|
184
364
|
[gh_discussions]: https://github.com/oauth-xx/oauth-ruby/discussions
|
|
185
365
|
[gh_sponsors]: https://github.com/sponsors/pboling
|
|
186
|
-
[license]: https://github.com/oauth-xx/oauth-ruby/blob/
|
|
366
|
+
[license]: https://github.com/oauth-xx/oauth-ruby/blob/main/LICENSE
|
|
187
367
|
[license-ref]: https://opensource.org/licenses/MIT
|
|
188
368
|
[liberapay_donate]: https://liberapay.com/pboling/donate
|
|
189
|
-
[politicme]: https://nationalprogressiveparty.org
|
|
190
369
|
[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
191
370
|
[rubygems]: https://rubygems.org/gems/oauth
|
|
192
|
-
[security]: https://github.com/oauth-xx/oauth-ruby/blob/
|
|
371
|
+
[security]: https://github.com/oauth-xx/oauth-ruby/blob/main/SECURITY.md
|
|
193
372
|
[semver]: http://semver.org/
|
|
194
373
|
[tweetme]: http://twitter.com/galtzo
|
data/SECURITY.md
CHANGED
|
@@ -3,14 +3,20 @@
|
|
|
3
3
|
## Supported Versions
|
|
4
4
|
|
|
5
5
|
| Version | Supported |
|
|
6
|
-
|
|
7
|
-
| 0.7.x | :white_check_mark: |
|
|
6
|
+
|---------|--------------------|
|
|
8
7
|
| 0.6.x | :white_check_mark: |
|
|
9
8
|
| 0.5.x | :white_check_mark: |
|
|
10
9
|
| <= 0.5 | :x: |
|
|
11
10
|
|
|
11
|
+
NOTE: Support for version 0.5.x will end in April, 2023
|
|
12
|
+
|
|
12
13
|
## Reporting a Vulnerability
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
|
|
16
|
+
Tidelift will coordinate the fix and disclosure.
|
|
17
|
+
|
|
18
|
+
## OAuth for Enterprise
|
|
19
|
+
|
|
20
|
+
Available as part of the Tidelift Subscription.
|
|
15
21
|
|
|
16
|
-
[
|
|
22
|
+
The maintainers of oauth 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&utm_term=repo)
|
data/lib/oauth/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: oauth
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.5.
|
|
4
|
+
version: 0.5.12
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Pelle Braendgaard
|
|
@@ -13,25 +13,11 @@ authors:
|
|
|
13
13
|
- Matt Sanford
|
|
14
14
|
- Aaron Quint
|
|
15
15
|
- Peter Boling
|
|
16
|
-
autorequire:
|
|
16
|
+
autorequire:
|
|
17
17
|
bindir: bin
|
|
18
18
|
cert_chain: []
|
|
19
|
-
date: 2022-
|
|
19
|
+
date: 2022-08-23 00:00:00.000000000 Z
|
|
20
20
|
dependencies:
|
|
21
|
-
- !ruby/object:Gem::Dependency
|
|
22
|
-
name: actionpack
|
|
23
|
-
requirement: !ruby/object:Gem::Requirement
|
|
24
|
-
requirements:
|
|
25
|
-
- - ">="
|
|
26
|
-
- !ruby/object:Gem::Version
|
|
27
|
-
version: '5.0'
|
|
28
|
-
type: :development
|
|
29
|
-
prerelease: false
|
|
30
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
31
|
-
requirements:
|
|
32
|
-
- - ">="
|
|
33
|
-
- !ruby/object:Gem::Version
|
|
34
|
-
version: '5.0'
|
|
35
21
|
- !ruby/object:Gem::Dependency
|
|
36
22
|
name: curb
|
|
37
23
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -78,16 +64,16 @@ dependencies:
|
|
|
78
64
|
name: minitest
|
|
79
65
|
requirement: !ruby/object:Gem::Requirement
|
|
80
66
|
requirements:
|
|
81
|
-
- - "
|
|
67
|
+
- - "<"
|
|
82
68
|
- !ruby/object:Gem::Version
|
|
83
|
-
version: '
|
|
69
|
+
version: '5.16'
|
|
84
70
|
type: :development
|
|
85
71
|
prerelease: false
|
|
86
72
|
version_requirements: !ruby/object:Gem::Requirement
|
|
87
73
|
requirements:
|
|
88
|
-
- - "
|
|
74
|
+
- - "<"
|
|
89
75
|
- !ruby/object:Gem::Version
|
|
90
|
-
version: '
|
|
76
|
+
version: '5.16'
|
|
91
77
|
- !ruby/object:Gem::Dependency
|
|
92
78
|
name: mocha
|
|
93
79
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -106,16 +92,16 @@ dependencies:
|
|
|
106
92
|
name: rack
|
|
107
93
|
requirement: !ruby/object:Gem::Requirement
|
|
108
94
|
requirements:
|
|
109
|
-
- - "
|
|
95
|
+
- - ">="
|
|
110
96
|
- !ruby/object:Gem::Version
|
|
111
|
-
version: '
|
|
97
|
+
version: '0'
|
|
112
98
|
type: :development
|
|
113
99
|
prerelease: false
|
|
114
100
|
version_requirements: !ruby/object:Gem::Requirement
|
|
115
101
|
requirements:
|
|
116
|
-
- - "
|
|
102
|
+
- - ">="
|
|
117
103
|
- !ruby/object:Gem::Version
|
|
118
|
-
version: '
|
|
104
|
+
version: '0'
|
|
119
105
|
- !ruby/object:Gem::Dependency
|
|
120
106
|
name: rack-test
|
|
121
107
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -134,16 +120,16 @@ dependencies:
|
|
|
134
120
|
name: rake
|
|
135
121
|
requirement: !ruby/object:Gem::Requirement
|
|
136
122
|
requirements:
|
|
137
|
-
- - "
|
|
123
|
+
- - ">="
|
|
138
124
|
- !ruby/object:Gem::Version
|
|
139
|
-
version: '
|
|
125
|
+
version: '0'
|
|
140
126
|
type: :development
|
|
141
127
|
prerelease: false
|
|
142
128
|
version_requirements: !ruby/object:Gem::Requirement
|
|
143
129
|
requirements:
|
|
144
|
-
- - "
|
|
130
|
+
- - ">="
|
|
145
131
|
- !ruby/object:Gem::Version
|
|
146
|
-
version: '
|
|
132
|
+
version: '0'
|
|
147
133
|
- !ruby/object:Gem::Dependency
|
|
148
134
|
name: rest-client
|
|
149
135
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -158,6 +144,20 @@ dependencies:
|
|
|
158
144
|
- - ">="
|
|
159
145
|
- !ruby/object:Gem::Version
|
|
160
146
|
version: '0'
|
|
147
|
+
- !ruby/object:Gem::Dependency
|
|
148
|
+
name: rubocop-lts
|
|
149
|
+
requirement: !ruby/object:Gem::Requirement
|
|
150
|
+
requirements:
|
|
151
|
+
- - "~>"
|
|
152
|
+
- !ruby/object:Gem::Version
|
|
153
|
+
version: '4.0'
|
|
154
|
+
type: :development
|
|
155
|
+
prerelease: false
|
|
156
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
157
|
+
requirements:
|
|
158
|
+
- - "~>"
|
|
159
|
+
- !ruby/object:Gem::Version
|
|
160
|
+
version: '4.0'
|
|
161
161
|
- !ruby/object:Gem::Dependency
|
|
162
162
|
name: typhoeus
|
|
163
163
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -186,7 +186,7 @@ dependencies:
|
|
|
186
186
|
- - "<="
|
|
187
187
|
- !ruby/object:Gem::Version
|
|
188
188
|
version: 3.14.0
|
|
189
|
-
description:
|
|
189
|
+
description:
|
|
190
190
|
email: oauth-ruby@googlegroups.com
|
|
191
191
|
executables:
|
|
192
192
|
- oauth
|
|
@@ -253,13 +253,40 @@ homepage: https://github.com/oauth-xx/oauth-ruby
|
|
|
253
253
|
licenses:
|
|
254
254
|
- MIT
|
|
255
255
|
metadata:
|
|
256
|
-
bug_tracker_uri: https://github.com/oauth-xx/oauth-ruby/issues
|
|
257
|
-
changelog_uri: https://github.com/oauth-xx/oauth-ruby/blob/master/CHANGELOG.md
|
|
258
|
-
documentation_uri: https://rubydoc.info/github/oauth-xx/oauth-ruby/master
|
|
259
256
|
homepage_uri: https://github.com/oauth-xx/oauth-ruby
|
|
260
|
-
source_code_uri: https://github.com/oauth-xx/oauth-ruby
|
|
257
|
+
source_code_uri: https://github.com/oauth-xx/oauth-ruby/tree/v0.5.12
|
|
258
|
+
changelog_uri: https://github.com/oauth-xx/oauth-ruby/blob/v0.5.12/CHANGELOG.md
|
|
259
|
+
bug_tracker_uri: https://github.com/oauth-xx/oauth-ruby/issues
|
|
260
|
+
documentation_uri: https://www.rubydoc.info/gems/oauth/0.5.12
|
|
261
|
+
wiki_uri: https://github.com/oauth-xx/oauth-ruby/wiki
|
|
261
262
|
rubygems_mfa_required: 'true'
|
|
262
|
-
post_install_message:
|
|
263
|
+
post_install_message: |2+
|
|
264
|
+
|
|
265
|
+
You have installed oauth version 0.5.12, congratulations!
|
|
266
|
+
|
|
267
|
+
Support for the 0.5.x series will end in April, 2023. Please upgrade to 0.6.x as soon as possible!
|
|
268
|
+
The only breaking change will be dropped support for Ruby 2.0, 2.1, 2.2, and 2.3.
|
|
269
|
+
|
|
270
|
+
Please see:
|
|
271
|
+
• https://github.com/oauth-xx/oauth/blob/main/SECURITY.md
|
|
272
|
+
|
|
273
|
+
Note also that I, and this project, am in the process of leaving Github.
|
|
274
|
+
I wrote about some of the reasons here:
|
|
275
|
+
• https://dev.to/galtzo/im-leaving-github-50ba
|
|
276
|
+
|
|
277
|
+
If you are a human, please consider a donation as I move toward supporting myself with Open Source work:
|
|
278
|
+
• https://liberapay.com/pboling
|
|
279
|
+
• https://ko-fi.com/pboling
|
|
280
|
+
• https://patreon.com/galtzo
|
|
281
|
+
|
|
282
|
+
If you are a corporation, please consider supporting this project, and open source work generally, with a TideLift subscription.
|
|
283
|
+
• https://tidelift.com/funding/github/rubygems/oauth
|
|
284
|
+
• Or hire me. I am looking for a job!
|
|
285
|
+
|
|
286
|
+
Please report issues, and support the project!
|
|
287
|
+
|
|
288
|
+
Thanks, |7eter l-|. l3oling
|
|
289
|
+
|
|
263
290
|
rdoc_options: []
|
|
264
291
|
require_paths:
|
|
265
292
|
- lib
|
|
@@ -274,8 +301,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
274
301
|
- !ruby/object:Gem::Version
|
|
275
302
|
version: '0'
|
|
276
303
|
requirements: []
|
|
277
|
-
rubygems_version: 3.
|
|
278
|
-
signing_key:
|
|
304
|
+
rubygems_version: 3.3.20
|
|
305
|
+
signing_key:
|
|
279
306
|
specification_version: 4
|
|
280
307
|
summary: OAuth Core Ruby implementation
|
|
281
308
|
test_files: []
|
|
309
|
+
...
|