omniauth-vis 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c033910cb1b4079859bd39ac8f335d4851fe71ba884d49e67b5c290954f9bae
-  data.tar.gz: e7ad31f822e75d60f2834818fa73a90f7340d21458827bb1abe4c68eaf0a1558
+  metadata.gz: 7573bf727926ca641fcc5f511334866a3322f05774aa5fdfa6696aa8f1155bef
+  data.tar.gz: 31ef20a3225cc70cd7953784fb620f5362cebe84571063ae7f767f2bd4583cd0
 SHA512:
-  metadata.gz: fd676cdec4deafc8ff4768e4277163689d9d76b1416a9610cdff112b80269fcc1af2dbb324b8ce04eaf6fd84763342738adc34ebdc6096e8b4656ac653f60502
-  data.tar.gz: 8c629c538a57de590710ed7f7faeb578fc5d951ba45aa22870da952fd76e9370322f2c348204f9c84534a23106336189cf463d526393ec41722b9daa84246dec
+  metadata.gz: 4e13523d75a34af402b2be5efff2f626fbded669a06f663c4fa9a1aa23fc3c870d0142c84606f70839255ee72473805ce2526f2b11a27d96e273664371109c89
+  data.tar.gz: 1541a47d6a04a10114a7c3fc7d5a6023d42947a06fb1a16b582b54ccc291a9282b377a8d49b9efcd23aeb5539ee48656ed6a222b58ef5bafc9577853a5df58a4

data/README.md

@@ -12,31 +12,17 @@ Contact VIS administrators (sebastian.castro@dhamma.org, ryan.johnson@dhamma.org
 
 - Name
 - Home page url
-- Logo url
 - Authorized callback urls (example: https://myapp.org/users/auth/vis/callback)
 
 ## Install the gem
 
 ```
+gem add omniauth
 gem add omniauth-vis
 ```
 
-## Configure
-
-```
-# config/initializers/vis.rb
-
-Rails.application.config.vis = {
-  server_url: "https://identity.dhamma.org/"
-  app_id: "APP_ID_PROVIDED",
-  app_secret: "APP_SECRET_PROVIDED",
-}
-```
-
 ## Use omniauth strategy
 
-You first need to install `omniauth-oauth2` gem, then add a new provider :
-
 ```
 # config/initializers/omniauth.rb
 
@@ -47,6 +33,15 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
+### Customize VIS server
+
+In case you need to work with a custom server, for exmaple a staging server, you can use server_url option
+```
+provider :vis, Rails.application.config.vis["app_id"], Rails.application.config.vis["app_secret"], {
+  server_url: "https://test.identity.dhamma.org"
+}
+```
+
 ## Use VIS API
 
 `Vis::Api` will implement [Oauth2 Client Credentials Flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) behind the scene
@@ -58,7 +53,7 @@ require "vis/api"
 @vis_api.post("api_path", data)
 ```
 
-Documentation about available api can be found at [https://test.identity.dhamma.org/doc](https://test.identity.dhamma.org/doc)
+Documentation about available api can be found at [https://identity.dhamma.org/doc](https://identity.dhamma.org/doc)
 
 Example
 

data/lib/omniauth/strategies/vis.rb

@@ -13,6 +13,7 @@ module OmniAuth
       option :scope, 'default'
 
       option :server_url, "https://identity.dhamma.org"
+      option :jwt_shared_secret, nil
 
       def setup_phase
         # configure Oauth2 client_options.site from a custom server_url option
@@ -42,7 +43,20 @@ module OmniAuth
       end
 
       def raw_info
-        @raw_info ||= access_token.get('/api/v1/me.json').parsed
+        return @raw_info if @raw_info.present?
+
+        @raw_info = if options.jwt_shared_secret.present?
+                      # get info from the JWT token, so we save an API call
+                      JWT.decode(
+                        access_token.token,
+                        options.jwt_shared_secret,
+                        true,
+                        { algorithm: "hs512" }
+                      ).first["user"]
+                    else
+                      # get info from API
+                      access_token.get("/api/v1/me.json").parsed
+                    end
       end
     end
   end

data/lib/vis/api.rb

@@ -1,6 +1,8 @@
 # Vipassna Identity Server Service - for server to server Oauth 2 client_credentials grant flow
 # gets tokens so we can use the VIS API
 module Vis
+  class OauthError < StandardError
+
   class Api
     def initialize(server_url: "https://identity.dhamma.org", client_id:, client_secret:)
       @client_id = client_id
@@ -24,7 +26,7 @@ module Vis
     private def check_error!(response_code, response_body_hash)
       return unless response_body_hash["error"].present? || !response_code.in?(["200", "202"]) # 201 ?
 
-      raise Exceptions::VisOauthError,
+      raise Vis::OauthError,
         "#{response_code} Error requesting token from Vipassana Identity Server. "\
         "#{response_body_hash['error']} #{response_body_hash['error_description']}"
     end

data/omniauth-vis.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'omniauth-vis'
-  gem.version       = '0.1.0'
+  gem.version       = '0.1.2'
   # gem.license       = 'MIT'
   gem.summary       = 'Helper to connect to Vipassna Identity Server'
   gem.description   = 'This allows you to connect to Vipassana identity server with your ruby app'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-vis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Dhamma workers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2