oauth_im 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f30ba9108e81c20be50aac65117a6b9cded7d96dd52fe9fcec17d2ec6b9ab2af
-  data.tar.gz: a71b00b75aee0dce818b377e7c5d8b08d09c129ff7147aba5e823d0cbbb7d075
+  metadata.gz: 3cbef449e4e7e3cb7c22930c0a5a7688d00bd137a955d8ff548542d4f2875572
+  data.tar.gz: 528c74b6cd08deb54536029b2e883d4949ac99c1abe2c56b421bbe76a70aa22a
 SHA512:
-  metadata.gz: 84a9bfaa94c718c7c43dec3e5fdac4737e42ee6703023548ea8515dd13d0817ce1df8f25a14bb4373b16b65bd46d2de40dd019e1b13e67c7a3433c98d9c10aba
-  data.tar.gz: 7c3ffcaba09344862292def9e8db21ff6772b98d9233f4885e58c882196c867fad7990bce2cac8250bb1cf0eb4086d12f7a017c28a3bae4a60ba41852d7151bf
+  metadata.gz: 63bfab0ceb921a9b129277030914e1dfe1bef673b79b2b27fe9042f0d6fb369059dd4a4221862a73dbb18be7ac1d423802bcb8d6ba6e7aaeac20be284261fea6
+  data.tar.gz: 98b94db5ac85de15989d3faa7512e63f80535c22dd8562439f439fa143f81dd462cb9e32999f1ea227c8d8b4fc58b7b04436ef48fe6a32ef63442b4c920a35af

data/README.md

@@ -8,7 +8,7 @@ apps.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'oauth_im'
+gem 'oauth_im', '0.x.y'   # e.g., '0.1.2'
 ```
 
 Then run:
@@ -54,10 +54,13 @@ end
 ### Helpers for Logging in and Out
 The engine provides [two endpoints](https://github.com/illustrativemathematics/oauth_im/blob/main/config/routes.rb#L5-L6) for logging in and out, and exposes
 corresponding view helpers. These are accessible from the main app as:
-* `oauth_im.login_path` or `oauth_im.login_url`
-* `oauth_im.logout_path` or `oauth_im.logout_url`
 
-Note that the helpers are namespaced to the engine.
+| path | url |
+|------|-----|
+| `oauth_im.login_path` | `oauth_im.login_url` |
+| `oauth_im.logout_path` | `oauth_im.logout_url` |
+
+* Note that the helpers are namespaced to the engine.
 
 The [controller actions](https://github.com/illustrativemathematics/oauth_im/blob/main/app/controllers/oauth_im/client_controller.rb#L14-L21) for these routes are provided and should "just
 work." Note that there are no view templates associated with these
@@ -71,4 +74,42 @@ exposes [two helper methods](https://github.com/illustrativemathematics/oauth_im
 * `email`: returns the current user's authenticated email address.
 
 You can include this concern in your app's `ApplicationController` or
-some other appropriate location.
+some other appropriate location, e.g.:
+``` ruby
+class ApplicationController < ActionController::Base
+  include OauthIm::Authenticable
+
+  # etc. etc. etc.
+end
+
+```
+
+## 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.

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

@@ -5,7 +5,6 @@ module OauthIm
     extend ActiveSupport::Concern
 
     included do
-      before_action :auth_uid
       helper_method :authenticated?
       helper_method :email
     end
@@ -20,10 +19,6 @@ module OauthIm
       @email ||= jwt_token['email']
     end
 
-    def auth_uid
-      gon.user_id = session[:user_jwt]['value'].first['jti'] if authenticated?
-    end
-
     def user_jwt
       @user_jwt ||= session[:user_jwt] || {}
     end
@@ -48,7 +43,11 @@ module OauthIm
     end
 
     def logged_in?
-      current_user.present?
+      current_user.present? || local_login?
+    end
+
+    def local_login?
+      session[:userinfo].present?
     end
   end
 end

data/app/controllers/oauth_im/client_controller.rb

@@ -21,7 +21,7 @@ module OauthIm
     end
 
     def local_login
-      raise 'Disallowed' unless Rails.env.development?
+      raise 'Disallowed' if Rails.env.production?
 
       session[:userinfo] = { info: { email: 'local_login@example.com' } }
       redirect_back(fallback_location: main_app.root_path)

data/lib/oauth_im/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth_im
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Eric Connally
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 description: Include this gem in Gemfile, add an initializer, and you are good to
   go.
 email:
@@ -95,10 +137,11 @@ 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
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -114,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Provide oauth functionality for IM apps.
 test_files: []