signatory 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+\.tmtags
+pkg/*
+*.gem
+.bundle

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create --install ruby-1.9.2@signatory

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    signatory (0.0.2)
+      activeresource (>= 2.3.9)
+      bundler (= 1.0.0)
+      oauth (= 0.4.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activeresource (2.3.9)
+      activesupport (= 2.3.9)
+    activesupport (2.3.9)
+    addressable (2.2.1)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    oauth (0.4.3)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    webmock (1.3.5)
+      addressable (>= 2.1.1)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource (>= 2.3.9)
+  bundler (= 1.0.0)
+  oauth (= 0.4.3)
+  rspec (= 2.0.0.beta.22)
+  signatory!
+  webmock (= 1.3.5)

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-08-26
+
+* 1 major enhancement:
+  * Initial release

data/README.rdoc

@@ -0,0 +1,96 @@
+= signatory
+
+* http://github.com/profounder/signatory
+
+== DESCRIPTION:
+
+A library to simplify interactions with the RightSignature API.  One of the primary goals of this library is to make the workflow clear to developers for using some of the more interesting features of the RightSignature system, eg: templates, document merges, and embedded signature frames.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  cred = Signatory::Credentials.load(File.open('rs.yml'))
+  if cred.oauth_ready? # true if access token is provided by the credential file otherwise false
+    # if you don't need to handle the credentials separately you can pass
+    # something that Signatory:Credentials can load (hash or file) instead
+    Signatory.credentials = cred
+
+    Signatory::Document.all # => List all documents
+    doc = Signatory::Document.find('XXXXXXXXXXX') # => Get document by id
+
+    ...
+
+    Signatory::Template.all # => List all templates
+    template = Signatory::Template.find('XXXXXXXXX') # => Get a template by id
+
+    merge_fields = [
+      Signatory::MergeField.new(:name => "Company Name", :value => "ABC Corp."),
+      Signatory::MergeField.new(:name => "Percentage", :value => "5.8%"),
+      Signatory::MergeField.new(:name => "Term", :value => "48 months"),
+      Signatory::MergeField.new(:name => "Monthly Payback", :value => "$30.00")
+    ]
+
+    # If you aren't embedding then you should include email addresses. You can
+    # also use instances of Signatory::Signer
+    roles = [
+      Signatory::Role.new(:role_name => 'Issuer', :name => 'Ryan Garver'),
+      Signatory::Role.new(:role_name => 'Investor', :name => 'Cary Dunn')
+    ]
+
+    doc = template.build_document(merge_fields, roles)
+
+    signer = doc.recipients.first # Order matters.  Returns a Signatory::Recipient
+
+    # Can be embedded with:
+    #
+    # <iframe src ="<%= signer.embed_url(redirect_url, :height => 500, :width => 700) %>"
+    #   width="700px" height="500px" frameborder="0" scrolling="no">
+    #  <p>Your browser does not support iframes.</p>
+    # </iframe>
+    #
+    # or use signer.embed_code(redirect_url, :height => 500, :width => 700) to generate the
+    # above code.  This will throw an exception if signer is not associated
+    # with a real document yet.
+  else
+    ... begin oauth workflow ...
+  end
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== THANKS:
+
+Special thanks to Cary Dunn at RightSignature for putting together a sample Rails app that formulated how the API should be used and introduced the embedded signing frame.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Ryan Garver
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'rubygems'
+require 'rubygems/specification'
+require 'bundler'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--colour', '--format', 'progress']
+end
+
+task :default => :spec

data/lib/signatory/api/base.rb

@@ -0,0 +1,43 @@
+module Signatory
+  module API
+    class Base < ActiveResource::Base
+      self.site = 'https://rightsignature.com/api/'
+
+      def id
+        guid
+      end
+
+      class << self
+        def instantiate_collection(collection, opts)
+          if collection.has_key?(formatted_collection_name)
+            collection = collection[formatted_collection_name]
+          end
+          super([collection[formatted_name]].flatten, opts)
+        end
+
+        def formatted_name
+          self.name.split('::').last.downcase
+        end
+
+        def formatted_collection_name
+          self.name.split('::').last.downcase.pluralize
+        end
+
+        def connection(refresh = false)
+          if defined?(@connection) || superclass == Object
+            @connection = Signatory::API::Connection.new(site, format) if refresh || @connection.nil?
+            @connection.proxy = proxy if proxy
+            @connection.user = user if user
+            @connection.password = password if password
+            @connection.auth_type = auth_type if auth_type
+            @connection.timeout = timeout if timeout
+            @connection.ssl_options = ssl_options if ssl_options
+            @connection
+          else
+            superclass.connection
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signatory/api/connection.rb

@@ -0,0 +1,14 @@
+module Signatory
+  module API
+    class Connection < ActiveResource::Connection
+      private
+      def new_http
+        Signatory.credentials.token
+      end
+
+      def apply_ssl_options(http)
+        http #noop
+      end
+    end
+  end
+end

data/lib/signatory/credentials.rb

@@ -0,0 +1,35 @@
+module Signatory
+  class Credentials
+    attr_accessor :key, :secret, :access_token, :access_secret
+
+    def initialize(key, secret, access_token, access_secret)
+      @key, @secret, @access_token, @access_secret = key, secret, access_token, access_secret
+    end
+
+    def self.load(source)
+      h = if source.respond_to?(:read)
+        YAML.load(source)
+      elsif source.is_a?(Hash)
+        source.inject({}){ |acc, (k, v)| acc[k.to_s] = v; acc}
+      end
+
+      new(h['key'], h['secret'], h['access_token'], h['access_secret'])
+    end
+
+    def token
+      @consumer ||= OAuth::Consumer.new(key, secret, {
+        :site               => 'https://rightsignature.com',
+        :scheme             => :header,
+        :http_method        => :post,
+        :request_token_path => "/oauth/request_token",
+        :access_token_path  => "/oauth/access_token",
+        :authorize_path     => "/oauth/authorize"
+      })
+      @token ||= OAuth::AccessToken.new(
+        @consumer,
+        access_token,
+        access_secret
+      )
+    end
+  end
+end

data/lib/signatory/document.rb

@@ -0,0 +1,12 @@
+module Signatory
+  class Document < API::Base
+    private
+    def self.instantiate_record(record, opts = {})
+      record['recipients'] = [record['recipients']['recipient']].flatten unless record['recipients'].nil? || record['recipients'].is_a?(Array)
+
+      doc = super(record, opts)
+      doc.recipients.each {|r| r.document = doc } if doc.respond_to?(:recipients)
+      doc
+    end
+  end
+end

data/lib/signatory/legacy_active_resource_hacks.rb

@@ -0,0 +1,37 @@
+module Signatory
+  module API
+    class Base < ActiveResource::Base
+
+      class << self
+        # This implementation is pulled directly from ActiveResource 3.0.0
+        # http://apidock.com/rails/ActiveResource/Base/all/class
+        def all(*args)
+          find(:all, *args)
+        end
+
+        # ActiveResource < 3.0.0 does not support auth_type
+        def connection(refresh = false)
+          if defined?(@connection) || superclass == Object
+            @connection = Signatory::API::Connection.new(site, format) if refresh || @connection.nil?
+            @connection.proxy = proxy if proxy
+            @connection.user = user if user
+            @connection.password = password if password
+            @connection.timeout = timeout if timeout
+            @connection.ssl_options = ssl_options if ssl_options
+            @connection
+          else
+            superclass.connection
+          end
+        end
+      end
+
+      def to_xml(options={})
+        fixed_attrs = attributes.clone
+        options[:except].each do |k|
+          fixed_attrs.delete(k.to_s)
+        end
+        fixed_attrs.to_xml({:root => self.class.element_name}.merge(options)){|b| yield(b) if block_given?}
+      end
+    end
+  end
+end

data/lib/signatory/merge_field.rb

@@ -0,0 +1,28 @@
+module Signatory
+  class MergeField < API::Base
+    def locked
+      attributes['locked'] || true
+    end
+
+    def id; attributes['id']; end
+
+    def to_xml(options = {})
+      identifier = {}
+      identifier.merge!({:merge_field_id => id}) unless attributes['id'].nil?
+      identifier.merge!({:merge_field_name => name}) unless attributes['name'].nil?
+      require 'builder' unless defined? ::Builder
+      options[:indent] ||= 2
+      xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
+      xml.tag!('merge_field', identifier) do
+        if attributes['value'].nil?
+          xml.page page
+          xml.name name
+          xml.id id
+        else
+          xml.value value
+          xml.locked locked
+        end
+      end
+    end
+  end
+end

data/lib/signatory/recipient.rb

@@ -0,0 +1,24 @@
+module Signatory
+  class Recipient < API::Base
+    def document=(doc)
+      @document = doc
+    end
+
+    def embed_url(redirect_url, options={})
+      signer_links = @document.get(:signer_links, "redirect_location" => redirect_url)
+      signer = [signer_links['signer_links']['signer_link']].flatten.select do |s|
+        s['role'] == role_id
+      end.first
+      options.merge!(:rt => signer['signer_token'])
+      params = options.sort.map{|k,v| "#{k}=#{v}"}.flatten.join('&')
+      "https://rightsignature.com/signatures/embedded?#{params}"
+    end
+
+    def embed_code(redirect_url, options={})
+      args = ['frameborder="0"', 'scrolling="no"']
+      args << "width=\"#{options[:width]}px\"" if options.has_key?(:width)
+      args << "height=\"#{options[:height]}px\"" if options.has_key?(:height)
+      "<iframe src =\"#{embed_url(redirect_url, options)}\" #{args.join(' ')}><p>Your browser does not support iframes.</p></iframe>"
+    end
+  end
+end

data/lib/signatory/role.rb

@@ -0,0 +1,27 @@
+module Signatory
+  class Role < API::Base
+    def email
+      attributes['email'] || 'noemail@rightsignature.com'
+    end
+
+    def to_xml(options = {})
+      identifier = {}
+      identifier.merge!({:role_id => role_id}) unless attributes['role_id'].nil?
+      identifier.merge!({:role_name => role_name}) unless attributes['role_name'].nil?
+      require 'builder' unless defined? ::Builder
+      options[:indent] ||= 2
+      xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
+      xml.role(identifier) do
+        if attributes['name'].nil?
+          xml.tag!('must-sign', must_sign)
+          xml.tag!('document-role-id', document_role_id)
+          xml.role role
+          xml.tag!('is-sender', is_sender)
+        else
+          xml.name name
+          xml.email email
+        end
+      end
+    end
+  end
+end

data/lib/signatory/ruby_hacks.rb

@@ -0,0 +1,7 @@
+unless Symbol.public_instance_methods.include?(:<=>)
+  class Symbol
+    def <=>(rhs)
+      to_s <=> rhs.to_s
+    end
+  end
+end

data/lib/signatory/template.rb

@@ -0,0 +1,43 @@
+module Signatory
+  class Template < API::Base
+    def prepackage
+      record = connection.format.decode(post(:prepackage).body)
+      Template.instantiate_record(record)
+    end
+
+    def build_document(merge_fields, roles)
+      doc_pkg = prepackage
+      doc_pkg.prefill_and_send(merge_fields, roles)
+    end
+
+    def prefill_and_send(merge_fields, roles)
+      attributes.merge!({
+        'merge_fields' => merge_fields,
+        'roles' => roles,
+        'action' => 'send'
+      })
+
+      doc = connection.format.decode(connection.post("/api/templates.xml", self.to_xml).body)
+      Document.find(doc['guid'])
+    end
+
+    def to_xml(opts = {})
+      super(opts.merge(:dasherize => false, :skip_types => true, :except => [:pages, :_type, :redirect_token, :content_type, :size, :tags])) do |b|
+        b.tag!(:tags) do
+          tags.split(" ").each do |tag|
+            b.tag!(:tag) { b.value tag}
+          end
+        end unless attributes['tags'].blank?
+      end
+    end
+
+    private
+    def self.instantiate_record(record, opts = {})
+      record['_type'] = record.delete('type') if record.has_key?('type')
+      record['roles'] = [record['roles']['role']].flatten unless record['roles'].nil? || record['roles'].is_a?(Array)
+      record['merge_fields'] = [record['merge_fields']['merge_field']].flatten unless record['merge_fields'].nil? || record['merge_fields'].is_a?(Array)
+
+      super(record, opts)
+    end
+  end
+end

data/lib/signatory/version.rb

@@ -0,0 +1,3 @@
+module Signatory
+  VERSION = '0.0.3'
+end

data/lib/signatory.rb

@@ -0,0 +1,36 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'signatory/ruby_hacks'
+require 'rubygems'
+require 'bundler/setup'
+require 'yaml'            unless defined?(YAML)
+require 'oauth'           unless defined?(OAuth)
+require 'active_resource' unless defined?(ActiveResource)
+
+module Signatory
+  class << self
+    def credentials=(creds)
+      if !creds.is_a?(Credentials)
+        creds = Credentials.load(creds)
+      end
+      @credentials = creds
+    end
+    def credentials; @credentials; end
+  end
+end
+
+require 'signatory/version'
+require 'signatory/api/connection'
+require 'signatory/api/base'
+require 'signatory/credentials'
+require 'signatory/document'
+require 'signatory/template'
+require 'signatory/role'
+require 'signatory/merge_field'
+require 'signatory/recipient'
+
+require 'active_resource/version'
+if ActiveResource::VERSION::STRING < '3.0.0'
+  require 'signatory/legacy_active_resource_hacks'
+end

data/signatory.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/signatory/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "signatory"
+  s.version     = Signatory::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan Garver"]
+  s.email       = ["ryan@profounder.com"]
+  s.homepage    = "http://rubygems.org/gems/signatory"
+  s.summary     = "API wrapper for RightSignature"
+  s.description = "Signatory provides a simple wrapper around the RightSignature API."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "signatory"
+
+  s.add_development_dependency "bundler", "= 1.0.0"
+  s.add_development_dependency "rspec", "= 2.0.0.beta.22"
+  s.add_development_dependency "webmock", "= 1.3.5"
+
+  s.add_dependency "bundler", "= 1.0.0"
+  s.add_dependency "oauth", "= 0.4.3"
+  s.add_dependency "activeresource", ">= 2.3.9"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/credentials_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Signatory::Credentials do
+  it "loads credentials from yaml" do
+    file = StringIO.new("---\nkey: thekey\nsecret: thesecret\naccess_token: accesstoken\naccess_secret: accesssecret")
+    creds = Signatory::Credentials.load(file)
+    creds.key.should == 'thekey'
+    creds.secret.should == 'thesecret'
+    creds.access_token.should == 'accesstoken'
+    creds.access_secret.should == 'accesssecret'
+  end
+  
+  it "loads credentials from hash" do
+    hash = {:key => 'thekey', :secret => 'thesecret', :access_token => 'accesstoken', :access_secret => 'accesssecret'}
+    creds = Signatory::Credentials.load(hash)
+    creds.key.should == 'thekey'
+    creds.secret.should == 'thesecret'
+    creds.access_token.should == 'accesstoken'
+    creds.access_secret.should == 'accesssecret'
+  end
+  
+  it "generates an access token from the credentials" do
+    consumer = stub!(:consumer)
+    OAuth::Consumer.should_receive(:new).with('thekey', 'thesecret', {
+      :site => 'https://rightsignature.com',
+      :scheme => :header,
+      :http_method => :post,
+      :request_token_path => "/oauth/request_token",
+      :access_token_path  => "/oauth/access_token",
+      :authorize_path     => "/oauth/authorize"
+    }).and_return(consumer)
+    access_token = stub!('access_token')
+    OAuth::AccessToken.should_receive(:new).with(consumer, 'accesstoken', 'accesssecret').and_return(access_token)
+    
+    hash = {:key => 'thekey', :secret => 'thesecret', :access_token => 'accesstoken', :access_secret => 'accesssecret'}
+    creds = Signatory::Credentials.load(hash)
+    creds.token.should be(access_token)
+  end
+end

data/spec/document_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Signatory::Document do
+  before(:each) do
+    Signatory.credentials = {:key => '123', :secret => '321'}
+  end
+  
+  describe ".all" do
+    it "returns a list of documents" do
+      stub_documents(:total_documents => 2)
+      documents = Signatory::Document.all
+      documents.count.should == 2
+      documents.each do |doc|
+        doc.should be_a(Signatory::Document)
+      end
+    end
+    
+    it "returns the right document" do
+      stub_documents(:total_documents => 1, :documents => [{:subject => 'This is a test', :guid => 'xxxyyy'}])
+      documents = Signatory::Document.all
+      documents.count.should == 1
+      document = documents.first
+      document.subject.should == 'This is a test'
+      document.id.should == 'xxxyyy'
+    end
+  end
+  
+  describe ".find by id" do
+    it "returns the document with the specified id" do
+      stub_document('xxxyyy', :subject => 'Test number 2')
+      doc = Signatory::Document.find('xxxyyy')
+      doc.subject.should == 'Test number 2'
+    end
+  end
+end

data/spec/fixtures/document.xml.erb

@@ -0,0 +1,51 @@
+<document>
+  <completed-at>2009-11-01T13:14:28-08:00</completed-at>
+  <thumbnail-url>https://thumbnail.png</thumbnail-url>
+  <message>Please sign the document.</message>
+  <form-fields>
+    <form-field>
+      <value>asdf</value>
+      <page>2</page>
+      <role-id>signer_B</role-id>
+      <name>Component 1</name>
+      <id>a_92208_asdf1234asdf_4709</id>
+    </form-field>
+  </form-fields>
+  <state>signed</state>
+  <pdf-url>https://pdfurl.pdf</pdf-url>
+  <deleted-at nil="true"></deleted-at>
+  <created-at>2009-11-01T12:29:36-08:00</created-at>
+  <is-public>false</is-public>
+  <signed-pdf-url>https://signedpdf.pdf</signed-pdf-url>
+  <original-filename>Application.pdf</original-filename>
+  <size>231740</size>
+  <recipients>
+    <recipient>
+      <state>signed</state>
+      <role-id>signer_B</role-id>
+      <must-sign>true</must-sign>
+      <is-sender>false</is-sender>
+      <email>support@rightsignature.com</email>
+      <name>John Bellingham</name>
+    </recipient>
+  </recipients>
+  <pages>
+    <page>
+      <original-template-filename>disclosure.pdf</original-template-filename>
+      <page-number>1</page-number>
+      <original-template-guid>a_154_fqLTIcNgcuIejFdhkVra</original-template-guid>
+    </page>
+    <page>
+      <original-template-filename>Application.pdf</original-template-filename>
+      <page-number>2</page-number>
+      <original-template-guid>a_311_yDhSZmJDtNEdPoZjfeF</original-template-guid>
+    </page>
+  </pages>
+  <subject><%= options[:subject] || "Employment Application" %></subject>
+  <guid><%= options[:guid] || 'ABCXYZ' %></guid>
+  <callback-location nil="true"></callback-location>
+  <processing-state>done-processing</processing-state>
+  <original-url>https://originaldoc.doc</original-url>
+  <content-type>package</content-type>
+  <expires-on>2009-11-06T16:00:00-08:00</expires-on>
+</document>