rightsignature 0.1.2 → 0.1.3

data/.gitignore

@@ -3,3 +3,4 @@
 .rvmrc
 *.swp
 *.swo
+Gemfile.lock

data/README.md

@@ -2,6 +2,15 @@ RightSignature API
 ==================
 This gem is a wrapper to RightSignature's API for both OAuth authentication and Token authentication
 
+#####Install
+```
+gem install rightsignature
+```
+or in your Gemfile
+```
+gem 'rightsignature', '~> 0.1.2'
+```
+
 Setup
 -----
 After getting an API key from RightSignature, you can use the Secure Token or generate an Access Token with the OAuth key and secret using RightSignature::load_configuration.
@@ -13,7 +22,12 @@ RightSignature::load_configuration(:api_token => YOUR_TOKEN)
 
 #####Using OAuth authentication
 ```
-RightSignature::load_configuration(:consumer_key => "Consumer123", :consumer_secret => "Secret098", :access_token => "AccessToken098", :access_secret => "AccessSecret123")
+RightSignature::load_configuration(
+  :consumer_key => "Consumer123", 
+  :consumer_secret => "Secret098", 
+  :access_token => "AccessToken098", 
+  :access_secret => "AccessSecret123"
+)
 ```
 Note: if the both OAuth credentials and api_token are set, the default action is to use Token Authentication.
 
@@ -140,6 +154,15 @@ filename = "Desired Filename.pdf"
 RightSignature::Document.send_document_from_file(raw_data, filename, 'My Subject', recipients)
 ```
 
+#####Embedded Signing Links
+Generates URLs for the embedded signing page for documents with recipients with email of 'noemail@rightsignature.com'. 
+Returns an array of {:name => "John Bellingham", "url" => "https://rightsignature.com/signatures/embedded?rt=1234"}
+```
+RightSignature::Document.get_signer_links_for(guid, redirect_location=nil)
+```
+Optional Option:
+ * redirect_location: URL to redirect user after signing.
+
 
 Templates
 ---------
@@ -198,6 +221,7 @@ Optional options:
      Ex. ['sent_from_api', {"user_id" => "32"}]
  * callback_url: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. 
      Ex. "http://yoursite/callback"
+
 ```
 options = {
   :description => "Please read over the handbook and sign it.",
@@ -231,6 +255,7 @@ Optional options:
      Ex. ['sent_from_api', {"user_id" => "32"}]
  * callback_url: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. 
      Ex. "http://yoursite/callback"
+
 ```
 options = {
   :description => "Please read over the handbook and sign it.",
@@ -248,6 +273,26 @@ options = {
 RightSignature::Template.send_template(guid, subject, roles, options)
 ```
 
+#####Embedded Signing Links for Sent Template
+Prepackages a template, and sends it out with each recipients marked as a embedded signer (email as noemail@rightsignature.com), then generates embedded signing URLs.
+Returns an array of {:name => "John Bellingham", "url" => "https://rightsignature.com/signatures/embedded?rt=1234"}
+```
+RightSignature::Template.send_as_embedded_signers(guid, recipients, options={})
+```
+ * guid: guid of template to create document with
+ * recipient: recipient names in array of {"Role Name" => {:name => "Your Name"}}
+ * options:
+   * subject: document subject that'll appear in the email
+   * 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"}]
+   * expires_in: number of days before expiring the document. API only allows 2,5,15, or 30.
+   * tags: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs)
+       Ex. ['sent_from_api', {"user_id" => "32"}]
+   * callback_url: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. 
+       Ex. "http://yoursite/callback"
+   * redirect_location: URL to redirect users after signing.
+
 #####Create New Template Link
 Generate a url that let's someone upload and create a template under OAuth user's account.
 ```
@@ -265,6 +310,7 @@ You can also add restrictions to what the person can do:
  * acceptable_merge_field_names: The user creating the Template will be forced to select one of the values provided. 
      There will be no free-form name entry when adding merge fields to the Template.
      Ex. ["Location", "Tax ID", "Company Name"]
+
 ```
 options = {
   :acceptable_merge_field_names => 
@@ -313,5 +359,4 @@ $:.push File.expand_path("../lib", __FILE__); require "rightsignature"; RightSig
 
 TODO:
 -----
-* Gemify me
 * Have a way for to generate an OAuth Access Token from RightSignature

data/lib/rightsignature/document.rb

@@ -211,6 +211,18 @@ module RightSignature
         "#{RightSignature::Connection.site}/builder/new?rt=#{response['document']['redirect_token']}"
       end
       
+      def get_signer_links_for(guid, redirect_location = nil)
+        params = {}
+        params[:redirect_location] = URI.encode(redirect_location) if redirect_location
+        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"]}"}
+        end
+        signer_links
+      end
+      
     end
   end
 end

data/lib/rightsignature/template.rb

@@ -172,6 +172,72 @@ module RightSignature
         "#{RightSignature::Connection.site}/builder/new?rt=#{redirect_token}"
       end
       
