flex_commerce_api 0.6.57

data/lib/paypal_express/setup.rb

@@ -0,0 +1,94 @@
+require_relative 'api'
+
+# @module FlexCommerce::PaypalExpress
+module FlexCommerce
+  module PaypalExpress
+    # @class Setup
+    # 
+    # This is the main class, which talks to ActiveMerchant gem to initiate a transaction using Paypal
+    class Setup
+      include ::FlexCommerce::PaypalExpress::Api
+      
+
+      # @initialize
+      # 
+      # @param {FlexCommerce::PaymentProviderSetup} payment_provider_setup
+      # @param {FlexCommerce::Cart} cart
+      # @param {Paypal Gateway} [gateway_class = ::ActiveMerchant::Billing::PaypalExpressGateway]
+      # @param {URL} success_url - Generally Paypal confirmation page
+      # @param {URL} cancel_url - Generally new transaction page
+      # @param {IP} ip_address - User ip address
+      # @param {boolean} [allow_shipping_change = true] - true: display shipping options, false: dont display shipping options
+      # @param {URL} callback_url - Generally cart show page
+      # @param {FlexCommerce::ShippingMethod} shipping_method_model = FlexCommerce::ShippingMethod
+      # @param {boolean} [use_mobile_payments = false]
+      # @param {String} [description = nil]
+      # 
+      # @note:
+      # For `::ActiveMerchant::Billing::PaypalExpressGateway` to work
+      # rails-site should include active merchant gem. Ideally this gem should be included in the gemspec.
+      # But as we are using custom gem, which is not published to ruby gems, there is no way of including it within this gem dependency
+      def initialize(cart:, gateway_class: ::ActiveMerchant::Billing::PaypalExpressGateway, success_url:, cancel_url:, ip_address:, allow_shipping_change: true, callback_url:, shipping_method_model: FlexCommerce::ShippingMethod, use_mobile_payments: false, description: nil)
+        self.gateway_class = gateway_class
+        self.cart = cart
+        self.allow_shipping_change = allow_shipping_change
+        self.success_url = success_url
+        self.cancel_url = cancel_url
+        self.ip_address = ip_address
+        self.callback_url = callback_url
+        self.shipping_method_model = shipping_method_model
+        self.use_mobile_payments = use_mobile_payments
+        self.description = description
+      end
+
+      def call
+        validate_shipping_method
+        
+        response = gateway.setup_order(convert_amount(cart.total), paypal_params)
+        # If paypal setup went fine, redirect to the paypal page
+        if response.success?
+          PaypalSetup.new(setup_type:  "redirect", redirect_url: gateway.redirect_url_for(response.token, mobile: use_mobile_payments))
+        else
+          # @TODO Find out where to get the message from and add it
+          error = "An error occured communicating with paypal #{response.message} \n\n#{response.params.to_json}. Total sent was #{convert_amount(cart.total)} Parameters sent were \n\n#{paypal_params}"
+          raise ::FlexCommerce::PaypalExpress::Exception::AccessDenied.new(error)
+        end
+      rescue ::FlexCommerce::PaypalExpress::Exception::AccessDenied => exception
+        PaypalSetup.new(errors: exception)
+      end
+
+      private
+
+      attr_accessor :description, :cart, :gateway_class, :success_url, :cancel_url, :ip_address, :allow_shipping_change, :callback_url, :shipping_method_model, :use_mobile_payments
+
+      def paypal_params
+        Process::PaypalParams.new(
+          cart: cart,
+          success_url: success_url,
+          cancel_url: cancel_url,
+          ip_address: ip_address,
+          allow_shipping_change: allow_shipping_change,
+          callback_url: callback_url,
+          shipping_method_model: shipping_method_model,
+          use_mobile_payments: use_mobile_payments,
+          description: description
+        ).call
+      end
+
+      # @method shipping_methods
+      # 
+      # @returns shipping methods with promotions applied
+      def shipping_methods
+        @shipping_methods ||= ShippingMethodsForCart.new(cart: cart, shipping_methods: shipping_method_model.all).call.sort_by(&:total)
+      end
+
+      def validate_shipping_method
+        unless cart.shipping_method_id.nil? || shipping_methods.any? {|sm| sm.id == cart.shipping_method_id} then
+          raise ::FlexCommerce::PaypalExpress::Exception::AccessDenied.new(I18n.t("payment_setup.shipping_method_not_available"))
+        end
+      end
+    end
+
+    class PaypalSetup < OpenStruct; end
+  end
+end

data/lib/paypal_express/shipping_methods_for_cart.rb

@@ -0,0 +1,46 @@
+# @module FlexCommerce::PaypalExpress
+module FlexCommerce
+  module PaypalExpress
+    # @class ShippingMethodsForCart
+    # 
+    # This deals with free shipping promotions and updates the shipping methods accordingly
+    class ShippingMethodsForCart
+
+      include Enumerable
+
+      def initialize(cart:, shipping_methods:)
+        self.cart = cart
+        self.shipping_methods = shipping_methods
+        self.shipping_promotions = cart.available_shipping_promotions
+      end
+
+      def call
+        free_shipping_method_ids = [ ]
+        shipping_promotions.reverse.each do |promotion|
+          # See if promotion is having a shipping method, 
+          # and also see if that cart total is eligible for promotion
+          if promotion.shipping_methods && can_apply_promotion_to_cart?(promotion: promotion)
+            free_shipping_method_ids << promotion.shipping_methods.map(&:id)
+          end
+        end
+
+        free_shipping_method_ids.flatten!
+        updated_shipping_methods = []
+        shipping_methods.each do |shipping_method|
+          shipping_method_free = free_shipping_method_ids.include?(shipping_method.id)
+          updated_shipping_methods << CartShippingMethod.new(shipping_method, shipping_method_free)
+        end
+        updated_shipping_methods
+      end
+
+      private
+
+      attr_accessor :cart, :shipping_methods, :shipping_promotions
+
+      def can_apply_promotion_to_cart?(promotion:)
+        (cart.sub_total - cart.total_discount) >= promotion.minimum_cart_total&.to_i
+      end
+
+    end
+  end
+end

data/lib/retry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Retry
+
+  DEFAULT_MAX_NO_OF_RETRIES = 2
+  DEFAULT_RESCUE_ERRORS = StandardError
+
+  def self.call(no_of_retries: DEFAULT_MAX_NO_OF_RETRIES, rescue_errors: DEFAULT_RESCUE_ERRORS, &blk)
+    total_attempts = 0
+    begin
+      blk.call
+    rescue rescue_errors => ex
+      total_attempts += 1 
+      retry if total_attempts < no_of_retries
+    ensure
+      if total_attempts == no_of_retries
+        return
+      end
+    end
+  end
+end

data/schemas/jsonapi/schema.json

