workarea-facebook_conversion_tracking 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0054cb6c3c1ca17de81bfe377b7b6708e9d42144
+  data.tar.gz: 92ebfb7e98c90b857425c61657b4f822e7db9084
+SHA512:
+  metadata.gz: 8e7e4156378a3f19c4d2ddd47b834fb397721458331a5d64f7c2e090bf9042582b1395934b25114740ea3ab8e9b282609be69b2a4e48b19876c0fdc4c179f180
+  data.tar.gz: f1beaff66340367f4495566b26bca5b1c1a5d5c8fc656b1d71032bdf2a385e1b17e2d8f5e325f4ea47f22baf4d183da441ce9201d9d5e50b4898aa016fa32941

data/.gitignore

@@ -0,0 +1,22 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+.DS_Store
+.byebug_history
+.bundle/
+.sass-cache/
+Gemfile.lock
+pkg/
+test/dummy/tmp/
+test/dummy/public/
+log/*.log
+test/dummy/log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+node_modules
+test/reports
+.rubocop-http*

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
+gem 'workarea', git: 'https://github.com/workarea-commerce/workarea.git', branch: 'v3.5-stable'

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+Workarea Facebook Conversion Tracking
+================================================================================
+
+A Facebook conversion tracking plugin for the Workarea Commerce platform. This integration sends events via browser and server
+to Facebook Business Manager.
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a Rails engine that must be mounted onto a host Rails application.
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-facebook_conversion_tracking'
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+Features
+--------------------------------------------------------------------------------
+
+This integration supports the following features:
+* Adding the Facebook pixel
+* Support the following facebook standard events out of the box:
+  * AddtoCart
+  * Purchase
+
+* Each event will require adjusting custom data on a per project need
+
+Configuration
+--------------------------------------------------------------------------------
+
+**For Workarea v3.5 and Greater** 
+Facebook Conversion Tracking can be configured via the settings section in the Workarea admin console.
+Available settings are: 
+* pixel id
+* access token
+* test code
+
+
+**For Workarea v3.0 to V3.4**
+Add the following to your secrets:
+
+  facebook_conversion_tracking:
+    pixel_id: YOUR-PIXEL-ID
+    access_token: YOUR-ACCESS-TOKEN
+    test_code: YOUR-TEST-CODE
+
+Documentation
+--------------------------------------------------------------------------------
+See [https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking](https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking) for Conversion Tracking Documentation. 
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea platform documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Sezzle is released under the MIT open source agreement.
+

data/app/assets/javascripts/workarea/storefront/facebook_conversion_tracking/modules/adapter.js

@@ -0,0 +1,116 @@
+WORKAREA.analytics.registerAdapter('facebookConversionTracking', function () {
+    'use strict';
+
+    return {
+        addToCart: function (payload) {
+            var eventName = 'AddToCart',
+                contentType = 'product_group',
+                eventId = payload.event_id,
+                products = [
+                    {
+                        id: payload.id,
+                        name: payload.name,
+                        sku: payload.sku,
+                        sale: payload.sale,
+                        price: payload.price,
+                        category: payload.category
+                    }
+                ],
+                serverPayload = {
+                    event: eventName,
+                    event_id: eventId,
+                    event_source_url: window.location.href,
+                    content_type: contentType,
+                    products: products
+                },
+                browserPayload = {
+                    name: [payload.name],
+                    sku: [payload.sku],
+                    sale: [payload.sale],
+                    price: [payload.price],
+                    category: [payload.category],
+                    content_type: contentType,
+                    content_ids: [payload.sku]
+                };
+
+            $.ajax({
+                type: 'POST',
+                url: WORKAREA.routes.storefront.facebookConversionTrackingAddToCartPath(),
+                data: serverPayload
+            });
+
+            if (_.isUndefined(window.fbq)) {
+                setTimeout(function() {
+                  fbq('track', eventName, browserPayload, { eventID: eventId });
+                }, 3000);
+            } else {
+                fbq('track', eventName, browserPayload, { eventID: eventId });
+            };
+        },
+
+        checkoutOrderPlaced: function (payload) {
+            var eventName = 'Purchase',
+                contentType = 'product_group',
+                eventId = payload.event_id,
+                products = [];
+
+            _.each(payload.items, function (impression) {
+                products.push({
+                    id: impression.product_id,
+                    name: impression.product_name,
+                    sku: impression.sku,
+                    price: impression.price,
+                    quantity: impression.quantity,
+                    category: impression.category
+                });
+            });
+
+            var serverPayload = {
+                event: eventName,
+                event_id: eventId,
+                event_source_url: window.location.href,
+                id: payload.id,
+                promo_codes: payload.promo_codes,
+                shipping_service: payload.shipping_service,
+                shipping_total: payload.shipping_total,
+                tax_total: payload.tax_total,
+                tenders: payload.tenders,
+                value: payload.total_price,
+                currency: payload.currency,
+                content_type: contentType,
+                products: products
+            },
+            browserPayload = {
+                id: payload.id,
+                promo_codes: payload.promo_codes,
+                shipping_service: payload.shipping_service,
+                shipping_total: payload.shipping_total,
+                tax_total: payload.tax_total,
+                tenders: payload.tenders,
+                value: payload.total_price,
+                currency: payload.currency,
+                content_type: contentType,
+                content_ids: _.map(products, 'id'),
+                name: _.map(products, 'name'),
+                sku: _.map(products, 'sku'),
+                price: _.map(products, 'price'),
+                quantity: _.map(products, 'quantity'),
+                category: _.map(products, 'category')
+            };
+
+            $.ajax({
+                type: 'POST',
+                url: WORKAREA.routes.storefront.facebookConversionTrackingPurchasePath(),
+                data: serverPayload
+            });
+
+            if (_.isUndefined(window.fbq)) {
+                setTimeout(function() {
+                  fbq('track', eventName, browserPayload, { eventID: eventId });
+                }, 3000);
+            } else {
+                fbq('track', eventName, browserPayload, { eventID: eventId });
+            };
+        },
+    };
+});

data/app/controllers/workarea/storefront/facebook_conversion_tracking_controller.rb

@@ -0,0 +1,11 @@
+module Workarea
+  class Storefront::FacebookConversionTrackingController < Storefront::ApplicationController
+    def add_to_cart
+      Workarea::FacebookConversionTracking::Models::Events::AddToCart.new(request, params).perform
+    end
+
+    def purchase
+      Workarea::FacebookConversionTracking::Models::Events::Purchase.new(request, params).perform
+    end
+  end
+end

data/app/helpers/workarea/facebook_conversion_tracking/analytics/helper.rb

@@ -0,0 +1,21 @@
+module Workarea
+  module FacebookConversionTracking
+    module Analytics
+      module Helper
+        def product_analytics_data(product)
+          super.merge(event_id: event_id)
+        end
+
+        def order_analytics_data(order)
+          super.merge(event_id: event_id, currency: order.model.total_value.currency.iso_code)
+        end
+
+        private
+
+        def event_id
+          "#{Time.current.to_i}_#{rand(10000)}"
+        end
+      end
+    end
+  end
+end

data/app/views/workarea/storefront/facebook/_pixel.html.haml

@@ -0,0 +1,12 @@
+- if Workarea::FacebookConversionTracking.pixel_id.present?
+  %iframe{ src: "https://www.facebook.com/tr?id=#{Workarea::FacebookConversionTracking.pixel_id}&ev=PageView&noscript=1", height: 1, width: 1, style: 'display:none;visibility:hidden;' }
+  :javascript
+    !function(f,b,e,v,n,t,s)
+    {if(f.fbq)return;n=f.fbq=function(){n.callMethod?
+    n.callMethod.apply(n,arguments):n.queue.push(arguments)};
+    if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version='2.0';
+    n.queue=[];t=b.createElement(e);t.async=!0;
+    t.src=v;s=b.getElementsByTagName(e)[0];
+    s.parentNode.insertBefore(t,s)}(window, document,'script',
+    'https://connect.facebook.net/en_US/fbevents.js');
+    fbq('init', "#{Workarea::FacebookConversionTracking.pixel_id}");

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('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/workarea/facebook_conversion_tracking/engine', __FILE__)
+APP_PATH = File.expand_path('../../test/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+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,11 @@
+module Workarea
+  Plugin.append_javascripts(
+    'storefront.modules',
+    'workarea/storefront/facebook_conversion_tracking/modules/adapter'
+  )
+
+  Plugin.append_partials(
+    'storefront.javascript',
+    'workarea/storefront/facebook/pixel'
+  )
+end

data/config/initializers/fields.rb

@@ -0,0 +1,23 @@
+if Workarea::Configuration.respond_to?(:define_fields)
+  Workarea::Configuration.define_fields do
+    fieldset 'Facebook Conversion Tracking' do
+      field 'Pixel Id',
+        type: :string,
+        description: 'Facebook Pixel Id',
+        allow_blank: false,
+        encrypted: false
+
+      field 'Access Token',
+        type: :string,
+        description: 'Business Manager Access Token',
+        allow_blank: false,
+        encrypted: true
+
+      field 'Test Code',
+        type: :string,
+        description: 'Business Manager Test Code',
+        allow_blank: true,
+        encrypted: false
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Workarea::Storefront::Engine.routes.draw do
+  post 'facebook_conversion_tracking/add_to_cart', to: 'facebook_conversion_tracking#add_to_cart'
+  post 'facebook_conversion_tracking/purchase', to: 'facebook_conversion_tracking#purchase'
+end

data/lib/workarea/facebook_conversion_tracking.rb

@@ -0,0 +1,37 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/facebook_conversion_tracking/engine'
+require 'workarea/facebook_conversion_tracking/version'
+
+require 'workarea/facebook_conversion_tracking/models/events/base'
+require 'workarea/facebook_conversion_tracking/models/events/add_to_cart'
+require 'workarea/facebook_conversion_tracking/models/events/purchase'
+require 'workarea/facebook_conversion_tracking/gateway'
+
+module Workarea
+  module FacebookConversionTracking
+    # used for <= 3.5, these creds come from secrets isntead of encrypted in the
+    # 3.5 configurations system.
+    def self.credentials
+      (Rails.application.secrets.facebook_conversion_tracking || {}).deep_symbolize_keys
+    end
+
+    def self.pixel_id
+      Workarea.config.facebook_conversion_tracking_pixel_id || credentials[:pixel_id]
+    end
+
+    def self.access_token
+      Workarea.config.facebook_conversion_tracking_access_token || credentials[:access_token]
+    end
+
+    def self.test_code
+      Workarea.config.facebook_conversion_tracking_test_code || credentials[:test_code]
+    end
+
+    def self.configured?
+      pixel_id.present? && access_token.present?
+    end
+  end
+end

data/lib/workarea/facebook_conversion_tracking/engine.rb

@@ -0,0 +1,13 @@
+module Workarea
+  module FacebookConversionTracking
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::FacebookConversionTracking
+
+      config.to_prepare do
+        Workarea::ApplicationController.helper(Workarea::FacebookConversionTracking::Analytics::Helper)
+        Workarea::Storefront::ApplicationController.helper(Workarea::FacebookConversionTracking::Analytics::Helper)
+      end
+    end
+  end
+end

data/lib/workarea/facebook_conversion_tracking/gateway.rb

@@ -0,0 +1,68 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Workarea
+  class FacebookConversionTrackingGateway
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def send
+      begin
+        response = conn.post do |req|
+          req.params['data'] = @payload.to_json
+        end
+
+        handle_response(response)
+      rescue => e
+        Raven.capture_message("Facebook Conversion Tracking POST Error: #{e}", level: 'error')
+      end
+    end
+
+    private
+
+    def handle_response(response)
+      parsed_resp = JSON.parse(response.body)
+
+      if response.status != 200
+        Raven.capture_message("Facebook Conversion Tracking Error: #{parsed_resp}", level: 'error')
+      else
+        parsed_resp
+      end
+    end
+
+    def conn
+      @conn ||=
+        Faraday.new(
+          url: URI.parse(url),
+          params: conn_params,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    # We only want to use the test code when testing on dev.
+    def conn_params
+      return unless Workarea::FacebookConversionTracking.configured?
+
+      test_code = Rails.env.development? ? { test_event_code: test_code } : {}
+      { access_token: access_token }.merge(test_code)
+    end
+
+    def url
+      "https://graph.facebook.com/v10.0/#{pixel_id}/events"
+    end
+
+    def pixel_id
+      Workarea::FacebookConversionTracking.pixel_id
+    end
+
+    def access_token
+      Workarea::FacebookConversionTracking.access_token
+    end
+
+    def test_code
+      Workarea::FacebookConversionTracking.test_code
+    end
+  end
+end

data/lib/workarea/facebook_conversion_tracking/models/events/add_to_cart.rb

@@ -0,0 +1,26 @@
+module Workarea
+  module FacebookConversionTracking
+    module Models
+      module Events
+        class AddToCart < Base
+          def perform
+            event = build_event
+
+            custom_data = {
+              content_type: @params[:content_type],
+              content_ids: products.pluck(:id),
+              name: products.pluck(:name),
+              sku: products.pluck(:sku),
+              sale: products.pluck(:sale),
+              price: products.pluck(:price)
+            }
+
+            event[:custom_data] = custom_data
+
+            send([event])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/facebook_conversion_tracking/models/events/base.rb

@@ -0,0 +1,37 @@
+module Workarea
+  module FacebookConversionTracking
+    module Models
+      module Events
+        class Base
+          def initialize(request, params)
+            @request = request
+            @params = params
+          end
+
+          def products
+            @params[:products].values
+          end
+
+          def build_event
+            {
+              event_name: @params[:event],
+              event_id: @params[:event_id],
+              event_time: Time.current.to_i,
+              event_source_url: @params[:event_source_url],
+              action_source: 'website',
+              user_data: {
+                client_ip_address: @request.remote_ip,
+                client_user_agent: @request.user_agent
+              },
+              custom_data: {}
+            }
+          end
+
+          def send(event)
+            Workarea::FacebookConversionTrackingGateway.new(event).send
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/facebook_conversion_tracking/models/events/purchase.rb

@@ -0,0 +1,34 @@
+module Workarea
+  module FacebookConversionTracking
+    module Models
+      module Events
+        class Purchase < Base
+          def perform
+            event = build_event
+
+            custom_data = {
+              id: @params[:id],
+              promo_codes: @params[:promo_codes],
+              shipping_service: @params[:shipping_service],
+              shipping_total: @params[:shipping_total],
+              tax_total: @params[:tax_total],
+              tenders: @params[:tenders],
+              value: @params[:value], #required
+              currency: @params[:currency], #required
+              content_type: @params[:content_type], #required for Dynamic Ads
+              content_ids: products.pluck(:id), #required for Dynamic Ads
+              name: products.pluck(:name),
+              sku: products.pluck(:sku),
+              price: products.pluck(:price),
+              quantity: products.pluck(:quantity),
+              category: products.pluck(:category)
+            }
+            event[:custom_data] = custom_data
+
+            send([event])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/facebook_conversion_tracking/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module FacebookConversionTracking
+    VERSION = '1.0.0'.freeze
+  end
+end

data/workarea-facebook_conversion_tracking.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+# Maintain your gem's version:
+require 'workarea/facebook_conversion_tracking/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = 'workarea-facebook_conversion_tracking'
+  spec.version     = Workarea::FacebookConversionTracking::VERSION
+  spec.authors     = ['Jurgen Hahn']
+  spec.email       = ['jurgen@syatt.io']
+  spec.homepage    = 'https://github.com/syatt-io/workarea-facebook-conversion-tracking'
+  spec.summary     = 'Workarea Commerce plugin for facebook conversion tracking'
+  spec.description = 'A facebook conversion tracking plugin into the Workarea Commerce system.'
+  spec.license     = 'Nonstandard'
+
+  spec.files = `git ls-files`.split("\n")
+
+  spec.add_dependency 'workarea', '~> 3.x'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: workarea-facebook_conversion_tracking
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jurgen Hahn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: workarea
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+description: A facebook conversion tracking plugin into the Workarea Commerce system.
+email:
+- jurgen@syatt.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- app/assets/javascripts/workarea/storefront/facebook_conversion_tracking/modules/adapter.js
+- app/controllers/workarea/storefront/facebook_conversion_tracking_controller.rb
+- app/helpers/workarea/facebook_conversion_tracking/analytics/helper.rb
+- app/views/workarea/storefront/facebook/_pixel.html.haml
+- bin/rails
+- config/initializers/appends.rb
+- config/initializers/fields.rb
+- config/routes.rb
+- lib/workarea/facebook_conversion_tracking.rb
+- lib/workarea/facebook_conversion_tracking/engine.rb
+- lib/workarea/facebook_conversion_tracking/gateway.rb
+- lib/workarea/facebook_conversion_tracking/models/events/add_to_cart.rb
+- lib/workarea/facebook_conversion_tracking/models/events/base.rb
+- lib/workarea/facebook_conversion_tracking/models/events/purchase.rb
+- lib/workarea/facebook_conversion_tracking/version.rb
+- workarea-facebook_conversion_tracking.gemspec
+homepage: https://github.com/syatt-io/workarea-facebook-conversion-tracking
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Workarea Commerce plugin for facebook conversion tracking
+test_files: []