feed2email 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2edf473e3d4740e4593c3c15cf7e2bb3c106815
-  data.tar.gz: 063706f3316c3f7610fa9b361adeca02dc2ecfe3
+  metadata.gz: ac8af629627f99050a52d97c8c83ae87c03663c4
+  data.tar.gz: cfc63b86eb14679e57d8f445559b682e2edeea16
 SHA512:
-  metadata.gz: a2780f0f6836d9071e8021bbe206c3c369a0a516d6c38f5678448dea229d00a332e206b4d8ce734569d5b933ed518b80edcb5ea2c9136e127ba33bd1fde75b5a
-  data.tar.gz: bcc5b42264fccb8ff5e54479120c6c50d67f188ddd343b1d894bb7b810e923e9b3c1f6a4693875ee6cae387250d465f0965f4d2be5ed5cb4e5e1b7c6c662fe92
+  metadata.gz: 8609da85c1b80a45cc69fa03ef66abbd3b5a4d0e588a720c3700fe887fe884afacbfa33f4b975037fed7d4480a2a6b219a9bebf01273cf28b5c1e25fd75fa23e
+  data.tar.gz: 3434bf8b41b8a0528f215a273c337198c16986e8ad04732e27417aa2b8af3b33d268110dbf94f4592679833b63fa10fb3ae77e0da06aefb6f33f07db3eaf6dfa

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.5.0
+
+* Sanitize SMTP user in from address
+* Add config option for sender email address (from)
+* Add config option for log verbosity
+* Add text/plain part in email messages
+* Strip HTML from email subject and body title
+
 ### 0.4.0
 
 * Major rewrite to keep history of processed (seen) entries

data/Gemfile.lock

@@ -1,45 +1,33 @@
 PATH
   remote: .
   specs:
-    feed2email (0.3.0)
+    feed2email (0.4.0)
       feedzirra
       mail
+      sanitize
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.1.12)
-      multi_json (~> 1.0)
-    builder (3.2.2)
-    curb (0.7.18)
-    feedzirra (0.1.3)
-      activesupport (~> 3.1.1)
-      builder (>= 2.1.2)
-      curb (~> 0.7.15)
-      i18n (>= 0.5.0)
-      loofah (~> 1.2.0)
-      nokogiri (>= 1.4.4)
-      rake (>= 0.8.7)
-      rdoc (~> 3.8)
-      sax-machine (~> 0.1.0)
-    i18n (0.6.5)
-    json (1.8.0)
+    curb (0.8.5)
+    feedzirra (0.7.0)
+      curb (~> 0.8.1)
+      loofah (~> 1.2.1)
+      sax-machine (~> 0.2.1)
     loofah (1.2.1)
       nokogiri (>= 1.4.4)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.24)
-    mini_portile (0.5.1)
-    multi_json (1.7.9)
-    nokogiri (1.6.0)
+    mime-types (1.25.1)
+    mini_portile (0.5.2)
+    nokogiri (1.6.1)
       mini_portile (~> 0.5.0)
     polyglot (0.3.3)
-    rake (10.1.0)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    sax-machine (0.1.0)
-      nokogiri (> 0.0.0)
+    sanitize (2.1.0)
+      nokogiri (>= 1.4.4)
+    sax-machine (0.2.1)
+      nokogiri (~> 1.6.0)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)

data/README.md

@@ -41,15 +41,23 @@ pair is separated with a colon: `foo: bar`
 ### Generic options
 
 * `recipient` (required) is the email address to send email to
+* `sender` (optional) is the email address to send email from (default is taken
+  from the feed entry author or, if missing, it is generated from the SMTP user
+  and host or, if missing, it is the same as `recipient`)
 * `send_delay` (optional) is the number of seconds to wait between each email to
   avoid SMTP server throttling errors (default is `10`; use `0` to disable)
 * `log_path` (optional) is the _absolute_ path to the log file (default is
   `true` which logs to standard output; use `false` to disable)
+* `log_level` (optional) is the logging verbosity level and can be `fatal`
+  (least verbose), `error`, `warn`, `info` (default) and `debug` (most verbose)
 * `max_entries` (optional) is the maximum number of entries to process per feed
   (default is `20`; use `0` for unlimited)
 
 ### SMTP
 
+For this method you need to have access to an SMTP service. [Mailgun][] has a
+free plan.
+
 * `smtp_host` is the SMTP service hostname to connect to
 * `smtp_port` is the SMTP service port to connect to
 * `smtp_user` is the username of your email account
@@ -63,10 +71,12 @@ your system will be able to read `config.yml` and your password. To prevent
 this, feed2email will not run and complain if it detects the wrong permissions.
 You can set the correct permissions with `chmod 600 ~/.feed2email/config.yml`.
 
+[Mailgun]: http://www.mailgun.com/
+
 ### MTA
 
 For this method you need to have an [MTA][] with a [Sendmail][]-compatible
-interface setup and working in your system. I suggest [msmtp][] or [Postfix][].
+interface setup and working in your system like [msmtp][] or [Postfix][].
 
 * `sendmail_path` (optional) is the path to the Sendmail binary (default is
   `/usr/sbin/sendmail`)

data/feed2email.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'feedzirra'
   gem.add_dependency 'mail'
+  gem.add_dependency 'sanitize'
 end

data/lib/feed2email.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 require 'logger'
 require 'mail'
 require 'net/smtp'
+require 'sanitize'
 require 'singleton'
 require 'yaml'
 

data/lib/feed2email/core_ext.rb

