visit_widget_email 0.7.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91d0baeed3fc442f160e0f82fd051b0e21f7b66f14d25f8d9b113dfdfeaa154a
+  data.tar.gz: df5b79d1c3f59b1f1d5a1ed4171bfa4c03157c0b9286209e402a6aba14ce88f5
+SHA512:
+  metadata.gz: 1ae9d37e5b4d4f6a6a7434f1ff61a63a4f00038cd31d3a945e2522455b670e8159cd57603008fce3f27f7c8504d85f579a7122725d80b2a965660fef52e32dda
+  data.tar.gz: d87a24333af7d4177a495eb4f6eed296466b7be766feaa33fc192f678b91bc0ef15eb6f1ccfcba701133e664a691eec377e4d8ea1e1673c156d0d9ecc4649eb2

data/README.md

@@ -0,0 +1,70 @@
+# VisitWidgetMailer
+
+Short description and motivation.
+
+## Usage
+
+How to use my plugin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'visit_widget_email'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install visit_widget_email
+```
+
+## Usage
+
+### Command and Query
+
+`VisitWidgetEmail::Commands::SendEmail` is the command used to send emails
+anywhere in the app. The constructor takes these params:
+
+`mailer_class_name, mailer_action, client_id, params`
+
+Where params are the custom parameters for that particular mailer.
+
+For the command to work, you'll need to implement the
+`VisitWidgetEmail::Queries::GetEmailParamsFromClient` class. This query should
+have an `execute` method that takes in the client id and returns a
+VisitWidgetEmail::EmailParams object with these attributes set:
+
+- primary_color
+- host
+- logo_url
+- client_name
+- enable_email_links
+- ios_itunes_app_id
+- android_bundle_identifier
+
+### Mailers
+
+You'll want to have your `ApplicationMailer` inherit from `VisitWidgetEmail::Mailer`:
+
+```ruby
+class ApplicationMailer < VisitWidgetEmail::Mailer
+end
+```
+
+Your mailer methods should have `email_params` as the first parameter.
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'VisitWidgetEmail'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test

data/app/helpers/visit_widget_email/mailer_helper.rb

@@ -0,0 +1,78 @@
+module VisitWidgetEmail
+  module MailerHelper
+    def primary_button(url, text, color, width=180)
+      html = '<a href="' + url + '"
+          style="width: ' + width.to_s + 'px;
+          display: block;
+          height: 40px;
+          margin: 0 auto 0 auto;
+          margin-top: 20px;
+          border-radius: 5px;
+          text-decoration: none;
+          background-color: ' + color + ';">
+              <span 
+              style="display: block;
+              text-align: center;
+              color: white;
+              padding-top: 12px;
+              font-family: ''open sans'', helvetica, arial, sans-serif;"
+              >' +
+                text +
+             '</span>' +
+          '</a>'     
+      
+      return html.html_safe
+    end
+    
+    def title(&block)
+      html = '<p style="font-size: 120%; text-align: center;"><strong>' +
+        + capture(&block) + '</strong></p>'
+        
+      html.html_safe
+    end
+    
+    def primary_content(&block)
+      html = 
+        '<div style="border: 1px solid #656A71; 
+        width: 90%; 
+        margin: 0 auto 0 auto; 
+        background-color: white; 
+        -webkit-box-shadow: 0px 0px 6px 0px rgba(50, 50, 50, 0.2);
+        -moz-box-shadow: 0px 0px 6px 0px rgba(50, 50, 50, 0.2);
+        box-shadow: 0px 0px 6px 0px rgba(50, 50, 50, 0.2);">' + 
+        capture(&block) + '</div>'
+      
+      html.html_safe
+    end
+    
+    def message(&block)
+      html =
+        '<div class="message" 
+      	      style="text-align: center; 
+      	             font-family: ''open sans'', helvetica, arial, sans-serif; 
+      	             font-weight: 100; 
+      	             color: #656A71; 
+                     margin-top: 16px;
+                     margin-bottom: 16px;
+                     padding-left: 10px; 
+                     padding-right: 10px;">' + 
+        capture(&block) + '</div>'
+      
+      html.html_safe
+    end
+    
+    def message_with_centered_text_and_left_justified(&block)
+      html =
+        '<div style="text-align: center;">
+          <div class="message" 
+           style="font-family: ''open sans'', helvetica, arial, sans-serif; 
+           font-weight: 100; 
+           color: #656A71; padding-left: 10px; padding-right: 10px;
+           display: inline-block; text-align: left;">' + 
+            capture(&block) + '</div></div><br />'
+      
+      html.html_safe
+    end
+
+  end
+end

data/app/mailers/visit_widget_email/mailer.rb

@@ -0,0 +1,5 @@
+module VisitWidgetEmail
+  class Mailer < ActionMailer::Base
+    include VisitWidgetEmail::MailerDefaults
+  end
+end

data/app/mailers/visit_widget_email/mailer_defaults.rb

@@ -0,0 +1,19 @@
+module VisitWidgetEmail
+  module MailerDefaults
+    extend ActiveSupport::Concern 
+    
+    included do
+      helper "visit_widget_email/mailer"
+      layout 'layouts/visit_widget_email/email' 
+      before_action :set_sendgrid_header
+      default from: Proc.new { 
+        VisitWidgetEmail::Settings.no_reply_email_address(@email_params) 
+      }
+    end
+
+    def set_sendgrid_header
+      headers['X-SMTPAPI'] = '{"asm_group_id": "' + 
+        ENV["SENDGRID_ALL_UNSUBSCRIBE_GROUP_ID"].to_s + '"}'
+    end
+  end
+end

data/app/views/layouts/visit_widget_email/email.html.erb

@@ -0,0 +1,86 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+	<body>
+		<div style="background-color: #F7F7F7">
+			<div class="header" 
+			style="width: 100%; 
+			background-color: <%= @email_params.primary_color %>; 
+			height: 50px;"
+			>
+		    <%= link_to root_url(host: @email_params.host) do %>
+				  <img src="<%= @email_params.logo_url  %>" 
+            style="display: block; margin: 0 auto 0 auto;" />
+		    <% end %>
+			</div>
+
+		  <%= yield %>
+			<% if @email_params.enable_email_links %>
+				<p style="text-align: center;">
+					<strong>
+						<%= t("email.get_mobile_app_line", 
+              client_name: @email_params.client_name) %>
+					</strong> 
+				</p>
+				<table style="margin-left: auto; margin-right: auto; 
+        border-collapse: collapse;">
+          <tr>
+            <% if @email_params.ios_itunes_app_id.present? %>
+              <td style="padding: 0; margin: 0;">
+                <a href="<%= "https://itunes.apple.com/us/app/id#{@email_params.ios_itunes_app_id}" %>">
+                  <% apple_logo_file_name = 
+                    "apple_app_store_logo_#{I18n.locale}.png" %>
+                  <% attachments.inline[apple_logo_file_name] =
+                    File.read(
+                      File.expand_path("images/#{apple_logo_file_name}", 
+                        __dir__)
+                    )
+                  %>
+                  <%= image_tag attachments[apple_logo_file_name].url, 
+                    style: "width: 168px; height: 50px; margin-right: 8px;" %>
+                </a>
+              </td>
+            <% end %>
+            <% if @email_params.android_bundle_identifier.present? %>
+              <td style="padding: 0; margin: 0;">
+                <a href="<%= 
+                  "http://play.google.com/store/apps/details?id="\
+                  "#{@email_params.android_bundle_identifier}" %>">
+                  <% google_logo_file_name = 
+                    "google_app_store_logo_#{I18n.locale}.png" %>
+                  <% attachments.inline[google_logo_file_name] =
+                    File.read(
+                      File.expand_path("images/#{google_logo_file_name}", 
+                        __dir__)
+                    )
+                  %>
+                  <%= image_tag attachments[google_logo_file_name].url, 
+                    style: "width: 168px; height: 50px;" %>
+                </a>
+              </td>
+            <% end %>
+          </tr>
+				</table>
+			<% end %>
+		</div>
+
+		<div style="margin-top: 50px; border-top: 1px solid #D3D3D3; 
+    background-color: white;">
+			<div class="footer_container" style="width: 90%;">
+
+				<p class="unsuscribe" style="text-decoration: none; color: #656A71; 
+        font-family: 'open sans', helvetica, arial, sans-serif; 
+        font-size: 14px; font-weight: 100;"> 
+          <%%asm_preferences_url%>
+			  </p>
+				<p class="copywrite" style="text-decoration: none; color: #656A71;
+        font-family: 'open sans', helvetica, arial, sans-serif;
+        font-size: 14px; font-weight: 100;"> 
+		      <%= t("email.copyright_notice") %>
+        </p>
+		 	</div>
+		</div>
+	</body>
+</html>

data/config/locales/de.yml

@@ -0,0 +1,5 @@
+de:
+  email:
+    get_mobile_app_line:
+      "%{client_name} Steigen Sie in den App Store oder Google Play!"
+    copyright_notice: © VisitWidget. Alle Rechte vorbehalten.

data/config/locales/en-GB.yml

@@ -0,0 +1,4 @@
+en-GB:
+  email:
+    get_mobile_app_line: Get %{client_name} on the App Store or Google Play!
+    copyright_notice: "\u00A9 VisitWidget. All Rights Reserved."

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  email:
+    get_mobile_app_line: Get %{client_name} on the App Store or Google Play!
+    copyright_notice: "\u00A9 VisitWidget. All Rights Reserved."

data/config/locales/es.yml

@@ -0,0 +1,4 @@
+es:
+  email:
+    get_mobile_app_line: "¡ %{client_name} Pon a la App Store o a Google Play!"
+    copyright_notice: "© VisitWidGet. Reservados todos los derechos."

data/config/locales/fr.yml

@@ -0,0 +1,4 @@
+fr:
+  email:
+    get_mobile_app_line: Obtenez %{client_name} sur l'App Store ou Google Play !
+    copyright_notice: © VisitWidget. Tous droits réservés.

data/config/locales/it.yml

@@ -0,0 +1,4 @@
+it:
+  email:
+    get_mobile_app_line: Ottieni %{client_name} su App Store o Google Play!
+    copyright_notice: "\u00A9 VisitWidget. Tutti i diritti riservati."

data/config/locales/nl.yml

@@ -0,0 +1,4 @@
+nl:
+  email:
+    get_mobile_app_line: Ottien %{client_name} su App Store o Google Play!
+    copyright_notice: "\u00A9 VisitWidget. Tutti i diritti riservati."

data/config/locales/pt-BR.yml

@@ -0,0 +1,4 @@
+pt-BR:
+  email:
+    get_mobile_app_line: Obtenha %{client_name} na App Store ou no Google Play!
+    copyright_notice: "\u00A9 VisitWidget. Todos os direitos reservados."

data/config/locales/zh-CN.yml

@@ -0,0 +1,4 @@
+zh-CN:
+  email:
+    get_mobile_app_line: 进入应用商店或谷歌 玩 %{client_name}
+    copyright_notice: â© 访问 Widget。保留所有权利。

data/lib/tasks/visit_widget_mailer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :visit_widget_mailer do
+#   # Task goes here
+# end

data/lib/visit_widget_email/commands/send_dynamic_template_email.rb

@@ -0,0 +1,75 @@
+require 'sendgrid-ruby'
+
+module VisitWidgetEmail
+  module Commands
+    class SendDynamicTemplateEmail
+      include SendGrid
+
+      def initialize(template_id, to, from = nil, dynamic_data = {}, locale = "en", attachments=[])
+        @template_id = template_id
+        @to = to
+        @from = from
+        @dynamic_data = dynamic_data
+        @locale = locale
+        @attachments = attachments
+      end
+      
+      def execute
+        validate()
+
+        data = {
+          "personalizations": [
+            {
+              "to": [
+                {
+                  "email": @to
+                }
+              ],
+              "dynamic_template_data": @dynamic_data
+            }
+          ],
+          "template_id": @template_id
+        }
+
+        if @from.present?
+          data[:from] = {
+            "email": @from
+          }
+        end
+
+        if @attachments.present?
+          data[:attachments] = @attachments
+        end
+
+        send_grid = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+        
+        response = send_grid.client.mail._("send").post(request_body: data)
+        error_message = "none"
+        if (response.body != "")
+          error = response.parsed_body[:errors].length > 0 ? response.parsed_body[:errors][0] : nil
+          error_message = error.nil? ? "" : error[:message]
+        end
+
+        # issue in certain environments with the api key, include small partial to verify key used
+        Rails.logger.info("Email response - to: #{@to}, status: #{response.status_code}, "\
+          "error message: #{error_message}, key: #{ENV['SENDGRID_API_KEY'][0...8]}, "\
+          "from: #{@from}, template_id: #{@template_id}")
+
+        return response
+      end
+
+      private
+
+      def validate
+        if @template_id.nil?
+          raise Exception.new "\"template_id\" is required"
+        end
+
+        if @to.nil?
+          raise Exception.new "\"to\" is required"
+        end
+      end
+      
+    end
+  end
+end

data/lib/visit_widget_email/commands/send_email.rb

@@ -0,0 +1,30 @@
+module VisitWidgetEmail
+  module Commands
+    class SendEmail
+      def initialize(mailer_params, client_id, locale, params)
+        @mailer_params = mailer_params.symbolize_keys
+        @client_id = client_id
+        @locale = locale
+        @params = params
+      end
+      
+      def execute
+        I18n.with_locale(@locale) do
+          mailer_class= @mailer_params[:class_name].constantize
+          
+          params = [create_app_email_params] + @params
+          message_delivery = mailer_class.send(@mailer_params[:action],
+            *params)
+          message_delivery.deliver_now
+        end
+      end
+      
+      private
+      
+      def create_app_email_params
+        query =  VisitWidgetEmail::Queries::GetEmailParamsFromClient.new
+        return query.execute(@client_id)
+      end
+    end
+  end
+end

data/lib/visit_widget_email/email_params.rb

@@ -0,0 +1,12 @@
+module VisitWidgetEmail
+  class EmailParams
+    attr_accessor :primary_color
+    attr_accessor :host
+    attr_accessor :logo_url
+    attr_accessor :client_name
+    attr_accessor :ios_itunes_app_id
+    attr_accessor :android_bundle_identifier
+    attr_accessor :enable_email_links
+    attr_accessor :host_with_optional_env
+  end
+end

data/lib/visit_widget_email/engine.rb

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

data/lib/visit_widget_email/settings.rb

@@ -0,0 +1,15 @@
+module VisitWidgetEmail
+  class Settings
+    def self.no_reply_email_address(email_params)
+      return "no-reply@#{email_params.host}"
+    end
+    
+    def self.unsubscribe_email_address
+      return "contact@visitwidget.com"
+    end   
+    
+    def self.default_domain
+      "visitwidget.com"
+    end 
+  end  
+end

data/lib/visit_widget_email/version.rb

@@ -0,0 +1,3 @@
+module VisitWidgetEmail
+  VERSION = '0.7.14'
+end

data/lib/visit_widget_email.rb

@@ -0,0 +1,9 @@
+require "visit_widget_email/engine"
+require "visit_widget_email/settings"
+require "visit_widget_email/email_params"
+require "visit_widget_email/commands/send_email"
+require "visit_widget_email/commands/send_dynamic_template_email"
+
+module VisitWidgetEmail
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: visit_widget_email
+version: !ruby/object:Gem::Version
+  version: 0.7.14
+platform: ruby
+authors:
+- Visit Widget
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sendgrid-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+description: Provides a email layout, mailer, and helper for emailsending in Visit
+  Widget apps.
+email:
+- development@visitwidget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/helpers/visit_widget_email/mailer_helper.rb
+- app/mailers/visit_widget_email/mailer.rb
+- app/mailers/visit_widget_email/mailer_defaults.rb
+- app/views/layouts/visit_widget_email/email.html.erb
+- app/views/layouts/visit_widget_email/images/apple_app_store_logo_de.png
+- app/views/layouts/visit_widget_email/images/apple_app_store_logo_en.png
+- app/views/layouts/visit_widget_email/images/apple_app_store_logo_es.png
+- app/views/layouts/visit_widget_email/images/apple_app_store_logo_fr.png
+- app/views/layouts/visit_widget_email/images/apple_app_store_logo_zn-CH.png
+- app/views/layouts/visit_widget_email/images/google_app_store_logo_de.png
+- app/views/layouts/visit_widget_email/images/google_app_store_logo_en.png
+- app/views/layouts/visit_widget_email/images/google_app_store_logo_es.png
+- app/views/layouts/visit_widget_email/images/google_app_store_logo_fr.png
+- app/views/layouts/visit_widget_email/images/google_app_store_logo_zn-CH.png
+- config/locales/de.yml
+- config/locales/en-GB.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- config/locales/nl.yml
+- config/locales/pt-BR.yml
+- config/locales/zh-CN.yml
+- lib/tasks/visit_widget_mailer_tasks.rake
+- lib/visit_widget_email.rb
+- lib/visit_widget_email/commands/send_dynamic_template_email.rb
+- lib/visit_widget_email/commands/send_email.rb
+- lib/visit_widget_email/email_params.rb
+- lib/visit_widget_email/engine.rb
+- lib/visit_widget_email/settings.rb
+- lib/visit_widget_email/version.rb
+homepage: https://github.com/visit-widget/visit_widget_email
+licenses:
+- Visit Widget LLC use only
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Provides a email layout, mailer, and helper for emailsending in Visit Widget
+  apps.
+test_files: []