🔀 Merge pull request #4 from oauth-xx/release/v2.0.2

Release/v2.0.2
oauth-xx · Sep 25, 2024 · 4fe309e · 4fe309e
2 parents 540baf3 + fa2080d
commit 4fe309e
Show file tree

Hide file tree

Showing 9 changed files with 128 additions and 60 deletions.
diff --git a/.envrc b/.envrc
@@ -1,3 +1,19 @@
+# Run any command in this library's bin/ without the bin/ prefix!
+PATH_add bin
+
+# Only add things to this file that should be shared with the team.
+
+# **dotenv** (See end of file for .env.local integration)
+# .env would override anything in this file, if enabled.
+# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments.
+# Override and customize anything below in your own .env.local
+# If you are using dotenv and not direnv,
+#   copy the following `export` statements to your own .env file.
+
+### General Ruby ###
+# Turn off Ruby Warnings about deprecated code
+# export RUBYOPT="-W0"
+
 ### External Testing Controls
 export K_SOUP_COV_DO=true # Means you want code coverage
 # Available formats are html, xml, rcov, lcov, json, tty
@@ -7,5 +23,15 @@ export K_SOUP_COV_MIN_BRANCH=23 # Means you want to enforce X% branch coverage
 export K_SOUP_COV_MIN_LINE=55 # Means you want to enforce X% line coverage
 export K_SOUP_COV_MIN_HARD=true # Means you want the build to fail if the coverage thresholds are not met
 export K_SOUP_COV_MULTI_FORMATTERS=true
-export MAX_ROWS=5 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage
-export DEBUG=true # allow byebug statements
+export MAX_ROWS=1 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage
+
+# Internal Debugging Controls
+export DEBUG=false # do not allow byebug statements (override in .env.local)
+
+# .env would override anything in this file, if `dotenv` is uncommented below.
+# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments,
+#   and that is why we generally want to leave it commented out.
+# dotenv
+
+# .env.local will override anything in this file.
+dotenv_if_exists .env.local
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,5 @@
 /doc/
 /.bundle/
 /.yardoc/
+
+.env.*
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,17 +10,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Removed
 
+## 2.0.2 - 2024-09-25
+- COVERAGE:  55.56% -- 55/99 lines in 6 files
+- BRANCH COVERAGE:  23.53% -- 4/17 branches in 6 files
+- 25.00% documented
+### Added
+- More Documentation
+### Fixed
+- Incorrect Documentation
+- Markdown Formatting
+### Changed
+- Renamed gem back to original `open_id_authentication`
+
 ## 2.0.1 - 2024-09-16 (returned to `open_id_authentication`)
-COVERAGE:  55.56% -- 55/99 lines in 6 files
-BRANCH COVERAGE:  23.53% -- 4/17 branches in 6 branches
+- COVERAGE:  55.56% -- 55/99 lines in 6 files
+- BRANCH COVERAGE:  23.53% -- 4/17 branches in 6 branches
 ### Added
 - More Documentation
 ### Changed
 - Renamed gem back to original `open_id_authentication`
 
 ## 2.0.0 - 2024-09-05 (released as `open_id_authentication2`)
-COVERAGE:  55.56% -- 55/99 lines in 6 files
-BRANCH COVERAGE:  23.53% -- 4/17 branches in 6 branches
+- COVERAGE:  55.56% -- 55/99 lines in 6 files
+- BRANCH COVERAGE:  23.53% -- 4/17 branches in 6 branches
 ### Added
 - More specs
 - version_gem runtime dependency

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    open_id_authentication (2.0.1)
-      rack-openid2 (~> 2.0, >= 2.0.1)
+    open_id_authentication (2.0.2)
+      rack-openid2 (~> 2.0, >= 2.0.2)
       version_gem (~> 1.1, >= 1.1.4)
 
 GEM
@@ -34,9 +34,9 @@ GEM
       racc
     racc (1.8.1)
     rack (3.1.7)
-    rack-openid2 (2.0.1)
+    rack-openid2 (2.0.2)
       rack (>= 2.2)
-      ruby-openid2 (>= 3.0)
+      ruby-openid2 (~> 3.1, >= 3.1.0)
       version_gem (~> 1.1, >= 1.1.4)
     rainbow (3.1.1)
     rake (13.2.1)
@@ -114,7 +114,7 @@ GEM
       rubocop (~> 1.51)
     rubocop-thread_safety (0.5.1)
       rubocop (>= 0.90.0)
-    ruby-openid2 (3.0.0)
+    ruby-openid2 (3.1.0)
       version_gem (~> 1.1, >= 1.1.4)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
@@ -124,7 +124,7 @@ GEM
     simplecov-cobertura (2.1.0)
       rexml
       simplecov (~> 0.19)
-    simplecov-console (0.9.1)
+    simplecov-console (0.9.2)
       ansi
       simplecov
       terminal-table

diff --git a/README.md b/README.md
@@ -1,9 +1,5 @@
 # OpenIdAuthentication
 
-<div id="badges">
-
-<div align="center">
-
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 [![Version](https://img.shields.io/gem/v/gem_bench.svg)](https://rubygems.org/gems/open_id_authentication)
 [![Downloads Today](https://img.shields.io/gem/rd/gem_bench.svg)](https://github.com/oauth-xx/open_id_authentication)
@@ -15,6 +11,14 @@
 [![CI Coverage Build][🚎cov-wfi]][🚎cov-wf]
 [![CI Heads Build][🚎hd-wfi]][🚎hd-wf]
 
+-----
+
+[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
+[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
+[![Polar Shield][🖇polar-img]][🖇polar]
+[![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
+[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
+
 [🚎s-wf]: https://github.com/oauth-xx/open_id_authentication/actions/workflows/supported.yml
 [🚎s-wfi]: https://github.com/oauth-xx/open_id_authentication/actions/workflows/supported.yml/badge.svg
 [🚎us-wf]: https://github.com/oauth-xx/open_id_authentication/actions/workflows/unsupported.yml
@@ -26,18 +30,6 @@
 [🚎hd-wf]: https://github.com/oauth-xx/open_id_authentication/actions/workflows/heads.yml
 [🚎hd-wfi]: https://github.com/oauth-xx/open_id_authentication/actions/workflows/heads.yml/badge.svg
 
-</div>
-
------
-
-<div align="center">
-
-[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
-[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
-[![Polar Shield][🖇polar-img]][🖇polar]
-[![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
-[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
-
 [⛳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_Me!-pboling.svg?style=social&logo=github
@@ -49,13 +41,6 @@
 [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-yellow.svg
 [🖇patreon]: https://patreon.com/galtzo
 
-<span class="badge-buymealatte">
-<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>
-</span>
-
-</div>
-</div>
-
 Provides a thin wrapper around [`ruby-openid2`](https://github.com/oauth-xx/ruby-openid2), a modernized fork of the
 ancient-and-archived `ruby-openid` gem from JanRan.
 
@@ -216,7 +201,6 @@ you can collapse the case into a mere boolean:
       end
     end
 
-
 ## Simple Registration OpenID Extension
 
 Some OpenID Providers support this lightweight profile exchange protocol.  See more: http://www.openidenabled.com/openid/simple-registration-extension
@@ -282,6 +266,37 @@ Accessing AX data is very similar to the Simple Registration process, described
 
 This would provide the sreg data for :email via registration, and the AX data for http://schema.openid.net/birthDate via ax.
 
+## General Info
+
+| Primary Namespace | `OpenIdAuthentication`                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| code triage       | [![Open Source Helpers](https://www.codetriage.com/oauth-xx/open_id_authentication/badges/users.svg)](https://www.codetriage.com/oauth-xx/open_id_authentication)                                                                                                                                                                                                                                                                                                         |
+| documentation     | [on Github.com][homepage],  [on rubydoc.info][documentation]                                                                                                                                                                                                                                                                                                                                                                                             |
+| 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)                                                                                                                                                                                                                                                 |
+| `...` 💖          | [![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] |
+
+<!-- 7️⃣ spread 💖 -->
+[🐦tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow%20%40galtzo
+[🐦tweet]: http://twitter.com/galtzo
+[🚎blog]: http://www.railsbling.com/tags/open_id_authentication/
+[🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
+[🖇linkedin]: http://www.linkedin.com/in/peterboling
+[🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-blue?style=plastic&logo=linkedin
+[✌️wellfound]: https://angel.co/u/peter-boling
+[✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=plastic&logo=wellfound
+[💲crunchbase]: https://www.crunchbase.com/person/peter-boling
+[💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=plastic&logo=crunchbase
+[🐘ruby-mast]: https://ruby.social/@galtzo
+[🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=plastic&logo=mastodon&label=Ruby%20%40galtzo
+[🌳linktree]: https://linktr.ee/galtzo
+[🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=plastic&logo=linktree
+[documentation]: https://rubydoc.info/github/oauth-xx/open_id_authentication
+[homepage]: https://github.com/oauth-xx/open_id_authentication
+
+<!-- Maintainer Contact Links -->
+[aboutme]: https://about.me/peter.boling
+[coderme]: https://coderwall.com/Peter%20Boling
+
 ## Credits
 
 ### 🌈 Contributors
@@ -317,3 +332,16 @@ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright
 [📄license]: LICENSE.txt
 [📄license-ref]: https://opensource.org/licenses/MIT
 [📄license-img]: https://img.shields.io/badge/License-MIT-green.svg
+
+## 🤑 One more thing
+
+You made it to the bottom of the page!
+If you think maintaining this gem is more difficult than parsing a README,
+or if you think I've done a bang up job with this gem,
+please consider supporting my efforts via this link,
+or one of the others at the head.
+
+[![Buy me a latte][🖇buyme-img]][🖇buyme]
+
+[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
+[🖇buyme]: https://www.buymeacoffee.com/pboling
diff --git a/Rakefile b/Rakefile
@@ -40,4 +40,4 @@ rescue LoadError
   end
 end
 
-task default: %i[spec rubocop_gradual yard yard:junk]
+task default: %i[spec rubocop_gradual:autocorrect yard yard:junk]
diff --git a/certs/pboling.pem b/certs/pboling.pem
@@ -1,27 +1,27 @@
 -----BEGIN CERTIFICATE-----
 MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
 ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
-A2NvbTAeFw0yMzA5MjAxNzMwMjhaFw0yNDA5MTkxNzMwMjhaMEMxFTATBgNVBAMM
+A2NvbTAeFw0yNDA5MjAwODU4NDJaFw0yNTA5MjAwODU4NDJaMEMxFTATBgNVBAMM
 DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
-LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA+a9UvHo3
-84k96WgU5Kk5HB+cLZs/modjorsTfqY67MJF5nNvAoqcKTUBW4uG+Zpfnm3jaDO5
-GxhJEIZWfndYzycHT2KMVQ1uTP82ba8ZaKrPlPIafkbui3mdds47qsmqHiblKERg
-U532lkwfqHDlJwE7OBZQ59EwWWLynlT/yAUHpOBbqIuHKUxdpmBI+sIjrZcD1e05
-WmjkO6fwIdC5oM757aoPxIgXD587VOViH11Vkm2doskj4T8yONtwVHlcrrhJ9Bzd
-/zdp6vEn7GZQrABvpOlqwWxQ72ZnFhJe/RJZf6CXOPOh69Ai0QKYl2a1sYuCJKS3
-nsBnxXJINEEznjR7rZjNUmYD+CZqfjzgPqedRxTlASe7iA4w7xZOqMDzcuhNwcUQ
-tMEH6BTktxKP3jXZPXRfHCf6s+HRVb6vezAonTBVyydf5Xp5VwWkd6cwm+2BzHl5
-7kc/3lLxKMcsyEUprAsk8LdHohwZdC267l+RS++AP6Cz6x+nB3oGob19AgMBAAGj
-fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQCSSas60GqqMjt
-xR7LoY1gucEvtzAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAjrxsKObI
+rFQjBpzvVfqnT6JlF8/pkpgEEjFh7ex3zIerfuHzZvSrx+sRDGxQ8koWWG0Wjx8s
+wkBZ5dIqvl0g3sWP5asa28u/09opxkQTC1Ao77iYxcBcwoCe/Dpf1m4Q/m6oH0kL
+2AZVNJQL3UkqAcLS0tsj/s/jAKnVlsaZZE5gQiIIi8HtkvSsajtx+Cq2AxDvcWvV
+/CliD+pmzYkTjvjwGm8yeyFGGGgrisJMryiZdZlkTwrQSjCzudIKbLeuG8Se4JTD
+TAcT+rPubr27v1jwmtIjtiot3rf4nof7LHLb122a/0VR7cC7xPLnXw0Cq1BShvoq
+/GKRdSwMNinTOGkFTK1gKnjN+3iD4zyXU3XO3CXoTr+Ju8fXPN1x4tpOMgbv8dme
+WbcQMOH9ZjmA5w0bSVRL1c3NhRRpUzrKTNXBEvqOyWjUnintxWKj+cRXx+z+dUgI
+dL3kj68fcsiTgl75In3C485pnCMmq1eLuVoiy3jkLNOn2lHeLt9ZK63LAgMBAAGj
+fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRhfc+2UaVYd74p
+yJ1JclGiUYN8+jAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
 A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
-ggGBAMl9ifcw5p+PdvB7dCPoNKoVdp/2LbC9ztETHuYL2gUMJB6UoS3o9c/piSuR
-V3ZMQaijmNu6ms1bWAtJ66LjmYrVflJtf9yp31Kierr9LpisMSUx2qbMOHGa8d2Z
-vCUWPF8E9Cg0mP3GAyZ6qql8jDh/anUKeksPXqJvNxNPDu2DVYsa/IWdl96whzS4
-Bl7SwB1E7agps40UcshCSKaVDOU0M+XN6SrnJMElnBic+KSAkBkVFbzS0BE4ODZM
-BgE6nYzQ05qhuvbE+oGdACTlemNtDDWCh0uw+7x0q2PocGIDU5zsPn/WNTkCXPmB
-CHGvqDNWq4M7ncTKAaS2XExgyb7uPdq9fKiOW8nmH+zCiGzJXzBWwZlKf7L4Ht9E
-a3f0e5C+zvee9Z5Ng9ciyfav9/fcXgYt5MjoBv27THr5XfBhgOCIHSYW2tqJmWKi
-KuxrfYrN+9HvMdm+nZ6TypmKftHY3Gj+/uu+g8Icm/zrvTWAEE0mcJOkfrIoNPJb
-pF8dMA==
+ggGBAA4fLU2+mQ++jBhVM2IeyvQdw1nm+0thkH4Ldv8ZOBm5ZxCPGIMoYliDDzg4
+4JDFxZR1wR4sdrz/K5tWtEkN23SKzopwbNb1NIQRSLQ7nOoc+4bkuz9xwKinmIvF
+D+5qsl2S27WLKFreMDtGoh0CREIMBUxU4rGTh0gtzmweGR+fnOShg4Jo0kxrjU5h
+uYk/uVE+bn/jOEGs43GvKXZLyshpBrZjQ+ArbvxDht5t35zbSxerbUxUPZUbXUCW
+tTyh38a9UYjAAHvnh6Y4Fi9wd4/pGNsektrzB3z/zlVj4YF2TMLX9XfNJWEGRGpO
+sSkLYdtEX1WQAmuZtActVW2cL3HdQaRbiv7VbfpA0eSk0ZdZHvBCl516ZZu10uX6
+82W1mg6fuezdpeBOiXwrEbZSt/oGiF4V511F6nd55p0okwHc/6nS10F/3aKJ4gwC
+I5o+DRfXQHqKucx1ldFHvI2rE/kSCWqGTHN2eyu1sqCPeOoIMxrltJhaejKPkxqj
+zaF9Og==
 -----END CERTIFICATE-----
diff --git a/lib/open_id_authentication/version.rb b/lib/open_id_authentication/version.rb
@@ -1,5 +1,5 @@
 module OpenIdAuthentication
   module Version
-    VERSION = "2.0.1"
+    VERSION = "2.0.2"
   end
 end
diff --git a/open_id_authentication.gemspec b/open_id_authentication.gemspec
@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.metadata["funding_uri"] = "https://liberapay.com/pboling"
   spec.metadata["rubygems_mfa_required"] = "true"
 
-  spec.add_dependency("rack-openid2", "~> 2.0", ">= 2.0.1")
+  spec.add_dependency("rack-openid2", "~> 2.0", ">= 2.0.2")
   spec.add_dependency("version_gem", "~> 1.1", ">= 1.1.4")
 
   # Coverage