@@ -0,0 +1,370 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "JSON API Schema",
+  "description": "This is a schema for responses in the JSON API format. For more, see http://jsonapi.org",
+  "oneOf": [
+    {
+      "$ref": "#/definitions/success"
+    },
+    {
+      "$ref": "#/definitions/failure"
+    },
+    {
+      "$ref": "#/definitions/info"
+    }
+  ],
+
+  "definitions": {
+    "success": {
+      "type": "object",
+      "required": [
+        "data"
+      ],
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/data"
+        },
+        "included": {
+          "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/resource"
+          },
+          "uniqueItems": true
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "links": {
+          "description": "Link members related to the primary data.",
+          "allOf": [
+            {
+              "$ref": "#/definitions/links"
+            },
+            {
+              "$ref": "#/definitions/pagination"
+            }
+          ]
+        },
+        "jsonapi": {
+          "$ref": "#/definitions/jsonapi"
+        }
+      },
+      "additionalProperties": false
+    },
+    "failure": {
+      "type": "object",
+      "required": [
+        "errors"
+      ],
+      "properties": {
+        "errors": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/error"
+          },
+          "uniqueItems": true
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "jsonapi": {
+          "$ref": "#/definitions/jsonapi"
+        }
+      },
+      "additionalProperties": false
+    },
+    "info": {
+      "type": "object",
+      "required": [
+        "meta"
+      ],
+      "properties": {
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "links": {
+          "$ref": "#/definitions/links"
+        },
+        "jsonapi": {
+          "$ref": "#/definitions/jsonapi"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "meta": {
+      "description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
+      "type": "object",
+      "additionalProperties": true
+    },
+    "data": {
+      "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/resource"
+        },
+        {
+          "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/resource"
+          },
+          "uniqueItems": true
+        },
+        {
+          "description": "null if the request is one that might correspond to a single resource, but doesn't currently.",
+          "type": "null"
+        }
+      ]
+    },
+    "resource": {
+      "description": "\"Resource objects\" appear in a JSON API document to represent resources.",
+      "type": "object",
+      "required": [
+        "type",
+        "id"
+      ],
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "attributes": {
+          "$ref": "#/definitions/attributes"
+        },
+        "relationships": {
+          "$ref": "#/definitions/relationships"
+        },
+        "links": {
+          "$ref": "#/definitions/links"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "links": {
+      "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.",
+      "type": "object",
+      "properties": {
+        "self": {
+          "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.",
+          "type": "string",
+          "format": "uri"
+        },
+        "related": {
+          "$ref": "#/definitions/link"
+        }
+      },
+      "additionalProperties": true
+    },
+    "link": {
+      "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
+      "oneOf": [
+        {
+          "description": "A string containing the link's URL.",
+          "type": "string",
+          "format": "uri"
+        },
+        {
+          "type": "object",
+          "required": [
+            "href"
+          ],
+          "properties": {
+            "href": {
+              "description": "A string containing the link's URL.",
+              "type": "string",
+              "format": "uri"
+            },
+            "meta": {
+              "$ref": "#/definitions/meta"
+            }
+          }
+        }
+      ]
+    },
+
+    "attributes": {
+      "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.",
+      "type": "object",
+      "patternProperties": {
+        "^(?!relationships$|links$)\\w[-\\w_]*$": {
+          "description": "Attributes may contain any valid JSON value."
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "relationships": {
+      "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
+      "type": "object",
+      "patternProperties": {
+        "^\\w[-\\w_]*$": {
+          "properties": {
+            "links": {
+              "$ref": "#/definitions/links"
+            },
+            "data": {
+              "description": "Member, whose value represents \"resource linkage\".",
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/relationshipToOne"
+                },
+                {
+                  "$ref": "#/definitions/relationshipToMany"
+                }
+              ]
+            },
+            "meta": {
+              "$ref": "#/definitions/meta"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "relationshipToOne": {
+      "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/empty"
+        },
+        {
+          "$ref": "#/definitions/linkage"
+        }
+      ]
+    },
+    "relationshipToMany": {
+      "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/linkage"
+      },
+      "uniqueItems": true
+    },
+    "empty": {
+      "description": "Describes an empty to-one relationship.",
+      "type": "null"
+    },
+    "linkage": {
+      "description": "The \"type\" and \"id\" to non-empty members.",
+      "type": "object",
+      "required": [
+        "type",
+        "id"
+      ],
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    },
+    "pagination": {
+      "type": "object",
+      "properties": {
+        "first": {
+          "description": "The first page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        },
+        "last": {
+          "description": "The last page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        },
+        "prev": {
+          "description": "The previous page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        },
+        "next": {
+          "description": "The next page of data",
+          "oneOf": [
+            { "type": "string", "format": "uri" },
+            { "type": "null" }
+          ]
+        }
+      }
+    },
+
+    "jsonapi": {
+      "description": "An object describing the server's implementation",
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "string"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "error": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "A unique identifier for this particular occurrence of the problem.",
+          "type": "string"
+        },
+        "links": {
+          "$ref": "#/definitions/links"
+        },
+        "status": {
+          "description": "The HTTP status code applicable to this problem, expressed as a string value.",
+          "type": "string"
+        },
+        "code": {
+          "description": "An application-specific error code, expressed as a string value.",
+          "type": "string"
+        },
+        "title": {
+          "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.",
+          "type": "string"
+        },
+        "detail": {
+          "description": "A human-readable explanation specific to this occurrence of the problem.",
+          "type": "string"
+        },
+        "source": {
+          "type": "object",
+          "properties": {
+            "pointer": {
+              "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
+              "type": "string"
+            },
+            "parameter": {
+              "description": "A string indicating which query parameter caused the error.",
+              "type": "string"
+            }
+          }
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}