signatory 0.0.3

data/spec/fixtures/documents.xml.erb

@@ -0,0 +1,49 @@
+<page>
+  <total-documents><%= options[:total_documents] %></total-documents>
+  <current-page>1</current-page>
+  <total-pages>1</total-pages>
+  <per-page>10</per-page>
+  <documents>
+    <% options[:total_documents].times do |i| %>
+      <% document = options[:documents][i] %>
+      <document>
+        <completed-at nil="true"></completed-at>
+        <thumbnail-url>http://thumbnailurl.png</thumbnail-url>
+        <message>Please sign this document.</message>
+        <state>pending</state>
+        <pdf-url>http://pdfurl.pdf</pdf-url>
+        <deleted-at nil="true"></deleted-at>
+        <created-at>2009-11-04T10:15:14-08:00</created-at>
+        <is-public>false</is-public>
+        <signed-pdf-url>http://signedpdfurl.pdf</signed-pdf-url>
+        <original-filename>Application.pdf</original-filename>
+        <size>47351</size>
+        <recipients>
+          <recipient>
+            <state>pending</state>
+            <must-sign>true</must-sign>
+            <document-role-id>signer_A</document-role-id>
+            <is-sender>true</is-sender>
+            <email>support@rightsignature.com</email>
+            <name>John Bellingham</name>
+          </recipient>
+          <recipient>
+            <state>signed</state>
+            <must-sign>true</must-sign>
+            <document-role-id>signer_B</document-role-id>
+            <is-sender>false</is-sender>
+            <email>maria@rightsignature.com</email>
+            <name>Maria Montes</name>
+          </recipient>
+        </recipients>
+        <subject><%= document.nil? ? "Employment Application" : document[:subject] %></subject>
+        <guid><%= document.nil? ? 'ABCXYZ' : document[:guid] %></guid>
+        <callback-location>http://callbacklocation.com/gateway</callback-location>
+        <processing-state>done-processing</processing-state>
+        <original-url>http://pdfurl.pdf</original-url>
+        <content-type>pdf</content-type>
+        <expires-on>2009-12-04T16:00:00-08:00</expires-on>
+      </document>
+    <% end %>
+  </documents>
+</page>

data/spec/fixtures/template.xml.erb

@@ -0,0 +1,32 @@
+<template>
+  <thumbnail-url>https://thumbnail.png</thumbnail-url>
+  <merge-fields>
+    <merge-field>
+      <page>1</page>
+      <name>Employee Name</name>
+      <id><%= options[:guid] || "a_951_5c0634d166d44916b9e0b3" %></id>
+    </merge-field>
+  </merge-fields>
+  <message>Please sign this document.</message>
+  <created-at>2009-10-28T19:03:26-07:00</created-at>
+  <roles>
+    <role>
+      <must-sign>false</must-sign>
+      <document-role-id>cc_A</document-role-id>
+      <role>Document Sender</role>
+      <is-sender>true</is-sender>
+    </role>
+    <role>
+      <must-sign>true</must-sign>
+      <document-role-id>cc_B</document-role-id>
+      <role>Employer</role>
+      <is-sender>false</is-sender>
+    </role>
+  </roles>
+  <size>3524</size>
+  <subject><%= options[:subject] || "Employment Application Template" %></subject>
+  <guid><%= options[:guid] || "a_951_5c0634d166d44916b9e0b3" %></guid>
+  <processing-state>done-processing</processing-state>
+  <content-type>pdf</content-type>
+  <filename>Application.pdf</filename>
+</template>

data/spec/fixtures/template_prepackage.xml.erb

@@ -0,0 +1,28 @@
+<template>
+  <type>DocumentPackage</type>
+  <merge-fields>
+    <merge-field>
+      <page>1</page>
+      <name>Company Name</name>
+      <id>a_953_8fadb0169d1849b58d1fdd09688e73_5359</id>
+    </merge-field>
+  </merge-fields>
+  <page-breakdown>
+    <page>
+      <original-template-filename>Application.pdf</original-template-filename>
+      <page-number>2</page-number>
+      <original-template-guid>a_311_yDhSZmJDtNExtgJNuSPQFadPoZjfeF</original-template-guid>
+    </page>
+  </page-breakdown>
+  <created-at>2009-11-04T19:49:39-08:00</created-at>
+  <roles>
+    <role>
+      <must-sign>false</must-sign>
+      <document-role-id>cc_A</document-role-id>
+      <role>Employer</role>
+      <is-sender>true</is-sender>
+    </role>
+  </roles>
+  <redirect-token>b14235360ad946daa765c95c67f248a2-2-8fadb0169d1849b58dcb1fdd09688e73</redirect-token>
+  <guid><%= options[:guid] %></guid>
+</template>

data/spec/fixtures/template_sent.xml.erb

