rightsignature 1.0.0 → 1.0.1

data/.gitignore

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rightsignature/account.rb

@@ -1,13 +1,32 @@
 module RightSignature
   module Account 
+    # Return account information about API user
+    # 
+    # Ex. 
+    #   @rs_connection.user_details
+    # 
     def user_details
       get "/api/users/user_details.xml"
     end
     
+    # Creates a user on API user's account
+    # * name: User's name
+    # * email: User's email
+    # 
+    # Ex. 
+    #   @rs_connection.add_user("John Bellingham", "john@example.com")
+    # 
     def add_user(name, email)
       post "/api/users.xml", {:user => {:name => name, :email => email}}
     end
     
+    # Return account's usage report (# of documents sent)
+    # * <b>since</b>: ("month"/"week"/"day") only count documents sent within a certain time
+    # * <b>signed</b>: (true/false) only count signed document
+    # 
+    # Ex. Return count of signed documents sent this month
+    #   @rs_connection.usage_report("month", true)
+    # 
     def usage_report(since=nil, signed=nil)
       options = {}
       options[:since] = since if since && ["month", "week", "day"].include?(since)

data/lib/rightsignature/connection.rb

@@ -8,6 +8,22 @@ module RightSignature
     attr_accessor :oauth_connection
     attr_accessor :token_connection
 
+    # Creates new instance of RightSignature::Connection to make API calls
+    # * <b>creds</b>: Hash of credentials for API Token or OAuth. If both are specified, it uses API Token
+    #   * Hash key for API Token:
+    #     * :api_token
+    #   * Hash keys for OAuth:
+    #     * :consumer_key
+    #     * :consumer_secret
+    #     * :access_token
+    #     * :access_secret
+    #     
+    # Example for Api Token:
+    #   @rs_connection = RightSignature::Connection.new(:api_token => "MYTOKEN")
+    # 
+    # Example for OAuth:
+    #   @rs_connection = RightSignature::Connection.new(:consumer_key => "ckey", :consumer_secret => "csecret", :access_token => "atoken", :access_secret => "asecret")
+    # 
     def initialize(creds={})
       @configuration = {}
       RightSignature::Connection.oauth_keys.each do |key|
@@ -24,10 +40,14 @@ module RightSignature
       @configuration
     end
 
+    # Checks if credentials are set for either API Token or for OAuth 
+    # 
     def check_credentials
       raise "Please set load_configuration with #{RightSignature::Connection.api_token_keys.join(',')} or #{RightSignature::Connection.oauth_keys.join(',')}" unless has_api_token? || has_oauth_credentials?
     end
 
+    # Checks if API Token credentials are set. Does not validate creds with server.
+    # 
     def has_api_token?
       return false if @configuration.nil?
       RightSignature::Connection.api_token_keys.each do |key|
@@ -37,6 +57,8 @@ module RightSignature
       return true
     end
 
+    # Checks if OAuth credentials are set. Does not validate creds with server.
+    # 
     def has_oauth_credentials?
       return false if @configuration.nil?
       RightSignature::Connection.oauth_keys.each do |key| 
@@ -46,14 +68,17 @@ module RightSignature
       return true
     end
 
+    # :nodoc:
     def self.oauth_keys
       [:consumer_key, :consumer_secret, :access_token, :access_secret].freeze
     end
 
+    # :nodoc:
     def self.api_token_keys
       [:api_token].freeze
     end    
     
+    # :nodoc:
     def site
       if has_api_token?
         RightSignature::TokenConnection.base_uri
@@ -62,6 +87,16 @@ module RightSignature
       end
     end
 
+    # PUT request to server
+    # 
+    # Arguments:
+    #   url: Path of API call
+    #   body: XML body in hash format
+    #   url: Hash of HTTP headers to include
+    # 
+    # Example:
+    #   @rs_connection.put("/api/documents.xml", {:documents=> {}}, {"User-Agent" => "My Own"})
+    # 
     def put(url, body={}, headers={})
       if has_api_token?
         options = {}
@@ -74,6 +109,15 @@ module RightSignature
       end
     end
 
+    # DELETE request to server
+    # 
+    # Arguments:
+    #   url: Path of API call
+    #   url: Hash of HTTP headers to include
+    # 
+    # Example:
+    #   @rs_connection.delete("/api/users.xml", {"User-Agent" => "My Own"})
+    # 
     def delete(url, headers={})
       if has_api_token?
         options = {}
@@ -85,6 +129,16 @@ module RightSignature
       end
     end
 
+    # GET request to server
+    # 
+    # Arguments:
+    #   url: Path of API call
+    #   params: Hash of URL parameters to include in request
+    #   url: Hash of HTTP headers to include
+    # 
+    # Example:
+    #   @rs_connection.get("/api/documents.xml", {:search => "my term"}, {"User-Agent" => "My Own"})
+    # 
     def get(url, params={}, headers={})
       check_credentials
       
@@ -101,6 +155,15 @@ module RightSignature
       end
     end
 
+    # POST request to server
+    # 
+    # Arguments:
+    #   url: Path of API call
+    #   url: Hash of HTTP headers to include
+    # 
+    # Example:
+    #   @rs_connection.post("/api/users.xml", {"User-Agent" => "My Own"})
+    # 
     def post(url, body={}, headers={})
       check_credentials
       
