feed2email 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9a92661dec1838e02af880c1e7c0e4c2a37dced
-  data.tar.gz: 879f563ae943c253b987a1c5beeec95b41bb95c3
+  metadata.gz: f18bbfd4e8a09cb263f70c7966af0fa9e6602a3c
+  data.tar.gz: fe00a0445e6010eca1d847861f33687beb7a8dc7
 SHA512:
-  metadata.gz: ad5c3c4fe63c1e5e860a3ea7bfaa5af4b345806c0569853e4a365f34f53cd0c3672fac725e3e2067cca5f5b9a1348f0a1651e5113a2488ee4d8ed80ad82d14be
-  data.tar.gz: f90bb39169407674065bedd943645ec94aee5f2ab825070e0563cc51fd5053665efdc15e054bb51146f466715b06387db668b127bb3faf6e232d48377ecdbe29
+  metadata.gz: 8fddbfd1416024208e32e65ba16a5eeb51c3e6537d6b39d0e49ba945ae8ab5c9bf9c8c14f3e976b173da9f06976e15b54ebc18ac73c62250727f2e3a58eafa1b
+  data.tar.gz: 0f1cbbdcba1768b9f75ad29c21b3c5c4d17cd55446dbaa1aed49fc72d9b63ec58a3c333dd1d8a0001e31f9cc6555ac106a8c40db764bcc127b004a2e0605f69c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.7.0
+
+* Prevent simultaneous running instances
+* Support log rotation
+* Show entry author and pubdate in email
+* Use a single SMTP connection for all email sending
+* Rename `smtp_tls` option to `smtp_starttls`
+
 ### 0.6.0
 
 * Render text/plain body as Markdown

data/README.md

@@ -1,4 +1,4 @@
-# feed2email
+# feed2email [![Gem Version](https://badge.fury.io/rb/feed2email.svg)](http://badge.fury.io/rb/feed2email)
 
 RSS/Atom feed updates in your email
 
@@ -7,9 +7,11 @@ RSS/Atom feed updates in your email
 I don't like having a separate application for feeds when I'm already checking
 my email. I also never read a thing when feeds are kept in a separate place.
 
-feed2email was written primarily as a replacement of [rss2email][] and aims to
-be simpler, faster, smaller and easier to use.
+feed2email is a [headless][] RSS/Atom feed aggregator that sends feed entries
+via email. It was written primarily as a replacement of [rss2email][] and aims
+to be simple, fast and easy to use.
 
+[headless]: http://en.wikipedia.org/wiki/Headless_software
 [rss2email]: http://www.allthingsrss.com/rss2email/
 
 ## Installation
@@ -27,13 +29,7 @@ $ gem install feed2email
 
 Through a [YAML][] file at `~/.feed2email/config.yml`.
 
-It is possible to send email via SMTP or an [MTA][] (default). If `config.yml`
-contains options for both, feed2email will use SMTP.
-
 [YAML]: http://en.wikipedia.org/wiki/YAML
-[MTA]: http://en.wikipedia.org/wiki/Message_transfer_agent
-
-### Format
 
 Each line in the configuration file contains a key-value pair. Each key-value
 pair is separated with a colon: `foo: bar`
@@ -48,9 +44,20 @@ pair is separated with a colon: `foo: bar`
   `true` which logs to standard output; use `false` to disable logging)
 * `log_level` (optional) is the logging verbosity level and can be `fatal`
   (least verbose), `error`, `warn`, `info` (default) and `debug` (most verbose)
+* `log_shift_age` (optional) is the number of _old_ log files to keep or the
+  frequency of rotation (`daily`, `weekly`, `monthly`; default is `0` so only
+  the current log file is kept)
+* `log_shift_size` (optional) is the maximum log file size in _megabytes_ and it
+  only applies when `log_shift_age` is a number greater than zero (default is
+  `1`)
 * `max_entries` (optional) is the maximum number of entries to process per feed
   (default is `20`; use `0` for unlimited)
 
+It is possible to send email via SMTP or an [MTA][] (default). If `config.yml`
+contains options for both, feed2email will use SMTP.
+
+[MTA]: http://en.wikipedia.org/wiki/Message_transfer_agent
+
 ### SMTP
 
 For this method you need to have access to an SMTP service. [Mailgun][] has a
@@ -61,21 +68,22 @@ free plan.
 * `smtp_user` (required) is the username of your email account
 * `smtp_pass` (required) is the password of your email account (see the warning
    below)
-* `smtp_tls` (optional) controls TLS (default is `true`; can also be `false`)
+* `smtp_starttls` (optional) controls STARTTLS (default is `true`; can also be
+  `false`)
 * `smtp_auth` (optional) controls the authentication method (default is `login`;
    can also be `plain` or `cram_md5`)
 
 **Warning:** Unless it has correct restricted permissions, anyone with access in
 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`.
+To set the correct permissions, issue `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 like [msmtp][] or [Postfix][].
+interface set up and working in your system like [msmtp][] or [Postfix][].
 
 * `sendmail_path` (optional) is the path to the Sendmail binary (default is
   `/usr/sbin/sendmail`)
@@ -88,26 +96,20 @@ interface setup and working in your system like [msmtp][] or [Postfix][].
 
 ### Managing feeds
 
-Create `~/.feed2email/feeds.yml` and add the address of each feed you want to
+Create or edit `~/.feed2email/feeds.yml` and add the URL of the feed you want to
 subscribe to, prefixed with a dash and a space:
 
 ~~~ yaml
 - https://github.com/agorf/feed2email/commits.atom
 ~~~
 
-To disable a feed, comment it:
+To disable a feed, comment its line by prefixing it with a hash symbol:
 
 ~~~ yaml
 #- https://github.com/agorf/feed2email/commits.atom
 ~~~
 
-### Running
-
-Simply:
-
-~~~ sh
-$ feed2email
-~~~
+### Running for the first time
 
 When feed2email runs for the first time or after adding a new feed:
 
@@ -121,14 +123,14 @@ provided migration script: `feed2email-migrate-history` If you don't, feed2email
 will think it's run for the first time and will treat all entries as old (thus
 no email will be sent and you may miss some entries).
 
-To receive existing entries from a new feed:
+### Receiving specific entries from a feed
 
-1. Add it to `feeds.yml` (see above)
+1. Add the feed URL to `~/.feed2email/feeds.yml`
 1. Run feed2email once so that the feed's history file is generated
 1. Remove the entries you want to receive from the feed's history (i.e. with
    your text editor)
-1. Remove the feed's meta file (`meta-<digest>.yml`) to bust feed fetching
-   caching
+1. Remove the feed's meta file (`meta-<digest>.yml`, where `<digest>` is the MD5
+   hex digest of the feed URL) to bust feed fetching caching
 
 Next time feed2email runs, these entries will be treated as new and will be
 processed (sent as email).
@@ -138,12 +140,19 @@ processed (sent as email).
 Before processing each feed, feed2email issues a [HEAD request][] to check
 whether it has been permanently moved by looking for a _301 Moved Permanently_
 HTTP status and its respective _Location_ header. In such case, feed2email
