oauth_im 0.1.0 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea835a658b25b83322e5bf443c18fec7df3a3382af3258a84b7d27d433a7e7b
-  data.tar.gz: dcf5682ded36d2d2436da87e07125f8425fdc6cf18cf0c281efedde34e781657
+  metadata.gz: a70d55e5fdd5e744b2dc73080162d95b932e18a889b8705e9ccddbb17ac04058
+  data.tar.gz: 253c1abec16f1895b8c4a663b46ac01699b46d81248ff5e661854445783987a0
 SHA512:
-  metadata.gz: 0ec95cfd4cecd4af9298296c615425985d0a35cdf2a22125220b5a788c7819c6beda8b3cebcb8905273fab6f48670058a5c6f5c1618866005e49b1f37110c7a9
-  data.tar.gz: fcc583866ca9264cd45b2ed05efeaeb36ab188e93c1f11036d010f30c59508ce632027bd8b10a79ec38966a65f34f04c6e49eabbbe2eb4ff496f47a9357785f8
+  metadata.gz: 73134ec8ba1250f443cd82f3f8ceea8ef1634967d19f0fcfe9dc0bc41dbf34dc6f3769daf4040e57eceb5ec960fb045c22e2a7187a77cbb873167be109c0348b
+  data.tar.gz: 9de025db4311239f823a0503abb80a84b21ab663272c607a029f7aa4d5d1dbd7223140b13d6e162eacd65cd2a09e3cfbde850b8dbd504403d8aab2c7545627b5

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:
@@ -39,9 +39,9 @@ end
 
 * The `ENV` variable values can be obtained from the OAuth provider.
 * The `callback_path` setting is used in two related ways:
-  * It defines a route to the `OAuthIm::ClientController#callback`
-    action.
-  * It defines a callback URL used by the OAuth provider.
+  * It [defines a route](https://github.com/illustrativemathematics/oauth_im/blob/main/config/routes.rb#L4) to the [`OAuthIm::ClientController#callback`
+    action](https://github.com/illustrativemathematics/oauth_im/blob/main/app/controllers/oauth_im/client_controller.rb#L7-L12).
+  * It defines a [callback URL](https://github.com/illustrativemathematics/oauth_im/blob/main/app/controllers/oauth_im/client_controller.rb#L69) used by the OAuth provider.
 * Note that this callback URL must be whitelisted at the provider.
   At FusionAuth, this is done under the `Applications|OAuth` tab.
   * For instance, for the app `staging-kh-iiab.herokuapp.com`, if
@@ -52,23 +52,34 @@ end
 
 ## Usage
 ### Helpers for Logging in and Out
-The engine provides two  endpoints for logging in and out, and exposes
+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` |
 
-The controller actions for these routes are provided and should "just
+* 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
 actions, since requests to them are redirected to the OAuth provider.
 
 ### Helpers for User ID and Authentication
 The gem provides a controller concern, `OauthIm::Authenticable`, that
-exposes two helper methods for use in views:
+exposes [two helper methods](https://github.com/illustrativemathematics/oauth_im/blob/main/app/controllers/concerns/oauth_im/authenticable.rb#L9-L10) for use in views:
 * `authenticated?`: returns `true` if the user has been authenticated
   by the OAuth service, false otherwise.
 * `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
+
+```

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.0'
+  VERSION = '0.4.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth_im
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.7
 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: []