workarea-klarna 1.0.0.beta1

data/app/views/workarea/storefront/klarna/_sdk.html.haml

@@ -0,0 +1,2 @@
+- if Workarea.config.load_klarna
+  = javascript_include_tag 'https://x.klarnacdn.net/kp/lib/v1/api.js'

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

@@ -0,0 +1,2 @@
+%p
+  = "#{t('workarea.storefront.orders.klarna')}: #{number_to_currency(tender.amount)}"

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

@@ -0,0 +1,6 @@
+.data-card
+  .data-card__cell
+    %p.data-card__line
+      = t('workarea.storefront.orders.klarna')
+    %p.data-card__line
+      = number_to_currency(tender.amount)

data/bin/rails

@@ -0,0 +1,20 @@
+#!/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/klarna/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 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+require 'teaspoon-mocha'
+
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,14 @@
+Workarea::Plugin.append_partials(
+  'storefront.javascript',
+  'workarea/storefront/klarna/sdk'
+)
+
+Workarea::Plugin.append_partials(
+  'storefront.payment_method',
+  'workarea/storefront/checkouts/klarna_payments'
+)
+
+Workarea::Plugin.append_javascripts(
+  'storefront.modules',
+  'workarea/storefront/klarna/modules/klarna_widget'
+)

data/config/initializers/configuration.rb

@@ -0,0 +1,32 @@
+Workarea.configure do |config|
+  config.tender_types << 'klarna'
+
+  # If this is false, the javascript file will not be included on the
+  # storefront, and a bogus gateway will be used.
+  config.load_klarna = !Rails.env.test?
+
+  # How long a klarna session is valid for. This is defined by Klarna's API
+  # and should not be extended beyond 48 hours.
+  config.klarn_session_expiration = 48.hours
+
+  # This controls whether requests go to the live or sandbox API endpoints.
+  config.klarna_playground = !Rails.env.production?
+
+  # Continents supported by KLarna and keys used to generate paths to
+  # credentials via environment variables and/or rails credentials. Also used
+  # to get the keys for the subdomain configuration.
+  config.klarna_continent_keys = {
+    'Europe' => 'EUR',
+    'North America' => 'NA',
+    'Oceania' => 'OC',
+    'Australia' => 'AUS'
+  }
+
+  # Subdomains to use for API requests depending on the user's continent.
+  config.klarna_subdomains = {
+    'EUR' => 'api',
+    'NA' => 'api-na',
+    'OC' => 'api-oc',
+    'AUS' => 'api-oc'
+  }
+end

data/config/initializers/fields.rb

@@ -0,0 +1,43 @@
+Workarea::Configuration.define_fields do
+  fieldset 'Klarna', namespaced: false do
+    # Klarna credentials can be configured via environment variables per
+    # continent:
+    #   WORKAREA_KLARNA_EUR_USERNAME
+    #   WORKAREA_KLARNA_EUR_PASSWORD
+    #   WORKAREA_KLARNA_NA_USERNAME
+    #   WORKAREA_KLARNA_NA_PASSWORD
+    #
+    # via rails credentials:
+    #   klarna:
+    #     eur:
+    #       username: YOUR_USERNAME
+    #       password: YOUR_CLIENT_SECRET
+    #     na:
+    #       username: YOUR_USERNAME
+    #       password: YOUR_CLIENT_SECRET
+    #
+    # Or through the workarea admin configuration. Setting credentials through
+    # the configuration allows for dyanmically changing credentials if, for
+    # example, you are using the multi-site plugin and wish to use different
+    # Klarna accounts for some or all sites.
+    #
+    field 'Europe Username',
+      type: :string,
+      id: 'klarna_eur_username',
+      description: 'Your Klarna API username for Europe'
+    field 'Europe Password',
+      type: :string,
+      id: 'klarna_eur_password',
+      encrypted: true,
+      description: 'Your Klarna API password for Europe'
+    field 'North America Username',
+      type: :string,
+      id: 'klarna_na_username',
+      description: 'Your Klarna API username for North America'
+    field 'North America Password',
+      type: :string,
+      id: 'klarna_na_password',
+      encrypted: true,
+      description: 'Your Klarna API password for North America'
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,30 @@
+en:
+  workarea:
+    admin:
+      orders:
+        tenders:
+          klarna:
+            title: Klarna
+    storefront:
+      checkouts:
+        klarna_payment_received: Your Klarna payment has been approved. Click 'Place Order' to purchase.
+        klarna_payment_expired: Your Klarna payment approval has expired.
+      orders:
+        klarna: Klarna
+      widget:
+        invalid_payment: The payment selected is not valid for this order. Please select a different payment option.
+    klarna:
+      gateway:
+        request:
+          base: 'Klarna request'
+          create_session: 'Klarna session creation'
+          update_session: 'Klarna session update'
+          place_order: 'Klarna payment authorization for %{amount}'
+          capture: 'Klarna payment capture for %{amount}'
+          refund: 'Klarna payment refund for %{amount}'
+          cancel: 'Klarna order cancellation'
+          release: 'Klarna order authorization release'
+        response:
+          success: '%{summary} was successful'
+          failure: Request to Klarna was not successful. %{summary}
+          unsupported_continent: The continent "%{continent}" associated to this request is either unknown or not supported.

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/workarea/klarna.rb

@@ -0,0 +1,30 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/klarna/gateway'
+require 'workarea/klarna/gateway/request'
+require 'workarea/klarna/gateway/response'
+require 'workarea/klarna/gateway/order'
+require 'workarea/klarna/gateway/create_session_request'
+require 'workarea/klarna/gateway/update_session_request'
+require 'workarea/klarna/gateway/place_order_request'
+require 'workarea/klarna/gateway/capture_request'
+require 'workarea/klarna/gateway/refund_request'
+require 'workarea/klarna/gateway/cancel_request'
+require 'workarea/klarna/gateway/release_request'
+require 'workarea/klarna/bogus_gateway'
+
+module Workarea
+  module Klarna
+    class << self
+      def gateway
+        return Klarna::BogusGateway.new unless Workarea.config.load_klarna
+        Klarna::Gateway.new
+      end
+    end
+  end
+end
+
+require 'workarea/klarna/engine'
+require 'workarea/klarna/version'

data/lib/workarea/klarna/bogus_gateway.rb

@@ -0,0 +1,19 @@
+module Workarea
+  module Klarna
+    class BogusGateway
+      def respond_to_missing?(method_name, include_private = false)
+        Gateway.new.respond_to?(method_name)
+      end
+
+      def method_missing(method_name, *args)
+        return super unless Gateway.new.respond_to?(method_name)
+
+        OpenStruct.new(
+          success?: false,
+          message: 'This is a bogus gateway',
+          params: {}
+        )
+      end
+    end
+  end
+end

data/lib/workarea/klarna/engine.rb

@@ -0,0 +1,10 @@
+require 'workarea/klarna'
+
+module Workarea
+  module Klarna
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::Klarna
+    end
+  end
+end

data/lib/workarea/klarna/gateway.rb

@@ -0,0 +1,92 @@
+module Workarea
+  module Klarna
+    class Gateway
+      class ContinentNotSupported < StandardError; end
+
+      def create_session(order)
+        request = CreateSessionRequest.new(order)
+        send_request(request)
+      end
+
+      def update_session(order, session_id = nil)
+        request = UpdateSessionRequest.new(order, session_id)
+        send_request(request)
+      end
+
+      def authorize(tender, amount)
+        request = PlaceOrderRequest.new(tender, amount)
+        send_transaction_request(request)
+      end
+
+      def purchase(tender, amount)
+        request = PlaceOrderRequest.new(order, amount, auto_capture: true)
+        send_transaction_request(request)
+      end
+
+      def capture(tender, amount)
+        request = CaptureRequest.new(tender, amount)
+        send_transaction_request(request)
+      end
+
+      def refund(tender, amount)
+        request = RefundRequest.new(tender, amount)
+        send_transaction_request(request)
+      end
+
+      def cancel(tender)
+        request = CancelRequest.new(tender)
+        send_transaction_request(request)
+      end
+
+      def release_authorization(tender)
+        request = ReleaseRequest.new(tender)
+        send_transaction_request(request)
+      end
+
+      def send_request(request)
+        request.validate!
+
+        raw_response = Faraday.send(request.method, request.url) do |req|
+          req.headers['Authorization'] = auth_header(request)
+          req.headers['User-Agent'] = "Workarea/#{Workarea::VERSION::STRING}"
+
+          if request.body.present?
+            req.headers['Content-Type'] = 'application/json'
+            req.body = request.body.to_json
+          end
+        end
+
+        Response.new(request, raw_response)
+      rescue ContinentNotSupported
+        unsupported_continent_response(request)
+      end
+
+      def send_transaction_request(request)
+        response = send_request(request)
+
+        ActiveMerchant::Billing::Response.new(
+          response.success?,
+          response.message,
+          response.params
+        )
+      end
+
+      private
+
+      def auth_header(request)
+        "Basic #{Base64.encode64([request.username, request.password].join(':'))}"
+      end
+
+      def unsupported_continent_response(request)
+        OpenStruct.new(
+          success?: false,
+          message: I18n.t(
+            'workarea.klarna.gateway.unsupported_continent',
+            continent: request.continent
+          ),
+          params: {}
+        )
+      end
+    end
+  end
+end

