rightsignature 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/lib/rightsignature/document.rb +5 -5
- data/lib/rightsignature/template.rb +9 -9
- data/lib/rightsignature/version.rb +1 -1
- data/spec/template_spec.rb +3 -3
- metadata +45 -15
@@ -110,7 +110,7 @@ module RightSignature
|
|
110
110
|
# - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
111
111
|
# - <b>tags</b>: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs)
|
112
112
|
# Ex. ['sent_from_api', {"user_id" => "32"}]
|
113
|
-
# - <b>
|
113
|
+
# - <b>callback_location</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.
|
114
114
|
# Ex. "http://yoursite/callback"
|
115
115
|
# - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
|
116
116
|
# More info: https://rightsignature.com/apidocs/text_tags
|
@@ -135,7 +135,7 @@ module RightSignature
|
|
135
135
|
# - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
136
136
|
# - <b>tags</b>: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs)
|
137
137
|
# Ex. ['sent_from_api', {"user_id" => "32"}]
|
138
|
-
# - <b>
|
138
|
+
# - <b>callback_location</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.
|
139
139
|
# Ex. "http://yoursite/callback"
|
140
140
|
# - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
|
141
141
|
# More info: https://rightsignature.com/apidocs/text_tags
|
@@ -176,7 +176,7 @@ module RightSignature
|
|
176
176
|
# - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
177
177
|
# - <b>tags</b>: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs)
|
178
178
|
# Ex. ['sent_from_api', {"user_id" => "32"}]
|
179
|
-
# - <b>
|
179
|
+
# - <b>callback_location</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.
|
180
180
|
# Ex. "http://yoursite/callback"
|
181
181
|
# - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
|
182
182
|
# More info: https://rightsignature.com/apidocs/text_tags
|
@@ -217,7 +217,7 @@ module RightSignature
|
|
217
217
|
# - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
218
218
|
# - <b>tags</b>: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs)
|
219
219
|
# Ex. ['sent_from_api', {"user_id" => "32"}]
|
220
|
-
# - <b>
|
220
|
+
# - <b>callback_location</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.
|
221
221
|
# Ex. "http://yoursite/callback"
|
222
222
|
# - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
|
223
223
|
# More info: https://rightsignature.com/apidocs/text_tags
|
@@ -270,7 +270,7 @@ module RightSignature
|
|
270
270
|
# - <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
271
271
|
# - <b>tags</b>: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs)
|
272
272
|
# Ex. ['sent_from_api', {"user_id" => "32"}]
|
273
|
-
# - <b>
|
273
|
+
# - <b>callback_location</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.
|
274
274
|
# Ex. "http://yoursite/callback"
|
275
275
|
# - <b>use_text_tags</b>: Document has special Text Tags that RightSignature parse. true or false.
|
276
276
|
# More info: https://rightsignature.com/apidocs/text_tags
|
@@ -57,7 +57,7 @@ module RightSignature
|
|
57
57
|
# * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
58
58
|
# * <b>tags</b>: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs)
|
59
59
|
# Ex. ['sent_from_api', {"user_id" => "32"}]
|
60
|
-
# * <b>
|
60
|
+
# * <b>callback_location</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.
|
61
61
|
# Ex. "http://yoursite/callback"
|
62
62
|
#
|
63
63
|
# Ex. call with all options used
|
@@ -76,7 +76,7 @@ module RightSignature
|
|
76
76
|
# {:name => 'sent_from_api'},
|
77
77
|
# {:name => 'user_id', :value => '32'}
|
78
78
|
# ],
|
79
|
-
# :
|
79
|
+
# :callback_location => "http://yoursite/callback"
|
80
80
|
# })
|
81
81
|
def prefill(guid, subject, roles, options={})
|
82
82
|
xml_hash = {
|
@@ -93,7 +93,7 @@ module RightSignature
|
|
93
93
|
use_merge_field_ids = options.delete(:use_merge_field_ids)
|
94
94
|
xml_hash[:template][:merge_fields] = MergeFieldsHelper.array_to_xml_hash(options[:merge_fields], use_merge_field_ids) if options[:merge_fields]
|
95
95
|
xml_hash[:template][:tags] = TagsHelper.array_to_xml_hash(options[:tags]) if options[:tags]
|
96
|
-
[:expires_in, :description, :
|
96
|
+
[:expires_in, :description, :callback_location, :action].each do |other_option|
|
97
97
|
xml_hash[:template][other_option] = options[other_option] if options[other_option]
|
98
98
|
end
|
99
99
|
|
@@ -121,7 +121,7 @@ module RightSignature
|
|
121
121
|
# * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
122
122
|
# * <b>tags</b>: document tags, an array of {:name => 'tag_name'} (for simple tag) or {:name => 'tag_name', :value => 'value'} (for tuples pairs)
|
123
123
|
# Ex. [{:name => 'sent_from_api'}, {:name => "user_id", :value => "32"}]
|
124
|
-
# * <b>
|
124
|
+
# * <b>callback_location</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.
|
125
125
|
# Ex. "http://yoursite/callback"
|
126
126
|
#
|
127
127
|
# Ex. call with all options used
|
@@ -140,7 +140,7 @@ module RightSignature
|
|
140
140
|
# {:name => 'sent_from_api'},
|
141
141
|
# {:name => 'user_id', :value => '32'}
|
142
142
|
# ],
|
143
|
-
# :
|
143
|
+
# :callback_location => "http://yoursite/callback"
|
144
144
|
# })
|
145
145
|
def prepackage_and_send(guid, roles, options={})
|
146
146
|
response = prepackage(guid)
|
@@ -169,7 +169,7 @@ module RightSignature
|
|
169
169
|
# * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
170
170
|
# * <b>tags</b>: document tags, an array of {:name => 'tag_name'} (for simple tag) or {:name => 'tag_name', :value => 'value'} (for tuples pairs)
|
171
171
|
# Ex. [{:name => 'sent_from_api'}, {:name => "user_id", :value => "32"}]
|
172
|
-
# * <b>
|
172
|
+
# * <b>callback_location</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.
|
173
173
|
# Ex. "http://yoursite/callback"
|
174
174
|
#
|
175
175
|
# Ex. call with all options used
|
@@ -188,7 +188,7 @@ module RightSignature
|
|
188
188
|
# {:name => 'sent_from_api'},
|
189
189
|
# {:name => 'user_id', :value => '32'}
|
190
190
|
# ],
|
191
|
-
# :
|
191
|
+
# :callback_location => "http://yoursite/callback"
|
192
192
|
# })
|
193
193
|
def send_template(guid, subject, roles, options={})
|
194
194
|
prefill(guid, subject, roles, options.merge({:action => 'send'}))
|
@@ -246,7 +246,7 @@ module RightSignature
|
|
246
246
|
# * <b>expires_in</b>: number of days before expiring the document. API only allows 2,5,15, or 30.
|
247
247
|
# * <b>tags</b>: document tags, an array of {:name => 'tag_name'} (for simple tag) or {:name => 'tag_name', :value => 'value'} (for tuples pairs)
|
248
248
|
# Ex. [{:name => 'sent_from_api'}, {:name => "user_id", :value => "32"}]
|
249
|
-
# * <b>
|
249
|
+
# * <b>callback_location</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.
|
250
250
|
# Ex. "http://yoursite/callback"
|
251
251
|
# * <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.
|
252
252
|
# Ex. "http://yoursite/thanks_for_signing"
|
@@ -267,7 +267,7 @@ module RightSignature
|
|
267
267
|
# {:name => 'sent_from_api'},
|
268
268
|
# {:name => 'user_id', :value => '32'}
|
269
269
|
# ],
|
270
|
-
# :
|
270
|
+
# :callback_location => "http://yoursite/callback"
|
271
271
|
# })
|
272
272
|
def send_as_embedded_signers(guid, recipients, options={})
|
273
273
|
redirect_location = options.delete(:redirect_location)
|
data/spec/template_spec.rb
CHANGED
@@ -158,7 +158,7 @@ describe RightSignature::Template do
|
|
158
158
|
@rs.prefill("MYGUID", "sign me", [], {:tags => [{"I_Key" => "I_Value"}, "Alone"]})
|
159
159
|
end
|
160
160
|
|
161
|
-
it "should include options :expires_in, :description, and :
|
161
|
+
it "should include options :expires_in, :description, and :callback_location" do
|
162
162
|
@rs.should_receive(:post).with('/api/templates.xml', {
|
163
163
|
:template => {
|
164
164
|
:guid => "MYGUID",
|
@@ -167,10 +167,10 @@ describe RightSignature::Template do
|
|
167
167
|
:roles => [],
|
168
168
|
:expires_in => 15,
|
169
169
|
:description => "Hey, I'm a description",
|
170
|
-
:
|
170
|
+
:callback_location => 'http://example.com/callie'
|
171
171
|
}
|
172
172
|
})
|
173
|
-
@rs.prefill("MYGUID", "sign me", [], {:expires_in => 15, :description => "Hey, I'm a description", :
|
173
|
+
@rs.prefill("MYGUID", "sign me", [], {:expires_in => 15, :description => "Hey, I'm a description", :callback_location => "http://example.com/callie"})
|
174
174
|
end
|
175
175
|
end
|
176
176
|
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rightsignature
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.2
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -11,11 +11,11 @@ authors:
|
|
11
11
|
autorequire:
|
12
12
|
bindir: bin
|
13
13
|
cert_chain: []
|
14
|
-
date: 2012-
|
14
|
+
date: 2012-11-13 00:00:00.000000000 Z
|
15
15
|
dependencies:
|
16
16
|
- !ruby/object:Gem::Dependency
|
17
17
|
name: bundler
|
18
|
-
requirement:
|
18
|
+
requirement: !ruby/object:Gem::Requirement
|
19
19
|
none: false
|
20
20
|
requirements:
|
21
21
|
- - ! '>='
|
@@ -23,10 +23,15 @@ dependencies:
|
|
23
23
|
version: 1.0.0
|
24
24
|
type: :development
|
25
25
|
prerelease: false
|
26
|
-
version_requirements:
|
26
|
+
version_requirements: !ruby/object:Gem::Requirement
|
27
|
+
none: false
|
28
|
+
requirements:
|
29
|
+
- - ! '>='
|
30
|
+
- !ruby/object:Gem::Version
|
31
|
+
version: 1.0.0
|
27
32
|
- !ruby/object:Gem::Dependency
|
28
33
|
name: rspec
|
29
|
-
requirement:
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
30
35
|
none: false
|
31
36
|
requirements:
|
32
37
|
- - ! '>='
|
@@ -34,10 +39,15 @@ dependencies:
|
|
34
39
|
version: 2.11.0
|
35
40
|
type: :development
|
36
41
|
prerelease: false
|
37
|
-
version_requirements:
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
none: false
|
44
|
+
requirements:
|
45
|
+
- - ! '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: 2.11.0
|
38
48
|
- !ruby/object:Gem::Dependency
|
39
49
|
name: bundler
|
40
|
-
requirement:
|
50
|
+
requirement: !ruby/object:Gem::Requirement
|
41
51
|
none: false
|
42
52
|
requirements:
|
43
53
|
- - ! '>='
|
@@ -45,10 +55,15 @@ dependencies:
|
|
45
55
|
version: 1.0.0
|
46
56
|
type: :runtime
|
47
57
|
prerelease: false
|
48
|
-
version_requirements:
|
58
|
+
version_requirements: !ruby/object:Gem::Requirement
|
59
|
+
none: false
|
60
|
+
requirements:
|
61
|
+
- - ! '>='
|
62
|
+
- !ruby/object:Gem::Version
|
63
|
+
version: 1.0.0
|
49
64
|
- !ruby/object:Gem::Dependency
|
50
65
|
name: oauth
|
51
|
-
requirement:
|
66
|
+
requirement: !ruby/object:Gem::Requirement
|
52
67
|
none: false
|
53
68
|
requirements:
|
54
69
|
- - ! '>='
|
@@ -56,10 +71,15 @@ dependencies:
|
|
56
71
|
version: 0.4.0
|
57
72
|
type: :runtime
|
58
73
|
prerelease: false
|
59
|
-
version_requirements:
|
74
|
+
version_requirements: !ruby/object:Gem::Requirement
|
75
|
+
none: false
|
76
|
+
requirements:
|
77
|
+
- - ! '>='
|
78
|
+
- !ruby/object:Gem::Version
|
79
|
+
version: 0.4.0
|
60
80
|
- !ruby/object:Gem::Dependency
|
61
81
|
name: httparty
|
62
|
-
requirement:
|
82
|
+
requirement: !ruby/object:Gem::Requirement
|
63
83
|
none: false
|
64
84
|
requirements:
|
65
85
|
- - ! '>='
|
@@ -67,10 +87,15 @@ dependencies:
|
|
67
87
|
version: 0.9.0
|
68
88
|
type: :runtime
|
69
89
|
prerelease: false
|
70
|
-
version_requirements:
|
90
|
+
version_requirements: !ruby/object:Gem::Requirement
|
91
|
+
none: false
|
92
|
+
requirements:
|
93
|
+
- - ! '>='
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: 0.9.0
|
71
96
|
- !ruby/object:Gem::Dependency
|
72
97
|
name: xml-fu
|
73
|
-
requirement:
|
98
|
+
requirement: !ruby/object:Gem::Requirement
|
74
99
|
none: false
|
75
100
|
requirements:
|
76
101
|
- - ! '>='
|
@@ -78,7 +103,12 @@ dependencies:
|
|
78
103
|
version: 0.1.7
|
79
104
|
type: :runtime
|
80
105
|
prerelease: false
|
81
|
-
version_requirements:
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
none: false
|
108
|
+
requirements:
|
109
|
+
- - ! '>='
|
110
|
+
- !ruby/object:Gem::Version
|
111
|
+
version: 0.1.7
|
82
112
|
description: Provides a wrapper for the RightSignature API.
|
83
113
|
email:
|
84
114
|
- dev@rightsignature.com
|
@@ -131,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
131
161
|
version: '0'
|
132
162
|
requirements: []
|
133
163
|
rubyforge_project:
|
134
|
-
rubygems_version: 1.8.
|
164
|
+
rubygems_version: 1.8.23
|
135
165
|
signing_key:
|
136
166
|
specification_version: 3
|
137
167
|
summary: API wrapper for RightSignature
|