stripe 4.24.0 → 5.0.0

data/test/stripe/customer_test.rb

@@ -53,50 +53,6 @@ module Stripe
       end
     end
 
-    context "#create_subscription" do
-      should "create a new subscription" do
-        customer = Stripe::Customer.retrieve("cus_123")
-        subscription = customer.create_subscription(items: [{ plan: "silver" }])
-        assert_requested :post, "#{Stripe.api_base}/v1/customers/#{customer.id}/subscriptions"
-        assert subscription.is_a?(Stripe::Subscription)
-      end
-    end
-
-    context "#create_upcoming_invoice" do
-      should "create a new invoice" do
-        customer = Stripe::Customer.retrieve("cus_123")
-        invoice = customer.create_upcoming_invoice
-        assert_requested :post, "#{Stripe.api_base}/v1/invoices"
-        assert invoice.is_a?(Stripe::Invoice)
-      end
-    end
-
-    context "#update_subscription" do
-      should "update a subscription" do
-        customer = Stripe::Customer.retrieve("cus_123")
-
-        # deprecated API and not in schema
-        stub_request(:post, "#{Stripe.api_base}/v1/customers/#{customer.id}/subscription")
-          .with(body: { plan: "silver" })
-          .to_return(body: JSON.generate(object: "subscription"))
-        subscription = customer.update_subscription(plan: "silver")
-        assert subscription.is_a?(Stripe::Subscription)
-      end
-    end
-
-    context "#cancel_subscription" do
-      should "cancel a subscription" do
-        customer = Stripe::Customer.retrieve("cus_123")
-
-        # deprecated API and not in schema
-        stub_request(:delete, "#{Stripe.api_base}/v1/customers/#{customer.id}/subscription")
-          .with(query: { at_period_end: "true" })
-          .to_return(body: JSON.generate(object: "subscription"))
-        subscription = customer.cancel_subscription(at_period_end: "true")
-        assert subscription.is_a?(Stripe::Subscription)
-      end
-    end
-
     context "#delete_discount" do
       should "delete a discount" do
         customer = Stripe::Customer.retrieve("cus_123")
@@ -113,6 +69,7 @@ module Stripe
         assert discount.is_a?(Stripe::Discount)
       end
     end
+
     context "#create_source" do
       should "create a source" do
         Stripe::Customer.create_source(

data/test/stripe/errors_test.rb

@@ -4,16 +4,37 @@ require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class StripeErrorTest < Test::Unit::TestCase
-    context "#to_s" do
-      should "convert to string" do
-        e = StripeError.new("message")
-        assert_equal "message", e.to_s
+    context "StripeError" do
+      context "#initialize" do
+        should "initialize error if json_body is set" do
+          e = StripeError.new("message", json_body: { error: { code: "some_error" } })
+          assert_not_nil e.error
+          assert_equal "some_error", e.error.code
+          assert_nil e.error.charge
+        end
+      end
+
+      context "#to_s" do
+        should "convert to string" do
+          e = StripeError.new("message")
+          assert_equal "message", e.to_s
+
+          e = StripeError.new("message", http_status: 200)
+          assert_equal "(Status 200) message", e.to_s
 
-        e = StripeError.new("message", http_status: 200)
-        assert_equal "(Status 200) message", e.to_s
+          e = StripeError.new("message", http_status: nil, http_body: nil, json_body: nil, http_headers: { request_id: "request-id" })
+          assert_equal "(Request request-id) message", e.to_s
+        end
+      end
+    end
 
-        e = StripeError.new("message", http_status: nil, http_body: nil, json_body: nil, http_headers: { request_id: "request-id" })
-        assert_equal "(Request request-id) message", e.to_s
+    context "OAuth::OAuthError" do
+      context "#initialize" do
+        should "initialize error if json_body is set" do
+          e = OAuth::OAuthError.new("message", "description", json_body: { error: "some_oauth_error" })
+          assert_not_nil e.error
+          assert_equal "some_oauth_error", e.error.error
+        end
       end
     end
   end

data/test/stripe/file_test.rb

@@ -52,16 +52,6 @@ module Stripe
         assert file.is_a?(Stripe::File)
       end
 
-      should "be creatable with Faraday::UploadIO" do
-        file = Stripe::File.create(
-          purpose: "dispute_evidence",
-          file: Faraday::UploadIO.new(::File.new(__FILE__), nil),
-          file_link_data: { create: true }
-        )
-        assert_requested :post, "#{Stripe.uploads_base}/v1/files"
-        assert file.is_a?(Stripe::File)
-      end
-
       should "be creatable with a string" do
         file = Stripe::File.create(
           purpose: "dispute_evidence",

data/test/stripe/invoice_test.rb

@@ -142,7 +142,7 @@ module Stripe
       end
     end
 
-    context "#upcoming" do
+    context ".upcoming" do
       should "retrieve upcoming invoices" do
         invoice = Stripe::Invoice.upcoming(
           customer: "cus_123",
@@ -192,6 +192,22 @@ module Stripe
       end
     end
 
+    context ".list_upcoming_line_items" do
+      should "retrieve upcoming invoices" do
+        line_items = Stripe::Invoice.list_upcoming_line_items(
+          customer: "cus_123",
+          subscription: "sub_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/invoices/upcoming/lines",
+                         query: {
+                           customer: "cus_123",
+                           subscription: "sub_123",
+                         }
+        assert line_items.data.is_a?(Array)
+        assert line_items.data[0].is_a?(Stripe::InvoiceLineItem)
+      end
+    end
+
     context "#void_invoice" do
       should "void invoice" do
         invoice = Stripe::Invoice.retrieve("in_123")

data/test/stripe/list_object_test.rb

@@ -132,22 +132,6 @@ module Stripe
       next_list = list.previous_page
       assert_equal({ expand: ["data.source"], limit: 3 }, next_list.filters)
     end
-
-    #
-    # backward compatibility
-    #
-
-    # note that the name #all is deprecated, as is using it fetch the next page
-    # in a list
-    should "be able to retrieve full lists given a listobject" do
-      c = Stripe::Charge.all
-      assert c.is_a?(Stripe::ListObject)
-      assert_equal("/v1/charges", c.resource_url)
-      all = c.all
-      assert all.is_a?(Stripe::ListObject)
-      assert_equal("/v1/charges", all.resource_url)
-      assert all.data.is_a?(Array)
-    end
   end
 end
 

data/test/stripe/login_link_test.rb

@@ -12,7 +12,7 @@ module Stripe
           "data" => [],
           "has_more" => false,
           "object" => "list",
-          "url" =>  "/v1/accounts/acct_123/login_links",
+          "url" => "/v1/accounts/acct_123/login_links",
         },
       }
       @account = Stripe::Account.construct_from(account_fixture)

data/test/stripe/multipart_encoder_test.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class MultipartEncoderTest < Test::Unit::TestCase
+    should "multipart encode parameters" do
+      Tempfile.create("image.jpg") do |f|
+        f.write "file-content"
+        f.flush
+        f.rewind
+
+        encoder = MultipartEncoder.new
+        encoder.encode(
+          file: f,
+          other_param: "other-param-content"
+        )
+        encoder.close
+        body = encoder.body
+
+        assert_equal <<~BODY.rstrip, body
+          --#{encoder.boundary}\r
+          Content-Disposition: form-data; name="file"; filename="#{::File.basename(f.path)}"\r
+          Content-Type: application/octet-stream\r
+          \r
+          file-content\r
+          --#{encoder.boundary}\r
+          Content-Disposition: form-data; name="other_param"\r
+          \r
+          other-param-content\r
+          --#{encoder.boundary}--
+        BODY
+      end
+    end
+
+    should "encode file-like objects" do
+      klass = Class.new do
+        def read
+          "klass-read-content"
+        end
+      end
+
+      encoder = MultipartEncoder.new
+      encoder.encode(
+        file_like: klass.new
+      )
+      encoder.close
+      body = encoder.body
+
+      assert_equal <<~BODY.rstrip, body
+        --#{encoder.boundary}\r
+        Content-Disposition: form-data; name="file_like"; filename="blob"\r
+        Content-Type: application/octet-stream\r
+        \r
+        klass-read-content\r
+        --#{encoder.boundary}--
+      BODY
+    end
+
+    should "escape quotes and line break characters in parameter names" do
+      encoder = MultipartEncoder.new
+      encoder.encode(
+        %("quoted\n\r") => "content"
+      )
+      encoder.close
+      body = encoder.body
+
+      assert_equal <<~BODY.rstrip, body
+        --#{encoder.boundary}\r
+        Content-Disposition: form-data; name="%22quoted  %22"\r
+        \r
+        content\r
+        --#{encoder.boundary}--
+      BODY
+    end
+
+    context ".encode" do
+      should "provide an easy encoding shortcut" do
+        body, content_type = MultipartEncoder.encode(
+          param: "content"
+        )
+        assert_include body, %(Content-Disposition: form-data; name="param")
+        assert_include content_type, "#{MultipartEncoder::MULTIPART_FORM_DATA}; boundary="
+      end
+    end
+
+    context "#body" do
+      should "error if not yet closed" do
+        encoder = MultipartEncoder.new
+
+        e = assert_raises RuntimeError do
+          encoder.body
+        end
+        assert_equal "object must be closed before getting body", e.message
+      end
+    end
+
+    context "#close" do
+      should "error if closed twice" do
+        encoder = MultipartEncoder.new
+        encoder.close
+
+        e = assert_raises RuntimeError do
+          encoder.close
+        end
+        assert_equal "object already closed", e.message
+      end
+    end
+
+    context "#content_type" do
+      should "produce a content type containing boundary" do
+        encoder = MultipartEncoder.new
+        assert_equal "#{MultipartEncoder::MULTIPART_FORM_DATA}; boundary=#{encoder.boundary}",
+                     encoder.content_type
+      end
+    end
+
+    context "#encode" do
+      should "error if already closed" do
+        encoder = MultipartEncoder.new
+        encoder.close
+
+        e = assert_raises RuntimeError do
+          encoder.encode(param: "content")
+        end
+        assert_equal "no more parameters can be written to closed object", e.message
+      end
+    end
+  end
+end

data/test/stripe/payment_intent_test.rb

@@ -4,7 +4,7 @@ require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class PaymentIntentTest < Test::Unit::TestCase
-    TEST_RESOURCE_ID = "pi_123".freeze
+    TEST_RESOURCE_ID = "pi_123"
 
     should "be listable" do
       payment_intents = Stripe::PaymentIntent.list

data/test/stripe/setup_intent_test.rb

@@ -4,7 +4,7 @@ require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class SetupIntentTest < Test::Unit::TestCase
-    TEST_RESOURCE_ID = "seti_123".freeze
+    TEST_RESOURCE_ID = "seti_123"
 
     should "be listable" do
       setup_intents = Stripe::SetupIntent.list

data/test/stripe/source_test.rb

@@ -51,24 +51,6 @@ module Stripe
       end
     end
 
-    context "#delete" do
-      should "warn that #delete is deprecated" do
-        old_stderr = $stderr
-        $stderr = StringIO.new
-        begin
-          source = Stripe::Source.construct_from(customer: "cus_123",
-                                                 id: "src_123",
-                                                 object: "source")
-          source.delete
-          message = "NOTE: Stripe::Source#delete is " \
-                    "deprecated; use #detach instead"
-          assert_match Regexp.new(message), $stderr.string
-        ensure
-          $stderr = old_stderr
-        end
-      end
-    end
-
     should "not be listable" do
       assert_raises NoMethodError do
         Stripe::Source.list

data/test/stripe/stripe_client_test.rb

@@ -17,6 +17,50 @@ module Stripe
       end
     end
 
+    context ".clear_all_connection_managers" do
+      should "clear connection managers across all threads" do
+        stub_request(:post, "#{Stripe.api_base}/path")
+          .to_return(body: JSON.generate(object: "account"))
+
+        num_threads = 3
+
+        # Poorly named class -- note this is actually a concurrent queue.
+        recv_queue = Queue.new
+        send_queue = Queue.new
+
+        threads = num_threads.times.map do |_|
+          Thread.start do
+            # Causes a connection manager to be created on this thread and a
+            # connection within that manager to be created for API access.
+            manager = StripeClient.default_connection_manager
+            manager.execute_request(:post, "#{Stripe.api_base}/path")
+
+            # Signal to the main thread we're ready.
+            recv_queue << true
+
+            # Wait for the main thread to signal continue.
+            send_queue.pop
+
+            # This check isn't great, but it's otherwise difficult to tell that
+            # anything happened with just the public-facing API.
+            assert_equal({}, manager.instance_variable_get(:@active_connections))
+          end
+        end
+
+        # Wait for threads to start up.
+        threads.each { recv_queue.pop }
+
+        # Do the clear (the method we're actually trying to test).
+        StripeClient.clear_all_connection_managers
+
+        # Tell threads to run their check.
+        threads.each { send_queue << true }
+
+        # And finally, give all threads time to perform their check.
+        threads.each(&:join)
+      end
+    end
+
     context ".default_client" do
       should "be a StripeClient" do
         assert_kind_of StripeClient, StripeClient.default_client
@@ -32,18 +76,19 @@ module Stripe
       end
     end
 
-    context ".default_conn" do
-      should "be a Faraday::Connection" do
-        assert_kind_of Faraday::Connection, StripeClient.default_conn
+    context ".default_connection_manager" do
+      should "be a ConnectionManager" do
+        assert_kind_of ConnectionManager,
+                       StripeClient.default_connection_manager
       end
 
       should "be a different connection on each thread" do
-        other_thread_conn = nil
+        other_thread_manager = nil
         thread = Thread.new do
-          other_thread_conn = StripeClient.default_conn
+          other_thread_manager = StripeClient.default_connection_manager
         end
         thread.join
-        refute_equal StripeClient.default_conn, other_thread_conn
+        refute_equal StripeClient.default_connection_manager, other_thread_manager
       end
     end
 
@@ -52,26 +97,54 @@ module Stripe
         Stripe.stubs(:max_network_retries).returns(2)
       end
 
-      should "retry on timeout" do
-        assert StripeClient.should_retry?(Faraday::TimeoutError.new(""), 0)
+      should "retry on Errno::ECONNREFUSED" do
+        assert StripeClient.should_retry?(Errno::ECONNREFUSED.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "retry on Net::OpenTimeout" do
+        assert StripeClient.should_retry?(Net::OpenTimeout.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "retry on Net::ReadTimeout" do
+        assert StripeClient.should_retry?(Net::ReadTimeout.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "retry on SocketError" do
+        assert StripeClient.should_retry?(SocketError.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "retry on a 409 Conflict" do
+        assert StripeClient.should_retry?(Stripe::StripeError.new(http_status: 409),
+                                          method: :post, num_retries: 0)
       end
 
-      should "retry on a failed connection" do
-        assert StripeClient.should_retry?(Faraday::ConnectionFailed.new(""), 0)
+      should "retry on a 500 Internal Server Error when non-POST" do
+        assert StripeClient.should_retry?(Stripe::StripeError.new(http_status: 500),
+                                          method: :get, num_retries: 0)
       end
 
-      should "retry on a conflict" do
-        error = make_rate_limit_error
-        e = Faraday::ClientError.new(error[:error][:message], status: 409)
-        assert StripeClient.should_retry?(e, 0)
+      should "retry on a 503 Service Unavailable" do
+        assert StripeClient.should_retry?(Stripe::StripeError.new(http_status: 503),
+                                          method: :post, num_retries: 0)
       end
 
       should "not retry at maximum count" do
-        refute StripeClient.should_retry?(RuntimeError.new, Stripe.max_network_retries)
+        refute StripeClient.should_retry?(RuntimeError.new,
+                                          method: :post, num_retries: Stripe.max_network_retries)
       end
 
       should "not retry on a certificate validation error" do
-        refute StripeClient.should_retry?(Faraday::SSLError.new(""), 0)
+        refute StripeClient.should_retry?(OpenSSL::SSL::SSLError.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "not retry on a 500 Internal Server Error when POST" do
+        refute StripeClient.should_retry?(Stripe::StripeError.new(http_status: 500),
+                                          method: :post, num_retries: 0)
       end
     end
 
@@ -115,15 +188,16 @@ module Stripe
     end
 
     context "#initialize" do
-      should "set Stripe.default_conn" do
+      should "set Stripe.default_connection_manager" do
         client = StripeClient.new
-        assert_equal StripeClient.default_conn, client.conn
+        assert_equal StripeClient.default_connection_manager,
+                     client.connection_manager
       end
 
       should "set a different connection if one was specified" do
-        conn = Faraday.new
-        client = StripeClient.new(conn)
-        assert_equal conn, client.conn
+        connection_manager = ConnectionManager.new
+        client = StripeClient.new(connection_manager)
+        assert_equal connection_manager, client.connection_manager
       end
     end
 
@@ -178,7 +252,7 @@ module Stripe
           Util.expects(:log_debug).with("Request details",
                                         body: "",
                                         idempotency_key: "abc",
-                                        query_params: nil)
+                                        query: nil)
 
           Util.expects(:log_info).with("Response from Stripe API",
                                        account: "acct_123",
@@ -403,6 +477,20 @@ module Stripe
           assert_equal 'Invalid response object from API: "" (HTTP response code was 200)', e.message
         end
 
+        should "handle low level error" do
+          stub_request(:post, "#{Stripe.api_base}/v1/charges")
+            .to_raise(Errno::ECONNREFUSED.new)
+
+          client = StripeClient.new
+          e = assert_raises Stripe::APIConnectionError do
+            client.execute_request(:post, "/v1/charges")
+          end
+
+          assert_equal StripeClient::ERROR_MESSAGE_CONNECTION % Stripe.api_base +
+                       "\n\n(Network error: Connection refused)",
+                       e.message
+        end
+
         should "handle error response with unknown value" do
           stub_request(:post, "#{Stripe.api_base}/v1/charges")
             .to_return(body: JSON.generate(bar: "foo"), status: 500)
@@ -738,14 +826,106 @@ module Stripe
 
       should "reset local thread state after a call" do
         begin
-          Thread.current[:stripe_client] = :stripe_client
+          StripeClient.current_thread_context.active_client = :stripe_client
 
           client = StripeClient.new
           client.request {}
 
-          assert_equal :stripe_client, Thread.current[:stripe_client]
+          assert_equal :stripe_client,
+                       StripeClient.current_thread_context.active_client
         ensure
-          Thread.current[:stripe_client] = nil
+          StripeClient.current_thread_context.active_client = nil
+        end
+      end
+
+      should "correctly return last responses despite multiple clients" do
+        charge_resp = { object: "charge" }
+        coupon_resp = { object: "coupon" }
+
+        stub_request(:post, "#{Stripe.api_base}/v1/charges")
+          .to_return(body: JSON.generate(charge_resp))
+        stub_request(:post, "#{Stripe.api_base}/v1/coupons")
+          .to_return(body: JSON.generate(coupon_resp))
+
+        client1 = StripeClient.new
+        client2 = StripeClient.new
+
+        client2_resp = nil
+        _charge, client1_resp = client1.request do
+          Charge.create
+
+          # This is contrived, but we run one client nested in the `request`
+          # block of another one just to ensure that the parent is still
+          # unwinding when this goes through. If the parent's last response
+          # were to be overridden by this client (through a bug), then it would
+          # happen here.
+          _coupon, client2_resp = client2.request do
+            Coupon.create
+          end
+        end
+
+        assert_equal charge_resp, client1_resp.data
+        assert_equal coupon_resp, client2_resp.data
+      end
+
+      should "correctly return last responses despite multiple threads" do
+        charge_resp = { object: "charge" }
+        coupon_resp = { object: "coupon" }
+
+        stub_request(:post, "#{Stripe.api_base}/v1/charges")
+          .to_return(body: JSON.generate(charge_resp))
+        stub_request(:post, "#{Stripe.api_base}/v1/coupons")
+          .to_return(body: JSON.generate(coupon_resp))
+
+        client = StripeClient.new
+
+        # Poorly named class -- note this is actually a concurrent queue.
+        recv_queue = Queue.new
+        send_queue = Queue.new
+
+        # Start a thread, make an API request, but then idle in the `request`
+        # block until the main thread has been able to make its own API request
+        # and signal that it's done. If this thread's last response were to be
+        # overridden by the main thread (through a bug), then this routine
+        # should suss it out.
+        resp1 = nil
+        thread = Thread.start do
+          _charge, resp1 = client.request do
+            Charge.create
+
+            # Idle in `request` block until main thread signals.
+            send_queue.pop
+          end
+
+          # Signal main thread that we're done and it can run its checks.
+          recv_queue << true
+        end
+
+        # Make an API request.
+        _coupon, resp2 = client.request do
+          Coupon.create
+        end
+
+        # Tell background thread to finish `request`, then wait for it to
+        # signal back to us that it's ready.
+        send_queue << true
+        recv_queue.pop
+
+        assert_equal charge_resp, resp1.data
+        assert_equal coupon_resp, resp2.data
+
+        # And for maximum hygiene, make sure that our thread rejoins.
+        thread.join
+      end
+
+      should "error if calls to #request are nested on the same thread" do
+        client = StripeClient.new
+        client.request do
+          e = assert_raises(RuntimeError) do
+            client.request {}
+          end
+          assert_equal "calls to StripeClient#request cannot be nested within a thread",
+                       e.message
         end
       end
     end
@@ -753,18 +933,23 @@ module Stripe
     context "#proxy" do
       should "run the request through the proxy" do
         begin
-          Thread.current[:stripe_client_default_conn] = nil
+          StripeClient.current_thread_context.default_connection_manager = nil
 
-          Stripe.proxy = "http://localhost:8080"
+          Stripe.proxy = "http://user:pass@localhost:8080"
 
           client = StripeClient.new
           client.request {}
 
-          assert_equal "http://localhost:8080", Stripe::StripeClient.default_conn.proxy.uri.to_s
+          connection = Stripe::StripeClient.default_connection_manager.connection_for(Stripe.api_base)
+
+          assert_equal "localhost", connection.proxy_address
+          assert_equal 8080, connection.proxy_port
+          assert_equal "user", connection.proxy_user
+          assert_equal "pass", connection.proxy_pass
         ensure
           Stripe.proxy = nil
 
-          Thread.current[:stripe_client_default_conn] = nil
+          StripeClient.current_thread_context.default_connection_manager = nil
         end
       end
     end