lob 1.9.1 → 1.10.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/README.md +112 -598
- data/examples/letters.rb +35 -0
- data/lib/lob/v1/bank_account.rb +4 -0
- data/lib/lob/v1/letter.rb +39 -0
- data/lib/lob/v1/resource.rb +4 -0
- data/lib/lob/version.rb +1 -1
- data/spec/lob/v1/bank_account_spec.rb +17 -0
- data/spec/lob/v1/check_spec.rb +6 -0
- data/spec/lob/v1/letter_spec.rb +95 -0
- data/spec/samples/8.5x11.pdf +1113 -2
- metadata +8 -2
data/examples/letters.rb
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
|
|
2
|
+
require 'lob'
|
|
3
|
+
|
|
4
|
+
# initialize Lob object
|
|
5
|
+
Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
|
|
6
|
+
@lob = Lob.load
|
|
7
|
+
|
|
8
|
+
# create a to address
|
|
9
|
+
to_address = @lob.addresses.create(
|
|
10
|
+
name: "ToAddress",
|
|
11
|
+
address_line1: "120 6th Ave",
|
|
12
|
+
city: "Boston",
|
|
13
|
+
state: "MA",
|
|
14
|
+
country: "US",
|
|
15
|
+
zip: 12345
|
|
16
|
+
)
|
|
17
|
+
|
|
18
|
+
# create a from address
|
|
19
|
+
from_address = @lob.addresses.create(
|
|
20
|
+
name: "FromAddress",
|
|
21
|
+
address_line1: "120 6th Ave",
|
|
22
|
+
city: "Boston",
|
|
23
|
+
state: "MA",
|
|
24
|
+
country: "US",
|
|
25
|
+
zip: 12345
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
# send the letter
|
|
29
|
+
puts @lob.letters.create(
|
|
30
|
+
description: "Test letter",
|
|
31
|
+
to: to_address["id"],
|
|
32
|
+
from: from_address["id"],
|
|
33
|
+
file: "https://s3-us-west-2.amazonaws.com/lob-assets/100_101_doc.pdf",
|
|
34
|
+
color: true
|
|
35
|
+
)
|
data/lib/lob/v1/bank_account.rb
CHANGED
|
@@ -30,6 +30,10 @@ module Lob
|
|
|
30
30
|
Lob.submit :delete, bank_account_url(bank_account_id)
|
|
31
31
|
end
|
|
32
32
|
|
|
33
|
+
def verify(bank_account_id, options = {})
|
|
34
|
+
Lob.submit :post, "#{bank_account_url(bank_account_id)}/verify", options
|
|
35
|
+
end
|
|
36
|
+
|
|
33
37
|
private
|
|
34
38
|
|
|
35
39
|
def bank_account_url(bank_account_id = nil)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
module Lob
|
|
2
|
+
module V1
|
|
3
|
+
class Letter
|
|
4
|
+
|
|
5
|
+
def initialize(resource)
|
|
6
|
+
@resource = resource
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
def list(options={})
|
|
10
|
+
Lob.submit(:get, letter_url, options)["data"] || []
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
def find(job_id)
|
|
14
|
+
Lob.submit :get, letter_url(job_id)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def create(options = {})
|
|
18
|
+
|
|
19
|
+
if options[:to] && !options[:to].is_a?(String)
|
|
20
|
+
options[:to] = @resource.format_address_params(options[:to])
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
if options[:from] && !options[:from].is_a?(String)
|
|
24
|
+
options[:from] = @resource.format_address_params(options[:from])
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
Lob.submit :post, letter_url, options
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
private
|
|
32
|
+
|
|
33
|
+
def letter_url(job_id = nil)
|
|
34
|
+
@resource.construct_url("letters", job_id)
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
data/lib/lob/v1/resource.rb
CHANGED
data/lib/lob/version.rb
CHANGED
|
@@ -111,4 +111,21 @@ describe Lob::V1::BankAccount do
|
|
|
111
111
|
end
|
|
112
112
|
end
|
|
113
113
|
end
|
|
114
|
+
|
|
115
|
+
describe "verify" do
|
|
116
|
+
it "should verify a bank account" do
|
|
117
|
+
VCR.use_cassette('verify_bank_account') do
|
|
118
|
+
new_bank_account = subject.bank_accounts.create(
|
|
119
|
+
routing_number: @sample_bank_account_params[:routing_number],
|
|
120
|
+
bank_address: @sample_address_params.clone,
|
|
121
|
+
account_number: @sample_bank_account_params[:account_number],
|
|
122
|
+
account_address: @sample_address_params.clone,
|
|
123
|
+
signatory: "John Doe"
|
|
124
|
+
)
|
|
125
|
+
|
|
126
|
+
verify_result = subject.bank_accounts.verify(new_bank_account["id"], amounts: [12, 34])
|
|
127
|
+
assert_equal(new_bank_account["id"], verify_result["id"])
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
end
|
|
114
131
|
end
|
data/spec/lob/v1/check_spec.rb
CHANGED
|
@@ -35,6 +35,8 @@ describe Lob::V1::Check do
|
|
|
35
35
|
signatory: "John Doe"
|
|
36
36
|
)
|
|
37
37
|
|
|
38
|
+
subject.bank_accounts.verify(new_bank_account["id"], amounts: [1, 2])
|
|
39
|
+
|
|
38
40
|
new_check = subject.checks.create(
|
|
39
41
|
bank_account: new_bank_account["id"],
|
|
40
42
|
to: @sample_address_params,
|
|
@@ -61,6 +63,8 @@ describe Lob::V1::Check do
|
|
|
61
63
|
signatory: "John Doe"
|
|
62
64
|
)
|
|
63
65
|
|
|
66
|
+
subject.bank_accounts.verify(new_bank_account["id"], amounts: [1, 2])
|
|
67
|
+
|
|
64
68
|
result = subject.checks.create(
|
|
65
69
|
bank_account: new_bank_account["id"],
|
|
66
70
|
to: new_address["id"],
|
|
@@ -86,6 +90,8 @@ describe Lob::V1::Check do
|
|
|
86
90
|
signatory: "John Doe"
|
|
87
91
|
)
|
|
88
92
|
|
|
93
|
+
subject.bank_accounts.verify(new_bank_account["id"], amounts: [1, 2])
|
|
94
|
+
|
|
89
95
|
new_check = subject.checks.create(
|
|
90
96
|
bank_account: new_bank_account["id"],
|
|
91
97
|
to: new_address["id"],
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
require "spec_helper"
|
|
2
|
+
|
|
3
|
+
describe Lob::V1::Letter do
|
|
4
|
+
|
|
5
|
+
before :each do
|
|
6
|
+
@sample_address_params = {
|
|
7
|
+
name: "TestAddress",
|
|
8
|
+
email: "test@test.com",
|
|
9
|
+
address_line1: "123 Test Street",
|
|
10
|
+
address_line2: "Unit 199",
|
|
11
|
+
city: "Mountain View",
|
|
12
|
+
state: "CA",
|
|
13
|
+
country: "US",
|
|
14
|
+
zip: 94085
|
|
15
|
+
}
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
subject { Lob(api_key: ENV["LOB_API_KEY"]) }
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
describe "list" do
|
|
22
|
+
it "should list letter" do
|
|
23
|
+
VCR.use_cassette('list_letters') do
|
|
24
|
+
new_address = subject.addresses.create @sample_address_params
|
|
25
|
+
|
|
26
|
+
new_letter = subject.letters.create(
|
|
27
|
+
description: "TestLetter",
|
|
28
|
+
color: true,
|
|
29
|
+
file: "https://s3-us-west-2.amazonaws.com/lob-assets/100_101_doc.pdf",
|
|
30
|
+
to: new_address["id"],
|
|
31
|
+
from: new_address["id"]
|
|
32
|
+
)
|
|
33
|
+
|
|
34
|
+
list_result = subject.letters.list
|
|
35
|
+
assert /#{new_letter["description"]}/ =~ list_result.to_s
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
describe "create" do
|
|
42
|
+
it "should create a letter with address_id" do
|
|
43
|
+
VCR.use_cassette('create_letter_with_address_id') do
|
|
44
|
+
new_address = subject.addresses.create @sample_address_params
|
|
45
|
+
|
|
46
|
+
new_letter = subject.letters.create(
|
|
47
|
+
description: "TestLetter",
|
|
48
|
+
color: true,
|
|
49
|
+
file: "https://s3-us-west-2.amazonaws.com/lob-assets/100_101_doc.pdf",
|
|
50
|
+
to: new_address["id"],
|
|
51
|
+
from: @sample_address_params
|
|
52
|
+
)
|
|
53
|
+
|
|
54
|
+
new_letter["description"].must_equal("TestLetter")
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
it "should create a letter with a local file" do
|
|
59
|
+
VCR.use_cassette('create_letter_with_address_id') do
|
|
60
|
+
new_address = subject.addresses.create @sample_address_params
|
|
61
|
+
|
|
62
|
+
new_letter = subject.letters.create(
|
|
63
|
+
description: "TestLetter",
|
|
64
|
+
color: true,
|
|
65
|
+
file: File.new(File.expand_path("../../../samples/8.5x11.pdf", __FILE__)),
|
|
66
|
+
to: new_address["id"],
|
|
67
|
+
from: @sample_address_params
|
|
68
|
+
)
|
|
69
|
+
|
|
70
|
+
new_letter["description"].must_equal("TestLetter")
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
describe "find" do
|
|
77
|
+
it "should find a letter" do
|
|
78
|
+
VCR.use_cassette('find_letter') do
|
|
79
|
+
new_address = subject.addresses.create @sample_address_params
|
|
80
|
+
|
|
81
|
+
new_letter = subject.letters.create(
|
|
82
|
+
description: "TestLetter",
|
|
83
|
+
color: true,
|
|
84
|
+
file: "https://s3-us-west-2.amazonaws.com/lob-assets/100_101_doc.pdf",
|
|
85
|
+
to: new_address["id"],
|
|
86
|
+
from: new_address["id"]
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
result = subject.letters.find(new_letter["id"])
|
|
90
|
+
assert /#{new_letter["description"]}/ =~ result.to_s
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
end
|