paubox 0.3.0 → 0.3.2

data/lib/paubox/mail_to_message.rb

@@ -1,94 +1,94 @@
-# frozen_string_literal: true
-
-module Paubox
-  # The MailToMessage class takes a Ruby Mail object and attempts to parse it
-  # into a Hash formatted for the JSON payload of HTTP api request.
-  class MailToMessage
-    include Paubox::FormatHelper
-    attr_reader :mail
-    require 'tempfile'
-
-    def initialize(mail, args = {})
-      @mail = mail
-      @allow_non_tls = args.fetch(:allow_non_tls, false)
-      @force_secure_notification = args.fetch(:force_secure_notification, nil)
-    end
-
-    def send_message_payload
-      { data: { message: convert_keys_to_json_version(build_parts) } }.to_json
-    end
-
-    private
-
-    def build_attachments
-      attachments = mail.attachments
-      return [] if attachments.empty?
-
-      packaged_attachments = []
-      attachments.each do |attch|
-        packaged_attachments << { content: convert_binary_to_base64(attch.body.decoded),
-                                  file_name: attch.filename,
-                                  content_type: attch.mime_type }
-      end
-      packaged_attachments
-    end
-
-    def build_content
-      content = {}
-      if mail.multipart?
-        html_content = mail.html_part.body.to_s if mail.html_part
-        text_content = mail.text_part.body.to_s if mail.text_part
-        content[:html_content] = base64_encode_if_needed(html_content) unless html_content.nil?
-        content[:text_content] = text_content unless text_content.nil?
-      elsif mail.content_type.to_s.include? 'text/html'
-        content[:html_content] = base64_encode_if_needed(mail.body.to_s)
-      else
-        content[:text_content] = mail.body.to_s
-      end
-      content
-    end
-
-    def build_headers
-      %i[from reply_to subject].map { |k| [k, mail[k].to_s] }.to_h
-    end
-
-    def build_force_secure_notification
-      if @force_secure_notification.instance_of?(String)
-        unless @force_secure_notification.to_s.empty? # if force_secure_notification is not nil or empty
-          force_secure_notification_val = @force_secure_notification.strip.downcase
-          if force_secure_notification_val == 'true'
-            return true
-          elsif force_secure_notification_val == 'false'
-            return false
-          else
-            return nil
-          end
-        end
-      end
-      nil
-    end
-
-    def build_parts
-      msg = {}
-      msg[:recipients] = string_or_array_to_array(mail.to)
-      msg[:cc] = string_or_array_to_array(mail.cc)
-      msg[:bcc] = string_or_array_to_array(mail.bcc)
-      msg[:allow_non_tls] = @allow_non_tls
-      @force_secure_notification = build_force_secure_notification
-      unless @force_secure_notification.nil?
-        msg[:force_secure_notification] = @force_secure_notification
-      end
-      msg[:headers] = build_headers
-      msg[:content] = build_content
-      msg[:attachments] = build_attachments
-      msg
-    end
-
-    def convert_binary_to_base64(f)
-      file = Tempfile.new(encoding: 'ascii-8bit')
-      file.write(f)
-      file.rewind
-      Base64.encode64(file.read)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Paubox
+  # The MailToMessage class takes a Ruby Mail object and attempts to parse it
+  # into a Hash formatted for the JSON payload of HTTP api request.
+  class MailToMessage
+    include Paubox::FormatHelper
+    attr_reader :mail
+    require 'tempfile'
+
+    def initialize(mail, args = {})
+      @mail = mail
+      @allow_non_tls = args.fetch(:allow_non_tls, false)
+      @force_secure_notification = args.fetch(:force_secure_notification, nil)
+    end
+
+    def send_message_payload
+      { data: { message: convert_keys_to_json_version(build_parts) } }.to_json
+    end
+
+    private
+
+    def build_attachments
+      attachments = mail.attachments
+      return [] if attachments.empty?
+
+      packaged_attachments = []
+      attachments.each do |attch|
+        packaged_attachments << { content: convert_binary_to_base64(attch.body.decoded),
+                                  file_name: attch.filename,
+                                  content_type: attch.mime_type }
+      end
+      packaged_attachments
+    end
+
+    def build_content
+      content = {}
+      if mail.multipart?
+        html_content = mail.html_part.body.to_s if mail.html_part
+        text_content = mail.text_part.body.to_s if mail.text_part
+        content[:html_content] = base64_encode_if_needed(html_content) unless html_content.nil?
+        content[:text_content] = text_content unless text_content.nil?
+      elsif mail.content_type.to_s.include? 'text/html'
+        content[:html_content] = base64_encode_if_needed(mail.body.to_s)
+      else
+        content[:text_content] = mail.body.to_s
+      end
+      content
+    end
+
+    def build_headers
+      %i[from reply_to subject].map { |k| [k, mail[k].to_s] }.to_h
+    end
+
+    def build_force_secure_notification
+      if @force_secure_notification.instance_of?(String)
+        unless @force_secure_notification.to_s.empty? # if force_secure_notification is not nil or empty
+          force_secure_notification_val = @force_secure_notification.strip.downcase
+          if force_secure_notification_val == 'true'
+            return true
+          elsif force_secure_notification_val == 'false'
+            return false
+          else
+            return nil
+          end
+        end
+      end
+      nil
+    end
+
+    def build_parts
+      msg = {}
+      msg[:recipients] = string_or_array_to_array(mail.to)
+      msg[:cc] = string_or_array_to_array(mail.cc)
+      msg[:bcc] = string_or_array_to_array(mail.bcc)
+      msg[:allow_non_tls] = @allow_non_tls
+      @force_secure_notification = build_force_secure_notification
+      unless @force_secure_notification.nil?
+        msg[:force_secure_notification] = @force_secure_notification
+      end
+      msg[:headers] = build_headers
+      msg[:content] = build_content
+      msg[:attachments] = build_attachments
+      msg
+    end
+
+    def convert_binary_to_base64(f)
+      file = Tempfile.new(encoding: 'ascii-8bit')
+      file.write(f)
+      file.rewind
+      Base64.encode64(file.read)
+    end
+  end
+end

