workarea-salesforce_esp 1.0.0

data/config/initializers/workarea.rb

@@ -0,0 +1,6 @@
+Workarea.configure do |config|
+  config.salesforce = ActiveSupport::Configurable::Configuration.new
+  config.salesforce.default_list = '' # required, default list to add new email signups to.
+  config.salesforce.token_endpoint = nil # required, URL endpoint to get an auth token.
+  config.salesforce.account_id = nil # optional, target account ID, optional
+end

data/config/routes.rb

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

data/lib/workarea/salesforce_esp.rb

@@ -0,0 +1,55 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/salesforce_esp/version'
+require 'workarea/salesforce_esp/engine'
+require 'workarea/salesforce_esp/gateway'
+require 'workarea/salesforce_esp/bogus_gateway'
+require 'workarea/salesforce_esp/response'
+require 'workarea/salesforce_esp/subscriber'
+
+require 'marketingcloudsdk'
+
+module Workarea
+  module SalesforceEsp
+    def self.gateway
+      if credentials.present?
+        options = {
+          client_id: client_id,
+          secret: secret,
+          account_id: account_id,
+          request_token_url: token_endpoint
+        }
+
+        Workarea::SalesforceEsp::Gateway.new(options)
+      else
+        Workarea::SalesforceEsp::BogusGateway.new
+      end
+    end
+
+    def self.credentials
+      (Rails.application.secrets.salesforce || {}).deep_symbolize_keys
+    end
+
+    def self.config
+      Workarea.config.salesforce
+    end
+
+    def self.account_id
+      Workarea.config.salesforce.account_id
+    end
+
+    def self.token_endpoint
+      Workarea.config.salesforce.token_endpoint
+    end
+
+    def self.client_id
+      credentials[:client_id]
+    end
+
+    def self.secret
+      credentials[:secret]
+    end
+  end
+end

data/lib/workarea/salesforce_esp/bogus_gateway.rb

@@ -0,0 +1,33 @@
+module Workarea
+  module SalesforceEsp
+    class BogusGateway
+      @@supported_methods = SalesforceEsp::Gateway.public_instance_methods
+
+
+      def subscribe(email, attrs, list_id)
+        bogus_response
+      end
+
+      def unsubscribe(email, list_id)
+        bogus_response
+      end
+
+      def send_triggered_email(email_key, email, attrs = {})
+        bogus_response
+      end
+
+      def method_missing(method, *args)
+        return true if @@supported_methods.include? method
+        super
+      end
+
+      private
+
+      def bogus_response
+        response = OpenStruct.new()
+        response["success?"] = true
+        Workarea::SalesforceEsp::Response.new(response)
+      end
+    end
+  end
+end

data/lib/workarea/salesforce_esp/engine.rb

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

data/lib/workarea/salesforce_esp/gateway.rb

@@ -0,0 +1,116 @@
+module Workarea
+  module SalesforceEsp
+    class Gateway
+      class SalesforceEspSubscriptionError < StandardError; end
+      class SalesforceEspEmailError < StandardError; end
+      class SalesforceEspListError < StandardError; end
+
+      def initialize(options = {})
+        @client = MarketingCloudSDK::Client.new(
+          'client' => {
+            'id' => options[:client_id],
+            'secret' => options[:secret],
+            'account_id' => options[:account_id],
+            'use_oAuth2_authentication' => true,
+            'request_token_url' => options[:request_token_url]
+          }
+        )
+      end
+
+      def subscribe(email, attrs, list_id)
+        raise SalesforceEspListError, 'No List ID error' unless list_id.present?
+
+        subscriber = build_subscriber(email, "Active", attrs, list_id)
+        response = perform_api_call(subscriber, "post")
+
+        if response.failure?
+          if response.subscriber_already_exists?
+            response = update_subscriber(email, "Active", attrs, list_id)
+          end
+        end
+
+        response
+      end
+
+      def unsubscribe(email, list_id)
+        subscriber = build_subscriber(email, "Unsubscribed", {}, list_id)
+        response = perform_api_call(subscriber, "patch")
+
+        if response.failure? && !response.user_not_found?
+          raise SalesforceEspSubscriptionError, response.status_message
+        end
+
+        response
+      end
+
+      def update_subscriber(email, status, attrs, list_id)
+        subscriber = build_subscriber(email, status, attrs, list_id)
+        response = perform_api_call(subscriber, "patch")
+
+        if response.failure? && !response.subscriber_already_exists?
+          raise SalesforceEspSubscriptionError, response.status_message
+        end
+
+        response
+      end
+
+      def write_to_data_extension(data_extension, attrs)
+        ex = ET_DataExtension::Row.new
+        ex.authStub = @client
+        ex.Name = data_extension
+        ex.props = attrs
+
+        perform_api_call(ex, 'post')
+      end
+
+      def send_triggered_email(email_key, email, attrs = {})
+        triggered_send = MarketingCloudSDK::TriggeredSend.new
+        triggered_send.authStub = @client
+        triggered_send.props = {
+          "CustomerKey" => email_key
+        }
+        triggered_send.subscribers = [
+          {
+            "EmailAddress" => email,
+            "SubscriberKey" => email,
+            "Attributes" => build_subscriber_attributes(attrs)
+          }
+        ]
+
+        response = Response.new(triggered_send.send)
+
+        raise SalesforceEspEmailError, response.status_message unless response.success?
+
+        response
+      end
+
+      private
+
+      def build_subscriber(email, status, attrs, list_id)
+        subscriber = MarketingCloudSDK::Subscriber.new
+        subscriber.authStub = @client
+        subscriber.props = {
+          "EmailAddress" => email,
+          "SubscriberKey" => email,
+          "Status" => "Active",
+          "Attributes" => build_subscriber_attributes(attrs),
+          "Lists" => { "ID" => list_id, "Status" => status }
+        }
+        subscriber
+      end
+
+      def build_subscriber_attributes(attrs)
+        attributes = []
+        attrs.each do |key, value|
+          attributes.push({ "Name" => key, "Value" => value })
+        end
+        attributes
+      end
+
+      def perform_api_call(obj, method)
+        results = obj.send(method.to_sym)
+        SalesforceEsp::Response.new(results)
+      end
+    end
+  end
+end

data/lib/workarea/salesforce_esp/response.rb

@@ -0,0 +1,34 @@
+module Workarea
+  module SalesforceEsp
+    class Response
+      attr_reader :success, :message, :status_message, :results
+
+      def initialize(response)
+        @success = response.success?
+        @message = response.message
+        @results = response.results
+        @status_message = results.first[:status_message] if results.present?
+      end
+
+      def subscriber_already_exists?
+        message == 'Error' && status_message == 'The subscriber is already on the list'
+      end
+
+      def user_not_found?
+        message == 'Error' && status_message == 'The subscriber was not found.'
+      end
+
+      def excluded_by_list_detective?
+        message == 'Error' && results.first[:subscriber_failures][:error_description] == 'Error Code: 24 - Subscriber was excluded by List Detective.'
+      end
+
+      def success?
+        success
+      end
+
+      def failure?
+        !success
+      end
+    end
+  end
+end

data/lib/workarea/salesforce_esp/subscriber.rb

@@ -0,0 +1,15 @@
+module Workarea
+  module SalesforceEsp
+    class Subscriber
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def subscriber_key
+        data[:subscriber_key]
+      end
+    end
+  end
+end

data/lib/workarea/salesforce_esp/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module SalesforceEsp
+    VERSION = "1.0.0".freeze
+  end
+end

data/test/dummy/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// 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 any plugin's vendor/assets/javascripts directory 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
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end