rightsignature 0.1.5 → 0.1.6

data/README.md

@@ -8,7 +8,7 @@ gem install rightsignature
 ```
 or in your Gemfile
 ```
-gem 'rightsignature', '~> 0.1.5'
+gem 'rightsignature', '~> 0.1.6'
 ```
 
 Setup
@@ -130,7 +130,7 @@ RightSignature::Document.send_document_from_file(File.open("here/is/myfile.pdf",
 ```
 * subject: Document subject
 * recipients: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
-    An optional :is_sender => true can be used to reference the API User and won't need to supply :name and :email. Ex. {:is_sender => true, :role => "cc"}
+    One recipient requires a :is_sender => true to reference the API User and doesn't need to supply :name and :email. Ex. {:is_sender => true, :role => "cc"}
 * Optional options:
     * description: document description that'll appear in the email
     * action: 'send' or 'redirect'. Redirect will prefill the document and generate a redirect token that can be used on for someone to send document under API user's account.
@@ -188,9 +188,12 @@ RightSignature::Template.details(guid)
 #####Prepackage and Send template
 Most common use of API, clones a template and sends it for signature.
 ```
-RightSignature::Template.prepackage_and_send(guid, subject, roles)
+RightSignature::Template.prepackage_and_send(guid, roles, options={})
 ```
+ * guid: template guid to use. Should be a template that was prepackaged
+ * roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :name => "a@example.com"}}
 Optional options:
+ * subject: document subject. Defaults to the subject in prepackage response.
  * description: document description that'll appear in the email
  * merge_fields: document merge fields, should be an array of merge_field_values in a hash with the merge_field_name.
      Ex. [{"Salary" => "$1,000,000"}]

data/lib/rightsignature/document.rb

@@ -217,8 +217,14 @@ module RightSignature
         response = RightSignature::Connection.get "/api/documents/#{guid}/signer_links.xml", params
         
         signer_links = []
-        response["document"]["signer_links"].each do |signer_link|
-          signer_links << {"name" => signer_link["signer_link"]["name"], "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=#{signer_link["signer_link"]["signer_token"]}"}
+        
+        if response["document"]["signer_links"]["signer_link"].is_a? Array
+          response["document"]["signer_links"]["signer_link"].each do |signer_link|
+            signer_links << {"name" => signer_link["name"], "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=#{signer_link["signer_token"]}"}
+          end
+        else
+          signer_link = response["document"]["signer_links"]["signer_link"]
+          signer_links << {"name" => signer_link["name"], "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=#{signer_link["signer_token"]}"}
         end
         signer_links
       end

data/lib/rightsignature/template.rb

@@ -90,10 +90,10 @@ module RightSignature
         RightSignature::Connection.post "/api/templates.xml", xml_hash
       end
       
-      def prepackage_and_send(guid, subject, roles, options={})
+      def prepackage_and_send(guid, roles, options={})
         response = prepackage(guid)
         new_guid = response["template"]["guid"]
-        send_template(new_guid, subject, roles, options)
+        send_template(new_guid, options.delete(:subject) || response["template"]["subject"], roles, options)
       end
       
       # Sends template.
@@ -225,11 +225,7 @@ module RightSignature
 
         recipients.each do |role_hash|
           key, value = role_hash.first
-          if role_hash[key]["email"]
-            role_hash[key]["email"] = "noemail@rightsignature.com"
-          else
-            role_hash[key][:email] = "noemail@rightsignature.com"
-          end
+          role_hash[key][:email] = "noemail@rightsignature.com" unless role_hash[key]["email"] || role_hash[key][:email]
         end
         
         response = send_template(template["guid"], options[:subject] || template["subject"], recipients, options)

data/lib/rightsignature/version.rb

@@ -1,3 +1,3 @@
 module RightSignature
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/document_spec.rb

@@ -256,10 +256,10 @@ describe RightSignature::Document do
   
   describe "get_signer_links_for" do
     it "should GET /api/documents/GUID123/signer_links.xml and return urls for signers" do
-      RightSignature::Connection.should_receive(:get).with("/api/documents/GUID123/signer_links.xml", {}).and_return({'document' => {'signer_links' => [
-        {'signer_link' => {"signer_token" => "avx37", "name" => "John Bellingham"}}, 
-        {'signer_link' => {"signer_token" => "fdh89", "name" => "Righty Jones"}}]
-      }})
+      RightSignature::Connection.should_receive(:get).with("/api/documents/GUID123/signer_links.xml", {}).and_return({'document' => {'signer_links' => {'signer_link' => [
+        {"signer_token" => "avx37", "name" => "John Bellingham"}, 
+        {"signer_token" => "fdh89", "name" => "Righty Jones"}]
+      }}})
       
       response = RightSignature::Document.get_signer_links_for("GUID123")
       response.size.should == 2
@@ -269,15 +269,26 @@ describe RightSignature::Document do
 
     it "should GET /api/documents/GUID123/signer_links.xml with URI encoded redirect location and return urls for signers" do
       RightSignature::Connection.should_receive(:get).with("/api/documents/GUID123/signer_links.xml", {:redirect_location => "http://google.com/redirected%20location"}
-      ).and_return({"document" => {'signer_links' => [
-        {'signer_link' => {"signer_token" => "avx37", "name" => "John Bellingham", "role" => "signer_A"}}, 
-        {'signer_link' => {"signer_token" => "fdh89", "name" => "Righty Jones", "role" => "signer_B"}}]
-      }})
+      ).and_return({'document' => {'signer_links' => {'signer_link' => [
+        {"signer_token" => "avx37", "name" => "John Bellingham"}, 
+        {"signer_token" => "fdh89", "name" => "Righty Jones"}]
+      }}})
       
       response = RightSignature::Document.get_signer_links_for("GUID123", "http://google.com/redirected location")
       response.size.should == 2
       response.include?({"name" => "John Bellingham", "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=avx37"}).should be_true
       response.include?({"name" => "Righty Jones", "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=fdh89"}).should be_true
     end
+
+    it "should GET /api/documents/GUID123/signer_links.xml with URI encoded redirect location and return urls for 1 signer_link" do
+      RightSignature::Connection.should_receive(:get).with("/api/documents/GUID123/signer_links.xml", {:redirect_location => "http://google.com/redirected%20location"}
+      ).and_return({'document' => {'signer_links' => {'signer_link' => 
+        {"signer_token" => "fdh89", "name" => "Righty Jones"}
+      }}})
+      
+      response = RightSignature::Document.get_signer_links_for("GUID123", "http://google.com/redirected location")
+      response.size.should == 1
+      response.include?({"name" => "Righty Jones", "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=fdh89"}).should be_true
+    end
   end
 end

data/spec/template_spec.rb

@@ -53,7 +53,24 @@ describe RightSignature::Template do
           :subject => "sign me", 
           :roles => []
         }})
-      RightSignature::Template.prepackage_and_send("GUID123", "sign me", [])
+      RightSignature::Template.prepackage_and_send("GUID123", [], {:subject => "sign me"})
+    end
+    
+    it "should default subject to one in Template prepackage response" do
+      RightSignature::Connection.should_receive(:post).with('/api/templates/GUID123/prepackage.xml', 
+        {}
+      ).and_return({"template" => {
+        "guid" => "a_123985_1z9v8pd654",
+        "subject" => "subject template",
+        "message" => "Default message here"
+      }})
+      RightSignature::Connection.should_receive(:post).with('/api/templates.xml', {:template => {
+          :guid => "a_123985_1z9v8pd654", 
+          :action => "send", 
+          :subject => "subject template", 
+          :roles => []
+        }})
+      RightSignature::Template.prepackage_and_send("GUID123", [])
     end
   end
 
@@ -220,10 +237,8 @@ describe RightSignature::Template do
   end
   
   describe "send_as_self_signers" do
-    it "should prepackage template, send template with reciepents with noemail@rightsignature.com and return self-signer links" do
-      RightSignature::Connection.should_receive(:post).with('/api/templates/TGUID/prepackage.xml', 
-        {}
-      ).and_return(  {"template"=>{
+    before do
+      @prepackage_response = {"template"=>{
         "type"=>"Document",
         "guid"=>"a_123_456",
         "created_at"=>"2012-09-25T14:51:44-07:00",
@@ -263,7 +278,19 @@ describe RightSignature::Template do
         "https%3A%2F%2Fs3.amazonaws.com%3A443%2Frightsignature.com%2Fassets%2F1464%2Fabcde_p1_t.png%3FSignature%3D1234AC",
         "redirect_token"=>
         "123456bcde"
-      }})
+      }}
+      
+      @sent_document_response = {"document"=> {
+        "status"=>"sent", 
+        "guid"=>"ABCDEFGH123"
+      }}
+      
+    end
+    
+    it "should prepackage template, send template with reciepents with noemail@rightsignature.com and return self-signer links" do
+      RightSignature::Connection.should_receive(:post).with('/api/templates/TGUID/prepackage.xml', 
+        {}
+      ).and_return(@prepackage_response)
       RightSignature::Connection.should_receive(:post).with('/api/templates.xml', {:template => {
           :guid => "a_123_456", 
           :action => "send", 
@@ -272,10 +299,7 @@ describe RightSignature::Template do
             {:role => {:name => "John Bellingham", :email => "noemail@rightsignature.com", "@role_name" => "Leasee"}},
             {:role => {:name => "Tim Else", :email => "noemail@rightsignature.com", "@role_name" => "Leaser"}}
           ]
-        }}).and_return({"document"=> {
-          "status"=>"sent", 
-          "guid"=>"ABCDEFGH123"
-        }})
+        }}).and_return(@sent_document_response)
       RightSignature::Connection.should_receive(:get).with("/api/documents/ABCDEFGH123/signer_links.xml", {}).and_return({"document" => {
         "signer_links" => [
           {"signer_link" => {"name" => "John Bellingham", "role" => "signer_A", "signer_token" => "slkfj2"}},
@@ -293,6 +317,35 @@ describe RightSignature::Template do
       results.include?({"name" => "Tim Else", "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=asfd1"})
     end
     
+    it "should not overwrite email if one is already set for receipient" do
+      RightSignature::Connection.should_receive(:post).with('/api/templates/TGUID/prepackage.xml', 
+        {}
+      ).and_return(@prepackage_response)
+      RightSignature::Connection.should_receive(:post).with('/api/templates.xml', {:template => {
+          :guid => "a_123_456", 
+          :action => "send", 
+          :subject => "subject template",
+          :roles => [
+            {:role => {:name => "John Bellingham", :email => "dontchange@example.com", "@role_name" => "Leasee"}},
+            {:role => {:name => "Tim Else", :email => "noemail@rightsignature.com", "@role_name" => "Leaser"}}
+          ]
+        }}).and_return(@sent_document_response)
+      RightSignature::Connection.should_receive(:get).with("/api/documents/ABCDEFGH123/signer_links.xml", {}).and_return({"document" => {
+        "signer_links" => [
+          {"signer_link" => {"name" => "John Bellingham", "email" => "dontchange@example.com", "role" => "signer_A", "signer_token" => "slkfj2"}},
+          {"signer_link" => {"name" => "Tim Else", "role" => "signer_B", "signer_token" => "asfd1"}}
+        ]
+      }})
+      
+      results = RightSignature::Template.send_as_embedded_signers("TGUID", [
+        {"Leasee" => {:name => "John Bellingham", :email => "dontchange@example.com"}}, 
+        {"Leaser" => {:name => "Tim Else"}}
+      ])
+      results.size.should == 2
+      results.include?({"name" => "John Bellingham", "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=slkfj2"})
+      results.include?({"name" => "Tim Else", "url" => "#{RightSignature::Connection.site}/signatures/embedded?rt=asfd1"})
+    end
+    
     it "should pass in options"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rightsignature
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors: