feed2email 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.2.0
+
+* Add support for sending mail via SMTP
+* Replace command-line configuration with a config file
+
 ### 0.1.0
 
 * Skip entry if pubDate is in the future

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    feed2email (0.0.2)
+    feed2email (0.2.0)
       feedzirra
       mail
 

data/README.md

@@ -6,7 +6,7 @@ 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.
 
-The script was written primarily as a replacement of [rss2email][] and aims to be simpler, faster, smaller and easier to use.
+feed2email was written primarily as a replacement of [rss2email][] and aims to be simpler, faster, smaller and easier to use.
 
 [rss2email]: http://www.allthingsrss.com/rss2email/
 
@@ -18,37 +18,82 @@ Install as a [gem][] from [RubyGems][]:
 $ gem install feed2email
 ~~~
 
-You also need to have [Sendmail][] working in your system to send mail. I use [msmtp][] which is a nice alternative with a compatible Sendmail interface.
-
 [gem]: http://rubygems.org/gems/feed2email
 [RubyGems]: http://rubygems.org/
-[Sendmail]: http://en.wikipedia.org/wiki/Sendmail
-[msmtp]: http://msmtp.sourceforge.net/
 
-## Use
+## Configuration
 
-Create `~/.feed2email/feeds.yml` and add the address of each feed you want to subscribe to, prefixed with a dash and a space.
+Since version 0.2.0, feed2email no longer supports command-line arguments and is configured through a [YAML][] configuration file located under `~/.feed2email/config.yml`.
 
-When run for the first time, the script enters "dry run" mode and exits almost immediately. During dry run mode:
+There are two ways to send mail: SMTP and Sendmail. If `config.yml` contains options for both, feed2email will use SMTP.
 
-* No feeds are fetched and, thus, no email is sent (existing feed entries are considered already seen)
-* `~/.feed2email/state.yml` is created containing the timestamp of when each feed was last fetched
+[YAML]: http://en.wikipedia.org/wiki/YAML
 
-If you want to receive existing entries from a specific feed, you can manually alter the timestamp for that feed in `state.yml` to a value in the past. Next time you run the script, all entries published past that timestamp will be sent with email.
+### SMTP
 
-To run the script:
+Since version 0.2.0, it is possible to send mail via SMTP.
 
-~~~ sh
-$ feed2email name@example.com
+Here's a sample `config.yml` file:
+
+~~~ yaml
+recipient: johndoe@example.org
+smtp_host: mail.example.org
+smtp_port: 587
+smtp_user: johndoe
+smtp_pass: 12345
+smtp_tls: true
+smtp_auth: login
 ~~~
 
