paubox 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b17ee76a0b045040db36865f166c659df8b29ba
-  data.tar.gz: 8618b773e3b75644e4480b815c66d3613e6a8ef1
+  metadata.gz: 71a4b58946b0869eac1768ba49c208950fc7d6f2
+  data.tar.gz: 704a4cf54c5ef966e0f060ad3186f7aab314ecca
 SHA512:
-  metadata.gz: 4eaa0bc9cb2d23b0aa7f36e1f2a1a30bcfaf798a4914857f273160b8c4bd60ea351145ae226fe5d2cf7c913c93b22574ef0f4d4770a50d4043ad1a843939f89c
-  data.tar.gz: d53e5917f0d7dbbefcad209a3b3a6bdc39b08bd0c1a5b8ffff85a5281772facb465df31d135baa88a2084b5eabcd10005b94c83eea96838609d33c5325b4629e
+  metadata.gz: 89fa8a685e2170ee6ebbf87c2845c7eb3eb875576fc9fd002034d6c33c94fd159c04a0cd5f13985311de9b614ceb8d5f1bd589767b60fad5ebf2adb999497c58
+  data.tar.gz: 44ab568c8b28b5f77c376851865e0892bf17cbb59f1975e8af47a69be6202cd8ea9ac152aa6c79ff37dcf39497ccd4bc8565254e619876c7ed0d5e314d738b51

data/README.md

@@ -1,5 +1,9 @@
 # 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.
+This gem and Paubox Transactional Email HTTP API are currently in pre-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.
 
 ## Installation
 
@@ -17,6 +21,83 @@ Or install it yourself as:
 
     $ gem install paubox
 
+### Getting Paubox API Credentials
+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).
+
+Be careful not to commit your API credentials to version control. It's best to store these in environmental variables.
+
+	Paubox.configure do |config|
+     config.api_key = ENV['PAUBOX_API_KEY']
+     config.api_user = ENV['PAUBOX_API_USER']
+    end
+
+
+### 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.
+
+	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"
+
+### Sending Messages without ensuring TLS
+
+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.
+
+	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
+	
+	args = { from: 'you@yourdomain.com',
+	         to: 'someone@domain.com, someone_else@domain.com',
+             cc: ['another@domain.com', 'yetanother@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)
+	
+	client = Paubox::Client.new
+	client.deliver_mail(message)
+	=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}
+
+	
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/paubox/paubox_ruby.
@@ -24,5 +105,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/paubox
 
 ## License
 
-Copyright &copy; 2018 Paubox, Inc. See LICENSE for details.
+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.
 

data/lib/mail/paubox.rb

@@ -14,6 +14,6 @@ module Mail
   end
 
   class Message
-    attr_accessor :source_tracking_id, :status
+    attr_accessor :source_tracking_id, :status, :allow_non_tls
   end
 end

data/lib/paubox/mail_to_message.rb

@@ -34,8 +34,10 @@ module Paubox
       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?
+        content[:html_content] = 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] = mail.body.to_s
       else
         content[:text_content] = mail.body.to_s
       end

data/lib/paubox/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paubox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Paubox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,7 @@ files:
 - 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: