postmark-inbound 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d30cef83d4df28de873f3d1d929ee705f27a86b4
+  data.tar.gz: e915c307737eccfcae23d32e4abaa332d9576237
+SHA512:
+  metadata.gz: 6d9eff2ee5a31ef257445750f70a8c8b1c652787463272bc30ecc7c9995cd9486e6fc80472fad47c22a254acf1866b4d6829de55534ece6235a17264b3cf46a4
+  data.tar.gz: 485870ff33fd174d41d147c1ccaeefd519099d2fe1e14b64086ac27c2a9c1c85c6a5bf73e385e3cd46fd50c64287f114bf4c2b31395afa88da4c801707f72f78

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Ken J.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# postmark-inbound
+
+[![Gem Version](https://badge.fury.io/rb/postmark-inbound.svg)](http://badge.fury.io/rb/postmark-inbound) [![Code Climate](https://codeclimate.com/github/kenjij/postmark-inbound/badges/gpa.svg)](https://codeclimate.com/github/kenjij/postmark-inbound) [![security](https://hakiri.io/github/kenjij/postmark-inbound/master.svg)](https://hakiri.io/github/kenjij/postmark-inbound/master)
+
+A Ruby server for Postmark inbound webhook.
+
+## Requirements
+
+- Ruby 2.1 <=
+- Kajiki 1.1 <=
+- Sinatra 1.4 <=
+
+## Getting Started
+
+### Install
+
+```
+$ gem install postmark-inbound
+```
+
+### Configure
+
+Create a configuration file following the example below.
+
+```ruby
+# Configure application logging
+PINS.logger = Logger.new(STDOUT)
+PINS.logger.level = Logger::DEBUG
+
+PINS::Config.setup do |c|
+  # User custom data
+  c.user = {my_data1: 'Something', my_data2: 'Somethingelse'}
+  # If any number of strings are set, it will require a matching "?auth=" parameter in the incoming request
+  c.auth_tokens = [
+    'adc9c81e23cd4ed785038028e69f7c54',
+    '4e1bca06d99f477f89c110e12e45f8f4'
+  ]
+  # HTTP server (Sinatra) settings
+  c.dump_errors = true
+  c.logging = true
+end
+
+# Add and register handler blocks; all handlers will be called for every incoming request
+PINS::Handler.add(:my_handler1) do |h|
+  h.set_block do |pin|
+    break unless pin[:originalrecipient] == 'myinbox@pm.example.com'
+    puts "It's a match!"
+    # Do something more
+  end
+end
+
+PINS::Handler.add(:my_handler2) do |h|
+  h.set_block do |pin|
+    break unless pin[:spam_status]
+    puts "We've got a spam."
+    # Do something more
+  end
+end
+```
+
+### Use
+
+To see help:
+
+```
+$ pin-server -h
+Usage: pin-server [options] {start|stop}
+  -c, --config=<s>     Load config from file
+  -d, --daemonize      Run in the background
+  -l, --log=<s>        Log output to file
+  -P, --pid=<s>        Store PID to file
+  -p, --port=<i>       Use port (default: 4567)
+```
+
+The minimum to start a server:
+
+```
+$ pin-server -c config.rb start
+```

data/bin/pin-server

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'kajiki'
+require 'postmark-inbound'
+
+
+opts = Kajiki.preset_options(:server, {config: true})
+
+Kajiki.run(opts) do |cmd|
+  case cmd
+  when 'start'
+    PINS::Config.load_config(opts[:config]) if opts[:config]
+    require 'postmark-inbound/server'
+    PINS.logger.warn('Postmark Inbound Server starting...')
+    Rack::Server.start({
+      app: PINS::Server.new,
+      Host: opts[:address],
+      Port: opts[:port]
+    })
+  end
+end

data/lib/postmark-inbound/config.rb

@@ -0,0 +1,41 @@
+require 'postmark-inbound/handler'
+
+module PINS
+
+  class Config
+
+    # Load Ruby config file
+    # @param path [String] config file
+    def self.load_config(path)
+      raise 'config file missing' unless path
+      PINS.logger.debug("Loading config file: #{path}")
+      require File.expand_path(path)
+      PINS.logger.info('Config.load_config done.')
+    end
+
+    # Returns the shared instance
+    # @return [PINS::Config]
+    def self.shared
+      @shared_config ||= Config.new
+    end
+
+    # Call this from your config file
+    def self.setup(&block)
+      yield Config.shared
+      PINS.logger.debug('Config.setup block executed.')
+    end
+
+    attr_accessor :user
+    attr_accessor :auth_tokens
+    attr_accessor :dump_errors
+    attr_accessor :logging
+
+    def initialize
+      @auth_tokens = []
+      @dump_errors = false
+      @logging = false
+    end
+
+  end
+
+end

data/lib/postmark-inbound/handler.rb

@@ -0,0 +1,55 @@
+module PINS
+
+  class Handler
+
+    # Call as often as necessary to add handlers, usually from the config file; each call creates a PINS::Handler object
+    # @param name [Symbol] or a String
+    def self.add(name)
+      @catalog ||= {}
+      if @catalog[name]
+        PINS.logger.warn("Handler not added, duplicate name: #{name}")
+        return nil
+      end
+      handler = Handler.new(name)
+      yield handler if block_given?
+      @catalog[name] = handler
+      PINS.logger.info("Added handler: #{name}")
+    end
+
+    # @return [Hash] containing all the handlers
+    def self.catalog
+      return @catalog
+    end
+
+    # Run the handlers, typically called by the server
+    # @param pin [Hash] from Postmark inbound webhook JSON
+    def self.run(pin, names = Handler.catalog.keys)
+      PINS.logger.info('Running handlers...')
+      names.each do |name|
+        (Handler.catalog)[name].run(pin)
+      end
+      PINS.logger.info('Done running handlers.')
+    end
+
+    attr_reader :myname
+
+    def initialize(name)
+      PINS.logger.debug("Initializing handler: #{name}")
+      @myname = name
+    end
+
+    # When adding a handler, call this to register a block
+    def set_block(&block)
+      PINS.logger.debug("Registering block for handler: #{}")
+      @block = block
+    end
+
+    def run(obj)
+      PINS.logger.warn("No block to execute for handler: #{myname}") unless @block
+      PINS.logger.debug("Running handler: #{myname}")
+      @block.call(obj)
+    end
+
+  end
+
+end

data/lib/postmark-inbound/helper.rb

@@ -0,0 +1,99 @@
+require 'json'
+require 'time'
+
+module PINS
+
+  module Helper
+
+    def parse_json(json)
+      obj = JSON.parse(json)
+      return parse_pm(keys_to_sym(obj)).merge!(catch_pm_headers(obj[:headers]))
+    end
+
+    # Convert all Hash keys to lowercase symbols
+    # @param obj [Object] any Ruby object
+    def keys_to_sym(obj)
+      case obj
+      when Array
+        obj.each do |v|
+          keys_to_sym(v)
+        end
+      when Hash
+        obj.keys.each do |k|
+          if k.class == String
+            obj[k.downcase.to_sym] = keys_to_sym(obj.delete(k))
+          end
+        end
+      end
+      return obj
+    end
+
+    # Additional parsing/conversions
+    def parse_pm(hash)
+      hash[:date] = Time.parse(hash[:date]) if hash[:date]
+      return hash
+    end
+
+    # Extract Postmark related headers into a Hash
+    # @param headers [Array]
+    # @return [Hash]
+    def catch_pm_headers(headers)
+      return nil unless Array === headers
+      caught = {}
+      headers.each do |h|
+        case h[:name]
+        when 'X-Spam-Status'
+          caught[:spam_status] = h[:value].downcase.start_with?('yes')
+        when 'X-Spam-Score'
+          caught[:spam_score] = h[:value].to_f
+        when 'Received-SPF'
+          caught[:received_spf_status] = (h[:value].split)[0].downcase
+        end
+      end
+      return caught
+    end
+
+    def lookup_email_headers(headers, name)
+    end
+
+    # Convert object into JSON, optionally pretty-format
+    # @param obj [Object] any Ruby object
+    # @param opts [Hash] any JSON options
+    # @return [String] JSON string
+    def json_with_object(obj, pretty: true, opts: nil)
+      return '{}' if obj.nil?
+      if pretty
+        opts = {
+          indent: '  ',
+          space: ' ',
+          object_nl: "\n",
+          array_nl: "\n"
+        }
+      end
+      JSON.fast_generate(json_format_value(obj), opts)
+    end
+
+    # Return Ruby object/value to JSON standard format
+    # @param val [Object]
+    # @return [Object]
+    def json_format_value(val)
+      case val
+      when Array
+        val.map { |v| json_format_value(v) }
+      when Hash
+        val.reduce({}) { |h, (k, v)| h.merge({k => json_format_value(v)}) }
+      when String
+        val.encode!('UTF-8', {invalid: :replace, undef: :replace})
+      when Time
+        val.utc.iso8601
+      else
+        val
+      end
+    end
+
+  end
+
+end
+
+
+[{'A' => 1, 'Base' => 'Text', 'He' => {'llo' => 2, 'NONE' => 0}, 'aRRAy' => [1,2,{a: 1, 'BB' => "two"}]}]

data/lib/postmark-inbound/logger.rb

@@ -0,0 +1,24 @@
+require 'logger'
+
+
+module PINS
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger ||= NullLogger.new()
+  end
+
+  class NullLogger < Logger
+
+    def initialize(*args)
+    end
+
+    def add(*args, &block)
+    end
+
+  end
+
+end

data/lib/postmark-inbound/server.rb

@@ -0,0 +1,57 @@
+require 'sinatra/base'
+require 'postmark-inbound/helper'
+
+module PINS
+
+  # The Sinatra server
+  class Server < Sinatra::Base
+
+    helpers Helper
+
+    configure do
+      set :environment, :production
+      disable :static
+      c = Config.shared
+      set :dump_errors, c.dump_errors
+      set :logging, c.logging
+      PINS.logger.info('Sinatra server configured.')
+    end
+
+    before do
+      tokens = Config.shared.auth_tokens
+      halt 401 unless tokens.empty? || tokens.include?(params[:auth])
+    end
+
+    post '/' do
+      PINS.logger.info('Incoming request received.')
+      PINS.logger.debug("Body size: #{request.content_length} bytes")
+      request.body.rewind
+      Handler.run(parse_json(request.body.read))
+      body ''
+    end
+
+    not_found do
+      PINS.logger.info('Invalid request.')
+      PINS.logger.debug("Request method and path: #{request.request_method} #{request.path}")
+      json_with_object({message: 'Huh, nothing here.'})
+    end
+
+    error 401 do
+      PINS.logger.info(params[:auth] ? 'Invalid auth token provided.' : 'Missing auth token.')
+      PINS.logger.debug("Provided auth token: #{params[:auth]}") if params[:auth]
+      json_with_object({message: 'Oops, need a valid auth.'})
+    end
+
+    error do
+      status 500
+      err = env['sinatra.error']
+      PINS.logger.error "#{err.class.name} - #{err}"
+      json_with_object({message: 'Yikes, internal error.'})
+    end
+
+    after do
+      content_type 'application/json'
+    end
+
+  end
+end

data/lib/postmark-inbound/version.rb

@@ -0,0 +1,5 @@
+module PINS
+
+  Version = '0.0.1'
+
+end

data/lib/postmark-inbound.rb

@@ -0,0 +1,2 @@
+require 'postmark-inbound/logger'
+require 'postmark-inbound/config'

data/postmark-inbound.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'postmark-inbound/version'
+
+
+Gem::Specification.new do |s|
+  s.name          = 'postmark-inbound'
+  s.version       = PINS::Version
+  s.authors       = ['Ken J.']
+  s.email         = ['kenjij@gmail.com']
+  s.summary       = %q{A Ruby server for Postmark inbound webhook.}
+  s.description   = %q{A programable Ruby server for Postmark inbound webhook. For example, trigger notifications or automated response.}
+  s.homepage      = 'https://github.com/kenjij/postmark-inbound'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.add_runtime_dependency 'kajiki', '~> 1.1'
+  s.add_runtime_dependency 'sinatra', '~> 1.4'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: postmark-inbound
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ken J.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kajiki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: A programable Ruby server for Postmark inbound webhook. For example,
+  trigger notifications or automated response.
+email:
+- kenjij@gmail.com
+executables:
+- pin-server
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/pin-server
+- lib/postmark-inbound.rb
+- lib/postmark-inbound/config.rb
+- lib/postmark-inbound/handler.rb
+- lib/postmark-inbound/helper.rb
+- lib/postmark-inbound/logger.rb
+- lib/postmark-inbound/server.rb
+- lib/postmark-inbound/version.rb
+- postmark-inbound.gemspec
+homepage: https://github.com/kenjij/postmark-inbound
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby server for Postmark inbound webhook.
+test_files: []