paubox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b17ee76a0b045040db36865f166c659df8b29ba
+  data.tar.gz: 8618b773e3b75644e4480b815c66d3613e6a8ef1
+SHA512:
+  metadata.gz: 4eaa0bc9cb2d23b0aa7f36e1f2a1a30bcfaf798a4914857f273160b8c4bd60ea351145ae226fe5d2cf7c913c93b22574ef0f4d4770a50d4043ad1a843939f89c
+  data.tar.gz: d53e5917f0d7dbbefcad209a3b3a6bdc39b08bd0c1a5b8ffff85a5281772facb465df31d135baa88a2084b5eabcd10005b94c83eea96838609d33c5325b4629e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paubox_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2018 Paubox Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,28 @@
+# Paubox Gem
+This is the official Ruby wrapper for the Paubox Transactional Email HTTP API. The Paubox Transactional Email API allows your application to send secure, HIPAA-compliant email and track deliveries and opens. This gem is currently in pre-alpha development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paubox'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install paubox
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paubox/paubox_ruby.
+
+
+## License
+
+Copyright © 2018 Paubox, Inc. See LICENSE for details.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/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__)

data/bin/setup

@@ -0,0 +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

data/lib/mail/paubox.rb

@@ -0,0 +1,19 @@
+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
+  end
+end

data/lib/paubox.rb

@@ -0,0 +1,21 @@
+require 'paubox/version'
+require 'paubox/client'
+require 'paubox/format_helper'
+require 'paubox/mail_to_message'
+require 'paubox/message'
+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

@@ -0,0 +1,73 @@
+module Paubox
+  # Client sends API requests to Paubox API
+  class Client
+    require 'rest-client'
+    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)
+      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
+  end
+end

data/lib/paubox/format_helper.rb

@@ -0,0 +1,55 @@
+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

data/lib/paubox/mail_to_message.rb

@@ -0,0 +1,68 @@
+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)
+    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] = html_content unless html_content.empty?
+        content[:text_content] = text_content unless text_content.empty?
+      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_parts
+      msg = {}
+      msg[:recipients] = string_or_array_to_array(mail.to)
+      msg[:recipients] += string_or_array_to_array(mail.cc)
+      msg[:bcc] = string_or_array_to_array(mail.bcc)
+      msg[:allow_non_tls] = @allow_non_tls
+      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

@@ -0,0 +1,73 @@
+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
+
+    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)
+    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] = html_content if html_content
+      content
+    end
+
+    def build_headers
+      %i[from reply_to subject].map { |k| [k, self.send(k)] }.to_h
+    end
+
+    def build_parts
+      msg = {}
+      msg[:recipients] = string_or_array_to_array(to) + string_or_array_to_array(cc)
+      msg[:allow_non_tls] = @allow_non_tls
+      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/version.rb

@@ -0,0 +1,3 @@
+module Paubox
+  VERSION = "0.1.0"
+end

data/lib/paubox_ruby.rb

@@ -0,0 +1 @@
+require 'paubox'

data/paubox_ruby.gemspec

@@ -0,0 +1,32 @@
+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.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'mail', '~> 2.6', '>= 2.6.4'
+  spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: paubox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paubox
+- Jonathan Greeley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.4
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: Ruby SDK for interacting with the Paubox Transactional Email HTTP API.
+email:
+- jon.r.greeley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mail/paubox.rb
+- lib/paubox.rb
+- lib/paubox/client.rb
+- lib/paubox/format_helper.rb
+- lib/paubox/mail_to_message.rb
+- lib/paubox/message.rb
+- lib/paubox/version.rb
+- lib/paubox_ruby.rb
+- paubox_ruby.gemspec
+homepage: https://www.paubox.com
+licenses:
+- Apache-2.0
+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.13
+signing_key: 
+specification_version: 4
+summary: Paubox's Official Ruby SDK
+test_files: []