Replace Mailchimp with a Flodesk integration

This will allow us to reduce emailing costs by a factor of 10.

Author: gnclmorais

Gemfile

@@ -48,7 +48,7 @@ gem 'tzinfo-data'
 gem 'chosen-rails'
 gem 'commonmarker'
 
-gem 'gibbon', '~> 3.5.0'
+gem 'faraday'
 
 gem 'stripe'
 
@@ -84,6 +84,7 @@ group :development, :test do
   gem 'fabrication'
   gem 'faker'
   gem 'launchy'
+  gem 'pry-rails'
   gem 'pry-byebug'
   gem 'pry-remote'
   gem 'rspec-collection_matchers'

Gemfile.lock

@@ -171,9 +171,6 @@ GEM
     foreman (0.87.2)
     friendly_id (5.5.1)
       activerecord (>= 4.0.0)
-    gibbon (3.5.0)
-      faraday (>= 1.0)
-      multi_json (>= 1.11.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
     haml (6.3.0)
@@ -230,7 +227,6 @@ GEM
     mini_portile2 (2.8.7)
     minitest (5.25.1)
     msgpack (1.7.2)
-    multi_json (1.15.0)
     multi_xml (0.6.0)
     net-http (0.4.1)
       uri
@@ -293,6 +289,8 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
+    pry-rails (0.3.11)
+      pry (>= 0.13.0)
     pry-remote (0.1.8)
       pry (~> 0.9)
       slop (~> 3.0)
@@ -511,10 +509,10 @@ DEPENDENCIES
   dotenv-rails
   fabrication
   faker
+  faraday
   font_awesome5_rails
   foreman
   friendly_id
-  gibbon (~> 3.5.0)
   haml
   high_voltage
   icalendar
@@ -535,6 +533,7 @@ DEPENDENCIES
   pickadate-rails
   premailer-rails
   pry-byebug
+  pry-rails
   pry-remote
   public_activity
   puma (~> 6.4)

app/views/admin/contacts/index.html.haml

@@ -14,7 +14,7 @@
             %th Sponsor
             %th Contact name
             %th Contact email
-            %th Mailchimp
+            %th Mailing list
         %tbody
           - @contacts.each do |contact|
             %tr

app/views/shared/_newsletter.html.haml

@@ -1,32 +1,34 @@
+- content_for :head do
+  :javascript
+    (function(w, d, t, h, s, n) {
+      w.FlodeskObject = n;
+      var fn = function() {
+        (w[n].q = w[n].q || []).push(arguments);
+      };
+      w[n] = w[n] || fn;
+      var f = d.getElementsByTagName(t)[0];
+      var v = '?v=' + Math.floor(new Date().getTime() / (120 * 1000)) * 60;
+      var sm = d.createElement(t);
+      sm.async = true;
+      sm.type = 'module';
+      sm.src = h + s + '.mjs' + v;
+      f.parentNode.insertBefore(sm, f);
+      var sn = d.createElement(t);
+      sn.async = true;
+      sn.noModule = true;
+      sn.src = h + s + '.js' + v;
+      f.parentNode.insertBefore(sn, f);
+    })(window, document, 'script', 'https://assets.flodesk.com', '/universal', 'fd');
+
 .row.justify-content-md-center
   .col-md-8
     %h2= t('homepage.newsletter.title')
     %p= t('homepage.newsletter.description')
 
-    -# Mailchimp Signup Form
-    #mc_embed_signup
-      %form.validate#mc-embedded-subscribe-form{ action: "https://codebar.us8.list-manage.com/subscribe/post?u=b4652d85b385945c79f2ffa2e&id=3798974cb3",
-                                                 method: "post",
-                                                 name: "mc-embedded-subscribe-form",
-                                                 target: "_blank",
-                                                 novalidate: true }
-        #mc_embed_signup_scroll
-          #indicates-required
-          .mc-field-group.mb-3
-            .d-flex.justify-content-between
-              %label.form-label{ for: "mce-EMAIL" }
-                Email Address
-                %span.asterisk *
-              %small
-                %span.asterisk * indicates required
-            %input.required.email.form-control#mce-EMAIL{ type: 'email', value: '', name: 'EMAIL' }
-
-          .clear#mce-responses
-            .response#mce-error-response{ style: 'display:none' }
-            .response#mce-success-response{ style: 'display:none' }
-
-          -# real people should not fill this in and expect good things - do not remove this or risk form bot signups
-          %div{ style: 'position: absolute; left: -5000px;', 'aria-hidden': 'true' }
-            %input{ type: 'text', name: 'b_b4652d85b385945c79f2ffa2e_3798974cb3', tabindex: '-1', value: '' }
-          .d-flex.justify-content-between.align-items-center
-            %input.btn.btn-primary#mc-embedded-subscribe{ type: 'submit', value: 'Subscribe', name: 'subscribe' }
+    -# Flodesk signup form
+    #fd-form-678b693a7ae9331608185173
+      :javascript
+        if (window.fd) window.fd('form', {
+          formId: '678b693a7ae9331608185173',
+          containerEl: '#fd-form-678b693a7ae9331608185173'
+        });

