passageidentity 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5dd45f9023ac4cd3eb005f4604f40229981aeca5c6da2ebd1eca685fcf54245
-  data.tar.gz: de14152791bbe75fb11de58d65cf72bab61f570bec22f93240f7a88c128d8eaa
+  metadata.gz: 150a9a5019bc8edcee52a97ca0827e550bcdddf331c53a5d30b93d9ee34c654a
+  data.tar.gz: 2e426bb06a6b0f48215bd6fc65f14f16bbe89533ef43268477345d6ee1ca10c4
 SHA512:
-  metadata.gz: d7184b5a3325f54c022a0ba63c622ad38670793eeb9c3cabadb0c28c4ee9b9675f63d302a93449f1d5eac43cecbbdf0bb82c0bbb1d06132caf3d3a99f552d3d1
-  data.tar.gz: 65e9721e3ca3049a758eb0287f5f379b7e27ee43397cb75592c2875194155a9d83d95c47244716d9de09d88fb6bb9ae33115d4f45649d6095adfb15c5b562942
+  metadata.gz: ccb948349018b0b7d6cca610f450c7ec73a14bb36043d1470186178b7a009f6e3c064812bff3016df0d5366b017e15bf1a58dd6226cca2feab3d91fa283e4d58
+  data.tar.gz: fe4a77185f3c88c1cde260a55ed9f238b7fc909bcdf57746eb9bd3023ac9ff08f178c6d8c6bd74451e8a8f7c6df79dd5386b46efbf10f538a194bef2570d3ecf

data/.github/workflows/deploy.yml

@@ -0,0 +1,30 @@
+name: Deploy Ruby Gem
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/on_pr.yml

@@ -0,0 +1,34 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches: [ main ]
+
+env:
+  API_KEY: ${{ secrets.API_KEY }}
+  APP_ID: ${{ secrets.APP_ID }}
+  PSG_JWT: ${{ secrets.PSG_JWT }}
+  TEST_USER_ID: ${{ secrets.TEST_USER_ID }}
+
+jobs:
+  build:
+    name: Test and Lint
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+
+    - name: Run Tests
+      run: |
+        gem build passageidentity.gemspec -o test.gem
+        gem install test.gem
+        rm test.gem
+        ruby tests/all.rb
+    - name: Run Linting
+      run: |
+        npm install -g prettier @prettier/plugin-ruby
+        gem install bundler prettier_print syntax_tree syntax_tree-haml syntax_tree-rbs
+        prettier --check '**/*.rb'

data/.gitignore

@@ -10,8 +10,7 @@
 /test/version_tmp/
 /tmp/
 
-/tests/environment.rb
-
+.env
 # Used by dotenv library to load environment variables.
 # .env
 

data/CONTRIBUTING.md

@@ -5,8 +5,8 @@
 Install the gem
 
 ```
-gem build passageidentity.gemspec
-gem install ./passageidentity-0.0.1.gem
+gem build passageidentity.gemspec -o {$FILE_NAME}.gem
+gem install ./{$FILE_NAME}.gem
 ```
 
 Test it out:
@@ -27,6 +27,15 @@ ruby tests/all.rb
 ruby tests/*_test.rb
 ```
 
+Run Linter:
+
+```
+npm install -g prettier @prettier/plugin-ruby
+gem install bundler prettier_print syntax_tree syntax_tree-haml syntax_tree-rbs
+prettier --write '**/*.rb'
+```
+
+
 To test in the example app, change the Gemfile to include this path:
 
 ```
@@ -45,7 +54,6 @@ Enter host password for user '<username>':
 ```
 
 ```
-<<<<<<< HEAD
 gem push passage-0.0.0.gem
 ```
 
@@ -55,17 +63,4 @@ You can check for the gem here:
 gem list -r passage
 ```
 
-=======
-gem push passageidentity-0.0.0.gem
-
-```
-
-You can check for the gem here:
-
-```
-
-gem list -r passageidentity
-
-```
->>>>>>> 2d0e3f6dc3b40c621c8d16506fa6ab43b0fba673
 ```

