paubox 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6385417dd81032791ac6552496137561e27aa435
-  data.tar.gz: dd150320e7ba927dfa0e83354917caad0a2f651f
+SHA256:
+  metadata.gz: a259c46c870059aff289a90bc661f86de6954c33b88ae75613dee3c9f15c1418
+  data.tar.gz: 4a5768c1ee7b711c91576ef7f43fc219150ed0c5f81512fe36269c09db825c8e
 SHA512:
-  metadata.gz: 221086699f1e8a9376bcb82ea4ba001a21c739612343ebb7c9492dc23fe13b570f0a358ceba705643a3149791d6d60c1e5292b3513a8c3743a75920eb2088f72
-  data.tar.gz: c80e028f4962360571e8044c0b9a76e544e4e762c590723603819b47067b2b9aa67a8c67e0ccd59c3f0478cf08f72dc8173bb60496c0a715267650cc7d90caeb
+  metadata.gz: 4285803ec83dd1f57b4407a4c0e7e177e1d571dcf6075b04707377c0286f1d76693858e69d6c6784d21245c286474025eb3514ddcb9414f2001891e6bcede3a5
+  data.tar.gz: 6e5b536a02e5df73675b255f6ed8080d3a5bf97a48f533bc2fb5f0e3189c8013cf7a373afffc957fe854335b07e074e1f2c858dbe50e2e64ab41ff7231c73aea

data/.gitignore

@@ -1,13 +1,14 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+
+# rspec failure tracking
+.rspec_status
 .gem

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

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

