flex_commerce_api 0.6.57

data/lib/paypal_express/cart_shipping_method.rb

@@ -0,0 +1,38 @@
+require 'bigdecimal'
+
+# @module FlexCommerce::PaypalExpress
+module FlexCommerce
+  module PaypalExpress
+    # @class CartShippingMethod
+    # 
+    # Used to decorate shipping methods based on Promotions
+    class CartShippingMethod < SimpleDelegator
+
+      ZERO = BigDecimal.new(0)
+
+      def initialize(shipping_method, free)
+        super(shipping_method)
+        self.free = free
+      end
+
+      def is_free?
+        free
+      end
+
+      def total
+        return ZERO if is_free?
+        super
+      end
+
+      def tax
+        return ZERO if is_free?
+        super
+      end
+
+      private
+
+      attr_accessor :free
+
+    end
+  end
+end

data/lib/paypal_express/exception/access_denied.rb

@@ -0,0 +1,10 @@
+require_relative 'transaction'
+
+module FlexCommerce
+  module PaypalExpress
+    module Exception
+      class AccessDenied < Transaction
+      end
+    end
+  end
+end

data/lib/paypal_express/exception/connection_error.rb

@@ -0,0 +1,10 @@
+require_relative 'transaction'
+
+module FlexCommerce
+  module PaypalExpress
+    module Exception
+      class ConnectionError < Transaction
+      end
+    end
+  end
+end

data/lib/paypal_express/exception/not_authorized.rb

@@ -0,0 +1,10 @@
+require_relative 'transaction'
+
+module FlexCommerce
+  module PaypalExpress
+    module Exception
+      class NotAuthorized < Transaction
+      end
+    end
+  end
+end

data/lib/paypal_express/exception/transaction.rb

@@ -0,0 +1,15 @@
+module FlexCommerce
+  module PaypalExpress
+    module Exception
+      class Transaction < ::StandardError
+        attr_accessor :transaction_id, :gateway_transaction_id, :response
+        def initialize(message, options = {})
+          options.each_pair do |attr, value|
+            try("#{attr}=".to_sym, value)
+          end
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/paypal_express/generate_summary.rb

@@ -0,0 +1,118 @@
+require_relative 'api'
+
+# @module FlexCommerce::PaypalExpress
+module FlexCommerce
+  module PaypalExpress
+    # @class GenerateSummary
+    # 
+    # This class is used while setting up the paypal for FE
+    # It deals with line items total, sub total, tax calculations and
+    # Also deals with discounted line items and discounts inorder to send to paypal
+    # 
+    class GenerateSummary
+      include ::FlexCommerce::PaypalExpress::Api
+      
+      def initialize(cart: , use_tax: false)
+        self.cart = cart
+        self.use_tax = use_tax
+        raise "use_tax is not yet supported.  FlexCommerce::PaypalExpress::GenerateSummary should support it in the future" if use_tax
+      end
+
+      # @method call
+      # 
+      # @returns an object with subtotal, tax, handling, shipping and items keys
+      def call
+        {
+            subtotal: subtotal,
+            tax: tax,
+            handling: handling,
+            shipping: shipping,
+            items: items
+        }
+      end
+
+      private
+
+      # @method subtotal
+      # 
+      # @returns the sum of line items total. This doesnt include any promotions
+      def subtotal
+        items.sum {|i| i[:quantity] * (i[:amount])}
+      end
+
+      # @method total
+      # 
+      # @return amount after converting cart total from pence to pounds
+      def total
+        convert_amount(cart.total)
+      end
+
+      # @method tax
+      # 
+      # @returns the sum of total line items tax
+      def tax
+        items.sum {|i| i[:tax] * i[:quantity]}
+      end
+
+      # @method handling
+      # 
+      # @returns Payment handling charges, which is 0
+      def handling
+        0
+      end
+
+      # @method shipping
+      # 
+      # @returns 0 if cart is eligible for free shipping
+      # @returns cart.shipping_total, if cart is not eligibl for free shipping
+      def shipping
+        return 0 if cart.free_shipping
+        convert_amount(cart.shipping_total)
+      end
+
+      # @mthod items
+      # 
+      # @returns both line items and discounts
+      def items
+        normal_items + discount_items
+      end
+
+      # @method discounts
+      # 
+      # @returns [] if there are no discounts on cart
+      # @returns Array containing about the total discount amount, if any applied.
+      def discount_items
+        return [] if cart.total_discount == 0
+        [
+            {
+                name: "Total discounts",
+                number: "NA",
+                quantity: 1,
+                amount: convert_amount(BigDecimal(0) - cart.total_discount),
+                description: "Total discounts",
+                tax: 0
+            }
+        ]
+      end
+
+      # @method normal_items
+      # 
+      # @returns Object, the normal line items added to cart
+      # @note these line items unit prices will be without any discounts
+      def normal_items
+        @normal_items ||= cart.line_items.map do |li|
+          {
+              name: li.title,
+              number: li.item.sku,
+              quantity: li.unit_quantity,
+              amount: convert_amount(li.unit_price),
+              description: li.title,
+              tax: 0
+          }
+        end
+      end
+
+      attr_accessor :cart, :use_tax
+    end
+  end
+end

data/lib/paypal_express/process/paypal_params.rb

@@ -0,0 +1,123 @@
+require 'paypal_express/api'
+
+# @module FlexCommerce::PaypalExpress::Process
+module FlexCommerce
+  module PaypalExpress
+    module Process
+      # @class PaypalParams
+      class PaypalParams
+        include ::FlexCommerce::PaypalExpress::Api
+
+        DEFAULT_DESCRIPTION = "Shift Commerce Order".freeze
+        
+        # @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]
+        # 
+        def initialize(cart:,success_url:, cancel_url:, ip_address:, allow_shipping_change: true, callback_url:, shipping_method_model: FlexCommerce::ShippingMethod, use_mobile_payments: false, description:)
+          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
+          base_paypal_params
+            .merge(paypal_shipping_address_params)
+            .merge(paypal_items)
+            .merge(ui_callback_params)
+            .merge(shipping_options_params)
+        end
+
+        attr_accessor :description, :cart, :success_url, :cancel_url, :ip_address, :allow_shipping_change, :callback_url, :shipping_method_model, :use_mobile_payments
+
+        private
+
+        def paypal_shipping_address_params
+          return {} unless cart.shipping_address
+          shipping_address = cart.shipping_address
+          {
+            address_override: true,
+            shipping_address: {
+              name: "#{shipping_address.first_name} #{shipping_address.middle_names} #{shipping_address.last_name}",
+              address1: shipping_address.address_line_1,
+              address2: "#{shipping_address.address_line_2} #{shipping_address.address_line_3}",
+              city: shipping_address.city,
+              state: shipping_address.state,
+              country: shipping_address.country,
+              zip: shipping_address.postcode
+
+            }
+          }
+        end
+
+        def base_paypal_params
+          {
+            currency: "GBP",
+            description: description || DEFAULT_DESCRIPTION,
+            ip: ip_address,
+            return_url: success_url,
+            cancel_return_url: cancel_url,
+            subtotal: summary[:subtotal], # As the cart total wont include any shipping if it has no shipping method
+            handling: summary[:handling],
+            tax: 0,
+            shipping: summary[:shipping]
+          }
+        end
+
+        def paypal_items
+          items = summary[:items]
+          {items: items}
+        end
+
+        def ui_callback_params
+          return {} unless allow_shipping_change && shipping_methods.count > 0
+          { 
+            callback_url: callback_url,
+            callback_timeout: 6,
+            callback_version: 95,
+            max_amount: convert_amount((cart.total * 1.2) + shipping_methods.last.total + shipping_methods.last.tax) 
+          }
+        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 shipping_method
+          cart.shipping_method || shipping_methods.first
+        end
+
+        def shipping_options_params
+          return { shipping_options: [] } if !allow_shipping_change || shipping_method.nil?
+          shipping_method_id = shipping_method.id
+          {
+              shipping_options: shipping_methods.map {|sm| {name: sm.label, amount: convert_amount(sm.total), default: sm.id == shipping_method_id, label: "#{sm.description}#{sm.id}"}}
+          }
+        end
+
+        def summary
+          @summary ||= GenerateSummary.new(cart: cart).call
+        end
+      end
+    end
+  end
+end

data/lib/paypal_express/process/response_parser.rb