data/README.md

@@ -51,6 +51,36 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Retrieve App Info
+
+To retrieve information about an app , you should use the `get_app` method.
+
+```ruby
+require 'passageidentity'
+
+PassageClient =
+  Passage::Client.new(app_id: PASSAGE_APP_ID)
+app_info = PassageClient.get_app()
+  
+```
+
+The information available in the Passage App struct returned by PassageClient.get_app():
+
+```ruby
+    Struct.new :name,
+               :id,
+               :auth_origin,
+               :redirect_url,
+               :login_url,
+               :rsa_public_key,
+               :allowed_identifer,
+               :required_identifier,
+               :require_email_verification,
+               :session_timeout_length,
+               :user_metadata_schema,
+               :layouts,
+```
+
 ## Retrieve User Info
 
 To retrieve information about a user, you should use the `get` method. You will need to use a Passage API key, which can be created in the Passage Console under your Application Settings. This API key grants your web server access to the Passage management APIs to get and update information about users. This API key must be protected and stored in an appropriate secure storage location. It should never be hard-coded in the repository.

data/lib/passageidentity/auth.rb

@@ -1,7 +1,7 @@
-require 'openssl'
-require 'base64'
-require 'jwt'
-require_relative 'client'
+require "openssl"
+require "base64"
+require "jwt"
+require_relative "client"
 
 module Passage
   class Auth
@@ -17,10 +17,10 @@ module Passage
     def fetch_app()
       begin
         response = @connection.get("/v1/apps/#{@app_id}")
-        return response.body['app']
+        return response.body["app"]
       rescue Faraday::Error => e
         raise PassageError,
-              "failed to get Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+              "failed to get Passage App. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
       end
     end
 
@@ -30,7 +30,7 @@ module Passage
       else
         app = fetch_app
         auth_gw_connection =
-          Faraday.new(url: 'https://auth.passage.id') do |f|
+          Faraday.new(url: "https://auth.passage.id") do |f|
             f.request :json
             f.request :retry
             f.response :raise_error
@@ -40,7 +40,7 @@ module Passage
 
         # fetch the public key if not in cache
         app = fetch_app
-        @auth_origin = app['auth_origin']
+        @auth_origin = app["auth_origin"]
         response =
           auth_gw_connection.get("/v1/apps/#{@app_id}/.well-known/jwks.json")
         @jwks = response.body
@@ -51,33 +51,33 @@ module Passage
     def authenticate_request(request)
       # Get the token based on the strategy
       if @auth_strategy === Passage::COOKIE_STRATEGY
-        unless request.cookies['psg_auth_token'].present?
+        unless request.cookies["psg_auth_token"].present?
           raise PassageError,
                 `missing authentication token: expected "psg_auth_token" cookie`
         end
-        @token = request.cookies['psg_auth_token']
+        @token = request.cookies["psg_auth_token"]
       else
         headers = request.headers
-        unless headers['Authorization'].present?
-          raise PassageError, 'no authentication token in header'
+        unless headers["Authorization"].present?
+          raise PassageError, "no authentication token in header"
         end
-        @token = headers['Authorization'].split(' ').last
+        @token = headers["Authorization"].split(" ").last
       end
 
       # authenticate the token
       if @token
         return authenticate_token(@token)
       else
-        raise PassageError, 'no authentication token'
+        raise PassageError, "no authentication token"
       end
       nil
     end
 
     def authenticate_token(token)
-      kid = JWT.decode(token, nil, false)[1]['kid']
+      kid = JWT.decode(token, nil, false)[1]["kid"]
       exists = false
-      for jwk in @jwks['keys']
-        if jwk['kid'] == kid
+      for jwk in @jwks["keys"]
+        if jwk["kid"] == kid
           exists = true
           break
         end
@@ -90,15 +90,13 @@ module Passage
             nil,
             true,
             {
-              iss: @app_id,
-              verify_iss: true,
               aud: @auth_origin,
               verify_aud: true,
-              algorithms: ['RS256'],
+              algorithms: ["RS256"],
               jwks: @jwks
             }
           )
-        return claims[0]['sub']
+        return claims[0]["sub"]
       rescue JWT::InvalidIssuerError => e
         raise Passage::PassageError, e.message
       rescue JWT::InvalidAudError => e

data/lib/passageidentity/client.rb

@@ -1,10 +1,24 @@
 # frozen_string_literal: true
 
-require_relative 'auth'
-require_relative 'user_api'
-require_relative 'error'
+require_relative "auth"
+require_relative "user_api"
+require_relative "error"
 
 module Passage
+  App =
+    Struct.new :name,
+               :id,
+               :auth_origin,
+               :redirect_url,
+               :login_url,
+               :rsa_public_key,
+               :allowed_identifer,
+               :required_identifier,
+               :require_email_verification,
+               :session_timeout_length,
+               :user_metadata_schema,
+               :layouts,
+               keyword_init: true
   User =
     Struct.new :id,
                :status,
@@ -43,21 +57,21 @@ module Passage
   COOKIE_STRATEGY = 0
   HEADER_STRATEGY = 1
 
-  EMAIL_CHANNEL = 'email'
-  PHONE_CHANNEL = 'phone'
+  EMAIL_CHANNEL = "email"
+  PHONE_CHANNEL = "phone"
 
   class Client
     attr_reader :auth
     attr_reader :user
 
-    def initialize(app_id:, api_key: '', auth_strategy: COOKIE_STRATEGY)
-      @api_url = 'https://api.passage.id'
+    def initialize(app_id:, api_key: "", auth_strategy: COOKIE_STRATEGY)
+      @api_url = "https://api.passage.id"
       @app_id = app_id
       @api_key = api_key
 
       # check for valid auth strategy
       unless [COOKIE_STRATEGY, HEADER_STRATEGY].include? auth_strategy
-        raise PassageError, 'invalid auth strategy.'
+        raise PassageError, "invalid auth strategy."
       end
       @auth_strategy = auth_strategy
 
@@ -72,7 +86,7 @@ module Passage
     end
 
     def get_connection
-      if @api_key == ''
+      if @api_key == ""
         @connection =
           Faraday.new(url: @api_url) do |f|
             f.request :json
@@ -86,7 +100,7 @@ module Passage
           Faraday.new(
             url: @api_url,
             headers: {
-              'Authorization' => "Bearer #{@api_key}"
+              "Authorization" => "Bearer #{@api_key}"
             }
           ) do |f|
             f.request :json
@@ -98,54 +112,79 @@ module Passage
       end
     end
 
+    def get_app()
+      begin
+        app_info = @auth.fetch_app()
+        return(
+          Passage::App.new(
+            name: app_info["name"],
+            id: app_info["id"],
+            auth_origin: app_info["auth_origin"],
+            redirect_url: app_info["redirect_url"],
+            login_url: app_info["login_url"],
+            rsa_public_key: app_info["rsa_public_key"],
+            allowed_identifer: app_info["allowed_identifer"],
+            required_identifier: app_info["required_identifier"],
+            require_email_verification: app_info["require_email_verification"],
+            session_timeout_length: app_info["session_timeout_length"],
+            user_metadata_schema: app_info["user_metadata_schema"],
+            layouts: app_info["layouts"]
+          )
+        )
+      rescue => e
+        raise e
+      end
+    end
+
     def create_magic_link(
-      user_id: '',
-      email: '',
-      phone: '',
-      channel: '',
+      user_id: "",
+      email: "",
+      phone: "",
+      channel: "",
       send: false,
-      magic_link_path: '',
-      redirect_url: '',
+      magic_link_path: "",
+      redirect_url: "",
       ttl: 60
     )
       magic_link_req = {}
-      magic_link_req['user_id'] = user_id unless user_id.empty?
-      magic_link_req['email'] = email unless email.empty?
-      magic_link_req['phone'] = phone unless phone.empty?
+      magic_link_req["user_id"] = user_id unless user_id.empty?
+      magic_link_req["email"] = email unless email.empty?
+      magic_link_req["phone"] = phone unless phone.empty?
 
       # check to see if the channel specified is valid before sending it off to the server
       unless [PHONE_CHANNEL, EMAIL_CHANNEL].include? channel
         raise PassageError,