data/lib/workarea/klarna/gateway/cancel_request.rb

@@ -0,0 +1,16 @@
+module Workarea
+  module Klarna
+    class Gateway
+      class CancelRequest < Request
+        def initialize(tender)
+          @tender = tender
+          @payment = tender.payment
+
+          @path = "/ordermanagement/v1/orders/#{tender.order_id}/cancel"
+          @method = 'post'
+          @summary = I18n.t('workarea.klarna.gateway.request.cancel')
+        end
+      end
+    end
+  end
+end

data/lib/workarea/klarna/gateway/capture_request.rb

@@ -0,0 +1,24 @@
+module Workarea
+  module Klarna
+    class Gateway
+      class CaptureRequest < Request
+        def initialize(tender, amount)
+          @tender = tender
+          @payment = tender.payment
+          @amount = amount
+
+          @path = "/ordermanagement/v1/orders/#{tender.order_id}/captures"
+          @method = 'post'
+          @summary = I18n.t(
+            'workarea.klarna.gateway.request.capture',
+            amount: @amount.format
+          )
+        end
+
+        def body
+          { captured_amount: @amount.cents }
+        end
+      end
+    end
+  end
+end

data/lib/workarea/klarna/gateway/create_session_request.rb

@@ -0,0 +1,22 @@
+module Workarea
+  module Klarna
+    class Gateway
+      class CreateSessionRequest < Request
+        def initialize(order)
+          super
+
+          @path = 'payments/v1/sessions'
+          @method = 'post'
+          @summary = I18n.t('workarea.klarna.gateway.request.create_session')
+        end
+
+        def body
+          Gateway::Order
+            .new(order, payment: payment)
+            .to_h
+            .except(:shipping_address, :billing_address)
+        end
+      end
+    end
+  end
+end

data/lib/workarea/klarna/gateway/order.rb

