oauth_im 0.1.0.beta2 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5d587f38e6c731c9cc977c05b37a6e6ce13d844ed99139b0ca0797b2a751bd9
-  data.tar.gz: c2a9666111de057e31e8e10219a434481c7fc2ba7939691b5dc43300ac27d590
+  metadata.gz: e28d71eba7b82be12370b581d9d18e1586c306f9289b652c01840b5741c390b1
+  data.tar.gz: a00df7c4945ba074f7493f727bed3a9b7b2404743d5f7b41f240e2042242530b
 SHA512:
-  metadata.gz: 94c68acad113e390308a30c30be31b1d6e7396338317c550984bdcde31e5ecd9771926cb8ce005886665c9eda721f706a7b63b46d8134885878a579ef735bc02
-  data.tar.gz: 628de3176ef5777daaed5a3f0863e53cb24cc540b6f2ee7b10b7b50372c05443bbd117f62cc5cbe9bcbca6763c3c93e2856823e70ec306919a1955ba073253ed
+  metadata.gz: fbcb705e404198de143fc4be4cfc0d3e61565d8e65786e856b0d0b562d86071cd686288ebb262db4d1b0e5433a2b7cf05da0d03746619114510f0e04e719cae8
+  data.tar.gz: fde29ac8263407ec2cce0d17d90ef85fa916e8d92ae8cc97b26335206b8b6c30c517c60b2af256ccdf16eea50fba7f8e94f1d727a77f6704002b62a3a4a2b313

data/README.md

@@ -1,28 +1,85 @@
 # 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:
 
 ```ruby
-gem 'oauth_im'
+gem 'oauth_im', '0.x.y'   # e.g., '0.1.2'
 ```
 
-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:
+
+| 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
+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, 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.beta2'
+  VERSION = '0.4.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth_im
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta2
+  version: 0.4.6
 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:
@@ -98,7 +140,7 @@ metadata:
   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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -109,12 +151,12 @@ 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:
+signing_key: 
 specification_version: 4
 summary: Provide oauth functionality for IM apps.
 test_files: []