oauth_im 0.4.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e28d71eba7b82be12370b581d9d18e1586c306f9289b652c01840b5741c390b1
-  data.tar.gz: a00df7c4945ba074f7493f727bed3a9b7b2404743d5f7b41f240e2042242530b
+  metadata.gz: b70eeabdc9f6da4c58f0bf9dd7f1eae8be61ce49a7d2d000967e99a91c2e62cd
+  data.tar.gz: cb8331b086b26d0a134f5560e4f9ceb94f7f529b6a4beaa154bc411a8743b1d1
 SHA512:
-  metadata.gz: fbcb705e404198de143fc4be4cfc0d3e61565d8e65786e856b0d0b562d86071cd686288ebb262db4d1b0e5433a2b7cf05da0d03746619114510f0e04e719cae8
-  data.tar.gz: fde29ac8263407ec2cce0d17d90ef85fa916e8d92ae8cc97b26335206b8b6c30c517c60b2af256ccdf16eea50fba7f8e94f1d727a77f6704002b62a3a4a2b313
+  metadata.gz: 482b2622fe4341c8f74d7eb7278086f876c390ee017396d5f26bd097dafcf3d888190e1bcfbddccc6d2e8e0948a37e0d27590446bbc5d8b1649b84f04084d967
+  data.tar.gz: 53e759edf05fea4c84f0d9d043f7dc1d9bdb41b4ef19336c537e4dac5c185587760c105bfef2f21d1f1be527dc5904378b5967e2e4c164d9395e9771d7dac355

data/README.md

@@ -79,7 +79,53 @@ some other appropriate location, e.g.:
 class ApplicationController < ActionController::Base
   include OauthIm::Authenticable
 
-  # etc. etc. etc.
+  # etc.
 end
-
 ```
+
+### Initializer
+* The gem provides a single initializer, `AppContext`.
+* This module is **not** name-spaced.
+* It provides a single method, `provide_authentication?`, which by
+  default is `true`.
+* Client apps can override this initializer method.
+  * For example, `iiab` overrides this initializer so that the
+    `provide_authentication?` method returns `false` unless the app is
+    `kh_iiab` (not `demo_im`).
+
+## Gem Maintenance
+After many false starts, this repo includes two (seemingly functional) github workflows.
+
+1. Thanks to [this workflow](https://github.com/illustrativemathematics/oauth_im/blob/main/.github/workflows/ci.yml),
+   largely copied from the CMS, the specs should run automatically when a PR is issued.
+2. Thanks to [this workflow](https://github.com/illustrativemathematics/oauth_im/blob/main/.github/workflows/release.yml)
+   based on [this blog post](https://andrewm.codes/blog/automating-ruby-gem-releases-with-github-actions/)
+   and using [this release phase action](https://github.com/illustrativemathematics/oauth_im/blob/main/.github/workflows/release.yml),
+   certain so-called [conventional commits](https://github.com/google-github-actions/release-please-action#how-should-i-write-my-commits)
+   will result in a so-called **release PR**.
+   * Per the above documentation, to issue such a commit, use the following format for your commit message:
+     * `fix: a comment about a  minor change that corresponds to a SemVar patch`
+     * `feat: a comment about a feature change that corresponds to a SemVar minor`
+     * `fix!: a comment about a breaking change that corresponds to a Semvar major`
+     * `feat!: ditto`
+   * Once a release PR is accepted and merged, a new PR is created that does several things:
+     * The gem is versioned by updating [the version file](https://github.com/illustrativemathematics/oauth_im/blob/main/lib/oauth_im/version.rb#L4).
+     * The new PR also includes auto-generated updates to [CHANGELOG.md](https://github.com/illustrativemathematics/oauth_im/blob/main/CHANGELOG.md).
+   * If this new PR is accepted and merged, several other things happened:
+     * A new tag and github release are created.
+     * The new gem version is automatically pushed up to Rubygems.
+
+### Notes
+* Because the above process adds new commits to the repository, you
+  should remember to pull them.
+* At Rubygems it is difficult to reuse version numbers for gems. For
+  this reason, you shouldn't try to force-push updates to gem version
+  numbers. Instead, let the automatic process manage versioning for
+  you.
+
+## Version History
+
+### 0.6.0
+* Remove coupling between gem and `iiab` app via the `AppContext`
+  module. Added default `AppContext` settings to be overridden in
+  client app (in this case, `iiab`).

data/app/controllers/concerns/oauth_im/authenticable.rb

@@ -12,7 +12,7 @@ module OauthIm
     private
 
     def authenticated?
-      AppContext.kh_iiab? && logged_in?
+      AppContext.provide_authentication? && logged_in?
     end
 
     def email

data/config/initializers/app_context.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AppContext
+  def self.provide_authentication?
+    true
+  end
+end

data/lib/oauth_im/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OauthIm
-  VERSION = '0.4.6'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth_im
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.6.0
 platform: ruby
 authors:
 - Eric Connally
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -127,6 +127,7 @@ files:
 - app/helpers/oauth_im/application_helper.rb
 - app/services/oauth_im/token_decoder.rb
 - app/views/layouts/oauth_im/application.html.erb
+- config/initializers/app_context.rb
 - config/routes.rb
 - lib/oauth_im.rb
 - lib/oauth_im/configuration.rb
@@ -137,9 +138,10 @@ homepage: https://github.com/illustrativemathematics/oauth_im
 licenses:
 - BSD-3-Clause
 metadata:
+  changelog_uri: https://github.com/illustrativemathematics/oauth_im
   homepage_uri: https://github.com/illustrativemathematics/oauth_im
   source_code_uri: https://github.com/illustrativemathematics/oauth_im
-  changelog_uri: https://github.com/illustrativemathematics/oauth_im
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: