replyr 0.0.1

data/lib/generators/replyr/templates/mailman_daemon

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'rubygems'  
+require "bundler/setup"  
+require 'daemons'
+
+options = {
+  app_name: "mailman",
+  dir_mode: :normal,
+  dir: "tmp/pids",
+}
+
+Daemons.run('script/mailman_server', options) 

data/lib/generators/replyr/templates/mailman_server

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+require "rubygems"  
+require "bundler/setup"  
+require "mailman"
+
+ENV["RAILS_ENV"] ||= "development"
+require File.expand_path("../../config/environment.rb", __FILE__)
+
+Mailman.config.ignore_stdin = true  
+Mailman.config.logger = Logger.new File.expand_path("../../log/mailman_#{Rails.env}.log", __FILE__)
+
+# Use Maildir
+#
+Mailman.config.maildir = "~/Maildir"
+
+# Use Pop3
+#
+# Mailman.config.pop3 = {
+#   server: 'pop.gmail.com', port: 995, ssl: true,
+#   username: USERNAME,
+#   password: PASSWORD
+# }
+
+# Use IMAP
+#
+# Mailman.config.imap = {
+#   server: 'imap.gmail.com', 
+#   port: 993, # usually 995, 993 for gmail
+#   ssl: true,
+#   username: USERNAME,
+#   password: PASSWORD,
+# }
+
+Mailman::Application.run do  
+
+  # DO NOT CHANGE. Replyr Route for processing reply emails
+  to Replyr.address_pattern do
+    Replyr::ReplyEmail.process(message)
+  end
+  
+  # add your custom routes (independent of Replyr) here
+  # to 'support%@example.org' do
+  #   # ...
+  # end
+  # 
+  # default do
+  #   # ...
+  # end
+
+end

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

@@ -0,0 +1,8 @@
+# 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) %>"

data/lib/replyr/config.rb

@@ -0,0 +1,22 @@
+module Replyr
+  class Config
+    attr_accessor :prefix, :host, :secret, :user_class
+    
+    def prefix
+      @prefix || "reply"
+    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.")
+    end
+    
+    def secret
+      @secret || (raise RuntimeError, "Replyr.config.secret is nil. Please set a secure secret token in an initializer.")
+    end
+    
+  end
+end

data/lib/replyr/engine.rb

@@ -0,0 +1,14 @@
+module Replyr
+
+  class Engine < Rails::Engine
+    # setup logger
+    initializer "replyr.logger" do
+      Replyr.setup_logger
+    end
+
+    initializer "replyr.activerecord" do
+      ActiveRecord::Base.send :extend, HandleReply::ClassMethods
+    end
+
+  end
+end

data/lib/replyr/handle_reply.rb

@@ -0,0 +1,36 @@
+module Replyr
+  module HandleReply
+
+    def self.included(base)
+      base.extend ClassMethods  
+    end
+  
+    module ClassMethods 
+    
+      # Usage:
+      # class Comment < ActiveRecord::Base
+      #   handle_reply do |comment, user, text, files|
+      #     Comment.create(body: text, author: user)
+      #   end
+      # end
+      #
+      def handle_reply(*options, &block)	
+    		options = options.extract_options!
+
+        define_method :handle_reply do |user, text, files = nil|
+          block.call(self, user, text, files) 
+        end
+  
+        define_method :reply_address_object_for_user do |user|
+          ReplyAddress.new(self, user)
+        end
+        
+        define_method :reply_address_for_user do |user|
+          reply_address_object_for_user(user).to_s
+        end
+
+      end
+    end
+
+  end
+end

data/lib/replyr/reply_address.rb

@@ -0,0 +1,111 @@
+require 'openssl'
+
+module Replyr
+  class ReplyAddress
+    attr_accessor :model, :user
+    
+    # Create a new reply address from a given user and model
+    #
+    def initialize(model, user)
+      @model = model
+      @user = user
+    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 = get_parsed_address(address)
+
+      model_class = class_from_normalized_model_name(parts[:model_name])
+      model = model_class.find(parts[:model_id])
+      user = Replyr.config.user_class.find(parts[:user_id])
+
+      address = new(model, user)
+      if address.token_valid?(parts[:token])
+        address
+      else
+        Replyr.logger.warn "Reply email address invalid."
+        nil
+      end
+    end
+    
+    # Check if a given token is valid
+    #
+    def token_valid?(token)
+      token == self.token
+    end
+    
+    # Split the reply email address. It has the following format:
+    # reply-comment-12-56-01ce26dc69094af9246ea7e7ce9970aff2b81cc9@reply.example.com
+    #
+    def self.get_parsed_address(address)
+      parsed = Mailman::Route::StringMatcher.new(Replyr.address_pattern).match(address)
+
+      if parsed.nil?
+        raise ArgumentError, "Malformed reply email address."
+      else
+        parsed.first # return Hash part
+      end
+    end
+    
+    # Returs the token from this address
+    #
+    def token
+      token_from_user_and_model(@user, @model)
+    end
+    
+    # Creates a token from the passed user and model objects
+    # Uses the configured secret as a salt
+    #
+    def token_from_user_and_model(user, model)
+      user_id = id_from_model(user)
+      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}"
+      )
+    end
+    
+    # Model name by 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
+
+    # Returns the address string
+    # (e.g reply-comment-12-56-01ce26dc69094af9246ea7e7ce9970aff2b81cc9@reply.example.com)
+    #
+    def address
+      user_id = id_from_model(@user)
+      model_id = id_from_model(@model)
+      model_name = normalized_model_name(@model)
+
+      local_part = [Replyr.config.prefix, model_name, model_id, user_id, token].join("-")
+      "#{local_part}@#{Replyr.config.host}"
+    end
+    alias_method :to_s, :address
+
+  end
+end

data/lib/replyr/reply_email.rb

@@ -0,0 +1,50 @@
+module Replyr
+  class ReplyEmail
+    attr_accessor :to, :from, :subject, :body, :attached_files
+  
+    def initialize(mail)
+      self.to = mail.to.first
+      self.from = mail.from.first
+      self.subject = mail.subject
+      self.body = mail.decoded # Returns the decoded text from the mail in UTF-8 format
+
+      # Extract Attachments and store as StringIO in attached_files
+      # can later be processed by e.g. carrierwave
+      #
+      self.attached_files = mail.attachments.map do |attachment|
+        file = StringIO.new(attachment.decoded)
+        file.class.class_eval { attr_accessor :original_filename, :content_type }
+        file.original_filename = attachment.filename
+        file.content_type = attachment.mime_type
+        file
+      end
+    end
+    
+    def self.process(mail)
+      reply_mail = new(mail)
+      reply_mail.process
+    end
+
+    # Checks if this incoming mail is a reply email
+    #
+    def is_reply_email?
+      to.starts_with?(Replyr.config.prefix)
+    end
+
+    def stripped_body
+      EmailReplyParser.parse_reply(body, from).to_s.force_encoding("UTF-8")
+    end
+  
+    def process
+      if is_reply_email?
+        if reply_address = ReplyAddress.new_from_address(to)
+          reply_address.model.class.handle_reply(reply_token, stripped_body, attached_files)
+        else
+          # no valid reply_address
+        end
+      end
+    end
+  
+  end
+
+end

data/lib/replyr/version.rb

@@ -0,0 +1,3 @@
+module Replyr
+  VERSION = "0.0.1"
+end

data/lib/replyr.rb

@@ -0,0 +1,26 @@
+require 'mailman'
+require 'email_reply_parser/email_reply_parser'
+require "replyr/config"
+require "replyr/reply_email"
+require "replyr/reply_address"
+require "replyr/handle_reply"
+require 'replyr/engine'
+
+module Replyr
+  class << self
+    attr_accessor :config, :logger
+
+    def config
+      @config ||= Replyr::Config.new
+    end
+    
+    def setup_logger
+      @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}"
+    end
+    
+  end
+end

data/lib/tasks/replyr_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :replyr do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/comment.rb

@@ -0,0 +1,7 @@
+class Comment < ActiveRecord::Base
+  belongs_to :user
+
+  handle_reply do |comment, user, text, files|
+    Comment.create(body: text)
+  end
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :comments
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "replyr"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,8 @@
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end