stripe 5.19.0 → 5.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 609a42b37282281ebdaea0fa8e0fd74540cdf49b44df5c3d03fc2c9d05a71638
-  data.tar.gz: 88f0c70adfa171e72d448126300692dfb027165fbb8d5be69e2dbf1eb7c2a9a1
+  metadata.gz: 53d5362cf3395da735662c079302a68f77a067db5ed0b33d9049ab47a5d610e6
+  data.tar.gz: a33095d14ba39ec3d3a178c5b6a7aaf477f3290a060bc9955d840d30f284d9ad
 SHA512:
-  metadata.gz: a800f54e6335291b9ce91a14d715b9432ebaa04a1145b8616470037972b1c8fb83622ad8226fb03e79ce9350c4b132bb776451da25ed3ca10c8624dfebdef778
-  data.tar.gz: ff25a1a52d03cdf59c16012cacced71952462ef3daff1f7caea9403045a20c8c1343e5252f326ff5182a92075fdfbd92432c4059504b529f5cca41289a110430
+  metadata.gz: 5708098cb83cae3806edc15aa7baa946f7e1107e380282e64012b59d849a8e5b1a6c394b23347b20dc94a81922760cdaea7cb6b634c8c2f35f8b8c74694e5bee
+  data.tar.gz: 3add4e8a981bf84adabf38d6c6ee98c7dbebb0254709e38e3ee9c4aeddd68c9ce1b78cf594cf1aad7c1bb587767952cba0be15a273bdb6bf31ed215040c5162b

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
-## - 2020-04-24
+## 5.20.0 - 2020-04-27
+* [#916](https://github.com/stripe/stripe-ruby/pull/916) Add new `.generate_header` method for webhooks
+
+## 5.19.0 - 2020-04-24
 * [#915](https://github.com/stripe/stripe-ruby/pull/915) Expose `Stripe::Webhook.compute_signature` publicly
 
 ## 5.18.0 - 2020-04-22

data/VERSION

@@ -1 +1 @@
-5.19.0
+5.20.0

data/lib/stripe/version.rb

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

data/lib/stripe/webhook.rb

@@ -39,6 +39,23 @@ module Stripe
                                 timestamped_payload)
       end
 
+      # Generates a value that would be added to a `Stripe-Signature` for a
+      # given webhook payload.
+      #
+      # Note that this isn't needed to verify webhooks in any way, and is
+      # mainly here for use in test cases (those that are both within this
+      # project and without).
+      def self.generate_header(timestamp, signature, scheme: EXPECTED_SCHEME)
+        raise ArgumentError, "timestamp should be an instance of Time" \
+          unless timestamp.is_a?(Time)
+        raise ArgumentError, "signature should be a string" \
+          unless signature.is_a?(String)
+        raise ArgumentError, "scheme should be a string" \
+          unless scheme.is_a?(String)
+
+        "t=#{timestamp.to_i},#{scheme}=#{signature}"
+      end
+
       # Extracts the timestamp and the signature(s) with the desired scheme
       # from the header
       def self.get_timestamp_and_signatures(header, scheme)

data/test/stripe/webhook_test.rb

@@ -22,7 +22,11 @@ module Stripe
         opts[:payload],
         opts[:secret]
       )
-      "t=#{opts[:timestamp].to_i},#{opts[:scheme]}=#{opts[:signature]}"
+      Stripe::Webhook::Signature.generate_header(
+        opts[:timestamp],
+        opts[:signature],
+        scheme: opts[:scheme]
+      )
     end
 
     context ".compute_signature" do
@@ -38,6 +42,24 @@ module Stripe
       end
     end
 
+    context ".generate_header" do
+      should "generate a header in valid format" do
+        timestamp = Time.now
+        signature = Stripe::Webhook::Signature.compute_signature(
+          timestamp,
+          EVENT_PAYLOAD,
+          SECRET
+        )
+        scheme = "v1"
+        header = Stripe::Webhook::Signature.generate_header(
+          timestamp,
+          signature,
+          scheme: scheme
+        )
+        assert_equal("t=#{timestamp.to_i},#{scheme}=#{signature}", header)
+      end
+    end
+
     context ".construct_event" do
       should "return an Event instance from a valid JSON payload and valid signature header" do
         header = generate_header

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 5.19.0
+  version: 5.20.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.