-updates `feeds.yml` with the new location and all feed entries are skipped (no
-email sent). If you do want to have some of them sent as email, please refer to
-the _Running_ section.
+updates `~/.feed2email/feeds.yml` with the new location and all feed entries are
+skipped (no email sent). If you do want to have some of them sent as email, see
+[Receiving specific entries from a feed](#receiving-specific-entries-from-a-feed).
 
 [HEAD request]: http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods
 
+### Feed caching
+
+feed2email caches fetched feeds with the _Last-Modified_ and _Etag_ HTTP
+headers. If you want to force a feed to be fetched, remove the feed's meta file
+(`~/.feed2email/meta-<digest>.yml`, where `<digest>` is the MD5 hex digest of
+the feed URL). Next time feed2email runs, the feed will be fetched.
+
 ### Automating
 
 You can use [cron][] to run feed2email automatically e.g. once every hour.

data/TODO.md

@@ -2,7 +2,6 @@
 
 * Specs
 * Do not mark entry as sent if email was not sent
-* Show entry metadata in email (e.g. pubdate, author)
 * Implement a command-line interface to manage feeds.yml
 * Detect entry URI changes (maybe by comparing body hashes?)
 * Filters (e.g. skip entries matching a pattern)
@@ -11,3 +10,7 @@
 * Profiles (support many feed lists and recipients)
 * Send email notifications to user (e.g. when a feed is not available anymore)
 * Plugin architecture
+* Integrate with Mail gem for email sending
+* Do not consider fetched if there was an error
+* begin ensure end
+* Fix sleeping

data/bin/feed2email

@@ -3,4 +3,9 @@
 require 'feed2email'
 require 'feed2email/feed'
 
-Feed2Email::Feed.process_all
+if File.new('/tmp/feed2email.lock', 'w').flock(File::LOCK_NB | File::LOCK_EX)
+  Feed2Email::Feed.process_all
+else
+  $stderr.puts 'An instance of feed2email is already running. Exiting...'
+  exit 1
+end

data/lib/feed2email/config.rb

@@ -87,13 +87,15 @@ module Feed2Email
 
     def defaults
       {
-        'log_level'     => 'info',
-        'log_path'      => true,
-        'max_entries'   => 20,
-        'send_delay'    => 10,
-        'sendmail_path' => '/usr/sbin/sendmail',
-        'smtp_auth'     => 'login',
-        'smtp_tls'      => true,
+        'log_level'      => 'info',
+        'log_path'       => true,
+        'log_shift_age'  => 0,
+        'log_shift_size' => 1, # megabyte
+        'max_entries'    => 20,
+        'send_delay'     => 10,
+        'sendmail_path'  => '/usr/sbin/sendmail',
+        'smtp_auth'      => 'login',
+        'smtp_starttls'  => true,
       }
     end
 

data/lib/feed2email/core_ext.rb

@@ -2,6 +2,12 @@ require 'cgi'
 require 'reverse_markdown'
 require 'sanitize'
 
+class Numeric
+  def megabytes
+    self * 1024 * 2014
+  end
+end
+
 class String
   def escape_html
     CGI.escapeHTML(self)

data/lib/feed2email/entry.rb

@@ -16,6 +16,10 @@ module Feed2Email
       @data.content || @data.summary
     end
 
+    def published
+      @data.published
+    end
+
     def send_mail
       Mail.new(self, @feed_title).send
     end

data/lib/feed2email/feed.rb

@@ -16,31 +16,34 @@ module Feed2Email
   class Feed
     extend Forwardable
 
-    class << self
-      extend Forwardable
+    def self.feed_uris; @feed_uris end
 
-      def_delegators :Feed2Email, :config, :log
+    def self.logger
+      Feed2Email.logger # delegate
     end
 
+    def self.smtp_connection
+      Feed2Email.smtp_connection # delegate
+    end
+
+    logger.debug 'Loading feed subscriptions...'
+    @feed_uris = Feeds.new(File.join(CONFIG_DIR, 'feeds.yml'))
+    logger.info "Subscribed to #{'feed'.pluralize(feed_uris.size)}"
+
     def self.process_all
-      feed_uris.each_with_index do |uri, i|
-        feed = new(uri)
-        feed.process
-        feed_uris[i] = feed.uri # persist possible permanent redirect
+      begin
+        feed_uris.each_with_index do |uri, i|
+          feed = new(uri)
+          feed.process
+          feed_uris[i] = feed.uri # persist possible permanent redirect
+        end
+      ensure
+        smtp_connection.finalize
       end
 
       feed_uris.sync
     end
 
-    def self.feed_uris
-      return @feed_uris if @feed_uris
-
-      log :debug, 'Loading feed subscriptions...'
-      @feed_uris = Feeds.new(File.join(CONFIG_DIR, 'feeds.yml'))
-      log :info, "Subscribed to #{'feed'.pluralize(feed_uris.size)}"
-      @feed_uris
-    end
-
     attr_reader :uri
 
     def initialize(uri)
@@ -48,7 +51,7 @@ module Feed2Email
     end
 
     def process
-      log :info, "Processing feed #{uri} ..."
+      logger.info "Processing feed #{uri} ..."
 
       return unless fetch_and_parse_feed
 
@@ -57,14 +60,14 @@ module Feed2Email
         history.sync
         meta.sync
       else
-        log :warn, 'Feed does not have entries'
+        logger.warn 'Feed does not have entries'
       end
     end
 
     private
 
     def fetch_feed
-      log :debug, 'Fetching feed...'
+      logger.debug 'Fetching feed...'
 
       begin
         handle_permanent_redirection
@@ -82,13 +85,13 @@ module Feed2Email
         end
       rescue OpenURI::HTTPError => e
         if e.message == '304 Not Modified'
-          log :info, 'Feed not modified; skipping...'
+          logger.info 'Feed not modified; skipping...'
           return false
         end
 
         raise
       rescue => e
-        log :error, 'Failed to fetch feed'
+        logger.error 'Failed to fetch feed'
         log_exception(e)
         return false
       end
@@ -102,7 +105,8 @@ module Feed2Email
 
       if response.code == '301' && response['location'] =~ %r{\Ahttps?://}
         self.uri = response['location']
-        log :warn, "Got permanently redirected! Updated feed location to #{uri}"
+        logger.warn(
+          "Got permanently redirected! Updated feed location to #{uri}")
       end
     end
 
@@ -139,12 +143,12 @@ module Feed2Email
     end
 
     def parse_feed(xml_data)
-      log :debug, 'Parsing feed...'
+      logger.debug 'Parsing feed...'
 
       begin
         Feedzirra::Feed.parse(xml_data)
       rescue => e
-        log :error, 'Failed to parse feed'
+        logger.error 'Failed to parse feed'
         log_exception(e)
         return false
       end
@@ -170,8 +174,8 @@ module Feed2Email
       }
     end
 
-    def log(*args)
-      Feed2Email::Feed.log(*args) # delegate
+    def logger
+      Feed2Email.logger # delegate
     end
 
     def max_entries
@@ -179,25 +183,25 @@ module Feed2Email
     end
 
     def process_entries
-      log :info, "Processing #{'entry'.pluralize(entries.size, 'entries')}..."
+      logger.info "Processing #{'entry'.pluralize(entries.size, 'entries')}..."
       entries.each {|entry| process_entry(entry) }
     end
 
     def process_entry(entry)
-      log :info, "Processing entry #{entry.uri} ..."
+      logger.info "Processing entry #{entry.uri} ..."
 
       if history.any?
         if history.include?(entry.uri)
-          log :debug, 'Skipping old entry...'
+          logger.debug 'Skipping old entry...'
         else
           # Sleep between entry processing to avoid Net::SMTPServerBusy errors
           if config['send_delay'] > 0
-            log :debug,
-              "Sleeping for #{'second'.pluralize(config['send_delay'])}"
+            logger.debug(
+              "Sleeping for #{'second'.pluralize(config['send_delay'])}")
             sleep(config['send_delay'])
           end
 
-          log :debug, 'Sending new entry...'
+          logger.debug 'Sending new entry...'
 
           begin
             entry.send_mail
@@ -212,7 +216,7 @@ module Feed2Email
           e = nil
         end
       else
-        log :debug, 'Skipping new feed entry...'
+        logger.debug 'Skipping new feed entry...'
         history << entry.uri
       end
     end
@@ -226,8 +230,8 @@ module Feed2Email
     end
 
     def log_exception(error)
-      log :error, "#{error.class}: #{error.message.strip}"
-      error.backtrace.each {|line| log :debug, line }
+      logger.error "#{error.class}: #{error.message.strip}"
+      error.backtrace.each {|line| logger.debug line }
     end
 
     def_delegator :data, :title, :title

data/lib/feed2email/lazy_smtp_connection.rb

@@ -0,0 +1,34 @@
+require 'net/smtp'
+
+module Feed2Email
+  class LazySMTPConnection
+    def config
+      Feed2Email.config # delegate
+    end
+
+    def connect
+      smtp.start('localhost', config['smtp_user'], config['smtp_pass'],
+                 config['smtp_auth'].to_sym)
+    end
+
+    def connected?
+      smtp.started?
+    end
+
+    def finalize
+      smtp.finish if connected?
+    end
+
+    def send_message(*args)
+      connect unless connected?
+      smtp.send_message(*args)
+    end
+
+    def smtp
+      return @smtp if @smtp
+      @smtp = Net::SMTP.new(config['smtp_host'], config['smtp_port'])
+      @smtp.enable_starttls if config['smtp_starttls']
+      @smtp
+    end
+  end
+end

data/lib/feed2email/logger.rb

@@ -1,42 +1,25 @@
 require 'logger'
+require 'feed2email/core_ext'
 
 module Feed2Email
   class Logger
-    def initialize(log_path, log_level)
-      @log_path = log_path
-      @log_level = log_level
-    end
+    attr_reader :logger
 
-    def log(severity, message)
-      logger.add(::Logger.const_get(severity.upcase), message)
+    def initialize(log_path, log_level, log_shift_age, log_shift_size)
+      @log_path = log_path
+      @logger = ::Logger.new(log_to(log_path), log_shift_age,
+                             log_shift_size.megabytes)
+      @logger.level = ::Logger.const_get(log_level.upcase)
     end
 
     private
 
-    def log_to
+    def log_to(log_path)
       if log_path == true
         $stdout
       elsif log_path # truthy but not true (a path)
         File.expand_path(log_path)
       end
     end
-
-    def logger
-      return @logger if @logger
-
-      @logger = ::Logger.new(log_to)
-
-      if log_level
-        @logger.level = ::Logger.const_get(log_level.upcase)
-      else
-        @logger.level = ::Logger::INFO
-      end
-
-      @logger
-    end
-
-    def log_path; @log_path end
-
-    def log_level; @log_level end
   end
 end

data/lib/feed2email/mail.rb

@@ -1,5 +1,5 @@
 require 'mail'
-require 'net/smtp'
+require 'feed2email/version'
 
 module Feed2Email
   class Mail
@@ -24,6 +24,7 @@ module Feed2Email
         <body>
         <h1><a href="%{uri}">%{title}</a></h1>
         %{content}
+        <p>%{published}</p>
         <p><a href="%{uri}">%{uri}</a></p>
         <p>--<br>
         Sent by <a href="https://github.com/agorf/feed2email">feed2email
@@ -31,38 +32,30 @@ module Feed2Email
         </body>
         </html>
       }.gsub(/^\s+/, '') % {
-        content: @entry.content,
-        title:   @entry.title.strip_html,
-        uri:     @entry.uri.escape_html,
+        content:   entry.content,
+        published: published,
+        title:     entry.title.strip_html,
+        uri:       entry.uri.escape_html,
       }
     end
 
     def body_text