@@ -1,171 +1,230 @@
-<img src="https://github.com/Paubox/paubox-csharp/raw/master/paubox_logo.png" alt="Paubox" width="150px">
-
-# Paubox Gem
-This gem and Paubox Transactional Email HTTP API are currently in alpha development.
-
-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 via Paubox and track deliveries and opens.
-
-It extends the [Ruby Mail Library](https://github.com/mikel/mail) for seamless integration in your existing Ruby application. The API wrapper also allows you to construct and send messages directly without the Ruby Mail Library.
-
-# Table of Contents
-* [Installation](#installation)
-*  [Usage](#usage)
-*  [Contributing](#contributing)
-*  [License](#license)
-
-
-<a name="#installation"></a>
-## 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
-
-### Getting Paubox API Credentials
-You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/join/see-pricing?unit=messages).
-
-Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.
-
-### Configuring API Credentials
-Include your API credentials in an initializer (e.g. config/initializers/paubox.rb in Rails).
-
-Keep your API credentials out of version control. Store these in environmental variables.
-```ruby
-Paubox.configure do |config|
-  config.api_key = ENV['PAUBOX_API_KEY']
-  config.api_user = ENV['PAUBOX_API_USER']
-end
-```
-
-<a name="#usage"></a>
-## Usage
-
-### Sending Messages with the Ruby Mail Library
-
-Using the Ruby Mail Library? Sending via Paubox is easy. Just build a message as normal and set Mail::Paubox as the delivery method.
-```ruby
-message = Mail.new do
-  from            'you@yourdomain.com'
-  to              'someone@somewhere.com'
-  subject         'HIPAA-compliant email made easy'
-
-  text_part do
-    body          'This message will be sent securely by Paubox.'
-  end
-
-  html_part do
-    content_type  'text/html; charset=UTF-8'
-    body          '<h1>This message will be sent securely by Paubox.</h1>'
-  end
-
-  delivery_method Mail::Paubox
-end
-
-message.deliver!
-=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}
-
-message.source_tracking_id
-=> "2a3c048485aa4cf6"
-```
-
-### 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. This means a message will not be converted into a secure portal message when a non-TLS connection is encountered.
-```ruby
-message = Mail.new do
-  from            'you@yourdomain.com'
-  to              'someone@somewhere.com'
-  subject         'Sending non-PHI'
-  body            'This message delivery will not enforce TLS transmission.'
-
-  delivery_method Mail::Paubox
-end
-
-message.allow_non_tls = true
-message.deliver!
-```
-
-### Sending Messages using just the Paubox API
-You don't need to use Ruby Mail to build and send messages with Paubox.
-```ruby
-args = { from: 'you@yourdomain.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 = Paubox::Message.new(args)
-
-client = Paubox::Client.new
-client.deliver_mail(message)
-=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}
-```
-
-### Checking Email Dispositions
-```ruby
-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
-```
-
-<a name="#contributing"></a>
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/paubox/paubox_ruby.
-
-
-<a name="#license"></a>
-## License
-
-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.
-
-## Copyright
-Copyright &copy; 2018, Paubox Inc.
-
+<img src="https://github.com/Paubox/paubox-csharp/raw/master/paubox_logo.png" alt="Paubox" width="150px">
+
+# Paubox Gem
+This gem and Paubox Transactional Email HTTP API are currently in alpha development.
+
+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 via Paubox and track deliveries and opens.
+
+It extends the [Ruby Mail Library](https://github.com/mikel/mail) for seamless integration in your existing Ruby application. The API wrapper also allows you to construct and send messages directly without the Ruby Mail Library.
+
+# Table of Contents
+* [Installation](#installation)
+*  [Usage](#usage)
+*  [Contributing](#contributing)
+*  [License](#license)
+
+
+<a name="#installation"></a>
+## 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
+
+### Getting Paubox API Credentials
+You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/join/see-pricing?unit=messages).
+
+Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.
+
+### Configuring API Credentials
+Include your API credentials in an initializer (e.g. config/initializers/paubox.rb in Rails).
+
+Keep your API credentials out of version control. Store these in environmental variables.
+```ruby
+Paubox.configure do |config|
+  config.api_key = ENV['PAUBOX_API_KEY']
+  config.api_user = ENV['PAUBOX_API_USER']
+end
+```
+
+<a name="#usage"></a>
+## Usage
+
+### Sending Messages with the Ruby Mail Library
+
+Using the Ruby Mail Library? Sending via Paubox is easy. Just build a message as normal and set Mail::Paubox as the delivery method.
+```ruby
+require 'Paubox'
+require 'json'
+require 'mail'
+
+message = Mail.new do
+  from            'you@yourdomain.com'
+  to              'someone@somewhere.com'
+  cc              'another@somewhere.com'
+  subject         'HIPAA-compliant email made easy'
+
+  text_part do
+    body          'This message will be sent securely by Paubox.'
+  end
+
+  html_part do
+    content_type  'text/html; charset=UTF-8'
+    body          '<h1>This message will be sent securely by Paubox.</h1>'
+  end
+
+  delivery_method Mail::Paubox
+end
+
+message.deliver!
+=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}
+
+message.source_tracking_id
+=> "2a3c048485aa4cf6"
+```
+
+### 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. This means a message will not be converted into a secure portal message when a non-TLS connection is encountered.
+```ruby
+require 'Paubox'
+require 'json'
+require 'mail'
+
+message = Mail.new do
+  from            'you@yourdomain.com'
+  to              'someone@somewhere.com'
+  subject         'Sending non-PHI'
+  body            'This message delivery will not enforce TLS transmission.'
+
+  delivery_method Mail::Paubox
+end
+
+message.allow_non_tls = true
+message.deliver!
+```
+
+### Forcing Secure Notifications
+
+Paubox Secure Notifications allow an extra layer of security, especially when coupled with an organization's requirement for message recipients to use 2-factor authentication to read messages (this setting is available to org administrators in the Paubox Admin Panel).
+
+Instead of receiving an email with the message contents, the recipient will receive a notification email that they have a new message in Paubox.
+```ruby
+require 'Paubox'
+require 'json'
+require 'mail'
+
+message = Mail.new do
+  from            'you@yourdomain.com'
+  to              'someone@somewhere.com'
+  subject         'Sending non-PHI'
+  body            'This message delivery will not enforce TLS transmission.'
+
+  delivery_method Mail::Paubox
+end
+
+message.force_secure_notification = 'true'
+message.deliver!
+```
+
+### Adding Attachments
+
+```ruby
+require 'Paubox'
+require 'json'
+require 'mail'
+
+message = Mail.new do
+  from            'you@yourdomain.com'
+  to              'someone@somewhere.com'
+  cc              'another@somewhere.com'
+  subject         'HIPAA-compliant email made easy'
+
+  delivery_method Mail::Paubox
+end
+
+message.add_file("D:\\TestFolder\\YourFileName.txt")
+message.deliver!
+```
+
+### Sending Messages using just the Paubox API
+You don't need to use Ruby Mail to build and send messages with Paubox.
+```ruby
+require 'Paubox'
+require 'json'
+
+args = { from: 'you@yourdomain.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 = Paubox::Message.new(args)
+
+client = Paubox::Client.new
+client.deliver_mail(message)
+=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}
+```
+
+### Checking Email Dispositions
+```ruby
+require 'Paubox'
+require 'json'
+
+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
+```
+
+<a name="#contributing"></a>
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paubox/paubox_ruby.
+
+
+<a name="#license"></a>
+## License
+
+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.
+
+## Copyright
+Copyright &copy; 2019, Paubox Inc.
+