@@ -0,0 +1,4 @@
+<document>
+<status>sent</status>
+<guid><%= options[:guid] %></guid>
+</document>

data/spec/fixtures/templates.xml.erb

@@ -0,0 +1,13 @@
+<templates>
+  <% options[:templates].each do |template| %>
+    <template>
+      <thumbnail-url>https://thumbnail.png</thumbnail-url>
+      <message>Please sign this document.</message>
+      <created-at>2009-11-04T14:01:30-08:00</created-at>
+      <subject><%= template[:subject] || "Employment Application Template" %></subject>
+      <guid><%= template[:guid] || "a_951_5c0634d166d44916b9e0b3" %></guid>
+      <processing-state>done-processing</processing-state>
+      <filename>application.pdf</filename>
+    </template>
+  <% end %>
+</templates>

data/spec/helpers/right_signature_stub.rb

@@ -0,0 +1,81 @@
+require 'erb'
+
+module RightSignatureStub
+  def stub_documents(options={})
+    options = {
+      :total_documents => 2,
+      :documents => []
+    }.merge(options)
+
+    stub_request(:get, 'https://rightsignature.com/api/documents.xml').to_return(
+      :body => ERB.new(fixture('documents.xml.erb')).result(binding)
+    )
+  end
+
+  def stub_document(id, options={})
+    options = {
+      :guid => id
+    }.merge(options)
+
+    stub_request(:get, "https://rightsignature.com/api/documents/#{id}.xml").to_return(
+      :body => ERB.new(fixture('document.xml.erb')).result(binding)
+    )
+  end
+
+  def stub_templates(templates=[])
+    options = {
+      :templates => templates
+    }
+
+    stub_request(:get, "https://rightsignature.com/api/templates.xml").to_return(
+      :body => ERB.new(fixture('templates.xml.erb')).result(binding)
+    )
+  end
+
+  def stub_template(id, options={})
+    options = {
+      :guid => id
+    }.merge(options)
+
+    stub_request(:get, "https://rightsignature.com/api/templates/#{id}.xml").to_return(
+      :body => ERB.new(fixture('template.xml.erb')).result(binding)
+    )
+  end
+
+  def stub_template_send(id, doc_id, options = {})
+    options = {
+      :guid => doc_id
+    }.merge(options)
+
+    stub_request(:post, "https://rightsignature.com/api/templates.xml").with do |req|
+      sent = Hash.from_xml(req.body)['template']
+
+      sent['guid'] == id &&
+      sent['action'] == 'send' &&
+      options[:roles].all? { |role|
+        sent['roles']['role'].map{|r|
+          "#{r['name']}:#{r['email']}"
+        }.include?("#{role.name}:#{role.email}")
+      } &&
+      options[:merge_fields].all? {|field|
+        [sent['merge_fields']['merge_field']].flatten.map{|mf|
+          mf['value']
+        }.include?(field.value)
+      }
+    end.to_return(:body => ERB.new(fixture('template_sent.xml.erb')).result(binding))
+  end
+
+  def stub_prepackage(tid, id, options = {})
+    options = {
+      :guid => id
+    }.merge(options)
+
+    stub_request(:post, "https://rightsignature.com/api/templates/#{tid}/prepackage.xml").to_return(
+      :body => ERB.new(fixture('template_prepackage.xml.erb')).result(binding)
+    )
+  end
+
+  def fixture(name)
+    File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', name))
+  end
+end

data/spec/merge_field_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Signatory::MergeField do
+  describe ".to_xml" do
+    it "converts name specified merge field to xml" do
+      mf = Signatory::MergeField.new(:name=>"Company Name", :value=>"Double Rainbow, Inc.")
+      xml = mf.to_xml
+
+      xml.should =~ /<merge_field merge_field_name="Company Name">/
+      hash = Hash.from_xml(xml)
+      hash['merge_field']['value'].should == "Double Rainbow, Inc."
+      hash['merge_field']['locked'].should == "true"
+    end
+    
+    it "converts id specified merge field to xml" do
+      mf = Signatory::MergeField.new(:id=>"a_233_f309f82jklnm_232", :value=>"Double Rainbow, Inc.")
+      xml = mf.to_xml
+
+      xml.should =~ /<merge_field merge_field_id="a_233_f309f82jklnm_232">/
+      hash = Hash.from_xml(xml)
+      hash['merge_field']['value'].should == "Double Rainbow, Inc."
+      hash['merge_field']['locked'].should == "true"
+    end
+  end
+end

