Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tests for update #1150

Merged
merged 3 commits into from
Nov 23, 2022
Merged

Add tests for update #1150

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c9627d
Add tests for update
anniel-stripe Nov 18, 2022
9818492
Apply suggestions from code review
anniel-stripe Nov 22, 2022
f931822
Lint
anniel-stripe Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 169 additions & 11 deletions test/stripe/api_resource_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ class NestedTestAPIResource < APIResource
assert_equal c.created, 12_345
end

should "updating an object should issue a POST request with only the changed properties" do
should "saving an object should issue a POST request with only the changed properties" do
stub_request(:post, "#{Stripe.api_base}/v1/customers/cus_123")
.with(body: { "description" => "another_mn" })
.to_return(body: JSON.generate(customer_fixture))
Expand All @@ -323,7 +323,15 @@ class NestedTestAPIResource < APIResource
c.save
end

should "updating should merge in returned properties" do
should "updating an object should issue a POST request with only the changed properties" do
anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
stub_request(:post, "#{Stripe.api_base}/v1/customers/cus_123")
.with(body: { "description" => "another_mn" })
.to_return(body: JSON.generate(customer_fixture))
Stripe::Customer.construct_from(customer_fixture)
Stripe::Customer.update("cus_123", { description: "another_mn" })
end

should "saving should merge in returned properties" do
stub_request(:post, "#{Stripe.api_base}/v1/customers/cus_123")
.with(body: { "description" => "another_mn" })
.to_return(body: JSON.generate(customer_fixture))
Expand All @@ -333,14 +341,21 @@ class NestedTestAPIResource < APIResource
assert_equal false, c.livemode
end

should "updating should fail if api_key is overwritten with nil" do
should "saving should fail if api_key is overwritten with nil" do
c = Stripe::Customer.new
assert_raises TypeError do
c.save({}, api_key: nil)
end
end

should "updating should use the supplied api_key" do
should "updating should fail if api_key is overwritten with nil" do
anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
Stripe::Customer.new("cus_123")
assert_raises TypeError do
Stripe::Customer.update("cus_123", {}, { api_key: nil })
end
end

should "saving should use the supplied api_key" do
stub_request(:post, "#{Stripe.api_base}/v1/customers")
.with(headers: { "Authorization" => "Bearer sk_test_local" })
.to_return(body: JSON.generate(customer_fixture))
Expand All @@ -349,6 +364,14 @@ class NestedTestAPIResource < APIResource
assert_equal false, c.livemode
end

should "updating should use the supplied api_key" do
stub_request(:post, "#{Stripe.api_base}/v1/customers")
.with(headers: { "Authorization" => "Bearer sk_test_local" })
.to_return(body: JSON.generate(customer_fixture))
Stripe::Customer.new("cus_123")
Stripe::Customer.update("cus_123", {}, api_key: "sk_test_local")
end

should "deleting should send no props and result in an object that has no props other deleted" do
stub_request(:delete, "#{Stripe.api_base}/v1/customers/cus_123")
.to_return(body: JSON.generate("id" => "cus_123", "deleted" => true))
Expand Down Expand Up @@ -385,7 +408,19 @@ class NestedTestAPIResource < APIResource
c.save
end

should "add key to nested objects" do
should "passing in a stripe_account header should pass it through on update" do
stub_request(:get, "#{Stripe.api_base}/v1/customers/cus_123")
.with(headers: { "Stripe-Account" => "acct_123" })
.to_return(body: JSON.generate(customer_fixture))
Stripe::Customer.retrieve("cus_123", stripe_account: "acct_123")

stub_request(:post, "#{Stripe.api_base}/v1/customers/cus_123")
.with(headers: { "Stripe-Account" => "acct_123" })
.to_return(body: JSON.generate(customer_fixture))
Stripe::Customer.update("cus_123", { description: "FOO" })
end
anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved

should "add key to nested objects on save" do
acct = Stripe::Account.construct_from(id: "myid",
legal_entity: {
size: "l",
Expand All @@ -401,6 +436,20 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "add key to nested objects on update" do
Stripe::Account.construct_from(id: "myid",
business_profile: {
url: "example.com",
support_email: "[email protected]",
})

stub_request(:post, "#{Stripe.api_base}/v1/accounts/myid")
.with(body: { business_profile: { name: "Bob" } })
.to_return(body: JSON.generate("id" => "myid"))

anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
Stripe::Account.update("myid", { business_profile: { name: "Bob" } })
end

should "save nothing if nothing changes" do
acct = Stripe::Account.construct_from(id: "acct_id",
metadata: {
Expand All @@ -414,6 +463,19 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "update nothing if nothing changes" do
Stripe::Account.construct_from(id: "acct_id",
metadata: {
key: "value",
})

stub_request(:post, "#{Stripe.api_base}/v1/accounts/acct_id")
.with(body: {})
.to_return(body: JSON.generate("id" => "acct_id"))

Stripe::Account.update("acct_id")
end

anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
should "not save nested API resources" do
ch = Stripe::Charge.construct_from(id: "ch_id",
customer: {
Expand All @@ -429,7 +491,21 @@ class NestedTestAPIResource < APIResource
ch.save
end

should "correctly handle replaced nested objects" do
should "not update nested API resources" do
Stripe::Charge.construct_from(id: "ch_id",
customer: {
object: "customer",
id: "customer_id",
})

stub_request(:post, "#{Stripe.api_base}/v1/charges/ch_id")
.with(body: {})
.to_return(body: JSON.generate("id" => "ch_id"))

Stripe::Charge.update("ch_id", { customer: { description: "Bob" } })
end

anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
should "correctly handle replaced nested objects on save" do
acct = Stripe::Account.construct_from(
id: "acct_123",
company: {
Expand All @@ -449,7 +525,26 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "correctly handle array setting" do
should "correctly handle replaced nested objects on update" do
Stripe::Account.construct_from(
id: "acct_123",
company: {
name: "company_name",
address: {
line1: "test",
city: "San Francisco",
},
}
)

stub_request(:post, "#{Stripe.api_base}/v1/accounts/acct_123")
.with(body: { company: { address: { line1: "Test2", city: "" } } })
.to_return(body: JSON.generate("id" => "my_id"))

Stripe::Account.update("acct_123", { company: { address: { line1: "Test2" } } })
end
anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved

should "correctly handle array setting on save" do
acct = Stripe::Account.construct_from(id: "myid",
legal_entity: {})

Expand All @@ -461,7 +556,17 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "correctly handle array insertion" do
should "correctly handle array setting on update" do
Stripe::Subscription.construct_from(id: "myid")

stub_request(:post, "#{Stripe.api_base}/v1/subscriptions/myid")
.with(body: { items: [{ plan: "foo", quantity: 2 }] })
.to_return(body: JSON.generate("id" => "myid"))

Stripe::Subscription.update("myid", { items: [{ plan: "foo", quantity: 2 }] })
end

anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
should "correctly handle array insertion on save" do
acct = Stripe::Account.construct_from(id: "myid",
legal_entity: {
additional_owners: [],
Expand All @@ -478,7 +583,20 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "correctly handle array updates" do
should "correctly handle array insertion on update" do
Stripe::Subscription.construct_from(id: "myid", items: [])

# Note that this isn't a perfect check because we're using webmock's
# data decoding, which isn't aware of the Stripe array encoding that we
# use here.
stub_request(:post, "#{Stripe.api_base}/v1/subscriptions/myid")
.with(body: { items: [{ plan: "foo", quantity: 2 }] })
.to_return(body: JSON.generate("id" => "myid"))

Stripe::Subscription.update("myid", { items: [{ plan: "foo", quantity: 2 }] })
end

anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
should "correctly handle array updates on save" do
acct = Stripe::Account.construct_from(id: "myid",
legal_entity: {
additional_owners: [{ first_name: "Bob" }, { first_name: "Jane" }],
Expand All @@ -495,7 +613,24 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "correctly handle array noops" do
should "correctly handle array updates on update" do
Stripe::Subscription.construct_from(id: "myid",
items: [
{ plan: "foo", quantity: 2 },
{ plan: "bar", quantity: 2 },
])

# Note that this isn't a perfect check because we're using webmock's
# data decoding, which isn't aware of the Stripe array encoding that we
# use here.
stub_request(:post, "#{Stripe.api_base}/v1/subscriptions/myid")
.with(body: { items: [{ plan: "foos", quantity: 3 }, { plan: "bar", quantity: 3 }] })
.to_return(body: JSON.generate("id" => "myid"))

Stripe::Subscription.update("myid", { items: [{ plan: "foos", quantity: 3 }, { plan: "bar", quantity: 3 }] })
end
anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved

should "correctly handle array noops on save" do
acct = Stripe::Account.construct_from(id: "myid",
legal_entity: {
additional_owners: [{ first_name: "Bob" }],
Expand All @@ -509,7 +644,17 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "correctly handle hash noops" do
should "correctly handle array noops on update" do
Stripe::Subscription.construct_from(id: "myid", items: [{ plan: "foo", quantity: 2 }])

stub_request(:post, "#{Stripe.api_base}/v1/subscriptions/myid")
.with(body: {})
.to_return(body: JSON.generate("id" => "myid"))

Stripe::Subscription.update("myid", {})
end

anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
should "correctly handle hash noops on save" do
acct = Stripe::Account.construct_from(id: "myid",
legal_entity: {
address: { line1: "1 Two Three" },
Expand All @@ -522,6 +667,19 @@ class NestedTestAPIResource < APIResource
acct.save
end

should "correctly handle hash noops on update" do
Stripe::Account.construct_from(id: "myid",
legal_entity: {
address: { line1: "1 Two Three" },
})

stub_request(:post, "#{Stripe.api_base}/v1/accounts/myid")
.with(body: {})
.to_return(body: JSON.generate("id" => "myid"))

Stripe::Account.update("myid", {})
end

anniel-stripe marked this conversation as resolved.
Show resolved Hide resolved
should "should create a new resource when an object without an id is saved" do
account = Stripe::Account.construct_from(id: nil,
display_name: nil)
Expand Down