workarea-zipco 1.0.0

data/app/services/workarea/zipco/order.rb

@@ -0,0 +1,188 @@
+module Workarea
+  module Zipco
+    class Order
+      module ProductUrl
+        include Workarea::I18n::DefaultUrlOptions
+        include Storefront::Engine.routes.url_helpers
+        extend self
+      end
+
+      module ProductImageUrl
+        include Workarea::ApplicationHelper
+        include Workarea::I18n::DefaultUrlOptions
+        include ActionView::Helpers::AssetUrlHelper
+        include Core::Engine.routes.url_helpers
+        extend self
+
+        def mounted_core
+          self
+        end
+      end
+
+      attr_reader :order
+
+      # @param  ::Workarea::Order
+      def initialize(order)
+        @order = Workarea::Storefront::OrderViewModel.new(order)
+      end
+
+      def to_h
+        {
+          shopper: zipco_shopper,
+          order: zipco_order,
+          config: zipco_config
+        }
+      end
+
+      private
+        def zipco_shopper
+          {
+            first_name: order.billing_address.first_name,
+            last_name: order.billing_address.last_name,
+            phone: order.billing_address.phone_number,
+            email: order.email,
+            billing_address: {
+              line1: order.billing_address.street,
+              line2: order.billing_address.street_2,
+              city: order.billing_address.city,
+              state: order.billing_address.region,
+              postal_code: order.billing_address.postal_code,
+              country: order.billing_address.country.alpha2
+            }
+          }
+        end
+
+        def zipco_order
+          {
+            reference: order.id,
+            amount: order.order_balance.to_f,
+            currency: currency_code,
+            shipping: zip_shipping,
+            items: items
+          }
+        end
+
+        def currency_code
+          @currency_code = order.total_price.currency.iso_code
+        end
+
+        def zip_shipping
+          return unless shipping.present?
+            {
+              pickup: false, # integrate this with bopus?
+              tracking: {
+                carrier: shipping_service
+              },
+              address: {
+                line1: order.shipping_address.street,
+                city: order.shipping_address.city,
+                state: order.shipping_address.region,
+                postal_code: order.shipping_address.postal_code,
+                country: order.shipping_address.country.alpha2
+              }
+            }
+        end
+
+        def shipping
+          @shipping = Workarea::Shipping.find_by_order(order.id)
+        end
+
+        def shipping_service
+          return unless shipping.present?
+          shipping.shipping_service.name
+        end
+
+        def items
+          items_array = order.items.map do |oi|
+
+            url = ProductImageUrl.product_image_url(oi.image, :detail)
+            item_image = url.starts_with?("/") ? nil : url
+
+            {
+              name: oi.product.name,
+              amount: oi.original_unit_price.to_f,
+              quantity: oi.quantity,
+              type: "sku",
+              reference: oi.id,
+              image_uri: item_image,
+              item_uri: ProductUrl.product_url(id: oi.product.to_param, host: Workarea.config.host)
+            }
+          end
+
+          # add taxes as item.
+          items_array << {
+            name: "Tax",
+            amount: order.tax_total.to_f,
+            quantity: 1,
+            type: "tax",
+            reference: "#{order.id}-tax",
+          }
+
+          # add shipping as item
+          items_array << {
+            name: "Shipping",
+            amount: order.shipping_total.to_f,
+            quantity: 1,
+            type: "shipping",
+            reference: "#{order.id}-shipping",
+          }
+
+          if gift_wrap_item.present?
+            items_array << gift_wrap_item
+          end
+
+          items_array + discount_items + advanced_payment_discount_item
+        end
+
+        def discount_items
+          discounts = order.price_adjustments.select { |p| p.discount? }
+          return [] unless discounts.present?
+
+          discounts.map do |d|
+            {
+              name: "Discount",
+              amount: d.amount.to_f,
+              quantity: 1,
+              type: "discount"
+            }
+          end
+        end
+
+        def advanced_payment_discount_item
+          return [] if order.order_balance == order.total_price
+          balance = order.total_price - order.order_balance
+
+          [
+            {
+              name: "Other payment tenders",
+              amount: (balance * -1).to_f,
+              quantity: 1,
+              type: "discount"
+            }
+          ]
+        end
+
+        def zipco_config
+          {
+            redirect_uri: confirm_url
+          }
+        end
+
+        def confirm_url
+          Storefront::Engine.routes.url_helpers.complete_zipco_url(host: Workarea.config.host)
+        end
+
+        def gift_wrap_item
+          adjustment = order.price_adjustments.detect { |pa| pa.description == 'Gift Wrapping' }
+          return unless adjustment.present?
+
+          {
+            name: "Gift Wrapping",
+            amount: adjustment.amount.to_f,
+            quantity: 1,
+            type: "sku"
+          }
+        end
+    end
+  end
+end

data/app/services/workarea/zipco/setup.rb