-It's also possible to override the path to the [Sendmail][] binary:
+A short explanation of the available options:
+
+* `recipient` is the email address to send updates to
+* `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 mail account
+* `smtp_pass` is the password of your mail account (see the warning below)
+* `smtp_tls` (optional) controls TLS (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`.
+
+### Sendmail
+
+For this method you need to have [Sendmail][] setup and working in your system. It is also possible to use [a program with a Sendmail-compatible interface][msmtp].
+
+Assuming you have everything setup and working, here's a sample `config.yml` file:
+
+~~~ yaml
+recipient: johndoe@example.org
+sendmail_path: /usr/sbin/sendmail
+~~~
+
+A short explanation of the available options:
+
+* `recipient` is the email address to send updates to
+* `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/
+
+## Use
+
+Create `~/.feed2email/feeds.yml` and add the address of each feed you want to subscribe to, prefixed with a dash and a space.
+
+Then run it:
 
 ~~~ sh
-$ SENDMAIL=/path/to/sendmail feed2email name@example.com
+$ feed2email
 ~~~
 
-You can use [cron][] to run the script e.g. once every hour.
+When run for the first time, feed2email enters "dry run" mode and exits almost immediately. During dry run mode:
+
+* No feeds are fetched and, thus, no email is sent (existing feed entries are considered already seen)
+* `~/.feed2email/state.yml` is created containing the timestamp of when each feed was last fetched
+
+If you want to receive existing entries from a specific feed, you can manually alter the timestamp for that feed in `state.yml` to a value in the past. Next time you run feed2email, all entries published past that timestamp will be sent with email.
+
+You can use [cron][] to run feed2email automatically e.g. once every hour.
 
 [cron]: http://en.wikipedia.org/wiki/Cron
 

data/bin/feed2email

@@ -1,10 +1,5 @@
 #!/usr/bin/env ruby
 
-if %w{-h --help}.include?(ARGV[0]) || (ARGV[0].nil? && ENV['MAILTO'].nil?)
-  $stderr.puts "usage: #{$0} <recipient>"
-  exit 1
-end
-
 require 'feed2email'
 
-Feed2Email::Feed.process_all(:recipient => ARGV[0] || ENV['MAILTO'])
+Feed2Email::Feed.process_all

data/lib/feed2email.rb

@@ -2,6 +2,7 @@ require 'cgi'
 require 'feedzirra'
 require 'fileutils'
 require 'mail'
+require 'net/smtp'
 require 'yaml'
 
 require 'feed2email/version'

data/lib/feed2email/feed.rb

@@ -1,29 +1,51 @@
 module Feed2Email
-  FEEDS_FILE = File.expand_path('~/.feed2email/feeds.yml')
-  STATE_FILE = File.expand_path('~/.feed2email/state.yml')
-  USER_AGENT = "feed2email/#{VERSION}"
+  CONFIG_DIR  = File.expand_path('~/.feed2email')
+  CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')
+  FEEDS_FILE  = File.join(CONFIG_DIR, 'feeds.yml')
+  STATE_FILE  = File.join(CONFIG_DIR, 'state.yml')
+  USER_AGENT  = "feed2email/#{VERSION}"
 
   class Feed
-    def self.process(uri, options)
-      Feed.new(uri, options).process
+    def self.process(uri)
+      Feed.new(uri).process
     end
 
-    def self.process_all(options)
-      FileUtils.mkdir_p(File.dirname(STATE_FILE)) rescue nil
+    def self.process_all
+      FileUtils.mkdir_p(CONFIG_DIR)
+
+      $config = YAML.load(open(CONFIG_FILE)) rescue nil
+
+      if !$config.is_a? Hash
+        $stderr.puts "Error: missing or invalid config file #{CONFIG_FILE}"
+        exit 1
+      end
+
+      if '%o' % (File.stat(CONFIG_FILE).mode & 0777) != '600'
+        $stderr.puts "Error: invalid permissions for config file #{CONFIG_FILE}"
+        exit 2
+      end
+
+      if $config['recipient'].nil?
+        $stderr.puts "Error: recipient missing from config file #{CONFIG_FILE}"
+        exit 3
+      end
+
+      feed_uris = YAML.load(open(FEEDS_FILE)) rescue nil
+
+      if !feed_uris.is_a? Array
+        $stderr.puts "Error: missing or invalid feeds file #{FEEDS_FILE}"
+        exit 4
+      end
 
       @@fetch_times = YAML.load(open(STATE_FILE)) rescue {}
 
-      feed_uris = YAML.load(open(FEEDS_FILE)) rescue []
-      feed_uris.each {|uri| Feed.process(uri, options) }
+      feed_uris.each {|uri| Feed.process(uri) }
 
       open(STATE_FILE, 'w') {|f| f.write(@@fetch_times.to_yaml) }
     end
 
-    attr_reader :options
-
-    def initialize(uri, options)
+    def initialize(uri)
       @uri = uri
-      @options = options
     end
 
     def fetch_time

data/lib/feed2email/mail.rb

@@ -1,11 +1,22 @@
 module Feed2Email
-  SENDMAIL = ENV['SENDMAIL'] || '/usr/sbin/sendmail'
-
   class Mail
     def initialize(entry)
       @entry = entry
     end
 
+    def send
+      if $config['smtp_host'] &&
+          $config['smtp_port'] &&
+          $config['smtp_user'] &&
+          $config['smtp_pass']
+        send_with_smtp
+      else
+        send_with_sendmail
+      end
+    end
+
+    private
+
     def body
       body_data = {
         :uri     => @entry.uri.escape_html,
@@ -29,14 +40,17 @@ module Feed2Email
     def from
       from_data = {
         :name  => @entry.feed.title,
-        :email => @entry.author,
+        :email => from_address,
       }
+      '"%{name}" <%{email}>' % from_data
+    end
 
-      if from_data[:email].nil? || from_data[:email]['@'].nil?
-        from_data[:email] = to
+    def from_address
+      if @entry.author && @entry.author['@']
+        @entry.author
+      else
+        to
       end
-
-      '"%{name}" <%{email}>' % from_data
     end
 
     def html_part
@@ -52,21 +66,40 @@ module Feed2Email
         m.to        = to
         m.subject   = subject
         m.html_part = html_part
-      end
+      end.to_s
     end
 
-    def send
-      open("|#{SENDMAIL} #{to}", 'w') do |f|
+    def send_with_sendmail
+      open("|#{sendmail_bin} #{to}", 'w') do |f|
         f.write(mail)
       end
     end
 
+    def send_with_smtp
+      host = $config['smtp_host']
+      port = $config['smtp_port']
+      user = $config['smtp_user']
+      pass = $config['smtp_pass']
+      tls  = $config['smtp_tls'] || $config['smtp_tls'].nil? # on by default
+      auth = ($config['smtp_auth'] || 'login').to_sym # login by default
+
+      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)
+      end
+    end
+
+    def sendmail_bin
+      $config['sendmail_path'] || '/usr/sbin/sendmail'
+    end
+
     def subject
       @entry.title
     end
 
     def to
-      @entry.feed.options[:recipient]
+      $config['recipient']
     end
   end
 end

data/lib/feed2email/version.rb

@@ -1,3 +1,3 @@
 module Feed2Email
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
@@ -79,12 +79,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2515505025282581014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2515505025282581014
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -92,4 +98,3 @@ signing_key:
 specification_version: 3
 summary: RSS/Atom feed updates in your email
 test_files: []
-has_rdoc: