Skip to content

Commit b18967d

Browse files
pbolingpboling
committed
📝 Update docs site
1 parent 461107b commit b18967d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+485
-240
lines changed

‎README.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[🖼️oauth-i]: https://logos.galtzo.com/assets/images/oauth/avatar-192px.svg
88
[🖼️oauth]: https://github.com/ruby-oauth/oauth
99

10-
# 🔑 Ruby OAuth
10+
# 🔑 Ruby OAuth 1.0 / 1.0a
1111

1212
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Unsupported][🚎7-us-wfi]][🚎7-us-wf] [![CI Ancient][🚎1-an-wfi]][🚎1-an-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
1313

@@ -22,10 +22,13 @@
2222
## 🌻 Synopsis
2323

2424
OAuth 1.0a is an industry-standard protocol for authorization.
25+
It is an update to the original OAuth 1.0 protocol, and is used by many popular services.
2526

26-
This is a RubyGem for implementing both OAuth 1.0a clients and servers in Ruby applications.
27+
This is a RubyGem for implementing OAuth 1.0 or 1.0a _clients_ and _servers_ in Ruby applications.
2728
See the sibling `oauth2` gem for OAuth 2.0, 2.1, & OIDC clients in Ruby.
2829

30+
All dependencies of this gem are signed, so it can be installed with a `HighSecurity` profile.
31+
2932
* [OAuth 1.0 Spec][oauth1-spec]
3033
* [oauth2 sibling gem][sibling-gem] for OAuth 2.0 implementations in Ruby.
3134

@@ -35,7 +38,7 @@ See the sibling `oauth2` gem for OAuth 2.0, 2.1, & OIDC clients in Ruby.
3538
## OAuth 1.0 vs 1.0a: What this library implements
3639

3740
This gem targets the OAuth 1.0a behavior (the errata that became RFC 5849), while maintaining compatibility with providers that still behave like classic 1.0.
38-
Here are the key lines between the two and how this gem handles them:
41+
Here are the key differences between the two and how this gem handles them:
3942

4043
- oauth_callback
4144
- 1.0: Optional in practice; some providers accepted flows without it.
@@ -56,7 +59,7 @@ Practical guidance:
5659

5760
References: [RFC 5849 (OAuth 1.0)](https://datatracker.ietf.org/doc/html/rfc5849), sections 5–7; [1.0a security errata](https://oauth.net/core/1.0a/).
5861

59-
OAuth Ruby has been maintained by a large number of talented
62+
Ruby OAuth has been maintained by a large number of talented
6063
individuals over the years.
6164
The primary maintainer since 2020 is Peter Boling (@pboling).
6265

@@ -87,7 +90,7 @@ Compatible with MRI Ruby 2.3+, and concordant releases of JRuby, and TruffleRuby
8790
### Federated DVCS
8891

8992
<details>
90-
<summary>Find this repo on federated forges (Coming soon!)</summary>
93+
<summary>Find this repo on federated forges</summary>
9194

9295
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
9396
|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|

‎docs/ActionController.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h2>Defined Under Namespace</h2>
105105
</div>
106106

107107
<div id="footer">
108-
Generated on Mon Sep 15 00:31:56 2025 by
108+
Generated on Sat Sep 20 17:50:29 2025 by
109109
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
110110
0.9.37 (ruby-3.4.5).
111111
</div>

‎docs/ActionController/Base.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ <h3 class="signature " id="process_with_oauth-instance_method">
238238
</div>
239239

240240
<div id="footer">
241-
Generated on Mon Sep 15 00:31:57 2025 by
241+
Generated on Sat Sep 20 17:50:29 2025 by
242242
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
243243
0.9.37 (ruby-3.4.5).
244244
</div>

‎docs/ActionController/TestRequest.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ <h3 class="signature " id="set_oauth_query_string-instance_method">
613613
</div>
614614

615615
<div id="footer">
616-
Generated on Mon Sep 15 00:31:57 2025 by
616+
Generated on Sat Sep 20 17:50:29 2025 by
617617
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
618618
0.9.37 (ruby-3.4.5).
619619
</div>

‎docs/EventMachine.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
116116
</div>
117117

118118
<div id="footer">
119-
Generated on Mon Sep 15 00:31:56 2025 by
119+
Generated on Sat Sep 20 17:50:29 2025 by
120120
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
121121
0.9.37 (ruby-3.4.5).
122122
</div>

‎docs/EventMachine/HttpClient.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ <h3 class="signature " id="signature_base_string-instance_method">
484484
</div>
485485

486486
<div id="footer">
487-
Generated on Mon Sep 15 00:31:57 2025 by
487+
Generated on Sat Sep 20 17:50:29 2025 by
488488
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
489489
0.9.37 (ruby-3.4.5).
490490
</div>

‎docs/Net.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h2>Defined Under Namespace</h2>
105105
</div>
106106

107107
<div id="footer">
108-
Generated on Mon Sep 15 00:31:56 2025 by
108+
Generated on Sat Sep 20 17:50:29 2025 by
109109
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
110110
0.9.37 (ruby-3.4.5).
111111
</div>

‎docs/Net/HTTPGenericRequest.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ <h3 class="signature " id="signature_base_string-instance_method">
397397
</div>
398398

399399
<div id="footer">
400-
Generated on Mon Sep 15 00:31:57 2025 by
400+
Generated on Sat Sep 20 17:50:29 2025 by
401401
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
402402
0.9.37 (ruby-3.4.5).
403403
</div>

‎docs/OAuth.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ <h2>
192192
</div>
193193

194194
<div id="footer">
195-
Generated on Mon Sep 15 00:31:56 2025 by
195+
Generated on Sat Sep 20 17:50:29 2025 by
196196
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
197197
0.9.37 (ruby-3.4.5).
198198
</div>

‎docs/OAuth/AccessToken.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ <h3 class="signature " id="request-instance_method">
681681
</div>
682682

683683
<div id="footer">
684-
Generated on Mon Sep 15 00:31:57 2025 by
684+
Generated on Sat Sep 20 17:50:29 2025 by
685685
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
686686
0.9.37 (ruby-3.4.5).
687687
</div>

0 commit comments

Comments
 (0)