config/initializers/flodesk.rb

@@ -0,0 +1,9 @@
+require 'services/flodesk'
+
+key = Rails.env.test? ? 'test' : ENV['FLODESK_KEY']
+
+logger.warn 'Missing key for Flodesk' unless key
+
+Flodesk::Client.api_key = key
+Flodesk::Client.complete_timeout = 15
+Flodesk::Client.open_timeout = 15

config/initializers/mailchimp.rb

@@ -99,9 +99,6 @@ en:
       workshop_email_subject: "Regarding hosting a workshop"
     chapters:
       title: "Chapters"
-    newsletter:
-      title: Subscribe to our newsletter
-      description: Get regular updates about the codebar community. Be informed about upcoming events, jobs, scholarships and other learning opportunities.
     events:
       upcoming: "Upcoming Events"
     donation_platforms:
@@ -350,7 +347,7 @@ en:
   terms_and_conditions:
     title: 'Terms and Conditions'
     body: 'Before you can proceed you must first read our Code of Conduct and agree to abide by it.'
-    link_text: 'Read codebar''s Code of Conduct'
+    link_text: 'Read codebar’s Code of Conduct'
     accept: 'Accept'
     messages:
       notice: 'You have to accept the Terms and Conditions before you are able to proceed.'
@@ -461,11 +458,11 @@ en:
       unsubscribe: Unsubscribe from newsletter
     messages:
       mailing_list:
-        subscribe: 'You have subscribed to codebar''s newsletter'
-        unsubscribe: 'You have unsubscribed from codebar''s newsletter'
+        subscribe: 'You have subscribed to codebar’s newsletter'
+        unsubscribe: 'You have unsubscribed from codebar’s newsletter'
       group:
-        subscribe: 'You have subscribed to %{chapter}''s %{role} group'
-        unsubscribe: 'You have unsubscribed from %{chapter}''s %{role} group'
+        subscribe: 'You have subscribed to %{chapter}’s %{role} group'
+        unsubscribe: 'You have unsubscribed from %{chapter}’s %{role} group'
 
   pages:
     cookies:
@@ -716,7 +713,7 @@ en:
 
     labels:
       terms_and_conditions_form:
-        terms: 'I have read codebar''s Code of Conduct and agree with all of its terms.'
+        terms: 'I have read codebar’s Code of Conduct and agree with all of its terms.'
       workshop:
         description: Additional description
         virtual: Virtual workshop

config/locales/en.yml

