[OFN Domains] Breaking OFN into domains - POC cookies inside an engine

.rubocop.yml

@@ -16,6 +16,8 @@ AllCops:
     - !ruby/regexp /old_and_unused\.rb$/
     # The parser gem fails to parse this file with out current Ruby version.
     - 'spec/factories.rb'
+    # Excluding: inadequate Naming/FileName rule rejects GemFile name with camelcase
+    - 'engines/web/Gemfile'
 
 # OFN SETTINGS
 # Cop settings that have been agreed upon by the OFN community

Gemfile

@@ -10,6 +10,8 @@ gem 'i18n-js', '~> 3.0.0'
 # Patched version. See http://rubysec.com/advisories/CVE-2015-5312/.
 gem 'nokogiri', '>= 1.6.7.1'
 
+gem 'web', path: './engines/web'
+
 gem 'pg'
 gem 'spree', github: 'openfoodfoundation/spree', branch: 'step-6a', ref: '69db1c090f3711088d84b524f1b94d25e6d21616'
 gem 'spree_i18n', github: 'spree/spree_i18n', branch: '1-3-stable'

Gemfile.lock

@@ -133,6 +133,11 @@ GIT
       activemodel (>= 3.0)
       railties (>= 3.0)
 
+PATH
+  remote: engines/web
+  specs:
+    web (0.0.1)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -767,6 +772,7 @@ DEPENDENCIES
   capybara (>= 2.15.4)
   coffee-rails (~> 3.2.1)
   compass-rails
+  web!
   custom_error_message!
   daemons
   dalli

app/assets/stylesheets/darkswarm/all.scss

@@ -12,6 +12,7 @@
 @import 'base/*';
 @import '*';
 @import 'pages/*';