-              'channel: must be either Passage::EMAIL_CHANNEL or Passage::PHONE_CHANNEL'
+              "channel: must be either Passage::EMAIL_CHANNEL or Passage::PHONE_CHANNEL"
       end
-      magic_link_req['channel'] = channel unless channel.empty?
-      magic_link_req['send'] = send
-      magic_link_req['magic_link_path'] = magic_link_path unless magic_link_path
-        .empty?
-      magic_link_req['redirect_url'] = redirect_url unless redirect_url.empty?
-      magic_link_req['ttl'] = ttl unless ttl == 0
+      magic_link_req["channel"] = channel unless channel.empty?
+      magic_link_req["send"] = send
+      magic_link_req[
+        "magic_link_path"
+      ] = magic_link_path unless magic_link_path.empty?
+      magic_link_req["redirect_url"] = redirect_url unless redirect_url.empty?
+      magic_link_req["ttl"] = ttl unless ttl == 0
 
       begin
         response =
           @connection.post("/v1/apps/#{@app_id}/magic-links", magic_link_req)
-        magic_link = response.body['magic_link']
+        magic_link = response.body["magic_link"]
         return(
           Passage::MagicLink.new(
-            id: magic_link['id'],
-            secret: magic_link['secret'],
-            activated: magic_link['activated'],
-            user_id: magic_link['user_id'],
-            app_id: magic_link['app_id'],
-            identifier: magic_link['identifier'],
-            type: magic_link['type'],
-            redirect_url: magic_link['redirect_url'],
-            ttl: magic_link['ttl'],
-            url: magic_link['url']
+            id: magic_link["id"],
+            secret: magic_link["secret"],
+            activated: magic_link["activated"],
+            user_id: magic_link["user_id"],
+            app_id: magic_link["app_id"],
+            identifier: magic_link["identifier"],
+            type: magic_link["type"],
+            redirect_url: magic_link["redirect_url"],
+            ttl: magic_link["ttl"],
+            url: magic_link["url"]
           )
         )
       rescue Faraday::Error => e
         raise PassageError,
-              "failed to create Passage Magic Link. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+              "failed to create Passage Magic Link. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
       end
     end
   end

data/lib/passageidentity/user_api.rb

@@ -1,4 +1,4 @@
-require_relative 'client'
+require_relative "client"
 
 module Passage
   class UserAPI
@@ -10,26 +10,26 @@ module Passage
     end
 
     def get(user_id:)
-      raise PassageError, 'must supply a valid user_id' if user_id.to_s.empty?
+      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
       begin
         response = @connection.get("/v1/apps/#{@app_id}/users/#{user_id}")
-        user = response.body['user']
+        user = response.body["user"]
         user.transform_keys(&:to_sym)
         return(
           Passage::User.new(
-            id: user['id'],
-            status: user['status'],
-            email: user['email'],
-            phone: user['phone'],
-            email_verified: user['email_verified'],
-            created_at: user['created_at'],
-            updated_at: user['updated_at'],
-            last_login_at: user['last_login_at'],
-            login_count: user['login_count'],
-            webauthn: user['webauthn'],
-            webauthn_devices: user['webauthn_devices'],
-            recent_events: user['recent_events'],
-            user_metadata: user['user_metadata']
+            id: user["id"],
+            status: user["status"],
+            email: user["email"],
+            phone: user["phone"],
+            email_verified: user["email_verified"],
+            created_at: user["created_at"],
+            updated_at: user["updated_at"],
+            last_login_at: user["last_login_at"],
+            login_count: user["login_count"],
+            webauthn: user["webauthn"],
+            webauthn_devices: user["webauthn_devices"],
+            recent_events: user["recent_events"],
+            user_metadata: user["user_metadata"]
           )
         )
       rescue Faraday::Error => e
@@ -38,32 +38,32 @@ module Passage
                 "passage User with ID \"#{user_id}\" does not exist"
         else
           raise PassageError,
