postageapp 1.2.5 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b142c061512b3ef0ff5d1d18d436de9796b772793e6ed10d1267d506c0577d54
+  data.tar.gz: 1f028542353d6cb55ca037f431a68ee1f2820833cc7bce8b5b5fd72f46345365
+SHA512:
+  metadata.gz: 615475381e51dfbdb59e6966381e9c09f95c76e2d625c3983c5fbe7955765f42e85ecd76e3e4a2249bd55638ab70a3bd5153e7715fcf6ed2b0607e108ead503e
+  data.tar.gz: 295a8585e182f43e92447188eed75af8f447083d7c0186076a2f425eed22f86a36d7788974095f49ab0a4807191c4d743113d6c25eaa5efe1b65f70cf1aefa28

data/.gitignore

@@ -1,3 +1,5 @@
+/.bundle
+
 .DS_Store
 coverage
 rdoc
@@ -8,3 +10,7 @@ test/gemfiles/*.lock
 Gemfile.lock
 .ruby-version
 *.gem
+
+.env
+
+.vscode

data/.travis.yml

@@ -3,35 +3,15 @@ before_install: "WITH_VERBOSE=1 script/with current bootstrap"
 install: "WITH_VERBOSE=1 script/with current bundle install"
 script: "WITH_VERBOSE=1 script/with current bundle exec rake test"
 rvm:
-  - 1.9.3-p551
-  - 2.0.0-p598
-  - 2.1.5
-  - 2.2.0
-  - 2.3.0
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1
+  - jruby-9.1.17.0
+  - jruby-9.2.17.0
 gemfile:
   - test/gemfiles/Gemfile.ruby
-  - test/gemfiles/Gemfile.rails-2.3.x
-  - test/gemfiles/Gemfile.rails-3.0.x
-  - test/gemfiles/Gemfile.rails-3.1.x
-  - test/gemfiles/Gemfile.rails-3.2.x
-  - test/gemfiles/Gemfile.rails-4.0.x
-  - test/gemfiles/Gemfile.rails-4.1.x
-  - test/gemfiles/Gemfile.rails-4.2.x
-matrix:
-  exclude:
-    - rvm: 2.0.0-p598
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 2.1.5
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 2.2.0
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 2.3.0
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 1.9.3-p551
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 1.9.3-p551
-      gemfile: test/gemfiles/Gemfile.rails-4.0.x
-    - rvm: 1.9.3-p551
-      gemfile: test/gemfiles/Gemfile.rails-4.1.x
-    - rvm: 1.9.3-p551
-      gemfile: test/gemfiles/Gemfile.rails-4.2.x
+  - test/gemfiles/Gemfile.rails-5.0.x
+  - test/gemfiles/Gemfile.rails-5.2.x
+  - test/gemfiles/Gemfile.rails-6.0.x
+  - test/gemfiles/Gemfile.rails-6.1.x

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2015 Scott Tadman, Oleg Khabarov, The Working Group, Inc
+Copyright (c) 2011-2019 Scott Tadman, Oleg Khabarov, PostageApp Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,14 +1,14 @@
-# [PostageApp](http://postageapp.com) Ruby Gem [![Build Status](https://secure.travis-ci.org/postageapp/postageapp-ruby.png)](http://travis-ci.org/postageapp/postageapp-ruby)
+# [PostageApp](https://postageapp.com/) Ruby Gem [![Build Status](https://secure.travis-ci.org/postageapp/postageapp-ruby.png)](http://travis-ci.org/postageapp/postageapp-ruby)
 
-This gem is used to integrate Ruby apps with [PostageApp](http://postageapp.com/)
+This gem is used to integrate Ruby apps with [PostageApp](https://postageapp.com/)
 service. Personalized high-volume email sending can be offloaded to PostageApp
-via a simple [JSON-based API](http://dev.postageapp.com/api.html).
+via a simple [JSON-based API](https://dev.postageapp.com/api).
 
-### [API Documentation](http://help.postageapp.com/kb/api/api-overview) • [Knowledge Base](http://help.postageapp.com/kb) • [Help Portal](http://help.postageapp.com/)
+### [API Documentation](https://dev.postageapp.com/api/)
 
 # Installation
 
-### Rails 4.x
+## Rails 5.2 and newer
 
 Add the `postageapp` gem to your Gemfile:
 
@@ -17,9 +17,20 @@ Add the `postageapp` gem to your Gemfile:
 Then from the Rails project's root run:
 
     bundle install
-    bin/rails generate postageapp --api-key PROJECT_API_KEY
 
-### Rails 3.x
+For authentication, add your project's PostageApp credentials to the
+Rails Encrypted Credentials:
+
+    rails credentials:edit
+
+The format of this entry should be:
+
+    postageapp:
+      api_key: __PROJECT_API_KEY__
+
+Where that will be picked up by the plugin when Rails starts.
+
+## Rails 4.x and newer
 
 Add the `postageapp` gem to your Gemfile:
 
@@ -28,25 +39,22 @@ Add the `postageapp` gem to your Gemfile:
 Then from the Rails project's root run:
 
     bundle install
-    script/rails generate postageapp --api-key PROJECT_API_KEY
-
-### Rails 2.x
+    bin/rails generate postageapp --api-key PROJECT_API_KEY
 
-In `config/environment.rb` add the following:
+## Legacy Versions of Rails
 
-    config.gem 'postageapp'
+* [Rails 3.x](doc/RAILS3.md)
+* [Rails 2.3.x](doc/RAILS2.md)
 
-Then from the Rails project's root run:
+## Sinatra / Rack / Others
 
-    rake gems:install
-    rake gems:unpack GEM=postageapp
-    script/generate postageapp --api-key PROJECT_API_KEY
+Add the `postageapp` gem to your Gemfile:
 
-### Sinatra / Rack / Others
+    gem 'postageapp'
 
-You'll need to install the gem first:
+Then from the project's root run:
 
-    $ sudo gem install postageapp
+    bundle install
 
 The configuration will need to be loaded before executing any API calls:
 
@@ -63,7 +71,8 @@ with the appropriate API key will also work.
 
 # Usage
 
-Here's an example of sending a message ([See full API documentation](http://help.postageapp.com/faqs/api/send_message)):
+Here's an example of sending a message using the
+[`send_message`](https://dev.postageapp.com/api/send_message) API call:
 
 ```ruby
 request = PostageApp::Request.new(
@@ -80,7 +89,7 @@ request = PostageApp::Request.new(
     },
     attachments: {
       'document.pdf' => {
-        content_type: application/pdf',
+        content_type: 'application/pdf',
         content: Base64.encode64(File.open('/path/to/document.pdf', 'rb').read)
       }
     }
@@ -107,7 +116,7 @@ Response usually comes back with data:
     >> response.data
     => { 'message' => { 'id' => '12345' }}
 
-### Recipient Override
+# Recipient Override
 
 Sometimes you don't want to send emails to real people in your application. For
 that there's an ability to override to what address all emails will be
@@ -138,7 +147,7 @@ require 'postageapp/mailer'
 There are custom methods that allow setting of `template` and `variables` parts
 of the API call. They are `postageapp_template` and `postageapp_variables`.
 Examples how they are used are below. For details what they do please see
-[documentation](http://help.postageapp.com/faqs)
+[documentation](https://dev.postageapp.com/api/)
 
 Please note that `deliver` method will return `PostageApp::Response` object.
 This way you can immediately check the status of the delivery. For example:
@@ -147,9 +156,9 @@ This way you can immediately check the status of the delivery. For example:
     response.ok?
     # => true
 
-### Rails 3 / 4
+## Mailer Base Class
 
-Here's an example of a mailer in Rails 3 environment:
+Here's an example of a mailer using the `PostageApp::Mailer` base class:
 
 ```ruby
 require 'postageapp/mailer'
@@ -194,7 +203,8 @@ class Notifier < PostageApp::Mailer
   def signup_notification
     from 'sender@example.com'
     subject 'Test Email'
-    recipients 'recipient@example.com'
+
+    mail(to: 'recipient@example.com')
   end
 end
 ```
@@ -217,44 +227,6 @@ class DevelopmentPostageappInterceptor
 end
 ```
 
-### Rails 2
-
-Here's an example of a mailer you'd set in in a Rails 2 environment:
-
-```ruby
-require 'postageapp/mailer'
-
-class Notifier < PostageApp::Mailer
-  def signup_notification
-    from 'system@example.com'
-    subject 'New Account Information'
-
-    # Recipients can be in any format API allows.
-    # Here's an example of a hash format
-    recipients(
-      'recipient_1@example.com' => {
-        'variable_name_1' => 'value',
-        'variable_name_2' => 'value'
-      },
-      'recipient_2@example.com' => {
-        'variable_name_1' => 'value',
-        'variable_name_2' => 'value'
-      },
-    )
-
-    attachment(
-      :content_type => 'application/zip',
-      :filename => 'example.zip',
-      :body => File.read('/path/to/example.zip'
-    )
-
-    # PostageApp specific elements:
-    postageapp_template 'example_template'
-    postageapp_variables 'global_variable' => 'value'
-  end
-end
-```
-
 # Automatic resending in case of failure
 
 For those rare occasions when the API is not reachable or unresponsive,
@@ -267,11 +239,89 @@ For projects other than Rails you'll need to tell where the `project_root` is:
 
 ```ruby
 PostageApp.configure do |config|
-  config.api_key      = 'PROJECT_API_KEY'
+  config.api_key = 'PROJECT_API_KEY'
   config.project_root = "/path/to/your/project"
 end
 ```
 
-# Copyright
-
-(C) 2011-2016 Scott Tadman, Oleg Khabarov, [PostageApp](http://www.postageapp.com/)
+# Configuration Details
+
+Configuration can be done either via Ruby code directly, by environment
+variables, or by a combination of both. Where both are supplied, the
+Ruby setting will take precedence.
+
+## Configuration Arguments
+
+These can all be set with `PostageApp.config`:
+
+* `api_key`: Project API key to use (required for project API functions)
+* `account_api_key`: Account API key to use (required for account API functions)
+* `postback_secret`: Secret to use for validating ActionMailbox requests (optional)
+* `project_root`: Project root for logging purposes (default: current working directory)
+* `recipient_override`: Override sender on `send_message` calls (optional)
+* `logger`: Logger instance to use (optional)
+* `secure`: Enable verifying TLS connections (default: `true`)
+* `verify_tls`: Enable TLS certificate verification (default: `true`)
+* `verify_certificate`: Alias for `verify_tls`
+* `host`: API host to contact (default: `api.postageapp.com`)
+* `port`: API port to contact (default: `443`)
+* `scheme`: HTTP scheme to use (default: `https`)
+* `protocol`: Alias for `scheme`
+* `proxy_username`: SOCKS5 proxy username (optional)
+* `proxy_user`: Alias for `proxy_username`
+* `proxy_password`: SOCKS5 proxy password (optional)
+* `proxy_pass`: Alias for `proxy_password`
+* `proxy_host`: SOCKS5 proxy host (optional)
+* `proxy_port`: SOCKS5 proxy port (default: `1080`)
+* `open_timeout`: Timeout in seconds when initiating requests (default: `5`)
+* `http_open_timeout`: Alias for `open_timeout`
+* `read_timeout`: Timeout in seconds when awaiting responses (default: `10`)
+* `http_read_timeout`: Alias for `read_timeout`
+* `retry_methods`: Which API calls to retry, comma and/or space separated (default: `send_message`)
+* `requests_to_resend`: Alias for `retry_methods`
+* `framework`: Framework used (default: `Ruby`)
+* `environment`: Environment to use (default: `production`)
+
+A typical configuration involves setting the project API key:
+
+    PostageApp.config do |config|
+      config.api_key = 'PROJECT_API_KEY'
+    end
+
+Where additional settings can be applied as necessary.
+
+## Environment Variables
+
+Most configuration parameters can be set via the environment:
+
+* `POSTAGEAPP_API_KEY`: Project API key to use (required for project API functions)
+* `POSTAGEAPP_ACCOUNT_API_KEY`: Account API key to use (required for account API functions)
+* `POSTAGEAPP_POSTBACK_SECRET`: Secret to use for validating ActionMailbox requests (optional)
+* `POSTAGEAPP_PROJECT_ROOT`: Project root for logging purposes (default: current working directory)
+* `POSTAGEAPP_RECIPIENT_OVERRIDE`: Override sender on `send_message` calls (optional)
+* `POSTAGEAPP_VERIFY_TLS`:  (default: `true`)
+* `POSTAGEAPP_VERIFY_CERTIFICATE`: Alias for `POSTAGEAPP_VERIFY_TLS`
+* `POSTAGEAPP_HOST`: API host to contact (default: `api.postageapp.com`)
+* `POSTAGEAPP_PORT`: API port to contact (default: `443`)
+* `POSTAGEAPP_SCHEME`: HTTP scheme to use (default: `https`)
+* `POSTAGEAPP_PROTOCOL`: Alias for `POSTAGEAPP_SCHEME`
+* `POSTAGEAPP_PROXY_USERNAME`: SOCKS5 proxy username (optional)
+* `POSTAGEAPP_PROXY_USER`: Alias for `POSTAGEAPP_PROXY_USERNAME`
+* `POSTAGEAPP_PROXY_PASSWORD`: SOCKS5 proxy password (optional)
+* `POSTAGEAPP_PROXY_PASS`: Alias for `POSTAGEAPP_PROXY_PASSWORD`
+* `POSTAGEAPP_PROXY_HOST`: SOCKS5 proxy host (optional)
+* `POSTAGEAPP_PROXY_PORT`: SOCKS5 proxy port (default: `1080`)
+* `POSTAGEAPP_OPEN_TIMEOUT`: Timeout in seconds when initiating requests (default: `5`)
+* `POSTAGEAPP_HTTP_OPEN_TIMEOUT`: Alias for `POSTAGEAPP_OPEN_TIMEOUT`
+* `POSTAGEAPP_READ_TIMEOUT`: Timeout in seconds when awaiting responses (default: `10`)
+* `POSTAGEAPP_HTTP_READ_TIMEOUT`: Alias for `POSTAGEAPP_READ_TIMEOUT`
+* `POSTAGEAPP_RETRY_METHODS`: Which API calls to retry, comma and/or space separated (default: `send_message`)
+* `POSTAGEAPP_REQUESTS_TO_RESEND`: Alias for `POSTAGEAPP_RETRY_METHODS`
+* `POSTAGEAPP_FRAMEWORK`: Framework used (default: `Ruby`)
+* `POSTAGEAPP_ENVIRONMENT`: Environment to use (default: `production`)
+
+# Copyright and Licensing
+
+(C) 2011-2019 Scott Tadman, Oleg Khabarov, [PostageApp](https://postageapp.com/)
+
+This is released under the [MIT License](LICENSE.md).

data/Rakefile

@@ -1,4 +1,5 @@
-require 'bundler/setup'
+# Avoid contaminating ENV with lots of BUNDLER_ variables
+# require 'bundler/setup'
 
 require 'rake/testtask'
 
@@ -11,17 +12,27 @@ end
 namespace :travis do
   desc "Run tests across different environments, simulating Travis"
   task :test do
-    require File.expand_path('test/travis_test', File.dirname(__FILE__))
+    require_relative './test/travis_test'
 
     TravisTest.run!
   end
 
   desc "Report on which versions of Ruby are installed"
   task :versions do
-    require File.expand_path('test/travis_test', File.dirname(__FILE__))
+    require_relative './test/travis_test'
 
     TravisTest.validate_ruby_versions!
   end
 end
 
-task :default => :test
+task default: :test
+
+namespace :test do
+  task :rails do
+    ENV['BUNDLE_GEMFILE'] = File.expand_path('./test/gemfiles/Gemfile.rails-6.1.x', __dir__)
+
+    require 'bundler/setup'
+
+    p Rails
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.4.0

data/app/ingresses/action_mailbox/ingresses/postage_app.rb

@@ -0,0 +1,2 @@
+module ActionMailbox::Ingresses::PostageApp
+end

data/app/ingresses/action_mailbox/ingresses/postage_app/inbound_emails_controller.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class ActionMailbox::Ingresses::PostageApp::InboundEmailsController < ActionMailbox::BaseController
+  before_action :hmac_authenticate
+
+  def create
+    ActionMailbox::InboundEmail.create_and_extract_message_id!(message_param)
+
+    head(:ok)
+
+  rescue JSON::ParserError => e
+    logger.error(e.message)
+
+    head(:unprocessable_entity)
+  end
+
+private
+  def message_param
+    params.require(:inbound_email).require(:message)
+  end
+
+  def hmac_authenticate
+    return if (hmac_authenticated?)
+
+    head(:unauthorized)
+  end
+
+  def hmac_authenticated?
+    if (PostageApp.config.postback_secret.present?)
+      ActiveSupport::SecurityUtils.secure_compare(
+        request.headers["X-PostageApp-Signature"],
+        hmac_signature(message_param, PostageApp.config.postback_secret)
+      )
+    else
+      raise ArgumentError, <<~END.squish
+        Missing required PostageApp "postback secret" which can be set as
+        in the Rails Encypted Credentials, as POSTAGEAPP_API_POSTBACK_SECRET
+        in the environment, or via a config/initializer script using the
+        PostageApp.config method.
+      END
+    end
+  end
+
+private
+  def hmac_signature(*content)
+    Base64.strict_encode64(
+      OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, *content)
+    )
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+PostageApp::Engine.routes.draw do
+  scope "/rails/action_mailbox", module: "action_mailbox/ingresses" do
+    post "/postageapp/inbound_emails" => "postage_app/inbound_emails#create",
+      as: :rails_postageapp_inbound_emails
+  end
+end