feed2email 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51069bce6917475aa8499384d330396eebde34c1
-  data.tar.gz: cde703782a959046c866aa459123d050e6df5fc2
+  metadata.gz: e90ae1ad818a1966844926f7653f068a284a13d3
+  data.tar.gz: 1f6ed9ac284fc677ca57d89cbcbf6a29543a1a19
 SHA512:
-  metadata.gz: 702e5ab54cd401d097b572bfdea2acfc48af045382ddc988135a1f93d8b100790c950b1cf1c32a0405feab4ae8d746c289fffd3ed328ff6974e2418eef87f383
-  data.tar.gz: 271c7c5d97acbc461dcdf24ac481255d0ddd6a387535c8fb9dc1fef58fcb6783aed9235c87d7a089de6e625036e06ae6399ec2f3b861486af257c697bb526f0f
+  metadata.gz: 7654f7a35ae49c97c79e39b4141d0e2ef52aa952db6c953a4d31550ea50606937ff3c862b94617e1132e64fd42c82ab84dadceb7dfbadc43e6b5a852acdb44e9
+  data.tar.gz: 685064935abc8fbe1a6ec02be6fb2223dfdf7d8ed192cc1262839650f1f61538e6f760c90bb368f298fdb0127e5e9c895dcb08c01bd539993b5ccc703daa0a1e

data/CHANGELOG.md

@@ -1,15 +1,26 @@
+### 0.9.0
+
+* Change data backend from YAML to SQLite3
+* Add `send_method` config option to send emails with
+* Add `file` send method for writing emails to a file
+* Add `backend` command to open an SQLite3 db shell
+* Add `config` command to open config with `$EDITOR`
+* Add `import`/`export` command to import/export feed subscriptions as OPML
+* Remove `history` command
+* Provide a single script for migrating (`feed2email-migrate`)
+
 ### 0.8.0
 
-* Command-line interface for managing feeds (c20bf0c, e5c6dec)
-* Perform feed autodiscovery in `add` command (46523ee)
-* Store feed metadata in feed list, so no more feed files (cfbd725)
-* Add `f2e` symlink to `feed2email` binary for running convenience (6add6b9)
-* Improve send delay between entry processing (2118aef)
-* Fix feed fetching exception handling (8eb68cf)
-* Sync feed metadata only if all entries are processed (73f0947)
-* Record entry to history only if email was sent (db59e77)
-* Always fetch feed when permanently redirected (4fb147f)
-* Ignore redirections to the same location (26513d1e)
+* Command-line interface for managing feeds
+* Perform feed autodiscovery in `add` command
+* Store feed metadata in feed list, so no more feed files
+* Add `f2e` symlink to `feed2email` binary for running convenience
+* Improve send delay between entry processing
+* Fix feed fetching exception handling
+* Sync feed metadata only if all entries are processed
+* Record entry to history only if email was sent
+* Always fetch feed when permanently redirected
+* Ignore redirections to the same location
 * Major rewrite of README file with new instructions
 
 ### 0.7.0

data/README.md

@@ -9,13 +9,18 @@ to be simple, fast and easy to use.
 
 ## Features
 
-* Easy command-line feed management (add, remove, enable/disable)
-* Feed fetching caching
-* Feed autodiscovery
-* Support for sending email with SMTP or a local MTA (e.g. sendmail)
+* Command-line feed management (add, remove, enable/disable)
+* Feed fetching caching (_Last-Modified_ and _ETag_ HTTP headers)
+* [Feed autodiscovery](http://www.rssboard.org/rss-autodiscovery)
+* [OPML][] import/export of feed subscriptions
+* Email sending with SMTP, [Sendmail][] (or compatible [MTA][]) or by writing to
+  a file
 * _text/html_ and _text/plain_ (Markdown) multipart emails
-* Support for feed permanent redirections
-* Auto-fixing relative feed entry permalinks
+* Permanent redirection support for feed URLs
+
+[OPML]: http://en.wikipedia.org/wiki/OPML
+[Sendmail]: http://en.wikipedia.org/wiki/Sendmail
+[MTA]: http://en.wikipedia.org/wiki/Message_transfer_agent
 
 ## Installation
 
@@ -25,22 +30,46 @@ As a [gem][] from [RubyGems][]:
 $ gem install feed2email
 ~~~
 
+If the above command fails due to missing headers, make sure the following
+packages for [curb][] and [sqlite3][] gems are installed:
+
+~~~ sh
+$ sudo apt-get install libcurl4-openssl-dev libsqlite3-dev
+~~~
+
+**Warning:** If you are updating from an earlier version of feed2email, make
+sure you run `feed2email-migrate` to migrate its data before using it.
+
 [gem]: http://rubygems.org/gems/feed2email
 [RubyGems]: http://rubygems.org/
+[curb]: https://rubygems.org/gems/curb
+[sqlite3]: https://rubygems.org/gems/sqlite3
 
 ## Configuration
 
-Through a [YAML][] file that you create at `~/.feed2email/config.yml`.
+Through a [YAML][] file at `~/.feed2email/config.yml`.
 
-[YAML]: http://en.wikipedia.org/wiki/YAML
+Edit it with the `config` command:
+
+~~~ sh
+$ # same as "f2e c"
+$ feed2email config
+~~~
+
+**Note:** The command will fail if the `EDITOR` environmental variable is not
+set.
 
 Each line in the configuration file contains a key-value pair. Each key-value
 pair is separated with a colon, e.g.: `foo: bar`
 
+[YAML]: http://en.wikipedia.org/wiki/YAML
+
 ### General options
 
 * `recipient` (required) is the email address to send email to
 * `sender` (required) is the email address to send email from (can be any)
+* `send_method` (optional) is the method to send email with and can be `file`
+  (default), `sendmail` or `smtp`
 * `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)
 * `max_entries` (optional) is the maximum number of entries to process per feed
@@ -51,7 +80,7 @@ pair is separated with a colon, e.g.: `foo: bar`
 * `log_path` (optional) is the _absolute_ path to the log file (default is
   `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)
+  (least verbose), `error`, `warn`, `info` (default) or `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)
@@ -59,12 +88,26 @@ pair is separated with a colon, e.g.: `foo: bar`
   only applies when `log_shift_age` is a number greater than zero (default is
   `1`)
 
-### Delivery options
+### Sending options
 
-It is possible to send email via SMTP or an [MTA][] (default). If `config.yml`
-contains options for both, feed2email will use SMTP.
+#### File
 
-[MTA]: http://en.wikipedia.org/wiki/Message_transfer_agent
+This method simply writes emails to a file (named after the `recipient` config
+option) in a path that you specify.
+
+* `mail_path` (optional) is the path to write emails in (default is `~/Mail/`)
+
+#### Sendmail
+
+For this method you need to have [Sendmail][] or an [MTA][] with a
+Sendmail-compatible interface (e.g. [msmtp][], [Postfix][]) set up and working
+in your system.
+
+* `sendmail_path` (optional) is the path to the Sendmail binary (default is
+  `/usr/sbin/sendmail`)
+
+[msmtp]: http://msmtp.sourceforge.net/
+[Postfix]: http://en.wikipedia.org/wiki/Postfix_(software)
 
 #### SMTP
 
@@ -88,145 +131,154 @@ 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 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`)
-
-[Sendmail]: http://en.wikipedia.org/wiki/Sendmail
-[msmtp]: http://msmtp.sourceforge.net/
-[Postfix]: http://en.wikipedia.org/wiki/Postfix_(software)
-
 ## Use
 
 ### Managing feeds
 
-First, add some feeds:
+Add some feeds:
 
 ~~~ sh
-$ feed2email add https://github.com/agorf.atom
-Added feed https://github.com/agorf.atom at index 0
 $ feed2email add https://github.com/agorf/feed2email/commits.atom
-Added feed https://github.com/agorf/feed2email/commits.atom at index 1
+Added feed:   1 https://github.com/agorf/feed2email/commits.atom
+$ # same as "feed2email add https://github.com/agorf.atom"
+$ f2e a https://github.com/agorf.atom
+Added feed:   2 https://github.com/agorf.atom
 ~~~
 
-**Tip:** You only have to type a feed2email command until it is unambiguous e.g.
-instead of `feed2email list`, you can simply issue `feed2email l` as long as
-there is no other command beginning with an `l`.
-
-It is also possible to pass a website URL and let feed2email autodiscover any
-feeds:
+Passing a website URL to the `add` command will have feed2email autodiscover any
+feeds in that page:
 
 ~~~ sh
-$ feed2email add http://www.rubyinside.com/
+$ f2e add http://www.rubyinside.com/
 0: http://www.rubyinside.com/feed/ "Ruby Inside" (application/rss+xml)
 Please enter a feed to subscribe to: 0
-Added feed http://www.rubyinside.com/feed/ at index 2
-$ feed2email add http://thechangelog.com/137/
+Added feed:   3 http://www.rubyinside.com/feed/
+$ f2e add http://thechangelog.com/137/
 0: http://thechangelog.com/137/feed/ "The Changelog » #137: Better GitHub Issues with HuBoard and Ryan Rauh Comments Feed" (application/rss+xml)
 1: http://thechangelog.com/feed/ "RSS 2.0 Feed" (application/rss+xml)
 Please enter a feed to subscribe to: 1
-Added feed http://thechangelog.com/feed/ at index 3
-$ feed2email add http://thechangelog.com/137/
+Added feed:   4 http://thechangelog.com/feed/
+$ # cancel autodiscovery by pressing Ctrl-C
+$ f2e add http://thechangelog.com/137/
 0: http://thechangelog.com/137/feed/ "The Changelog » #137: Better GitHub Issues with HuBoard and Ryan Rauh Comments Feed" (application/rss+xml)
 Please enter a feed to subscribe to: ^C
 ~~~
 
-Note that on the last command, feed2email autodiscovers the same two feeds as in
-the second command, but only lists the ones that haven't been already added.
-Autodiscovery is then cancelled by pressing `Ctrl-C`.
+**Note:** When autodiscovering feeds, feed2email lists only those that don't
+already exist in your feed subscriptions.
 
 The feed list so far:
 
 ~~~ sh
+$ # same as "f2e l"
 $ feed2email list
-0: https://github.com/agorf.atom
-1: https://github.com/agorf/feed2email/commits.atom
-2: http://www.rubyinside.com/feed/
-3: http://thechangelog.com/feed/
+  1 https://github.com/agorf/feed2email/commits.atom
+  2 https://github.com/agorf.atom
+  3 http://www.rubyinside.com/feed/
+  4 http://thechangelog.com/feed/
 ~~~
 
-To disable a feed so that it is not processed with `feed2email process`, toggle
-it:
+A feed can be disabled so that it is not processed when `feed2email process`
+runs with the `toggle` command:
 
 ~~~ sh
+$ # same as "f2e t 1"
 $ feed2email toggle 1
-Disabled feed at index 1
-$ feed2email list
-0: https://github.com/agorf.atom
-1: DISABLED https://github.com/agorf/feed2email/commits.atom
-2: http://www.rubyinside.com/feed/
-3: http://thechangelog.com/feed/
+Toggled feed:   1 DISABLED https://github.com/agorf/feed2email/commits.atom
 ~~~
 
-It is also possible to remove it from the list:
+It can be enabled with the `toggle` command again:
 
 ~~~ sh
+$ # same as "feed2email toggle 1"
+$ f2e t 1
+Toggled feed:   1 https://github.com/agorf/feed2email/commits.atom
+~~~
+
+It can also be removed from feed subscriptions permanently:
+
+~~~ sh
+$ # same as "f2e r 1"
 $ feed2email remove 1
-Removed feed at index 1
-Warning: Feed list indices have changed!
+Removed feed:   1 https://github.com/agorf/feed2email/commits.atom
 ~~~
 
-It has been removed, but what is that weird warning?
+### Migrating to/from feed2email
 
-Since the feed that got removed was at index 1, every feed below it got
-reindexed. So feed2email warns you that the feed indices have changed: the feed
-at index 2 is now at index 1 and the feed at index 3 is now at index 2.
+feed2email supports importing and exporting feed subscriptions as [OPML][]. This
+makes it easy to migrate to and away from feed2email anytime you want.
 
-Indeed:
+Export feed subscriptions to `feeds.xml`:
 
 ~~~ sh
-$ feed2email list
-0: https://github.com/agorf.atom
-1: http://www.rubyinside.com/feed/
-2: http://thechangelog.com/feed/
+$ # same as "f2e e feeds.xml"
+$ feed2email export feeds.xml
+This may take a bit. Please wait...
+Exported 3 feed subscriptions to feeds.xml
+~~~
+
+Import feed subscriptions from `feeds.xml`:
+
+~~~ sh
+$ # same as "f2e i feeds.xml"
+$ feed2email import feeds.xml
+Importing...
+Feed already exists:   2 https://github.com/agorf.atom
+Feed already exists:   3 http://www.rubyinside.com/feed/
+Feed already exists:   4 http://thechangelog.com/feed/
 ~~~
 
-**Tip:** feed2email installs `f2e` as a symbolic link to the feed2email binary,
-so you can use that to avoid typing the whole name every time, e.g.: `f2e list`
-or even `f2e l`.
+Nothing was imported since all feeds already exist. Let's remove them first and
+then try again:
+
+~~~ sh
+$ f2e r 2
+Removed feed:   2 https://github.com/agorf.atom
+$ f2e r 3
+Removed feed:   3 http://www.rubyinside.com/feed/
+$ f2e r 4
+Removed feed:   4 http://thechangelog.com/feed/
+$ f2e l
+No feeds
+$ feed2email import feeds.xml
+Importing...
+Imported feed:   1 https://github.com/agorf.atom
+Imported feed:   2 http://www.rubyinside.com/feed/
+Imported feed:   3 http://thechangelog.com/feed/
+Imported 3 feed subscriptions from feeds.xml
+~~~
 
 ### Running
 
 ~~~ sh
+$ # same as "f2e p"
 $ feed2email process
 ~~~
 
 When run, feed2email will go through your feed list, fetch each feed (if
-necessary) and send an email for each new entry. Any output is logged to the
+necessary) and send an email for each new entry. Output is logged to the
 standard output, unless configured otherwise.
 
-**Warning:** Prior to version 0.8.0 where a command-line interface was
-introduced, the way to run feed2email was simply `feed2email`. Now this will
-just print helpful text on how to use it.
-
 When a new feed is detected (which is the case when feed2email runs for the
 first time on your feed list), all of its entries are skipped and no email is
 sent. This is so that you don't get spammed when you add a feed for the first
 time.
 
-If you want to receive a specific entry from a newly added feed, edit the feed's
-history file with `feed2email history` and remove the entry. Then issue
-`feed2email fetch` to clear the feed's fetch cache. Next time
-`feed2email process` runs, the entry will be treated as new and will be
-processed.
-
 ### Getting help
 
-Issue `feed2email` or `feed2email help` at any point to get helpful text on how
-to use feed2email.
+Issue `feed2email help` (`f2e h`) or just `feed2email` (`f2e`) at any point to
+get helpful text on how to use feed2email.
 
 ## Contributing
 
-Using feed2email and want to help? Just [contact me](http://agorf.gr/) and
-describe how you use it and if you have any ideas on how it can be improved.
+Using feed2email and want to help? [Let me know](http://agorf.gr/) how you use
+it and if you have any ideas on how to improve it.
 
 ## License
 
-Licensed under the MIT license (see `LICENSE.txt`).
+Licensed under the MIT license (see [LICENSE.txt][license]).
+
+[license]: https://github.com/agorf/feed2email/blob/master/LICENSE.txt
 
 ## Author
 

data/bin/f2e

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
 
-if File.new('/tmp/feed2email.lock', 'w').flock(File::LOCK_NB | File::LOCK_EX)
-  require 'feed2email/cli'
-  Feed2Email::Cli.start(ARGV)
-else
+LOCK_FILE = '/tmp/feed2email.lock'
+
+unless File.new(LOCK_FILE, 'w').flock(File::LOCK_NB | File::LOCK_EX)
   abort 'An instance of feed2email is already running. Exiting...'
 end
 
+require 'feed2email/cli'
+
+Feed2Email::Cli.start(ARGV)

data/bin/feed2email

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
 
-if File.new('/tmp/feed2email.lock', 'w').flock(File::LOCK_NB | File::LOCK_EX)
-  require 'feed2email/cli'
-  Feed2Email::Cli.start(ARGV)
-else
+LOCK_FILE = '/tmp/feed2email.lock'
+
+unless File.new(LOCK_FILE, 'w').flock(File::LOCK_NB | File::LOCK_EX)
   abort 'An instance of feed2email is already running. Exiting...'
 end
 
+require 'feed2email/cli'
+
+Feed2Email::Cli.start(ARGV)

data/bin/feed2email-migrate

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'feed2email/migrate/convert_feeds_migration'
+require 'feed2email/migrate/feeds_import_migration'
+require 'feed2email/migrate/history_import_migration'
+require 'feed2email/migrate/split_history_migration'
+
+include Feed2Email::Migrate
+
+[
+  SplitHistoryMigration,
+  ConvertFeedsMigration,
+  FeedsImportMigration,
+  HistoryImportMigration
+].each do |klass|
+  if klass.new.apply
+    print 'Applied '
+  else
+    print 'Skipped '
+  end
+
+  puts klass.to_s
+end

data/lib/feed2email.rb

@@ -1,17 +1,14 @@
+require 'pathname'
 require 'feed2email/config'
-require 'feed2email/feed_list'
-require 'feed2email/lazy_smtp_connection'
 require 'feed2email/logger'
 
 module Feed2Email
-  CONFIG_DIR = File.join(ENV['HOME'], '.feed2email')
-
   def self.config
-    @config ||= Config.new(File.join(CONFIG_DIR, 'config.yml'))
+    @config ||= Config.new(config_path)
   end
 
-  def self.feed_list
-    @feed_list ||= FeedList.new(File.join(CONFIG_DIR, 'feeds.yml'))
+  def self.config_path
+    root.join('config.yml').to_s
   end
 
   def self.logger
@@ -21,7 +18,7 @@ module Feed2Email
     ).logger
   end
 
-  def self.smtp_connection
-    @smtp_connection ||= LazySMTPConnection.new
+  def self.root
+    @root ||= Pathname.new(ENV['HOME']).join('.feed2email')
   end
 end