paypal-rest-api 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb41159069ce06e4af428ec51fd553c176383626ac51eae019484f7bf65d22c8
-  data.tar.gz: 6c91629dd7dc266198642ae2ed4606c764cf8e376a39695fb7fbdf5ebfd22e28
+  metadata.gz: '08b9e0e25c50df502751486cfeceb957be78e1951aa919faec3caf9550eec304'
+  data.tar.gz: 0d3894d681057c4721cf3e50a20308ad8e7a19ffb68d73ecab31ca9f112ed2c2
 SHA512:
-  metadata.gz: 4dfa83c73dbf06ac3badf8151241baa837a075f17bbe40927b8b1280bbff3867bdf8da3b4ed2e4b4126530767019aabf82899941edc0efeccdca42eba7d597e5
-  data.tar.gz: '08df1fc1d94b9c395e684a366aed64c50f94a2e357ee1d0ddb0894ba2bd5db7a2a8513799caa6138c87784fe1932f7bbcd8028f0c679e843fa9f0cfbe9b97f69'
+  metadata.gz: 49e4bbea2d23037f3af274dddf8fc9c0652b55b06247bf8513531bf41ca925bfc768f9bfa9a98022f3783cf64022906dec19932d8cf2380ef5c4464cff1ba66e
+  data.tar.gz: b8e9d53bab01f8f31da162165191bbe8ecc00b06b9a342966a3400971811d6498c71b598e2f35e7269863d82abdcfa39b92dbcf7734eb6bb79545f52a11fbb48

data/README.md