+      # Sends template with all roles as embedded signers and returns an array of hashes with :name and :url for each signer link.
+      # * guid: templates guid. Ex. a_1_zcfdidf8fi23
+      # * roles: Recipients of the document, should be an array of role names in a hash with keys as role_names. 
+      #     Ex. [{"Employee" => {:name => "John Employee"}]
+      #       is equivalent to 
+      #         <role role_name="Employee">
+      #           <name>John Employee</name>
+      #           <email>noemail@rightsignature.com</email>
+      #         </role>
+      # * options: other optional values
+      #     - subject: subject of the document that'll appear in email. Defaults to Template's subject
+      #     - 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"}]
+      #           is equivalent to 
+      #             <merge_field merge_field_name="Salary">
+      #             <value>$1,000,000</value>
+      #             </merge_field>
+      #     - expires_in: number of days before expiring the document. API only allows 2,5,15, or 30.
+      #     - tags: document tags, an array of {:name => 'tag_name'} (for simple tag) or {:name => 'tag_name', :value => 'value'} (for tuples pairs)
+      #         Ex. [{:name => 'sent_from_api'}, {:name => "user_id", :value => "32"}]
+      #     - callback_url: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. 
+      #         Ex. "http://yoursite/callback"
+      #     - redirect_location: A URI encoded URL that specifies the location for the signing widget to redirect the user to after it is signed. 
+      #         Ex. "http://yoursite/thanks_for_signing"
+      # 
+      # Ex. call with all options used
+      #   RightSignature::Template.prefill(
+      #     "a_1_zcfdidf8fi23", 
+      #     "Your Employee Handbook", 
+      #     [{"employee" => {:name => "John Employee", :email => "john@employee.com"}}],
+      #     {
+      #       :description => "Please read over the handbook and sign it.",
+      #       :merge_fields => [
+      #         { "Department" => "Fun and games" },
+      #         { "Salary" => "$1,000,000" }
+      #       ],
+      #       :expires_in => 5,
+      #       :tags => [
+      #         {:name => 'sent_from_api'},
+      #         {:name => 'user_id', :value => '32'}
+      #       ],
+      #       :callback_url => "http://yoursite/callback"
+      #     })
+      def send_as_embedded_signers(guid, recipients, options={})
+        redirect_location = options.delete(:redirect_location)
+
+        response = prepackage(guid)
+        template = response["template"]
+
+        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
+        end
+        
+        response = send_template(template["guid"], options[:subject] || template["subject"], recipients, options)
+        document_guid = response["document"]["guid"]
+        
+        RightSignature::Document.get_signer_links_for(document_guid, redirect_location)
+      end
+      
+      
     end
   end
 end

data/lib/rightsignature/version.rb

@@ -1,3 +1,3 @@
 module RightSignature
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/document_spec.rb

@@ -253,4 +253,31 @@ describe RightSignature::Document do
       RightSignature::Document.generate_document_redirect_url("subjy", [], {}).should == "#{RightSignature::Connection.site}/builder/new?rt=REDIRECT_TOKEN"
     end
   end
+  
+  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"}}]
+      }})
+      
+      response = RightSignature::Document.get_signer_links_for("GUID123")
+      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 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"}}]
+      }})
+      
+      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
+  end
 end

data/spec/template_spec.rb

@@ -186,4 +186,81 @@ describe RightSignature::Template do
       end
     end
   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"=>{
+        "type"=>"Document",
+        "guid"=>"a_123_456",
+        "created_at"=>"2012-09-25T14:51:44-07:00",
+        "filename"=>"assets-363-demo_document.pdf",
+        "size"=>"14597",
+        "content_type"=>"pdf",
+        "page_count"=>"1",
+        "subject"=>"subject template",
+        "message"=>"Default message here",
+        "tags"=>"template_id:31,user:1",
+        "processing_state"=>"done-processing",
+        "roles"=>
+        {"role"=>
+          [{"role"=>"Document Sender",
+            "name"=>"Document Sender",
+            "must_sign"=>"false",
+            "document_role_id"=>"cc_A",
+            "is_sender"=>"true"},
+           {"role"=>"Leasee",
+            "name"=>"Leasee",
+            "must_sign"=>"true",
+            "document_role_id"=>"signer_A",
+            "is_sender"=>"false"},
+           {"role"=>"Leaser",
+            "name"=>"Leaser",
+            "must_sign"=>"true",
+            "document_role_id"=>"signer_B",
+            "is_sender"=>"true"}]},
+        "merge_fields"=>nil,
+        "pages"=>
+          {"page"=>
+            {"page_number"=>"1",
+             "original_template_guid"=>"GUID123",
+             "original_template_filename"=>"demo_document.pdf"}
+          },
+        "thumbnail_url"=>
+        "https%3A%2F%2Fs3.amazonaws.com%3A443%2Frightsignature.com%2Fassets%2F1464%2Fabcde_p1_t.png%3FSignature%3D1234AC",
+        "redirect_token"=>
+        "123456bcde"
+      }})
+      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 => "noemail@rightsignature.com", "@role_name" => "Leasee"}},
+            {:role => {:name => "Tim Else", :email => "noemail@rightsignature.com", "@role_name" => "Leaser"}}
+          ]
+        }}).and_return({"document"=> {
+          "status"=>"sent", 
+          "guid"=>"ABCDEFGH123"
+        }})
+      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"}},
+          {"signer_link" => {"name" => "Tim Else", "role" => "signer_B", "signer_token" => "asfd1"}}
+        ]
+      }})
+      
+      
+      results = RightSignature::Template.send_as_embedded_signers("TGUID", [
+        {"Leasee" => {:name => "John Bellingham"}}, 
+        {"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.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,7 +118,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - README.md
 - lib/rightsignature.rb
 - lib/rightsignature/connection.rb

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rightsignature (0.1.0)
-      bundler (>= 1.0.0)
-      httparty (>= 0.9.0)
-      oauth (= 0.4.3)
-      xml-fu (>= 0.1.7)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    builder (3.1.3)
-    diff-lcs (1.1.3)
-    httparty (0.9.0)
-      multi_json (~> 1.0)
-      multi_xml
-    multi_json (1.3.6)
-    multi_xml (0.5.1)
-    oauth (0.4.3)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
-    xml-fu (0.1.7)
-      builder (>= 2.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.0.0)
-  rightsignature!
-  rspec (>= 2.11.0)