Add unit tests to CI/CD and style updates

Author: karissarjacobsen

.github/workflows/rubyonrails.yml

@@ -0,0 +1,40 @@
+# This workflow uses actions that are not certified by GitHub.  They are
+# provided by a third-party and are governed by separate terms of service,
+# privacy policy, and support documentation.
+#
+# This workflow will install a prebuilt Ruby version, install dependencies, and
+# run tests and linters.
+name: "Ruby on Rails CI"
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.1.2
+
+      - name: Run linter
+        run: bundle exec rubocop --parallel
+
+      - name: Run tests
+        run: |
+          gem install docusign_esign
+          ruby test/run_tests.rb
+        env:
+          CLIENT_ID: ${{ secrets.CLIENT_ID }}
+          USER_ID: ${{ secrets.USER_ID }}
+          SIGNER_EMAIL: ${{ secrets.SIGNER_EMAIL }}
+          SIGNER_NAME: ${{ secrets.SIGNER_NAME }}
+          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+

.rubocop.yml

@@ -1,3 +1,15 @@
+AllCops:
+  Exclude:
+    - '**/db/**/*'
+    - '**/config/**/*'
+    - '**/test/**/*'
+    - '**/bin/**/*'
+    - '**/*test*'
+    - '**/vendor/**/*'
+
+Layout/EndOfLine:
+  Enabled: false
+
 Layout/LineLength:
   Enabled: false
 
@@ -7,6 +19,12 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
+Lint/EnsureReturn:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: single_quotes
 

.ruby-version

@@ -1 +1 @@
-2.7.2
+3.1.2

Gemfile

@@ -77,7 +77,6 @@ gem 'omniauth-oauth2', '~> 1.7.1'
 gem 'omniauth-rails_csrf_protection'
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'matrix', '~> 0.4.2'
 gem 'tzinfo-data', '~> 1.2022.1', '>= 1.2022.1'
 gem 'wdm', '>= 0.1.0', platforms: %i[mingw mswin x64_mingw]
-
-gem "matrix", "~> 0.4.2"

Gemfile.lock

@@ -142,7 +142,7 @@ GEM
     jbuilder (2.11.5)
       actionview (>= 5.0.0)
       activesupport (>= 5.0.0)
-    json (2.6.2)
+    json (2.6.3)
     jwt (2.5.0)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)

app/controllers/clickwrap/ceg006_embed_clickwrap_controller.rb

@@ -3,34 +3,32 @@ class Clickwrap::Ceg006EmbedClickwrapController < EgController
   before_action -> { @example = Utils::ManifestUtils.new.get_example(@manifest, 6, 'Click') }
 
   def create
-    begin
-      args = {
-        account_id: session[:ds_account_id],
-        base_path: session[:ds_base_path],
-        access_token: session[:ds_access_token],
-        clickwrap_id: params[:clickwrapId],
-        full_name: params[:fullName],
-        email: params[:email],
-        company: params[:company],
-        title: params[:title],
-        date: params[:date]
-      }
+    args = {
+      account_id: session[:ds_account_id],
+      base_path: session[:ds_base_path],
+      access_token: session[:ds_access_token],
+      clickwrap_id: params[:clickwrapId],
+      full_name: params[:fullName],
+      email: params[:email],
+      company: params[:company],
+      title: params[:title],
+      date: params[:date]
+    }
 
-      results = Clickwrap::Eg006EmbedClickwrapService.new(args).worker
+    results = Clickwrap::Eg006EmbedClickwrapService.new(args).worker
 
-      if results == nil
-        @error_code = '200'
-        @error_message = 'The email address was already used to agree to this elastic template. Provide a different email address if you want to view the agreement and agree to it.'
-        render 'ds_common/error'
-      else
-        @title = @example['ExampleName']
-        @message = format_string(@example['ResultsPageText'])
-        @agreementUrl = results["agreementUrl"]
-        render 'clickwrap/ceg006_embed_clickwrap/results'
-      end
-    rescue DocuSign_Click::ApiError => e
-      handle_error(e)
+    if results.nil?
+      @error_code = '200'
+      @error_message = 'The email address was already used to agree to this elastic template. Provide a different email address if you want to view the agreement and agree to it.'
+      render 'ds_common/error'
+    else
+      @title = @example['ExampleName']
+      @message = format_string(@example['ResultsPageText'])
+      @agreementUrl = results['agreementUrl']
+      render 'clickwrap/ceg006_embed_clickwrap/results'
     end
+  rescue DocuSign_Click::ApiError => e
+    handle_error(e)
   end
 
   def get

app/controllers/ds_common_controller.rb

@@ -10,7 +10,6 @@ def index
   end
 
   def handle_redirects
-    minimum_buffer_min = 10
     if Rails.configuration.quickstart
       @manifest = Utils::ManifestUtils.new.get_manifest(Rails.configuration.example_manifest_url)
 
@@ -19,9 +18,9 @@ def handle_redirects
         session[:quickstarted] = true
         redirect_to '/auth/docusign'
       elsif session[:been_here].nil?
-        enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).is_cfr(session[:ds_account_id])
-        if enableCFR == "enabled"
-          session[:status_cfr] = "enabled"
+        enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).cfr?(session[:ds_account_id])
+        if enableCFR == 'enabled'
+          session[:status_cfr] = 'enabled'
           @status_cfr = session[:status_cfr]
           redirect_to '/eeg041'
         else
@@ -31,24 +30,22 @@ def handle_redirects
         render_examples
       end
     elsif session[:ds_access_token].present?
-      if (!session[:api] || session[:api] == "eSignature")
-        enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).is_cfr(session[:ds_account_id])
-        if enableCFR == "enabled"
-          session[:status_cfr] = "enabled"
-        end
+      if !session[:api] || session[:api] == 'eSignature'
+        enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).cfr?(session[:ds_account_id])
+        session[:status_cfr] = 'enabled' if enableCFR == 'enabled'
       end
-        render_examples
+      render_examples
     else
       render_examples
     end
   end
 
   def render_examples
-    if(session[:ds_access_token].present? && !session[:status_cfr] && (!session[:api] || session[:api] == "eSignature"))
-      enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).is_cfr(session[:ds_account_id])
-      if enableCFR == "enabled"
-        @status_cfr = "enabled"
-        session[:status_cfr] = "enabled"
+    if session[:ds_access_token].present? && !session[:status_cfr] && (!session[:api] || session[:api] == 'eSignature')
+      enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).cfr?(session[:ds_account_id])
+      if enableCFR == 'enabled'
+        @status_cfr = 'enabled'
+        session[:status_cfr] = 'enabled'
       end
     else
       @status_cfr = session[:status_cfr]

app/controllers/e_sign/eeg014_collect_payment_controller.rb

@@ -5,37 +5,35 @@ class ESign::Eeg014CollectPaymentController < EgController
   before_action -> { @example = Utils::ManifestUtils.new.get_example(@manifest, 14, 'eSignature') }
 
   def create
-    begin
-      envelope_args = {
-        signer_email: param_gsub(params['signerEmail']),
-        signer_name: param_gsub(params['signerName']),
-        cc_email: param_gsub(params['ccEmail']),
-        cc_name: param_gsub(params['ccName']),
-        gateway_account_id: Rails.application.config.gateway_account_id,
-        gateway_name: Rails.application.config.gateway_name,
-        gateway_display_name: Rails.application.config.gateway_display_name
-      }
-      args = {
-        account_id: session['ds_account_id'],
-        base_path: session['ds_base_path'],
-        access_token: session['ds_access_token'],
-        envelope_args: envelope_args
-      }
+    envelope_args = {
+      signer_email: param_gsub(params['signerEmail']),
+      signer_name: param_gsub(params['signerName']),
+      cc_email: param_gsub(params['ccEmail']),
+      cc_name: param_gsub(params['ccName']),
+      gateway_account_id: Rails.application.config.gateway_account_id,
+      gateway_name: Rails.application.config.gateway_name,
+      gateway_display_name: Rails.application.config.gateway_display_name
+    }
+    args = {
+      account_id: session['ds_account_id'],
+      base_path: session['ds_base_path'],
+      access_token: session['ds_access_token'],
+      envelope_args: envelope_args
+    }
 
-      results = ESign::Eg014CollectPaymentService.new(args).worker
-      @title = @example['ExampleName']
-      @message = format_string(@example['ResultsPageText'], results[:envelope_id])
-      render 'ds_common/example_done'
-    rescue DocuSign_eSign::ApiError => e
-      handle_error(e)
-    end
+    results = ESign::Eg014CollectPaymentService.new(args).worker
+    @title = @example['ExampleName']
+    @message = format_string(@example['ResultsPageText'], results[:envelope_id])
+    render 'ds_common/example_done'
+  rescue DocuSign_eSign::ApiError => e
+    handle_error(e)
   end
 
   def get
-    enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).is_cfr(session[:ds_account_id])
-    if enableCFR == "enabled"
-      session[:status_cfr] = "enabled"
-      @title = "Not CFR Part 11 compatible"
+    enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).cfr?(session[:ds_account_id])
+    if enableCFR == 'enabled'
+      session[:status_cfr] = 'enabled'
+      @title = 'Not CFR Part 11 compatible'
       @error_information = @manifest['SupportingTexts']['CFRError']
       render 'ds_common/error'
     end

app/controllers/e_sign/eeg020_phone_authentication_controller.rb

@@ -41,10 +41,10 @@ def create
   end
 
   def get
-    enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).is_cfr(session[:ds_account_id])
-    if enableCFR == "enabled"
-      session[:status_cfr] = "enabled"
-      @title = "Not CFR Part 11 compatible"
+    enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).cfr?(session[:ds_account_id])
+    if enableCFR == 'enabled'
+      session[:status_cfr] = 'enabled'
+      @title = 'Not CFR Part 11 compatible'
       @error_information = @manifest['SupportingTexts']['CFRError']
       render 'ds_common/error'
     end

app/controllers/e_sign/eeg032_pauses_signature_workflow_controller.rb

@@ -27,10 +27,10 @@ def create
   end
 
   def get
-    enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).is_cfr(session[:ds_account_id])
-    if enableCFR == "enabled"
-      session[:status_cfr] = "enabled"
-      @title = "Not CFR Part 11 compatible"
+    enableCFR = ESign::GetDataService.new(session[:ds_access_token], session[:ds_base_path]).cfr?(session[:ds_account_id])
+    if enableCFR == 'enabled'
+      session[:status_cfr] = 'enabled'
+      @title = 'Not CFR Part 11 compatible'
       @error_information = @manifest['SupportingTexts']['CFRError']
       render 'ds_common/error'
     end