@@ -1,3 +1,8 @@
+[![Gem Version](https://badge.fury.io/rb/paypal-rest-api.svg)](https://badge.fury.io/rb/paypal-rest-api)
+[![GitHub Actions](https://github.com/aglushkov/paypal-rest-api/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/aglushkov/paypal-rest-api/actions/workflows/main.yml)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/11efd530f1df171dac2b/test_coverage)](https://codeclimate.com/github/aglushkov/paypal-rest-api/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/11efd530f1df171dac2b/maintainability)](https://codeclimate.com/github/aglushkov/paypal-rest-api/maintainability)
+
 # PaypalAPI
 
 ## Installation
@@ -130,7 +135,7 @@ Retries happen on any network error, on 409, 429, 5xx response status code.
 
 ```ruby
 client = PaypalAPI::Client.new(
-  retries: {count: 2, sleep: [0, 0]}
+  retries: {enabled: !Rails.env.test?, count: 5, sleep: [0, 0.25, 0.75, 1.5, 2]}
   # ...
 )
 ```
@@ -351,6 +356,18 @@ All API endpoints accept this parameters:
 - `PaypalAPI::Orders.track`
 - `PaypalAPI::Orders.update_tracker`
 
+### Payment Tokens
+
+- `PaypalAPI::PaymentTokens.create`
+- `PaypalAPI::PaymentTokens.list`
+- `PaypalAPI::PaymentTokens.show`
+- `PaypalAPI::PaymentTokens.delete`
+
+<!-- -->
+
+- `PaypalAPI::SetupTokens.create`
+- `PaypalAPI::SetupTokens.show`
+
 ### Payments
 
 - `PaypalAPI::AuthorizedPayments.show`

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/paypal-api/api_collections/authentication.rb

@@ -13,7 +13,7 @@ module PaypalAPI
     PATH = "/v1/oauth2/token"
 
     #
-    # Common class and instance methods
+    # Common methods for PayplaAPI::Authentication class and client.authentication instance
     #
     module APIs
       #

data/lib/paypal-api/api_collections/authorized_payments.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class AuthorizedPayments < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PayplaAPI::AuthorizedPayments class and client.authorized_payments instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/captured_payments.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class CapturedPayments < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::CapturedPayments class and client.captured_payments instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/catalog_products.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class CatalogProducts < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::CatalogProducts class and client.catalog_products instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/disputes.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class Disputes < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Disputes class and client.disputes instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/invoice_templates.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class InvoiceTemplates < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::InvoiceTemplates class and client.invoice_templates instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/invoices.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class Invoices < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Invoices class and client.invoices instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/orders.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class Orders < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Orders class and client.orders instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/payment_tokens.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Payment Method Tokens
+  #
+  # @see https://developer.paypal.com/docs/api/payment-tokens/v3/
+  #
+  class PaymentTokens < APICollection
+    #
+    # Common methods for PaypalAPI::PaymentTokens class and client.payment_tokens instance
+    #
+    module APIs
+      # @!macro [new] request
+      #   @param query [Hash, nil] Request query parameters
+      #   @param body [Hash, nil] Request body parameters
+      #   @param headers [Hash, nil] Request headers
+      #   @return [Response] Response object
+
+      #
+      # Create payment token for a given payment source
+      #
+      # @see https://developer.paypal.com/docs/api/payment-tokens/v3/#payment-tokens_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v3/vault/payment-tokens", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List all payment tokens
+      #
+      # @see https://developer.paypal.com/docs/api/payment-tokens/v3/#customer_payment-tokens_get
+      #
+      # @macro request
+      #
+      def list(query: nil, body: nil, headers: nil)
+        client.get("/v3/vault/payment-tokens", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Retrieve a payment token
+      #
+      # @see https://developer.paypal.com/docs/api/payment-tokens/v3/#payment-tokens_get
+      #
+      # @param id [String] ID of the payment token.
+      # @macro request
+      #
+      def show(id, query: nil, body: nil, headers: nil)
+        client.get("/v3/vault/payment-tokens/#{encode(id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Delete payment token
+      #
+      # @see https://developer.paypal.com/docs/api/payment-tokens/v3/#payment-tokens_delete
+      #
+      # @param id [String] ID of the payment token
+      # @macro request
+      #
+      def delete(id, query: nil, body: nil, headers: nil)
+        client.delete("/v3/vault/payment-tokens/#{encode(id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

data/lib/paypal-api/api_collections/payout_items.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class PayoutItems < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::PayoutItems class and client.payout_items instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/payouts.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class Payouts < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Payouts class and client.payouts instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/referenced_payout_items.rb

@@ -4,11 +4,11 @@ module PaypalAPI
   #
   # Enables partner merchants and developers to process individual referenced payouts to recipients.
   #
-  # @seehttps://developer.paypal.com/docs/api/referenced-payouts/v1/
+  # @see https://developer.paypal.com/docs/api/referenced-payouts/v1/
   #
   class ReferencedPayoutItems < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::ReferencedPayoutItems class and client.referenced_payout_items instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/referenced_payouts.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class ReferencedPayouts < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::ReferencedPayouts class and client.referenced_payouts instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/refunds.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class Refunds < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Refunds class and client.refunds instance
     #
     module APIs
       #

data/lib/paypal-api/api_collections/setup_tokens.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Payment Setup Tokens
+  #
+  # @see https://developer.paypal.com/docs/api/payment-tokens/v3/
+  #
+  class SetupTokens < APICollection
+    #
+    # Common methods for PaypalAPI::SetupTokens class and client.setup_tokens instance
+    #
+    module APIs
+      # @!macro [new] request
+      #   @param query [Hash, nil] Request query parameters
+      #   @param body [Hash, nil] Request body parameters
+      #   @param headers [Hash, nil] Request headers
+      #   @return [Response] Response object
+
+      #
+      # Create a setup token
+      #
+      # @see https://developer.paypal.com/docs/api/payment-tokens/v3/#setup-tokens_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v3/vault/setup-tokens", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Retrieve a setup token
+      #
+      # @see https://developer.paypal.com/docs/api/payment-tokens/v3/#setup-tokens_get
+      #
+      # @param id [String] ID of the setup token.
+      # @macro request
+      #
+      def show(id, query: nil, body: nil, headers: nil)
+        client.get("/v3/vault/setup-tokens/#{encode(id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

data/lib/paypal-api/api_collections/shipment_tracking.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class ShipmentTracking < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::ShipmentTracking class and client.shipment_tracking instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/subscription_plans.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class SubscriptionPlans < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::SubscriptionPlans class and client.subscription_plans instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/subscriptions.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class Subscriptions < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Subscriptions class and client.subscriptions instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/user_info.rb

@@ -8,7 +8,7 @@ module PaypalAPI
   #
   class UserInfo < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::UserInfo class and client.user_info instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/users.rb

@@ -4,11 +4,11 @@ module PaypalAPI
   #
   # Managing users APIs
   #
-  # https://developer.paypal.com/docs/api/identity/v2/
+  # @see https://developer.paypal.com/docs/api/identity/v2/
   #
   class Users < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Users class and client.users instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/webhook_events.rb

@@ -6,7 +6,7 @@ module PaypalAPI
   #
   class WebhookEvents < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::WebhookEvents class and client.webhook_events instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/webhook_lookups.rb

@@ -6,7 +6,7 @@ module PaypalAPI
   #
   class WebhookLookups < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::WebhookLookups class and client.webhook_lookups instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/api_collections/webhooks.rb

@@ -6,7 +6,7 @@ module PaypalAPI
   #
   class Webhooks < APICollection
     #
-    # Common class and instance methods
+    # Common methods for PaypalAPI::Webhooks class and client.webhooks instance
     #
     module APIs
       # @!macro [new] request

data/lib/paypal-api/client.rb

@@ -241,6 +241,11 @@ module PaypalAPI
       Orders.new(self)
     end
 
+    # @return [PaymentTokens] PaymentTokens APIs collection
+    def payment_tokens
+      PaymentTokens.new(self)
+    end
+
     # @return [PayoutItems] PayoutItems APIs collection
     def payout_items
       PayoutItems.new(self)
@@ -251,7 +256,7 @@ module PaypalAPI
       Payouts.new(self)
     end
 
-    # @return [Redunds] Refunds APIs collection
+    # @return [Refunds] Refunds APIs collection
     def refunds
       Refunds.new(self)
     end
@@ -266,6 +271,11 @@ module PaypalAPI
       ReferencedPayouts.new(self)
     end
 
+    # @return [SetupTokens] SetupTokens APIs collection
+    def setup_tokens
+      SetupTokens.new(self)
+    end
+
     # @return [ShipmentTracking] Shipment Tracking APIs collection
     def shipment_tracking
       ShipmentTracking.new(self)

data/lib/paypal-api/error.rb

@@ -37,7 +37,6 @@ module PaypalAPI
     #
     class FailedRequest < Error
       def initialize(message = nil, request:, response:)
-        super(message)
         @request = request
         @response = response
 
@@ -48,6 +47,9 @@ module PaypalAPI
         @error_debug_id = data[:debug_id]
         @error_details = data[:details]
         @paypal_request_id = request.http_request["paypal-request-id"]
+
+        message += "\n  #{response.http_body}" unless data.empty?
+        super(message)
       end
     end
 

data/lib/paypal-api/request.rb

@@ -83,27 +83,9 @@ module PaypalAPI
     def build_http_headers(http_request, body, headers)
       headers = normalize_headers(headers)
 
-      unless headers.key?("authorization")
-        http_request["authorization"] = client.access_token.authorization_string
-      end
-
-      #
-      # We should set json content type header to not get 415 UnsupportedMediaType
-      # error in various APIs
-      #
-      # PayPal requires "application/json" content type even for GET requests
-      # and for POST requests without body.
-      #
-      # Net::HTTP sets default content-type "application/x-www-form-urlencoded"
-      # if not provided
-      #
-      unless headers.key?("content-type")
-        http_request["content-type"] = "application/json"
-      end
-
-      unless headers.key?("paypal-request-id")
-        http_request["paypal-request-id"] = SecureRandom.uuid unless http_request.is_a?(Net::HTTP::Get)
-      end
+      add_authorization_header(http_request, headers)
+      add_content_type_header(http_request, headers)
+      add_paypal_request_id_header(http_request, headers)
 
       headers.each { |key, value| http_request[key] = value }
     end
@@ -124,5 +106,33 @@ module PaypalAPI
     def normalize_headers(headers)
       headers.empty? ? headers : headers.transform_keys { |key| key.to_s.downcase }
     end
+
+    def add_authorization_header(http_request, headers)
+      unless headers.key?("authorization")
+        http_request["authorization"] = client.access_token.authorization_string
+      end
+    end
+
+    #
+    # We should set json content type header to not get 415 UnsupportedMediaType
+    # error in various APIs
+    #
+    # PayPal requires "application/json" content type even for GET requests
+    # and for POST requests without body.
+    #
+    # Net::HTTP sets default content-type "application/x-www-form-urlencoded"
+    # if not provided
+    #
+    def add_content_type_header(http_request, headers)
+      unless headers.key?("content-type")
+        http_request["content-type"] = "application/json"
+      end
+    end
+
+    def add_paypal_request_id_header(http_request, headers)
+      unless headers.key?("paypal-request-id")
+        http_request["paypal-request-id"] = SecureRandom.uuid unless http_request.is_a?(Net::HTTP::Get)
+      end
+    end
   end
 end

data/lib/paypal-api.rb

@@ -200,11 +200,13 @@ module PaypalAPI
       invoice_templates
       invoices
       orders
+      payment_tokens
       payout_items
       payouts
       refunds
       referenced_payout_items
       referenced_payouts
+      setup_tokens
       shipment_tracking
       subscriptions
       subscription_plans
@@ -253,11 +255,13 @@ 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/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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies: []
 description: PayPal REST API with no dependencies.
 email:
@@ -30,11 +30,13 @@ 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/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