docusign_esign 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,110 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+# load the gem
+require 'swagger_client'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/tests/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+
+gem 'docusign_esign', path: '../'

data/tests/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: ../
+  specs:
+    docusign_esign (1.0.0)
+      json (~> 1.8, >= 1.8.3)
+      jwt (~> 2.0, >= 2.0.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.18)
+    json (1.8.6)
+    jwt (2.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  docusign_esign!
+  rspec
+
+BUNDLED WITH
+   1.11.2

data/tests/rsa_keys/private.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAn0EXst/7QPcwn+Zw8tpZez5Pee+F8XjM6OvjxWKlcRZkd3UM
+BG63y9LrXG6boHhpUwMrxHByZHBGB2uDQ4ztis9MZvGRB+hCFjYSy3mgPQ+4Q24B
+j6FD+CkF8CXO35s+2Cf2ZhLkPxpC0fOg/1/1hGfmuVaJoS9jfN45BlYdBV8iLgEy
+iktGRKDSur7Zjj1vvCWaG5jsAc29ffg3EuBdw4ImAkVlks7SB44TpM8JH3qC5H4a
+L4D9i2Xjw2zeANdPD9p8VL4zMrcQXKzZsHShWh0z3q5QPDJBLxGivyLLL4RrA3tY
+L5cGKr9PHKONVGT6ymxqt2B7b48qIc5KoGu9CwIDAQABAoIBADeZca0tHpqtUmgY
++4kF62SoOfYfxjsqShvtsy1IBeun/jZogmQPxZJfFnXEVggd0eO+AStJeN6RBhn0
+ErVkP9CNFCcConhIwb3gbgpk8akv0kyUXO4oxsKei+iuQn31xOiRdyhm4xIW2IpV
+TPmrpltuLPK7ADzqfwjqyqzoJqSnZ4HPLDB4bFLYTDCgl1L+nrl4NroQge86vXBg
+oVZaR1w/1Kwi1cpVhHgqg8D5+5aR5fFiRGB6CfM+uH+ZmjewaEBil+G6VI/v/7f2
+PTGLPDtS6xD7FH+PzqEenefuztu9THibt1ynxI8ZrloD3vKtss5BUfWMW6/DxH6S
+E21f6rECgYEA0Xa4adZKcwwX2NITMGLu3KYbtkDfc0E2PPlo33KhEb9+gB8Cur3O
+5LMDpCWMRlkYGubov0CHXY2nSPOitkYQusi3HOCk8ZgOJqVnXqyLs6zpDzjuYVjZ
+Un8Sl/MYg2u1vCK0wgOBFq+GaU6mDTrII0MMyPODiaXvz/4kgxh2SnECgYEAwqKz
+cGPi4Cbd8RlFQgx9GBsf4QVEMuCHEdmy1Hwm0c7pQrlNnyqCrzhvbV8TAHCsrm49
+Hod/owgDhJq4noEQTSSvSdshvVMGOr0EZ/U+EgFULs7MiB6X0Mlvsag7/lQD2Uzu
++kiJaQehZ69Xnn5E2u4+1IjhBSR2hDuFo+9qZTsCgYBKIkWUl9ZTr5UFFRzbhDhb
++aJXN9Cd/xeOLwuyAeUF3guMlu0lYKZIBR+lyfBCuaexZcY8Yj9Gmir5w9jzwAqN
+wRol61AVfaaMgP/73v+2wNzfmVutMoAAFZ9kDhK/+LAifPoSrKDUgZ0FymM0zXgm
+GsX8nUsRvZwJtj3/8/lx0QKBgA0ZnFA1OODzXL7Mf5/ZbVYBBV1E2HlAKXcnGuU4
+UfiPH54REMtkthULDFzlKEdATi8TVmPGpO2ZLXtwWnq4nxtCG9YxvIycmO+9Jx3E
+IOBfXIYl/xguTvOLi0v+0cLlbrjid7c6yJzcGZ377D7LquC9Zlcxu0t4T83In88P
+3y5fAoGBAM+Qy1aDWOELopxlgpPqkdnqRZN4qRR0T2jmEoG4ZAAizXpeqiRVqrLG
+N8E2e1fgEDw2ejS12Cj4iBqyhvRENVcVac71Kd14gpwka61GiOb3jS+QxWlfmZya
+nM6+yyri5lAljyLgln8LZ8bkMJGXF1X1cGtjy+jI9PWzfhD49VkM
+-----END RSA PRIVATE KEY-----

data/tests/rsa_keys/public.pem

@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn0EXst/7QPcwn+Zw8tpZ
+ez5Pee+F8XjM6OvjxWKlcRZkd3UMBG63y9LrXG6boHhpUwMrxHByZHBGB2uDQ4zt
+is9MZvGRB+hCFjYSy3mgPQ+4Q24Bj6FD+CkF8CXO35s+2Cf2ZhLkPxpC0fOg/1/1
+hGfmuVaJoS9jfN45BlYdBV8iLgEyiktGRKDSur7Zjj1vvCWaG5jsAc29ffg3EuBd
+w4ImAkVlks7SB44TpM8JH3qC5H4aL4D9i2Xjw2zeANdPD9p8VL4zMrcQXKzZsHSh
+Wh0z3q5QPDJBLxGivyLLL4RrA3tYL5cGKr9PHKONVGT6ymxqt2B7b48qIc5KoGu9
+CwIDAQAB
+-----END PUBLIC KEY-----

data/tests/spec/unit_tests_spec.rb

@@ -0,0 +1,360 @@
+require 'docusign_esign'
+require 'base64'
+require 'uri'
+
+describe 'DocuSign Ruby Client Tests' do
+	def login(username, password, integrator_key)
+		begin
+			configuration = DocuSign_eSign::Configuration.new
+	  	configuration.host = "https://demo.docusign.net/restapi"
+
+	  	api_client = DocuSign_eSign::ApiClient.new(configuration)
+	    api_client.default_headers.store("X-DocuSign-Authentication", $auth_header)
+
+	  	authentication_api = DocuSign_eSign::AuthenticationApi.new(api_client)
+
+	  	login_options = DocuSign_eSign::LoginOptions.new
+
+			login_information = authentication_api.login(login_options)
+
+			if !login_information.nil?
+				login_information.login_accounts.each do |login_account|
+					if login_account.is_default == "true"
+						$base_url = login_account.base_url
+						$account_id = login_account.account_id
+
+						return login_account
+					end
+				end
+			end
+		rescue => e
+		  puts "Error during processing: #{$!}"
+		  # puts "Backtrace:\n\t#{e.backtrace.join("\n\t")}"
+		end
+
+		return nil
+	end
+
+	def create_api_client
+		api_client = nil
+
+		if !$base_url.nil?
+			configuration = DocuSign_eSign::Configuration.new
+
+			# IMPORTANT: Use the base url from the login account to instantiant the api_client
+			base_uri = URI.parse($base_url)
+	  	configuration.host = "%s://%s/restapi" % [base_uri.scheme, base_uri.host]
+
+			api_client = DocuSign_eSign::ApiClient.new(configuration)
+			api_client.default_headers.store("X-DocuSign-Authentication", $auth_header)
+		end
+
+		return api_client
+	end
+
+	def create_envelope_on_document(status, is_embedded_signing)
+		if(!$account_id.nil?)
+			# STEP 2: Create envelope definition
+  		# Add a document to the envelope
+			document_path = "../docs/Test.pdf"
+			document_name = "Test.pdf"
+			document = DocuSign_eSign::Document.new
+  		document.document_base64 = Base64.encode64(File.open(document_path).read)
+  		document.name = document_name
+  		document.document_id = '1'
+
+			# Create a |SignHere| tab somewhere on the document for the recipient to sign
+			signHere = DocuSign_eSign::SignHere.new
+			signHere.x_position = "100"
+			signHere.y_position = "100"
+			signHere.document_id = "1"
+			signHere.page_number = "1"
+			signHere.recipient_id = "1"
+
+			tabs = DocuSign_eSign::Tabs.new
+			tabs.sign_here_tabs = Array(signHere)
+
+			signer = DocuSign_eSign::Signer.new
+			signer.email = $recipient_email
+			signer.name = $recipient_name
+			signer.recipient_id = "1"
+
+			if(is_embedded_signing)
+				signer.client_user_id = $client_user_id
+			end
+			
+			signer.tabs = tabs
+
+			# Add a recipient to sign the document
+			recipients = DocuSign_eSign::Recipients.new
+			recipients.signers = Array(signer)
+
+			envelop_definition = DocuSign_eSign::EnvelopeDefinition.new
+			envelop_definition.email_subject = "[DocuSign Ruby SDK] - Please sign this doc"
+
+			# set envelope status to "sent" to immediately send the signature request
+			envelop_definition.status = status.nil? ? 'sent' : status
+			envelop_definition.recipients = recipients
+			envelop_definition.documents = Array(document)
+
+			options = DocuSign_eSign::CreateEnvelopeOptions.new
+
+			# STEP 3: Create envelope
+			api_client = create_api_client()
+			envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+			return envelopes_api.create_envelope($account_id, envelop_definition, options)
+		end
+	end
+
+  before(:all) do
+    # run before each test
+    $username = '[REQUIRED]'
+    $password = '[REQUIRED]'
+    $integrator_key = '[REQUIRED]'
+
+    $auth_header = '{"Username": "%s", "Password": "%s", "IntegratorKey": "%s"}' %[$username, $password, $integrator_key]
+
+    $recipient_email = "[REQUIRED]"
+    $recipient_name = "[REQUIRED]"
+
+    # Required for embedded signing url
+    $client_user_id = '[REQUIRED]'
+    $return_url = 'https://www.docusign.com/devcenter'
+    $authentication_method = 'email'
+	    
+    $template_id = ''
+    $envelope_id = nil
+
+    $base_url = nil
+    $account_id = nil
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe DocuSign_eSign::AuthenticationApi do
+  	describe '.login' do
+  		context 'given correct credentials' do
+  			it 'return LoginAccount' do
+  				login_account = login($username, $password, $integrator_key)
+
+					if !login_account.nil?
+						$base_url = login_account.base_url
+						$account_id = login_account.account_id
+					end
+
+		      expect($account_id).to be_truthy
+		      expect($base_url).to be_truthy
+  			end
+  		end
+  	end
+  end
+
+  describe DocuSign_eSign::EnvelopesApi do
+  	describe '.create' do
+  		context 'request signature on a document' do
+  			it 'successfully create an envelope' do
+	  			
+	  			# STEP 1: Login and get the account_id & base_url
+	  			login($username, $password, $integrator_key)
+
+	  			envelope_summary = create_envelope_on_document('created', true)
+
+	  			expect(envelope_summary).to be_truthy
+
+	  			if !envelope_summary.nil?
+						$envelope_id = envelope_summary.envelope_id
+						expect($envelope_id).to be_truthy
+					end
+				end
+  		end
+
+  		context 'request signature using a template' do
+  			it 'successfully send an envelope' do
+  				# TODO
+  			end
+  		end
+
+  		context 'sender view' do
+  			it 'successfully returns sender view url' do
+  				view_url = nil
+  				
+  				if !$envelope_id.nil?
+  					api_client = create_api_client()
+						envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+
+	  				return_url_request = DocuSign_eSign::ReturnUrlRequest.new
+	  				return_url_request.return_url = $return_url
+
+	  				view_url = envelopes_api.create_sender_view($account_id, $envelope_id, return_url_request)
+	  			end
+
+					expect(view_url).to be_truthy
+  				if !view_url.nil?
+  					expect(view_url.url).to be_truthy
+  				end
+  			end
+  		end
+
+  		context 'recipient view' do
+  			it 'successfully returns embedded signing view url' do
+  				view_url = nil
+
+  				if !$envelope_id.nil?
+  					api_client = create_api_client()
+						envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+
+						envelope = DocuSign_eSign::Envelope.new
+						envelope.status = 'sent'
+
+						options = DocuSign_eSign::UpdateOptions.new
+
+						envelope_update_summary = envelopes_api.update($account_id, $envelope_id, envelope, options)
+
+						expect(envelope_update_summary).to be_truthy
+						if(!envelope_update_summary.nil?)
+							expect(envelope_update_summary.envelope_id).to be_truthy
+						end
+
+						recipient_view_request = DocuSign_eSign::RecipientViewRequest.new
+						recipient_view_request.return_url = $return_url
+						recipient_view_request.client_user_id = $client_user_id
+						recipient_view_request.authentication_method = $authentication_method
+						recipient_view_request.user_name = $recipient_name
+						recipient_view_request.email = $recipient_email
+
+						view_url = envelopes_api.create_recipient_view($account_id, $envelope_id, recipient_view_request)
+  				end
+
+  				expect(view_url).to be_truthy
+  				if !view_url.nil?
+  					expect(view_url.url).to be_truthy
+  				end
+  			end
+  		end
+
+  		context 'embedded console view' do
+  			it 'successfully returns embedded console view url' do
+  				view_url = nil
+
+  				if !$envelope_id.nil?
+  					api_client = create_api_client()
+						envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+
+						console_view_request = DocuSign_eSign::ConsoleViewRequest.new
+						console_view_request.envelope_id = $envelope_id
+						console_view_request.return_url = $return_url
+
+						view_url = envelopes_api.create_console_view($account_id, console_view_request)
+  				end
+
+  				expect(view_url).to be_truthy
+  				if !view_url.nil?
+  					expect(view_url.url).to be_truthy
+  				end
+  			end
+  		end
+  	end
+
+  	describe '.get' do
+  		context 'get envelope information' do
+  			it 'successfully returns envelope summary' do
+  				envelope_summary = nil
+
+  				if !$envelope_id.nil?
+						api_client = create_api_client()
+						envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+						
+						options = DocuSign_eSign::GetEnvelopeOptions.new
+
+						envelope_summary = envelopes_api.get_envelope($account_id, $envelope_id, options)
+					end
+
+					expect(envelope_summary).to be_truthy
+					if !envelope_summary.nil?
+						expect(envelope_summary.envelope_id).to eq($envelope_id)
+					end
+  			end
+  		end
+  	end
+
+  	describe '.list' do
+  		context 'list recipients' do
+  			it 'successfully list envelope recipients' do
+  				recipients = nil
+
+  				if !$envelope_id.nil?
+  					api_client = create_api_client()
+						envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+
+						options = DocuSign_eSign::ListRecipientsOptions.new
+
+						recipients = envelopes_api.list_recipients($account_id, $envelope_id, options)
+					end
+
+					expect(recipients).to be_truthy
+					if !recipients.nil?
+						expect(recipients.recipient_count.to_i).to be > 0
+					end
+  			end
+  		end
+
+  		context 'list status changes' do
+  			it 'successfully lists envelope status changes' do
+  				envelopes_information = nil
+
+  				if !$envelope_id.nil?
+						api_client = create_api_client()
+						envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+						
+						options = DocuSign_eSign::ListStatusChangesOptions.new
+						options.from_date = Time.now.strftime("%Y-%m-%d")
+
+						envelopes_information = envelopes_api.list_status_changes($account_id, options)
+					end
+
+					expect(envelopes_information).to be_truthy
+					if !envelopes_information.nil?
+						expect(envelopes_information.total_set_size.to_i).to be > 0
+					end
+  			end
+  		end
+
+  		context 'list documents and download' do
+  			it 'successfully lists and download envelope documents' do
+  				envelope_documents_result = nil
+
+  				if !$envelope_id.nil?
+						api_client = create_api_client()
+						envelopes_api = DocuSign_eSign::EnvelopesApi.new(api_client)
+						
+						options = DocuSign_eSign::ListDocumentsOptions.new
+
+						envelope_documents_result = envelopes_api.list_documents($account_id, $envelope_id, options)
+					end
+
+					expect(envelope_documents_result).to be_truthy
+					if !envelope_documents_result.nil?
+						expect(envelope_documents_result.envelope_id).to eq($envelope_id)
+						expect(envelope_documents_result.envelope_documents).to be_truthy
+
+						if !envelope_documents_result.envelope_documents.nil?
+							expect(envelope_documents_result.envelope_documents.count).to be > 0
+
+
+							if envelope_documents_result.envelope_documents.count > 0
+								options = DocuSign_eSign::GetDocumentOptions.new
+
+								envelope_documents_result.envelope_documents.each do |envelope_document|
+									document = envelopes_api.get_document($account_id, envelope_document.document_id, $envelope_id, options)
+									expect(document).to be_truthy
+								end
+							end
+						end
+					end
+  			end
+  		end
+		end
+	end
+end