@@ -0,0 +1,37 @@
+module Workarea
+  module Zipco
+    class Setup
+      attr_reader :checkout, :order
+
+      # @param  ::Workarea::Checkout
+      def initialize(checkout)
+        @checkout = checkout
+        @order = checkout.order
+       end
+
+      def create_order_response
+        @create_order_response ||= Zipco.gateway.create_order(order_details)
+      end
+
+      def set_checkout_data
+        payment = Workarea::Payment.find(order.id)
+
+        payment.clear_credit_card
+
+        payment.set_zipco(token: create_order_response.zipco_order_id)
+
+        order.update_attributes!(zipco_order_id: create_order_response.zipco_order_id)
+      end
+
+      def redirect_uri
+        create_order_response.redirect_uri
+      end
+
+      private
+
+        def order_details
+          Workarea::Zipco::Order.new(order).to_h
+        end
+    end
+  end
+end

data/app/view_models/workarea/storefront/checkout/payment_view_model.decorator

@@ -0,0 +1,17 @@
+module Workarea
+  decorate Storefront::Checkout::PaymentViewModel, with: :zipco do
+    decorated do
+      delegate :zipco?, to: :payment
+    end
+
+    def using_new_card?
+      super && !zipco?
+    end
+
+    def zipco
+      order = Workarea::Order.find(payment.id)
+      Storefront::ZipcoViewModel.new(nil, order: order)
+    end
+  end
+end
+

data/app/view_models/workarea/storefront/order_view_model.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Storefront::OrderViewModel, with: :kount do
+    def placed_at
+      if model.zipco_referred?
+        Time.current
+      else
+        model.placed_at
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/zipco_view_model.rb

@@ -0,0 +1,18 @@
+module Workarea
+  module Storefront
+    class ZipcoViewModel < ApplicationViewModel
+    def show?
+      Zipco.config.allowed_countries.include?(order.billing_address.country.alpha2)
+    end
+
+    private
+
+      def order
+        @order ||= begin
+          o = options[:order]
+          Workarea::Storefront::OrderViewModel.new(o)
+        end
+      end
+    end
+  end
+end

data/app/views/workarea/admin/orders/tenders/_zipco.html.haml

@@ -0,0 +1,4 @@
+%li
+  = image_tag('https://static.zipmoney.com.au/assets/default/footer-tile/footer-tile-new.png')
+  = t('workarea.zipco.tender_description')
+

data/app/views/workarea/storefront/checkouts/_zipco_payment.html.haml

@@ -0,0 +1,10 @@
+- content_for :head do
+  = javascript_include_tag 'https://static.zipmoney.com.au/checkout/checkout-v1.min.js'
+
+- if @step.zipco.show?
+  .checkout-payment__primary-method.checkout-payment__primary-method--zipco{ class: ('checkout-payment__primary-method--selected' if @step.zipco?) }
+    .button-property
+      = radio_button_tag 'payment', 'zipco', step.zipco?, data: { zipco_payment_method: '' }
+      = label_tag 'payment[zipco]', nil, class: 'button-property__name' do
+        = image_tag('https://static.zipmoney.com.au/assets/default/footer-tile/footer-tile-new.png', class: "zipco-icon")
+      %p.button-property__text= t('workarea.storefront.zipco.on_continue')

data/app/views/workarea/storefront/order_mailer/tenders/_zipco.html.haml

@@ -0,0 +1,4 @@
+%p{ style: "margin: 0 0 6px; font: 13px/1.5 arial; color: #{@config.text_color};" }
+  = t('workarea.zipco.tender_description')
+
+

data/app/views/workarea/storefront/order_mailer/tenders/_zipco.text.erb

@@ -0,0 +1 @@
+<%= t('workarea.zipco.tender_description') %>

data/app/views/workarea/storefront/orders/_zipco_order_message.html.haml

@@ -0,0 +1,2 @@
+- if @order.zipco_referred?
+  %p= t('workarea.storefront.orders.referred_message')

data/app/views/workarea/storefront/orders/tenders/_zipco.html.haml

@@ -0,0 +1,6 @@
+.data-card
+  .data-card__cell
+    %p.data-card__line
+      = image_tag('https://static.zipmoney.com.au/assets/default/footer-tile/footer-tile-new.png', class: "zipco-icon")
+
+

data/app/views/workarea/storefront/zipco/_zipco_tagline.html.haml

@@ -0,0 +1,4 @@
+- if Workarea::Zipco.config.marketing_assets_key.present? && Workarea::Zipco.config.show_tagline
+  %script{:src => "https://static.zipmoney.com.au/lib/js/zm-widget-js/dist/zip-widget.min.js", :type => "text/javascript"}
+  %div{ data: {env: "#{Workarea::Zipco.config.marketing_assets_env}", "zm-merchant": "#{Workarea::Zipco.config.marketing_assets_key}" }}
+  #zip-product-widg{data: {"zm-asset": "productwidget", "zm-popup-asset": "termsdialog", "zm-widget": "popup" }, style: "cursor:pointer"}

data/app/views/workarea/storefront/zipco_landing/show.html.haml

