rightsignature 1.0.3 → 1.0.4

data/README.md

@@ -222,7 +222,7 @@ Most common use of API, clones a template and sends it for signature.
 @rs_connection.prepackage_and_send(guid, roles, options={})
 ```
  * guid: template guid to use. Should be a template that was prepackaged
- * roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :name => "a@example.com"}}
+ * roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :email => "a@example.com"}}
 Optional options:
  * subject: document subject. Defaults to the subject in prepackage response.
  * description: document description that'll appear in the email
@@ -244,11 +244,11 @@ For cloning a Template before sending it.
 #####Template Prefilling
 After prepacking, the new template can be updated with prefill data. This won't send out the template as a document.
 ```
-@rs_connection.prefill(guid, subject, roles)
+@rs_connection.prefill(guid, subject, roles, options={})
 ```
  * guid: template guid to use. Should be a template that was prepackaged
  * subject: document subject. 
- * roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :name => "a@example.com"}}
+ * roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :email => "a@example.com"}}
  * Optional options:
    * 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.
@@ -281,11 +281,11 @@ options = {
 #####Template Sending
 Send template as a document for signing. Same options as prefill.
 ```
-@rs_connection.send_template(guid, subject, roles)
+@rs_connection.send_template(guid, subject, roles, options={})
 ```
  * guid: template guid to use. Should be a template that was prepackaged
  * subject: document subject. 
- * roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :name => "a@example.com"}}
+ * roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :email => "a@example.com"}}
  * Optional options:
    * 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.

data/lib/rightsignature/connection/oauth_connection.rb

@@ -55,8 +55,9 @@ module RightSignature
     end
     
     # Uses consumer to generate a request token.
-    def new_request_token
-      @request_token = oauth_consumer.get_request_token
+    # * <b>o</b>: options hash. Use this to set the :oauth_callback
+    def new_request_token(o = {})
+      @request_token = oauth_consumer.get_request_token(o)
     end
 
     # Sets request token.

data/lib/rightsignature/template.rb

@@ -61,7 +61,7 @@ module RightSignature
     #       Ex. "http://yoursite/callback"
     # 
     # Ex. call with all options used
-    #   RightSignature::Template.prefill(
+    #   @rs_connection.prefill(
     #     "a_1_zcfdidf8fi23", 
     #     "Your Employee Handbook", 
     #     [{"employee" => {:name => "John Employee", :email => "john@employee.com"}}],
@@ -76,6 +76,7 @@ module RightSignature
     #         {:name => 'sent_from_api'},
     #         {:name => 'user_id', :value => '32'}
     #       ],
+    #       :redirect_location => "http://yoursite/redirect",
     #       :callback_location => "http://yoursite/callback"
     #     })
     def prefill(guid, subject, roles, options={})
@@ -93,7 +94,7 @@ module RightSignature
       use_merge_field_ids = options.delete(:use_merge_field_ids)
       xml_hash[:template][:merge_fields] = MergeFieldsHelper.array_to_xml_hash(options[:merge_fields], use_merge_field_ids) if options[:merge_fields]
       xml_hash[:template][:tags] = TagsHelper.array_to_xml_hash(options[:tags]) if options[:tags]
-      [:expires_in, :description, :callback_location, :action].each do |other_option|
+      [:expires_in, :description, :callback_location, :redirect_location, :action].each do |other_option|
         xml_hash[:template][other_option] = options[other_option] if options[other_option]
       end
 
@@ -125,7 +126,7 @@ module RightSignature
     #       Ex. "http://yoursite/callback"
     # 
     # Ex. call with all options used
-    #   RightSignature::Template.prepackage_and_send(
+    #   @rs_connection.prepackage_and_send(
     #     "a_1_zcfdidf8fi23", 
     #     "Your Employee Handbook", 
     #     [{"employee" => {:name => "John Employee", :email => "john@employee.com"}}],
@@ -173,7 +174,7 @@ module RightSignature
     #       Ex. "http://yoursite/callback"
     # 
     # Ex. call with all options used
-    #   RightSignature::Template.send_template(
+    #   @rs_connection.send_template(
     #     "a_1_zcfdidf8fi23", 
     #     "Your Employee Handbook", 
     #     [{"employee" => {:name => "John Employee", :email => "john@employee.com"}}],
@@ -252,7 +253,7 @@ module RightSignature
     #       Ex. "http://yoursite/thanks_for_signing"
     # 
     # Ex. call with all options used
-    #   RightSignature::Template.prefill(
+    #   @rs_connection.send_as_embedded_signers(
     #     "a_1_zcfdidf8fi23", 
     #     "Your Employee Handbook", 
     #     [{"employee" => {:name => "John Employee", :email => "john@employee.com"}}],
@@ -267,7 +268,7 @@ module RightSignature
     #         {:name => 'sent_from_api'},
     #         {:name => 'user_id', :value => '32'}
     #       ],
-    #       :callback_location => "http://yoursite/callback"
+    #       :redirect_location => "http://yoursite/redirect_from_signing"
     #     })
     def send_as_embedded_signers(guid, recipients, options={})
       redirect_location = options.delete(:redirect_location)

data/lib/rightsignature/version.rb

@@ -1,3 +1,3 @@
 module RightSignature
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/oauth_connnection_spec.rb

@@ -75,6 +75,16 @@ describe RightSignature::OauthConnection do
       oauth_connection.new_request_token
       oauth_connection.request_token.should == request_mock
     end
+    
+    it "should pass in options" do
+      request_mock = mock(OAuth::RequestToken)
+      OAuth::Consumer.stub(:new).and_return(@consumer_mock)
+      @consumer_mock.should_receive(:get_request_token).with({:oauth_callback => "http://example.com/callback"}).and_return(request_mock)
+
+      oauth_connection = RightSignature::OauthConnection.new({:consumer_key => "Consumer123", :consumer_secret => "Secret098", :access_token => "AccessToken098", :access_secret => "AccessSecret123"})
+      oauth_connection.new_request_token({:oauth_callback => "http://example.com/callback"})
+      oauth_connection.request_token.should == request_mock
+    end
   end
 
   describe "set_request_token" do

data/spec/template_spec.rb

@@ -158,7 +158,7 @@ describe RightSignature::Template do
         @rs.prefill("MYGUID", "sign me", [], {:tags => [{"I_Key" => "I_Value"}, "Alone"]})
       end
 
-      it "should include options :expires_in, :description, and :callback_location" do
+      it "should include options :expires_in, :description, :redirect_location, and :callback_location" do
         @rs.should_receive(:post).with('/api/templates.xml', {
           :template => {
             :guid => "MYGUID", 
@@ -167,10 +167,11 @@ describe RightSignature::Template do
             :roles => [],
             :expires_in => 15, 
             :description => "Hey, I'm a description", 
+            :redirect_location => 'http://example.com/redirectme',
             :callback_location => 'http://example.com/callie'
           }
         })
-        @rs.prefill("MYGUID", "sign me", [], {:expires_in => 15, :description => "Hey, I'm a description", :callback_location => "http://example.com/callie"})
+        @rs.prefill("MYGUID", "sign me", [], {:expires_in => 15, :description => "Hey, I'm a description", :redirect_location => 'http://example.com/redirectme', :callback_location => "http://example.com/callie"})
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rightsignature
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,3 +166,4 @@ signing_key:
 specification_version: 3
 summary: API wrapper for RightSignature
 test_files: []
+has_rdoc: