paypal-rest-api 0.3.1 → 0.5.0

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/access_token_methods.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  class Client
+    #
+    # Client methods to get access token
+    #
+    module AccessTokenMethods
+      #
+      # Checks cached access token is expired and returns it or generates new one
+      #
+      # @return [AccessToken] AccessToken object
+      #
+      def access_token
+        (@access_token.nil? || @access_token.expired?) ? refresh_access_token : @access_token
+      end
+
+      #
+      # Generates and caches new AccessToken
+      #
+      # @return [AccessToken] new AccessToken object
+      #
+      def refresh_access_token
+        requested_at = Time.now
+        response = authentication.generate_access_token
+
+        @access_token = AccessToken.new(
+          requested_at: requested_at,
+          expires_in: response.fetch(:expires_in),
+          access_token: response.fetch(:access_token),
+          token_type: response.fetch(:token_type)
+        )
+      end
+    end
+  end
+end

data/lib/paypal-api/client/api_methods.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  class Client
+    #
+    # Methods to access API collections
+    #
+    module APIMethods
+      # @return [AuthorizedPayments] AuthorizedPayments APIs collection
+      def authorized_payments
+        AuthorizedPayments.new(self)
+      end
+
+      # @return [CapturedPayments] CapturedPayments APIs collection
+      def captured_payments
+        CapturedPayments.new(self)
+      end
+
+      # @return [Authentication] Authentication APIs collection
+      def authentication
+        Authentication.new(self)
+      end
+
+      # @return [CatalogProducts] Catalog Products APIs collection
+      def catalog_products
+        CatalogProducts.new(self)
+      end
+
+      # @return [Disputes] Disputes APIs collection
+      def disputes
+        Disputes.new(self)
+      end
+
+      # @return [InvoiceTemplates] InvoiceTemplates APIs collection
+      def invoice_templates
+        InvoiceTemplates.new(self)
+      end
+
+      # @return [Invoices] Invoices APIs collection
+      def invoices
+        Invoices.new(self)
+      end
+
+      # @return [Orders] Orders APIs collection
+      def orders
+        Orders.new(self)
+      end
+
+      # @return [PartnerReferrals] PartnerReferrals APIs collection
+      def partner_referrals
+        PartnerReferrals.new(self)
+      end
+
+      # @return [PaymentExperienceWebProfiles] PaymentExperienceWebProfiles APIs collection
+      def payment_experience_web_profiles
+        PaymentExperienceWebProfiles.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)
+      end
+
+      # @return [Payouts] Payouts APIs collection
+      def payouts
+        Payouts.new(self)
+      end
+
+      # @return [Refunds] Refunds APIs collection
+      def refunds
+        Refunds.new(self)
+      end
+
+      # @return [ReferencedPayoutItems] ReferencedPayoutItems APIs collection
+      def referenced_payout_items
+        ReferencedPayoutItems.new(self)
+      end
+
+      # @return [ReferencedPayouts] ReferencedPayouts APIs collection
+      def referenced_payouts
+        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)
+      end
+
+      # @return [Subscriptions] Subscriptions APIs collection
+      def subscriptions
+        Subscriptions.new(self)
+      end
+
+      # @return [SubscriptionPlans] Subscription Plans APIs collection
+      def subscription_plans
+        SubscriptionPlans.new(self)
+      end
+
+      # @return [TransactionSearch] TransactionSearch APIs collection
+      def transaction_search
+        TransactionSearch.new(self)
+      end
+
+      # @return [UserInfo] User Info APIs collection
+      def user_info
+        UserInfo.new(self)
+      end
+
+      # @return [Users] Users Management APIs collection
+      def users
+        Users.new(self)
+      end
+
+      # @return [Webhooks] Webhooks APIs collection
+      def webhooks
+        Webhooks.new(self)
+      end
+
+      # @return [WebhookEvents] Webhook Events APIs collection
+      def webhook_lookups
+        WebhookLookups.new(self)
+      end
+
+      # @return [WebhookEvents] Webhook Lookups APIs collection
+      def webhook_events
+        WebhookEvents.new(self)
+      end
+    end
+  end
+end

data/lib/paypal-api/client/environment_methods.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  class Client
+    #
+    # Client environment specific methods
+    #
+    module EnvironmentMethods
+      # Checks if PayPal LIVE environment enabled
+      # @return [Boolean] Checks if PayPal LIVE environment enabled
+      def live?
+        env.live?
+      end
+
+      # Checks if PayPal SANDBOX environment enabled
+      # @return [Boolean] Checks if PayPal SANDBOX environment enabled
+      def sandbox?
+        env.sandbox?
+      end
+
+      # Base API URL
+      # @return [String] Base API URL
+      def api_url
+        env.api_url
+      end
+
+      # Base WEB URL
+      # @return [String] Base WEB URL
+      def web_url
+        env.web_url
+      end
+    end
+  end
+end