data/spec/recipient_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Signatory::Recipient do
+  before(:each) do
+    @document = Signatory::Document.new(:guid => 'XXXXX')
+    @recipient = Signatory::Recipient.new(
+      :name => "Bartholomew Davis McDugalheimer",
+      :is_sender => "false",
+      :must_sign => "true",
+      :role_id => "signer_A",
+      :state => "pending",
+      :email => "noemail@rightsignature.com"
+    )
+    @recipient.document = @document
+    stub_request(:get, "https://rightsignature.com/api/documents/XXXXX/signer_links.xml?redirect_location=http%3A%2F%2Fexample.com").
+      to_return(:body => "
+        <document>
+          <signer_links>
+            <signer_link>
+              <role>signer_A</role>
+              <signer_token>YYYY</signer_token>
+            </signer_link>
+          </signer_links>
+        </document>
+      ")
+  end
+
+  describe ".embed_url" do
+    it "generates the right url" do
+      @recipient.embed_url('http://example.com').should == "https://rightsignature.com/signatures/embedded?rt=YYYY"
+    end
+
+    it "generates the right url with dimensions" do
+      @recipient.embed_url('http://example.com', :height => 500, :width => 600).should == "https://rightsignature.com/signatures/embedded?height=500&rt=YYYY&width=600"
+    end
+  end
+
+  describe ".embed_code" do
+    it "generates the right iframe code" do
+      @recipient.embed_code('http://example.com').should == '<iframe src ="https://rightsignature.com/signatures/embedded?rt=YYYY" frameborder="0" scrolling="no"><p>Your browser does not support iframes.</p></iframe>'
+    end
+
+    it "generates the right iframe code with dimensions" do
+      @recipient.embed_code('http://example.com', :height => 500, :width => 600).should == '<iframe src ="https://rightsignature.com/signatures/embedded?height=500&rt=YYYY&width=600" frameborder="0" scrolling="no" width="600px" height="500px"><p>Your browser does not support iframes.</p></iframe>'
+    end
+  end
+end

data/spec/role_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Signatory::Role do
+  describe ".to_xml" do
+    it "converts name specified roles to xml" do
+      role = Signatory::Role.new(:name=>"RyGar", :role_name=>"Issuer", :email=>"noemail@rightsignature.com")
+      xml = role.to_xml
+
+      xml.should =~ /<role role_name="Issuer">/
+      hash = Hash.from_xml(xml)
+      hash['role']['name'].should == "RyGar"
+      hash['role']['email'].should == "noemail@rightsignature.com"
+    end
+    
+    it "converts id specified roles to xml" do
+      role = Signatory::Role.new(:name=>"RyGar", :role_id=>"signer_A", :email=>"noemail@rightsignature.com")
+      xml = role.to_xml
+
+      xml.should =~ /<role role_id="signer_A">/
+      hash = Hash.from_xml(xml)
+      hash['role']['name'].should == "RyGar"
+      hash['role']['email'].should == "noemail@rightsignature.com"
+    end
+  end
+end

data/spec/signatory_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Signatory do
+  describe ".credentials" do
+    it "takes a Signatory::Credentials" do
+      cred = Signatory::Credentials.new('XXX', 'YYY', 'AAA', 'BBB')
+      Signatory.credentials = cred
+      Signatory.credentials.key.should == 'XXX'
+      Signatory.credentials.secret.should == 'YYY'
+    end
+    
+    it "takes a read-able object" do
+      file = StringIO.new("---\nkey: thekey\nsecret: thesecret\naccess_token: accesstoken\naccess_secret: accesssecret")
+      Signatory.credentials = file
+      Signatory.credentials.key.should == 'thekey'
+      Signatory.credentials.secret.should == 'thesecret'
+    end
+    
+    it "takes a hash" do
+      Signatory.credentials = {:key => 'key1', :secret => 'secret1', :access_token => 'accesstoken', :access_secret => 'accesssecret'}
+      Signatory.credentials.key.should == 'key1'
+      Signatory.credentials.secret.should == 'secret1'
+    end
+  end
+  
+  it "uses oauth" do
+    token = Signatory.credentials.token
+    token.should_receive(:get).with('/api/documents/123.xml', {"Accept"=>"application/xml"}).and_return(mock('result', :code => 200, :body => '<document><name>Test</name></document>'))
+
+    Signatory::Document.find('123')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'stringio'
+require 'rspec'
+begin
+  require 'webmock/rspec'
+rescue LoadError
+  require 'rubygems'
+  require 'webmock/rspec'
+end
+
+Dir[File.join(File.dirname(__FILE__), 'helpers', '*.rb')].each do |f|
+  require f
+end
+
+require File.dirname(__FILE__) + '/../lib/signatory'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+  c.include WebMock
+  c.include RightSignatureStub
+
+  c.before(:each) do
+    Signatory.credentials = {:key => 'key1', :secret => 'secret1', :access_token => 'accesstoken', :access_secret => 'accesssecret'}
+  end
+end

data/spec/template_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Signatory::Template do
+  describe ".all" do
+    it "returns a list of templates" do
+      stub_templates([{:subject => "Template Subject"}, {:subject => "Template Subject 2"}])
+      templates = Signatory::Template.all
+      templates.count.should == 2
+      templates.each do |temp|
+        temp.should be_a(Signatory::Template)
+      end
+      subjects = templates.map{|t| t.subject}
+      subjects.should include("Template Subject")
+      subjects.should include("Template Subject 2")
+    end
+  end
+  
+  describe ".find by id" do
+    it "returns the template with the specified id" do
+      stub_template('xxxyyy', :subject => 'Blah blah')
+      temp = Signatory::Template.find('xxxyyy')
+      temp.subject.should == 'Blah blah'
+    end
+  end
+  
+  describe ".prepackage" do
+    it "should have roles and merge fields" do
+      temp = Signatory::Template.new(:guid => 'xxxyyy', :subject => 'Blah blah')
+      stub_prepackage('xxxyyy', 'yyyxxx')
+      packaged_temp = temp.prepackage
+      
+      packaged_temp.roles.map(&:role).should include('Employer')
+      packaged_temp.merge_fields.map(&:name).should include('Company Name')
+      packaged_temp.id.should == 'yyyxxx'
+    end
+  end
+  
+  describe ".build_document" do
+    it "returns a new document" do
+      temp = Signatory::Template.new(:guid => 'xxxyyy', :subject => 'Blah blah')
+      doc_pkg = Signatory::Template.new(:guid => 'abcabc', :type => 'DocumentPackage')
+      doc = Signatory::Document.new
+      
+      roles = [{:name => "Ryan Garver"}, {:name => "Cary Dunn"}]
+      merge_fields = {'Company Name' => 'ABC Corp'}
+      
+      temp.should_receive(:prepackage).and_return(doc_pkg)
+      doc_pkg.should_receive(:prefill_and_send).with(merge_fields, roles).and_return(doc)
+      
+      result = temp.build_document(merge_fields, roles)
+      result.should == doc
+    end
+  end
+  
+  context "type = DocumentPackage" do
+    describe ".signing_parties" do
+      it "returns all of the roles that must sign"
+    end
+
+    describe ".sender" do
+      it "returns the role who sent the document"
+    end
+
+    describe ".prefill_and_send" do
+      it "returns the sent document" do
+        doc_pkg = Signatory::Template.new(:guid => 'templid')
+        roles = [Signatory::Role.new(:name => "Ryan Garver", :role_name => 'Issuer'), Signatory::Role.new(:name => "Cary Dunn", :role_name => 'Investor')]
+        merge_fields = [Signatory::MergeField.new(:name => 'Company Name', :value => 'ABC Corp')]
+
+        id, subject = rand.to_s, "Subject #{rand}"
+        stub_template_send('templid', id, :roles => roles, :merge_fields => merge_fields)
+        stub_document(id, :subject => subject)
+        doc = doc_pkg.prefill_and_send(merge_fields, roles)
+        doc.guid.should == id
+        doc.subject.should == subject
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification 
+name: signatory
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Ryan Garver
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196431
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        version: 2.0.0.beta.22
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 3
+        - 5
+        version: 1.3.5
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 4
+        - 3
+        version: 0.4.3
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 3
+        - 9
+        version: 2.3.9
+  type: :runtime
+  version_requirements: *id006
+description: Signatory provides a simple wrapper around the RightSignature API.
+email: 
+- ryan@profounder.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- History.txt
+- README.rdoc
+- Rakefile
+- lib/signatory.rb
+- lib/signatory/api/base.rb
+- lib/signatory/api/connection.rb
+- lib/signatory/credentials.rb
+- lib/signatory/document.rb
+- lib/signatory/legacy_active_resource_hacks.rb
+- lib/signatory/merge_field.rb
+- lib/signatory/recipient.rb
+- lib/signatory/role.rb
+- lib/signatory/ruby_hacks.rb
+- lib/signatory/template.rb
+- lib/signatory/version.rb
+- signatory.gemspec
+- spec/credentials_spec.rb
+- spec/document_spec.rb
+- spec/fixtures/document.xml.erb
+- spec/fixtures/documents.xml.erb
+- spec/fixtures/template.xml.erb
+- spec/fixtures/template_prepackage.xml.erb
+- spec/fixtures/template_sent.xml.erb
+- spec/fixtures/templates.xml.erb
+- spec/helpers/right_signature_stub.rb
+- spec/merge_field_spec.rb
+- spec/recipient_spec.rb
+- spec/role_spec.rb
+- spec/signatory_spec.rb
+- spec/spec_helper.rb
+- spec/template_spec.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/signatory
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: signatory
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: API wrapper for RightSignature
+test_files: []
+