refactored code

Author: karissarjacobsen

Gemfile

@@ -3,14 +3,14 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '~>2.7.2'
+ruby '~>3.0.2'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6.0.4.1'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3', '~> 1.4.2'
 # Use Puma as the app server
-gem 'puma', '~> 4.3.9'
+gem 'puma', '~> 4.3.11'
 # Use SCSS for stylesheets
 gem 'sass-rails', '~> 6.0.0'
 # Use Uglifier as compressor for JavaScript assets
@@ -49,7 +49,7 @@ end
 
 group :development do
   # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
-  gem 'listen', '~> 3.2.1'
+  gem 'listen', '> 3.2.1'
   gem 'web-console', '~> 4.0.1'
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'pry-nav', '~> 0.3.0'
@@ -77,3 +77,5 @@ gem 'omniauth-rails_csrf_protection'
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', '~> 1.2019.3', platforms: %i[mingw mswin x64_mingw jruby]
 gem 'wdm', '>= 0.1.0', platforms: %i[mingw mswin x64_mingw]
+
+gem "webrick", "~> 1.7"

Gemfile.lock

@@ -113,7 +113,7 @@ GEM
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
     erubi (1.10.0)
-    ethon (0.15.0)
+    ethon (0.14.0)
       ffi (>= 1.15.0)
     execjs (2.8.1)
     faraday (1.9.3)
@@ -140,6 +140,7 @@ GEM
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
     ffi (1.15.5)
+    ffi (1.15.5-x64-mingw32)
     globalid (1.0.0)
       activesupport (>= 5.0)
     hashie (5.0.0)
@@ -148,17 +149,17 @@ GEM
     io-like (0.3.1)
     jbuilder (2.10.2)
       activesupport (>= 5.0.0)
-    json (2.6.1)
-    jwt (2.3.0)
-    listen (3.2.1)
+    json (2.5.1)
+    jwt (2.2.3)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.2)
+    marcel (1.0.1)
     method_source (0.9.2)
     mini_mime (1.1.2)
     minitest (5.15.0)
@@ -167,6 +168,8 @@ GEM
     multi_xml (0.6.0)
     multipart-post (2.1.1)
     nio4r (2.5.8)
+    nokogiri (1.13.1-x64-mingw32)
+      racc (~> 1.4)
     nokogiri (1.13.1-x86_64-darwin)
       racc (~> 1.4)
     nokogiri (1.13.1-x86_64-linux)
@@ -181,7 +184,7 @@ GEM
       hashie (>= 3.4.6)
       rack (>= 1.6.2, < 3)
       rack-protection
-    omniauth-oauth2 (1.7.2)
+    omniauth-oauth2 (1.7.1)
       oauth2 (~> 1.4)
       omniauth (>= 1.9, < 3)
     omniauth-rails_csrf_protection (1.0.0)
@@ -195,9 +198,9 @@ GEM
     pry-rails (0.3.9)
       pry (>= 0.10.4)
     public_suffix (4.0.6)
-    puma (4.3.10)
+    puma (4.3.11)
       nio4r (~> 2.0)
-    racc (1.6.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-protection (2.1.0)
       rack
@@ -240,6 +243,8 @@ GEM
       sassc-rails (~> 2.1, >= 2.1.1)
     sassc (2.4.0)
       ffi (~> 1.9)
+    sassc (2.4.0-x64-mingw32)
+      ffi (~> 1.9)
     sassc-rails (2.1.2)
       railties (>= 4.0.0)
       sassc (>= 2.0)
@@ -271,13 +276,17 @@ GEM
       ethon (>= 0.9.0)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
+    tzinfo-data (1.2019.3)
+      tzinfo (>= 1.0.0)
     uglifier (4.2.0)
       execjs (>= 0.3.0, < 3)
+    wdm (0.1.1)
     web-console (4.0.4)
       actionview (>= 6.0.0)
       activemodel (>= 6.0.0)
       bindex (>= 0.4.0)
       railties (>= 6.0.0)
+    webrick (1.7.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -286,6 +295,7 @@ GEM
     zeitwerk (2.5.3)
 
 PLATFORMS
+  x64-mingw32
   x86_64-darwin-20
   x86_64-linux
 
@@ -301,12 +311,12 @@ DEPENDENCIES
   docusign_monitor (~> 1.0.0)
   docusign_rooms (~> 1.2.0.rc1)
   jbuilder (~> 2.10.0)
-  listen (~> 3.2.1)
+  listen (> 3.2.1)
   omniauth-oauth2 (~> 1.7.1)
   omniauth-rails_csrf_protection
   pry-nav (~> 0.3.0)
   pry-rails (~> 0.3.9)
-  puma (~> 4.3.9)
+  puma (~> 4.3.11)
   rails (~> 6.0.4.1)
   sass-rails (~> 6.0.0)
   selenium-webdriver (~> 3.142.7)
@@ -318,9 +328,10 @@ DEPENDENCIES
   uglifier (~> 4.2.0)
   wdm (>= 0.1.0)
   web-console (~> 4.0.1)
+  webrick (~> 1.7)
 
 RUBY VERSION
-   ruby 2.7.2p137
+   ruby 3.0.2p107
 
 BUNDLED WITH
-   2.2.16
+   2.2.31

README.md

@@ -61,7 +61,7 @@ For a list of code examples that use the Admin API, select the Ruby tab under [E
 
    To use [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/), you will need an integration key and a secret key. See [Installation steps](#installation-steps) for details.
 
-   To use [JWT Grant](https://developers.docusign.com/platform/auth/jwt/), you will need an integration key, an RSA key pair, and the API Username GUID of the impersonated user. See [Installation steps for JWT Grant authentication](#installation-steps-for-jwt-grant-authentication) for details.
+   To use [JWT Grant](https://developers.docusign.com/platform/auth/jwt/), you will need an integration key, an RSA key pair, and the User ID GUID of the impersonated user. See [Installation steps for JWT Grant authentication](#installation-steps-for-jwt-grant-authentication) for details.
 
    For both authentication flows:
 
@@ -110,7 +110,7 @@ Also, in order to select JSON Web Token authentication in the launcher, in confi
    `cd <Quickstart folder>` or `cd code-examples-ruby`
 1. Install the dependencies: `bundler install`
 1. To configure the launcher for [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication, create a copy of the file config/appsettings.example.yml and save the copy as config/appsettings.yml.
-   1. Add your API Username. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **API Username** GUID and save it in appsettings.yml as your `impersonated_user_guid`.
+   1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in appsettings.yml as your `impersonated_user_guid`.
    1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions** > **Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in appsettings.yml as your `jwt_integration_key`.
    1. Generate an RSA key pair, if you don’t already have one. Under **Authentication**, select **+ GENERATE RSA**. Copy the private key and save it in a new file named config/docusign_private_key.txt.
    1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of http://localhost:3000/auth/docusign/callback. Select **SAVE**.

app/assets/images/favicon.ico

@@ -4,18 +4,42 @@ class AdminApi::Eg001CreateUserController < EgController
 
   def create
     begin
-      results = AdminApi::Eg001CreateUserService.new(session, request).call
+      args = {
+        account_id: session['ds_account_id'],
+        base_path: session['ds_base_path'],
+        access_token: session['ds_access_token'],
+        organization_id: session['organization_id']
+      }
+      user_data = {
+        user_name: param_gsub(params['user_name']),
+        first_name: param_gsub(params['first_name']),
+        last_name: param_gsub(params['last_name']),
+        email: param_gsub(params['email']),
+        auto_activate_memberships: true,
+        accounts: [
+          {
+            id: args[:account_id],
+            permission_profile: {
+              id: request['permission_profile_id']
+            },
+            groups: [
+              {
+                id: request['group_id']
+              }
+            ]
+          }
+        ]
+      }
+
+      results = AdminApi::Eg001CreateUserService.new(args, user_data).worker
 
       @title = 'Create a new active eSignature user'
       @h1 = 'Create a new active eSignature user'
       @message = "Results from eSignUserManagement:createUser method:"
       @json = results.to_json.to_json
       render 'ds_common/example_done'
     rescue DocuSign_Admin::ApiError => e
-      error = JSON.parse e.response_body
-      @error_code = e.code
-      @error_message = error['error_description']
-      render 'ds_common/error'
+      handle_error(e)
     end
   end
 
@@ -37,14 +61,4 @@ def get
     @groups = groups_api.list_groups(args[:account_id]).groups
   end
 
-  private
-
-  def check_auth
-    minimum_buffer_min = 10
-    token_ok = check_token(minimum_buffer_min)
-    unless token_ok
-      flash[:messages] = 'Sorry, you need to re-authenticate.'
-      redirect_to '/ds/mustAuthenticate'
-    end
-  end
 end

app/controllers/admin_api/eg001_create_user_controller.rb

@@ -3,7 +3,23 @@ class AdminApi::Eg002CreateActiveClmEsignUserController < EgController
 
     def create
       begin
-        results = AdminApi::Eg002CreateActiveClmEsignUserService.new(session, request).call
+        args = {
+          user_name: params[:user_name],
+          first_name: params[:first_name],
+          last_name: params[:last_name],
+          email: params[:email],
+          clm_permission_profile_id:  params[:clm_permission_profile_id],
+          esign_permission_profile_id:  params[:esign_permission_profile_id],
+          clm_product_id: params[:clm_product_id],
+          esign_product_id: params[:esign_product_id],
+          ds_group_id:  params[:ds_group_id],
+          account_id: session[:ds_account_id],
+          organization_id: session['organization_id'],
+          base_path: session[:ds_base_path],
+          access_token: session[:ds_access_token]
+        }
+
+        results = AdminApi::Eg002CreateActiveClmEsignUserService.new(args).worker
 
         @title = "Create a new active user for CLM and eSignature"
         @h1 = "Create a new active user for CLM and eSignature"
@@ -12,10 +28,7 @@ def create
 
         render 'ds_common/example_done'
       rescue DocuSign_Admin::ApiError => e
-        error = JSON.parse e.response_body
-        @error_code = e.code
-        @error_message = error['error_description']
-        render 'ds_common/error'
+        handle_error(e)
       end
     end
 
@@ -37,17 +50,4 @@ def get
       end
       @ds_groups = AdminApi::GetDataService.new(session).get_ds_groups
     end
-
-    private
-
-    def check_auth
-      minimum_buffer_min = 10
-      token_ok = check_token(minimum_buffer_min)
-      unless token_ok
-        flash[:messages] = 'Sorry, you need to re-authenticate.'
-        # We could store the parameters of the requested operation so it could be restarted automatically
-        # But since it should be rare to have a token issue here, we'll make the user re-enter the form data after authentication
-        redirect_to '/ds/mustAuthenticate'
-      end
-    end
   end

app/controllers/admin_api/eg002_create_active_clm_esign_user_controller.rb

@@ -9,29 +9,27 @@ def create
     file_path = File.expand_path(File.join(File.dirname(__FILE__), '../../../data/exportedUserData.csv'))
 
     begin
-      results = AdminApi::Eg003BulkExportUserDataService.new(session, request, file_path).call
+      request_body = {
+        type: 'organization_memberships_export'
+      }
+      args = {
+        account_id: session['ds_account_id'],
+        base_path: session['ds_base_path'],
+        access_token: session['ds_access_token'],
+        organization_id: session['organization_id'],
+        file_path: file_path,
+        request_body: request_body
+      }
+
+      results = AdminApi::Eg003BulkExportUserDataService.new(args).worker
 
       @title = 'Bulk-export user data'
       @h1 = 'Bulk-export user data'
       @message = "User data exported to #{file_path}. </br> Results from UserExport::getUserListExport method:"
       @json = results.to_json.to_json
       render 'ds_common/example_done'
     rescue DocuSign_Admin::ApiError => e
-      error = JSON.parse e.response_body
-      @error_code = e.code
-      @error_message = error['error_description']
-      render 'ds_common/error'
-    end
-  end
-
-  private
-
-  def check_auth
-    minimum_buffer_min = 10
-    token_ok = check_token(minimum_buffer_min)
-    unless token_ok
-      flash[:messages] = 'Sorry, you need to re-authenticate.'
-      redirect_to '/ds/mustAuthenticate'
+      handle_error(e)
     end
   end
 end

app/controllers/admin_api/eg003_bulk_export_user_data_controller.rb

@@ -9,7 +9,15 @@ def create
     file_path = File.expand_path(File.join(File.dirname(__FILE__), '../../../data/userData.csv'))
 
     begin
-      results = AdminApi::Eg004ImportUserService.new(session, request, file_path).call
+      args = {
+        account_id: session['ds_account_id'],
+        base_path: session['ds_base_path'],
+        access_token: session['ds_access_token'],
+        organization_id: session['organization_id'],
+        csv_file_path: file_path
+      }
+
+      results = AdminApi::Eg004ImportUserService.new(args).worker
       session[:import_id] = results.id
 
       @title = 'Add users via bulk import'
@@ -19,10 +27,7 @@ def create
       @json = results.to_json.to_json
       render 'ds_common/example_done'
     rescue DocuSign_Admin::ApiError => e
-      error = JSON.parse e.response_body
-      @error_code = e.code
-      @error_message = error['error_description']
-      render 'ds_common/error'
+      handle_error(e)
     end
   end
 
@@ -48,15 +53,4 @@ def check_status
       render 'ds_common/error'
     end
   end
-
-  private
-
-  def check_auth
-    minimum_buffer_min = 10
-    token_ok = check_token(minimum_buffer_min)
-    unless token_ok
-      flash[:messages] = 'Sorry, you need to re-authenticate.'
-      redirect_to '/ds/mustAuthenticate'
-    end
-  end
 end