harbor 0.16.1

data/lib/harbor/logging.rb

@@ -0,0 +1,39 @@
+gem "logging"
+require "logging"
+require Pathname(__FILE__).dirname + "logging/request_logger"
+
+Logging.configure do
+
+  logger 'root' do
+    level :debug
+    appenders 'app'
+  end
+
+  logger 'request' do
+    additive false
+    level :info
+    appenders 'request'
+  end
+
+  logger 'error' do
+    additive false
+    level :error
+    appenders 'error'
+  end
+
+  appender 'app' do
+    type 'File'
+    filename 'log/app.log'
+  end
+
+  appender 'request' do
+    type 'File'
+    filename 'log/request.log'
+  end
+
+  appender 'error' do
+    type 'File'
+    filename 'log/error.log'
+  end
+
+end

data/lib/harbor/logging/appenders/email.rb

@@ -0,0 +1,84 @@
+module Harbor
+  module LogAppenders
+
+    class Email < Logging::Appender
+      
+      attr_accessor :duplicate_subject_delivery_threshold
+      
+      def initialize(container, from, *addresses)
+        @container = container
+        @from = from
+        @addresses = addresses
+        @tracked_subjects = []
+
+        # Deliver emails with exact-match subjects only every 10 Minutes
+        @duplicate_subject_delivery_threshold = 60 * 10
+
+        super("exception_notifier", :level => :error)
+      end
+
+      def write(event)
+        unless @level > event.level
+          flush_expired_subjects
+
+          data = event.data
+          subject = data.split($/, 2)[0]
+
+          if tracked_subject = @tracked_subjects.detect { |tracked_subject| tracked_subject.subject == subject }
+            tracked_subject.occurances << Time.now
+            
+            # Don't send the email if we've already sent one within the time threshold
+            return false if (Time.now - tracked_subject.sent_at) < @duplicate_subject_delivery_threshold
+          else
+            tracked_subject = TrackedSubject.new(subject)
+            tracked_subject.occurances << Time.now
+
+            @tracked_subjects << tracked_subject
+          end
+
+          mailer = @container.get(:mailer)
+          mailer.from = @from
+          mailer.to = @addresses
+
+          data << "\n(from: #{`hostname`.chomp}, PID: #{Process.pid})"
+
+          mailer.subject = "[ERROR] #{subject}"
+          mailer["x_priority"] = "1 (Highest)"
+          mailer["x_msmail_priority"] = "High"
+          mailer.text = if tracked_subject.occurances.size > 1
+            "Repeated #{tracked_subject.occurances.size} times since #{tracked_subject.sent_at.strftime('%Y-%m-%d %R%z')}\n\n#{data}"
+          else
+            data
+          end
+          mailer.send!
+
+          tracked_subject.occurances.clear
+          tracked_subject.sent_at = Time.now
+        end
+      end
+      
+      private
+
+      ##
+      # Flushes items from the @tracked_subjects array when they are no longer useful
+      ##
+      def flush_expired_subjects
+        @tracked_subjects.reject! do |tracked_subject|
+          tracked_subject.occurances.empty? && (Time.now - tracked_subject.sent_at) >= @duplicate_subject_delivery_threshold
+        end
+      end
+    end
+
+
+    class Email::TrackedSubject
+      attr_accessor :sent_at
+      attr_reader :subject, :occurances
+
+      def initialize(subject)
+        @subject = subject
+        @occurances = []
+      end
+    end  
+
+  end
+end

data/lib/harbor/logging/request_logger.rb

@@ -0,0 +1,34 @@
+module Harbor
+  class RequestLogger
+    ##
+    # Logs requests and their params the configured request logger.
+    # 
+    # Format:
+    # 
+    #   #application      #time                   #duration   #ip              #method #uri      #status   #params
+    #   [PhotoManagement] [04-02-2009 @ 14:22:40] [0.12s]     [64.134.226.23] [GET]    /products (200)     {"order" => "desc"}
+    ##
+    def self.info(request, response, start_time, end_time)
+      case
+      when response.status >= 500 then status = "\033[0;31m#{response.status}\033[0m" # prints the status value in red
+      when response.status >= 400 then status = "\033[0;33m#{response.status}\033[0m" # prints the status value in yellow
+      else status = "\033[0;32m#{response.status}\033[0m"                             # prints the status value in green
+      end
+
+      message = "[#{self.class}] [#{start_time.strftime('%m-%d-%Y @ %H:%M:%S')}] [#{"%2.2fs" % (end_time - start_time)}] [#{request.remote_ip}] [#{request.request_method}] #{request.path_info} (#{status})"
+      message << "\t #{request.params.inspect}" unless request.params.empty?
+      message << "\n"
+
+      if (request_logger = Logging::Logger["request"]).info?
+        request_logger << message
+      end
+    end
+
+    def self.error(exception, request, response, trace)
+      Logging::Logger['error'] << trace
+    end
+  end
+end
+
+Harbor::Application.register_event(:request_complete) { |*args| Harbor::RequestLogger.info(*args) }
+Harbor::Application.register_event(:exception) { |*args| Harbor::RequestLogger.error(*args) }

data/lib/harbor/mail_servers/abstract.rb

@@ -0,0 +1,12 @@
+module Harbor
+  module MailServers
+    class Abstract
+      def initialize(config = {})
+      end
+
+      def deliver(message_or_messages)
+        raise NotImplementedError.new("Classes extending #{self.class.name} must implement #deliver(message_or_messages).")
+      end
+    end
+  end
+end

data/lib/harbor/mail_servers/sendmail.rb

@@ -0,0 +1,19 @@
+module Harbor
+  module MailServers
+    class Sendmail < Abstract
+      def initialize(config = {})
+        @sendmail = config[:sendmail] || `which sendmail`.chomp
+      end
+
+      def deliver(message_or_messages)
+        messages = Array === message_or_messages ? message_or_messages : [message_or_messages]
+
+        messages.each do |message|
+          sendmail = ::IO.popen("#{@sendmail} -i -t", "w+")
+          sendmail.puts message.to_s
+          sendmail.close
+        end
+      end
+    end
+  end
+end

data/lib/harbor/mail_servers/smtp.rb

@@ -0,0 +1,25 @@
+require "net/smtp"
+
+module Harbor
+  module MailServers
+    class SmtpServer < Abstract
+      def initialize(config = {})
+        @config = {}
+        raise ArgumentError("You must provide the :address to your SMTP server in the SmtpServer config.") unless config.has_key?(:address)
+
+        @config[:address] = config[:address]
+        @config[:port] = config.fetch(:port, 25)
+      end
+
+      def deliver(message_or_messages)        
+        messages = Array === message_or_messages ? message_or_messages : [message_or_messages]
+
+        Net::SMTP.start(@config[:address], @config[:port]) do |smtp|
+          messages.each do |message|
+            smtp.send_message(message.to_s, message.from, message.to)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harbor/mail_servers/test.rb

@@ -0,0 +1,17 @@
+module Harbor
+  module MailServers
+    class Test < Abstract
+      attr_accessor :messages
+      
+      def initialize(config = {})
+        self.messages = []
+      end
+
+      def deliver(message_or_messages)
+        messages = Array === message_or_messages ? message_or_messages : [message_or_messages]
+
+        messages.push(*messages)
+      end
+    end
+  end
+end

data/lib/harbor/mailer.rb

@@ -0,0 +1,96 @@
+require "cgi"
+
+gem "mail_builder"
+require "mail_builder"
+
+require Pathname(__FILE__).dirname + "mail_servers/abstract"
+require Pathname(__FILE__).dirname + "mail_servers/sendmail"
+require Pathname(__FILE__).dirname + "mail_servers/smtp"
+require Pathname(__FILE__).dirname + "mail_servers/test"
+
+module Harbor
+  class Mailer < MailBuilder
+
+    def self.layout=(layout)
+      @@layout = layout
+    end
+
+    def self.layout
+      @@layout rescue nil
+    end
+
+    def self.host=(host)
+      @@host = host
+    end
+
+    def self.host
+      @@host rescue "www.example.com"
+    end
+
+    attr_accessor :mail_server
+
+    def initialize(*args)
+      super
+
+      @layout = self.class.layout
+      @host = self.class.host
+    end
+
+    ##
+    # We want to automatically assign the value of @mailer to self whenever
+    # a view is passed to the mailer object. This lets us use, for instance,
+    # the envelope_id to track click-through's and bounces using the same
+    # identifier.
+    # 
+    %w(html= text=).each do |method|
+      define_method(method) do |value|
+        if value.is_a?(Harbor::View)
+          value.context.merge(:mailer => self)
+        end
+
+        if @layout && layout = @layout.dup
+          layout.sub!(/(\.html\.erb$)|$/, ".txt.erb") if method == "text="
+          value = Harbor::View.new(layout, :content => value, :mailer => self)
+        end
+
+        super(value)
+      end
+    end
+
+    def host
+      @host
+    end
+
+    ##
+    # Tokenizes urls in the email body by replacing them with the mail_server_url
+    # provided. The message's envelope_id and a base64 encoded version of the original
+    # url are passed to the URL provided.
+    # 
+    #   mailer.html = 'Please visit <a href="http://example.com">our site</a> for details.'
+    #   mailer.tokenize_urls!("http://example.com/.m/%s?redirect=%s")
+    #   mailer.html # => "Please visit <a href=\"http://example.com/.m/%2AF%2Ch2Gtn.ny1poJnnvvCeSMZA?redirect=aHR0cDovL2V4YW1wbGUuY29t%0A\">our site</a> for details."
+    ##
+    def tokenize_urls!(mail_server_url)
+      mail_server_url = "http://#{mail_server_url}" unless mail_server_url =~ /^http/
+
+      [:@html, :@text].each do |ivar|
+        if content = instance_variable_get(ivar)
+          new_content = content.to_s.gsub(/(https?:\/\/.+?(?=[" <]|$))(\W*)(.{4}|$)/) do |url|
+            # Don't tokenize the inner text of a link
+            if $3 == '</a>'
+              url
+            else
+              (mail_server_url % [CGI.escape(envelope_id), CGI.escape([$1].pack("m"))]) + $2 + $3
+            end
+          end
+          instance_variable_set(ivar, new_content)
+        end
+      end
+    end
+
+    def send!
+      mail_server.deliver(self)
+    end
+
+  end
+end

data/lib/harbor/messages.rb

@@ -0,0 +1,17 @@
+module Harbor
+  class Messages < Hash
+    def initialize(messages = {})
+      super()
+      merge!(messages) if messages
+    end
+
+    def [](key)
+      @expired = true
+      super
+    end
+
+    def expired?
+      !!@expired
+    end
+  end
+end

data/lib/harbor/mime.rb

@@ -0,0 +1,206 @@
+module Harbor
+  # Copyright (c) 2007, 2008, 2009 Christian Neukirchen <purl.org/net/chneukirchen>
+  # This file originated from the Rack project, which can be found at rack.rubyforge.org
+  module Mime
+    # Returns String with mime type if found, otherwise use +fallback+.
+    # +ext+ should be filename extension in the '.ext' format that
+    #       File.extname(file) returns.
+    # +fallback+ may be any object
+    #
+    # Also see the documentation for MIME_TYPES
+    #
+    # Usage:
+    #     Harbor::Mime.mime_type('.foo')
+    #
+    # This is a shortcut for:
+    #     Harbor::Mime::MIME_TYPES.fetch('.foo', 'application/octet-stream')
+
+    def mime_type(ext, fallback='application/octet-stream')
+      MIME_TYPES.fetch(ext, fallback)
+    end
+    module_function :mime_type
+
+    # List of most common mime-types, selected various sources
+    # according to their usefulness in a webserving scope for Ruby
+    # users.
+    #
+    # To amend this list with your local mime.types list you can use:
+    #
+    #     require 'webrick/httputils'
+    #     list = WEBrick::HTTPUtils.load_mime_types('/etc/mime.types')
+    #     Harbor::Mime::MIME_TYPES.merge!(list)
+    #
+    # To add the list mongrel provides, use:
+    #
+    #     require 'mongrel/handlers'
+    #     Harbor::Mime::MIME_TYPES.merge!(Mongrel::DirHandler::MIME_TYPES)
+
+    MIME_TYPES = {
+      ".3gp"     => "video/3gpp",
+      ".a"       => "application/octet-stream",
+      ".ai"      => "application/postscript",
+      ".aif"     => "audio/x-aiff",
+      ".aiff"    => "audio/x-aiff",
+      ".asc"     => "application/pgp-signature",
+      ".asf"     => "video/x-ms-asf",
+      ".asm"     => "text/x-asm",
+      ".asx"     => "video/x-ms-asf",
+      ".atom"    => "application/atom+xml",
+      ".au"      => "audio/basic",
+      ".avi"     => "video/x-msvideo",
+      ".bat"     => "application/x-msdownload",
+      ".bin"     => "application/octet-stream",
+      ".bmp"     => "image/bmp",
+      ".bz2"     => "application/x-bzip2",
+      ".c"       => "text/x-c",
+      ".cab"     => "application/vnd.ms-cab-compressed",
+      ".cc"      => "text/x-c",
+      ".chm"     => "application/vnd.ms-htmlhelp",
+      ".class"   => "application/octet-stream",
+      ".com"     => "application/x-msdownload",
+      ".conf"    => "text/plain",
+      ".cpp"     => "text/x-c",
+      ".crt"     => "application/x-x509-ca-cert",
+      ".css"     => "text/css",
+      ".csv"     => "text/csv",
+      ".cxx"     => "text/x-c",
+      ".deb"     => "application/x-debian-package",
+      ".der"     => "application/x-x509-ca-cert",
+      ".diff"    => "text/x-diff",
+      ".djv"     => "image/vnd.djvu",
+      ".djvu"    => "image/vnd.djvu",
+      ".dll"     => "application/x-msdownload",
+      ".dmg"     => "application/octet-stream",
+      ".doc"     => "application/msword",
+      ".dot"     => "application/msword",
+      ".dtd"     => "application/xml-dtd",
+      ".dvi"     => "application/x-dvi",
+      ".ear"     => "application/java-archive",
+      ".eml"     => "message/rfc822",
+      ".eps"     => "application/postscript",
+      ".exe"     => "application/x-msdownload",
+      ".f"       => "text/x-fortran",
+      ".f77"     => "text/x-fortran",
+      ".f90"     => "text/x-fortran",
+      ".flv"     => "video/x-flv",
+      ".for"     => "text/x-fortran",
+      ".gem"     => "application/octet-stream",
+      ".gemspec" => "text/x-script.ruby",
+      ".gif"     => "image/gif",
+      ".gz"      => "application/x-gzip",
+      ".h"       => "text/x-c",
+      ".hh"      => "text/x-c",
+      ".htm"     => "text/html",
+      ".html"    => "text/html",
+      ".ico"     => "image/vnd.microsoft.icon",
+      ".ics"     => "text/calendar",
+      ".ifb"     => "text/calendar",
+      ".iso"     => "application/octet-stream",
+      ".jar"     => "application/java-archive",
+      ".java"    => "text/x-java-source",
+      ".jnlp"    => "application/x-java-jnlp-file",
+      ".jpeg"    => "image/jpeg",
+      ".jpg"     => "image/jpeg",
+      ".js"      => "application/javascript",
+      ".json"    => "application/json",
+      ".log"     => "text/plain",
+      ".m3u"     => "audio/x-mpegurl",
+      ".m4v"     => "video/mp4",
+      ".man"     => "text/troff",
+      ".mathml"  => "application/mathml+xml",
+      ".mbox"    => "application/mbox",
+      ".mdoc"    => "text/troff",
+      ".me"      => "text/troff",
+      ".mid"     => "audio/midi",
+      ".midi"    => "audio/midi",
+      ".mime"    => "message/rfc822",
+      ".mml"     => "application/mathml+xml",
+      ".mng"     => "video/x-mng",
+      ".mov"     => "video/quicktime",
+      ".mp3"     => "audio/mpeg",
+      ".mp4"     => "video/mp4",
+      ".mp4v"    => "video/mp4",
+      ".mpeg"    => "video/mpeg",
+      ".mpg"     => "video/mpeg",
+      ".ms"      => "text/troff",
+      ".msi"     => "application/x-msdownload",
+      ".odp"     => "application/vnd.oasis.opendocument.presentation",
+      ".ods"     => "application/vnd.oasis.opendocument.spreadsheet",
+      ".odt"     => "application/vnd.oasis.opendocument.text",
+      ".ogg"     => "application/ogg",
+      ".p"       => "text/x-pascal",
+      ".pas"     => "text/x-pascal",
+      ".pbm"     => "image/x-portable-bitmap",
+      ".pdf"     => "application/pdf",
+      ".pem"     => "application/x-x509-ca-cert",
+      ".pgm"     => "image/x-portable-graymap",
+      ".pgp"     => "application/pgp-encrypted",
+      ".pkg"     => "application/octet-stream",
+      ".pl"      => "text/x-script.perl",
+      ".pm"      => "text/x-script.perl-module",
+      ".png"     => "image/png",
+      ".pnm"     => "image/x-portable-anymap",
+      ".ppm"     => "image/x-portable-pixmap",
+      ".pps"     => "application/vnd.ms-powerpoint",
+      ".ppt"     => "application/vnd.ms-powerpoint",
+      ".ps"      => "application/postscript",
+      ".psd"     => "image/vnd.adobe.photoshop",
+      ".py"      => "text/x-script.python",
+      ".qt"      => "video/quicktime",
+      ".ra"      => "audio/x-pn-realaudio",
+      ".rake"    => "text/x-script.ruby",
+      ".ram"     => "audio/x-pn-realaudio",
+      ".rar"     => "application/x-rar-compressed",
+      ".rb"      => "text/x-script.ruby",
+      ".rdf"     => "application/rdf+xml",
+      ".roff"    => "text/troff",
+      ".rpm"     => "application/x-redhat-package-manager",
+      ".rss"     => "application/rss+xml",
+      ".rtf"     => "application/rtf",
+      ".ru"      => "text/x-script.ruby",
+      ".s"       => "text/x-asm",
+      ".sgm"     => "text/sgml",
+      ".sgml"    => "text/sgml",
+      ".sh"      => "application/x-sh",
+      ".sig"     => "application/pgp-signature",
+      ".snd"     => "audio/basic",
+      ".so"      => "application/octet-stream",
+      ".svg"     => "image/svg+xml",
+      ".svgz"    => "image/svg+xml",
+      ".swf"     => "application/x-shockwave-flash",
+      ".t"       => "text/troff",
+      ".tar"     => "application/x-tar",
+      ".tbz"     => "application/x-bzip-compressed-tar",
+      ".tcl"     => "application/x-tcl",
+      ".tex"     => "application/x-tex",
+      ".texi"    => "application/x-texinfo",
+      ".texinfo" => "application/x-texinfo",
+      ".text"    => "text/plain",
+      ".tif"     => "image/tiff",
+      ".tiff"    => "image/tiff",
+      ".torrent" => "application/x-bittorrent",
+      ".tr"      => "text/troff",
+      ".txt"     => "text/plain",
+      ".vcf"     => "text/x-vcard",
+      ".vcs"     => "text/x-vcalendar",
+      ".vrml"    => "model/vrml",
+      ".war"     => "application/java-archive",
+      ".wav"     => "audio/x-wav",
+      ".wma"     => "audio/x-ms-wma",
+      ".wmv"     => "video/x-ms-wmv",
+      ".wmx"     => "video/x-ms-wmx",
+      ".wrl"     => "model/vrml",
+      ".wsdl"    => "application/wsdl+xml",
+      ".xbm"     => "image/x-xbitmap",
+      ".xhtml"   => "application/xhtml+xml",
+      ".xls"     => "application/vnd.ms-excel",
+      ".xml"     => "application/xml",
+      ".xpm"     => "image/x-xpixmap",
+      ".xsl"     => "application/xml",
+      ".xslt"    => "application/xslt+xml",
+      ".yaml"    => "text/yaml",
+      ".yml"     => "text/yaml",
+      ".zip"     => "application/zip",
+    }
+  end
+end