-                "failed to get Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+                "failed to get Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
         end
       end
     end
 
     def activate(user_id:)
-      raise PassageError, 'must supply a valid user_id' if user_id.to_s.empty?
+      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
       begin
         response =
           @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}/activate")
-        user = response.body['user']
+        user = response.body["user"]
         return(
           Passage::User.new(
-            id: user['id'],
-            status: user['status'],
-            email: user['email'],
-            phone: user['phone'],
-            email_verified: user['email_verified'],
-            created_at: user['created_at'],
-            updated_at: user['updated_at'],
-            last_login_at: user['last_login_at'],
-            login_count: user['login_count'],
-            webauthn: user['webauthn'],
-            webauthn_devices: user['webauthn_devices'],
-            recent_events: user['recent_events'],
-            user_metadata: user['user_metadata']
+            id: user["id"],
+            status: user["status"],
+            email: user["email"],
+            phone: user["phone"],
+            email_verified: user["email_verified"],
+            created_at: user["created_at"],
+            updated_at: user["updated_at"],
+            last_login_at: user["last_login_at"],
+            login_count: user["login_count"],
+            webauthn: user["webauthn"],
+            webauthn_devices: user["webauthn_devices"],
+            recent_events: user["recent_events"],
+            user_metadata: user["user_metadata"]
           )
         )
       rescue Faraday::Error => e
@@ -72,32 +72,32 @@ module Passage
                 "passage User with ID \"#{user_id}\" does not exist"
         else
           raise PassageError,
-                "failed to activate Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+                "failed to activate Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
         end
       end
     end
 
     def deactivate(user_id:)
-      raise PassageError, 'must supply a valid user_id' if user_id.to_s.empty?
+      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
       begin
         response =
           @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}/deactivate")
-        user = response.body['user']
+        user = response.body["user"]
         return(
           Passage::User.new(
-            id: user['id'],
-            status: user['status'],
-            email: user['email'],
-            phone: user['phone'],
-            email_verified: user['email_verified'],
-            created_at: user['created_at'],
-            updated_at: user['updated_at'],
-            last_login_at: user['last_login_at'],
-            login_count: user['login_count'],
-            webauthn: user['webauthn'],
-            webauthn_devices: user['webauthn_devices'],
-            recent_events: user['recent_events'],
-            user_metadata: user['user_metadata']
+            id: user["id"],
+            status: user["status"],
+            email: user["email"],
+            phone: user["phone"],
+            email_verified: user["email_verified"],
+            created_at: user["created_at"],
+            updated_at: user["updated_at"],
+            last_login_at: user["last_login_at"],
+            login_count: user["login_count"],
+            webauthn: user["webauthn"],
+            webauthn_devices: user["webauthn_devices"],
+            recent_events: user["recent_events"],
+            user_metadata: user["user_metadata"]
           )
         )
       rescue Faraday::Error => e
@@ -106,36 +106,36 @@ module Passage
                 "passage User with ID \"#{user_id}\" does not exist"
         else
           raise PassageError,
-                "failed to deactivate Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+                "failed to deactivate Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
         end
       end
     end
 
-    def update(user_id:, email: '', phone: '', user_metadata: {})
-      raise PassageError, 'must supply a valid user_id' if user_id.to_s.empty?
+    def update(user_id:, email: "", phone: "", user_metadata: {})
+      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
       updates = {}
-      updates['email'] = email unless email.empty?
-      updates['phone'] = phone unless phone.empty?
-      updates['user_metadata'] = user_metadata unless user_metadata.empty?
+      updates["email"] = email unless email.empty?
+      updates["phone"] = phone unless phone.empty?
+      updates["user_metadata"] = user_metadata unless user_metadata.empty?
       begin
         response =
           @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}", updates)
-        user = response.body['user']
+        user = response.body["user"]
         return(
           Passage::User.new(
-            id: user['id'],
-            status: user['status'],
-            email: user['email'],
-            phone: user['phone'],
-            email_verified: user['email_verified'],
-            created_at: user['created_at'],
-            updated_at: user['updated_at'],
-            last_login_at: user['last_login_at'],
-            login_count: user['login_count'],
-            webauthn: user['webauthn'],
-            webauthn_devices: user['webauthn_devices'],
-            recent_events: user['recent_events'],
-            user_metadata: user['user_metadata']
+            id: user["id"],
+            status: user["status"],
+            email: user["email"],
+            phone: user["phone"],
+            email_verified: user["email_verified"],
+            created_at: user["created_at"],
+            updated_at: user["updated_at"],
+            last_login_at: user["last_login_at"],
+            login_count: user["login_count"],
+            webauthn: user["webauthn"],
+            webauthn_devices: user["webauthn_devices"],
+            recent_events: user["recent_events"],
+            user_metadata: user["user_metadata"]
           )
         )
       rescue Faraday::Error => e
@@ -144,44 +144,44 @@ module Passage
                 "passage User with ID \"#{user_id}\" does not exist"
         else
           raise PassageError,
-                "failed to update Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+                "failed to update Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
         end
       end
     end
 
-    def create(email: '', phone: '', user_metadata: {})
+    def create(email: "", phone: "", user_metadata: {})
       create = {}
-      create['email'] = email unless email.empty?
-      create['phone'] = phone unless phone.empty?
-      create['user_metadata'] = user_metadata unless user_metadata.empty?
+      create["email"] = email unless email.empty?
+      create["phone"] = phone unless phone.empty?
+      create["user_metadata"] = user_metadata unless user_metadata.empty?
       begin
         response = @connection.post("/v1/apps/#{@app_id}/users", create)
-        user = response.body['user']
+        user = response.body["user"]
         return(
           Passage::User.new(
-            id: user['id'],
-            status: user['status'],
-            email: user['email'],
-            phone: user['phone'],
-            email_verified: user['email_verified'],
-            created_at: user['created_at'],
-            updated_at: user['updated_at'],
-            last_login_at: user['last_login_at'],
-            login_count: user['login_count'],
-            webauthn: user['webauthn'],
-            webauthn_devices: user['webauthn_devices'],
-            recent_events: user['recent_events'],
-            user_metadata: user['user_metadata']
+            id: user["id"],
+            status: user["status"],
+            email: user["email"],
+            phone: user["phone"],
+            email_verified: user["email_verified"],
+            created_at: user["created_at"],
+            updated_at: user["updated_at"],
+            last_login_at: user["last_login_at"],
+            login_count: user["login_count"],
+            webauthn: user["webauthn"],
+            webauthn_devices: user["webauthn_devices"],
+            recent_events: user["recent_events"],
+            user_metadata: user["user_metadata"]
           )
         )
       rescue Faraday::Error => e
         raise PassageError,
-              "failed to create Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+              "failed to create Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
       end
     end
 
     def delete(user_id:)
-      raise PassageError, 'must supply a valid user_id' if user_id.to_s.empty?
+      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
       begin
         response = @connection.delete("/v1/apps/#{@app_id}/users/#{user_id}")
         return true
@@ -191,15 +191,15 @@ module Passage
                 "passage User with ID \"#{user_id}\" does not exist"
         else
           raise PassageError,
-                "failed to delete Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+                "failed to delete Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
         end
       end
     end
 
     def delete_device(user_id:, device_id:)
-      raise PassageError, 'must supply a valid user_id' if user_id.to_s.empty?
+      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
       if device_id.to_s.empty?
-        raise PassageError, 'must supply a valid device_id'
+        raise PassageError, "must supply a valid device_id"
       end
       begin
         response =
@@ -209,32 +209,32 @@ module Passage
         return true
       rescue Faraday::Error => e
         raise PassageError,
-              "failed to delete Passage User Device. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+              "failed to delete Passage User Device. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
       end
     end
 
     def list_devices(user_id:)
-      raise PassageError, 'must supply a valid user_id' if user_id.to_s.empty?
+      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
       begin
         response =
           @connection.get("/v1/apps/#{@app_id}/users/#{user_id}/devices")
