Skip to content

Commit a87fbc9

Browse files
pbolingpboling
authored
Merge pull request #5 from ruby-oauth/feat/update-docs
2 parents 045ae47 + 7904c95 commit a87fbc9

36 files changed

+7585
-11
lines changed

‎CHANGELOG.md‎

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,25 @@ Please file a bug if you notice a violation of semantic versioning.
2020

2121
### Added
2222

23+
### Changed
24+
25+
### Deprecated
26+
27+
### Removed
28+
29+
### Fixed
30+
31+
### Security
32+
33+
## [1.0.6] - 2025-09-21
34+
35+
- TAG: [v1.0.6][1.0.6t]
36+
- COVERAGE: 100.00% -- 296/296 lines in 10 files
37+
- BRANCH COVERAGE: 96.55% -- 28/29 branches in 10 files
38+
- 11.43% documented
39+
40+
### Added
41+
2342
- (dev) kettle-dev v1.1.16 (@pboling)
2443
- (docs) more documentation (@Aboling0, @pboling)
2544
- (docs) Deployed documentation site for HEAD (@Aboling0)
@@ -36,8 +55,6 @@ Please file a bug if you notice a violation of semantic versioning.
3655
- (test) migrated test suite to RSpec (@pboling)
3756
- (test) ignore Ruby warnings coming from other libs (@pboling)
3857

39-
### Deprecated
40-
4158
### Removed
4259

4360
- (test) minitest (@pboling)
@@ -48,8 +65,6 @@ Please file a bug if you notice a violation of semantic versioning.
4865
- Use Shellwords for proper tokenization
4966
- Verified options file loading and CLI flag precedence
5067

51-
### Security
52-
5368
## [1.0.5] - 2022-09-20
5469

5570
- TAG: [v1.0.5][1.0.5t]
@@ -109,7 +124,9 @@ Please file a bug if you notice a violation of semantic versioning.
109124

110125
- Initial release (@pboling)
111126

112-
[Unreleased]: https://gitlab.com/ruby-oauth/oauth-tty/-/compare/v1.0.5...main
127+
[Unreleased]: https://github.com/ruby-oauth/oauth-tty/compare/v1.0.6...HEAD
128+
[1.0.6]: https://github.com/ruby-oauth/oauth-tty/compare/v1.0.5...v1.0.6
129+
[1.0.6t]: https://github.com/ruby-oauth/oauth-tty/releases/tag/v1.0.6
113130
[1.0.5]: https://gitlab.com/ruby-oauth/oauth-tty/-/compare/v1.0.4...v1.0.5
114131
[1.0.5t]: https://gitlab.com/ruby-oauth/oauth-tty/-/releases/tag/v1.0.5
115132
[1.0.4]: https://gitlab.com/ruby-oauth/oauth-tty/-/compare/v1.0.3...v1.0.4

‎Gemfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ GIT
2323
PATH
2424
remote: .
2525
specs:
26-
oauth-tty (1.0.5)
26+
oauth-tty (1.0.6)
2727
version_gem (~> 1.1, >= 1.1.9)
2828

2929
GEM

‎README.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,12 @@
2424
OAuth 1.0a is an industry-standard protocol for authorization.
2525
It is an update to the original OAuth 1.0 protocol, and is used by many popular services.
2626

27-
This is a RubyGem for implementing OAuth 1.0 or 1.0a _clients_ and _servers_ in Ruby applications.
28-
See the sibling `oauth2` gem for OAuth 2.0, 2.1, & OIDC clients in Ruby.
27+
This RubyGem provides a CLI for OAuth 1.0 or 1.0a _clients_ and _servers_ in Ruby applications.
2928

3029
All dependencies of this gem are signed, so it can be installed with a `HighSecurity` profile.
3130

3231
* [OAuth 1.0 Spec][oauth1-spec]
33-
* [oauth gem][sibling-gem] for OAuth 1.0 / 1.0a client and server implementations in Ruby.
32+
* [oauth sibling gem][sibling-gem] for OAuth 1.0 / 1.0a client and server implementations in Ruby.
3433
* [oauth2 sibling gem][sibling2-gem] for OAuth 2.0 / 2.1, & OIDC client implementations in Ruby.
3534

3635
[oauth1-spec]: http://oauth.net/core/1.0/
@@ -449,14 +448,17 @@ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright
449448

450449
<ul>
451450
<li>
452-
Copyright (c) 2023, 2025 Peter H. Boling, of
451+
Copyright (c) 2021-2022, 2025 Peter H. Boling, of
453452
<a href="https://discord.gg/3qme4XHNKN">
454453
Galtzo.com
455454
<picture>
456455
<img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
457456
</picture>
458457
</a>, and oauth-tty contributors.
459458
</li>
459+
<li>
460+
2016-2017 Thiago Pinto
461+
</li>
460462
</ul>
461463

462464
## 🤑 A request for help