@@ -0,0 +1,4 @@
+- if Workarea::Zipco.config.marketing_assets_key.present?
+  %script{:src => "https://static.zipmoney.com.au/lib/js/zm-widget-js/dist/zip-widget.min.js", :type => "text/javascript"}
+  %div{data: {"env": "#{Workarea::Zipco.config.marketing_assets_env}", "zm-merchant": "#{Workarea::Zipco.config.marketing_assets_key}" }}
+  %div{data: {"zm-asset": "landingpage", "zm-widget": "inline"}}

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/workarea/zipco/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,24 @@
+Workarea::Plugin.append_partials(
+  'storefront.product_pricing_details',
+  'workarea/storefront/zipco/zipco_tagline'
+)
+
+Workarea::Plugin.append_partials(
+  'storefront.cart_checkout_actions',
+  'workarea/storefront/zipco/zipco_tagline'
+)
+
+Workarea::Plugin.append_partials(
+  'storefront.payment_method',
+  'workarea/storefront/checkouts/zipco_payment'
+)
+
+Workarea::Plugin.append_partials(
+  'storefront.checkout_confirmation_text',
+  'workarea/storefront/orders/zipco_order_message'
+)
+
+Workarea::Plugin.append_stylesheets(
+  "storefront.components",
+  "workarea/storefront/zipco/components/zipco_icon"
+)

data/config/initializers/workarea.rb

@@ -0,0 +1,15 @@
+Workarea.configure do |config|
+  config.order_status_calculators.insert(0, 'Workarea::Order::Status::ZipReferred')
+  config.tender_types.append(:zipco)
+
+  config.zipco = ActiveSupport::Configurable::Configuration.new
+  config.zipco.api_version = "2017-03-01"
+  config.zipco.api_timeout = 15
+  config.zipco.open_timeout = 15
+
+  config.zipco.marketing_assets_key = nil
+  config.zipco.marketing_assets_env = Rails.env.production? ? "production" : "sandbox"
+
+  config.zipco.show_tagline = true # toggles tagline on PDP and cart display
+  config.zipco.allowed_countries = ["AU", "NZ"]
+end

data/config/locales/en.yml

@@ -0,0 +1,38 @@
+---
+en:
+  workarea:
+    admin:
+      orders:
+        tenders:
+          zip:
+            title: Zip Payments
+    storefront:
+      orders:
+        referred_message: Your order is pending approval of your zipMoney application. You will receive an email with instructions shortly on whether your application has been approved or not. If approved you will be able to complete your purchase by following a link in the email.
+        tenders:
+          zipco: Zip Payments
+      carts:
+        zip: Zip Payments
+      checkouts:
+        zip: Zip Payments
+      zipco:
+        cancelled_message: Your Zip payment has been cancelled. Please select another payment method.
+        declined_message: Your Zip payment has been declined.
+        check_out: Check Out with Zip
+        checkout_submit_text: Continue to Zip
+        on_continue: When you click Place Order you will be directed to ZIP to complete payment. When using ZIP all promo codes must be applied before moving to the next step.
+        payment_error: There was a problem processing your Zip payment, you have not been charged. Please try again or select
+          another payment method.
+        zip: Zip
+        learn_more: Learn More
+    zipco:
+      authorize: "%{amount} has been authorized"
+      capture: "%{amount} has been captured"
+      purchase: "%{amount} has been purchased"
+      refund: "%{amount} has been refunded"
+      refund: "Zip Payment Transaction has been refunded"
+      authorize_failure: "Zip authorize has failed"
+      capture_failure: "Zip capture has failed"
+      purchase_failure: "Zip purchase has failed"
+      refund_failure: "Zip refund has failed"
+      tender_description: "Zip Payment"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Workarea::Storefront::Engine.routes.draw do
+  get 'zipco/start/' => 'zipco#start', as: :start_zipco
+  get 'zipco/complete/' => 'zipco#complete', as: :complete_zipco
+  get 'zipco_landing' => 'zipco_landing#show', as: :zipco_landing
+end

data/lib/workarea/zipco.rb

@@ -0,0 +1,48 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/zipco/engine'
+require 'workarea/zipco/version'
+
+require 'workarea/zipco/bogus_gateway'
+require 'workarea/zipco/gateway'
+require 'workarea/zipco/response'
+
+
+require "faraday"
+
+module Workarea
+  module Zipco
+    RETRY_ERROR_STATUSES = 500..599
+
+    def self.credentials
+      (Rails.application.secrets.zipco || {}).deep_symbolize_keys
+    end
+
+    def self.config
+      Workarea.config.zipco
+    end
+
+    def self.secret_key
+      return unless credentials.present?
+      credentials[:secret_key]
+    end
+
+    def self.test?
+      config[:test]
+    end
+
+    # Conditionally use the real gateway when secrets are present.
+    # Otherwise, use the bogus gateway.
+    #
+    # @return [Zipco::Gateway]
+    def self.gateway(options = {})
+      if credentials.present?
+        Zipco::Gateway.new(secret_key: secret_key, api_version: config.api_version)
+      else
+        Zipco::BogusGateway.new
+      end
+    end
+  end
+end