@@ -2,6 +2,10 @@ class String
   def escape_html
     CGI.escapeHTML(self)
   end
+
+  def strip_html
+    CGI.unescapeHTML(Sanitize.clean(self))
+  end
 end
 
 class Time

data/lib/feed2email/feed.rb

@@ -69,6 +69,7 @@ module Feed2Email
           )
         rescue => e
           log :error, "#{e.class}: #{e.message.strip}"
+          e.backtrace.each {|line| log :debug, line }
         end
       end
 
@@ -107,6 +108,7 @@ module Feed2Email
               entry.process
             rescue => e
               log :error, "#{e.class}: #{e.message.strip}"
+              e.backtrace.each {|line| log :debug, line }
             end
 
             seen_entries << entry.uri if e.nil? # record in history if no errors

data/lib/feed2email/logger.rb

@@ -16,6 +16,10 @@ module Feed2Email
       log_path != false
     end
 
+    def log_level
+      config['log_level'] || 'info'
+    end
+
     def log_path
       config['log_path']
     end
@@ -30,7 +34,7 @@ module Feed2Email
 
     def logger
       @logger ||= ::Logger.new(log_to)
-      @logger.level = ::Logger::INFO
+      @logger.level = ::Logger.const_get(log_level.upcase)
       @logger
     end
   end

data/lib/feed2email/mail.rb

@@ -8,7 +8,7 @@ module Feed2Email
     def send
       sleep config['send_delay'] || 10 # avoid Net::SMTPServerBusy errors
 
-      if send_with_smtp?
+      if smtp_configured?
         send_with_smtp
       else
         send_with_sendmail
@@ -17,12 +17,7 @@ module Feed2Email
 
     private
 
-    def body
-      body_data = {
-        :uri     => @entry.uri.escape_html,
-        :title   => @entry.title.escape_html,
-        :content => @entry.content,
-      }
+    def body_html
       %{
         <html>
         <body>
@@ -34,52 +29,72 @@ module Feed2Email
         #{VERSION}</a> at #{Time.now}</p>
         </body>
         </html>
-      }.gsub(/^\s+/, '') % body_data
+      }.gsub(/^\s+/, '') % {
+        :uri     => @entry.uri.escape_html,
+        :title   => @entry.title.strip_html,
+        :content => @entry.content,
+      }
     end
 
-    def config
-      Feed2Email::Config.instance.config
-    end
+    def body_text
+      %{
+        %{title}
+
+        %{content}
 
-    def from
-      from_data = {
-        :name  => @feed_title,
-        :email => from_address,
+        %{uri}
+
+        --
+        Sent by feed2email #{VERSION} at #{Time.now}
+      }.gsub(/^\s+/, '') % {
+        :title   => @entry.title.strip_html,
+        :content => @entry.content.strip_html,
+        :uri     => @entry.uri,
       }
-      '"%{name}" <%{email}>' % from_data
+    end
+
+    def config
+      Feed2Email::Config.instance.config
     end
 
     def from_address
-      if @entry.author && @entry.author['@']
+      if config['sender']
+        config['sender']
+      elsif @entry.author && @entry.author['@']
         @entry.author[/\S+@\S+/]
-      elsif send_with_smtp?
+      elsif smtp_configured?
         '%{user}@%{host}' % {
-          :user => config['smtp_user'],
+          :user => config['smtp_user'].gsub(/\W/, '_'),
           :host => config['smtp_host']
         }
       else
-        to # recipient as a last resort
+        recipient
       end
     end
 
-    def html_part
+    def mail
+      ::Mail.new.tap do |m|
+        m.from      = %{"#{@feed_title}" <#{from_address}>}
+        m.to        = recipient
+        m.subject   = @entry.title.strip_html
+        m.html_part = mail_part('text/html', body_html)
+        m.text_part = mail_part('text/plain', body_text)
+      end.to_s
+    end
+
+    def mail_part(content_type, body)
       part = ::Mail::Part.new
-      part.content_type = 'text/html; charset=UTF-8'
+      part.content_type = "#{content_type}; charset=UTF-8"
       part.body = body
       part
     end
 
-    def mail
-      ::Mail.new.tap do |m|
-        m.from      = from
-        m.to        = to
-        m.subject   = subject
-        m.html_part = html_part
-      end.to_s
+    def recipient
+      config['recipient']
     end
 
     def send_with_sendmail
-      open("|#{sendmail_bin} #{to}", 'w') do |f|
+      open("|#{sendmail_bin} #{recipient}", 'w') do |f|
         f.write(mail)
       end
     end
@@ -95,11 +110,11 @@ module Feed2Email
       smtp = Net::SMTP.new(host, port)
       smtp.enable_starttls if tls
       smtp.start('localhost', user, pass, auth) do
-        smtp.send_message(mail, from_address, to)
+        smtp.send_message(mail, from_address, recipient)
       end
     end
 
-    def send_with_smtp?
+    def smtp_configured?
       config['smtp_host'] &&
         config['smtp_port'] &&
         config['smtp_user'] &&
@@ -109,13 +124,5 @@ module Feed2Email
     def sendmail_bin
       config['sendmail_path'] || '/usr/sbin/sendmail'
     end
-
-    def subject
-      @entry.title
-    end
-
-    def to
-      config['recipient']
-    end
   end
 end

data/lib/feed2email/version.rb

@@ -1,3 +1,3 @@
 module Feed2Email
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Aggelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-22 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: RSS/Atom feed updates in your email
 email:
 - agorf@agorf.gr
@@ -82,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: RSS/Atom feed updates in your email