@@ -0,0 +1,175 @@
+require 'faraday'
+
+module Flodesk
+  # Subscriber status
+  ACTIVE = 'active'.freeze
+
+  class Client
+    API_ENDPOINT = 'https://api.flodesk.com/v1/'
+    DEFAULT_TIMEOUT = 60
+
+    class_attribute :api_key
+    class_attribute :complete_timeout
+    class_attribute :open_timeout
+
+    # Allows for setting these values in `config/initializers/flodesk.rb`
+    class << self
+      def api_key
+        @@api_key
+      end
+
+      def complete_timeout
+        @@complete_timeout
+      end
+
+      def open_timeout
+        @@open_timeout
+      end
+    end
+
+    attr_accessor :api_endpoint
+    attr_accessor :debug
+    attr_accessor :logger
+
+    # We need 3 actions:
+    #
+    #   1. subscribe   --> params(list_id, email, first_name, last_name)
+    #      Documentation:  https://developers.flodesk.com/#tag/subscriber/operation/createOrUpdateSubscriber
+    #      Endpoint:       https://api.flodesk.com/v1/subscribers
+    #
+    #   2. unsubscribe --> params(list_id, email)
+    #      Documentation:  https://developers.flodesk.com/#tag/subscriber/operation/removeSubscriberFromSegments
+    #      Endpoint:       https://api.flodesk.com/v1/subscribers/{id_or_email}/segments
+    #
+    #   3. subscribed? --> params(list_id, email)
+    #      Documentation:  https://developers.flodesk.com/#tag/subscriber/operation/retrieveSubscriber
+    #      Endpoint:       https://api.flodesk.com/v1/subscribers/{id_or_email}
+
+    def initialize(api_key: nil, api_endpoint: nil, complete_timeout: nil, open_timeout: nil, debug: false, logger: nil)
+      @api_key = api_key || self.class.api_key || ENV['FLODESK_KEY']
+      @api_key = @api_key.strip if @api_key
+
+      @complete_timeout = complete_timeout || self.class.complete_timeout || DEFAULT_TIMEOUT
+      @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_TIMEOUT
+
+      # TODO
+      # @debug = debug || self.class.debug || false
+      # @logger = logger || self.class.logger || ::Logger.new(STDOUT)
+    end
+
+    def disabled?
+      !@api_key
+    end
+
+    def subscribe(email:, first_name:, last_name:, segment_ids:, double_optin: true)
+      body = {
+        email: email,
+        first_name: first_name,
+        last_name: last_name,
+        segment_ids: segment_ids,
+        double_optin: double_optin,
+      }
+
+      request(:post, "subscribers", body)
+    end
+
+    def unsubscribe(email:, segment_ids:)
+      body = {
+        segment_ids: segment_ids
+      }
+
+      response = request(:delete, "subscribers/#{email}/segments", body)
+    end
+
+    def subscribed?(email:, segment_ids:)
+      response = request(:get, "subscribers/#{email}")
+      body = OpenStruct.new(response[:body])
+
+      # If not subscribed, stop here
+      is_active = body.status.to_s.eql?(ACTIVE)
+      return false unless is_active
+
+      segment_ids.all? do |segment_id|
+        body.segments.any? { |segment| segment_id.to_s.eql?(segment["id"]) }
+      end
+    end
+
+    private
+
+    def connection
+      @connection ||= begin
+        options = {
+          headers: {
+            user_agent: "codebar (codebar.io)",
+          },
+          request: {
+            timeout: @complete_timeout,
+            open_timeout: @open_timeout,
+          },
+        }
+
+        # Config options: https://lostisland.github.io/faraday/#/customization/request-options
+        Faraday.new(url: API_ENDPOINT, **options) do |config|
+          config.request :json
+
+          # Beware: the order of these lines matter. Examples:
+          # - https://mattbrictson.com/blog/advanced-http-techniques-in-ruby#pitfall-raise_error-and-logger-in-the-wrong-order
+          # - https://stackoverflow.com/a/67182791/590525
+          config.response :raise_error
+          config.response :logger, Rails.logger, headers: true, bodies: true, log_level: :debug
+          config.response :json
+
+          # https://developers.flodesk.com/#section/Authentication/api_key
+          config.request :authorization, 'Basic', -> { @api_key }
+        end
+      end
+    end
+
+    def request(http_method, endpoint, body = {})
+      # Faraday's `delete` does not accept body at the time of writing
+      response = if http_method == :delete
+        connection.run_request(http_method, endpoint, body, nil)
+      else
+        connection.public_send(http_method, endpoint, body)
+      end
+
+      {
+        status: response.status,
+        body: JSON.parse(response.body)
+      }
+    rescue Faraday::Error => err
+      message = err.response_body["message"]
+
+      FlodeskError.new(message, {
+        raw_body: err.response_body,
+        status_code: err.response_status
+      })
+    end
+  end
+
+  # Inspired by https://github.com/amro/gibbon/blob/master/lib/gibbon/mailchimp_error.rb
+  class FlodeskError < StandardError
+    attr_reader :status_code, :raw_body
+
+    def initialize(message = "", params = {})
+      @status_code = params[:status_code]
+      @raw_body    = params[:raw_body]
+
+      super(message)
+    end
+
+    def to_s
+      super + " " + instance_variables_to_s
+    end
+
+    private
+
+    def instance_variables_to_s
+      [:status_code, :raw_body].map do |attr|
+        attr_value = send(attr)
+
+        "@#{attr}=#{attr_value.inspect}"
+      end.join(", ")
+    end
+  end
+end