-      %{
-        # [%{title}](%{uri})
-
-        %{content}
-
-        %{uri}
-
-        --
-        Sent by feed2email #{VERSION} at #{Time.now}
-      }.gsub(/^\s+/, '') % {
-        content: @entry.content.to_markdown,
-        title:   @entry.title.strip_html,
-        uri:     @entry.uri,
-      }
+      body_html.to_markdown
     end
 
     def config
       Feed2Email.config # delegate
     end
 
+    def entry; @entry end
+
+    def feed_title; @feed_title end
+
     def mail
       ::Mail.new.tap do |m|
-        m.from      = %{"#{@feed_title}" <#{config['sender']}>}
+        m.from      = %{"#{feed_title}" <#{config['sender']}>}
         m.to        = config['recipient']
-        m.subject   = @entry.title.strip_html
+        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
@@ -75,6 +68,14 @@ module Feed2Email
       part
     end
 
+    def published
+      return nil unless entry.author || entry.published
+      text = 'Published'
+      text << " by #{entry.author}" if entry.author
+      text << " at #{entry.published}" if entry.published
+      text
+    end
+
     def send_with_sendmail
       open("|#{config['sendmail_path']} #{config['recipient']}", 'w') do |f|
         f.write(mail)
@@ -82,17 +83,7 @@ module Feed2Email
     end
 
     def send_with_smtp
-      smtp = Net::SMTP.new(config['smtp_host'], config['smtp_port'])
-      smtp.enable_starttls if config['smtp_tls']
-
-      smtp.start(
-        'localhost',
-        config['smtp_user'],
-        config['smtp_pass'],
-        config['smtp_auth'].to_sym
-      ) do
-        smtp.send_message(mail, config['sender'], config['recipient'])
-      end
+      smtp_connection.send_message(mail, config['sender'], config['recipient'])
     end
 
     def smtp_configured?
@@ -101,5 +92,9 @@ module Feed2Email
         config['smtp_user'] &&
         config['smtp_pass']
     end
+
+    def smtp_connection
+      Feed2Email.smtp_connection
+    end
   end
 end

data/lib/feed2email/version.rb

@@ -1,3 +1,3 @@
 module Feed2Email
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/lib/feed2email.rb

@@ -1,18 +1,22 @@
+require 'feed2email/config'
+require 'feed2email/lazy_smtp_connection'
+require 'feed2email/logger'
+
 module Feed2Email
   CONFIG_DIR = File.expand_path('~/.feed2email')
 
-  def self.config
-    @config ||= Config.new(File.join(CONFIG_DIR, 'config.yml'))
-  end
+  def self.config; @config end
 
   def self.logger
-    @logger ||= Logger.new(config['log_path'], config['log_level'])
+    @logger.logger # delegate
   end
 
-  def self.log(*args)
-    logger.log(*args) # delegate
-  end
-end
+  def self.smtp_connection; @smtp_connection end
 
-require 'feed2email/config'
-require 'feed2email/logger'
+  @config = Config.new(File.join(CONFIG_DIR, 'config.yml'))
+
+  @logger = Logger.new(config['log_path'], config['log_level'],
+                       config['log_shift_age'], config['log_shift_size'])
+
+  @smtp_connection = LazySMTPConnection.new
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Aggelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-01 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
@@ -159,6 +159,7 @@ files:
 - lib/feed2email/feed_history.rb
 - lib/feed2email/feed_meta.rb
 - lib/feed2email/feeds.rb
+- lib/feed2email/lazy_smtp_connection.rb
 - lib/feed2email/logger.rb
 - lib/feed2email/mail.rb
 - lib/feed2email/version.rb