@@ -114,6 +177,16 @@ module RightSignature
       end
     end
     
+    # Attempts to parse response from a connection and return it as a hash. 
+    # If response isn't a success, an RightSignature::ResponseError is raised
+    # 
+    # Arguments:
+    #   url: Path of API call
+    #   url: Hash of HTTP headers to include
+    # 
+    # Example:
+    #   @rs_connection.delete("/api/users.xml", {"User-Agent" => "My Own"})
+    # 
     def parse_response(response)
       if response.is_a? Net::HTTPResponse
         unless response.is_a? Net::HTTPSuccess

data/lib/rightsignature/connection/oauth_connection.rb

@@ -3,6 +3,17 @@ module RightSignature
     attr_reader :request_token
     attr_reader :consumer_key, :consumer_secret, :oauth_access_token, :oauth_access_secret
 
+    # Creates new instance of RightSignature::OauthConnection to make API calls
+    # * <b>creds</b>: Hash of credentials for OAuth. 
+    #   * Hash keys for OAuth:
+    #     * :consumer_key
+    #     * :consumer_secret
+    #     * :access_token
+    #     * :access_secret
+    #     
+    # Example:
+    #   @rs_oauth = RightSignature::OauthConnection.new(:consumer_key => "ckey", :consumer_secret => "csecret", :access_token => "atoken", :access_secret => "asecret")
+    # 
     def initialize(credentials={})
       @consumer_key = credentials[:consumer_key]
       @consumer_secret = credentials[:consumer_secret]
@@ -10,6 +21,7 @@ module RightSignature
       @oauth_access_secret = credentials[:access_secret]
     end
     
+    # Oauth consumer
     def oauth_consumer
       check_credentials unless @consumer_key && @consumer_secret
       @oauth_consumer ||= OAuth::Consumer.new(
@@ -26,21 +38,30 @@ module RightSignature
       )
     end
     
+    # Access token
     def access_token
       check_credentials
       @access_token ||= OAuth::AccessToken.new(oauth_consumer,  @oauth_access_token,  @oauth_access_secret)
     end
-        
+
+    # Replaces access token 
+    # * <b>access_token</b>: access token key
+    # * <b>access_secret</b>: access token secret
+    # 
     def set_access_token(access_token, access_secret)
       @oauth_access_token = access_token
       @oauth_access_secret = access_secret
       @access_token = OAuth::AccessToken.new(oauth_consumer, @oauth_access_token, @oauth_access_secret)
     end
     
+    # Uses consumer to generate a request token.
     def new_request_token
       @request_token = oauth_consumer.get_request_token
     end
     
+    # Uses request token and given OAuth verifier to generate an access token. Requires a request token to be set.
+    # * <b>oauth_verifier</b>: OAuth verifier
+    # 
     def generate_access_token(oauth_verifier)
       raise "Please set request token with new_request_token" unless @request_token
       @access_token = @request_token.get_access_token(:oauth_verifier =>  oauth_verifier)
@@ -49,6 +70,10 @@ module RightSignature
       @access_token
     end
     
+    # Generates HTTP request with oauth credentials. Require access_token to be set.
+    # * <b>method</b>: HTTP Method. Ex. ('get'/'post'/'delete'/'put')
+    # * <b>options</b>: OAuth::AccessToken options to pass. Last option should be headers
+    # 
     def request(method, *options)
       options.last ||= {}
       options.last["Accept"] ||= "*/*"
@@ -58,10 +83,12 @@ module RightSignature
     end
     
   private
+    # Raises exception if OAuth credentials are not set.
     def check_credentials
       raise "Please set #{RightSignature::Connection.oauth_keys.join(', ')}" unless has_oauth_credentials?
     end
 
+    # Checks if OAuth credentials are set.
     def has_oauth_credentials?
       [@consumer_key, @consumer_secret, @oauth_access_token, @oauth_access_secret].each do |cred| 
         return false if cred.nil? || cred.match(/^\s*$/)

data/lib/rightsignature/connection/token_connection.rb

@@ -6,11 +6,21 @@ module RightSignature
     
     attr_reader :api_token
 
+    # Creates new instance of RightSignature::TokenConnection to make API calls
+    # * <b>api_token</b>: API Token. 
+    #     
+    # Example:
+    #   @rs_token = RightSignature::TokenConnection.new("APITOKEN")
+    # 
     def initialize(api_token)
       @api_token = api_token
     end
     
-
+    # Generates HTTP request with token credentials. Require api_token to be set.
+    # * <b>method</b>: HTTP Method. Ex. ('get'/'post'/'delete'/'put')
+    # * <b>url</b>: request path/url of request
+    # * <b>options</b>: HTTPary options to pass. Last option should be headers
+    # 
     def request(method, url, options)
       raise "Please set api_token" if @api_token.nil? || @api_token.empty?
       
@@ -18,9 +28,9 @@ module RightSignature
       options[:headers]['api-token'] = @api_token
       options[:headers]["Accept"] ||= "*/*"
       options[:headers]["content-type"] ||= "application/xml"
-      __send__(method, url, options)
+      self.class.__send__(method, url, options)
     end
     
   end
 
-end
+end

data/lib/rightsignature/document.rb

