-
-
Notifications
You must be signed in to change notification settings - Fork 196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace Mailchimp with a Flodesk integration #2162
Open
gnclmorais
wants to merge
1
commit into
codebar:master
Choose a base branch
from
gnclmorais:me-from-mailchimp-to-flowdesk
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,31 @@ | ||
| - 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' | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| require 'faraday' | ||
|
|
||
| module Flodesk | ||
| # Subscriber status | ||
| ACTIVE = 'active'.freeze | ||
|
|
||
| class Client | ||
| API_ENDPOINT = 'https://api.flodesk.com/v1/'.freeze | ||
| 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, :debug, :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, complete_timeout: nil, open_timeout: 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 | ||
| end | ||
|
|
||
| def disabled? | ||
| !@api_key | ||
| end | ||
|
|
||
| def subscribe(email:, first_name:, last_name:, segment_ids:, double_optin: true) | ||
| body = { email:, first_name:, last_name:, segment_ids:, double_optin: } | ||
|
|
||
| request(:post, 'subscribers', body) | ||
| end | ||
|
|
||
| def unsubscribe(email:, segment_ids:) | ||
| body = { segment_ids: } | ||
|
|
||
| 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 | ||
| options = { | ||
| headers: { | ||
| user_agent: 'codebar (codebar.io)' | ||
| }, | ||
| request: { | ||
| timeout: @complete_timeout, | ||
| open_timeout: @open_timeout | ||
| } | ||
| } | ||
|
|
||
| # https://lostisland.github.io/faraday/#/customization/request-options | ||
| @connection ||= 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 | ||
|
|
||
| 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 => e | ||
| FlodeskError.new(e.response_body['message'], { | ||
| raw_body: e.response_body, | ||
| status_code: e.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 | ||
| %i[status_code raw_body].map do |attr| | ||
| attr_value = send(attr) | ||
|
|
||
| "@#{attr}=#{attr_value.inspect}" | ||
| end.join(', ') | ||
| end | ||
| end | ||
| end |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before release, this snippet has to come from codebar’s Flodesk account (right now this came from my test one).