paubox 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71a4b58946b0869eac1768ba49c208950fc7d6f2
-  data.tar.gz: 704a4cf54c5ef966e0f060ad3186f7aab314ecca
+  metadata.gz: 1f0440a738fccb295099ca9e7851a3af6d5c3e76
+  data.tar.gz: 0e62063b19db76bc80286645cd160bc708a9812b
 SHA512:
-  metadata.gz: 89fa8a685e2170ee6ebbf87c2845c7eb3eb875576fc9fd002034d6c33c94fd159c04a0cd5f13985311de9b614ceb8d5f1bd589767b60fad5ebf2adb999497c58
-  data.tar.gz: 44ab568c8b28b5f77c376851865e0892bf17cbb59f1975e8af47a69be6202cd8ea9ac152aa6c79ff37dcf39497ccd4bc8565254e619876c7ed0d5e314d738b51
+  metadata.gz: 458522bb6529f2e8a04d3bd1b729bf0a42e0106d93e55e110e0d8b3bf1537fdb49fdd7694b09549debfb7377ab49f2c759076f5fe13fa44d8d80b1af7cba7448
+  data.tar.gz: 9804229b214ab1973f1fce4d3019f919be12511bffb8bb8109b250ebb5f419763a2e582c7e653f323b0386006eaf128420a7e41fb57010f522f1f3071b578b7e

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.gem

data/README.md

@@ -25,19 +25,20 @@ Or install it yourself as:
 You will need to have a Paubox account. Please contact [Paubox Customer Success](https://paubox.zendesk.com/hc/en-us) for details on gaining access to the Transactional Email API alpha testing program.
 
 ### Configuring API Credentials
-To set your API credentials you'll need to include these in an initializer (config/initializers/paubox.rb in Rails).
+Include your API credentials in an initializer (e.g. config/initializers/paubox.rb in Rails).
 
-Be careful not to commit your API credentials to version control. It's best to store these in environmental variables.
+Keep your API credentials out of version control. Store these in environmental variables.
 
 	Paubox.configure do |config|
      config.api_key = ENV['PAUBOX_API_KEY']
      config.api_user = ENV['PAUBOX_API_USER']
     end
 
+## Usage
 
 ### Sending Messages with the Ruby Mail Library
 
-If you're already using the Ruby Mail Library, sending via Paubox is easy. Just build your message as normal and set Mail::Paubox as the delivery method.
+Using the Ruby Mail Library? Sending via Paubox is easy. Just build a message as normal and set Mail::Paubox as the delivery method.
 
 	message = Mail.new do
       from            'you@yourdomain.com'
@@ -62,9 +63,9 @@ If you're already using the Ruby Mail Library, sending via Paubox is easy. Just
     message.source_tracking_id
     => "2a3c048485aa4cf6"
 
-### Sending Messages without ensuring TLS
+### Allowing non-TLS message delivery
 
-If you want to send non-PHI mail that does not need to be HIPAA-compliant, you can allow the message delivery to take place even if a TLS connection is unavailable.
+If you want to send non-PHI mail that does not need to be HIPAA-compliant, you can allow the message delivery to take place even if a TLS connection is unavailable. This means a message will not be converted into a secure portal message when a non-TLS connection is encountered.
 
 	message = Mail.new do
       from            'you@yourdomain.com'
@@ -79,22 +80,54 @@ If you want to send non-PHI mail that does not need to be HIPAA-compliant, you c
     message.deliver!
 
 ### Sending Messages using just the Paubox API
+You don't need to use Ruby Mail to build and send messages with Paubox.
 	
 	args = { from: 'you@yourdomain.com',
-	         to: 'someone@domain.com, someone_else@domain.com',
-             cc: ['another@domain.com', 'yetanother@domain.com'],
+	         to: 'someone@domain.com, someone-else@domain.com',
+             cc: ['another@domain.com', 'yet-another@domain.com'],
              bcc: 'bcc-recipient@domain.com',
              reply_to: 'reply-to@yourdomain.com',
              subject: 'Testing!',
              text_content: 'Hello World!',
              html_content: '<h1>Hello World!</h1>' }
              
-	message = Message.new(args)
+	message = Paubox::Message.new(args)
 	
 	client = Paubox::Client.new
 	client.deliver_mail(message)
 	=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}
 
+### Checking Email Dispositions
+
+	client = Paubox::Client.new
+	email_disposition = client.email_disposition('2a3c048485aa4cf6')
+	
+	# Get array of email_dispositions. One email_disposition is generated for each recipient.
+	message_deliveries = email_disposition.message_deliveries
+	=> [<struct Paubox::EmailDisposition::MessageDelivery recipient="test@domain.com", status=#<struct Paubox::EmailDisposition::MessageDeliveryStatus delivery_status="delivered", delivery_time=Mon, 30 Apr 2018 12:54:19 -0700, opened_status="opened", opened_time=Mon, 30 Apr 2018 12:55:19 -0700>>]
+	
+	# Inspect a message delivery
+	delivery = message_deliveries.first
+	
+	delivery.recipient
+	=> "test@domain.com"
+	
+	# Inspect the message delivery status
+	status = delivery.status
+	
+	status.delivery_status
+	=> "delivered"
+	
+	status.delivery_time
+	=> Mon, 30 Apr 2018 12:54:19 -0700
+	
+	# opened_status is only available for single-recipient messages
+	status.opened_status
+	=> "opened"
+	
+	# opened_time is only available for single-recipient messages
+	status.opened_time
+	=> Mon, 30 Apr 2018 12:55:19 -0700
 	
 
 

data/lib/paubox.rb

@@ -3,6 +3,7 @@ require 'paubox/client'
 require 'paubox/format_helper'
 require 'paubox/mail_to_message'
 require 'paubox/message'
+require 'paubox/email_disposition'
 require 'mail/paubox'
 
 module Paubox

data/lib/paubox/client.rb

@@ -2,6 +2,7 @@ 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 = {})
@@ -41,7 +42,7 @@ module Paubox
     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)
+      email_disposition = Paubox::EmailDisposition.new(JSON.parse(response.body))
     end
     alias message_receipt email_disposition
 
@@ -69,5 +70,12 @@ module Paubox
         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

@@ -0,0 +1,57 @@
+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/version.rb

@@ -1,3 +1,3 @@
 module Paubox
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/paubox_ruby.gemspec

@@ -20,13 +20,13 @@ Gem::Specification.new do |spec|
   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', '~> 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 'mail', '>= 2.6'
   spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paubox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Paubox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,22 +85,16 @@ dependencies:
   name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.4
+        version: '2.6'
   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
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -140,12 +134,12 @@ files:
 - lib/mail/paubox.rb
 - lib/paubox.rb
 - lib/paubox/client.rb
+- lib/paubox/email_disposition.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-0.1.0.gem
 - paubox_ruby.gemspec
 homepage: https://www.paubox.com
 licenses:
@@ -159,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="