replyr 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc30e8d36b31046ac18c5ec4447a1ac051a512b2
-  data.tar.gz: ed95db5d8aa64a306fdaad7818dd176ed3393402
+  metadata.gz: 09c0af70b27c7e54b91f2df46e1f397d57449109
+  data.tar.gz: b00e0b4df98e524e279235a580159b85b6714000
 SHA512:
-  metadata.gz: ab02078a8475a15365ca3add436a3681ce988903eb718eb9eb9059ea424eae52d3a8071ac6b978cb161aa5397c507e09b421a18c0b85cade8c351f6d00804c46
-  data.tar.gz: 49ef7f5734651590f4c6692bd9a046d2f85c97307006584454426c59127869b0ac64ab8c9b76ff4a0911ba59441a0f9e9ce0a25ce6988010837da633c1d4c078
+  metadata.gz: f2667bea0a35a65e7fde2635b636de4a99e33972e55425cd9be7f39835187add195525717296296cc54d630e4d55c394e511a9598a4a80dc3314937faba3f70a
+  data.tar.gz: ef21000d33e3b10ca64293290ca3699554c46d83f14653d4495e756bd8a78e689300bbc73ebae3b732f6216ffe0e0b26afa34da45d4cb767a1b6e2fda047868a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## v0.0.7
 
+- Add handling of bounce emails
+
+## v0.0.7
+
 - Process the stripped body (signature removed)
 
 ## v0.0.6

data/README.md

@@ -25,7 +25,7 @@ https://github.com/titanous/mailman
   - Ruby >= 1.9.3
   - Rails 3 >= 3.1 or Rails 4.x
 
-## Installtion
+## Installation
 
 #### Add the gem to your `Gemfile`
 
@@ -45,7 +45,7 @@ $ rails g replyr:install
 Open up `config/initializers/replyr.rb` and set the host name of your reply email address.
 
 ```ruby
-Ryplr.config.host = "yourdomain.com"
+Ryplr.config.reply_host = "yourdomain.com"
 ```
 
 #### Setup Mailman Gem
@@ -54,6 +54,8 @@ The Install Generator will already have created a `script/mailman_server` file w
 
 ## Usage
 
+### Reply Handling
+
 #### Make a model accept replies
 
 Update your ActiveRecord models you want to reply to by adding a `handle_reply` like this:
@@ -65,6 +67,7 @@ class Comment < ActiveRecord::Base
   handle_reply do |comment, user, text, files|
     Comment.create(body: text)
   end
+
 end
 ```
 
@@ -78,15 +81,48 @@ To add the unique reply address to your outgoing emails and make them 'replyable
 
 ```ruby
 class CommentMailer < ActionMailer::Base
+
   def new_comment(user, comment)
-    mail(to: user.email, reply_to: comment.reply_address_for_user(user))
+    mail to: user.email, reply_to: comment.reply_address_for_user(user)
   end
+  
 end
 ```
 
-## Start up
+### Bounce Handling
+
+#### Make a model accept bounce emails
+
+Add a `handle_bounce` call to the ActiveRecord model you want to handle your bounce emails on.
+
+```ruby
+class User < ActiveRecord::Base
+
+  handle_bounce do |user, email|
+    # Put your custom bounce handling code here
+    # e.g. mark email as invalid
+    user.update_attribute(:email_valid, false)
+  end
+
+end
+```
+
+#### Update your mailers and set the `return_path`
+
+```ruby
+class CommentMailer < ActionMailer::Base
+  
+  def new_comment(user, comment)
+    mail to: user.email, return_path: user.bounce_address
+  end
+  
+end
+```
+
+
+## Start up the worker
 
-Start/Stop up the Mailman background worker with the following commands:
+Start/Stop the Mailman background worker with the following commands:
 
 ```bash
 $ RAILS_ENV=production script/mailman_daemon start

data/lib/generators/replyr/templates/mailman_server

@@ -34,11 +34,11 @@ Mailman.config.maildir = "~/Maildir"
 Mailman::Application.run do  
 
   # DO NOT CHANGE. Replyr Route for processing reply emails
-  to Replyr.address_pattern do
-    Replyr::ReplyEmail.process(message)
+  to Replyr.route do
+    Replyr.process(message)
   end
   
-  # add your custom routes (independent of Replyr) here
+  # add your custom mailman routes (independent of Replyr) here
   # to 'support%@example.org' do
   #   # ...
   # end

data/lib/generators/replyr/templates/replyr.rb.erb

@@ -1,8 +1,17 @@
 # Configuration for Replyr
 #
 
-# Set the host name for your reply email addresses
-Replyr.config.host = "example.com"
-
 # Set a secure secret token to be used for salting the email-address 
 Replyr.config.secret = "<%= defined?(SecureRandom) ? SecureRandom.hex(32) : ActiveSupport::SecureRandom.hex(32) %>"