-        devicesResp = response.body['devices']
+        devicesResp = response.body["devices"]
         devices = Array.new
         devicesResp.each do |device|
           devices.append(
             Passage::Device.new(
-              id: device['id'],
-              cred_id: device['cred_id'],
-              friendly_name: device['friendly_name'],
-              usage_count: device['usage_count'],
-              last_used: device['last_used']
+              id: device["id"],
+              cred_id: device["cred_id"],
+              friendly_name: device["friendly_name"],
+              usage_count: device["usage_count"],
+              last_used: device["last_used"]
             )
           )
         end
         return devices
       rescue Faraday::Error => e
         raise PassageError,
-              "failed to delete Passage User Device. Http Status: #{e.response[:status]}. Response: #{e.response[:body]['error']}"
+              "failed to delete Passage User Device. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
       end
     end
   end

data/lib/passageidentity.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require "faraday"
 
-require_relative 'passageidentity/client'
+require_relative "passageidentity/client"
 
 module Passage
 end

data/passageidentity.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'passageidentity'
-  s.version = '0.0.4'
+  s.version = '0.0.7'
   s.summary = 'Passage SDK for biometric authentication'
   s.description =
     'Enables verification of server-side authentication and user management for applications using Passage'
@@ -27,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday', '>= 0.17.0', '< 2.0'
   s.add_dependency 'jwt', '>= 2.3.0'
   s.add_dependency 'openssl', '>= 3.0.0'
+  s.add_dependency 'dotenv', '>= 2.7.6'
 end

data/tests/all.rb

@@ -1,2 +1,3 @@
-Dir[File.dirname(File.absolute_path(__FILE__)) + '/**/*_test.rb']
-  .each { |file| require file }
+Dir[File.dirname(File.absolute_path(__FILE__)) + "/**/*_test.rb"].each do |file|
+  require file
+end

data/tests/app_test.rb

@@ -0,0 +1,15 @@
+require_relative "../lib/passageidentity/client"
+require "dotenv"
+require "faraday"
+require "test/unit"
+
+Dotenv.load(".env")
+class TestAppAPI < Test::Unit::TestCase
+  PassageClient =
+    Passage::Client.new(app_id: ENV["APP_ID"], api_key: ENV["API_KEY"])
+
+  def test_get_app()
+    app = PassageClient.get_app()
+    assert_equal ENV["APP_ID"], app.id
+  end
+end

data/tests/auth_test.rb

@@ -1,14 +1,15 @@
-require_relative '../lib/passageidentity/client'
-require_relative './environment'
-require 'faraday'
-require 'test/unit'
+require_relative "../lib/passageidentity/client"
+require "dotenv"
+require "faraday"
+require "test/unit"
 
+Dotenv.load(".env")
 class TestUserAPI < Test::Unit::TestCase
   PassageClient =
-    Passage::Client.new(app_id: ENV['APP_ID'], api_key: ENV['API_KEY'])
+    Passage::Client.new(app_id: ENV["APP_ID"], api_key: ENV["API_KEY"])
 
   def test_authenticate_token
-    user_id = PassageClient.auth.authenticate_token(ENV['PSG_JWT'])
-    assert_equal ENV['TEST_USER_ID'], user_id
+    user_id = PassageClient.auth.authenticate_token(ENV["PSG_JWT"])
+    assert_equal ENV["TEST_USER_ID"], user_id
   end
 end

data/tests/magic_link_test.rb

@@ -1,20 +1,21 @@
-require_relative '../lib/passageidentity/client'
-require_relative './environment'
-require 'faraday'
-require 'test/unit'
+require_relative "../lib/passageidentity/client"
+require "dotenv"
+require "faraday"
+require "test/unit"
 
+Dotenv.load(".env")
 class TestUserAPI < Test::Unit::TestCase
   PassageClient =
-    Passage::Client.new(app_id: ENV['APP_ID'], api_key: ENV['API_KEY'])
+    Passage::Client.new(app_id: ENV["APP_ID"], api_key: ENV["API_KEY"])
 
   def test_create_magi_link()
     magic_link =
       PassageClient.create_magic_link(
-        email: 'chris@passage.id',
+        email: "chris@passage.id",
         channel: Passage::EMAIL_CHANNEL,
         ttl: 12
       )
     assert_equal 12, magic_link.ttl
