paypal-rest-api 0.3.1 → 0.5.0

data/lib/paypal-api/request_executor.rb

@@ -30,31 +30,40 @@ module PaypalAPI
 
     private
 
-    def execute_request(retry_number: 0)
+    def start_execution(retry_number)
       callbacks_context[:retry_number] = retry_number
-
       run_callbacks(:before)
-      response = execute_net_http_request
-    rescue => error
-      raise error if NetworkErrorBuilder::ERRORS.none? { |network_error_class| error.is_a?(network_error_class) }
+      execute_net_http_request
+    end
 
+    def handle_network_error(error, retry_number)
       will_retry = retries[:enabled] && !retries_limit_reached?(retry_number)
       callbacks_context[:will_retry] = will_retry
       run_callbacks(:after_network_error, error)
       raise NetworkErrorBuilder.call(request: request, error: error) unless will_retry
 
       retry_request(retry_number)
+    end
+
+    def handle_success_response(response)
+      callbacks_context.delete(:will_retry)
+      run_callbacks(:after_success, response)
+      response
+    end
+
+    def handle_failed_response(response, retry_number)
+      will_retry = retries[:enabled] && retryable?(response, retry_number)
+      callbacks_context[:will_retry] = will_retry
+      run_callbacks(:after_fail, response)
+      will_retry ? retry_request(retry_number) : response
+    end
+
+    def execute_request(retry_number: 0)
+      response = start_execution(retry_number)
+    rescue => error
+      unknown_network_error?(error) ? handle_unknown_error(error) : handle_network_error(error, retry_number)
     else
-      if response.success?
-        callbacks_context.delete(:will_retry)
-        run_callbacks(:after_success, response)
-        response
-      else
-        will_retry = retries[:enabled] && retryable?(response, retry_number)
-        callbacks_context[:will_retry] = will_retry
-        run_callbacks(:after_fail, response)
-        will_retry ? retry_request(retry_number) : response
-      end
+      response.success? ? handle_success_response(response) : handle_failed_response(response, retry_number)
     end
 
     def execute_net_http_request
@@ -105,6 +114,14 @@ module PaypalAPI
       true
     end
 
+    def unknown_network_error?(error)
+      NetworkErrorBuilder::ERRORS.none? { |network_error_class| error.is_a?(network_error_class) }
+    end
+
+    def handle_unknown_error(error)
+      raise error
+    end
+
     def run_callbacks(callback_name, resp = nil)
       callbacks[callback_name].each { |callback| callback.call(request, callbacks_context, resp) }
     end

data/lib/paypal-api/response.rb

@@ -108,6 +108,72 @@ module PaypalAPI
       "#<#{self.class.name} (#{http_response.code})>"
     end
 
+    #
+    # Follow up HATEOAS link
+    #
+    # @see https://developer.paypal.com/api/rest/responses/#link-hateoaslinks
+    #
+    # @param rel [String] Target link "rel" attribute
+    # @param query [Hash] Request additional query parameters
+    # @param body [Hash] Request body parameters
+    # @param headers [Hash] Request headers
+    #
+    # @return [Response, nil] Follow-up link response, if link with provided "rel" exists
+    #
+    def follow_up_link(rel, query: nil, body: nil, headers: nil)
+      links = self[:links]
+      return unless links
+
+      link = links.find { |curr_link| curr_link[:rel] == rel.to_s }
+      return unless link
+
+      http_method = link[:method]&.downcase || :get
+      request.client.public_send(http_method, link[:href], query: query, body: body, headers: headers)
+    end
+
+    #
+    # Pagination methods
+    #
+    module PaginationHelpers
+      #
+      # Iterates through all response pages by requesting HATEOAS "next" links,
+      # making additional fetches to the API as necessary.
+      #
+      # @see #follow_up_link
+      #
+      # @yield [Response] Next page response
+      #
+      # @return [void]
+      #
+      def each_page(&block)
+        return enum_for(:each_page) unless block
+
+        page = self
+        yield(page)
+        yield(page) while (page = page.follow_up_link("next"))
+      end
+
+      #
+      # Iterates through all items in response +items_field_name+ field,
+      # making additional pages requests as necessary.
+      #
+      # @see #each_page
+      #
+      # @param items_field_name [Symbol] Name of field containing items
+      #
+      # @yield [Hash] Item
+      #
+      # @return [void]
+      #
+      def each_page_item(items_field_name, &block)
+        return enum_for(:each_page_item, items_field_name) unless block
+
+        each_page do |page|
+          page.fetch(items_field_name).each(&block)
+        end
+      end
+    end
+
     private
 
     def json_response?
@@ -120,5 +186,7 @@ module PaypalAPI
     rescue JSON::ParserError, TypeError
       json
     end
+
+    include PaginationHelpers
   end
 end

data/lib/paypal-api.rb

@@ -100,10 +100,8 @@ module PaypalAPI
 
     #
     # @!macro [new] api_collection
-    #   $0 APIs collection
+    #   $3 APIs collection
     #   @api public
-    #   @example
-    #     PaypalAPI.$0
     #
 
     #
@@ -139,6 +137,14 @@ module PaypalAPI
     #   @macro api_collection
     #   @return [Orders]
     #
+    # @!method partner_referrals
+    #   @macro api_collection
+    #   @return [PartnerReferrals]
+    #
+    # @!method payment_experience_web_profiles
+    #   @macro api_collection
+    #   @return [PaymentExperienceWebProfile]
+    #
     # @!method payout_items
     #   @macro api_collection
     #   @return [PayoutItems]
@@ -171,6 +177,10 @@ module PaypalAPI
     #   @macro api_collection
     #   @return [SubscriptionPlans]
     #
+    # @!method transaction_search
+    #   @macro api_collection
+    #   @return [TransactionSearch]
+    #
     # @!method user_info
     #   @macro api_collection
     #   @return [UserInfo]
@@ -200,14 +210,19 @@ module PaypalAPI
       invoice_templates
       invoices
       orders
+      partner_referrals
+      payment_experience_web_profiles
+      payment_tokens
       payout_items
       payouts
       refunds
       referenced_payout_items
       referenced_payouts
+      setup_tokens
       shipment_tracking
       subscriptions
       subscription_plans
+      transaction_search
       user_info
       users
       webhooks
@@ -235,6 +250,10 @@ end
 require_relative "paypal-api/access_token"
 require_relative "paypal-api/api_collection"
 require_relative "paypal-api/environment"
+require_relative "paypal-api/client/access_token_methods"
+require_relative "paypal-api/client/api_methods"
+require_relative "paypal-api/client/environment_methods"
+require_relative "paypal-api/client/http_methods"
 require_relative "paypal-api/client"
 require_relative "paypal-api/config"
 require_relative "paypal-api/error"
@@ -253,14 +272,19 @@ require_relative "paypal-api/api_collections/disputes"
 require_relative "paypal-api/api_collections/invoice_templates"
 require_relative "paypal-api/api_collections/invoices"
 require_relative "paypal-api/api_collections/orders"
+require_relative "paypal-api/api_collections/partner_referrals"
+require_relative "paypal-api/api_collections/payment_experience_web_profiles"
+require_relative "paypal-api/api_collections/payment_tokens"
 require_relative "paypal-api/api_collections/payout_items"
 require_relative "paypal-api/api_collections/payouts"
 require_relative "paypal-api/api_collections/refunds"
 require_relative "paypal-api/api_collections/referenced_payout_items"
 require_relative "paypal-api/api_collections/referenced_payouts"
+require_relative "paypal-api/api_collections/setup_tokens"
 require_relative "paypal-api/api_collections/shipment_tracking"
 require_relative "paypal-api/api_collections/subscriptions"
 require_relative "paypal-api/api_collections/subscription_plans"
+require_relative "paypal-api/api_collections/transaction_search"
 require_relative "paypal-api/api_collections/user_info"
 require_relative "paypal-api/api_collections/users"
 require_relative "paypal-api/api_collections/webhooks"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies: []
 description: PayPal REST API with no dependencies.
 email:
@@ -30,20 +30,29 @@ files:
 - lib/paypal-api/api_collections/invoice_templates.rb
 - lib/paypal-api/api_collections/invoices.rb
 - lib/paypal-api/api_collections/orders.rb
+- lib/paypal-api/api_collections/partner_referrals.rb
+- lib/paypal-api/api_collections/payment_experience_web_profiles.rb
+- lib/paypal-api/api_collections/payment_tokens.rb
 - lib/paypal-api/api_collections/payout_items.rb
 - lib/paypal-api/api_collections/payouts.rb
 - lib/paypal-api/api_collections/referenced_payout_items.rb
 - lib/paypal-api/api_collections/referenced_payouts.rb
 - lib/paypal-api/api_collections/refunds.rb
+- lib/paypal-api/api_collections/setup_tokens.rb
 - lib/paypal-api/api_collections/shipment_tracking.rb
 - lib/paypal-api/api_collections/subscription_plans.rb
 - lib/paypal-api/api_collections/subscriptions.rb
+- lib/paypal-api/api_collections/transaction_search.rb
 - lib/paypal-api/api_collections/user_info.rb
 - lib/paypal-api/api_collections/users.rb
 - lib/paypal-api/api_collections/webhook_events.rb
 - lib/paypal-api/api_collections/webhook_lookups.rb
 - lib/paypal-api/api_collections/webhooks.rb
 - lib/paypal-api/client.rb
+- lib/paypal-api/client/access_token_methods.rb
+- lib/paypal-api/client/api_methods.rb
+- lib/paypal-api/client/environment_methods.rb
+- lib/paypal-api/client/http_methods.rb
 - lib/paypal-api/config.rb
 - lib/paypal-api/environment.rb
 - lib/paypal-api/error.rb
@@ -78,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: PayPal REST API