Devdocs 5748 (#49)

karissarjacobsen · web-flow · commit 05e033800b84 · 2021-11-16T11:13:27.000-08:00
* add step admin4 step 4 and update text

* working changes to dropdown api

* update config file

* routing constraints

* update routes

* update Gemfile

* remove debug statements

* updates to dropdown

* update routes

* remove export data

* Revert "update routes"

This reverts commit 4b680a53f0e088fa34a16086183ad8827fb97de7.

* Revert "remove export data"

This reverts commit 4d05ab7a6a3fb2e55969be5992f901e4dd60141c.

* update routes and remove data

* include banner when logged in

* include default session api type

* small quickstart related fix

* fix jwt issue
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -97,7 +97,7 @@ GEM
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
-    docusign_esign (3.13.0.rc1)
+    docusign_esign (3.13.0)
       addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
@@ -113,10 +113,10 @@ GEM
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
     erubi (1.10.0)
-    ethon (0.14.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
     execjs (2.8.1)
-    faraday (1.7.0)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -135,17 +135,17 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    ffi (1.15.3)
+    ffi (1.15.4)
     globalid (0.5.2)
       activesupport (>= 5.0)
     hashie (4.1.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     io-like (0.3.1)
     jbuilder (2.10.2)
       activesupport (>= 5.0.0)
-    json (2.5.1)
-    jwt (2.2.3)
+    json (2.6.1)
+    jwt (2.3.0)
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -154,9 +154,9 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
+    marcel (1.0.2)
     method_source (0.9.2)
-    mini_mime (1.1.1)
+    mini_mime (1.1.2)
     minitest (5.14.4)
     msgpack (1.4.2)
     multi_json (1.15.0)
@@ -177,7 +177,7 @@ GEM
       hashie (>= 3.4.6)
       rack (>= 1.6.2, < 3)
       rack-protection
-    omniauth-oauth2 (1.7.1)
+    omniauth-oauth2 (1.7.2)
       oauth2 (~> 1.4)
       omniauth (>= 1.9, < 3)
     omniauth-rails_csrf_protection (1.0.0)
@@ -191,9 +191,9 @@ GEM
     pry-rails (0.3.9)
       pry (>= 0.10.4)
     public_suffix (4.0.6)
-    puma (4.3.9)
+    puma (4.3.10)
       nio4r (~> 2.0)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-protection (2.1.0)
       rack
@@ -279,7 +279,7 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-darwin-20
diff --git a/app/controllers/ds_common_controller.rb b/app/controllers/ds_common_controller.rb
@@ -6,22 +6,33 @@ class DsCommonController < ApplicationController
 
   def index
     @show_doc = Rails.application.config.documentation
-    if Rails.configuration.examples_API['Rooms']
+    if session[:examples_API] == 'Rooms'
       render 'room_api/index'
-    elsif Rails.configuration.examples_API['Click']
+    elsif session[:examples_API] == 'Click'
       render 'clickwrap/index'
-    elsif Rails.configuration.examples_API['Monitor']
+    elsif session[:examples_API] == 'Monitor'
       render 'monitor_api/index'
-    elsif Rails.configuration.examples_API['Admin']
+    elsif session[:examples_API] == 'Admin'
       render 'admin_api/index'
     else
+      session[:examples_API] = 'eSignature'
       @show_doc = Rails.application.config.documentation
       if Rails.configuration.quickstart && session[:been_here].nil?
         redirect_to '/eg001'
       end
     end
   end
 
+  def choose_api
+    render 'ds_common/choose_api'
+  end
+
+  def api_selected
+    session.delete :eg
+    session[:examples_API] = params[:chosen_api]
+    redirect_to '/ds/mustAuthenticate'
+  end
+
   def ds_return
     # To break out of the Quickstart loop an example has been completed
     session[:been_here] = true
@@ -32,17 +43,17 @@ def ds_return
   end
 
   def ds_must_authenticate
-    if Rails.configuration.examples_API['Monitor']
+    if session[:examples_API] == 'Monitor'
       jwt_auth
     end
-    if Rails.configuration.quickstart
-      redirect_to('/auth/docusign')
+    if Rails.configuration.quickstart and session[:been_here].nil? and session[:examples_API] == 'eSignature'
+      redirect_to "/auth/docusign"
     end
     @title = 'Authenticate with DocuSign'
     @show_doc = Rails.application.config.documentation
 
     if params[:auth] == 'grand-auth'
-      redirect_to('/auth/docusign')
+      redirect_to "/auth/docusign"
     elsif params[:auth] == 'jwt-auth'
       jwt_auth
     end
@@ -57,16 +68,16 @@ def jwt_auth
       end
     else
       session['omniauth.state'] = SecureRandom.hex
-      url = JwtAuth::JwtCreator.consent_url(session['omniauth.state'])
+      url = JwtAuth::JwtCreator.consent_url(session['omniauth.state'], session['examples_API'])
     redirect_to root_path if session[:token].present?
     end
-    if Rails.configuration.examples_API['Rooms']
+    if session[:examples_API] == 'Rooms'
       configuration = DocuSign_Rooms::Configuration.new
       api_client = DocuSign_Rooms::ApiClient.new(configuration)
-    elsif Rails.configuration.examples_API['Click']
+    elsif session[:examples_API] == 'Click'
       configuration = DocuSign_Click::Configuration.new
       api_client = DocuSign_Click::ApiClient.new configuration
-    elsif Rails.configuration.examples_API['Admin']
+    elsif session[:examples_API] == 'Admin'
       configuration = DocuSign_Admin::Configuration.new
       api_client = DocuSign_Admin::ApiClient.new configuration
     end
diff --git a/app/controllers/session_controller.rb b/app/controllers/session_controller.rb
@@ -24,6 +24,10 @@ def destroy
     redirect_to root_path
   end
 
+  # def switch_api
+  #   internal_destroy
+  # end
+
   # GET /auth/failure
   def omniauth_failure
     error_msg = "OmniAuth authentication failure message: #{params[:message]} for strategy: #{params[:strategy]} and HTTP_REFERER: #{params[:origin]}"
diff --git a/app/services/admin_api/get_data_service.rb b/app/services/admin_api/get_data_service.rb
@@ -32,7 +32,6 @@ def get_ds_groups
 
     def get_organization_id
       worker
-      puts "\n\n getting org_id \n\n"
       accounts_api = DocuSign_Admin::AccountsApi.new(@api_client)
       accounts_api.get_organizations().organizations[0].as_json['id']
     end
diff --git a/app/services/jwt_auth/jwt_creator.rb b/app/services/jwt_auth/jwt_creator.rb
@@ -9,16 +9,16 @@ class JwtCreator
     # DocuSign authorization URI to obtain individual consent
     # https://developers.docusign.com/platform/auth/jwt/jwt-get-token
     # https://developers.docusign.com/platform/auth/consent/obtaining-individual-consent/
-    def self.consent_url(state)
+    def self.consent_url(state, examples_API)
       # GET /oauth/auth
       # This endpoint is used to obtain consent and is the first step in several authentication flows.
       # https://developers.docusign.com/platform/auth/reference/obtain-consent
       scope = "signature"
-      if Rails.configuration.examples_API['Rooms']
+      if examples_API == 'Rooms'
         scope = "signature dtr.rooms.read dtr.rooms.write dtr.documents.read dtr.documents.write dtr.profile.read dtr.profile.write dtr.company.read dtr.company.write room_forms"
-      elsif Rails.configuration.examples_API['Click']
+      elsif examples_API == 'Click'
         scope = "signature click.manage click.send"
-      elsif Rails.configuration.examples_API['Admin']
+      elsif examples_API == 'Admin'
         scope = "signature organization_read group_read permission_read user_read user_write account_read domain_read identity_provider_read"
       end
       scope = "#{scope} impersonation"
@@ -36,15 +36,15 @@ def initialize(session)
       @session = session
       scope = "signature"
       @client_module = DocuSign_eSign
-      if Rails.configuration.examples_API['Rooms']
+      if session[:examples_API] == 'Rooms'
         scope = "signature dtr.rooms.read dtr.rooms.write dtr.documents.read dtr.documents.write dtr.profile.read dtr.profile.write dtr.company.read dtr.company.write room_forms"
         @client_module = DocuSign_Rooms
-      elsif Rails.configuration.examples_API['Click']
+      elsif session[:examples_API] == 'Click'
         scope = "signature click.manage click.send"
         @client_module = DocuSign_Click
-      elsif Rails.configuration.examples_API['Monitor']
+      elsif session[:examples_API] == 'Monitor'
         @client_module = DocuSign_Monitor
-      elsif Rails.configuration.examples_API['Admin']
+      elsif session[:examples_API] == 'Admin'
         scope = "signature organization_read group_read permission_read user_read user_write account_read domain_read identity_provider_read"
         @client_module = DocuSign_Admin
       end
@@ -69,6 +69,11 @@ def check_jwt_token
         end
       rescue @client_module::ApiError => exception
         Rails.logger.warn exception.inspect
+
+        if exception.response_body == nil
+          return false
+        end
+
         body = JSON.parse(exception.response_body)
 
         if body['error'] == "consent_required"
diff --git a/app/views/clickwrap/index.html.erb b/app/views/clickwrap/index.html.erb
@@ -1,5 +1,4 @@
-<% if !session[:ds_user_name] %>
-<!-- IF not signed in -->
+
 <div class="container-fill-bg header-div">
 <div class="jumbotron jumbotron-fluid">
   <table>
@@ -18,7 +17,6 @@
 </div>
 
 </div>
-<% end %>
 
   <div class="container body-div" id="index-page">
     <h2>Welcome</h2>
diff --git a/app/views/ds_common/choose_api.erb b/app/views/ds_common/choose_api.erb
@@ -0,0 +1,19 @@
+<div style="margin:1% 5%;">
+  <h1 class="display-4">Please Choose an API</h1>
+  <p class="lead">
+    <form class="eg" action="/ds/apiSelected" method="POST"  data-busy="form">
+     <%= hidden_field_tag :authenticity_token, form_authenticity_token %>
+      <div class="form-group">
+        <select id="chosen_api" name="chosen_api" class="form-control">
+          <option value="eSignature" selected>eSignature</option>
+          <option value="Rooms">Rooms</option>
+          <option value="Click">Click</option>
+          <option value="Monitor">Monitor</option>
+          <option value="Admin">Admin</option>
+        </select><br>
+        <button class="btn btn-docu btn-lg">Choose your desired API</button>
+      </div>
+    </form>
+  </p>
+  <hr class="my-4">
+</div>
diff --git a/app/views/ds_common/ds_must_authenticate.erb b/app/views/ds_common/ds_must_authenticate.erb
@@ -5,7 +5,7 @@
      <%= hidden_field_tag :authenticity_token, form_authenticity_token %>
       <div class="form-group">
         <select id="auth" name="auth" class="form-control">
-          <% unless Rails.configuration.examples_API['Monitor'] %>
+          <% unless session[:examples_API] == 'Monitor' %>
           <option value="grand-auth" selected>Authorization Code grant</option>
           <% end %>
           <option value="jwt-auth">JSON Web Token (JWT) grant</option>
diff --git a/app/views/layouts/_head.erb b/app/views/layouts/_head.erb
@@ -45,6 +45,9 @@
         <a class="nav-link" href="/ds/mustAuthenticate">Login <span class="sr-only">(current)</span></a>
       </li>
       <% end  %>
+      <li class="nav-item active">
+        <a class="nav-link" href="/ds/chooseApi">Choose API <span class="sr-only">(current)</span></a>
+      </li>
     </ul>
 
     <% if session["ds_user_name"] %>
@@ -82,4 +85,3 @@
     <section id="content" class="container-full-bg">
   <% end %>
   <% end %>
-
diff --git a/app/views/room_api/index.html.erb b/app/views/room_api/index.html.erb
@@ -1,24 +1,22 @@
-<% if !session[:ds_user_name] %>
-  <!-- IF not signed in -->
-  <div class="container-fill-bg header-div">
-    <div class="jumbotron jumbotron-fluid">
-      <table>
-        <tbody>
-        <tr>
-          <td>
-            <h1 class="display-4">Ruby Launcher</h1>
-            <p class="Xlead">Welcome to the DocuSign Ruby examples using multiple OAuth flows (JWT and Authorization
-              Code Grant).</p>
-          </td>
-          <td>
-            <img src="banner-code.png"/>
-          </td>
-        </tr>
-        </tbody>
-      </table>
-    </div>
+
+<div class="container-fill-bg header-div">
+  <div class="jumbotron jumbotron-fluid">
+    <table>
+      <tbody>
+      <tr>
+        <td>
+          <h1 class="display-4">Ruby Launcher</h1>
+          <p class="Xlead">Welcome to the DocuSign Ruby examples using multiple OAuth flows (JWT and Authorization
+            Code Grant).</p>
+        </td>
+        <td>
+          <img src="banner-code.png"/>
+        </td>
+      </tr>
+      </tbody>
+    </table>
   </div>
-<% end %>
+</div>
 
 <div class="container body-div" id="index-page">
   <h2>Welcome</h2>
diff --git a/config/appsettings.example.yml b/config/appsettings.example.yml
@@ -4,13 +4,6 @@ default: &default
   app_url: http://localhost:3000
   # quickstart is an optional setting and can be enabled by setting it to: true
   quickstart: {QUICKSTART_VALUE}
-  # Set only one examples_API type to 'true' and set the remaining to 'false'.
-  examples_API:
-    eSignature: true
-    Rooms: false
-    Click: false
-    Monitor: false
-    Admin: false
   # NOTE: The terms "client_id" and "Integration key" are synonyms. They refer to the same thing
   # The integration_key value is the same between the development account and production account
   integration_key: {INTEGRATION_KEY_AUTH_CODE}
diff --git a/config/initializers/omniauth.rb b/config/initializers/omniauth.rb
@@ -23,6 +23,11 @@
   # OAuth2 login response callback message configuration is in OmniAuth::Strategies::Docusign in lib/docusign.rb
   provider :docusign, config.integration_key, config.integration_secret, setup: lambda { |env|
     strategy = env['omniauth.strategy']
+
+    # params = strategy.request.params
+    # examples_API = params['examples_API']
+    # strategy.request.params.delete('examples_API')
+
     strategy.options[:client_options].site = config.app_url
     strategy.options[:prompt] = 'login'
     strategy.options[:oauth_base_uri] = config.authorization_server
@@ -34,11 +39,13 @@
     unless strategy.options[:allow_silent_authentication]
       strategy.options[:authorize_params].prompt = strategy.options.prompt
     end
-    if Rails.configuration.examples_API['Rooms']
+    session = strategy.session
+
+    if session[:examples_API] == "Rooms"
       strategy.options[:authorize_params].scope = "signature dtr.rooms.read dtr.rooms.write dtr.documents.read dtr.documents.write dtr.profile.read dtr.profile.write dtr.company.read dtr.company.write room_forms"
-    elsif Rails.configuration.examples_API['Click']
+    elsif session[:examples_API] == "Click"
       strategy.options[:authorize_params].scope = "signature click.manage click.send"
-    elsif Rails.configuration.examples_API['Admin']
+    elsif session[:examples_API] == "Admin"
       strategy.options[:authorize_params].scope = "signature organization_read group_read permission_read user_read user_write account_read domain_read identity_provider_read"
     end
   }
diff --git a/config/routes.rb b/config/routes.rb