-    assert_equal 'chris@passage.id', magic_link.identifier
+    assert_equal "chris@passage.id", magic_link.identifier
   end
 end

data/tests/user_api_test.rb

@@ -1,18 +1,19 @@
-require_relative '../lib/passageidentity/client'
-require_relative './environment'
-require 'faraday'
-require 'test/unit'
+require_relative "../lib/passageidentity/client"
+require "dotenv"
+require "faraday"
+require "test/unit"
 
+Dotenv.load(".env")
 class TestUserAPI < Test::Unit::TestCase
   PassageClient =
-    Passage::Client.new(app_id: ENV['APP_ID'], api_key: ENV['API_KEY'])
+    Passage::Client.new(app_id: ENV["APP_ID"], api_key: ENV["API_KEY"])
 
   def setup()
     $global_test_user =
       PassageClient.user.create(
-        email: 'chris+test-ruby@passage.id',
+        email: "chris+test-ruby@passage.id",
         user_metadata: {
-          'example1': 'cool'
+          example1: "cool"
         }
       )
   end
@@ -20,13 +21,13 @@ class TestUserAPI < Test::Unit::TestCase
   def test_create_delete_user()
     user =
       PassageClient.user.create(
-        email: 'chris+test-create-delete@passage.id',
+        email: "chris+test-create-delete@passage.id",
         user_metadata: {
-          'example1': 'cool'
+          example1: "cool"
         }
       )
-    assert_equal 'chris+test-create-delete@passage.id', user.email
-    assert_equal 'cool', user.user_metadata['example1']
+    assert_equal "chris+test-create-delete@passage.id", user.email
+    assert_equal "cool", user.user_metadata["example1"]
     deleted = PassageClient.user.delete(user_id: user.id)
     assert_equal true, deleted
   end
@@ -39,28 +40,28 @@ class TestUserAPI < Test::Unit::TestCase
   def test_deactivate_user()
     user = PassageClient.user.deactivate(user_id: $global_test_user.id)
     assert_equal $global_test_user.id, user.id
-    assert_equal 'inactive', user.status
+    assert_equal "inactive", user.status
   end
 
   def test_activate_user()
     user = PassageClient.user.activate(user_id: $global_test_user.id)
     assert_equal $global_test_user.id, user.id
-    assert_equal 'active', user.status
+    assert_equal "active", user.status
   end
 
   def test_update_user()
-    new_email = 'chris+update_test-ruby@passage.id'
+    new_email = "chris+update_test-ruby@passage.id"
     user =
       PassageClient.user.update(
         user_id: $global_test_user.id,
         email: new_email,
         user_metadata: {
-          'example1': 'lame'
+          example1: "lame"
         }
       )
     assert_equal $global_test_user.id, user.id
     assert_equal new_email, user.email
-    assert_equal 'lame', user.user_metadata['example1']
+    assert_equal "lame", user.user_metadata["example1"]
   end
 
   def test_list_devices()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passageidentity
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Passage Identity
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
 description: Enables verification of server-side authentication and user management
   for applications using Passage
 email: support@passage.id
@@ -65,6 +79,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/deploy.yml"
+- ".github/workflows/on_pr.yml"
 - ".gitignore"
 - CONTRIBUTING.md
 - LICENSE
@@ -74,9 +90,9 @@ files:
 - lib/passageidentity/client.rb
 - lib/passageidentity/error.rb
 - lib/passageidentity/user_api.rb
-- passage-ruby
 - passageidentity.gemspec
 - tests/all.rb
+- tests/app_test.rb
 - tests/auth_test.rb
 - tests/magic_link_test.rb
 - tests/user_api_test.rb
@@ -85,7 +101,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/passage-identity/passage-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: Passage SDK for biometric authentication
 test_files: []

data/passage-ruby

@@ -1 +0,0 @@
-passage-ruby