stripe 4.13.0 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fefd607d30d32ab6b4b1a3062c031fec8366abd331c311770136721354b89a4
-  data.tar.gz: c537164f6d8871f1508c4a2b82d894eec944169fbf4143c50c274df37f78170e
+  metadata.gz: 790e0608c4ddd64ef2fe1c9c479bf5aea4860001f710f01bec506d5abb5c6d00
+  data.tar.gz: dcda60f272c74dda8e2681c2ca023e6355a52efcac58f69b773a4881eeedf541
 SHA512:
-  metadata.gz: 1c7ab0496bb4f3359ca20399f7fd2dc72ce62d193ac18083974bf4f164b6204e9a77c01227814023e1ce91b589acfb505849dbe4793e748b25eb15c0183944c4
-  data.tar.gz: 3b3bfae890cb4c99a4a9005f9aac45bfd92c270035fab4df4f92b8fe17af3a520475c390cbdab59e9eabde7e76b4a66da816a39d6a0f2502fda0b1f5d1d9125f
+  metadata.gz: 31001e18ef97dd7c17f882398a14cd983ff33e08e5f30a3d22331863bd3a67ec7946968a1465c46d64e564b619625b9c3fe59e4ec1b9076307ccba2fe5c49d98
+  data.tar.gz: 493304d4c23cb7ea517419a5ebe70aa23da0610ede0c5364a2dccac1c8c425d36f50c6d923db494e71a54edb4c3eeb872819b844fe90921bde47c75b631fea46

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 4.14.0 - 2019-04-18
+* [#758](https://github.com/stripe/stripe-ruby/pull/758) Add support for the `CreditNote` resource and APIs
+
 ## 4.13.0 - 2019-04-16
 * [#766](https://github.com/stripe/stripe-ruby/pull/766) Relax constraints on objects that we'll accept as a file (now they just need to respond to `#read`)
 

data/VERSION

@@ -1 +1 @@
-4.13.0
+4.14.0

data/lib/stripe.rb

@@ -52,6 +52,7 @@ require "stripe/charge"
 require "stripe/checkout/session"
 require "stripe/country_spec"
 require "stripe/coupon"
+require "stripe/credit_note"
 require "stripe/customer"
 require "stripe/discount"
 require "stripe/dispute"

data/lib/stripe/credit_note.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNote < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::Create
+
+    OBJECT_NAME = "credit_note".freeze
+
+    custom_method :void_credit_note, http_verb: :post, http_path: "void"
+
+    def void_credit_note(params = {}, opts = {})
+      url = resource_url + "/void"
+      resp, opts = request(:post, url, params, opts)
+      initialize_from(resp.data, opts)
+    end
+  end
+end

data/lib/stripe/util.rb

@@ -61,6 +61,7 @@ module Stripe
         Checkout::Session::OBJECT_NAME            => Checkout::Session,
         CountrySpec::OBJECT_NAME                  => CountrySpec,
         Coupon::OBJECT_NAME                       => Coupon,
+        CreditNote::OBJECT_NAME                   => CreditNote,
         Customer::OBJECT_NAME                     => Customer,
         Discount::OBJECT_NAME                     => Discount,
         Dispute::OBJECT_NAME                      => Dispute,

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "4.13.0".freeze
+  VERSION = "4.14.0".freeze
 end

data/test/stripe/credit_note_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Stripe
+  class CreditNoteTest < Test::Unit::TestCase
+    should "be listable" do
+      credit_notes = Stripe::CreditNote.list
+      assert_requested :get, "#{Stripe.api_base}/v1/credit_notes"
+      assert credit_notes.data.is_a?(Array)
+      assert credit_notes.first.is_a?(Stripe::CreditNote)
+    end
+
+    should "be retrievable" do
+      credit_note = Stripe::CreditNote.retrieve("cn_123")
+      assert_requested :get, "#{Stripe.api_base}/v1/credit_notes/cn_123"
+      assert credit_note.is_a?(Stripe::CreditNote)
+    end
+
+    should "be creatable" do
+      credit_note = Stripe::CreditNote.create(
+        amount: 100,
+        invoice: "in_123",
+        reason: "duplicate"
+      )
+      assert_requested :post, "#{Stripe.api_base}/v1/credit_notes"
+      assert credit_note.is_a?(Stripe::CreditNote)
+    end
+
+    should "be saveable" do
+      credit_note = Stripe::CreditNote.retrieve("cn_123")
+      credit_note.metadata["key"] = "value"
+      credit_note.save
+      assert_requested :post, "#{Stripe.api_base}/v1/credit_notes/#{credit_note.id}"
+    end
+
+    should "be updateable" do
+      credit_note = Stripe::CreditNote.update("cn_123", metadata: { key: "value" })
+      assert_requested :post, "#{Stripe.api_base}/v1/credit_notes/cn_123"
+      assert credit_note.is_a?(Stripe::CreditNote)
+    end
+
+    context "#void_credit_note" do
+      should "void credit_note" do
+        credit_note = Stripe::CreditNote.retrieve("cn_123")
+        credit_note = credit_note.void_credit_note
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/credit_notes/#{credit_note.id}/void"
+        assert credit_note.is_a?(Stripe::CreditNote)
+      end
+    end
+
+    context ".void_credit_note" do
+      should "void credit_note" do
+        credit_note = Stripe::CreditNote.void_credit_note("cn_123")
+        assert_requested :post, "#{Stripe.api_base}/v1/credit_notes/cn_123/void"
+        assert credit_note.is_a?(Stripe::CreditNote)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 4.13.0
+  version: 4.14.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,6 +86,7 @@ files:
 - lib/stripe/checkout/session.rb
 - lib/stripe/country_spec.rb
 - lib/stripe/coupon.rb
+- lib/stripe/credit_note.rb
 - lib/stripe/customer.rb
 - lib/stripe/discount.rb
 - lib/stripe/dispute.rb
@@ -167,6 +168,7 @@ files:
 - test/stripe/checkout/session_test.rb
 - test/stripe/country_spec_test.rb
 - test/stripe/coupon_test.rb
+- test/stripe/credit_note_test.rb
 - test/stripe/customer_card_test.rb
 - test/stripe/customer_test.rb
 - test/stripe/dispute_test.rb
@@ -270,6 +272,7 @@ test_files:
 - test/stripe/checkout/session_test.rb
 - test/stripe/country_spec_test.rb
 - test/stripe/coupon_test.rb
+- test/stripe/credit_note_test.rb
 - test/stripe/customer_card_test.rb
 - test/stripe/customer_test.rb
 - test/stripe/dispute_test.rb