docusigner 0.0.1

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'docusigner'
+require 'shoulda'
+require 'webmock/test_unit'
+
+class Test::Unit::TestCase
+  include WebMock::API
+end
+
+WebMock.disable_net_connect!

data/test/unit/account_test.rb

@@ -0,0 +1,405 @@
+require 'test_helper'
+
+class Docusigner::AccountTest < Test::Unit::TestCase
+
+  context "an account" do
+    setup do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf.json")
+        .to_return(:body => {
+          "accountIdGuid" => "1234-asdf",
+          "accountName" => "My Account Name",
+          "billingPeriodEndDate" => "2013-03-21T07:00:00.0000000Z",
+          "billingPeriodEnvelopesAllowed" => "",
+          "billingPeriodEnvelopesSent" => "",
+          "billingPeriodStartDate" => "2013-02-21T08:00:00.0000000Z",
+          "connectPermission" => "full",
+          "currencyCode" => "USD",
+          "currentPlanId" => "36eb5ca8-ebc0-446b-930c-ee010eb59179",
+          "distributorCode" => "DocuSign",
+          "docuSignLandingUrl" => "http://www.docusign.com/products/sign_up/buy_now.php",
+          "planName" => "DocuSign Demo Plan",
+          "planStartDate" => "2013-02-21T14:28:35.0000000Z",
+          "suspensionStatus" => ""
+        }.to_json)
+      @account = Docusigner::Account.find("1234-asdf")
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf.json")
+    end
+
+    should "be findable by id" do
+      assert_equal("1234-asdf", @account.id)
+    end
+
+    should "be able to fetch its brands" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/brands.json")
+        .to_return(:body => {
+          "brands" => [{
+            "brandCompany" => "String content",
+            "brandId" => "1",
+            "brandName" => "String content",
+          }, {
+            "brandCompany" => "String content",
+            "brandId" => "2",
+            "brandName" => "String content",
+          }],
+          "recipientBrandIdDefault" => "1",
+          "senderBrandIdDefault" => "1",
+        }.to_json)
+      brands = @account.brands
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/brands.json")
+      assert_equal(2, brands.length)
+      brands.each do |brand|
+        assert_equal("1234-asdf", brand.account_id)
+      end
+    end
+
+    should "be able to fetch a list of custom fields" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/custom_fields.json")
+        .to_return(:body => {
+          "listCustomFields" => [{
+            "name" => "String",
+            "required" => "String",
+            "show" => "String",
+            "listItems" => ["String","String"]
+          },
+          {
+            "name" => "String",
+            "required" => "String",
+            "show" => "String",
+            "listItems" => ["String","String"]
+          }],
+          "textCustomFields" => [{
+            "name" => "String",
+            "required" => "String",
+            "show" => "String",
+          },
+          {
+            "name" => "String",
+            "required" => "String",
+            "show" => "String",
+          }]
+        }.to_json)
+      custom_fields = @account.custom_fields
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/custom_fields.json")
+      assert_equal(4, custom_fields.length)
+      custom_fields.each do |custom_field|
+        assert_equal("1234-asdf", custom_field.account_id)
+      end
+    end
+
+    should "be able to fetch envelopes from a given date" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes.json?from_date=2013-01-01")
+        .to_return(:body => {
+          "envelopes" => [{
+            "certificateUri" => "String content",
+            "customFieldsUri" => "String content",
+            "documentsCombinedUri" => "String content",
+            "documentsUri" => "String content",
+            "envelopeId" => "envelope1",
+            "envelopeUri" => "String content",
+            "notificationUri" => "String content",
+            "recipientsUri" => "String content",
+            "status" => "created",
+            "statusChangedDateTime" => "String content"
+          },
+          {
+            "certificateUri" => "String content",
+            "customFieldsUri" => "String content",
+            "documentsCombinedUri" => "String content",
+            "documentsUri" => "String content",
+            "envelopeId" => "envelope2",
+            "envelopeUri" => "String content",
+            "notificationUri" => "String content",
+            "recipientsUri" => "String content",
+            "status" => "sent",
+            "statusChangedDateTime" => "String content"
+          }],
+          "resultSetSize" => "String content"
+        }.to_json)
+      envelopes = @account.envelopes("2013-01-01")
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes.json?from_date=2013-01-01")
+      assert_equal(2, envelopes.length)
+      envelopes.each do |envelope|
+        assert_equal("1234-asdf", envelope.account_id)
+      end
+    end
+
+    should "be able to fetch folders" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/folders.json")
+        .to_return(:body => {
+          "folders" => [{
+            "folderId" => "String content",
+            "name" => "String content",
+            "ownerEmail" => "String content",
+            "ownerUserName" => "String content",
+            "type" => "String content",
+            "uri" => "String content"
+          },
+          {
+            "folderId" => "String content",
+            "name" => "String content",
+            "ownerEmail" => "String content",
+            "ownerUserName" => "String content",
+            "type" => "String content",
+            "uri" => "String content"
+          },
+          {
+            "folderId" => "String content",
+            "folders" => [{
+              "folderId" => "String content",
+              "name" => "String content",
+              "ownerEmail" => "String content",
+              "ownerUserName" => "String content",
+              "parentFolderId" => "String content",
+              "parentFolderUri" => "String content",
+              "type" => "String content",
+              "uri" => "String content"
+            }],
+          }],
+        }.to_json)
+      folders = @account.folders
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/folders.json")
+      assert_equal(3, folders.length)
+      folders.each do |folder|
+        assert_equal("1234-asdf", folder.account_id)
+      end
+    end
+
+    should "be able to fetch groups" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/groups.json")
+        .to_return(:body => {
+          "groups" => [{
+            "groupId" => "String content",
+            "groupName" => "String content",
+            "groupType" => "String content",
+            "permissionsProfileId" => "String content"
+          }]
+        }.to_json)
+      groups = @account.groups
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/groups.json")
+      assert_equal(1, groups.length)
+      groups.each do |group|
+        assert_equal("1234-asdf", group.account_id)
+      end
+    end
+
+    should "be able to fetch settings" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/settings.json")
+        .to_return(:body => {
+          "accountSettings" => [
+            {
+              "name" => "allowInPerson",
+              "value" => "true"
+            },
+            {
+              "name" => "allowSignerReassign",
+              "value" => "true"
+            },
+            {
+              "name" => "attachCompletedEnvelope",
+              "value" => "true"
+            },
+            {
+              "name" => "autoNavRule",
+              "value" => "required_fields"
+            },
+            {
+              "name" => "canSelfBrandSend",
+              "value" => "true"
+            },
+            {
+              "name" => "canSelfBrandSign",
+              "value" => "true"
+            },
+            {
+              "name" => "enableAutoNav",
+              "value" => "false"
+            },
+            {
+              "name" => "enableCalculatedFields",
+              "value" => "true"
+            },
+            {
+              "name" => "enableDSPro",
+              "value" => "false"
+            },
+            {
+              "name" => "enableEnvelopeStampingByAccountAdmin",
+              "value" => "false"
+            },
+            {
+              "name" => "enablePaymentProcessing",
+              "value" => "false"
+            },
+            {
+              "name" => "enablePowerForm",
+              "value" => "true"
+            },
+            {
+              "name" => "enableReservedDomain",
+              "value" => "false"
+            },
+            {
+              "name" => "enableSendToAgent",
+              "value" => "true"
+            },
+            {
+              "name" => "enableSendToIntermediary",
+              "value" => "false"
+            },
+            {
+              "name" => "enableSendToManage",
+              "value" => "true"
+            },
+            {
+              "name" => "enableSequentialSigningAPI",
+              "value" => "true"
+            },
+            {
+              "name" => "enableSequentialSigningUI",
+              "value" => "true"
+            },
+            {
+              "name" => "enableSignerAttachments",
+              "value" => "true"
+            },
+            {
+              "name" => "enableSignOnPaper",
+              "value" => "true"
+            },
+            {
+              "name" => "enableSignOnPaperOverride",
+              "value" => "false"
+            },
+            {
+              "name" => "enableTransactionPoint",
+              "value" => "false"
+            },
+            {
+              "name" => "enableVaulting",
+              "value" => "false"
+            },
+            {
+              "name" => "envelopeIntegrationAllowed",
+              "value" => "full"
+            },
+            {
+              "name" => "envelopeIntegrationEnabled",
+              "value" => "false"
+            },
+            {
+              "name" => "envelopeStampingDefaultValue",
+              "value" => "false"
+            },
+            {
+              "name" => "idCheckExpire",
+              "value" => "always"
+            },
+            {
+              "name" => "idCheckExpireDays",
+              "value" => "0"
+            },
+            {
+              "name" => "idCheckRequired",
+              "value" => "never"
+            },
+            {
+              "name" => "pkiSignDownloadedPDFDocs",
+              "value" => "yes_sign"
+            },
+            {
+              "name" => "signDateFormat",
+              "value" => "M/d/yyyy"
+            },
+            {
+              "name" => "signerAttachCertificateToEnvelopePDF",
+              "value" => "false"
+            },
+            {
+              "name" => "signerCanCreateAccount",
+              "value" => "true"
+            },
+            {
+              "name" => "signerCanSignOnMobile",
+              "value" => "true"
+            },
+            {
+              "name" => "signerInSessionUseEnvelopeCompleteEmail",
+              "value" => "false"
+            },
+            {
+              "name" => "signerMustHaveAccount",
+              "value" => "false"
+            },
+            {
+              "name" => "signerMustLoginToSign",
+              "value" => "false"
+            },
+            {
+              "name" => "signerShowSecureFieldInitialValues",
+              "value" => "false"
+            },
+            {
+              "name" => "sessionTimeout",
+              "value" => "120"
+            },
+            {
+              "name" => "useAccountLevelEmail",
+              "value" => "true"
+            },
+            {
+              "name" => "usesAPI",
+              "value" => "false"
+            }
+          ]
+        }.to_json)
+      settings = @account.settings
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/settings.json")
+      assert_equal("false", settings["usesAPI"])
+      assert_equal("1234-asdf", settings.account_id)
+    end
+
+    should "be able to fetch templates" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/templates.json")
+        .to_return(:body => {
+          "envelopeTemplates" => [{
+            "description" => "String content",
+            "folderName" => "String content",
+            "folderUri" => "String content",
+            "lastModified" => "String content",
+            "name" => "String content",
+            "pageCount" => 2147483647,
+            "password" => "String content",
+            "shared" => "String content",
+            "templateId" => "String content",
+            "uri" => "String content"
+          }]
+        }.to_json)
+      templates = @account.templates
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/templates.json")
+      assert_equal(1, templates.length)
+      templates.each do |template|
+        assert_equal("1234-asdf", template.account_id)
+      end
+    end
+
+    should "be able to fetch users" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/users.json")
+        .to_return(:body => {
+          "users" => [{
+            "uri" => "String content",
+            "userId" => "String content",
+            "userName" => "String content",
+            "userStatus" => "String content",
+            "userType" => "String content"
+          }]
+        }.to_json)
+      users = @account.users
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/users.json")
+      assert_equal(1, users.length)
+      users.each do |user|
+        assert_equal("1234-asdf", user.account_id)
+      end
+    end
+  end
+
+end