data/lib/paubox/message.rb

@@ -1,98 +1,98 @@
-# frozen_string_literal: true
-
-module Paubox
-  # The Message class is for building a Paubox email message using a hash.
-  class Message
-    include Paubox::FormatHelper
-    attr_accessor :from, :to, :cc, :bcc, :subject, :reply_to, :text_content,
-                  :html_content, :allow_non_tls, :force_secure_notification
-
-    def initialize(args)
-      @from = args[:from]
-      @to = args[:to]
-      @cc = args[:cc]
-      @bcc = args[:bcc]
-      @subject = args[:subject]
-      @reply_to = args[:reply_to]
-      @text_content = args[:text_content]
-      @html_content = args[:html_content]
-      @packaged_attachments = []
-      @attachments = build_attachments(args[:attachments])
-      @allow_non_tls = args.fetch(:allow_non_tls, false)
-      @force_secure_notification = args.fetch(:force_secure_notification, nil)
-    end
-
-    def send_message_payload
-      { data: { message: convert_keys_to_json_version(build_parts) } }.to_json
-    end
-
-    def add_attachment(file_path)
-      @packaged_attachments << { filename: file_path.split('/').last,
-                                 content_type: `file --b --mime-type #{file_path}`.chomp,
-                                 content: Base64.encode64(File.read(file_path)) }
-    end
-
-    def attachments
-      @packaged_attachments
-    end
-
-    def attachments=(args)
-      @attachments = build_attachments(args)
-    end
-
-    private
-
-    def build_attachments(args)
-      return (@packaged_attachments = []) if args.to_a.empty?
-
-      args.each do |a|
-        a[:content] = base64_encode_if_needed(a[:content])
-        @packaged_attachments << a
-      end
-      @packaged_attachments
-    end
-
-    def build_content
-      content = {}
-      content[:text_content] = text_content if text_content
-      content[:html_content] = base64_encode_if_needed(html_content) if html_content
-      content
-    end
-
-    def build_headers
-      %i[from reply_to subject].map { |k| [k, send(k)] }.to_h
-    end
-
-    def build_force_secure_notification
-      if @force_secure_notification.instance_of?(String)
-        unless @force_secure_notification.to_s.empty? # if force_secure_notification is not nil or empty
-          force_secure_notification_val = @force_secure_notification.strip.downcase
-          if force_secure_notification_val == 'true'
-            return true
-          elsif force_secure_notification_val == 'false'
-            return false
-          else
-            return nil
-          end
-        end
-      end
-      nil
-    end
-
-    def build_parts
-      msg = {}
-      msg[:recipients] = string_or_array_to_array(to)
-      msg[:cc] = string_or_array_to_array(cc)
-      msg[:allow_non_tls] = @allow_non_tls
-      @force_secure_notification = build_force_secure_notification
-      unless @force_secure_notification.nil?
-        msg[:force_secure_notification] = @force_secure_notification
-      end
-      msg[:bcc] = string_or_array_to_array(bcc)
-      msg[:headers] = build_headers
-      msg[:content] = build_content
-      msg[:attachments] = attachments
-      msg
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Paubox
+  # The Message class is for building a Paubox email message using a hash.
+  class Message
+    include Paubox::FormatHelper
+    attr_accessor :from, :to, :cc, :bcc, :subject, :reply_to, :text_content,
+                  :html_content, :allow_non_tls, :force_secure_notification
+
+    def initialize(args)
+      @from = args[:from]
+      @to = args[:to]
+      @cc = args[:cc]
+      @bcc = args[:bcc]
+      @subject = args[:subject]
+      @reply_to = args[:reply_to]
+      @text_content = args[:text_content]
+      @html_content = args[:html_content]
+      @packaged_attachments = []
+      @attachments = build_attachments(args[:attachments])
+      @allow_non_tls = args.fetch(:allow_non_tls, false)
+      @force_secure_notification = args.fetch(:force_secure_notification, nil)
+    end
+
+    def send_message_payload
+      { data: { message: convert_keys_to_json_version(build_parts) } }.to_json
+    end
+
+    def add_attachment(file_path)
+      @packaged_attachments << { filename: file_path.split('/').last,
+                                 content_type: `file --b --mime-type #{file_path}`.chomp,
+                                 content: Base64.encode64(File.read(file_path)) }
+    end
+
+    def attachments
+      @packaged_attachments
+    end
+
+    def attachments=(args)
+      @attachments = build_attachments(args)
+    end
+
+    private
+
+    def build_attachments(args)
+      return (@packaged_attachments = []) if args.to_a.empty?
+
+      args.each do |a|
+        a[:content] = base64_encode_if_needed(a[:content])
+        @packaged_attachments << a
+      end
+      @packaged_attachments
+    end
+
+    def build_content
+      content = {}
+      content[:text_content] = text_content if text_content
+      content[:html_content] = base64_encode_if_needed(html_content) if html_content
+      content
+    end
+
+    def build_headers
+      %i[from reply_to subject].map { |k| [k, send(k)] }.to_h
+    end
+
+    def build_force_secure_notification
+      if @force_secure_notification.instance_of?(String)
+        unless @force_secure_notification.to_s.empty? # if force_secure_notification is not nil or empty
+          force_secure_notification_val = @force_secure_notification.strip.downcase
+          if force_secure_notification_val == 'true'
+            return true
+          elsif force_secure_notification_val == 'false'
+            return false
+          else
+            return nil
+          end
+        end
+      end
+      nil
+    end
+
+    def build_parts
+      msg = {}
+      msg[:recipients] = string_or_array_to_array(to)
+      msg[:cc] = string_or_array_to_array(cc)
+      msg[:allow_non_tls] = @allow_non_tls
+      @force_secure_notification = build_force_secure_notification
+      unless @force_secure_notification.nil?
+        msg[:force_secure_notification] = @force_secure_notification
+      end
+      msg[:bcc] = string_or_array_to_array(bcc)
+      msg[:headers] = build_headers
+      msg[:content] = build_content
+      msg[:attachments] = attachments
+      msg
+    end
+  end
+end

data/lib/paubox/templated_message.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Paubox
+  # The TemplatedMessage class is for building a Paubox email message from a dynamic template, using a hash.
+  class TemplatedMessage < Message
+    attr_accessor :template_name,
+                  :template_values
+                  
+    def initialize(args)
+      @template_name = args[:template][:name]
+      @template_values = args[:template][:values]
+
+      super
+    end
+
+    def send_message_payload
+      # template name and values must be outside the `message` object
+      msg = convert_keys_to_json_version(build_parts)
+
+      template_params = {
+        template_name: @template_name,
+        template_values: @template_values.to_json
+      }
+
+      { data: { message: convert_keys_to_json_version(build_parts) }.merge(template_params) }.to_json
+    end
+  end
+end

data/lib/paubox/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module Paubox
-  VERSION = '0.3.0'
-end
+# frozen_string_literal: true
+
+module Paubox
+  VERSION = '0.3.2'
+end

data/lib/paubox.rb

@@ -1,24 +1,25 @@
-# frozen_string_literal: true
-
-require 'paubox/version'
-require 'paubox/client'
-require 'paubox/format_helper'
-require 'paubox/mail_to_message'
-require 'paubox/message'
-require 'paubox/email_disposition'
-require 'mail/paubox'
-
-module Paubox
-  class << self
-    attr_accessor :configuration
-  end
-
-  def self.configure
-    self.configuration ||= Configuration.new
-    yield(configuration)
-  end
-
-  class Configuration
-    attr_accessor :api_key, :api_user
-  end
-end
+# frozen_string_literal: true
+
+require 'paubox/version'
+require 'paubox/client'
+require 'paubox/format_helper'
+require 'paubox/mail_to_message'
+require 'paubox/message'
+require 'paubox/templated_message'
+require 'paubox/email_disposition'
+require 'mail/paubox'
+
+module Paubox
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key, :api_user
+  end
+end

data/lib/paubox_ruby.rb

@@ -1,3 +1,3 @@
-# frozen_string_literal: true
-
-require 'paubox'
+# frozen_string_literal: true
+
+require 'paubox'

data/paubox_ruby.gemspec

@@ -1,34 +1,34 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'paubox/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'paubox'
-  spec.version       = Paubox::VERSION
-  spec.authors       = ['Paubox', 'Jonathan Greeley']
-  spec.email         = ['jon.r.greeley@gmail.com']
-
-  spec.summary       = "Paubox's Official Ruby SDK"
-  spec.description   = 'Ruby SDK for interacting with the Paubox Transactional Email HTTP API.'
-  spec.homepage      = 'https://www.paubox.com'
-  spec.license       = 'Apache-2.0'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3'
-  spec.add_development_dependency 'bundler', '~> 2.0.2'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'webmock', '~> 2.1'
-
-  spec.add_dependency 'mail', '>= 2.5'
-  spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
-end
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paubox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'paubox'
+  spec.version       = Paubox::VERSION
+  spec.authors       = ['Paubox']
+  spec.email         = ['engineering@paubox.com']
+
+  spec.summary       = "Paubox's Official Ruby SDK"
+  spec.description   = 'Ruby SDK for interacting with the Paubox Transactional Email HTTP API.'
+  spec.homepage      = 'https://www.paubox.com'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+
+  spec.add_dependency 'mail', '>= 2.5'
+  spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paubox
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Paubox
-- Jonathan Greeley
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -43,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +116,7 @@ dependencies:
         version: 2.0.2
 description: Ruby SDK for interacting with the Paubox Transactional Email HTTP API.
 email:
-- jon.r.greeley@gmail.com
+- engineering@paubox.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -138,6 +137,7 @@ files:
 - lib/paubox/format_helper.rb
 - lib/paubox/mail_to_message.rb
 - lib/paubox/message.rb
+- lib/paubox/templated_message.rb
 - lib/paubox/version.rb
 - lib/paubox_ruby.rb
 - paubox_ruby.gemspec
@@ -145,7 +145,7 @@ homepage: https://www.paubox.com
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.3.14
+signing_key:
 specification_version: 4
 summary: Paubox's Official Ruby SDK
 test_files: []