Skip to content

Commit 89ad2de

Browse files
committed
✨ Badges & documentation
- Update dead JanRain / VitalConnectInc links - Add FUNDING.yml
1 parent 345c5b5 commit 89ad2de

File tree

7 files changed

+177
-49
lines changed

7 files changed

+177
-49
lines changed

.github/FUNDING.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
buy_me_a_coffee: pboling
4+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
5+
github: [pboling] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
6+
issuehunt: pboling # Replace with a single IssueHunt username
7+
ko_fi: pboling # Replace with a single Ko-fi username
8+
liberapay: pboling # Replace with a single Liberapay username
9+
open_collective: # Replace with a single Open Collective username
10+
patreon: galtzo # Replace with a single Patreon username
11+
polar: pboling
12+
thanks_dev: gh/pboling
13+
tidelift: rubygems/ruby-openid2 # Replace with a single Tidelift platform-name/package-name e.g., npm/babel

CHANGELOG.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2121
## 2.9.2
2222

2323
* Perform all checks before verifying endpoints.
24-
[#126](https://github.com/openid/ruby-openid/pull/126)
24+
[#126](https://github.com/oauth-xx/ruby-openid2/pull/126)
2525

2626
## 2.9.1
2727

@@ -30,62 +30,62 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3030
## 2.9.0
3131

3232
* Remove deprecated `autorequire` from gemspec.
33-
[#123](https://github.com/openid/ruby-openid/pull/123)
33+
[#123](https://github.com/oauth-xx/ruby-openid2/pull/123)
3434
* Rescue from `Yadis::XRI::XRIHTTPError` on discovery.
35-
[#106](https://github.com/openid/ruby-openid/pull/106)
35+
[#106](https://github.com/oauth-xx/ruby-openid2/pull/106)
3636
* Avoid SSRF for claimed_id request.
37-
[#121](https://github.com/openid/ruby-openid/pull/121)
37+
[#121](https://github.com/oauth-xx/ruby-openid2/pull/121)
3838
* Updated documentation.
39-
[#115](https://github.com/openid/ruby-openid/pull/115), [#116](https://github.com/openid/ruby-openid/pull/116), [#117](https://github.com/openid/ruby-openid/pull/117), [#118](https://github.com/openid/ruby-openid/pull/118)
39+
[#115](https://github.com/oauth-xx/ruby-openid2/pull/115), [#116](https://github.com/oauth-xx/ruby-openid2/pull/116), [#117](https://github.com/oauth-xx/ruby-openid2/pull/117), [#118](https://github.com/oauth-xx/ruby-openid2/pull/118)
4040
* Reduce warnings output in test runs.
41-
[#119](https://github.com/openid/ruby-openid/pull/119)
41+
[#119](https://github.com/oauth-xx/ruby-openid2/pull/119)
4242
* Drop deprecated option from gemspec.
43-
[#120](https://github.com/openid/ruby-openid/pull/120)
43+
[#120](https://github.com/oauth-xx/ruby-openid2/pull/120)
4444
* Remove circular require.
45-
[#113](https://github.com/openid/ruby-openid/pull/113)
45+
[#113](https://github.com/oauth-xx/ruby-openid2/pull/113)
4646
* Updated Travis CI config with Ruby 2.6
47-
[#114](https://github.com/openid/ruby-openid/pull/114)
47+
[#114](https://github.com/oauth-xx/ruby-openid2/pull/114)
4848
* Simplify Bundler require; remove need for extra `:require`.
49-
[#112](https://github.com/openid/ruby-openid/pull/112)
49+
[#112](https://github.com/oauth-xx/ruby-openid2/pull/112)
5050

5151
## 2.8.0
5252

5353
* Fix `admin/mkassoc` script.
54-
See https://github.com/openid/ruby-openid/pull/103
54+
See https://github.com/oauth-xx/ruby-openid2/pull/103
5555
* Allow specifying timeout for `OpenID::StandardFetcher` in environment variables.
56-
See https://github.com/openid/ruby-openid/pull/109
56+
See https://github.com/oauth-xx/ruby-openid2/pull/109
5757
* Fixed some documentation.
58-
See https://github.com/openid/ruby-openid/pull/111
58+
See https://github.com/oauth-xx/ruby-openid2/pull/111
5959
* Fixed example server.
60-
See https://github.com/openid/ruby-openid/pull/91
60+
See https://github.com/oauth-xx/ruby-openid2/pull/91
6161
* Fixed tests.
62-
See https://github.com/openid/ruby-openid/pull/86
62+
See https://github.com/oauth-xx/ruby-openid2/pull/86
6363
* Misc. changes to the CI setup.
6464
See
65-
- https://github.com/openid/ruby-openid/pull/110
66-
- https://github.com/openid/ruby-openid/pull/108
67-
- https://github.com/openid/ruby-openid/pull/107
65+
- https://github.com/oauth-xx/ruby-openid2/pull/110
66+
- https://github.com/oauth-xx/ruby-openid2/pull/108
67+
- https://github.com/oauth-xx/ruby-openid2/pull/107
6868

6969
## 2.7.0
7070

7171
* Use RFC 2396 compatible URI parser for trustroot - 7c84ec9ced3ccbdad575e02dbfa81e53b52f909e
72-
See https://github.com/openid/ruby-openid/pull/85
72+
See https://github.com/oauth-xx/ruby-openid2/pull/85
7373
* Use HMAC from OpenSSL rather than Digest - ce2e30d7ff3308f17ef7d8c19d6f4752f76c9c40
74-
See https://github.com/openid/ruby-openid/pull/84
74+
See https://github.com/oauth-xx/ruby-openid2/pull/84
7575
* Check if OpenSSL is loaded - 751e55820d958ee781f5abb466a576d83ddde6fd
7676

7777
## 2.6.0
7878

7979
* More safely build filenames - 1c4a90630b183e7572b8ab5f2e3a3e0c0fecd2c7
80-
See https://github.com/openid/ruby-openid/pull/80
80+
See https://github.com/oauth-xx/ruby-openid2/pull/80
8181
* The session serializer of Rails4.1 is json - b44a1eb511dec3be25a07930121bc80cacec0f1c
8282
* Handle boolean value to fix signature issue - d65076269b77754da7db6e4b189edeeb9201600d
83-
See https://github.com/openid/ruby-openid/pull/76
83+
See https://github.com/oauth-xx/ruby-openid2/pull/76
8484

8585
## 2.5.0
8686

8787
* Revert json serialization - 8dc60e553369df2300ebb4b83a29618aff643c2c
88-
See https://github.com/openid/ruby-openid/pull/73
88+
See https://github.com/oauth-xx/ruby-openid2/pull/73
8989

9090
## 2.4.0
9191

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Contributing
22

3-
Bug reports and pull requests are welcome on GitHub at [https://github.com/VitalConnectInc/ruby-openid2][🚎src-main]
3+
Bug reports and pull requests are welcome on GitHub at [https://github.com/oauth-xx/ruby-openid2][🚎src-main]
44
. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
55
the [code of conduct][🤝conduct].
66

@@ -44,12 +44,12 @@ See: [RubyGems Security Guide][🔒️rubygems-security-guide]
4444

4545
Made with [contributors-img][🖐contrib-rocks].
4646

47-
[🧪build]: https://github.com/VitalConnectInc/ruby-openid2/actions
48-
[🤝conduct]: https://github.com/VitalConnectInc/ruby-openid2/blob/main/CODE_OF_CONDUCT.md
47+
[🧪build]: https://github.com/oauth-xx/ruby-openid2/actions
48+
[🤝conduct]: https://github.com/oauth-xx/ruby-openid2/blob/main/CODE_OF_CONDUCT.md
4949
[🖐contrib-rocks]: https://contrib.rocks
50-
[🖐contributors]: https://github.com/VitalConnectInc/ruby-openid2/graphs/contributors
51-
[🖐contributors-img]: https://contrib.rocks/image?repo=VitalConnectInc/ruby-openid2
50+
[🖐contributors]: https://github.com/oauth-xx/ruby-openid2/graphs/contributors
51+
[🖐contributors-img]: https://contrib.rocks/image?repo=oauth-xx/ruby-openid2
5252
[💎rubygems]: https://rubygems.org
5353
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
5454
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/guides/pull/325
55-
[🚎src-main]: https://github.com/VitalConnectInc/ruby-openid2
55+
[🚎src-main]: https://github.com/oauth-xx/ruby-openid2

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ the terms of the Ruby license. See http://www.ruby-lang.org/en/LICENSE.txt
44
lib/openid/yadis/htmltokenizer.rb is Copyright 2004 by Ben Giddings and
55
distributed under the terms of the Ruby license.
66

7-
The remainder of this package is Copyright 2006-2008 by JanRain, Inc. and
7+
The remainder of this package is Copyright 2006-2012 by JanRain, Inc., 2024 Peter Boling and
88
distributed under the terms of license below:
99

1010
Apache License

NOTICE

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
This product includes software developed by JanRain,
2-
available from http://github.com/openid/ruby-openid
1+
This product includes software originally developed by JanRain,
2+
currently maintained by Peter Boling,
3+
available from http://github.com/oauth-xx/ruby-openid2

README.md

Lines changed: 129 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,51 @@
22

33
<div id="badges">
44

5+
[![Version](https://img.shields.io/gem/v/ruby-openid2.svg)](https://rubygems.org/gems/ruby-openid2)
6+
[![Downloads Today](https://img.shields.io/gem/rd/ruby-openid2.svg)](https://github.com/oauth-xx/ruby-openid2)
57
[![CI Supported Build][🚎s-wfi]][🚎s-wf]
68
[![CI Unsupported Build][🚎us-wfi]][🚎us-wf]
79
[![CI Style Build][🚎st-wfi]][🚎st-wf]
810
[![CI Coverage Build][🚎cov-wfi]][🚎cov-wf]
911
[![CI Heads Build][🚎hd-wfi]][🚎hd-wf]
1012

11-
[🚎s-wf]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/supported.yml
12-
[🚎s-wfi]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/supported.yml/badge.svg
13-
[🚎us-wf]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/unsupported.yml
14-
[🚎us-wfi]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/unsupported.yml/badge.svg
15-
[🚎st-wf]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/style.yml
16-
[🚎st-wfi]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/style.yml/badge.svg
17-
[🚎cov-wf]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/coverage.yml
18-
[🚎cov-wfi]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/coverage.yml/badge.svg
19-
[🚎hd-wf]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/heads.yml
20-
[🚎hd-wfi]: https://github.com/VitalConnectInc/ruby-openid2/actions/workflows/heads.yml/badge.svg
13+
[🚎s-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/supported.yml
14+
[🚎s-wfi]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/supported.yml/badge.svg
15+
[🚎us-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/unsupported.yml
16+
[🚎us-wfi]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/unsupported.yml/badge.svg
17+
[🚎st-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/style.yml
18+
[🚎st-wfi]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/style.yml/badge.svg
19+
[🚎cov-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/coverage.yml
20+
[🚎cov-wfi]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/coverage.yml/badge.svg
21+
[🚎hd-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/heads.yml
22+
[🚎hd-wfi]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/heads.yml/badge.svg
23+
24+
-----
25+
26+
<div align="center">
27+
28+
[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
29+
[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
30+
[![Polar Shield][🖇polar-img]][🖇polar]
31+
[![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
32+
[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
33+
34+
[⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
35+
[⛳liberapay]: https://liberapay.com/pboling/donate
36+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
37+
[🖇sponsor]: https://github.com/sponsors/pboling
38+
[🖇polar-img]: https://polar.sh/embed/seeks-funding-shield.svg?org=pboling
39+
[🖇polar]: https://polar.sh/pboling
40+
[🖇kofi-img]: https://img.shields.io/badge/buy%20me%20coffee-donate-yellow.svg
41+
[🖇kofi]: https://ko-fi.com/O5O86SNP4
42+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-yellow.svg
43+
[🖇patreon]: https://patreon.com/galtzo
44+
45+
<span class="badge-buymealatte">
46+
<a href="https://www.buymeacoffee.com/pboling"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff" /></a>
47+
</span>
2148

49+
</div>
2250
</div>
2351

2452
A Ruby library for verifying and serving OpenID identities.
@@ -37,6 +65,35 @@ A Ruby library for verifying and serving OpenID identities.
3765
* Comprehensive test suite
3866
* Supports both OpenID 1 and OpenID 2 transparently
3967

68+
| Project | GemBench |
69+
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
70+
| gem name | [ruby-openid2](https://rubygems.org/gems/ruby-openid2) |
71+
| code triage | [![Open Source Helpers](https://www.codetriage.com/oauth-xx/ruby-openid2/badges/users.svg)](https://www.codetriage.com/oauth-xx/ruby-openid2) |
72+
| documentation | [on Github.com][homepage], [on Rdoc.info][documentation] |
73+
| documentation | |
74+
| expert support | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
75+
| `...` 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Follow Me on LinkedIn][🖇linkedin-img]][🖇linkedin] [![Find Me on WellFound:][✌️wellfound-img]][✌️wellfound] [![Find Me on CrunchBase][💲crunchbase-img]][💲crunchbase] [![My LinkTree][🌳linktree-img]][🌳linktree] [![Follow Me on Ruby.Social][🐘ruby-mast-img]][🐘ruby-mast] [![Tweet @ Peter][🐦tweet-img]][🐦tweet] [💻][coderme] [🌏][aboutme] |
76+
77+
<!-- 7️⃣ spread 💖 -->
78+
[🐦tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow%20%40galtzo
79+
[🐦tweet]: http://twitter.com/galtzo
80+
[🚎blog]: http://www.railsbling.com/tags/ruby-openid2/
81+
[🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
82+
[🖇linkedin]: http://www.linkedin.com/in/peterboling
83+
[🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-blue?style=plastic&logo=linkedin
84+
[✌️wellfound]: https://angel.co/u/peter-boling
85+
[✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=plastic&logo=wellfound
86+
[💲crunchbase]: https://www.crunchbase.com/person/peter-boling
87+
[💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=plastic&logo=crunchbase
88+
[🐘ruby-mast]: https://ruby.social/@galtzo
89+
[🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=plastic&logo=mastodon&label=Ruby%20%40galtzo
90+
[🌳linktree]: https://linktr.ee/galtzo
91+
[🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=plastic&logo=linktree
92+
93+
<!-- Maintainer Contact Links -->
94+
[aboutme]: https://about.me/peter.boling
95+
[coderme]: https://coderwall.com/Peter%20Boling
96+
4097
## Installing
4198

4299
Before running the examples or writing your own code you'll need to install
@@ -74,7 +131,7 @@ the examples.
74131

75132
## Homepage
76133

77-
* GitHub repository: [openid/ruby-openid](http://github.com/openid/ruby-openid)
134+
* GitHub repository: [oauth-xx/ruby-openid2](http://github.com/oauth-xx/ruby-openid2)
78135
* Homepage: [OpenID.net](http://openid.net/)
79136

80137
## Community
@@ -86,14 +143,70 @@ Please join this list to discuss, ask implementation questions, report
86143
bugs, etc. Also check out the openid channel on the freenode IRC
87144
network.
88145

89-
If you have a bugfix or feature you'd like to contribute, don't
90-
hesitate to send it to us: [How to contribute](http://openidenabled.com/contribute/).
146+
## 🤝 Contributing
147+
148+
See [CONTRIBUTING.md][🤝contributing]
149+
150+
[🤝contributing]: CONTRIBUTING.md
151+
152+
## 🌈 Contributors
153+
154+
[![Contributors][🖐contributors-img]][🖐contributors]
155+
156+
Made with [contributors-img][🖐contrib-rocks].
157+
158+
[🖐contrib-rocks]: https://contrib.rocks
159+
[🖐contributors]: https://github.com/oauth-xx/ruby-openid2/graphs/contributors
160+
[🖐contributors-img]: https://contrib.rocks/image?repo=oauth-xx/ruby-openid2
161+
162+
## 🪇 Code of Conduct
163+
164+
Everyone interacting in this project's codebases, issue trackers,
165+
chat rooms and mailing lists is expected to follow the [code of conduct][🪇conduct].
166+
167+
[🪇conduct]: CODE_OF_CONDUCT.md
168+
169+
## 📌 Versioning
170+
171+
This Library adheres to [Semantic Versioning 2.0.0][📌semver].
172+
Violations of this scheme should be reported as bugs.
173+
Specifically, if a minor or patch version is released that breaks backward compatibility,
174+
a new version should be immediately released that restores compatibility.
175+
Breaking changes to the public API will only be introduced with new major versions.
176+
177+
To get a better understanding of how SemVer is intended to work over a project's lifetime,
178+
read this article from the creator of SemVer:
179+
180+
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
181+
182+
As a result of this policy, you can (and should) specify a dependency on these libraries using
183+
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
184+
185+
For example:
186+
187+
```ruby
188+
spec.add_dependency("ruby-openid2", "~> 3.0")
189+
```
190+
191+
See [CHANGELOG.md][📌changelog] for list of releases.
192+
193+
[comment]: <> ( 📌 VERSIONING LINKS )
194+
195+
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
196+
[📌semver]: http://semver.org/
197+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
198+
[📌changelog]: CHANGELOG.md
91199

92-
## Author
200+
### © Copyright
93201

94-
Copyright 2006-2012, JanRain, Inc.
202+
* Copyright (c) 2006-2012, JanRain, Inc.
203+
* Copyright (c) 2024 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
95204

96-
205+
[railsbling]: http://www.railsbling.com
206+
[peterboling]: http://www.peterboling.com
207+
[bundle-group-pattern]: https://gist.github.com/pboling/4564780
208+
[documentation]: http://rdoc.info/github/oauth-xx/ruby-openid2/frames
209+
[homepage]: https://github.com/oauth-xx/ruby-openid2
97210

98211
## License
99212

0 commit comments

Comments
 (0)