stripe 5.7.1 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc4c445567a38782dc843a338247615185c7f7f37a41e7fc7112ae09a9b80863
-  data.tar.gz: 3feccf9203d4c39fcb2abb6ceee3cae6e501d2194a91117d6802fb2ecf151f2a
+  metadata.gz: a5a17039dd8609885e953ff5fd576a532f77d02b555d6a3f5d1b6c8437252a34
+  data.tar.gz: c9ae5618e79a97607fd55563ecca60a3a79de58b5f46f99977c8ed28441b35e8
 SHA512:
-  metadata.gz: bb4acdf7e1d6c198f93b383fa6963a1222fcfc40fc3893ce005978e350a48995a2cd8c2507ac957284406a36eaeaa018db5b29d53092269b5dba1302dddfcc7f
-  data.tar.gz: 56f2cb939da176b60462370323bd5aff987b6d7ab2d12965833843d3fd8ad81bf9f1cd9f4ae65ebda1340a6c9eeba1a634d77ccaeff41e437abf3660c081dcb5
+  metadata.gz: 6535270353329e05c49b0e3e7853cf096dd4e35ac1e677c781f9005c89a0432141176c5e68cde123381083237d9ff3d460a3fb82bb3373863950217c7496fc21
+  data.tar.gz: cfc98fa53ba0707c4ad798fc42a168a10eb4b62cb1e57cf6e08d17a9815d0a5c7bfd1057f6d2e40cc9a379210c12f11007c8ac3aafc307676a6e23445500a4ed

data/.travis.yml

@@ -16,7 +16,7 @@ sudo: false
 env:
   global:
     # If changing this number, please also change it in `test/test_helper.rb`.
-    - STRIPE_MOCK_VERSION=0.63.0
+    - STRIPE_MOCK_VERSION=0.72.0
 
 cache:
   directories:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 5.8.0 - 2019-11-05
+* [#879](https://github.com/stripe/stripe-ruby/pull/879) Add support for `Mandate`
+* [#876](https://github.com/stripe/stripe-ruby/pull/876) Add additional per-request configuration documentation
+* [#874](https://github.com/stripe/stripe-ruby/pull/874) Raise an error when requests params are invalid
+* [#873](https://github.com/stripe/stripe-ruby/pull/873) Contributor Covenant
+
 ## 5.7.1 - 2019-10-15
 * [#869](https://github.com/stripe/stripe-ruby/pull/869) Fixes the misnamed `connection_base=` setter to be named `connect_base=`
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at conduct@stripe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/README.md

@@ -110,8 +110,26 @@ Stripe::Charge.retrieve(
     api_key: "sk_test_...",
   }
 )
+
+Stripe::Charge.capture(
+  "ch_18atAXCdGbJFKhCuBAa4532Z",
+  {},
+  {
+    stripe_version: "2018-02-28",
+    api_key: "sk_test_...",
+  }
+)
 ```
 
+Keep in mind that there are different method signatures depending on the action:
+- When operating on a collection (e.g. `.list`, `.create`) the method signature is
+  `method(params, opts)`.
+- When operating on resource (e.g. `.capture`, `.update`) the method signature is
+  `method(id, params, opts)`.
+- One exception is that `retrieve`, despite being an operation on a resource, has the signature
+  `retrieve(id, opts)`. In addition, it will accept a Hash for the `id` param but will extract the
+  `id` key out and use the others as options.
+
 ### Accessing a response object
 
 Get access to response objects by initializing a client and using its `request`

data/VERSION

@@ -1 +1 @@
-5.7.1
+5.8.0

data/lib/stripe/api_operations/request.rb

@@ -5,6 +5,9 @@ module Stripe
     module Request
       module ClassMethods
         def request(method, url, params = {}, opts = {})
+          params ||= {}
+
+          error_on_invalid_params(params)
           warn_on_opts_in_params(params)
 
           opts = Util.normalize_opts(opts)
@@ -47,6 +50,14 @@ module Stripe
           end
         end
 
+        private def error_on_invalid_params(params)
+          return if params.nil? || params.is_a?(Hash)
+
+          raise ArgumentError,
+                "request params should be either a Hash or nil " \
+                  "(was a #{params.class})"
+        end
+
         private def warn_on_opts_in_params(params)
           Util::OPTS_USER_SPECIFIED.each do |opt|
             if params.key?(opt)

data/lib/stripe/object_types.rb

@@ -48,6 +48,7 @@ module Stripe
         Issuing::Dispute::OBJECT_NAME => Issuing::Dispute,
         Issuing::Transaction::OBJECT_NAME => Issuing::Transaction,
         LoginLink::OBJECT_NAME => LoginLink,
+        Mandate::OBJECT_NAME => Mandate,
         Order::OBJECT_NAME => Order,
         OrderReturn::OBJECT_NAME => OrderReturn,
         PaymentIntent::OBJECT_NAME => PaymentIntent,

data/lib/stripe/resources.rb

@@ -37,6 +37,7 @@ require "stripe/resources/issuing/cardholder"
 require "stripe/resources/issuing/dispute"
 require "stripe/resources/issuing/transaction"
 require "stripe/resources/login_link"
+require "stripe/resources/mandate"
 require "stripe/resources/order"
 require "stripe/resources/order_return"
 require "stripe/resources/payment_intent"

data/lib/stripe/resources/mandate.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Mandate < APIResource
+    OBJECT_NAME = "mandate"
+  end
+end

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "5.7.1"
+  VERSION = "5.8.0"
 end

data/test/stripe/api_resource_test.rb

@@ -227,6 +227,22 @@ module Stripe
         end
       end
 
+      should "error if the params is not a Hash" do
+        stub_request(:post, "#{Stripe.api_base}/v1/charges/ch_123/capture")
+          .to_return(body: JSON.generate(charge_fixture))
+
+        e = assert_raises(ArgumentError) { Stripe::Charge.capture("ch_123", "sk_test_secret") }
+
+        assert_equal "request params should be either a Hash or nil (was a String)", e.message
+      end
+
+      should "allow making a request with params set to nil" do
+        stub_request(:post, "#{Stripe.api_base}/v1/charges/ch_123/capture")
+          .to_return(body: JSON.generate(charge_fixture))
+
+        Stripe::Charge.capture("ch_123", nil, "sk_test_secret")
+      end
+
       should "error if a user-specified opt is given a non-nil non-string value" do
         stub_request(:post, "#{Stripe.api_base}/v1/charges")
           .to_return(body: JSON.generate(charge_fixture))

data/test/stripe/mandate_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class MandateTest < Test::Unit::TestCase
+    should "be retrievable" do
+      schedule = Stripe::Mandate.retrieve("mandate_123")
+      assert_requested :get,
+                       "#{Stripe.api_base}/v1/mandates/mandate_123"
+      assert schedule.is_a?(Stripe::Mandate)
+    end
+  end
+end

data/test/test_helper.rb

@@ -16,7 +16,7 @@ require ::File.expand_path("test_data", __dir__)
 require ::File.expand_path("stripe_mock", __dir__)
 
 # If changing this number, please also change it in `.travis.yml`.
-MOCK_MINIMUM_VERSION = "0.63.0"
+MOCK_MINIMUM_VERSION = "0.72.0"
 MOCK_PORT = Stripe::StripeMock.start
 
 # Disable all real network connections except those that are outgoing to

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 5.7.1
+  version: 5.8.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
@@ -28,6 +28,7 @@ files:
 - ".vscode/extensions.json"
 - ".vscode/settings.json"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTORS
 - Gemfile
 - History.txt
@@ -90,6 +91,7 @@ files:
 - lib/stripe/resources/issuing/dispute.rb
 - lib/stripe/resources/issuing/transaction.rb
 - lib/stripe/resources/login_link.rb
+- lib/stripe/resources/mandate.rb
 - lib/stripe/resources/order.rb
 - lib/stripe/resources/order_return.rb
 - lib/stripe/resources/payment_intent.rb
@@ -175,6 +177,7 @@ files:
 - test/stripe/issuing/transaction_test.rb
 - test/stripe/list_object_test.rb
 - test/stripe/login_link_test.rb
+- test/stripe/mandate_test.rb
 - test/stripe/multipart_encoder_test.rb
 - test/stripe/oauth_test.rb
 - test/stripe/order_return_test.rb
@@ -246,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Stripe API
@@ -290,6 +293,7 @@ test_files:
 - test/stripe/issuing/transaction_test.rb
 - test/stripe/list_object_test.rb
 - test/stripe/login_link_test.rb
+- test/stripe/mandate_test.rb
 - test/stripe/multipart_encoder_test.rb
 - test/stripe/oauth_test.rb
 - test/stripe/order_return_test.rb