workarea-klarna 1.0.0 → 1.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b329672c7677a15dd2c837beac7585af2d605687b4b08d330e334227d687006
-  data.tar.gz: 5bf7f652fbe885802606eb15307c4660eb78c50012e1e05032e1ad7c0e856373
+  metadata.gz: e17b49cdfa065638bbb4f8888d123947759b86a69943fe5f44de06a53bea9b4a
+  data.tar.gz: 8ebf705cd2f857c1e60327bbef2db98fe1370a5805c68174cea2d7454757df5d
 SHA512:
-  metadata.gz: 0271d39ec81381a10988b829b408f3fb9bf870c0654262b843329d0262365c4f3dc0f3133b57ceffaedfb1a8ab2fd907acc7869d533ca78527a7d9a518e9fbda
-  data.tar.gz: f77a15b2f8f09f748f04d2bd32259c4721af1382060b682a2266e73b280578c22308e1223d26baf98bfe9028942eca19654211dbce11fefc318bc189093510c7
+  metadata.gz: 68a20b6f8e5c7b950ce72512f82eaff39d06eed6762905f3c7bb5fe0b16bfe5156062d27bf22b16c78eb9cd0d2075a0145b5d807d956ea00cabb5ecc01d11d78
+  data.tar.gz: eeaa6d9753cba65d3d96dcaccfab52d17b4402b00e2a0270f9b67cf8510ea2217f234ca757562c01ca247e8c7fb69dd160877114c29c0f584743234918db4996

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+Workarea Klarna 1.1.0.beta1 (2020-12-08)
+--------------------------------------------------------------------------------
+
+*   bump version for beta release
+
+
+    Matt Duffy
+
+*   add pushing to weblinc gem server
+
+
+    Matt Duffy
+
+*   Add On-Site Messaging support
+
+
+    Matt Duffy
+
+
+
 Workarea Klarna 1.0.0 (2020-10-14)
 --------------------------------------------------------------------------------
 

data/README.md

@@ -8,6 +8,7 @@ Overview
 * Adds Klarna tender type.
 * Dynamically provides payment options in checkout based on customer's eligible payment options determined by geographic location.
 * Supports authorizations, captures, cancellations, and refunds.
+* Enables On-Site Messaging through admin configuration.
 
 Getting Started
 --------------------------------------------------------------------------------
