hubspot-mailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84be921dddd2279d24cd15c9a4f0a182bba57e58
+  data.tar.gz: 27960c36c5cccfeb6a0a02835c3af5ef4fa3c4c6
+SHA512:
+  metadata.gz: c825a4740b1758e896823f147d7298b453163247753d863049604d9555cfb53b62f9e9679e6efaa0aa6e7bbf21e2dd55a80b460d50a0002ac33265874c49dfab
+  data.tar.gz: f3f538cdc9547886dec6ec50b6fb4a8ed77fe0ff6bc7dfc397112e0f0462e3f7b348b7e75a2a73f162afd1536f4ce2f970d3fed65dcb21866ed830a5e2857562

data/lib/hubspot-mailer.rb

@@ -0,0 +1,8 @@
+require 'action_mailer'
+require 'hubspot-ruby'
+require 'hubspot/mailer/delivery'
+require 'hubspot/mailer/exceptions'
+require 'hubspot/mailer/hubspot_preview_interceptor'
+require 'hubspot/mailer/message'
+require 'hubspot/mailer'
+

data/lib/hubspot/mailer.rb

@@ -0,0 +1,179 @@
+module Hubspot
+  class Mailer < ActionMailer::Base
+    abstract!
+
+    register_preview_interceptor(HubspotPreviewInterceptor)
+
+    # Register our own delivery method
+    add_delivery_method :hubspot, Delivery
+
+    # Set hubspot as a default delivery method
+    self.delivery_method = :hubspot
+
+    # Set credentials
+    # self.hubspot_settings = { :hapikey => ENV.fetch("HUBSPOT_API_KEY") }
+
+    self.default_params = {}.freeze
+
+    SINGLE_SEND_PATH = '/email/public/v1/singleEmail/send'.freeze
+
+    class << self
+      # Wraps an email delivery inside of <tt>ActiveSupport::Notifications</tt> instrumentation.
+      #
+      # This method is actually called by the <tt>Mail::Message</tt> object itself
+      # through a callback when you call <tt>:deliver</tt> on the <tt>Mail::Message</tt>,
+      # calling +deliver_mail+ directly and passing a <tt>Mail::Message</tt> will do
+      # nothing except tell the logger you sent the email.
+      def deliver_mail(mail) #:nodoc:
+        ActiveSupport::Notifications.instrument("deliver.hubspot_mailer") do |payload|
+          set_payload_for_mail(payload, mail)
+          yield # Let Mail do the delivery actions
+        end
+      end
+
+      # Perform the delivery by calling Hubspot's API
+      #
+      # Receives regular mail object that contains additional template details.
+      def single_send(mail)
+        # Format the request data
+        data = single_send_params(mail)
+
+        # Call the API
+        response = Hubspot::Connection.post_json(SINGLE_SEND_PATH, params: {}, body: data)
+
+        # Parse response and either raise or return event details
+        parse_response(response)
+      end
+
+      private
+
+      def set_payload_for_mail(payload, mail)
+        payload[:mailer]     = name
+        payload[:message_id] = mail.message_id
+        payload[:subject]    = mail.subject
+        payload[:to]         = mail.to
+        payload[:from]       = mail.from     if mail.from.present?
+        payload[:send_id]    = mail.send_id  if mail.send_id.present?
+        payload[:reply_to]   = mail.reply_to if mail.reply_to.present?
+        payload[:cc]         = mail.cc       if mail.cc.present?
+        payload[:bcc]        = mail.bcc      if mail.bcc.present?
+      end
+
+      def single_send_params(mail)
+        raise MissingTemplateError, "Missing emailId parameter." unless mail.email_id.present?
+        raise MissingRecipientError, "Missing recipient emaul."  unless mail.to.present?
+
+        data = {
+          emailId: mail.email_id,
+          message: { to: mail.to.first }
+        }
+
+        data[:message][:from]   = mail.from.first if mail.from.present?
+        data[:message][:cc]     = mail.cc         if mail.cc.present?
+        data[:message][:bcc]    = mail.bcc        if mail.bcc.present?
+        data[:message][:sendId] = mail.send_id    if mail.send_id.present?
+
+        if mail.reply_to.present?
+          if mail.reply_to.size > 1
+            data[:message][:replyToList] = mail.reply_to
+          else
+            data[:message][:replyTo] = mail.reply_to.first
+          end
+        end
+
+        # Copy subject from header to custom property
+        if mail.subject.present? and not mail.custom_properties.try(:[], :subject)
+          mail.custom_properties ||= {}
+          mail.custom_properties[:subject] = mail.subject
+        end
+
+        if mail.contact_properties.present?
+          data[:contactProperties] =
+            Hubspot::Utils.hash_to_properties(mail.contact_properties, :key_name => :name)
+        end
+
+        if mail.custom_properties.present?
+          data[:customProperties] =
+            Hubspot::Utils.hash_to_properties(mail.custom_properties, :key_name => :name)
+        end
+
+        data
+      end
+
+      def parse_response(response)
+        status_code = response["sendResult"]
+
+        case status_code
+          when "SENT", "QUEUED"
+            response["eventId"]
+          when "INVALID_TO_ADDRESS"
+            raise RecipientAddressError.new(response), "The TO address is invalid: #{status_code}"
+          when "INVALID_FROM_ADDRESS"
+            raise SenderAddressError.new(response), "The FROM address is invalid: #{status_code}"
+          when "BLOCKED_DOMAIN", "PORTAL_SUSPENDED"
+            raise SendingError.new(response), "Message can't be sent: #{status_code}"
+          when "PREVIOUSLY_BOUNCED", "PREVIOUS_SPAM"
+            raise DeliveryError.new(response), "Message can't be delivered: #{status_code}"
+          when "MISSING_CONTENT"
+            raise InvalidTemplateError.new(response), "The emailId is invalid, or the emailId is an email that is not set up for Single Send: #{status_code}"
+          else
+            raise UnknownResponseError.new(response), "Unrecognized status code: #{status_code}"
+        end
+      end
+    end
+
+    attr_internal :message
+
+    def initialize
+      super()
+      @_mail_was_called = false
+      @_message         = Message.new
+    end
+
+    def process(method_name, *args) #:nodoc:
+      payload = {
+        mailer: self.class.name,
+        action: method_name,
+        args:   args
+      }
+
+      ActiveSupport::Notifications.instrument("process.hubspot_mailer", payload) do
+        super
+        @_message = ActionMailer::Base::NullMail.new unless @_mail_was_called
+      end
+    end
+
+    def mail(headers = {}, &block)
+      return message if @_mail_was_called && headers.blank? && !block
+
+      headers = apply_defaults(headers)
+
+      # Set configure delivery behavior
+      wrap_delivery_behavior!(headers[:delivery_method], headers[:delivery_method_options])
+
+      # Hubspot-specific attributes, e.g. emailId (template ID)
+      assign_attributes_to_message(message, headers)
+
+      # Default headers
+      assign_headers_to_message(message, headers)
+
+      @_mail_was_called = true
+
+      message
+    end
+
+    private
+
+    def assign_attributes_to_message(message, headers)
+      hubspot_props = %i[email_id send_id contact_properties custom_properties]
+
+      headers.slice(*hubspot_props).each { |k, v| message.try("#{k}=", v) }
+      headers.except!(*hubspot_props)
+    end
+
+    def assign_headers_to_message(message, headers)
+      headers.except(:parts_order, :content_type, :body, :template_name,
+        :template_path, :delivery_method, :delivery_method_options).each { |k, v| message[k] = v }
+    end
+  end
+end

data/lib/hubspot/mailer/delivery.rb

@@ -0,0 +1,17 @@
+module Hubspot
+  class Mailer < ActionMailer::Base
+    class Delivery
+      attr_accessor :settings
+
+      DEFAULTS = {}
+
+      def initialize(values)
+        self.settings = DEFAULTS.merge(values)
+      end
+
+      def deliver!(mail)
+        Hubspot::Mailer.single_send(mail)
+      end
+    end
+  end
+end

data/lib/hubspot/mailer/exceptions.rb

@@ -0,0 +1,21 @@
+module Hubspot
+  class Mailer < ActionMailer::Base
+    class MissingTemplateError < StandardError; end
+    class MissingRecipientError < StandardError; end
+
+    class RequestError < StandardError
+      attr_reader :response
+
+      def initialize(response = nil)
+        @response = response
+      end
+    end
+
+    class RecipientAddressError < RequestError; end
+    class SenderAddressError < RequestError; end
+    class SendingError < RequestError; end
+    class DeliveryError < RequestError; end
+    class InvalidTemplateError < RequestError; end
+    class UnknownResponseError < RequestError; end
+  end
+end

data/lib/hubspot/mailer/hubspot_preview_interceptor.rb

@@ -0,0 +1,48 @@
+module Hubspot
+  class Mailer < ActionMailer::Base
+    class HubspotPreviewInterceptor
+      class << self
+        def previewing_email(message)
+          new(message).transform!
+        end
+      end
+
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def transform!
+        build_preview
+        message
+      end
+
+      private
+
+      def build_preview
+        html_part = "<b>Email ID (template)</b>: #{message.email_id}<br/><br/>"
+
+        html_part << list_properties("Contact Properties (use via {{contact.propertyname}})", message.contact_properties)
+        html_part << list_properties("Custom Properties (use via {{custom.property_name}})", message.custom_properties)
+
+        message.html_part = html_part
+
+        message
+      end
+
+      def list_properties(label, list)
+        buffer = ""
+        return buffer unless list.present?
+
+        buffer << "<b>#{label}</b>:<ul>"
+
+        list.each_pair do |property, value|
+          buffer << "<li><i>#{property}</i>: #{value}</li>"
+        end
+
+        buffer << "</ul>"
+      end
+    end
+  end
+end

data/lib/hubspot/mailer/message.rb

@@ -0,0 +1,10 @@
+module Hubspot
+  class Mailer < ActionMailer::Base
+    class Message < Mail::Message
+      attr_accessor :email_id
+      attr_accessor :send_id
+      attr_accessor :contact_properties
+      attr_accessor :custom_properties
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: hubspot-mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- heaven
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hubspot-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Create beautiful transactional emails right within HubSpot using the
+  email editor with all the benefits of smart content, personalization and templates
+  - just like regular HubSpot emails. Create beautiful transactional emails right
+  within HubSpot using the email editor with all the benefits of smart content, personalization
+  and templates - just like regular HubSpot emails. Create beautiful transactional
+  emails right within HubSpot using the email editor with all the benefits of smart
+  content, personalization and templates - just like regular HubSpot emails.
+email:
+- hello@codeart.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hubspot-mailer.rb
+- lib/hubspot/mailer.rb
+- lib/hubspot/mailer/delivery.rb
+- lib/hubspot/mailer/exceptions.rb
+- lib/hubspot/mailer/hubspot_preview_interceptor.rb
+- lib/hubspot/mailer/message.rb
+homepage: https://github.com/heaven/hubspot-mailer
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: HubSpot Single Send API SDK for use with Ruby on Rails
+test_files: []