oauth_im 0.4.7 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a70d55e5fdd5e744b2dc73080162d95b932e18a889b8705e9ccddbb17ac04058
-  data.tar.gz: 253c1abec16f1895b8c4a663b46ac01699b46d81248ff5e661854445783987a0
+  metadata.gz: 49173e12b6a9dd53124b3ecb56a5f71411a819daacd7a1d2e914dd911e4157a1
+  data.tar.gz: 1c7e47395be3b93a95604aa880cacc2f84edf6d45cd516e0e036e86068d67feb
 SHA512:
-  metadata.gz: 73134ec8ba1250f443cd82f3f8ceea8ef1634967d19f0fcfe9dc0bc41dbf34dc6f3769daf4040e57eceb5ec960fb045c22e2a7187a77cbb873167be109c0348b
-  data.tar.gz: 9de025db4311239f823a0503abb80a84b21ab663272c607a029f7aa4d5d1dbd7223140b13d6e162eacd65cd2a09e3cfbde850b8dbd504403d8aab2c7545627b5
+  metadata.gz: b376f8f3b03157df81d18c56d34dd9c9f58d4f5577a308ad75fb709e02ed0b6dbec3d51f9733ad2897402b9bfe2d0c5fed639e861c25a80975dc89db1a3abd4a
+  data.tar.gz: c81f6b6aad610aa99f800f00023c0478e25b39afb56abcf8dbedd9affe08a2fdd16cd4ee5101d2c896d5243b8d2996d6311b3d9accd69626c2df354a8c6d1d9a

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,8 @@ module OauthIm
     private
 
     def authenticated?
-      AppContext.kh_iiab? && logged_in?
+      AppContext.authenticated_for_specs? ||
+        (AppContext.provide_authentication? && logged_in?)
     end
 
     def email
@@ -39,6 +40,8 @@ module OauthIm
           else
             head :forbidden
           end
+        else
+          AppContext.current_user
         end
     end
 

data/config/initializers/app_context.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module AppContext
+  def self.provide_authentication?
+    true
+  end
+
+  def self.authenticated_for_specs?
+    @authenticated_for_specs
+  end
+
+  def self.authenticate_for_specs(current_user: nil)
+    @current_user = current_user
+    @authenticated_for_specs = true
+    yield
+    @authenticated_for_specs = false
+    @current_user = nil
+  end
+
+  def self.current_user
+    @current_user
+  end
+end

data/lib/oauth_im/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth_im
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.7.0
 platform: ruby
 authors:
 - Eric Connally
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-05-04 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