data/lib/paypal-api/client/http_methods.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  class Client
+    #
+    # Client HTTP methods
+    #
+    module HTTPMethods
+      # @!macro [new] request
+      # @param path [String] Request path
+      # @param query [Hash, nil] Request query parameters
+      # @param body [Hash, nil] Request body parameters
+      # @param headers [Hash, nil] Request headers
+      #
+      # @return [Response] Response object
+
+      #
+      # Executes POST http request
+      #
+      # @macro request
+      #
+      def post(path, query: nil, body: nil, headers: nil)
+        execute_request(Net::HTTP::Post, path, query: query, body: body, headers: headers)
+      end
+
+      #
+      # Executes GET http request
+      #
+      # @macro request
+      #
+      def get(path, query: nil, body: nil, headers: nil)
+        execute_request(Net::HTTP::Get, path, query: query, body: body, headers: headers)
+      end
+
+      #
+      # Executes PATCH http request
+      #
+      # @macro request
+      #
+      def patch(path, query: nil, body: nil, headers: nil)
+        execute_request(Net::HTTP::Patch, path, query: query, body: body, headers: headers)
+      end
+
+      #
+      # Executes PUT http request
+      #
+      # @macro request
+      #
+      def put(path, query: nil, body: nil, headers: nil)
+        execute_request(Net::HTTP::Put, path, query: query, body: body, headers: headers)
+      end
+
+      #
+      # Executes DELETE http request
+      #
+      # @macro request
+      #
+      def delete(path, query: nil, body: nil, headers: nil)
+        execute_request(Net::HTTP::Delete, path, query: query, body: body, headers: headers)
+      end
+
+      private
+
+      def execute_request(http_method, path, query: nil, body: nil, headers: nil)
+        request = Request.new(self, http_method, path, query: query, body: body, headers: headers)
+        RequestExecutor.new(self, request).call
+      end
+    end
+  end
+end

data/lib/paypal-api/client.rb

@@ -5,6 +5,11 @@ module PaypalAPI
   # PaypalAPI Client
   #
   class Client
+    include AccessTokenMethods
+    include APIMethods
+    include EnvironmentMethods
+    include HTTPMethods
+
     # Paypal environment
     attr_reader :env
 
@@ -43,30 +48,6 @@ module PaypalAPI
       @access_token = nil
     end
 
-    # Checks if PayPal LIVE environment enabled
-    # @return [Boolean] Checks if PayPal LIVE environment enabled
-    def live?
-      env.live?
-    end
-
-    # Checks if PayPal SANDBOX environment enabled
-    # @return [Boolean] Checks if PayPal SANDBOX environment enabled
-    def sandbox?
-      env.sandbox?
-    end
-
-    # Base API URL
-    # @return [String] Base API URL
-    def api_url
-      env.api_url
-    end
-
-    # Base WEB URL
-    # @return [String] Base WEB URL
-    def web_url
-      env.web_url
-    end
-
     # Registers callback
     #
     # @param callback_name [Symbol] Callback name.
@@ -90,32 +71,6 @@ module PaypalAPI
       callbacks.fetch(callback_name) << block
     end
 
-    #
-    # Checks cached access token is expired and returns it or generates new one
-    #
-    # @return [AccessToken] AccessToken object
-    #
-    def access_token
-      (@access_token.nil? || @access_token.expired?) ? refresh_access_token : @access_token
-    end
-
-    #
-    # Generates and caches new AccessToken
-    #
-    # @return [AccessToken] new AccessToken object
-    #
-    def refresh_access_token
-      requested_at = Time.now
-      response = authentication.generate_access_token
-
-      @access_token = AccessToken.new(
-        requested_at: requested_at,
-        expires_in: response.fetch(:expires_in),
-        access_token: response.fetch(:access_token),
-        token_type: response.fetch(:token_type)
-      )
-    end
-
     #
     # Verifies Webhook
     #
@@ -147,170 +102,5 @@ module PaypalAPI
     def verify_webhook(webhook_id:, headers:, raw_body:)
       WebhookVerifier.new(self).call(webhook_id: webhook_id, headers: headers, raw_body: raw_body)
     end