+
+# Set the host name for your reply email addresses
+Replyr.config.reply_host = "example.com"
+
+# Set the host name for your bounce email addresses
+Replyr.config.bounce_host = "example.com"
+
+# Set custom prefix for your reply email addresses (default: "reply")
+# Replyr.config.reply_prefix = "reply"
+
+# Set custom prefix for your bounce email addresses (default: "bounce")
+# Replyr.config.bounce_prefix = "bounce"

data/lib/replyr.rb

@@ -1,9 +1,15 @@
 require 'mailman'
 require 'email_reply_parser/email_reply_parser'
 require "replyr/config"
-require "replyr/reply_email"
+
+require "replyr/address_builder"
 require "replyr/reply_address"
+require "replyr/bounce_address"
+
+require "replyr/email"
+
 require "replyr/handle_reply"
+require "replyr/handle_bounce"
 require 'replyr/engine'
 
 # Monkey Patch broken listen dependency in mailman v0.7.0
@@ -21,10 +27,31 @@ module Replyr
       @logger = (defined?(Rails) && Rails.logger) ? Rails.logger : Logger.new(STDOUT)
     end
     
-    def address_pattern
-      "#{config.prefix}-%model_name%-%model_id%-%user_id%-%token%@#{config.host}"
+    # Regexp for reply addresses:
+    # reply-comment-12-56-01ce26dc69094af9246ea7e7ce9970aff2b81cc9@reply.example.com
+    #
+    def reply_pattern
+      /#{config.reply_prefix}-(?<model_name>[a-z,#]+)-(?<model_id>\d+)-(?<user_id>\d+)-(?<token>\S+)@#{config.reply_host}/
+    end
+    
+    # Regexp for bounce addresses:
+    # bounce-newsletter-12-01ce26dc69094af9246ea7e7ce9970aff2b81cc9@bounce.example.com
+    #
+    def bounce_pattern
+      /#{config.bounce_prefix}-(?<model_name>[a-z,#]+)-(?<model_id>\d+)-(?<token>\S+)@#{config.bounce_host}/
+    end
+    
+    # Regexp for bounce and reply addresses.
+    # Use this as the Replyr route in your mailman-server.
+    #
+    def route
+      /#{reply_pattern}|#{bounce_pattern}/
+    end
+    alias_method :address_pattern, :route
+    
+    def process(message)
+      Replyr::Email.process(message)
     end
-    alias_method :mailman_route, :address_pattern
     
   end
 end

data/lib/replyr/address_builder.rb

@@ -0,0 +1,69 @@
+require 'openssl'
+
+module Replyr
+  module AddressBuilder
+    # Model name may be namespaced (e.g. MyApp::Comment)
+    # For the reply email address the model name will be converted to "my_app/comment".
+    # Then the slash "/" will be replaced with a plus sign "+", because
+    # slashes should not be used email addresses.
+    #
+    def normalized_model_name(model)
+      model.class.name.tableize.singularize.gsub("/", "+")
+    end
+    
+    # Converts a normalized model_name back to a real model name
+    # and returns the class
+    #
+    def self.class_from_normalized_model_name(model_name)
+      model_name.gsub("+", "/").classify.constantize
+    end
+    
+    # Returns the ID of an AR object.
+    # Uses primary key to find out the correct field
+    #
+    def id_from_model(object)
+      object.send(object.class.primary_key)
+    end
+    
+    # Split the reply/bounce email address. It has the following format:
+    # Reply: reply-comment-12-56-01ce26dc69094af9246ea7e7ce9970aff2b81cc9@reply.example.com
+    # Bounce: bounce-newsletter-12-01ce26dc69094af9246ea7e7ce9970aff2b81cc9@bounce.example.com
+    #
+    def self.get_parsed_address(address)
+      if match_data = Replyr.route.match(address)
+        match_data
+      else
+        raise ArgumentError, "Malformed reply/bounce email address."
+      end
+    end
+    
+    # Creates a token from the passed model (and user if passed) 
+    # Uses the configured secret as a salt
+    #
+    def create_token(model, user = nil)
+      user_id = user.present? ? id_from_model(user) : nil
+      model_id = id_from_model(model)
+      model_name = normalized_model_name(model)
+
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha1'),
+        Replyr.config.secret,
+        [user_id, model_name, model_id].compact.join("-")
+      )
+    end
+        
+    # Check if a given token is valid
+    #
+    def token_valid?(token)
+      token == self.token
+    end
+    
+    # Ensure a given token is valid
+    #
+    def ensure_valid_token!(token)
+      raise(RuntimeError, "Token invalid.") unless token_valid?(token)
+    end
+    
+    
+  end
+end

data/lib/replyr/bounce_address.rb

@@ -0,0 +1,52 @@
+require 'openssl'
+
+module Replyr
+  class BounceAddress
+    include AddressBuilder
+    
+    attr_accessor :model
+    
+    # Create a new reply address from a given user and model
+    #
+    def initialize(model)
+      @model = model
+    end
+    
+    # Create a reply address from a given address string
+    # Checks for validity of address and raises an ArgumentError
+    # if it's invalid.
+    #
+    def self.new_from_address(address)
+      parts = AddressBuilder.get_parsed_address(address)
+
+      model_class = AddressBuilder.class_from_normalized_model_name(parts[:model_name])
+      model = model_class.find(parts[:model_id])
+
+      address = new(model)
+      address.ensure_valid_token!(parts[:token])
+      address
+    rescue
+      Replyr.logger.warn "Bounce email address invalid."
+      nil
+    end
+    
+    # Returs the token from this address
+    #
+    def token
+      create_token(@model)
+    end
+
+    # Returns the address string
+    # (e.g bounce-newsletter-12-01ce26dc69094af9246ea7e7ce9970aff2b81cc9@bounce.example.com)
+    #
+    def address
+      model_id = id_from_model(@model)
+      model_name = normalized_model_name(@model)
+
+      local_part = [Replyr.config.bounce_prefix, model_name, model_id, token].join("-")
+      "#{local_part}@#{Replyr.config.bounce_host}"
+    end
+    alias_method :to_s, :address
+
+  end
+end

data/lib/replyr/config.rb

@@ -1,17 +1,30 @@
 module Replyr
   class Config
-    attr_accessor :prefix, :host, :secret, :user_class
+    attr_accessor :reply_prefix, 
+                  :reply_host, 
+                  :bounce_prefix,
+                  :bounce_host,
+                  :secret, 
+                  :user_class
     
-    def prefix
-      @prefix || "reply"
+    def reply_prefix
+      @reply_prefix || "reply"
+    end
+
+    def bounce_prefix
+      @bounce_prefix || "bounce"
     end
     
     def user_class
       @user_class || User
     end
     
-    def host
-      @host || (raise RuntimeError, "Replyr.config.host is nil. Please set a host in an initializer.")
+    def reply_host
+      @reply_host || (raise RuntimeError, "Replyr.config.reply_host is nil. Please set a host in an initializer.")
+    end
+
+    def bounce_host
+      @bounce_host || (raise RuntimeError, "Replyr.config.bounce_host is nil. Please set a host in an initializer.")
     end
     
     def secret

data/lib/replyr/{reply_email.rb → email.rb}

@@ -1,8 +1,9 @@
 module Replyr
-  class ReplyEmail
-    attr_accessor :to, :from, :subject, :body, :files
+  class Email
+    attr_accessor :to, :from, :subject, :body, :files, :mail
   
     def initialize(mail)
+      self.mail = mail
       self.to = mail.to.first
       self.from = mail.from.first
       self.subject = mail.subject
@@ -28,15 +29,30 @@ module Replyr
     # Checks if this incoming mail is a reply email
     #
     def is_reply_email?
-      to.starts_with?(Replyr.config.prefix)
+      to.starts_with?(Replyr.config.reply_prefix)
     end
 
     def stripped_body
       EmailReplyParser.parse_reply(body, from).to_s.force_encoding("UTF-8")
     end
   
+    def is_bounce_email?
+      mail.bounced? || false
+    end
+    
+    def failed_permanently?
+      !mail.retryable? || false
+    end
+  
     def process
-      if is_reply_email?
+      if is_bounce_email?
+        if bounce_address = BounceAddress.new_from_address(to)
+          bounce_address.model.handle_bounce(mail.final_recipient)
+          true
+        else
+          false
+        end
+      elsif is_reply_email?
         if reply_address = ReplyAddress.new_from_address(to)
           reply_address.model.handle_reply(reply_address.user, stripped_body, files)
           true

data/lib/replyr/engine.rb

@@ -8,6 +8,7 @@ module Replyr
 
     initializer "replyr.activerecord" do
       ActiveRecord::Base.send :extend, HandleReply::ClassMethods
+      ActiveRecord::Base.send :extend, HandleBounce::ClassMethods
     end
 
   end

data/lib/replyr/handle_bounce.rb

@@ -0,0 +1,35 @@
+module Replyr
+  module HandleBounce
+
+    def self.included(base)
+      base.extend ClassMethods  
+    end
+  
+    module ClassMethods 
+    
+      # Usage:
+      # class Comment < ActiveRecord::Base
+      #   handle_bounce do |comment, email|
+      #     # your custom code (e.g. mark email as invalid)
+      #   end
+      # end
+      #
+      def handle_bounce(*options, &block)	
+    		options = options.extract_options!
+
+        define_method :handle_bounce do |email|
+          block.call(self, email) 
+        end
+  
+        define_method :bounce_address_object do
+          BounceAddress.new(self)
+        end
+        
+        define_method :bounce_address do
+          bounce_address_object.to_s
+        end
+      end
+    end
+
+  end
+end