@@ -0,0 +1,146 @@
+# @module FlexCommerce::PaypalExpress::Process
+module FlexCommerce
+  module PaypalExpress
+    module Process
+      # @class ResponseParser
+      class ResponseParser
+
+        def initialize(response:, shipping_method_model:)
+          self.response = response
+          self.shipping_method_model = shipping_method_model
+        end
+
+        # @TODO: Need to validate the paypal response, to ensure it is
+        #        returning all the attribute values as expected
+        # Related ticket: https://github.com/shiftcommerce/flex-ruby-gem/issues/152
+        # 
+        def call
+          {
+            shipping_method_id: get_shipping_method_details,
+            email: get_email_address,
+            shipping_address_attributes: get_shipping_address_attributes,
+            billing_address_attributes: get_billing_address_attributes
+          }
+        end
+
+        attr_accessor :response, :shipping_method_model
+
+        private
+
+        # @method get_shipping_method_details
+        # 
+        # Currently, Paypal will only return the shipping_option_name param
+        # which contains the shipping method label. Using this, we need to find
+        # the shipping method id and return it.
+        # @TODO: Incase of its missing, currently we are returning nil value. But ideally 
+        # we have to log this error, just to ensure it is not platform issue.
+        #  
+        def get_shipping_method_details
+          if response.params["shipping_option_name"]
+            shipping_option_name = response.params["shipping_option_name"]
+            shipping_method = find_shipping_method(shipping_option_name)
+            raise "Shipping method #{response.params["shipping_option_name"]} not found\n\nExact response from paypal were: \n#{response.to_json}" unless shipping_method
+            shipping_method.id
+          else
+            nil
+          end
+        end
+
+        # @!visibility private
+        # 
+        # Currently Paypal is returning only shipping method label.
+        # And we cannot query for shipping method by using the label, so 
+        # We are fetching all the shipping methods and filtering them by label
+        # 
+        def find_shipping_method(shipping_option_name)
+          all_shipping_methods = shipping_method_model.all
+          sm = all_shipping_methods.select { |sm| sm.label == shipping_option_name }.first
+          sm ||= all_shipping_methods.select{ |sm| sm.label == de_dup_shipping_option_name(shipping_option_name) }.first
+          sm
+        end
+
+        # @!visibility private
+        # 
+        # COPIED this comments from flex-platform code
+        # 
+        # This is temporary but will do no harm if left in
+        # When paypal calls the "callback url" to get the list of shipping options
+        # then, the user clicks on "buy" - the resulting shipping method name is duplicated
+        # so, if you had "Shipping method 1" - you would get "Shipping method 1 Shipping method 1"
+        # This method looks for that duplication and removes it
+        # @TODO Debug system thoroughly to find the root cause of this
+        def de_dup_shipping_option_name(str)
+          parts = str.split(" ")
+          if parts.length.even?
+            mid = parts.length / 2
+            lft = parts[0...mid]
+            right = parts[mid..-1]
+            if lft == right
+              lft.join(" ")
+            else
+              str
+            end
+          else
+            str
+          end
+        end
+
+        # @method get_shipping_address_attributes
+        # 
+        # Paypal will return shipping address in PaymentDetails.ShipToAddress Object
+        # 
+        def get_shipping_address_attributes
+          convert_address(response.params["PaymentDetails"]["ShipToAddress"])
+        end
+
+        # @method get_billing_address_attributes
+        # 
+        # Paypal will return shipping address in PayerInfo.Address Object
+        # 
+        def get_billing_address_attributes
+          convert_address(response.params["PayerInfo"]["Address"])
+        end
+
+        # @method get_billing_address_attributes
+        # 
+        # Paypal will return shipping address in PayerInfo.Payer Object
+        # 
+        def get_email_address
+          response.params["PayerInfo"]["Payer"]
+        end
+
+        # @!visibility private
+        # 
+        def convert_address(paypal_address)
+          mapping = address_direct_mapping
+          name_words = paypal_address["Name"].split(" ")
+          attrs = {
+              "first_name" => name_words.shift,
+              "last_name" => name_words.pop || "",
+              "middle_names" => name_words.join(" ")
+          }
+          paypal_address.inject(attrs) do |acc, (field, value)|
+            if mapping.key?(field)
+              acc.merge(mapping[field] => value || "")
+            else
+              acc
+            end
+          end
+        end
+
+        # @!visibility private
+        # 
+        def address_direct_mapping
+          {
+            "Street1" => "address_line_1",
+            "Street2" => "address_line_2",
+            "CityName" => "city",
+            "StateOrProvince" => "state",
+            "Country" => "country",
+            "PostalCode" => "postcode"
+          }
+        end
+      end
+    end
+  end
+end