+@import '../web/all';
 
 ofn-modal {
   display: block;

app/helpers/footer_links_helper.rb

@@ -0,0 +1,11 @@
+require 'web/cookies_consent'
+
+module FooterLinksHelper
+  def cookies_policy_link
+    link_to( t( '.footer_data_cookies_policy' ), '', 'cookies-policy-modal' => true, 'cookies-banner' => !Web::CookiesConsent.new(cookies, request.host).exists? && Spree::Config.cookies_consent_banner_toggle)
+  end
+
+  def privacy_policy_link
+    link_to( t( '.footer_data_privacy_policy' ), Spree::Config.privacy_policy_url, target: '_blank' )
+  end
+end

app/views/layouts/darkswarm.html.haml

@@ -19,6 +19,7 @@
     %script{src: "//maps.googleapis.com/maps/api/js?libraries=places,geometry#{ ENV['GOOGLE_MAPS_API_KEY'] ? '&key=' + ENV['GOOGLE_MAPS_API_KEY'] : ''} "}
     = stylesheet_link_tag "darkswarm/all"
     = javascript_include_tag "darkswarm/all"
+    = javascript_include_tag "web/all"
 
     = render "layouts/i18n_script"
     = render "layouts/bugherd_script"

app/views/shared/_footer.html.haml

@@ -140,8 +140,6 @@
           = t '.footer_legal_text_html', {content_license: link_to('CC BY-SA 3.0', 'https://creativecommons.org/licenses/by-sa/3.0/'), code_license: link_to('AGPL 3', 'https://tldrlegal.com/license/gnu-affero-general-public-license-v3-(agpl-3.0)' )}
         %p.text-small
           %div
-            - cookies_policy_link = link_to( t( '.footer_data_cookies_policy' ), '', 'cookies-policy-modal' => true, 'cookies-banner' => !CookiesConsent.new(cookies, request.host).exists? && Spree::Config.cookies_consent_banner_toggle)
-            - privacy_policy_link = link_to( t( '.footer_data_privacy_policy' ), Spree::Config.privacy_policy_url, :target => '_blank' )
             - if Spree::Config.privacy_policy_url.present?
               = t '.footer_data_text_with_privacy_policy_html', {cookies_policy: cookies_policy_link.html_safe, privacy_policy: privacy_policy_link.html_safe }
             - else

config/routes.rb

@@ -109,17 +109,16 @@
       get :job_queue
     end
 
-    scope '/cookies' do
-      resource :consent, only: [:show, :create, :destroy], :controller => "cookies_consent"
-    end
-
     resources :customers, only: [:index, :update]
 
     post '/product_images/:product_id', to: 'product_images#update_product_image'
   end
 
   get 'sitemap.xml', to: 'sitemap#index', defaults: { format: 'xml' }
 
+  # Mount Web engine routes
+  mount Web::Engine, :at => '/'
+
   # Mount Spree's routes
   mount Spree::Core::Engine, :at => '/'
 end

engines/web/README.md

@@ -0,0 +1,5 @@
+# Web
+
+This is the rails engine for the Web domain.
+
+See our wiki for [more info about domains and engines in OFN](https://github.com/openfoodfoundation/openfoodnetwork/wiki/Tech-Doc:-How-OFN-is-organized-in-Domains-using-Rails-Engines).

engines/web/app/assets/javascripts/web/all.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_controller.js.coffee → engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_controller.js.coffee

@@ -1,6 +1,6 @@
 Darkswarm.controller "CookiesBannerCtrl", ($scope, CookiesBannerService, $http, $window)->
 
   $scope.acceptCookies = ->
-    $http.post('/api/cookies/consent')
+    $http.post('/web/api/cookies/consent')
     CookiesBannerService.close()
     CookiesBannerService.disable()

app/assets/javascripts/darkswarm/cookies_banner/cookies_banner_service.js.coffee → engines/web/app/assets/javascripts/web/cookies_banner/cookies_banner_service.js.coffee

@@ -4,7 +4,7 @@ Darkswarm.factory "CookiesBannerService", (Navigation, $modal, $location, Redire
     modalMessage: null
     isEnabled: false
 
-    open: (path, template = 'darkswarm/cookies_banner/cookies_banner.html') =>
+    open: (path, template = 'angular-templates/cookies_banner.html') =>
       return unless @isEnabled
       @modalInstance = $modal.open
         templateUrl: template

engines/web/app/assets/javascripts/web/web.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

engines/web/app/assets/stylesheets/web/all.css.scss

@@ -0,0 +1,2 @@
+@import 'web/pages/cookies_banner';
+@import 'web/pages/cookies_policy_modal';

app/assets/stylesheets/darkswarm/pages/cookies_banner.css.scss → engines/web/app/assets/stylesheets/web/pages/cookies_banner.css.scss

@@ -1,4 +1,4 @@
-@import '../branding';
+@import 'darkswarm/branding';
 
 .cookies-banner {
   background: $dark-grey;

app/assets/stylesheets/darkswarm/pages/cookies_policy_modal.css.scss → engines/web/app/assets/stylesheets/web/pages/cookies_policy_modal.css.scss

@@ -1,4 +1,4 @@
-@import '../branding';
+@import 'darkswarm/branding';
 
 .cookies-policy-modal {
   background: $disabled-light;

engines/web/app/controllers/web/api/cookies_consent_controller.rb

@@ -0,0 +1,30 @@
+require_dependency 'web/cookies_consent'
+
+module Web
+  module Api
+    class CookiesConsentController < BaseController
+      include ActionController::Cookies
+      respond_to :json
+
+      def show
+        render json: { cookies_consent: cookies_consent.exists? }
+      end
+
+      def create
+        cookies_consent.set
+        show
+      end
+
+      def destroy
+        cookies_consent.destroy
+        show
+      end
+
+      private
+
+      def cookies_consent
+        @cookies_consent ||= Web::CookiesConsent.new(cookies, request.host)
+      end
+    end
+  end
+end

engines/web/app/controllers/web/application_controller.rb

@@ -0,0 +1,5 @@
+module Web
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

engines/web/app/helpers/web/cookies_policy_helper.rb

@@ -0,0 +1,23 @@
+module Web
+  module CookiesPolicyHelper
+    def render_cookie_entry(cookie_name, cookie_desc, cookie_domain = nil)
+      render partial: 'cookies_policy_entry',
+             locals: { cookie_name: cookie_name,
+                       cookie_desc: cookie_desc,
+                       cookie_domain: cookie_domain }
+    end
+
+    def matomo_iframe_src
+      "#{Spree::Config.matomo_url}"\
+        "/index.php?module=CoreAdminome&action=optOut"\
+        "&language=#{locale_language}"\
+        "&backgroundColor=&fontColor=222222&fontSize=16px&fontFamily=%22Roboto%22%2C%20Arial%2C%20sans-serif"
+    end
+
+    # removes country from locale if needed
+    #   for example, both locales en and en_GB return language en
+    def locale_language
+      I18n.locale[0..1]
+    end
+  end
+end

engines/web/config/routes.rb

@@ -0,0 +1,9 @@
+Web::Engine.routes.draw do
+  namespace :web do
+    namespace :api do
+      scope '/cookies' do
+        resource :consent, only: [:show, :create, :destroy], controller: "cookies_consent"
+      end
+    end
+  end
+end

engines/web/lib/web.rb

@@ -0,0 +1,4 @@
+require "web/engine"
+
+module Web
+end

engines/web/lib/web/cookies_consent.rb

@@ -0,0 +1,31 @@
+module Web
+  class CookiesConsent
+    COOKIE_NAME = 'cookies_consent'.freeze
+
+    def initialize(cookies, domain)
+      @cookies = cookies
+      @domain = domain
+    end
+
+    def exists?
+      cookies.key?(COOKIE_NAME)
+    end
+
+    def destroy
+      cookies.delete(COOKIE_NAME, domain: domain)
+    end
+
+    def set
+      cookies[COOKIE_NAME] = {
+        value: COOKIE_NAME,
+        expires: 1.year.from_now,
+        domain: domain,
+        httponly: true
+      }
+    end
+
+    private
+
+    attr_reader :cookies, :domain
+  end
+end

engines/web/lib/web/engine.rb

@@ -0,0 +1,4 @@
+module Web
+  class Engine < ::Rails::Engine
+  end
+end

engines/web/lib/web/version.rb

@@ -0,0 +1,3 @@
+module Web
+  VERSION = "0.0.1".freeze
+end

engines/web/spec/helpers/cookies_policy_helper_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Web
+  describe CookiesPolicyHelper, type: :helper do
+    # keeps global state unchanged
+    around do |example|
+      original_locale = I18n.locale
+      original_matomo_url = Spree::Config.matomo_url
+      example.run
+      Spree::Config.matomo_url = original_matomo_url
+      I18n.locale = original_locale
+    end
+
+    describe "matomo optout iframe src" do
+      describe "when matomo url is set" do
+        before do
+          Spree::Config.matomo_url = "http://matomo.org/"
+        end
+
+        scenario "includes the matomo URL" do
+          expect(helper.matomo_iframe_src).to include Spree::Config.matomo_url
+        end
+
+        scenario "is not equal to the matomo URL" do
+          expect(helper.matomo_iframe_src).to_not eq Spree::Config.matomo_url
+        end
+      end
+
+      scenario "is not nil, when matomo url is nil" do
+        Spree::Config.matomo_url = nil
+        expect(helper.matomo_iframe_src).to_not eq nil
+      end
+    end
+
+    describe "language from locale" do
+      scenario "when locale is the language" do
+        I18n.locale = "en"
+        expect(helper.locale_language).to eq "en"
+      end
+
+      scenario "is empty when locale is empty" do
+        I18n.locale = ""
+        expect(helper.locale_language).to be_empty
+      end
+
+      scenario "is only the language, when locale includes country" do
+        I18n.locale = "en_GB"
+        expect(helper.locale_language).to eq "en"
+      end
+    end
+  end
+end