data/test/unit/base_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class Docusigner::BaseTest < Test::Unit::TestCase
+
+  context "headers" do
+    teardown do
+      Docusigner::Base.instance_variable_set(:@headers, nil)
+      Docusigner::Account.instance_variable_set(:@headers, nil)
+    end
+
+    should "be inheritable" do
+      Docusigner::Base.headers['X-Foo'] = "bar"
+      assert_equal('bar', Docusigner::Account.headers['X-Foo'])
+
+      Docusigner::Account.headers["X-Bar"] = "foo"
+      assert_nil(Docusigner::Base.headers["X-Bar"])
+    end
+
+    should "authenticate via a bearer token" do
+      Docusigner::Base.token = "sometoken"
+      assert_equal("Bearer sometoken", Docusigner::Base.headers['Authorization'])
+    end
+
+    should "authenticate via username, password, integrator_key" do
+      Docusigner::Base.authorization = {
+        :username => "Jeff",
+        :password => "supersecure",
+        :integrator_key => "longkey",
+      }
+      assert_equal("<DocuSignCredentials><Username>Jeff</Username><Password>supersecure</Password><IntegratorKey>longkey</IntegratorKey></DocuSignCredentials>", 
+        Docusigner::Base.headers['X-DocuSign-Authentication'])
+    end
+  end
+
+end

data/test/unit/envelope_test.rb

@@ -0,0 +1,141 @@
+require 'test_helper'
+
+class Docusigner::EnvelopeTest < Test::Unit::TestCase
+
+  should "be able to create an envelope" do
+    @envelope = Docusigner::Envelope.new({
+      :account_id => "1234-asdf",
+      :emailSubject => "Fee Agreement",
+      :emailBlurb => "Please sign the attached agreement.",
+      :recipients => {
+        :signers => [
+          {
+            :email => "someone@somewhere.com",
+            :name => "Bob Smith",
+            :recipientId => "1",
+          }
+        ]
+      },
+      :documents => [
+        {
+          :name => "Fee Agreement.pdf",
+          :documentId => "1"
+        }
+      ],
+      :status => Docusigner::Envelope::Status::SENT
+    })
+    @envelope.add_document(File.open(File.expand_path("../../test.pdf", __FILE__)), 1)
+
+    stub_request(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes.json")
+      .to_return(:body => {
+        "envelopeId" => "someid",
+        "status" => "sent",
+        "statusDateTime" => "2013-02-21T14:28:35.0000000Z",
+        "uri" => "/envelopes/someid"
+      }.to_json)
+    @envelope.save
+    assert_requested(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes.json")
+    assert_equal("someid", @envelope.id)
+  end
+
+  context "an existing envelope" do
+    setup do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890.json")
+        .to_return(:body => {
+          "allowReassign" => "true",
+          "certificateUri" => "/envelopes/qwer-7890/documents/certificate",
+          "createdDateTime" => "2013-02-26T21:07:46.8430000Z",
+          "customFieldsUri" => "/envelopes/qwer-7890/custom_fields",
+          "documentsCombinedUri" => "/envelopes/qwer-7890/documents/combined",
+          "documentsUri" => "/envelopes/qwer-7890/documents",
+          "emailBlurb" => "This is the blurb for the email.",
+          "emailSubject" => "SDK Example",
+          "enableWetSign" => "true",
+          "envelopeId" => "qwer-7890",
+          "envelopeUri" => "/envelopes/qwer-7890",
+          "notificationUri" => "/envelopes/qwer-7890/notification",
+          "recipientsUri" => "/envelopes/qwer-7890/recipients",
+          "sentDateTime" => "2013-02-26T21:07:47.1230000Z",
+          "status" => "sent",
+          "statusChangedDateTime" => "2013-02-26T21:07:47.1230000Z",
+          "templatesUri" => "/envelopes/qwer-7890/templates"
+        }.to_json)
+      @envelope = Docusigner::Envelope.find("qwer-7890", :params => {:account_id => "1234-asdf"})
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890.json")
+    end
+
+    should "be findable by id" do
+      assert_equal("qwer-7890", @envelope.id)
+      assert_equal("1234-asdf", @envelope.account_id)
+    end
+
+    should "be able to list recipients" do
+      stub_request(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/recipients.json")
+        .to_return(:body => {
+          "agents" => [],
+          "carbonCopies" => [],
+          "certifiedDeliveries" => [],
+          "currentRoutingOrder" => "1",
+          "editors" => [],
+          "inPersonSigners" => [],
+          "intermediaries" => [],
+          "recipientCount" => "1",
+          "signers" => [
+            {
+              "recipientId" => "1",
+              "requireIdLookup" => "false",
+              "routingOrder" => "1",
+              "status" => "sent",
+              "email" => "david@avvo.com",
+              "name" => "David Doan"
+            }
+          ]
+        }.to_json)
+      recipients = @envelope.recipients
+      assert_requested(:get, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/recipients.json")
+      assert_equal(1, recipients.count)
+    end
+
+    should "be able to get a recipient view url" do
+      stub_request(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/views/recipient.json")
+        .to_return(:body => {
+          "url" => "http://localhost/Member/StartInSession.aspx?t=d1cf42f2-30b6-499b-ab54-058fbf438103"
+        }.to_json)
+      url = @envelope.recipient_url({
+        :authenticationMethod => "email",
+        :email => "mike.rosey@docusign.com",
+        :returnUrl => "http://www.docusign.com",
+        :userName => "Mike Rosey",
+        :clientUserId => 333,
+        :recipientId => 1
+      })
+      assert_requested(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/views/recipient.json")
+      assert_equal("http://localhost/Member/StartInSession.aspx?t=d1cf42f2-30b6-499b-ab54-058fbf438103", url)
+    end
+
+    should "be able to get a sender view url" do
+      stub_request(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/views/sender.json")
+        .to_return(:body => {
+          "url" => "http://localhost/Member/StartInSession.aspx?StartConsole=1&t=6cafaeaa-cc6b-496d-812d-421b72f854de&DocuEnvelope=AB52A90E-BDC7-4F59-BFBD-90E32E984EA7&send=1"
+        }.to_json)
+      url = @envelope.sender_url({
+        :returnUrl => "http://www.docusign.com",
+      })
+      assert_requested(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/views/sender.json")
+      assert_equal("http://localhost/Member/StartInSession.aspx?StartConsole=1&t=6cafaeaa-cc6b-496d-812d-421b72f854de&DocuEnvelope=AB52A90E-BDC7-4F59-BFBD-90E32E984EA7&send=1", url)
+    end
+
+    should "be able to get a correction view url" do
+      stub_request(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/views/correct.json")
+        .to_return(:body => {
+          "url" => "http://localhost/someurl"
+        }.to_json)
+      url = @envelope.correct_url({
+        :returnUrl => "http://www.docusign.com",
+      })
+      assert_requested(:post, "https://demo.docusign.net/restapi/v2/accounts/1234-asdf/envelopes/qwer-7890/views/correct.json")
+      assert_equal("http://localhost/someurl", url)
+    end
+  end
+
+end

data/test/unit/login_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+class Docusigner::LoginTest < Test::Unit::TestCase
+
+  should "be able to fetch login information" do
+    stub_request(:get, "https://demo.docusign.net/restapi/v2/login_information.json")
+      .to_return(:body => {
+        "apiPassword" => "base64encoded=",
+        "loginAccounts" => [
+          {
+            "accountId" => "1234",
+            "accountIdGuid" => "asdfawef23fwfwef",
+            "baseUrl" => "https://demo.docusign.net/restapi/v2/accounts/1234",
+            "email" => "myemail@gmail.com",
+            "isDefault" => "true",
+            "loginAccountSettings" => [
+              {
+                "name" => "usesAPI",
+                "value" => "false"
+              }
+            ],
+            "loginUserSettings" => [
+              {
+                "name" => "canManageAccount",
+                "value" => "true"
+              },
+              {
+                "name" => "canSendAPIRequests",
+                "value" => "false"
+              },
+              {
+                "name" => "canSendEnvelope",
+                "value" => "true"
+              },
+              {
+                "name" => "allowSendOnBehalfOf",
+                "value" => "true"
+              },
+              {
+                "name" => "apiAccountWideAccess",
+                "value" => "true"
+              }
+            ],
+            "name" => "Company.com",
+            "siteDescription" => "",
+            "userId" => "someguid",
+            "userName" => "Jeff Ching"
+          }
+        ]
+      }.to_json)
+    login_information = Docusigner::LoginInformation.find
+    assert_requested(:get, "https://demo.docusign.net/restapi/v2/login_information.json")
+    assert_equal(1, login_information.loginAccounts.length)
+  end
+
+  should "be able to update password" do
+    stub_request(:put, "https://demo.docusign.net/restapi/v2/login_information/password.json")
+      .with(:body => {
+        :currentPassword => "oldpw",
+        :email => "myemail@gmail.com",
+        :newPassword => "newpw"
+      }.to_json)
+    Docusigner::LoginInformation.change_password("myemail@gmail.com", "oldpw", "newpw")
+    assert_requested(:put, "https://demo.docusign.net/restapi/v2/login_information/password.json")
+  end
+end