workarea-flow_io 1.2.1

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+git_source :github do |repo|
+  if ENV['GITHUB_TOKEN']
+    "https://x-access-token:#{ENV['GITHUB_TOKEN']}@github.com/#{repo}.git"
+  else
+    "https://github.com/#{repo}.git"
+  end
+end
+
+gemspec
+
+gem 'byebug'
+gem 'simplecov', require: false
+gem 'sprockets', '~> 3'
+
+source 'https://gems.weblinc.com' do
+  gem 'workarea-oms', '~> 5.1.1'
+end

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties.
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/README.md

@@ -0,0 +1,200 @@
+# Workarea Flow Io
+
+[Flow](https://flow.io) is an international checkout solution.  Clients set up
+an "experience" in Flow that targets specific currencies or regions.  A
+customer is geolocated using a javascript call, or they can opt to change
+their shipping country via a javascript widget.  Customers checking out
+in foreign currencies get redirected to Flow's hosted checkout solution.
+
+## Installation
+
+To install Flow, add it to your Gemfile:
+
+```ruby
+gem 'workarea-flow_io'
+```
+
+...and run `bundle install`!
+
+Next, configure your credentials in **config/secrets.yml**, as shown here:
+
+```yaml
+flow_io:
+  # get your API token from https://console.flow.io
+  # under 'Organization Settings > Integrations"
+  api_token:
+  organization_id:
+  # the following credentials are provided by flow.io representatives..
+  ftp_username:
+  ftp_password:
+```
+
+Finally, run the generator to set up Flow for use with your application:
+
+    rails workarea:flow_io:install
+
+This task creates localization attributes, webhooks, and exports products
+to Flow for later use, which are broken out into the following Rake
+tasks (run in the same order):
+
+    workarea:flow_io:create_localization_attributes
+    workarea:flow_io:create_webhooks
+    workarea:flow_io:export_products
+
+Now you're ready to Let It Flow!
+
+## Configuration
+
+Flow is configured using your `Workarea.config`, much like most of our
+other plugins. Many of these settings have defaults provided out of the
+box. The above steps in "Installation" should be the bare minimum you
+need to get the plugin working.
+
+### JavaScript Integration
+
+`Workarea::FlowIo` can optionally use [FlowJS](https://docs-beta.flow.io/docs/flowjs)
+as an additional layer of real-time pricing updates, or as the primary
+means by which "global" experience customers with no pre-defined
+experience can view localized prices. It is off by default, but can be
+enabled by setting the following in an initializer:
+
+```ruby
+Workarea.configure do |config|
+  config.flow_io.enable_javascript = true
+end
+```
+
+### Localization Attributes
+
+The plugin provides localization attributes for: `original_price`,
+`sale_price`, `msrp`, `product_id` and `digital` These correspond to
+values of the `attributes` when exporting an item to flow, and they come back
+in the `local_item_pricing` `attributes` field.  Other fields include
+`gtin`, `brand`, and `hazardous`. For more information, visit
+https://docs.flow.io/module/localization/resource/attributes and
+https://docs.flow.io/type/attribute-form
+
+### Checkout
+
+All international orders will be routed to a Flow.io hosted checkout
+page. By default the order confirmation page will be hosted with Flow.io as
+well.
+
+Customers will be redirected to the default Flow.io checkout url.
+However, most clients will choose to redirect to a subdomain.  The
+redirect domain is controlled via the following config:
+
+
+```ruby
+Workarea.configure do |config|
+  config.flow_io.checkout_uri = 'https://checkout.flow.io'
+end
+```
+
+## Under The Hood
+
+This section explains a bit about how Flow integrates their pricing
+model into your Workarea store.
+
+### Item Exporting / Importing
+
+A callbacks worker gets enqueued when `Catalog::Product`, `Shipping::Sku`,
+`Pricing::Sku`, or `Pricing::Price` are saved.  Depending on the number of
+skus changed, the worker will export the affected items to Flow.  Flow
+will then create Local Items to represent those skus in each experience,
+and push those prices back to Workarea in a flat file sent over SFTP.
+The plugin embeds those local items on the `Pricing::Sku` for display.
+The base price of a localized price will not necessarily be the same.
+After the initial price is converted into the localized currency,
+rounding and margin rules are applied and then it is converted back into
+the default currency as the base price.
+
+### Order Pricing
+
+When a customer is transacting in a currency other than the default
+currency, two sets of `PriceAdjustment`s are in effect.  The standard
+`#price_adjustments` on `Order::Item` and `Shipping` are used to track
+pricing in the sites default currency while `#flow_price_adjustments`
+will store pricing the customer transacted in.
+
+### Checkout Flow
+
+A new pricing calculator is added, `FlowLocalizationCalculator` and
+appended to the END of the pricing calculators array; it is important
+that if a build adds custom calculators that the
+`FlowLocalizationCalculator` is last.  This calculator sends the order
+to flow and updates the `Order::Item` and `Shipping` `#price_adjutments`
+with localized prices and updated base prices.  Because of the way
+discounting is passed to flow, discounts are displaying as a generic
+Discount adjustment, instead of an adjustment for each discount.
+Display will still happen at the order or item level depending on how
+the initial discount price adjutments were created.
+
+A `before_action` in `Storefront::CheckoutsController` will send
+customers to Flow's hosted checkout if they are checking out in a Flow
+`Experience`.  After the customer completes the order in hosted
+checkout.  Flow will send an `OrderUpsertedV2` webhook with a
+`#submitted_at` value.  The `Workarea::Order` will be updated and marked
+as placed.
+
+When `Fulfillment::Item`s are shipped or canceled in Workarea, workers
+will update Flow with `ShippingNotifications` or
+`FulfillmentCancellations`.
+
+### Session
+
+A piece of middleware sits in front of `Rack::Cache` that will upsert a
+`Session` in Flow if the `_f60_session` cookie is blank, passing the
+`request.remote_ip` and `HTTP_GEOIP_CITY_COUNTRY_CODE3` from Nginx.  If
+the `_f60_session` cookie is present and the `flow_experience` cookie
+isn't a request will be made to get the session from the Flow API.  If
+the API request 404s, a new session will be created and the
+`_f60_session` cookie will be updated.  It updates HTTP's `Vary` header
+to include `X-Flow-Experience` and stores the current `Experience` in
+the `flow_experience` cookie as JSON.  If a user updates their country
+via the `country_picker.js`, the `flow_experience` cookie is updated in
+the `onSessionUpdate` in javascript.
+
+### Caching
+
+Cache keys are decorated to include the current `Experience` key.  The
+Http Vary header is adjusted to include `X-Flow-Experience`  The current
+country ISO-3166-3 code is added to the `locale` as an added measure
+agaisnt browser caching and the etag is updated to include the
+`Experience` key.
+
+## Client Considerations
+
+It's assumed that Flow will be the payment processor for foreign orders,
+and that Flow will `purchase` those funds. 3PL(Third Party Logistics)
+will need to be discussed between the client and Flow for foreign orders.
+
+## Incompatibilities and Gotchas
+
+When using this plugin with Gift Cards, make sure `flow_io` appears
+after `gift_cards` in your Gemfile, like so:
+
+```ruby
+gem 'workarea-gift_cards'
+gem 'workarea-flow_io'
+```
+
+## Contributing
+
+Do you have a feature request, documentation update, bug report, or any
+kind of feedback about this plugin? [Create a new issue](https://github.com/workarea-commerce/workarea-flow-io/issues/new/choose)
+and tell us all about it!
+
+If you have some code you'd like to contribute to `Workarea::FlowIo`,
+make sure tests pass locally by running:
+
+```bash
+rails test                        # runs tests local to the plugin
+rails app:workarea:test:decorated # runs decorated tests
+```
+
+Then, fork this repo and submit a pull request!
+
+## License
+
+`Workarea::FlowIo` is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,59 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Flow Io'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/flow_io/version'
+
+desc "Release version #{Workarea::FlowIo::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"'
+
+  system "git tag -a v#{Workarea::FlowIo::VERSION} -m 'Tagging #{Workarea::FlowIo::VERSION}'"
+  system 'git push origin HEAD --follow-tags'
+
+  system "gem build workarea-flow_io.gemspec"
+  system "gem push workarea-flow_io-#{Workarea::FlowIo::VERSION}.gem #{host}"
+  system "gem push workarea-flow_io-#{Workarea::FlowIo::VERSION}.gem --host #{host}"
+  system "rm workarea-flow_io-#{Workarea::FlowIo::VERSION}.gem"
+end
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+task teaspoon: 'app:teaspoon'
+
+desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/javascripts/workarea/storefront/flow_io/adapters/flow_io_adapter.js

@@ -0,0 +1,61 @@
+/**
+ * @namespace WORKAREA.flowIoAdapter
+ */
+
+WORKAREA.analytics.registerAdapter('flowIoAdapter', function () {
+    'use strict';
+
+    return {
+        'addToCartConfirmation': function (payload) {
+            var cartAddEvent = {
+                item_number: payload.sku,
+                quantity: payload.quantity,
+                price: {
+                    amount: payload.price,
+                    currency: payload.currency_code,
+                },
+            };
+
+            flow.beacon('event', 'cart_add', cartAddEvent);
+        },
+
+        'removeFromCart': function (payload) {
+            var cartRemoveEvent = {
+                item_number: payload.sku
+            };
+
+            flow.beacon('event', 'cart_remove', cartRemoveEvent);
+        },
+
+        'checkoutOrderPlaced': function (payload) {
+            var transactionEvent = {
+                number: payload.id,
+                revenue: {
+                    amount: payload.total_price,
+                    currency: payload.total_price_currence_code,
+                },
+                shipping: {
+                    amount: payload.shipping_total,
+                    currency: payload.shipping_total_currency_code
+                },
+                tax: {
+                    amount: payload.tax_total,
+                    currency: payload.tax_total_currency_code,
+                },
+                items: _.map(payload.items, function (impression) {
+                    return {
+                        number: impression.sku,
+                        price: {
+                            amount: impression.price,
+                            currency: impression.currency_code
+                        },
+                        quantity: impression.quantity,
+                        name: impression.product_name
+                    };
+                })
+            };
+
+            flow.beacon('event', 'transaction', transactionEvent);
+        }
+    };
+});

data/app/assets/javascripts/workarea/storefront/flow_io/configuration.js.erb

@@ -0,0 +1,10 @@
+
+(function () {
+    'use strict';
+
+  <% if Workarea.config.flow_io.enable_javascript %>
+    WORKAREA.config.flow = {
+      organizationID: "<%= Workarea::FlowIo.organization_id %>"
+    };
+  <% end %>
+})();

data/app/assets/javascripts/workarea/storefront/flow_io/flow.js

@@ -0,0 +1,91 @@
+/**
+ * Integrate flow.io's JS into your Workarea application.
+ *
+ * @namespace WORKAREA.flow
+ */
+WORKAREA.registerModule('flow', (function () {
+    'use strict';
+
+    var getScript = _.once(function () {
+            !function (f, l, o, w, i, n, g) {
+            f[i] = f[i] || {};f[i].cmd = f[i].cmd || function () {
+            (f[i].q = f[i].q || []).push(arguments);};n = l.createElement(o);
+            n.src = w;g = l.getElementsByTagName(o)[0];g.parentNode.insertBefore(n, g);
+            }(window,document,'script','https://cdn.flow.io/flowjs/latest/flow.min.js','flow');
+
+            flow.cmd('set', 'organization', WORKAREA.config.flow.organizationID);
+            flow.cmd('init');
+        }),
+
+        urlLocale = function (url) {
+            var parsedUrl = WORKAREA.url.parse(url),
+                parts = _.filter(parsedUrl.path.split("/"), function(part) { return part !== ""; } ),
+                matches = (parts[0] || "").match(/^(\w{3})$/);
+
+            if (matches === null) {
+                return;
+            }
+            else {
+                return matches[1];
+            }
+        },
+
+        redirectUrl = function(url, locale) {
+           var oldLocale = urlLocale(url),
+               parsedUrl;
+
+            if (_.isUndefined(oldLocale)) {
+                parsedUrl = WORKAREA.url.parse(url);
+                return url.replace(new RegExp(parsedUrl.path + "$"), "/" + locale + parsedUrl.path);
+            } else {
+                return url.replace(oldLocale, locale);
+            }
+        },
+
+        updateSession = function(status, session) {
+            var country = session.geo.country.iso_3166_3.toLowerCase(),
+                url = WORKAREA.url.current();
+
+            WORKAREA.cookie.create('flow_country', country, 365);
+            WORKAREA.cookie.create('flow_experience', encodeURIComponent(JSON.stringify(session.experience)), 365);
+            WORKAREA.url.redirectTo(redirectUrl(url, country));
+        },
+
+        initCountryPicker = _.once(function() {
+            flow.cmd('on', 'ready', function () {
+                flow.countryPicker.createCountryPicker({
+                    type: "modal",
+                    containerId: "country-picker",
+                    onSessionUpdate: updateSession
+                });
+            });
+        }),
+
+        localizePrices = function() {
+            flow.cmd('localize');
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.flow
+         */
+        init = function () {
+            if (_.isUndefined(WORKAREA.config.flow)) { return; }
+
+            getScript();
+            localizePrices();
+
+            if (!_.isEmpty($("#country-picker"))) {
+                initCountryPicker();
+            }
+        };
+
+        // urlLocale and redirectUrl are only exposed for testing and
+        // shouldn't be used as part of public API
+        return {
+            init: init,
+            urlLocale: urlLocale,
+            redirectUrl: redirectUrl
+        };
+}()));