oauth_im 0.1.0.beta → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27cef13d10be77f61bfff0a4faeabea5695f0707dc8edceb2cb47363f1aa4b58
-  data.tar.gz: e429efcb445b1243d4954801abc053bf80b4f6f9543a962d668e4728bb25c65b
+  metadata.gz: 0ba9ab7f3674cc033d6ceaa2adb235c3a046f0b4090ea7d712318d8787d9abdf
+  data.tar.gz: ae1998dbd428f00ee8f2b30e334de251be35ae760b0efab820a37bc00900e7d1
 SHA512:
-  metadata.gz: d8a956deb04217dd73f4bf2bd35d6e9390b542e1ce786784088c05593eb607ac0bc19df739052af1dfcc0c820ad59bc18b1fad107ca3e05eaafb7480cd9ce19b
-  data.tar.gz: 5fb848b54191d4c12052786bbfd959069ece2c1b0dda8aab7481a7fe1b262b389e79c76af4108a453aa71b28492d20fdfdff41bed5edd390a7afb668c38ef451
+  metadata.gz: 7a87bf27fc06e740fe0b4de963d553e2d5077e55db71ce2137850fdc01bd9ee2092c600c760c788e200ef7dc0dfc0710a5961ce4b23a5310215e9cf6e4d51ff4
+  data.tar.gz: 9be6e477b2e60ad61e73e25edbc4151cbe986bb01e2125b35fb527f9c58dbbd3dd56a750492957900d539e4b0fe2312b04fd91714c580b3a9dc2d2dabc6bd188

data/README.md

@@ -1,8 +1,8 @@
 # OauthIm
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+The IIAB apps use an OAuth service provider (currently FusionAuth). This gem
+serves to standardize integration with this service. The hope is that,
+at some point, we can add this service to the CMS, Kamaji, and related
+apps.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -11,18 +11,64 @@ Add this line to your application's Gemfile:
 gem 'oauth_im'
 ```
 
-And then execute:
+Then run:
 ```bash
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install oauth_im
+## Configuration
+Once the gem is installed, add an initializer. Here is an example:
+
+```ruby
+# config/initializers/oauth_im.rb
+module OauthIm
+  configure do |config|
+    config.api_key       = ENV['FUSION_AUTH_API_KEY']
+    config.callback_path = ENV['FUSION_CALLBACK_PATH'] || DEFAULT_CALLBACK_PATH
+    config.client_id     = ENV['FUSION_AUTH_CLIENT_ID']
+    config.client_secret = ENV['FUSION_AUTH_CLIENT_SECRET']
+    config.domain        = ENV['FUSION_AUTH_DOMAIN']
+    config.hmac          = ENV['FUSION_AUTH_HMAC']
+    config.iss_domain    = ENV['FUSION_AUTH_ISS_DOMAIN']
+    config.tenant_id     = ENV['FUSION_AUTH_TENANT_ID']
+    config.authorize_url = ENV['FUSION_AUTH_AUTHORIZE_URL'] || DEFAULT_AUTHORIZE_URL
+    config.token_url     = ENV['FUSION_AUTH_TOKEN_URL']     || DEFAULT_TOKEN_URL
+  end
+end
 ```
 
-## Contributing
-Contribution directions go here.
+* 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](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
+    `config.callback_path` is set to `callback` (the default), then
+    the URL `https://staging-kh-iiab.herokuapp.com/oauth_im/callback`
+    must be entered in the OAuth provider's list of authorized
+    redirect URLs.
+
+## Usage
+### 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.
+
+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](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.
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+You can include this concern in your app's `ApplicationController` or
+some other appropriate location.

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.beta'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oauth_im
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.2
 platform: ruby
 authors:
 - Eric Connally
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -109,9 +109,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: