docu_sign 0.0.3

data/lib/docu_sign/tab.rb

@@ -0,0 +1,96 @@
+module DocuSign
+  class Tab < DocuSignModel
+    ATTRIBUTES = [:document_id, :recipient_id, :page_number, :x_position, :y_position, :scale_value, :anchor_tab_item,
+      :type, :name, :tab_label, :value, :custom_tab_type, :custom_tab_width, :custom_tab_height, :custom_tab_required,
+      :conceal_value_on_document, :custom_tab_locked, :custom_tab_disable_auto_size, :custom_tab_list_items,
+      :custom_tab_list_values, :custom_tab_list_selected_value, :custom_tab_radio_group_name,
+      :custom_tab_validation_pattern, :custom_tab_validation_message, :template_locked, :template_required,
+      :conditional_parent_label, :conditional_parent_value, :shared_tab, :require_initial_on_shared_tab_change,
+      :font, :bold, :italic, :underline, :font_color, :font_size, :merge_field_xml, :include_note_in_email]
+    ATTRIBUTES.each do |attr|
+      self.send(:attr_accessor, attr)
+    end
+
+    alias_attribute :page, :page_number
+    alias_attribute :x, :x_position
+    alias_attribute :y, :y_position
+
+    def initialize(attributes = {})
+      ATTRIBUTES.each do |attr|
+        self.send("#{attr}=", attributes[attr])
+      end
+    end
+
+    def anchor(options = {}, &block)
+      anchor_builder.build(options, &block).tap do |a|
+        yield a if block_given?
+        self.anchor_tab_item = a
+      end
+    end
+
+    def anchor=(options = {})
+      anchor options
+    end
+
+    def anchor_builder
+      @anchor_builder ||= DocuSign::Builder::AnchorBuilder.new
+    end
+
+    %w(recipient document).each do |attr|
+      class_eval %Q{
+        def #{attr}=(value)
+          self.#{attr}_id = value.id
+        end
+      }
+    end
+
+    def to_savon
+      {
+        "DocumentID" => self.document_id,
+        "RecipientID" => self.recipient_id,
+        "PageNumber" => self.page_number,
+        "XPosition" => self.x_position,
+        "YPosition" => self.y_position,
+        "ScaleValue" => self.scale_value,
+        "AnchorTabItem" => self.anchor_tab_item.try(:to_savon),
+        "Type" => self.type,
+        "Name" => self.name,
+        "TabLabel" => self.tab_label,
+        "Value" => self.value,
+        "CustomTabType" => self.custom_tab_type,
+        "CustomTabWidth" => self.custom_tab_width,
+        "CustomTabHeight" => self.custom_tab_height,
+        "CustomTabRequired" => self.custom_tab_required?,
+        "ConcealValueOnDocument" => self.conceal_value_on_document?,
+        "CustomTabLocked" => self.custom_tab_locked?,
+        "CustomTabDisableAutoSize" => self.custom_tab_disable_auto_size?,
+        "CustomTabListItems" => self.custom_tab_list_items,
+        "CustomTabListValues" => self.custom_tab_list_values,
+        "CustomTabListSelectedValue" => self.custom_tab_list_selected_value,
+        "CustomTabRadioGroupName" => self.custom_tab_radio_group_name,
+        "CustomTabValidationPattern" => self.custom_tab_validation_pattern,
+        "CustomTabValidationMessage" => self.custom_tab_validation_message,
+        "TemplateLocked" => self.template_locked?,
+        "TemplateRequired" => self.template_required?,
+        "ConditionalParentLabel" => self.conditional_parent_label,
+        "ConditionalParentValue" => self.conditional_parent_value,
+        "SharedTab" => self.shared_tab?,
+        "RequireInitialOnSharedTabChange" => self.require_initial_on_shared_tab_change?,
+        "Font" => self.font,
+        "Bold" => self.bold,
+        "Italic" => self.italic,
+        "Underline" => self.underline,
+        "FontColor" => self.font_color,
+        "FontSize" => self.font_size,
+        "MergeFieldXml" => self.merge_field_xml,
+        "IncludeNoteInEmail" => self.include_note_in_email?
+      }.delete_if{|key, value| value.nil?}
+    end
+  end
+end
+
+# {http://www.docusign.net/API/3.0}ArrayOfTab
+module DocuSign
+  class ArrayOfTab < ::Array
+  end
+end

data/lib/docu_sign/tab_status.rb

@@ -0,0 +1,17 @@
+module DocuSign
+  class TabStatus < DocuSignModel
+    ATTRIBUTES = [:tab_type, :status, :x_position, :y_position, :signed, :tab_label, :tab_name, :tab_value,
+      :document_id, :page_number, :original_value, :validation_pattern, :role_name, :list_values, :list_selected_value,
+      :scale_value]
+    ATTRIBUTES.each do |attr|
+      self.send(:attr_accessor, attr)
+    end
+
+    def initialize(attributes = {})
+      ATTRIBUTES.each do |attr|
+        self.send("#{attr}=", attributes[attr])
+      end
+    end
+
+  end
+end

data/lib/docu_sign/version.rb

@@ -0,0 +1,3 @@
+module DocuSign
+  VERSION = "0.0.3"
+end

data/lib/docu_sign/void_envelope_status.rb

@@ -0,0 +1,14 @@
+module DocuSign
+  class VoidEnvelopeStatus < DocuSignModel
+    ATTRIBUTES = [:void_success]
+    ATTRIBUTES.each do |attr|
+      self.send(:attr_accessor, attr)
+    end
+
+    def initialize(attributes = {})
+      ATTRIBUTES.each do |attr|
+        self.send("#{attr}=", attributes[attr])
+      end
+    end
+  end
+end

data/lib/docu_sign.rb

@@ -0,0 +1,37 @@
+require "docu_sign/version"
+
+require 'docu_sign/extensions'
+
+require 'savon'
+require 'builder'
+
+require 'docu_sign/client'
+require 'docu_sign/docu_sign_model'
+require 'docu_sign/docu_sign_response'
+require 'docu_sign/anchor_tab'
+require 'docu_sign/authentication_status'
+require 'docu_sign/document'
+require 'docu_sign/document_pdf'
+require 'docu_sign/document_status'
+require 'docu_sign/envelope'
+require 'docu_sign/envelope_status'
+require 'docu_sign/error'
+require 'docu_sign/notification'
+require 'docu_sign/recipient'
+require 'docu_sign/recipient_status'
+require 'docu_sign/tab'
+require 'docu_sign/tab_status'
+require 'docu_sign/void_envelope_status'
+
+require 'docu_sign/builder/base'
+require 'docu_sign/builder/document_builder'
+require 'docu_sign/builder/recipient_builder'
+require 'docu_sign/builder/tab_builder'
+require 'docu_sign/builder/anchor_builder'
+require 'docu_sign/builder/notification_builder'
+
+require 'docu_sign/railtie' if defined?(Rails)
+
+module DocuSign
+  # Your code goes here...
+end

data/spec/docu_sign/client_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DocuSign::Client do
+  before do
+    @client = DocuSign::Client.new(DOCU_SIGN_CONFIG)
+  end
+
+end

data/spec/docu_sign/document_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DocuSign::Document do
+  before(:each) do
+    @d = DocuSign::Document.new
+  end
+
+  it "should create a new document" do
+    @d.should be_an_instance_of(DocuSign::Document)
+  end
+
+  it "should respond to tabs" do
+    @d.should respond_to(:tabs)
+  end
+
+  describe "#tabs" do
+    context "with no arguments" do
+      it "should return an empty tab array" do
+        @d.tabs.should == []
+      end
+    end
+
+    context "with arguments" do
+      before(:each) do
+        @tabs = @d.tabs stub(:id => 1) do |d|
+          d.tab :name => 'tab_1', :value => 'foo'
+          d.tab :name => 'tab_2', :value => 'bar'
+        end
+      end
+
+      it "should build tabs" do
+        @tabs.all? { |t| t.is_a?(DocuSign::Tab) }.should be_true
+      end
+
+      it "should build the appropriate number of tabs" do
+        @tabs.size.should == 2
+      end
+    end
+  end
+
+  describe "#tab" do
+    it "should build a tab" do
+      @d.tab.should be_an_instance_of(DocuSign::Tab)
+    end
+
+    it "should pass in arguments" do
+      tab = @d.tab :document_id => 1
+      tab.document_id.should == 1
+    end
+  end
+end

data/spec/docu_sign/envelope_spec.rb

@@ -0,0 +1,132 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DocuSign::Envelope do
+  before(:each) do
+    @e = DocuSign::Envelope.new
+  end
+
+  it "should create a new envelope" do
+    @e.should be_an_instance_of(DocuSign::Envelope)
+  end
+
+  it "should respond to documents" do
+    @e.should respond_to(:documents)
+  end
+
+  describe "#documents" do
+    context "with no arguments" do
+      it "should return an empty document array" do
+        @e.documents.should == []
+      end
+    end
+
+    context "with arguments" do
+      before(:each) do
+        @documents = @e.documents do |e|
+          e.document :name => 'Document 1'
+          e.document :name => 'Document 2'
+        end
+      end
+
+      it "should build documents" do
+        @documents.all? { |t| t.is_a?(DocuSign::Document) }.should be_true
+      end
+
+      it "should build the appropriate number of tabs" do
+        @documents.size.should == 2
+      end
+    end
+  end
+
+  describe "#document" do
+    it "should build a document" do
+      @e.document.should be_an_instance_of(DocuSign::Document)
+    end
+
+    it "should pass in arguments" do
+      document = @e.document :name => "Document 1"
+      document.name.should == "Document 1"
+    end
+  end
+
+  it "should respond to recipients" do
+    @e.should respond_to(:recipients)
+  end
+
+  describe "#recipients" do
+    context "with no arguments" do
+      it "should return an empty recipient array" do
+        @e.recipients.should == []
+      end
+    end
+
+    context "with arguments" do
+      before(:each) do
+        @recipients = @e.recipients do |e|
+          e.recipient :id => 1
+          e.recipient :id => 2
+        end
+      end
+
+      it "should build recipients" do
+        @recipients.all? { |r| r.is_a?(DocuSign::Recipient) }.should be_true
+      end
+
+      it "should build the appropriate number of recipients" do
+        @recipients.size.should == 2
+      end
+    end
+  end
+
+  describe "#recipient" do
+    it "should build a recipient" do
+      @e.recipient.should be_an_instance_of(DocuSign::Recipient)
+    end
+
+    it "should pass in arguments" do
+      recipient = @e.recipient :id => 1
+      recipient.id.should == 1
+    end
+  end
+
+  it "should respond to tabs" do
+    @e.should respond_to(:tabs)
+  end
+
+  describe "#tabs" do
+    context "with no arguments" do
+      it "should return an empty tab array" do
+        @e.tabs.should == []
+      end
+    end
+
+    context "with arguments" do
+      before(:each) do
+        @tabs = @e.tabs stub(:id => 1) do |e|
+          e.tab :name => 'tab_1', :value => 'foo'
+          e.tab :name => 'tab_2', :value => 'bar'
+        end
+      end
+
+      it "should build tabs" do
+        @tabs.all? { |t| t.is_a?(DocuSign::Tab) }.should be_true
+      end
+
+      it "should build the appropriate number of tabs" do
+        @tabs.size.should == 2
+      end
+    end
+  end
+
+  describe "#tab" do
+    it "should build a tab" do
+      @e.tab.should be_an_instance_of(DocuSign::Tab)
+    end
+
+    it "should pass in arguments" do
+      tab = @e.tab :document_id => 1
+      tab.document_id.should == 1
+    end
+  end
+
+end

data/spec/docu_sign/post_processing_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Post Processing Group" do
+  before do
+    @client = DocuSign::Client.new(DOCU_SIGN_CONFIG)
+  end
+
+  describe "request_document_pdfs_ex" do
+    use_vcr_cassette :request_document_pdfs_ex, :record => :new_episodes
+    before do
+      envelope = DocuSign::Envelope.new.tap do |e|
+        e.transaction_id = "Test#{Time.now.to_i.to_s}"
+        e.account_id = "678cce00-95a7-4279-9101-557b3868d7aa"
+        e.asynchronous = false
+        e.subject = "Test Envelope"
+        e.notification do |n|
+          n.use_account_defaults = false
+          n.reminders = {
+            :reminder_enabled => true,
+            :reminder_delay => 2,
+            :reminder_frequency => 2
+          }
+          n.expirations = {
+            :expire_enabled => true,
+            :expire_after => 10,
+            :expire_warn => 2
+          }
+        end
+      end
+      # Documents
+      envelope.documents do |e|
+        file = File.open(File.dirname(__FILE__) + '/../fixtures/document.pdf', "rb")
+        contents = file.read
+        e.document :id => 1,
+          :name => "Document",
+          :pdf_bytes => Base64.encode64(contents),
+          :file_extension => 'pdf'
+      end
+      # Recipients
+      envelope.recipients do |e|
+        e.recipient :id => 1,
+          :user_name => "Recipient 1",
+          :email => "donald@donaldpiret.com",
+          :type => "Signer",
+          :require_id_lookup => false
+      end
+      # Tabs
+      envelope.tabs do |e|
+        e.tab :document_id => 1,
+          :recipient_id => 1,
+          :page_number => 1,
+          :x_position => 100,
+          :y_position => 200,
+          :type => "SignHere",
+          :anchor => {
+            :string => "blank",
+            :x => "200",
+            :y => 0,
+            :unit => "Pixels",
+            :ignore_if_not_present => false
+          }
+        e.tab :document_id => 1,
+          :recipient_id => 1,
+          :page_number => 1,
+          :x_position => 100,
+          :y_position => 200,
+          :type => "SignerAttachment",
+          :anchor => {
+            :string => "blank",
+            :x => "200",
+            :y => 0,
+            :unit => "Pixels",
+            :ignore_if_not_present => false
+          }
+      end
+      @envelope_id = @client.create_and_send_envelope(envelope).envelope_id
+    end
+
+    it "should successfully get an arry of document pdfs" do
+      response = @client.request_document_pd_fs_ex({"EnvelopeID" => @envelope_id})
+      response.should be_a_kind_of(Array)
+      response.first.should be_a_kind_of(DocuSign::DocumentPDF)
+    end
+  end
+end

data/spec/docu_sign/sending_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Sending Function Group" do
+  before do
+    @client = DocuSign::Client.new(DOCU_SIGN_CONFIG)
+  end
+
+  describe "create_and_send_envelope" do
+    use_vcr_cassette :create_and_send_envelope, :record => :new_episodes
+    it "should successfully create and send a simple envelope" do
+      envelope = DocuSign::Envelope.new.tap do |e|
+        e.transaction_id = "Test#{Time.now.to_i.to_s}"
+        e.account_id = "678cce00-95a7-4279-9101-557b3868d7aa"
+        e.asynchronous = false
+        e.subject = "Test Envelope"
+        e.notification do |n|
+          n.use_account_defaults = false
+          n.reminders = {
+            :reminder_enabled => true,
+            :reminder_delay => 2,
+            :reminder_frequency => 2
+          }
+          n.expirations = {
+            :expire_enabled => true,
+            :expire_after => 10,
+            :expire_warn => 2
+          }
+        end
+      end
+      # Documents
+      envelope.documents do |e|
+        file = File.open(File.dirname(__FILE__) + '/../fixtures/document.pdf', "rb")
+        contents = file.read
+        e.document :id => 1,
+          :name => "Document",
+          :pdf_bytes => Base64.encode64(contents),
+          :file_extension => 'pdf'
+      end
+      # Recipients
+      envelope.recipients do |e|
+        e.recipient :id => 1,
+          :user_name => "Recipient 1",
+          :email => "donald@donaldpiret.com",
+          :type => "Signer",
+          :require_id_lookup => false
+      end
+      # Tabs
+      envelope.tabs do |e|
+        e.tab :document_id => 1,
+          :recipient_id => 1,
+          :page_number => 1,
+          :x_position => 100,
+          :y_position => 200,
+          :type => "SignHere",
+          :anchor => {
+            :string => "blank",
+            :x => "200",
+            :y => 0,
+            :unit => "Pixels",
+            :ignore_if_not_present => false
+          }
+        e.tab :document_id => 1,
+          :recipient_id => 1,
+          :page_number => 1,
+          :x_position => 100,
+          :y_position => 200,
+          :type => "SignerAttachment",
+          :anchor => {
+            :string => "blank",
+            :x => "200",
+            :y => 0,
+            :unit => "Pixels",
+            :ignore_if_not_present => false
+          }
+      end
+      result = @client.create_and_send_envelope(envelope)
+      result.should be_an_instance_of(DocuSign::EnvelopeStatus)
+    end
+  end
+
+  describe "invalid requests" do
+    use_vcr_cassette :invalid_request
+
+    before do
+      @envelope = DocuSign::Envelope.new.tap do |e|
+        e.transaction_id = "Test#{Time.now.to_i.to_s}"
+        e.account_id = "678cce00-95a7-4279-9101-557b3868d7aa"
+        e.asynchronous = false
+      end
+    end
+
+    it "should successfully raise an error" do
+      lambda{ @client.create_and_send_envelope(@envelope) }.should raise_exception(DocuSign::Error)
+    end
+  end
+end

data/spec/docu_sign/status_spec.rb

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Status and Managing functions" do
+  before do
+    @client = DocuSign::Client.new(DOCU_SIGN_CONFIG)
+  end
+
+  describe "request_envelope" do
+    use_vcr_cassette :request_envelope
+    before do
+      @envelope = create_docusign_envelope
+    end
+
+    it "should correctly retrieve an envelope given an envelope id" do
+      envelope = @client.request_envelope({"EnvelopeID" => @envelope.envelope_id, "IncludeDocumentBytes" => "false"})
+      envelope.should be_an_instance_of(DocuSign::Envelope)
+    end
+  end
+  
+  describe "request_status" do
+    use_vcr_cassette :request_status
+    before do
+      @envelope = create_docusign_envelope
+    end
+    
+    it "should correctly retrieve an envelope status given an envelope id" do
+      @envelope_status = @client.request_status(:envelope_id => @envelope.envelope_id)
+      @envelope_status.recipient_statuses.first.status.should eq("Sent")
+    end
+  end
+  
+  describe "request_status_ex" do
+    use_vcr_cassette :request_status_ex
+    before do
+      @envelope = create_docusign_envelope
+    end
+    
+    it "should correctly retrieve the extended status given an envelope id" do
+      @envelope_status = @client.request_status_ex(:envelope_id => @envelope.envelope_id)
+      @envelope_status.recipient_statuses.first.status.should eq("Sent")
+    end
+  end
+  
+  describe "request_statuses" do
+    use_vcr_cassette :request_statuses, :record => :new_episodes
+    before do
+      @envelope = create_docusign_envelope
+      @envelope2 = create_docusign_envelope
+    end
+    
+    it "should correctly retrieve both envelope statuses" do
+      @envelope_statuses = @client.request_statuses(:envelope_status_filter => {"AccountId" => "678cce00-95a7-4279-9101-557b3868d7aa", "EnvelopeIds" => {"EnvelopeId" => [@envelope.envelope_id, @envelope2.envelope_id]}})
+      puts @envelope_statuses.inspect
+    end
+  end
+      
+
+  describe "void_envelope" do
+    use_vcr_cassette :void_envelope
+    before do
+      @envelope_id = create_docusign_envelope
+    end
+
+    it "should correctly void an envelope given an envelope id" do
+      @void = @client.void_envelope({"EnvelopeID" => @envelope_id, "Reason" => "Booking Cancelled"})
+      @void.should be_an_instance_of(DocuSign::VoidEnvelopeStatus)
+      @void.void_success.should be_true
+    end
+
+    it "should work with snake case input parameters" do
+      @void = @client.void_envelope(:envelope_id => @envelope_id, :reason => "Booking Cancelled")
+      @void.should be_an_instance_of(DocuSign::VoidEnvelopeStatus)
+      @void.void_success.should be_true
+    end
+  end
+
+  def create_docusign_envelope
+    envelope = DocuSign::Envelope.new.tap do |e|
+      e.transaction_id = "Test#{Time.now.to_i.to_s}"
+      e.account_id = "678cce00-95a7-4279-9101-557b3868d7aa"
+      e.asynchronous = false
+      e.subject = "Test Envelope"
+      e.notification do |n|
+        n.use_account_defaults = false
+        n.reminders = {
+          :reminder_enabled => true,
+          :reminder_delay => 2,
+          :reminder_frequency => 2
+        }
+        n.expirations = {
+          :expire_enabled => true,
+          :expire_after => 10,
+          :expire_warn => 2
+        }
+      end
+    end
+    # Documents
+    envelope.documents do |e|
+      file = File.open(File.dirname(__FILE__) + '/../fixtures/document.pdf', "rb")
+      contents = file.read
+      e.document :id => 1,
+        :name => "Document",
+        :pdf_bytes => Base64.encode64(contents),
+        :file_extension => 'pdf'
+    end
+    # Recipients
+    envelope.recipients do |e|
+      e.recipient :id => 1,
+        :user_name => "Recipient 1",
+        :email => "donald@donaldpiret.com",
+        :type => "Signer",
+        :require_id_lookup => false
+    end
+    # Tabs
+    envelope.tabs do |e|
+      e.tab :document_id => 1,
+        :recipient_id => 1,
+        :page_number => 1,
+        :x_position => 100,
+        :y_position => 200,
+        :type => "SignHere",
+        :anchor => {
+          :string => "blank",
+          :x => "200",
+          :y => 0,
+          :unit => "Pixels",
+          :ignore_if_not_present => false
+        }
+      e.tab :document_id => 1,
+        :recipient_id => 1,
+        :page_number => 1,
+        :x_position => 100,
+        :y_position => 200,
+        :type => "SignerAttachment",
+        :anchor => {
+          :string => "blank",
+          :x => "200",
+          :y => 0,
+          :unit => "Pixels",
+          :ignore_if_not_present => false
+        }
+    end
+    return @client.create_and_send_envelope(envelope)
+  end
+
+end