Feature/code examples refactoring (#50)

* esign examples refactored

* updated eg011

* click refactored

* rooms refactored

* monitor refactored

* admin examples refactored

* refactored esign examples & updated scopes

* added methods to parent controllers

* added initialize method

* fixed worker call

* fixed error handling

* removed return statement

Author: RomanBachaloSigmaSoftware

app/controllers/admin_api/eg001_create_user_controller.rb

@@ -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/eg002_create_active_clm_esign_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/eg003_bulk_export_user_data_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/eg004_import_user_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

app/controllers/admin_api/eg005_audit_users_controller.rb

@@ -7,7 +7,14 @@ def create
       end
 
       begin
-        results = AdminApi::Eg005AuditUsersService.new(session, request).call
+        args = {
+          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::Eg005AuditUsersService.new(args).worker
 
         @title = "Audit users"
         @h1 = "Audit users"
@@ -16,23 +23,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'
-      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.'
-        # 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'
+        handle_error(e)
       end
     end
   end

app/controllers/clickwrap/eg001_create_clickwrap_controller.rb

@@ -2,7 +2,14 @@ class Clickwrap::Eg001CreateClickwrapController < EgController
   before_action :check_auth
 
   def create
-    results = Clickwrap::Eg001CreateClickwrapService.new(session, request).call
+    args = {
+      account_id: session[:ds_account_id],
+      base_path: session[:ds_base_path],
+      access_token: session[:ds_access_token],
+      clickwrap_name: request[:clickwrapName]
+    }
+
+    results = Clickwrap::Eg001CreateClickwrapService.new(args).worker
 
     session[:clickwrap_id] = results.clickwrap_id
     session[:clickwrap_name] = results.clickwrap_name
@@ -13,15 +20,4 @@ def create
     @json = results.to_json.to_json
     render 'ds_common/example_done'
   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/clickwrap/eg002_activate_clickwrap_controller.rb

@@ -2,22 +2,18 @@ class Clickwrap::Eg002ActivateClickwrapController < EgController
   before_action :check_auth
 
   def create
-    results = Clickwrap::Eg002ActivateClickwrapService.new(session).call
+    args = {
+      account_id: session[:ds_account_id],
+      base_path: session[:ds_base_path],
+      access_token: session[:ds_access_token],
+      clickwrap_id: session[:clickwrap_id]
+    }
+
+    results = Clickwrap::Eg002ActivateClickwrapService.new(args).worker
 
     @title = 'Activating a new clickwrap'
     @h1 = 'Activating a new clickwrap'
     @message = "The clickwrap #{results.clickwrap_name} has been activated"
     render 'ds_common/example_done'
   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/clickwrap/eg003_create_new_clickwrap_version_controller.rb

@@ -2,22 +2,19 @@ class Clickwrap::Eg003CreateNewClickwrapVersionController < EgController
   before_action :check_auth
 
   def create
-    results = Clickwrap::Eg003CreateNewClickwrapVersionService.new(session).call
+    args = {
+      account_id: session[:ds_account_id],
+      base_path: session[:ds_base_path],
+      access_token: session[:ds_access_token],
+      clickwrap_id: session[:clickwrap_id],
+      clickwrap_name: session[:clickwrap_name]
+    }
+
+    results = Clickwrap::Eg003CreateNewClickwrapVersionService.new(args).worker
     puts results.to_json.to_json
     @title = 'Creating a new clickwrap version'
     @h1 = 'Creating a new clickwrap version'
     @message = "Version #{results.version_number} of clickwrap #{results.clickwrap_name} has been created"
     render 'ds_common/example_done'
   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/clickwrap/eg004_list_clickwraps_controller.rb

@@ -2,23 +2,18 @@ class Clickwrap::Eg004ListClickwrapsController < EgController
   before_action :check_auth
 
   def create
-    results = Clickwrap::Eg004ListClickwrapsService.new(session, request).call
+    args = {
+      account_id: session[:ds_account_id],
+      base_path: session[:ds_base_path],
+      access_token: session[:ds_access_token]
+    }
+
+    results = Clickwrap::Eg004ListClickwrapsService.new(args).worker
 
     @title = 'List clickwraps results'
     @h1 = 'List clickwraps results'
     @message = "Results from the ClickWraps::getClickwraps method:"
     @json = results.to_json.to_json
     render 'ds_common/example_done'
   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