@@ -0,0 +1,249 @@
+module Workarea
+  module Klarna
+    class Gateway
+      class Order
+        attr_reader :order
+
+        def initialize(order, payment: nil, shippings: nil)
+          @order = order
+          @payment = payment
+          @shippings = shippings
+        end
+
+        def to_h
+          {
+            purchase_country: payment.address.country.alpha2,
+            purchase_currency: order.total_price.currency.iso_code,
+            locale: I18n.locale,
+            order_amount: order_amount,
+            order_tax_amount: order.tax_total.cents,
+            order_lines: order_lines,
+            billing_address: billing_address,
+            shipping_address: shipping_address,
+            merchant_urls: merchant_urls,
+            merchant_reference1: order.id,
+            attachment: extra_merchant_data
+          }
+            .compact
+            .tap { |hash| remove_inline_tax(hash) if include_tax_line? }
+        end
+
+        def payment
+          @payment ||= Workarea::Payment.find(order.id)
+        end
+
+        def shippings
+          @shippings ||= Workarea::Shipping.by_order(order.id)
+        end
+
+        def price_adjustments
+          @price_adjustments ||=
+            order.price_adjustments + shippings.flat_map(&:price_adjustments)
+        end
+
+        private
+
+        def order_amount
+          raw_total = order.total_price
+          tenders = gift_cards + [store_credit]
+
+          (raw_total - tenders.compact.sum(&:amount).to_m).cents
+        end
+
+        def order_lines
+          [
+            *order.items.map(&method(:format_item)),
+            shipping_line,
+            discount_line,
+            tax_line,
+            store_credit_line,
+            gift_card_line,
+          ].compact
+        end
+
+        def billing_address
+          format_address(payment.address)
+        end
+
+        def shipping_address
+          format_address(shippings.first.address)
+        end
+
+        def format_address(address)
+          return unless address.present?
+
+          {
+            given_name: address.first_name,
+            family_name: address.last_name,
+            email: order.email,
+            street_address: address.street,
+            street_address2: address.street_2,
+            postal_code: address.postal_code,
+            city: address.city,
+            region: address.region,
+            phone: address.phone_number,
+            country: address.country.alpha2
+          }
+        end
+
+        def format_item(item)
+          view_model = Storefront::OrderItemViewModel.new(item)
+          breadcrumbs = Navigation::Breadcrumbs.from_global_id(item.via) if item.via.present?
+          tax_amount, tax_rate = item_tax_data(item)
+
+          {
+            name: view_model.product_name,
+            type: item.shipping? ? 'physical' : 'digital',
+            reference: item.sku,
+            quantity: item.quantity,
+            unit_price: item.current_unit_price.cents,
+            total_amount: item.total_price.cents,
+            total_tax_amount: tax_amount,
+            tax_rate: tax_rate,
+            product_url: Workarea::Storefront::Engine.routes.url_helpers.product_url(
+              host: Workarea.config.host,
+              id: view_model.product.slug
+            ),
+            product_identifiers: { category_path: breadcrumbs&.join(' > ') }.compact
+          }
+        end
+
+        def item_tax_data(item)
+          tax_amount =
+            price_adjustments
+              .adjusting('tax')
+              .select { |pa| pa.data['order_item_id'].to_s == item.id.to_s }
+              .sum(&:amount)
+
+          tax_rate = (tax_amount.cents.to_f / item.total_price.cents).round(2) * 10000
+
+          [tax_amount.cents, tax_rate.to_i]
+        end
+
+        def shipping_line
+          return unless shippings.present? && shippings.all?(&:shipping_service)
+
+          shipping_total = order.shipping_total.cents
+          return if shipping_total.zero?
+
+          shipping_tax = price_adjustments
+                          .adjusting('tax')
+                          .select { |pa| !!pa.data['shipping_service_tax'] }
+                          .sum(&:amount)
+                          .cents
+
+          {
+            name: 'Shipping',
+            type: 'shipping_fee',
+            quantity: 1,
+            unit_price: shipping_total,
+            total_amount: shipping_total,
+            total_tax_amount: shipping_tax,
+            tax_rate: ((shipping_tax * 1.0 / shipping_total).round(2) * 10000).to_i
+          }
+        end
+
+        def discount_line
+          order_discount = price_adjustments.adjusting('order').discounts.sum.cents
+          return if order_discount.zero?
+
+          {
+            name: 'Order Discounts',
+            type: 'discount',
+            quantity: 1,
+            unit_price: order_discount,
+            total_amount: order_discount,
+            total_tax_amount: 0,
+            tax_rate: 0
+          }
+        end
+
+        def tax_line
+          return unless include_tax_line?
+
+          {
+            name: 'Tax',
+            type: 'sales_tax',
+            quantity: 1,
+            unit_price: order.tax_total.cents,
+            total_amount: order.tax_total.cents
+          }
+        end
+
+        def store_credit
+          payment.store_credit
+        end
+
+        def store_credit_line
+          return unless store_credit&.amount&.positive?
+
+          {
+            name: 'Store Credit',
+            type: 'store_credit',
+            quantity: 1,
+            unit_price: -1 * store_credit.amount.cents,
+            tax_rate: 0,
+            total_tax_amount: 0,
+            total_amount: -1 * store_credit.amount.cents
+          }
+        end
+
+        def gift_cards
+          if payment.respond_to?(:gift_card) &&
+            [payment.gift_card].compact
+          elsif payment.respond_to?(:gift_cards)
+            payment.gift_cards
+          else
+            []
+          end
+        end
+
+        def gift_card_line
+          amount = gift_cards.sum(&:amount)
+
+          return unless amount.to_i.positive?
+
+          {
+            name: 'Gift Card',
+            type: 'gift_card',
+            quantity: 1,
+            unit_price: -1 * amount,
+            tax_rate: 0,
+            total_tax_amount: 0,
+            total_amount: -1 * amount
+          }
+        end
+
+        def merchant_urls
+          {
+            confirmation:
+              Workarea::Storefront::Engine
+                .routes
+                .url_helpers
+                .checkout_confirmation_url(host: Workarea.config.host)
+          }
+        end
+
+        def include_tax_line?
+          payment.address.country.alpha2 == 'US'
+        end
+
+        def remove_inline_tax(hash)
+          hash[:order_lines].each do |line|
+            line.delete(:total_tax_amount)
+            line.delete(:tax_rate)
+          end
+        end
+
+        def extra_merchant_data
+          return unless order.extra_merchant_data.present?
+
+          {
+            body: order.extra_merchant_data.to_json,
+            content_type: 'application/vnd.klarna.internal.emd-v2+json'
+          }
+        end
+      end
+    end
+  end
+end