postageapp 1.3.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 99701f8c8bb6345d893d0e891e4080b574934fd2
-  data.tar.gz: 96c72f588f097c9a04ed8e0d47dc1ca836f96799
+SHA256:
+  metadata.gz: 8fb7fce16defbeb345e4b38780b1fe03a30b15aa60a6da835366f7ae583fef0e
+  data.tar.gz: 5201a95c68b7c63ae1db1059131dd31fbc0a4945ebec7f8540ac52d838a81f6a
 SHA512:
-  metadata.gz: 3bfdec8d06ffb5af34bd0e13897f46986fde993d36009c96aa34d0710e2ff5729415d157b1e7af28448592da86566b272fec80d4ea52d1038c254d506c098ac9
-  data.tar.gz: 8da78d92e5d62ca7e5a9e7e77d04dd33dee17977a37f372738cb1c58d278f954132f1ae722f04a5c7b9b76e53b05ac1cada4328517b9c8d74aef631ef09da37f
+  metadata.gz: d57a61ffdc8390963c98490e6b0e68cf98ccf396294cd603acc35c1874044d4453d69ccdbccb550f2cbc7746d64b19078dd62be7d915d80527922048c9909d97
+  data.tar.gz: d93cbdac054b4b5cce7c18e64aa911970c8746293b87f595e1964ccfccc63ad4f7ef9df09412a6e167b9c8982645dd679b56ef90a31f1cb19deda2cc967ef04d

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,45 +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-p648
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - jruby-9.1.2.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
   - test/gemfiles/Gemfile.rails-5.0.x
-matrix:
-  exclude:
-    - rvm: 1.9.3-p551
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 2.0.0-p648
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 2.1.10
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 2.2.5
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 2.3.1
-      gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: jruby-9.1.2.0
-      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
-    - rvm: 1.9.3-p551
-      gemfile: test/gemfiles/Gemfile.rails-5.0.x
-    - rvm: 2.0.0-p648
-      gemfile: test/gemfiles/Gemfile.rails-5.0.x
-    - rvm: 2.1.10
-      gemfile: 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,13 +1,35 @@
-# [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 5.2 and newer
+
+Add the `postageapp` gem to your Gemfile:
+
+    gem 'postageapp'
+
+Then from the Rails project's root run:
+
+    bundle install
+
+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:
@@ -26,9 +48,13 @@ Then from the Rails project's root run:
 
 ## Sinatra / Rack / Others
 
-You'll need to install the gem first:
+Add the `postageapp` gem to your Gemfile:
+
+    gem 'postageapp'
+
+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:
 
@@ -46,7 +72,7 @@ with the appropriate API key will also work.
 # Usage
 
 Here's an example of sending a message using the
-[`send_message`](http://help.postageapp.com/faqs/api/send_message) API call:
+[`send_message`](https://dev.postageapp.com/api/send_message) API call:
 
 ```ruby
 request = PostageApp::Request.new(
@@ -63,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)
       }
     }
@@ -121,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:
@@ -213,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.2

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+if (defined?(ActionMailbox) and defined?(ActionMailbox::BaseController))
+  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
+end

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

@@ -0,0 +1,4 @@
+if (defined?(ActionMailbox))
+  module ActionMailbox::Ingresses::PostageApp
+  end
+end

data/config/routes.rb

@@ -0,0 +1,8 @@
+PostageApp::Engine.routes.draw do
+  if (defined?(ActionMailbox))
+    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
+end

data/exe/postageapp

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+
+require 'postageapp'
+require 'postageapp/cli'
+
+exit_code = -1
+
+begin
+  if (ARGV.length > 0)
+    PostageApp::CLI.parse!(*ARGV)
+
+    exit(0)
+  end
+
+rescue PostageApp::CLI::Command::MissingArguments
+  exit(-20)
+rescue PostageApp::CLI::Command::APICallError
+  exit(-30)
+rescue PostageApp::CLI::UnknownCommand => e
+  $stderr.puts("Error: #{e}")
+  exit_code = -11
+end
+
+puts "usage: postageapp command [options]"
+puts
+puts "commands:"
+
+PostageApp::CLI::Command.defined.each do |command, _|
+  puts "  #{command}"
+end
+
+puts
+puts "* Documentation: https://dev.postageapp.com/api/"
+
+exit(exit_code)

data/lib/generators/postageapp/postageapp_generator.rb

@@ -10,18 +10,21 @@ class PostageappGenerator < Rails::Generators::Base
   def self.source_root
     @__source_root ||= File.expand_path(
       '../../../generators/postageapp/templates',
-      File.dirname(__FILE__)
+      __dir__
     )
   end
   
   def install
-    unless (options[:api_key])
-      puts 'Must pass --api-key with API key of your PostageApp.com project'
+    unless (PostageApp::Env.rails_with_encrypted_credentials?)
+      unless (options[:api_key])
+        puts 'Must pass --api-key with API key of your PostageApp.com project'
 
-      exit(-1)
+        exit(-1)
+      end
+      
+      template('initializer.rb', 'config/initializers/postageapp.rb')
     end
-    
-    template('initializer.rb', 'config/initializers/postageapp.rb')
+
     copy_file('postageapp_tasks.rake', 'lib/tasks/postageapp_tasks.rake')
 
     puts run('rake postageapp:test')

data/lib/postageapp/cli/command/config.rb

@@ -0,0 +1,74 @@
+PostageApp::CLI::Command.define do
+  argument :'no-header',
+    optional: true,
+    boolean: true,
+    desc: 'An identifier to refer to this mailbox on subsequent API calls'
+
+  argument :markdown,
+    optional: true,
+    boolean: true,
+    desc: 'Emit markdown formatted description of variables'
+
+  perform do |arguments|
+    if (arguments[:markdown])
+      PostageApp::Configuration.params.each do |param, config|
+        case (default = config[:default])
+        when Proc
+          default = default.call
+        end
+
+        puts '* `%s`: %s (%s)' % [
+          param,
+          config[:desc],
+          case (config[:required])
+          when String
+            'required %s' % config[:required]
+          when true
+            'required'
+          else
+            default ? 'default: `%s`' % default : 'optional'
+          end
+        ]
+
+        config[:aliases]&.each do |param_alias|
+          puts '* `%s`: Alias for `%s`' % [
+            param_alias,
+            param
+          ]
+        end
+      end
+    else
+      unless (arguments[:'no-header'])
+        puts '%-40s %s' % [ 'Variable', 'Description' ]
+        puts '-' * 78
+      end
+  
+      PostageApp::Configuration.params.each do |param, config|
+        case (default = config[:default])
+        when Proc
+          default = default.call
+        end
+
+        puts '%-40s %s (%s)' % [
+          param,
+          config[:desc],
+          case (config[:required])
+          when String
+            'required %s' % config[:required]
+          when true
+            'required'
+          else
+            default ? 'default: %s' % default : 'optional'
+          end
+        ]
+
+        config[:aliases]&.each do |param_alias|
+          puts '%-40s Alias for %s' % [
+            param_alias,
+            param
+          ]
+        end
+      end
+    end
+  end
+end