Merge pull request #1311 from stripe/helenye-use-deprecation-gem-search

Use the deprecation gem in search and clean up usage of the gem

lib/stripe/api_operations/search.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-# TODO: (major) Deprecated, Remove along with extends
 module Stripe
   module APIOperations
+    # The _search method via API Operations is deprecated.
+    # Please use the search method from within the resource instead.
     module Search
       def _search(search_url, filters = {}, opts = {})
         request_stripe_object(
@@ -12,6 +13,9 @@ module Stripe
           opts: opts
         )
       end
+
+      extend Gem::Deprecate
+      deprecate :_search, "request_stripe_object", 2024, 1
     end
   end
 end

lib/stripe/resources/account.rb

@@ -11,7 +11,6 @@ module Stripe
   # for a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express**
   # below. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts).
   class Account < APIResource
-    extend Gem::Deprecate
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

test/stripe/api_operations_test.rb

@@ -39,6 +39,26 @@ module Stripe
       end
     end
 
+    context ".search" do
+      should "warn that ._search is deprecated" do
+        old_stderr = $stderr
+        $stderr = StringIO.new
+        begin
+          stub_request(:post, "#{Stripe.api_base}/v1/customers/search?query=foo:bar")
+            .to_return(body: JSON.generate(object: "customer"))
+
+          client = StripeClient.new
+          client.request { Customer._search("/v1/customers/search", query: "foo:bar") }
+
+          message = "NOTE: Stripe::Customer._search is deprecated; use request_stripe_object " \
+                    "instead. It will be removed on or after 2024-01."
+          assert_match Regexp.new(message), $stderr.string
+        ensure
+          $stderr = old_stderr
+        end
+      end
+    end
+
     context ".nested_resource_class_methods" do
       class MainResource < APIResource # rubocop:todo Lint/ConstantDefinitionInBlock
         extend Stripe::APIOperations::NestedResource