postmark-inbound 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 034aa428798a3824eddbccfcc91f128d32d09983
-  data.tar.gz: 0340b574dc1ef7d314b86417e9c9a6c9f5b9d3eb
+  metadata.gz: 68e263e910d1c898e9959f28756fb370f65f7dfb
+  data.tar.gz: a15cd5ea90284cb8c1c1689a5b1a4f4b5f413df0
 SHA512:
-  metadata.gz: eb30b5de2aa8042ee269c0dd88caf501132710e63a7cbfb7e0b25adad0fdd4c33016ca67704713b85656a0980575127041899872a2497f5650added9845c1451
-  data.tar.gz: e7be9a60f997880660ad087ca3bb360f7c76f2b0cede8fc4acd956ac39ea78002dd24f9385e48bc38cbc6eed7e55f8eacd1c0be60b629e6c56142b4340764789
+  metadata.gz: 455d1a0606cf8504d01e2a91d4233630a8e0ce1a1f655b38a9747d3f4523a024ade1b841062be8e39b2dabd7861d94fcf0c27c628a182d5f59aff0db2128cbec
+  data.tar.gz: 3e4bf98990750698e31ed501cb6372485983fa144d4d5bac37cc582d1f6d947149476f75a49d3729f3820af1512e180613a0483b19ee5a9becf9acd364a5194b

data/README.md

@@ -36,27 +36,35 @@ PINS::Config.setup do |c|
     'someSTRING1234',
     'OTHERstring987'
   ]
+  # Paths of where you've stored the handlers
+  c.handler_paths = [
+    'handlers'
+  ]
   # HTTP server (Sinatra) settings
   c.dump_errors = true
   c.logging = true
 end
+```
+
+#### Handlers
 
-# 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
+Handler blocks are called for every incoming requests. Create as many files you'd like containing handlers, for example: `handlers/examples.rb`
+
+```ruby
+PINS::Handler.add do |pin|
+  # The 'pin' variable contains data from Postmark
+  break unless pin[:originalrecipient] == 'myinbox@pm.example.com'
+  puts "It's a match!"
+  # Do something more
 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
+# You can have multiple handlers in one file
+PINS::Handler.add do |pin|
+  break unless pin[:spam_status]
+  puts "We've got a spam."
+  # Do something more
 end
+
 ```
 
 ### Use

data/bin/pin-server

@@ -9,6 +9,7 @@ Kajiki.run(opts) do |cmd|
   case cmd
   when 'start'
     PINS::Config.load_config(opts[:config]) if opts[:config]
+    PINS::Handler.autoload
     require 'postmark-inbound/server'
     PINS.logger.warn('Postmark Inbound Server starting...')
     Rack::Server.start({

data/lib/postmark-inbound/config.rb

@@ -1,7 +1,9 @@
-require 'postmark-inbound/handler'
-
 module PINS
 
+  def self.config
+    Config.shared
+  end
+
   class Config
 
     # Load Ruby config file
@@ -27,11 +29,13 @@ module PINS
 
     attr_accessor :user
     attr_accessor :passwords
+    attr_accessor :handler_paths
     attr_accessor :dump_errors
     attr_accessor :logging
 
     def initialize
       @passwords = []
+      @handler_paths = []
       @dump_errors = false
       @logging = false
     end

data/lib/postmark-inbound/handler.rb

@@ -1,52 +1,53 @@
 module PINS
 
+  def self.handlers
+    Handler.handlers
+  end
+
   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}")
+    # Load handlers from directories designated in config
+    def self.autoload
+      PINS.config.handler_paths.each { |path|
+        load_from_path(path)
+      }
     end
 
-    # @return [Hash] containing all the handlers
-    def self.catalog
-      return @catalog
+    # Load handlers from a directory
+    # @param path [String] directory name
+    def self.load_from_path(path)
+      Dir.chdir(path) {
+        Dir.foreach('.') { |f| load f unless File.directory?(f) }
+      }
+    end
+
+    # Call as often as necessary to add handlers; each call creates a PINS::Handler object
+    def self.add(&block)
+      @handlers ||= []
+      @handlers << Handler.new(&block)
+      PINS.logger.debug("Added handler: #{@handlers.last}")
+    end
+
+    # @return [Array] containing all the handlers
+    def self.handlers
+      @handlers
     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)
+    def self.run_handlers(pin)
       PINS.logger.info('Running handlers...')
-      names.each do |name|
-        (Handler.catalog)[name].run(pin)
-      end
+      @handlers.each { |h| h.run(pin) }
       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: #{myname}")
+    def initialize(&block)
       @block = block
     end
 
     def run(obj)
-      PINS.logger.warn("No block to execute for handler: #{myname}") unless @block
-      PINS.logger.debug("Running handler: #{myname}")
+      PINS.logger.warn("No block to execute for handler: #{self}") unless @block
+      PINS.logger.debug("Running handler: #{self}")
       @block.call(obj)
     end
 

data/lib/postmark-inbound/server.rb

@@ -6,8 +6,8 @@ module PINS
   # The Sinatra server
   class Server < Sinatra::Base
 
-    use Rack::Auth::Basic, "Restricted Area" do |username, password|
-      Config.shared.passwords.include?(password)
+    use Rack::Auth::Basic, "Restricted Area" do |_username, password|
+      PINS.config.passwords.include?(password)
     end
 
     helpers Helper
@@ -15,7 +15,7 @@ module PINS
     configure do
       set :environment, :production
       disable :static
-      c = Config.shared
+      c = PINS.config
       set :dump_errors, c.dump_errors
       set :logging, c.logging
       PINS.logger.info('Sinatra server configured.')
@@ -25,7 +25,7 @@ module PINS
       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))
+      Handler.run_handlers(parse_json(request.body.read))
       body ''
     end
 

data/lib/postmark-inbound/version.rb

@@ -1,5 +1,5 @@
 module PINS
 
-  Version = '0.1.0'
+  Version = '0.2.0'
 
 end

data/lib/postmark-inbound.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postmark-inbound
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ken J.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kajiki