@@ -2,152 +2,240 @@ module RightSignature
   module Document
     include RightSignature::Helpers
 
+    # Lists documents 
+    #   * <b>options</b>: (optional) search filters
+    #     * <b>:state</b> - (completed/trashed/pending) filter by state
+    #     * <b>:page</b> - page offset
+    #     * <b>:per_page</b> - # of entries per page to return
+    #     * <b>:search</b> - search term filter
+    #     * <b>:tags</b> - tags filter. Array of ["single_tag", {"tag_key" => "tag_value"}]
+    #     * <b>:sort</> - sort documents by given attribute. 
+    #     API supports 'created', 'completed', and 'activity'
+    #     * <b>:range</b> - ('today'/'thisweek'/'thismonth'/'alltime'/Date) return documents with a certain date range.
+    #     * <b> :recipient_email</b> - filter document where it has a recipient with given email and involves the current OAuth user. 
+    #     * <b> :account</b> - (true/false) include all documents in current account if true.
+    # 
+    # Ex.
+    #   options = {
+    #     :state => ['completed', 'trashed'],
+    #     :page => 1,
+    #     :per_page => 20,
+    #     :search => "me",
+    #     :tags => ["single_tag", "key" => "with_value"]
+    #   }
+    # 
+    #   @rs_connection.documents_list(options)
+    # 
     def documents_list(options={})
       options[:tags] = TagsHelper.mixed_array_to_string_array(options[:tags]) if options[:tags]
       options[:state] = options[:state].join(',') if options[:state] && options[:state].is_a?(Array)
       get "/api/documents.xml", options
     end
     
+    # Gets details for a document
+    # * <b>guids</b>: Array of document GUIDs
+    # 
+    # Ex. Get details for document GUID123
+    #   @rs_connection.document_details("GUID123")
+    #
     def document_details(guid)
       get "/api/documents/#{guid}.xml"
     end
     
+    # Gets details for multiple documents.
+    # * <b>guids</b>: Array of document GUIDs
+    # 
+    # Ex. Get details for documents GUID123 and GUID345
+    #   @rs_connection.documents_batch_details(["GUID123","GUID345"])
+    #
     def documents_batch_details(guids)
       get "/api/documents/#{guids.join(',')}/batch_details.xml"
     end
     
+    # Sends a reminder for a document
+    # * <b>guid</b>: Document GUID
+    # 
+    # Ex. Sends reminder for document GUID123
+    #   @rs_connection.send_reminder("GUID123")
+    #
     def send_reminder(guid)
       post "/api/documents/#{guid}/send_reminders.xml", {}
     end
     
+    # Extends a document's expiration date by 7 days
+    # * <b>guid</b>: Document GUID
+    # 
+    # Ex. Extend expiration for document GUID123 by 7 days
+    #   @rs_connection.trash_document("GUID123")
+    #
     def trash_document(guid)
       post "/api/documents/#{guid}/trash.xml", {}
     end
 
+    
+    # Extends a document's expiration date by 7 days
+    # * <b>guid</b>: Document GUID
+    # 
+    # Ex. Extend expiration for document GUID123 by 7 days
+    #   @rs_connection.extend_document_expiration("GUID123")
+    #
     def extend_document_expiration(guid)
       post "/api/documents/#{guid}/extend_expiration.xml", {}
     end
     
-    # This will REPLACE the tags on a document
+    # <b>REPLACE</b> the tags on a document
     # tags are an array of 'tag_name' or {'tag_name' => 'value'}
-    # Hash style:
-    # {:name => value}
+    # 
+    # Ex. Replaces document GUID123 with tags "single_tag", "hello:bye"
+    #   @rs_connection.update_document_tags("GUID123", ["single_tag", {"hello" => "bye"}])
     def update_document_tags(guid, tags)
       post "/api/documents/#{guid}/update_tags.xml", { :tags => TagsHelper.array_to_xml_hash(tags) }
     end
     
     # Creates a document from a raw data
-    # * file: file binary. Ex. File.read('myfile.pdf')
-    # * filename: original filename
-    # * subject: subject of the document that'll appear in email
-    # * recipients: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
-    #     An optional :is_sender (true/false) is used to referrence the API User and won't need to supply :name and :email
-    #     Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
+    # * <b>file</b>: file binary. Ex. File.read('myfile.pdf')
+    # * <b>filename</b>: original filename
+    # * <b>subject</b>: subject of the document that'll appear in email
+    # * <b>recipients</b>: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
+    #   One of the recipients requires <b>:is_sender</b> (true/false) to reference the API User and won't need to supply :name and :email
+    #   Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
     #     [
     #       {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
     #       {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
     #       {'is_sender' => true, :role => 'signer'},
     #     ]
-    # * options: other optional values
-    #     - description: document description that'll appear in the email
-    #     - action: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
-    #     - 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"
-    #     - use_text_tags: Document has special Text Tags that RightSignature parse. true or false.
-    #         More info: https://rightsignature.com/apidocs/text_tags
+    # * <b>options</b>: other optional values
+    #   - <b>description</b>: document description that'll appear in the email
+    #   - <b>action</b>: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
+    #   - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   - <b>tags</b>: 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"}]
+    #   - <b>callback_url</b>: 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"
+    #   - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
+    #     More info: https://rightsignature.com/apidocs/text_tags
     def send_document_from_data(file_data, filename, subject, recipients, options={})
       send_document(subject, recipients, {:type => "base64", :filename => filename, :value => Base64::encode64(file_data)}, options)
     end
     
     # Creates a document from a File or path to file
-    # * file: Path to file or File object
-    # * subject: subject of the document that'll appear in email
-    # * recipients: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
-    #     An optional :is_sender (true/false) is used to referrence the API User and won't need to supply :name and :email
-    #     Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
+    # * <b>file</b>: Path to file or File object
+    # * <b>subject</b>: subject of the document that'll appear in email
+    # * <b>recipients</b>: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
+    #   One of the recipients requires <b>:is_sender</b> (true/false) to reference the API User and won't need to supply :name and :email
+    #   Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
     #     [
     #       {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
     #       {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
     #       {'is_sender' => true, :role => 'signer'},
     #     ]
-    # * options: other optional values
-    #     - description: document description that'll appear in the email
-    #     - action: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
-    #     - 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"
-    #     - use_text_tags: Document has special Text Tags that RightSignature parse. true or false.
-    #         More info: https://rightsignature.com/apidocs/text_tags
+    # * <b>options</b>: other optional values
+    #   - <b>description</b>: document description that'll appear in the email
+    #   - <b>action</b>: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
+    #   - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   - <b>tags</b>: 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"}]
+    #   - <b>callback_url</b>: 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"
+    #   - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
+    #       More info: https://rightsignature.com/apidocs/text_tags
+    # 
+    # Example:
+    #   recipients = [
+    #     {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
+    #     {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
+    #     {'is_sender' => true, :role => 'signer'}
+    #   ]
+    #   options={
+    #     :tags => [{:tag => {:name => 'sent_from_api'}}, {:tag => {:name => 'user_id', :value => '12345'}}],
+    #     :expires_in => '5 days',
+    #     :action => "redirect",
+    #     'callback_location' => "http://example.com/doc_callback",
+    #     'use_text_tags' => false
+    #   }
+    #   @rs_connection.send_document_from_file("here/is/myfile.pdf", 'My Subject', recipients, options)
+    # 
     def send_document_from_file(file, subject, recipients, options={})
       send_document(subject, recipients, {:type => "base64", :filename => File.basename(file), :value => Base64::encode64(File.read(file)) }, options)
     end
     
     # Creates a document from URL
-    # * url: URL to file
-    # * subject: subject of the document that'll appear in email
-    # * recipients: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
-    #     An optional :is_sender (true/false) is used to referrence the API User and won't need to supply :name and :email
-    #     Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
+    # * <b>url</b>: URL to file
+    # * <b>subject</b>: subject of the document that'll appear in email
+    # * <b>recipients</b>: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
+    #   One of the recipients requires <b>:is_sender</b> (true/false) to reference the API User and won't need to supply :name and :email
+    #   Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
     #     [
     #       {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
     #       {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
     #       {'is_sender' => true, :role => 'signer'},
     #     ]
-    # * options: other optional values
-    #     - description: document description that'll appear in the email
-    #     - action: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
-    #     - 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"
-    #     - use_text_tags: Document has special Text Tags that RightSignature parse. true or false.
-    #         More info: https://rightsignature.com/apidocs/text_tags
+    # * <b>options</b>: other optional values
+    #   - <b>description</b>: document description that'll appear in the email
+    #   - <b>action</b>: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
+    #   - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   - <b>tags</b>: 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"}]
+    #   - <b>callback_url</b>: 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"
+    #   - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
+    #       More info: https://rightsignature.com/apidocs/text_tags
+    # 
+    # Example:
+    #   recipients = [
+    #     {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
+    #     {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
+    #     {'is_sender' => true, :role => 'signer'}
+    #   ]
+    #   options={
+    #     :tags => [{:tag => {:name => 'sent_from_api'}}, {:tag => {:name => 'user_id', :value => '12345'}}],
+    #     :expires_in => '5 days',
+    #     :action => "redirect",
+    #     'callback_location' => "http://example.com/doc_callback",
+    #     'use_text_tags' => false
+    #   }
+    #   @rs_connection.send_document_from_url("http://myfile/here", 'My Subject', recipients, options)
+    #
     def send_document_from_url(url, subject, recipients, options={})
       send_document(subject, recipients, {:type => "url", :filename => File.basename(url), :value => url }, options)
     end
     
     # Creates a document from a base64 encoded file or publicly available URL
-    # * document_data: hash of document source :type ('base64' or 'url'), :filename to be used, :value of source (url or base64 encoded binary)
-    # * subject: subject of the document that'll appear in email
-    # * recipients: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
-    #     An optional :is_sender (true/false) is used to referrence the API User and won't need to supply :name and :email
-    #     Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
+    # * <b>document_data</b>: hash of document source :type ('base64' or 'url'), :filename to be used, :value of source (url or base64 encoded binary)
+    # * <b>subject</b>: subject of the document that'll appear in email
+    # * <b>recipients</b>: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
+    #   One of the recipients requires <b>:is_sender</b> (true/false) to reference the API User and won't need to supply :name and :email
+    #   Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
     #     [
     #       {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
     #       {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
     #       {'is_sender' => true, :role => 'signer'},
     #     ]
     # * options: other optional values
