Feature/sup 303 ruby add mfa example app (#20)

* upgrades to ruby 2.7 and also adds most style changes with most session management in place

* removes .DS_Store files

* fully fleshed out app with styling

* adds README with updated steps

Author: adamzinder

.DS_Store

@@ -2,6 +2,7 @@
 require 'sinatra'
 require 'workos'
 require 'json'
+require 'pry'
 
 $organization
 
@@ -17,7 +18,7 @@
     organizations = WorkOS::Organizations.list_organizations(
         domains: domains
       )
-    
+    binding.pry
     if organizations.data.length == 0 
         $organization = WorkOS::Organizations.create_organization(
             name: organizationName,
@@ -36,7 +37,7 @@
     organization_id = $organization.id  # ... The ID of the organization to start an Admin Portal session for
     link = WorkOS::Portal.generate_link(
       organization: organization_id,
-      intent: 'sso',
+      intent: 'dsync',
     )
     redirect link
 end

ruby-admin-portal-example/app.rb

@@ -0,0 +1,2 @@
+WORKOS_API_KEY=<Replace with your key>
+WORKOS_CLIENT_ID=<Replace with your client ID>

ruby-mfa-example/.env.example

@@ -0,0 +1 @@
+.env

ruby-mfa-example/.gitignore

@@ -0,0 +1 @@
+2.7.1

ruby-mfa-example/.ruby-version

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'dotenv'
+gem 'sinatra'
+gem 'workos'
+gem 'pry'

ruby-mfa-example/Gemfile

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    dotenv (2.7.6)
+    method_source (1.0.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rack-protection (2.2.0)
+      rack
+    ruby2_keywords (0.0.5)
+    sinatra (2.2.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.0)
+      tilt (~> 2.0)
+    sorbet-runtime (0.5.9859)
+    tilt (2.0.10)
+    workos (2.2.0)
+      sorbet-runtime (~> 0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  pry
+  sinatra
+  workos
+
+BUNDLED WITH
+   2.1.4

ruby-mfa-example/Gemfile.lock

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 WorkOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ruby-mfa-example/LICENSE

@@ -0,0 +1,32 @@
+# ruby-mfa-example
+
+An example Sinatra application demonstrating how Magic Link works with WorkOS and Ruby.
+
+## Clone and Install
+
+1. Clone the main repo:
+
+```sh
+git clone https://github.com/workos-inc/ruby-example-applications.git
+```
+
+2. Navigate to the MFA app within the main repo and install dependencies:
+
+```sh
+cd ruby-example-applications/ruby-mfa-example && bundle install
+```
+
+## Configure your environment
+
+1. Grab your [API Key](https://dashboard.workos.com/api-keys) and your [Client ID](https://dashboard.workos.com/configuration).
+2. Run `cp .env.example .env` and add your API key and Client ID. The `workos` gem will read your API key from the ENV variable `WORKOS_API_KEY` and your Client ID from the ENV variable `WORKOS_CLIENT_ID`. You may also set the API key and Client ID yourself by adding `WorkOS.key = $YOUR_API_KEY` and `CLIENT_ID = $YOUR_CLIENT_ID` to `app.rb`.
+
+## Run the app 
+
+```sh
+ruby app.rb
+```
+
+Head to `http://localhost:4567` and you're all set!
+
+For more information, see the [WorkOS Ruby SDK documentation](https://docs.workos.com/sdk/ruby).

ruby-mfa-example/README.md

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'sinatra'
+require 'workos'
+require 'json'
+require 'pry'
+use Rack::Session::Pool
+
+# Pull API key from ENV variable
+WorkOS.key = ENV['WORKOS_API_KEY']
+
+# Configure your Redirect URIs on the dashboard configuration
+# page: https://dashboard.workos.com/sso/configuration
+
+
+get '/' do
+  if session[:factor_list].nil?
+    session[:factor_list] ||= []
+    @factors = session[:factor_list] 
+    session[:current_factor_qr] = ''
+    session[:phone_number] = ''
+    erb :index, :layout => :layout
+  else
+    @factors=session[:factor_list]
+    erb :index, :layout => :layout
+  end
+end
+
+
+get '/enroll_factor_details' do
+  erb :enroll_factor, :layout => :layout
+end
+
+post '/enroll_factor' do
+  factor_type = params[:type]
+  totp_issuer = params[:totp_issuer]
+  totp_user = params[:totp_user]
+  phone_number = params[:phone_number]
+
+  
+  new_factor = WorkOS::MFA.enroll_factor(
+    type: factor_type,
+    phone_number: phone_number,
+    totp_issuer: totp_issuer,
+    totp_user: totp_user
+    )
+  session[:factor_list] << new_factor 
+  @factors = session[:factor_list]
+  redirect '/'
+end
+
+get '/factor_detail' do
+  factors = session[:factor_list]
+  @factor  = factors.select {|factor| factor.id == params[:id] }.first
+  if @factor.type == 'sms'
+    @phone_number = @factor .sms[:phone_number]
+    session[:phone_numer] = @phone_number
+  elsif  @factor.type == 'totp' 
+    @current_factor_qr = @factor.totp[:qr_code]
+    session[:current_factor_qr] = @current_factor_qr
+  end
+  session[:current_factor] = @factor.id
+  session[:current_factor_type] = @factor.type
+  erb :factor_detail, :layout => :layout
+end
+
+post '/challenge_factor' do
+  if session[:current_factor_type] == 'sms'
+    message = params[:sms_message]
+    session[:message] = message
+    challenge = WorkOS::MFA.challenge_factor(
+      authentication_factor_id: session[:current_factor],
+      sms_template: message,
+    )
+  else
+    challenge = WorkOS::MFA.challenge_factor(
+      authentication_factor_id: session[:current_factor],
+    )
+  end
+  session[:challenge_id] = challenge.id
+
+  erb :challenge_factor, :layout => :layout
+end
+
+post '/verify_factor' do
+  code = params[:code]
+  challenge_id = session[:challenge_id]
+  verify_factor = WorkOS::MFA.verify_factor(
+    authentication_challenge_id: challenge_id,
+    code: code
+  )
+  @challenge = verify_factor.challenge
+  @valid = verify_factor.valid
+  @type = session[:type]
+  erb :challenge_success, :layout => :layout
+end
+
+get '/clear_session' do
+  session.clear
+  redirect '/'
+end