@@ -68,6 +69,22 @@ You must provide credentials for each region you would like to support. The plug
 
 You can get more specific information from the [Klarna Developer](https://developers.klarna.com/) portal.
 
+## On-Site Messaging
+
+Klarna allows you to strategically place information about Klarna payments on your website through On-Site Messaging. The workarea-klarna plugin simplifies the installation process by including the required script tag and some common placements when an admin user configures on-site messaging in the admin.
+
+### Enabling
+
+Workarea provides two configuration fields in the admin under the "Klarna" section to allow the use of messaging. The first field is the on-site messaging client ID. To obtain an ID, [go through the activation process](https://developers.klarna.com/documentation/on-site-messaging/integration/platform-activation/) on your Klarna merchant portal. This will provide a code sample of the script tag that Workarea will automatically generate. Copy the client ID from that code sample and set it within the Workarea configuration page, select the region that corresponds to the region of your merchant portal (North America, Europe, or Oceania), and you're done!
+
+### Automated Placements
+
+Once you provide the client ID, Workarea will automatically enable two placements on your site. The first is the "info-page" placement, which is used to generate the page at **yoursite.com/klarna** and a link to that page will be added to the footer navigation. The second placement is on product detail pages, where a message will display under the add to cart button advertising Klarna as a payment option. The price within this message will update if/when the price of the product changes as a user selects product options.
+
+### Custom Placements
+
+To add more placements to your site, you can utilize the various system and content pages by adding a HTML content block and copying the placement code from your [Klarna merchant portal placements page](https://developers.klarna.com/documentation/on-site-messaging/integration/installation/#adding-placements).
+
 Workarea Platform Documentation
 --------------------------------------------------------------------------------
 

data/Rakefile

@@ -32,6 +32,8 @@ require 'workarea/klarna/version'
 
 desc "Release version #{Workarea::Klarna::VERSION} of the gem"
 task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
   Rake::Task['workarea:changelog'].execute
   system 'git add CHANGELOG.md'
   system 'git commit -m "Update CHANGELOG"'
@@ -41,6 +43,7 @@ task :release do
 
   system "gem build workarea-klarna.gemspec"
   system "gem push workarea-klarna-#{Workarea::Klarna::VERSION}.gem"
+  system "gem push workarea-klarna-#{Workarea::Klarna::VERSION}.gem --host #{host}"
   system "rm workarea-klarna-#{Workarea::Klarna::VERSION}.gem"
 end
 

data/app/assets/javascripts/workarea/storefront/klarna/modules/klarna_placement_refresh.js

@@ -0,0 +1,22 @@
+/**
+ * @namespace WORKAREA.klarnaPlacementRefresh
+ */
+WORKAREA.registerModule('klarnaPlacementRefresh', (function () {
+    'use strict';
+
+    /**
+     * @method
+     * @name init
+     * @memberof WORKAREA.klarnaPlacementRefresh
+     */
+    var init = function () {
+            var $placements = $('[data-klarna-placement-refresh]');
+
+            if (_.isEmpty($placements)) { return; }
+
+            window.KlarnaOnsiteService = window.KlarnaOnsiteService || [];
+            window.KlarnaOnsiteService.push({ eventName: 'refresh-placements' });
+        };
+
+    return { init: init };
+}()));

data/app/controllers/workarea/storefront/pages_controller.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Storefront::PagesController, with: :klarna do
+    def klarna
+      head :not_found unless Klarna.on_site_messaging?
+    end
+  end
+end

data/app/helpers/workarea/storefront/klarna_helper.rb

@@ -0,0 +1,28 @@
+module Workarea
+  module Storefront
+    module KlarnaHelper
+      def klarna_on_site_messaging_javacript_tag
+        return unless Workarea::Klarna.on_site_messaging?
+
+        javascript_include_tag(
+          klarna_on_site_messaging_url,
+          async: true,
+          data: {
+            client_id:  Workarea::Klarna.on_site_messaging_client_id,
+            klarna_on_site_messaging: ''
+          }
+        )
+      end
+
+      def klarna_on_site_messaging_url
+        region = Workarea.config.klarna_on_site_messaging_region
+        subdomains = [
+          Workarea.config.klarna_on_site_messaging_subdomains[region],
+          ('playground' if Workarea.config.klarna_playground)
+        ]
+
+        "https://#{subdomains.compact.join('.')}.klarnaservices.com/lib.js"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+- if Workarea::Klarna.on_site_messaging?
+  %li.page-footer__help-item= link_to t('workarea.storefront.orders.klarna'), klarna_path, class: 'page-footer__help-link'

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

@@ -0,0 +1 @@
+= klarna_on_site_messaging_javacript_tag

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

@@ -0,0 +1,3 @@
+<!-- Placement v2 -->
+%klarna-placement{ data: { key: 'info-page', locale: 'en-US' } }
+<!-- end Placement -->

data/app/views/workarea/storefront/products/_klarna_placement.html.haml

@@ -0,0 +1,3 @@
+<!-- Placement v2 -->
+%klarna-placement{ data: { key: 'credit-promotion-auto-size', locale: 'en-US', purchase_amount: (product.sell_min_price&.cents || 0), klarna_placement_refresh: request.xhr? } }
+<!-- end Placement -->

data/config/initializers/appends.rb

@@ -3,12 +3,28 @@ Workarea::Plugin.append_partials(
   'workarea/storefront/klarna/sdk'
 )
 
+Workarea::Plugin.append_partials(
+  'storefront.body_top',
+  'workarea/storefront/klarna/on_site_messaging'
+)
+
 Workarea::Plugin.append_partials(
   'storefront.payment_method',
   'workarea/storefront/checkouts/klarna_payments'
 )
 
+Workarea::Plugin.append_partials(
+  'storefront.product_details',
+  'workarea/storefront/products/klarna_placement'
+)
+
+Workarea::Plugin.append_partials(
+  'storefront.footer_help',
+  'workarea/storefront/klarna/footer_link'
+)
+
 Workarea::Plugin.append_javascripts(
   'storefront.modules',
-  'workarea/storefront/klarna/modules/klarna_widget'
+  'workarea/storefront/klarna/modules/klarna_widget',
+  'workarea/storefront/klarna/modules/klarna_placement_refresh'
 )

data/config/initializers/configuration.rb

@@ -12,7 +12,7 @@ Workarea.configure do |config|
   # 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
+  # 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 = {
@@ -29,4 +29,12 @@ Workarea.configure do |config|
     'OC' => 'api-oc',
     'AUS' => 'api-oc'
   }
+
+  # Subdomains to use for On-Site Messaging
+  config.klarna_on_site_messaging_subdomains = {
+    'EUR' => 'eu-library',
+    'NA' => 'na-library',
+    'OC' => 'oc-library',
+    'AUS' => 'oc-library'
+  }
 end

data/config/initializers/fields.rb

@@ -24,20 +24,42 @@ Workarea::Configuration.define_fields do
     field 'Europe Username',
       type: :string,
       id: 'klarna_eur_username',
-      description: 'Your Klarna API username for Europe'
+      description: 'Your Klarna API username for Europe',
+      allow_blank: true
     field 'Europe Password',
       type: :string,
       id: 'klarna_eur_password',
       encrypted: true,
-      description: 'Your Klarna API password for Europe'
+      description: 'Your Klarna API password for Europe',
+      allow_blank: true
     field 'North America Username',
       type: :string,
       id: 'klarna_na_username',
-      description: 'Your Klarna API username for North America'
+      description: 'Your Klarna API username for North America',
+      allow_blank: true
     field 'North America Password',
       type: :string,
       id: 'klarna_na_password',
       encrypted: true,
-      description: 'Your Klarna API password for North America'
+      description: 'Your Klarna API password for North America',
+      allow_blank: true
+
+    field 'On-Site Messaging Client ID',
+      type: :string,
+      id: 'klarna_on_site_messaging_client_id',
+      allow_blank: true,
+      description: %{
+        The client ID provided by Klarna when enabling On-Site Messaging in the
+        Klarna merchant portal. See
+        <a href="https://developers.klarna.com/documentation/on-site-messaging/integration/platform-activation/">the Klarna documentation</a>
+        for more information.
+      }.squish.html_safe
+
+    field 'On-Site Messaging Region',
+      type: :string,
+      id: 'klarna_on_site_messaging_region',
+      default: -> { Workarea.config.klarna_continent_keys.values.first },
+      values: -> { Workarea.config.klarna_continent_keys.to_a },
+      description: 'Region to use for contacting klarna for on-site messaging'
   end
 end

data/config/routes.rb

@@ -1,2 +1,5 @@
-Rails.application.routes.draw do
+Workarea::Storefront::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    get 'klarna', to: 'pages#klarna'
+  end
 end

data/lib/workarea/klarna.rb

@@ -22,6 +22,16 @@ module Workarea
         return Klarna::BogusGateway.new unless Workarea.config.load_klarna
         Klarna::Gateway.new
       end
+
+      def on_site_messaging_client_id
+        ENV["WORKAREA_KLARNA_ON_SITE_MESSAGING_CLIENT_ID"].presence ||
+          Rails.application.credentials.klarna.try(:[], :on_site_messaging_client_id) ||
+          Workarea.config.klarna_on_site_messaging_client_id
+      end
+
+      def on_site_messaging?
+        on_site_messaging_client_id.present?
+      end
     end
   end
 end

data/lib/workarea/klarna/engine.rb

@@ -5,6 +5,10 @@ module Workarea
     class Engine < ::Rails::Engine
       include Workarea::Plugin
       isolate_namespace Workarea::Klarna
+
+      config.to_prepare do
+        Storefront::ApplicationController.helper(Storefront::KlarnaHelper)
+      end
     end
   end
 end

data/lib/workarea/klarna/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Klarna
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0.beta1".freeze
   end
 end

data/test/helpers/workarea/storefront/klarna_helper_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class KlarnaHelperTest < ViewTest
+      def test_klarna_on_site_messaging_javacript_tag
+        Workarea.config.klarna_on_site_messaging_client_id = nil
+        assert_nil(klarna_on_site_messaging_javacript_tag)
+
+        Workarea.config.klarna_on_site_messaging_client_id = '123'
+        Workarea.config.klarna_on_site_messaging_region = 'NA'
+        Workarea.config.klarna_playground = true
+
+        result = klarna_on_site_messaging_javacript_tag
+        assert_includes(result, %(src="https://na-library.playground.klarnaservices.com/lib.js"))
+        assert_includes(result, %(async))
+        assert_includes(result, %(data-client-id="123"))
+        assert_includes(result, %(data-klarna-on-site-messaging))
+      end
+
+
+      def test_klarna_on_site_messaging_url
+        Workarea.config.klarna_on_site_messaging_region = 'NA'
+        Workarea.config.klarna_playground = true
+
+        assert_equal(
+          'https://na-library.playground.klarnaservices.com/lib.js',
+          klarna_on_site_messaging_url
+        )
+
+        Workarea.config.klarna_playground = false
+        assert_equal(
+          'https://na-library.klarnaservices.com/lib.js',
+          klarna_on_site_messaging_url
+        )
+
+        Workarea.config.klarna_on_site_messaging_region = 'EUR'
+        assert_equal(
+          'https://eu-library.klarnaservices.com/lib.js',
+          klarna_on_site_messaging_url
+        )
+      end
+    end
+  end
+end

data/test/integration/workarea/storefront/klarna_info_page_integration_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class KlarnaInfoPageIntegrationTest < Workarea::IntegrationTest
+      def test_klarna_info_page
+        Workarea.config.klarna_on_site_messaging_client_id = nil
+
+        get storefront.klarna_path
+        assert_response(:missing)
+
+        Workarea.config.klarna_on_site_messaging_client_id = '123-456'
+
+        get storefront.klarna_path
+        assert_response(:success)
+      end
+    end
+  end
+end

data/test/lib/workarea/klarna_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module Workarea
+  class KlarnaTest < TestCase
+    def test_on_site_messaging_client_id
+      @_kosm_env = ENV['WORKAREA_KLARNA_ON_SITE_MESSAGING_CLIENT_ID']
+      @_kosm_cred = Rails.application.credentials.klarna
+
+      ENV['WORKAREA_KLARNA_ON_SITE_MESSAGING_CLIENT_ID'] = nil
+      Rails.application.credentials.klarna = nil
+      Workarea.config.klarna_on_site_messaging_client_id = nil
+
+      assert_nil(Klarna.on_site_messaging_client_id)
+      refute(Klarna.on_site_messaging?)
+
+      Workarea.config.klarna_on_site_messaging_client_id = 'config_123'
+      assert_equal('config_123', Klarna.on_site_messaging_client_id)
+      assert(Klarna.on_site_messaging?)
+
+      Rails.application.credentials.klarna = { on_site_messaging_client_id: 'cred_123' }
+      assert_equal('cred_123', Klarna.on_site_messaging_client_id)
+      assert(Klarna.on_site_messaging?)
+
+      ENV['WORKAREA_KLARNA_ON_SITE_MESSAGING_CLIENT_ID'] = 'env_123'
+      assert_equal('env_123', Klarna.on_site_messaging_client_id)
+      assert(Klarna.on_site_messaging?)
+    ensure
+      ENV['WORKAREA_KLARNA_ON_SITE_MESSAGING_CLIENT_ID'] = @_kosm_env
+      Rails.application.credentials.klarna = @_kosm_cred
+    end
+  end
+end

data/workarea-klarna.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version     = Workarea::Klarna::VERSION
   spec.authors     = ["Matt Duffy"]
   spec.email       = ["mduffy@workarea.com"]
-  spec.homepage    = "https://www.workarea.com"
+  spec.homepage    = "https://github.com/workarea-commerce/workarea-klarna"
   spec.summary     = "Klarna API integration for the Workarea Commerce Platform."
   spec.description = "Klarna Payments and Order Management API integration with Workarea Commerce."
   spec.license     = "Business Software License"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-klarna
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.beta1
 platform: ruby
 authors:
 - Matt Duffy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -43,10 +43,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/workarea/storefront/klarna/modules/klarna_placement_refresh.js
 - app/assets/javascripts/workarea/storefront/klarna/modules/klarna_widget.js
 - app/controllers/workarea/storefront/checkout/addresses_controller.decorator
 - app/controllers/workarea/storefront/checkout/place_order_controller.decorator
 - app/controllers/workarea/storefront/checkouts_controller.decorator
+- app/controllers/workarea/storefront/pages_controller.decorator
+- app/helpers/workarea/storefront/klarna_helper.rb
 - app/models/workarea/checkout/steps/payment.decorator
 - app/models/workarea/order.decorator
 - app/models/workarea/payment.decorator
@@ -60,9 +63,13 @@ files:
 - app/view_models/workarea/storefront/checkout/payment_view_model.decorator
 - app/views/workarea/admin/orders/tenders/_klarna.html.haml
 - app/views/workarea/storefront/checkouts/_klarna_payments.html.haml
+- app/views/workarea/storefront/klarna/_footer_link.html.haml
+- app/views/workarea/storefront/klarna/_on_site_messaging.html.haml
 - app/views/workarea/storefront/klarna/_sdk.html.haml
 - app/views/workarea/storefront/order_mailer/tenders/_klarna.html.haml
 - app/views/workarea/storefront/orders/tenders/_klarna.html.haml
+- app/views/workarea/storefront/pages/klarna.html.haml
+- app/views/workarea/storefront/products/_klarna_placement.html.haml
 - bin/rails
 - config/initializers/appends.rb
 - config/initializers/configuration.rb
@@ -127,6 +134,8 @@ files:
 - test/dummy/db/seeds.rb
 - test/dummy/log/.keep
 - test/factories/workarea/klarna.rb
+- test/helpers/workarea/storefront/klarna_helper_test.rb
+- test/integration/workarea/storefront/klarna_info_page_integration_test.rb
 - test/integration/workarea/storefront/klarna_session_integration_test.rb
 - test/lib/workarea/klarna/gateway/capture_request_test.rb
 - test/lib/workarea/klarna/gateway/create_session_request_test.rb
@@ -137,6 +146,7 @@ files:
 - test/lib/workarea/klarna/gateway/response_test.rb
 - test/lib/workarea/klarna/gateway/update_session_request_test.rb
 - test/lib/workarea/klarna/gateway_test.rb
+- test/lib/workarea/klarna_test.rb
 - test/models/workarea/checkout/steps/klarna_payment_test.rb
 - test/models/workarea/klarna_payment_test.rb
 - test/models/workarea/payment/authorize/klarna_test.rb
@@ -151,7 +161,7 @@ files:
 - test/vcr_cassettes/klarna_refund.yml
 - test/view_models/workarea/storefront/checkout/klarna_payment_view_model_test.rb
 - workarea-klarna.gemspec
-homepage: https://www.workarea.com
+homepage: https://github.com/workarea-commerce/workarea-klarna
 licenses:
 - Business Software License
 metadata: {}
@@ -166,9 +176,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: