paubox 0.2.3 → 0.3.0

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -1,14 +1,15 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "paubox_ruby"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'paubox_ruby'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mail/paubox.rb

@@ -1,19 +1,21 @@
-module Mail
-  class Paubox
-    attr_accessor :settings
-
-    def initialize(settings)
-      @settings = settings
-    end
-
-    def deliver!(mail)
-      client = ::Paubox::Client.new(settings)
-      response = client.send_mail(mail)
-      puts response
-    end
-  end
-
-  class Message
-    attr_accessor :source_tracking_id, :status, :allow_non_tls
-  end
-end
+# frozen_string_literal: true
+
+module Mail
+  class Paubox
+    attr_accessor :settings
+
+    def initialize(settings)
+      @settings = settings
+    end
+
+    def deliver!(mail)
+      client = ::Paubox::Client.new(settings)
+      response = client.send_mail(mail)
+      puts response
+    end
+  end
+
+  class Message
+    attr_accessor :source_tracking_id, :status, :allow_non_tls, :force_secure_notification
+  end
+end

data/lib/paubox.rb

@@ -1,22 +1,24 @@
-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/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/client.rb

@@ -1,81 +1,85 @@
-module Paubox
-  # Client sends API requests to Paubox API
-  class Client
-    require 'rest-client'
-    require 'ostruct'
-    attr_reader :api_key, :api_user, :api_host, :api_protocol, :api_version
-
-    def initialize(args = {})
-      args = defaults.merge(args)
-      @api_key = args[:api_key]
-      @api_user = args[:api_user]
-      @api_host = args[:api_host]
-      @api_protocol = args[:api_protocol]
-      @api_version = args[:api_version]
-      @test_mode = args[:test_mode]
-      @api_base_endpoint = api_base_endpoint
-      @allow_non_tls = args.fetch(:allow_non_tls, false)
-    end
-
-    def api_status
-      url = request_endpoint('status')
-      RestClient.get(url, accept: :json)
-    end
-
-    def send_mail(mail)
-      case mail
-      when Mail::Message
-        payload = MailToMessage.new(mail, { allow_non_tls: @allow_non_tls })
-                               .send_message_payload
-      when Hash
-        payload = Message.new(mail).send_message_payload
-      end
-      url = request_endpoint('messages')
-      response = RestClient.post(url, payload, auth_header)
-      if mail.class == Mail::Message
-        mail.source_tracking_id = JSON.parse(response.body)['sourceTrackingId']
-      end
-      JSON.parse(response.body)
-    end
-    alias deliver_mail send_mail
-
-    def email_disposition(source_tracking_id)
-      url = "#{request_endpoint('message_receipt')}?sourceTrackingId=#{source_tracking_id}"
-      response = RestClient.get(url, auth_header)
-      email_disposition = Paubox::EmailDisposition.new(JSON.parse(response.body))
-    end
-    alias message_receipt email_disposition
-
-    private
-
-    def auth_header
-      { accept: :json,
-        content_type: :json,
-        :Authorization => "Token token=#{@api_key}" }
-    end
-
-    def api_base_endpoint
-      "#{api_protocol}#{api_host}/#{api_version}/#{api_user}"
-    end
-
-    def request_endpoint(endpoint)
-      "#{api_base_endpoint}/#{endpoint}"
-    end
-
-    def defaults
-      { api_key: Paubox.configuration.api_key,
-        api_user: Paubox.configuration.api_user,
-        api_host: 'api.paubox.net',
-        api_protocol: 'https://',
-        api_version: 'v1',
-        test_mode: false }
-    end
-
-    # recursively converts a nested Hash into OpenStruct
-    def to_open_struct(hash)
-      OpenStruct.new(hash.each_with_object({}) do |(key, val), memo|
-        memo[key] = val.is_a?(Hash) ? to_open_struct(val) : val
-      end)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Paubox
+  # Client sends API requests to Paubox API
+  class Client
+    require 'rest-client'
+    require 'ostruct'
+    attr_reader :api_key, :api_user, :api_host, :api_protocol, :api_version
+
+    def initialize(args = {})
+      args = defaults.merge(args)
+      @api_key = args[:api_key]
+      @api_user = args[:api_user]
+      @api_host = args[:api_host]
+      @api_protocol = args[:api_protocol]
+      @api_version = args[:api_version]
+      @test_mode = args[:test_mode]
+      @api_base_endpoint = api_base_endpoint
+    end
+
+    def api_status
+      url = request_endpoint('status')
+      RestClient.get(url, accept: :json)
+    end
+
+    def send_mail(mail)
+      case mail
+      when Mail::Message
+        allow_non_tls = mail.allow_non_tls.nil? ? false : mail.allow_non_tls
+        payload = MailToMessage.new(mail, allow_non_tls: allow_non_tls)
+                               .send_message_payload
+      when Hash
+        payload = Message.new(mail).send_message_payload
+      when Paubox::Message
+        payload = mail.send_message_payload
+      end
+      url = request_endpoint('messages')
+      response = RestClient.post(url, payload, auth_header)
+      if mail.class == Mail::Message
+        mail.source_tracking_id = JSON.parse(response.body)['sourceTrackingId']
+      end
+      JSON.parse(response.body)
+    end
+    alias deliver_mail send_mail
+
+    def email_disposition(source_tracking_id)
+      url = "#{request_endpoint('message_receipt')}?sourceTrackingId=#{source_tracking_id}"
+      response = RestClient.get(url, auth_header)
+      email_disposition = Paubox::EmailDisposition.new(JSON.parse(response.body))
+    end
+    alias message_receipt email_disposition
+
+    private
+
+    def auth_header
+      { accept: :json,
+        content_type: :json,
+        Authorization: "Token token=#{@api_key}" }
+    end
+
+    def api_base_endpoint
+      "#{api_protocol}#{api_host}/#{api_version}/#{api_user}"
+    end
+
+    def request_endpoint(endpoint)
+      "#{api_base_endpoint}/#{endpoint}"
+    end
+
+    def defaults
+      { api_key: Paubox.configuration.api_key,
+        api_user: Paubox.configuration.api_user,
+        api_host: 'api.paubox.net',
+        api_protocol: 'https://',
+        api_version: 'v1',
+        test_mode: false }
+    end
+
+    # recursively converts a nested Hash into OpenStruct
+    def to_open_struct(hash)
+      OpenStruct.new(hash.each_with_object({}) do |(key, val), memo|
+        memo[key] = val.is_a?(Hash) ? to_open_struct(val) : val
+      end)
+    end
+  end
+end

data/lib/paubox/email_disposition.rb

@@ -1,57 +1,62 @@
-module Paubox
-  # Parses email dispositions from /v1/message_reciept response to friendly Ruby
-  class EmailDisposition
-    require 'time'
-    attr_reader :response, :raw_json_response, :source_tracking_id, :message_id,
-                :message_deliveries, :errors
-    MessageDelivery = Struct.new(:recipient, :status)
-    MessageDeliveryStatus = Struct.new(:delivery_status, :delivery_time,
-                                       :opened_status, :opened_time)
-    MessageMultiDeliveryStatus = Struct.new(:delivery_status, :delivery_time)
-    ResponseError = Struct.new(:code, :status, :title, :details)
-
-    def initialize(response)
-      @response = response
-      @raw_json_response = response.to_json
-      @source_tracking_id = response.dig('sourceTrackingId')
-      @message_data = response.dig('data', 'message')
-      @message_id = @message_data ? @message_data['id'] : nil
-      @message_deliveries ||= build_message_deliveries
-      @errors ||= build_errors
-    end
-
-    def errors?
-      errors.any?
-    end
-
-    def build_errors
-      return [] unless response['errors']
-      errors = response['errors']
-      errors.map { |e| ResponseError.new(e['code'], e['status'], e['title'], e['details']) }
-    end
-
-    private
-
-    def build_message_deliveries
-      return [] unless @message_data
-      deliveries = @message_data.fetch('message_deliveries', [])
-      deliveries.map do |delivery|
-        status = build_message_delivery_status(delivery['status'])
-        MessageDelivery.new(delivery['recipient'], status)
-      end
-    end
-
-    def build_message_delivery_status(stat)
-      delivery_status = stat['deliveryStatus']
-      delivery_time = stat['deliveryTime'].to_s.empty? ? nil : DateTime.parse(stat['deliveryTime'])
-      opened_status = stat['openedStatus'].to_s.empty? ? 'unopened' : stat['openedStatus']
-      opened_time = stat['openedTime'].to_s.empty? ? nil : DateTime.parse(stat['openedTime'])
-      return MessageMultiDeliveryStatus.new(delivery_status, delivery_time) if multi_recipient?
-      MessageDeliveryStatus.new(delivery_status, delivery_time, opened_status, opened_time)
-    end
-
-    def multi_recipient?
-      @message_data.fetch('message_deliveries', []).length > 1
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Paubox
+  # Parses email dispositions from /v1/message_reciept response to friendly Ruby
+  class EmailDisposition
+    require 'time'
+    attr_reader :response, :raw_json_response, :source_tracking_id, :message_id,
+                :message_deliveries, :errors
+    MessageDelivery = Struct.new(:recipient, :status)
+    MessageDeliveryStatus = Struct.new(:delivery_status, :delivery_time,
+                                       :opened_status, :opened_time)
+    MessageMultiDeliveryStatus = Struct.new(:delivery_status, :delivery_time)
+    ResponseError = Struct.new(:code, :status, :title, :details)
+
+    def initialize(response)
+      @response = response
+      @raw_json_response = response.to_json
+      @source_tracking_id = response.dig('sourceTrackingId')
+      @message_data = response.dig('data', 'message')
+      @message_id = @message_data ? @message_data['id'] : nil
+      @message_deliveries ||= build_message_deliveries
+      @errors ||= build_errors
+    end
+
+    def errors?
+      errors.any?
+    end
+
+    def build_errors
+      return [] unless response['errors']
+
+      errors = response['errors']
+      errors.map { |e| ResponseError.new(e['code'], e['status'], e['title'], e['details']) }
+    end
+
+    private
+
+    def build_message_deliveries
+      return [] unless @message_data
+
+      deliveries = @message_data.fetch('message_deliveries', [])
+      deliveries.map do |delivery|
+        status = build_message_delivery_status(delivery['status'])
+        MessageDelivery.new(delivery['recipient'], status)
+      end
+    end
+
+    def build_message_delivery_status(stat)
+      delivery_status = stat['deliveryStatus']
+      delivery_time = stat['deliveryTime'].to_s.empty? ? nil : DateTime.parse(stat['deliveryTime'])
+      opened_status = stat['openedStatus'].to_s.empty? ? 'unopened' : stat['openedStatus']
+      opened_time = stat['openedTime'].to_s.empty? ? nil : DateTime.parse(stat['openedTime'])
+      return MessageMultiDeliveryStatus.new(delivery_status, delivery_time) if multi_recipient?
+
+      MessageDeliveryStatus.new(delivery_status, delivery_time, opened_status, opened_time)
+    end
+
+    def multi_recipient?
+      @message_data.fetch('message_deliveries', []).length > 1
+    end
+  end
+end

data/lib/paubox/format_helper.rb

@@ -1,55 +1,60 @@
-module Paubox
-  # Utility methods for Message and MailToMessage
-  module FormatHelper
-    require 'base64'
-    BASE64_REGEX = %r(/^(?:[A-Za-z0-9+\/]{4}\n?)*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
-
-    def base64_encoded?(value)
-      return false unless value.is_a?(String)
-      !value.strip.match(BASE64_REGEX).nil?
-    end
-
-    def base64_encode_if_needed(str)
-      return str if base64_encoded?(str.to_s)
-      Base64.encode64(str.to_s)
-    end
-
-    # Converts hash keys to strings and maps them to expected JSON key.
-    # Also converts hashes in shallow arrays.
-    def convert_keys_to_json_version(hash)
-      converted = {}
-      hash.each_pair do |key, val|
-        converted[ruby_to_json_key(key)] = val.is_a?(Hash) ? convert_keys_to_json_version(val) : val
-        next unless val.is_a?(Array)
-        val.each_with_index { |el, i| val[i] = convert_keys_to_json_version(el) if el.is_a?(Hash) }
-      end
-      converted
-    end
-
-    def ruby_to_json_key(key)
-      { reply_to: 'reply-to', html_content: 'text/html', text_content: 'text/plain',
-        filename: 'fileName', file_name: 'fileName', content_type: 'contentType',
-        allow_non_tls: 'allowNonTLS' }[key] || key.to_s
-    end
-
-    # def get_values_whitelist(*vals)
-    #   vals.map { |k| next unless mail[k]; [ruby_to_json_key(k), mail[k]] }.to_h
-    # end
-
-    def string_or_array_to_array(object)
-      case object
-      when String
-        a = object.split(',').map { |str| squish(str) }
-      when Array
-        a = object.map { |s| squish(s) }
-      else
-        return []
-      end
-      a.reject(&:empty?)
-    end
-
-    def squish(str)
-      str.to_s.split.join(' ')
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Paubox
+  # Utility methods for Message and MailToMessage
+  module FormatHelper
+    require 'base64'
+    BASE64_REGEX = %r(/^(?:[A-Za-z0-9+\/]{4}\n?)*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/).freeze
+
+    def base64_encoded?(value)
+      return false unless value.is_a?(String)
+
+      !value.strip.match(BASE64_REGEX).nil?
+    end
+
+    def base64_encode_if_needed(str)
+      return str if base64_encoded?(str.to_s)
+
+      Base64.encode64(str.to_s)
+    end
+
+    # Converts hash keys to strings and maps them to expected JSON key.
+    # Also converts hashes in shallow arrays.
+    def convert_keys_to_json_version(hash)
+      converted = {}
+      hash.each_pair do |key, val|
+        converted[ruby_to_json_key(key)] = val.is_a?(Hash) ? convert_keys_to_json_version(val) : val
+        next unless val.is_a?(Array)
+
+        val.each_with_index { |el, i| val[i] = convert_keys_to_json_version(el) if el.is_a?(Hash) }
+      end
+      converted
+    end
+
+    def ruby_to_json_key(key)
+      { reply_to: 'reply-to', html_content: 'text/html', text_content: 'text/plain',
+        filename: 'fileName', file_name: 'fileName', content_type: 'contentType',
+        allow_non_tls: 'allowNonTLS', force_secure_notification: 'forceSecureNotification' }[key] || key.to_s
+    end
+
+    # def get_values_whitelist(*vals)
+    #   vals.map { |k| next unless mail[k]; [ruby_to_json_key(k), mail[k]] }.to_h
+    # end
+
+    def string_or_array_to_array(object)
+      case object
+      when String
+        a = object.split(',').map { |str| squish(str) }
+      when Array
+        a = object.map { |s| squish(s) }
+      else
+        return []
+      end
+      a.reject(&:empty?)
+    end
+
+    def squish(str)
+      str.to_s.split.join(' ')
+    end
+  end
+end