-
-    # @!macro [new] request
-    # @param path [String] Request path
-    # @param query [Hash, nil] Request query parameters
-    # @param body [Hash, nil] Request body parameters
-    # @param headers [Hash, nil] Request headers
-    #
-    # @return [Response] Response object
-
-    #
-    # Executes POST http request
-    #
-    # @macro request
-    #
-    def post(path, query: nil, body: nil, headers: nil)
-      execute_request(Net::HTTP::Post, path, query: query, body: body, headers: headers)
-    end
-
-    #
-    # Executes GET http request
-    #
-    # @macro request
-    #
-    def get(path, query: nil, body: nil, headers: nil)
-      execute_request(Net::HTTP::Get, path, query: query, body: body, headers: headers)
-    end
-
-    #
-    # Executes PATCH http request
-    #
-    # @macro request
-    #
-    def patch(path, query: nil, body: nil, headers: nil)
-      execute_request(Net::HTTP::Patch, path, query: query, body: body, headers: headers)
-    end
-
-    #
-    # Executes PUT http request
-    #
-    # @macro request
-    #
-    def put(path, query: nil, body: nil, headers: nil)
-      execute_request(Net::HTTP::Put, path, query: query, body: body, headers: headers)
-    end
-
-    #
-    # Executes DELETE http request
-    #
-    # @macro request
-    #
-    def delete(path, query: nil, body: nil, headers: nil)
-      execute_request(Net::HTTP::Delete, path, query: query, body: body, headers: headers)
-    end
-
-    # @return [AuthorizedPayments] AuthorizedPayments APIs collection
-    def authorized_payments
-      AuthorizedPayments.new(self)
-    end
-
-    # @return [CapturedPayments] CapturedPayments APIs collection
-    def captured_payments
-      CapturedPayments.new(self)
-    end
-
-    # @return [Authentication] Authentication APIs collection
-    def authentication
-      Authentication.new(self)
-    end
-
-    # @return [CatalogProducts] Catalog Products APIs collection
-    def catalog_products
-      CatalogProducts.new(self)
-    end
-
-    # @return [Disputes] Disputes APIs collection
-    def disputes
-      Disputes.new(self)
-    end
-
-    # @return [InvoiceTemplates] InvoiceTemplates APIs collection
-    def invoice_templates
-      InvoiceTemplates.new(self)
-    end
-
-    # @return [Invoices] Invoices APIs collection
-    def invoices
-      Invoices.new(self)
-    end
-
-    # @return [Orders] Orders APIs collection
-    def orders
-      Orders.new(self)
-    end
-
-    # @return [PayoutItems] PayoutItems APIs collection
-    def payout_items
-      PayoutItems.new(self)
-    end
-
-    # @return [Payouts] Payouts APIs collection
-    def payouts
-      Payouts.new(self)
-    end
-
-    # @return [Redunds] Refunds APIs collection
-    def refunds
-      Refunds.new(self)
-    end
-
-    # @return [ReferencedPayoutItems] ReferencedPayoutItems APIs collection
-    def referenced_payout_items
-      ReferencedPayoutItems.new(self)
-    end
-
-    # @return [ReferencedPayouts] ReferencedPayouts APIs collection
-    def referenced_payouts
-      ReferencedPayouts.new(self)
-    end
-
-    # @return [ShipmentTracking] Shipment Tracking APIs collection
-    def shipment_tracking
-      ShipmentTracking.new(self)
-    end
-
-    # @return [Subscriptions] Subscriptions APIs collection
-    def subscriptions
-      Subscriptions.new(self)
-    end
-
-    # @return [SubscriptionPlans] Subscription Plans APIs collection
-    def subscription_plans
-      SubscriptionPlans.new(self)
-    end
-
-    # @return [UserInfo] User Info APIs collection
-    def user_info
-      UserInfo.new(self)
-    end
-
-    # @return [Users] Users Management APIs collection
-    def users
-      Users.new(self)
-    end
-
-    # @return [Webhooks] Webhooks APIs collection
-    def webhooks
-      Webhooks.new(self)
-    end
-
-    # @return [WebhookEvents] Webhook Events APIs collection
-    def webhook_lookups
-      WebhookLookups.new(self)
-    end
-
-    # @return [WebhookEvents] Webhook Lookups APIs collection
-    def webhook_events
-      WebhookEvents.new(self)
-    end
-
-    private
-
-    def execute_request(http_method, path, query: nil, body: nil, headers: nil)
-      request = Request.new(self, http_method, path, query: query, body: body, headers: headers)
-      RequestExecutor.new(self, request).call
-    end
   end
 end

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
@@ -117,12 +99,55 @@ module PaypalAPI
 
     def build_http_uri(path, query)
       uri = URI.join(client.env.api_url, path)
-      uri.query = URI.encode_www_form(query) if query && !query.empty?
+      add_query_params(uri, query)
+
       uri
     end
 
     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
+
+    def add_query_params(uri, query)
+      return if !query || query.empty?
+
+      # We should merge query params with uri query params to not temove them
+      uri_query_string = uri.query
+
+      if uri_query_string && !uri_query_string.empty?
+        old_query = URI.decode_www_form(uri_query_string).to_h
+        query = old_query.transform_keys!(&:to_sym).merge!(query.transform_keys(&:to_sym))
+      end
+
+      uri.query = URI.encode_www_form(query)
+    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