‎docs/OAuth.html‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Module: OAuth
8+
9+
&mdash; Documentation by YARD 0.9.37
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "OAuth";
19+
relpath = '';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="class_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="_index.html">Index (O)</a> &raquo;
40+
41+
42+
<span class="title">OAuth</span>
43+
44+
</div>
45+
46+
<div id="search">
47+
48+
<a class="full_list_link" id="class_list_link"
49+
href="class_list.html">
50+
51+
<svg width="24" height="24">
52+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55+
</svg>
56+
</a>
57+
58+
</div>
59+
<div class="clear"></div>
60+
</div>
61+
62+
<div id="content"><h1>Module: OAuth
63+
64+
65+
66+
</h1>
67+
<div class="box_info">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
<dl>
80+
<dt>Defined in:</dt>
81+
<dd>lib/oauth/tty.rb<span class="defines">,<br />
82+
lib/oauth/tty/cli.rb,<br /> lib/oauth/tty/command.rb,<br /> lib/oauth/tty/version.rb,<br /> lib/oauth/tty/commands/help_command.rb,<br /> lib/oauth/tty/commands/sign_command.rb,<br /> lib/oauth/tty/commands/query_command.rb,<br /> lib/oauth/tty/commands/version_command.rb,<br /> lib/oauth/tty/commands/authorize_command.rb</span>
83+
</dd>
84+
</dl>
85+
86+
</div>
87+
88+
<h2>Defined Under Namespace</h2>
89+
<p class="children">
90+
91+
92+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="OAuth/TTY.html" title="OAuth::TTY (module)">TTY</a></span>
93+
94+
95+
96+
97+
</p>
98+
99+
100+
<h2>
101+
Constant Summary
102+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
103+
</h2>
104+
105+
<dl class="constants">
106+
107+
<dt id="CLI-constant" class="">CLI =
108+
<div class="docstring">
109+
<div class="discussion">
110+
<p>Backwards compatibility hack.<br />
111+
TODO: Remove with April 2023 release of 2.0 release of oauth gem</p>
112+
113+
114+
</div>
115+
</div>
116+
<div class="tags">
117+
118+
119+
</div>
120+
</dt>
121+
<dd><pre class="code"><span class='const'>OAuth</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="OAuth/TTY.html" title="OAuth::TTY (module)">TTY</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="OAuth/TTY/CLI.html" title="OAuth::TTY::CLI (class)">CLI</a></span></span></pre></dd>
122+
123+
</dl>
124+
125+
126+
127+
128+
129+
130+
131+
132+
133+
134+
</div>
135+
136+
<div id="footer">
137+
Generated on Sun Sep 21 01:04:15 2025 by
138+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
139+
0.9.37 (ruby-3.4.5).
140+
</div>
141+
142+
</div>
143+
</body>
144+
</html>

‎docs/OAuth/TTY.html‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Module: OAuth::TTY
8+
9+
&mdash; Documentation by YARD 0.9.37
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "OAuth::TTY";
19+
relpath = '../';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="../class_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="../_index.html">Index (T)</a> &raquo;
40+
<span class='title'><span class='object_link'><a href="../OAuth.html" title="OAuth (module)">OAuth</a></span></span>
41+
&raquo;
42+
<span class="title">TTY</span>
43+
44+
</div>
45+
46+
<div id="search">
47+
48+
<a class="full_list_link" id="class_list_link"
49+
href="../class_list.html">
50+
51+
<svg width="24" height="24">
52+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55+
</svg>
56+
</a>
57+
58+
</div>
59+
<div class="clear"></div>
60+
</div>
61+
62+
<div id="content"><h1>Module: OAuth::TTY
63+
64+
65+
66+
</h1>
67+
<div class="box_info">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
<dl>
80+
<dt>Defined in:</dt>
81+
<dd>lib/oauth/tty.rb<span class="defines">,<br />
82+
lib/oauth/tty/cli.rb,<br /> lib/oauth/tty/command.rb,<br /> lib/oauth/tty/version.rb,<br /> lib/oauth/tty/commands/help_command.rb,<br /> lib/oauth/tty/commands/sign_command.rb,<br /> lib/oauth/tty/commands/query_command.rb,<br /> lib/oauth/tty/commands/version_command.rb,<br /> lib/oauth/tty/commands/authorize_command.rb</span>
83+
</dd>
84+
</dl>
85+
86+
</div>
87+
88+
<h2>Overview</h2><div class="docstring">
89+
<div class="discussion">
90+
<p>The namespace of this gem</p>
91+
92+
93+
</div>
94+
</div>
95+
<div class="tags">
96+
97+
98+
</div><h2>Defined Under Namespace</h2>
99+
<p class="children">
100+
101+
102+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="TTY/Commands.html" title="OAuth::TTY::Commands (module)">Commands</a></span>, <span class='object_link'><a href="TTY/Version.html" title="OAuth::TTY::Version (module)">Version</a></span>
103+
104+
105+
106+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="TTY/CLI.html" title="OAuth::TTY::CLI (class)">CLI</a></span>, <span class='object_link'><a href="TTY/Command.html" title="OAuth::TTY::Command (class)">Command</a></span>
107+
108+
109+
</p>
110+
111+
112+
113+
114+
115+
116+
117+
118+
119+
</div>
120+
121+
<div id="footer">
122+
Generated on Sun Sep 21 01:04:15 2025 by
123+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
124+
0.9.37 (ruby-3.4.5).
125+
</div>
126+
127+
</div>
128+
</body>
129+
</html>

0 commit comments

Comments
 (0)