-    #     - description: document description that'll appear in the email
-    #     - action: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
-    #     - 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"
-    #     - use_text_tags: Document has special Text Tags that RightSignature parse. true or false.
-    #         More info: https://rightsignature.com/apidocs/text_tags
+    #   - <b>description</b>: document description that'll appear in the email
+    #   - <b>action</b>: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
+    #   - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   - <b>tags</b>: 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"}]
+    #   - <b>callback_url</b>: 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"
+    #   - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
+    #       More info: https://rightsignature.com/apidocs/text_tags
     # Ex. 
-    # recipients = [
-    #   {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
-    #   {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
-    #   {'is_sender' => true, :role => 'signer'},
-    # ]
-    # document_data = {:type => 'base64', :filename => "originalfile.pdf", :value => Base64.encode64(File.read('myfile.pdf','r'))}
-    # options = {
-    #   :tags => ['sent_from_api', 'user_id' => '12345'],
-    #   :expires_in => '5 days',
-    #   :action => "redirect",
-    #   'callback_location' => "http://example.com/doc_callback",
-    #   'use_text_tags' => false
-    # }
-    # RightSignature::send_document( "My Subject", recipients, document_data, options)
+    #   recipients = [
+    #     {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
+    #     {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
+    #     {'is_sender' => true, :role => 'signer'},
+    #   ]
+    #   document_data = {:type => 'base64', :filename => "originalfile.pdf", :value => Base64.encode64(File.read('myfile.pdf','r'))}
+    #   options = {
+    #     :tags => ['sent_from_api', 'user_id' => '12345'],
+    #     :expires_in => '5 days',
+    #     :action => "redirect",
+    #     'callback_location' => "http://example.com/doc_callback",
+    #     'use_text_tags' => false
+    #   }
+    #   @rs_connection.send_document( "My Subject", recipients, document_data, options)
     # 
     def send_document(subject, recipients, document_data, options={})
       document_hash = {:document => {
@@ -166,41 +254,41 @@ module RightSignature
     end
     
     # Prefills a document from a base64 encoded file or publicly available URL and returns a url that allows someone to send as the API User
-    # * document_data: hash of document source :type ('base64' or 'url'), :filename to be used, :value of source (url or base64 encoded binary)
-    # * subject: subject of the document that'll appear in email
-    # * recipients: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
-    #     An optional :is_sender (true/false) is used to referrence the API User and won't need to supply :name and :email
-    #     Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
+    # * <b>document_data</b>: hash of document source :type ('base64' or 'url'), :filename to be used, :value of source (url or base64 encoded binary)
+    # * <b>subject</b>: subject of the document that'll appear in email
+    # * <b>recipients</b>: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). 
+    #   One of the recipients requires <b>:is_sender</b> (true/false) to reference the API User and won't need to supply :name and :email
+    #   Ex. CC to support@rightsignature.com, with sender and john@rightsignature.com as a signer
     #     [
     #       {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
     #       {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
     #       {'is_sender' => true, :role => 'signer'},
     #     ]
-    # * options: other optional values
-    #     - description: document description that'll appear in the email
-    #     - action: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
-    #     - 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"
-    #     - use_text_tags: Document has special Text Tags that RightSignature parse. true or false.
-    #         More info: https://rightsignature.com/apidocs/text_tags
+    # * <b>options</b>: other optional values
+    #   - <b>description</b>: document description that'll appear in the email
+    #   - <b>action</b>: 'send' or 'redirect'. Redirect will return a token that will allow another person to send the document under API user's account
+    #   - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   - <b>tags</b>: 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"}]
+    #   - <b>callback_url</b>: 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"
+    #   - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
+    #     More info: https://rightsignature.com/apidocs/text_tags
     # Ex. 
-    # recipients = [
-    #   {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
-    #   {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
-    #   {'is_sender' => true, :role => 'signer'},
-    # ]
-    # document_data = {:type => 'base64', :filename => "originalfile.pdf", :value => Base64.encode64(File.read('myfile.pdf','r'))}
-    # options = {
-    #   :tags => ['sent_from_api', 'user_id' => '12345'],
-    #   :expires_in => '5 days',
-    #   :action => "redirect",
-    #   'callback_location' => "http://example.com/doc_callback",
-    #   'use_text_tags' => false
-    # }
-    # RightSignature::generate_document_redirect_url( "My Subject", recipients, document_data, options)
+    #   recipients = [
+    #     {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
+    #     {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
+    #     {'is_sender' => true, :role => 'signer'},
+    #   ]
+    #   document_data = {:type => 'base64', :filename => "originalfile.pdf", :value => Base64.encode64(File.read('myfile.pdf','r'))}
+    #   options = {
+    #     :tags => ['sent_from_api', 'user_id' => '12345'],
+    #     :expires_in => '5 days',
+    #     :action => "redirect",
+    #     'callback_location' => "http://example.com/doc_callback",
+    #     'use_text_tags' => false
+    #   }
+    #   @rs_connection.generate_document_redirect_url( "My Subject", recipients, document_data, options)
     #
     def generate_document_redirect_url(subject, recipients, document_data, options={})
       options[:action] = "redirect"
@@ -209,6 +297,13 @@ module RightSignature
       "#{site}/builder/new?rt=#{response['document']['redirect_token']}"
     end
     
+    # Generates signer links for a Document with signers with email of "noemail@rightsignautre.com"
+    # * <b>guid</b>: Document GUID
+    # * <b>redirect_location</b>: (Optional) URL to redirect each signer after it is completed
+    # 
+    # Ex. Generate signer links for document GUID123 that redirects users to http://mysite/done_signing after signing
+    #   @rs_connection.get_document_signer_links_for("GUID123", "http://mysite/done_signing")
+    # 
     def get_document_signer_links_for(guid, redirect_location = nil)
       params = {}
       params[:redirect_location] = URI.encode(redirect_location) if redirect_location

data/lib/rightsignature/errors.rb

@@ -8,10 +8,12 @@ module RightSignature
       super((message || @response.message))
     end
 
+    # returns HTTP Code from response
     def code
       @response.code
     end
   
+    # Suggestions on how to resolve a certain error 
     def common_solutions
       if @response.code.to_i == 406
         "Check the Content-Type and makes sure it's the correct type (usually application/json or application/xml), ensure url has .xml or .json at the end, check 'Accept' header to allow xml or json ('*/*' for anything)"
@@ -23,6 +25,8 @@ module RightSignature
     end
   end
 
-  class TokenResponseError < Exception; end
-  class OAuthResponseError < Exception; end
+  class TokenResponseError < ResponseError # :nodoc:
+  end
+  class OAuthResponseError < ResponseError # :nodoc:
+  end
 end

data/lib/rightsignature/helpers/normalizing.rb

@@ -1,6 +1,6 @@
-module RightSignature::Helpers
-  module TagsHelper
-    class <<self
+module RightSignature::Helpers #:nodoc:
+  module TagsHelper #:nodoc: 
+    class <<self #:nodoc: 
       def mixed_array_to_string_array(array_of_tags)
         return array_of_tags unless array_of_tags.is_a?(Array)
   
@@ -32,8 +32,8 @@ module RightSignature::Helpers
     end
   end
   
-  module RolesHelper
-    class <<self
+  module RolesHelper #:nodoc: 
+    class <<self #:nodoc: 
       # Converts [{"Role_ID" => {:name => "John", :email => "email@example.com"}}] to 
       #   [{:role => {:name => "John", :email => "email@example.com", "@role_id" => "Role_ID"} }]
       # Tries to guess if it's using Role ID or Role Name
@@ -56,8 +56,8 @@ module RightSignature::Helpers
   end
 
   
-  module MergeFieldsHelper
-    class <<self
+  module MergeFieldsHelper #:nodoc: 
+    class <<self #:nodoc:
       # Converts [{"Role Name" => {:name => "John", :email => "email@example.com"}}] to 
       #   [{"role roles_name=\"Role Name\"" => {:role => {:name => "John", :email => "email@example.com"}} }]
       def array_to_xml_hash(merge_fields_array, use_id=false)
@@ -77,6 +77,7 @@ module RightSignature::Helpers
     end
   end
   
+   #:nodoc: 
   def array_to_acceptable_names_hash(acceptable_names)
     converted_fields = []
     acceptable_names.each do |name|

data/lib/rightsignature/template.rb

@@ -1,51 +1,64 @@
 module RightSignature
   module Template
     include RightSignature::Helpers
-    # List Templates and passes in optional options.
-    #  Options:
-    #   * page: page number
-    #   * per_page: number of templates to return per page. 
-    #       API only supports 10, 20, 30, 40, or 50. Default is 10.
-    #   * tags: filter templates by given tags. Array of strings, for name/value tags colon (:) should separate name and value.
-    #       Ex. "single_tag,tag_key:tag_value" would find templates with 'single_tag' and the name/value of 'tag_key' with value 'tag_value'.
-    #   * search: term to search for in templates.
+    # List Templates with optional filters
+    # * <b>Options</b>: (optional) Hash of filters to use
+    #   * <b>page</b>: page number
+    #   * <b>per_page</b>: number of templates to return per page. 
+    #     API only supports 10, 20, 30, 40, or 50. Default is 10.
+    #   * <b>tags</b>: filter templates by given tags. Array of strings, for name/value tags colon (:) should separate name and value.
+    #     Ex. "single_tag,tag_key:tag_value" would find templates with 'single_tag' and the name/value of 'tag_key' with value 'tag_value'.
+    #   * <b>search</b>: term to search for in templates.
+    # 
+    # Ex. 
+    #   options = {
+    #     :state => ['completed', 'trashed'],
+    #     :page => 1,
+    #     :per_page => 20,
+    #     :search => "me",
+    #     :tags => ["single_tag", "key" => "with_value"]
+    #   }
+    #   @rs_connection.templates_list(options)
     def templates_list(options={})
       options[:tags] = TagsHelper.mixed_array_to_string_array(options[:tags]) if options[:tags]
       get "/api/templates.xml", options
     end
     
+    # Gets template details
+    # * <b>guid</b>: templates guid. Ex. a_1_zcfdidf8fi23
     def template_details(guid)
       get "/api/templates/#{guid}.xml", {}
     end
     
-    # Clones a template so it can be used for sending. Always first step in sending a template.
+    # Clones a template so it can be used for sending. Always first step in sending a template. 
+    # * <b>guid</b>: templates guid. Ex. a_1_zcfdidf8fi23
     def prepackage(guid)
       post "/api/templates/#{guid}/prepackage.xml", {}
     end
     
-    # Prefills template.
-    # * guid: templates guid. Ex. a_1_zcfdidf8fi23
-    # * subject: subject of the document that'll appear in email
-    # * roles: Recipients of the document, should be an array of role names and emails in a hash with keys as role_names. 
+    # Prefills template. Should use a <b>prepackaged</b> template first.
+    # * <b>guid</b>: templates guid. Ex. a_1_zcfdidf8fi23
+    # * <b>subject</b>: subject of the document that'll appear in email
+    # * <b>roles</b>: Recipients of the document, should be an array of role names and emails in a hash with keys as role_names. 
     #     Ex. [{"Employee" => {:name => "John Employee", :email => "john@employee.com"}}]
     #       is equivalent to 
     #         <role role_name="Employee">
     #           <name>John Employee</name>
     #           <email>john@employee.com</email>
     #         </role>
-    # * options: other optional values
-    #     - 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 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"
+    # * <b>options</b>: other optional values
+    #   * <b>description</b>: document description that'll appear in the email
+    #   * <b>merge_fields</b>: 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>
+    #   * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   * <b>tags</b>: 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"}]
+    #   * <b>callback_url</b>: 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"
     # 
     # Ex. call with all options used
     #   RightSignature::Template.prefill(
@@ -87,38 +100,80 @@ module RightSignature
       post "/api/templates.xml", xml_hash
     end
     
+    # Prepackages and sends template.
+    # * <b>guid</b>: templates guid. Ex. a_1_zcfdidf8fi23
+    # * <b>roles</b>: Recipients of the document, should be an array of role names and emails in a hash with keys as role_names. 
+    #     Ex. [{"Employee" => {:name => "John Employee", :email => "john@employee.com"}}]
+    #       is equivalent to 
+    #         <role role_name="Employee">
+    #           <name>John Employee</name>
+    #           <email>john@employee.com</email>
+    #         </role>
+    # * <b>options</b>: other optional values
+    #   * <b>subject</b>: subject of the document that'll appear in email. Defaults to template's subject
+    #   * <b>description</b>: document description that'll appear in the email
+    #   * <b>merge_fields</b>: 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>
+    #   * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   * <b>tags</b>: 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"}]
+    #   * <b>callback_url</b>: 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"
+    # 
+    # Ex. call with all options used
+    #   RightSignature::Template.prepackage_and_send(
+    #     "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 prepackage_and_send(guid, roles, options={})
       response = prepackage(guid)
       new_guid = response["template"]["guid"]
       send_template(new_guid, options.delete(:subject) || response["template"]["subject"], roles, options)
     end
     
-    # Sends template.
-    # * guid: templates guid. Ex. a_1_zcfdidf8fi23
-    # * subject: subject of the document that'll appear in email
-    # * roles: Recipients of the document, should be an array of role names and emails in a hash with keys as role_names. 
+    # Sends template. Should use a <b>prepackaged</b> template first. Easier to use <b>prepackage_and_send</b> for most cases.
+    # * <b>guid</b>: templates guid. Ex. a_1_zcfdidf8fi23
+    # * <b>subject</b>: subject of the document that'll appear in email
+    # * <b>roles</b>: Recipients of the document, should be an array of role names and emails in a hash with keys as role_names. 
     #     Ex. [{"Employee" => {:name => "John Employee", :email => "john@employee.com"}}]
     #       is equivalent to 
     #         <role role_name="Employee">
     #           <name>John Employee</name>
     #           <email>john@employee.com</email>
     #         </role>
-    # * options: other optional values
-    #     - 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"
+    # * <b>options</b>: other optional values
+    #   * <b>description</b>: document description that'll appear in the email
+    #   * <b>merge_fields</b>: 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>
+    #   * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   * <b>tags</b>: 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"}]
+    #   * <b>callback_url</b>: 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"
     # 
     # Ex. call with all options used
-    #   RightSignature::Template.prefill(
+    #   RightSignature::Template.send_template(
     #     "a_1_zcfdidf8fi23", 
     #     "Your Employee Handbook", 
     #     [{"employee" => {:name => "John Employee", :email => "john@employee.com"}}],
@@ -140,17 +195,17 @@ module RightSignature
     end
     
     # Creates a URL that give person ability to create a template in your account.
-    # * options: optional options for redirected person
-    #     - callback_location: URI encoded URL that specifies the location we will POST a callback notification to when the template has been created.
-    #     - redirect_location: A URI encoded URL that specifies the location we will redirect the user to, after they have created a template.
-    #     - tags: tags to add to the template. an array of 'tag_name' (for simple tag) or {'tag_name' => 'value'} (for tuples pairs)
-    #         Ex. ['created_from_api', {"user_id" => "123"}]
-    #     - acceptable_role_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 roles to the Template. An array of strings. 
-    #         Ex. ["Employee", "Employeer"]
-    #     - 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"]
+    # * <b>options</b>: optional options for redirected person
+    #   * <b>callback_location</b>: URI encoded URL that specifies the location we will POST a callback notification to when the template has been created.
+    #   * <b>redirect_location</b>: A URI encoded URL that specifies the location we will redirect the user to, after they have created a template.
+    #   * <b>tags</b>: tags to add to the template. an array of 'tag_name' (for simple tag) or {'tag_name' => 'value'} (for tuples pairs)
+    #       Ex. ['created_from_api', {"user_id" => "123"}]
+    #   * <b>acceptable_role_names</b>: 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 roles to the Template. An array of strings. 
+    #       Ex. ["Employee", "Employeer"]
+    #   * <b>acceptable_merge_field_names</b>: 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"]
     def generate_build_url(options={})
       xml_hash = {:template => {}}
       xml_hash[:template][:tags] = TagsHelper.array_to_xml_hash(options[:tags]) if options[:tags]
@@ -171,30 +226,30 @@ module RightSignature
     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. 
+    # * <b>guid</b>: templates guid. Ex. a_1_zcfdidf8fi23
+    # * <b>roles</b>: 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"
+    # * <b>options</b>: other optional values
+    #   * <b>subject</b>: subject of the document that'll appear in email. Defaults to Template's subject
+    #   * <b>description</b>: document description that'll appear in the email
+    #   * <b>merge_fields</b>: 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>
+    #   * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
+    #   * <b>tags</b>: 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"}]
+    #   * <b>callback_url</b>: 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"
+    #   * <b>redirect_location</b>: 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(

data/lib/rightsignature/version.rb

@@ -1,3 +1,3 @@
 module RightSignature
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/api_token_connection_spec.rb

@@ -8,20 +8,20 @@ describe RightSignature::TokenConnection do
 
   it "should create 'api-token' in headers with :api_token credentials, accept of '*/*', and content-type of xml with given method" do
     token_connection = RightSignature::TokenConnection.new('APITOKEN')
-    token_connection.should_receive(:get).with("path", {:query => {:search => 'hey there'}, :headers => {"api-token" => "APITOKEN", "Accept" => "*/*", "content-type" => "application/xml"}}).and_return(stub("HTTPartyResponse", :parsed_response => nil))
+    token_connection.class.should_receive(:get).with("path", {:query => {:search => 'hey there'}, :headers => {"api-token" => "APITOKEN", "Accept" => "*/*", "content-type" => "application/xml"}}).and_return(stub("HTTPartyResponse", :parsed_response => nil))
     token_connection.request(:get, "path", {:query => {:search => 'hey there'}})
   end
   
   it "should add 'api-token' to headers with :api_token credentials, accept of '*/*', and content-type of xml with given method" do
     token_connection = RightSignature::TokenConnection.new('APITOKEN')
-    token_connection.should_receive(:get).with("path", {:query => {:search => 'hey there'}, :headers => {"api-token" => "APITOKEN", "Accept" => "*/*", "content-type" => "application/xml", :my_header => "someHeader"}}).and_return(stub("HTTPartyResponse", :parsed_response => nil))
+    token_connection.class.should_receive(:get).with("path", {:query => {:search => 'hey there'}, :headers => {"api-token" => "APITOKEN", "Accept" => "*/*", "content-type" => "application/xml", :my_header => "someHeader"}}).and_return(stub("HTTPartyResponse", :parsed_response => nil))
     token_connection.request(:get, "path", {:query => {:search => 'hey there'}, :headers => {:my_header => "someHeader"}})
   end
 
   it "should create 'api-token' in headers with :api_token credentials, accept of '*/*', and content-type of xml to POST method" do
     token_connection = RightSignature::TokenConnection.new('APITOKEN')
-    token_connection.should_receive(:post).with("path", {:body => {:document => {:roles => []}}, :headers => {"api-token" => "APITOKEN", "Accept" => "*/*", "content-type" => "application/xml"}}).and_return(stub("HTTPartyResponse", :parsed_response => nil))
+    token_connection.class.should_receive(:post).with("path", {:body => {:document => {:roles => []}}, :headers => {"api-token" => "APITOKEN", "Accept" => "*/*", "content-type" => "application/xml"}}).and_return(stub("HTTPartyResponse", :parsed_response => nil))
     token_connection.request(:post, "path", {:body => {:document => {:roles => []}}})
   end
   
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rightsignature
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70183818100960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,15 +23,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *70183818100960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70183818100180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -39,15 +34,10 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.11.0
+  version_requirements: *70183818100180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70183818099240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,15 +45,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *70183818099240
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70183818097840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -71,15 +56,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
+  version_requirements: *70183818097840
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70183818096560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,15 +67,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+  version_requirements: *70183818096560
 - !ruby/object:Gem::Dependency
   name: xml-fu
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70183818094620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -103,12 +78,7 @@ dependencies:
         version: 0.1.7
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.1.7
+  version_requirements: *70183818094620
 description: Provides a wrapper for the RightSignature API.
 email:
 - dev@rightsignature.com
@@ -119,6 +89,7 @@ files:
 - .gitignore
 - Gemfile
 - README.md
+- Rakefile
 - lib/rightsignature.rb
 - lib/rightsignature/account.rb
 - lib/rightsignature/connection.rb
@@ -160,9 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: API wrapper for RightSignature
 test_files: []
-has_rdoc: