Updated README and tests comments

Author: an-tk

.travis.yml

@@ -4,6 +4,6 @@ branches:
 language: ruby
 #before_install: openssl aes-256-cbc -K $encrypted_7aa52200b8fc_key -iv $encrypted_7aa52200b8fc_iv -in tests/keys/docusign_private_key.txt.enc -out tests/keys/docusign_private_key.txt -d
 # command to install dependencies
-install: cd tests/spec && bundle install
+install: cd tests && bundle install
 # command to run tests
 script: bundle exec rspec unit_tests_using_jwt_spec.rb --format documentation

README.md

@@ -39,30 +39,45 @@ For details regarding which type of OAuth grant will work best for your DocuSign
 For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
 
 ## Running tests:
+Pre-conditions:
+1. Make sure ruby is installed or install it fallowing the [instructions](https://www.ruby-lang.org/en/documentation/installation/)
+2. Login with your DocuSign account on https://appdemo.docusign.com.
+3. Open Apps and Keys section in Settings and press Add App and Integration Key button.
+4. Enter App name, add secret key, generate RSA key and press Save button, add `https://developers.docusign.com/` to Redirect URIs.
+5. Create new template on https://appdemo.docusign.com/templates page and save its ID.
+
+After complete all previous steps for run on the Windows 10 need to do the following:
+1. Download curl from https://curl.se/windows/
+2. Inside archive find "bin" directory
+3. Rename libcurl-x64.def to libcurl.def
+4. Rename libcurl-x64.dll to libcurl.dll
+5. Copy all files from "bin" directory to C:\Ruby30-x64\bin
 
 To run tests, you need:
 1. Create a .env file at the `tests` dir (or rename an existing .env.example file)
 2. Enter your data from the developer account
-* SECRET=< The secret key of your application > \
+* `SECRET` \
     settings => Apps and Keys =>
     Apps and Integration Keys your app "ACTIONS" => Edit =>
     Authentication => Secret Keys
-* INTEGRATOR_KEY_JWT=< your Integration Key > \
+* `INTEGRATOR_KEY_JWT` \
     settings => Apps and Keys => Integration Key of your app
-* TEMPLATE_ID=< your template id > \
-  templates => in MyTemplates list click by choosen template => template id
-* USER_ID=< your User ID > \
+* `TEMPLATE_ID` \
+  templates => in MyTemplates list click by chosen template or _create new one_ => template id
+* `USER_ID` \
     settings => Apps and Keys => User ID
 
 3. Copy private key to `tests/docs/private.pem ` \
     Settings => "Apps and Keys"
     in Apps and Integration Keys choose your application name => "ACTIONS" Edit => Service Integration => + GENERATE RSA
 
-4. Install dependencies bundle install
+4. Run tests: \
+   `cd tests && bundle install`\
+   `bundle exec rspec spec/unit_tests_using_jwt_spec.rb --format documentation`
+
+### Important note:
+First time you ask for a JWT access token you might need to uncomment lines 19-21 in `tests/spec/unit_tests_using_jwt_spec.rb:19` and grant access to the API
 
-5. Run tests: \
-   `cd tests`\
-   `rspec`
 
 ## Support
 Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).

tests/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 gem 'rspec'
 gem 'dotenv'
+gem 'launchy'
 gem 'docusign_esign', path: '../'

tests/spec/unit_tests_using_jwt_spec.rb

@@ -2,6 +2,7 @@
 require 'docusign_esign'
 require 'base64'
 require 'uri'
+require 'launchy'
 
 describe 'DocuSign Ruby Client Tests' do
   def login
@@ -12,10 +13,13 @@ def login
 
         $api_client = DocuSign_eSign::ApiClient.new(configuration)
         $api_client.set_oauth_base_path(DocuSign_eSign::OAuth::DEMO_OAUTH_BASE_PATH)
-        # $api_client.get_authorization_uri($integrator_key,%w[signature impersonation],$return_url,'code')
-        # $api_client.request_jwt_application_token($integrator_key,File.read($private_key_filename),$expires_in_seconds,%w[signature impersonation] )
-        # code = 'code_here'
-        # $api_client.generate_access_token($integrator_key,$secret,code)
+        # IMPORTANT NOTE:
+        # the first time you ask for a JWT access token, you should grant access by making the following call
+        # visit DocuSign OAuth authorization url in the browser, login, grant access and restart the tests
+        # url = $api_client.get_authorization_uri($integrator_key,%w[signature organization_read impersonation],$return_url,'code')
+        # Launchy.open(url)
+        # abort "Please restart the tests"
+        # END OF NOTE
       end
 
       token_obj = $api_client.request_jwt_user_token(ENV["INTEGRATOR_KEY_JWT"], ENV["USER_ID"], File.read($private_key_filename), $expires_in_seconds)
@@ -348,19 +352,15 @@ def create_envelope_on_document(status, is_embedded_signing)
           if !$envelope_id.nil?
             api_client = create_api_client()
             templates_api = DocuSign_eSign::TemplatesApi.new(api_client)
-
-            options = DocuSign_eSign::GetEnvelopeOptions.new
-            $template_id = ENV["TEMPLATE_ID"]
-
             options = DocuSign_eSign::GetOptions.new
             options.include = "tabs"
 
-            template_summary = templates_api.get($account_id, $template_id, options)
+            template_summary = templates_api.get($account_id, ENV["TEMPLATE_ID"], options)
           end
 
           expect(template_summary).to be_truthy
           if !template_summary.nil?
-            expect(template_summary.template_id).to eq($template_id)
+            expect(template_summary.template_id).to eq(ENV["TEMPLATE_ID"])
           end
         end
       end