feed2email 0.2.1 → 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c37536cc5633493536c5d46a079717773feb25a
+  data.tar.gz: af6456d9ac843c5e2972ae231ec8bebb39a2b0b6
+SHA512:
+  metadata.gz: a967e6d52c3a5ec70ffe6772cc6b478776a61d21fc1c09e56cddc5d080f57544135b1fbee814d9b116ddbbe88def9c2e51c9bbbc47e355b9c716c6d0e9eb9814
+  data.tar.gz: c58f7436d84347b5e52e66ceef8d30674ba7905f8d1f5ee1e062cb234524604b4cd07042a310486cda8c6475acbe9cd5a53335cebee5587ff51ae8c33cd81b18

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.2.2
+
+* Fix smtp_tls option never being false
+* Use SMTP user@host as "from" address if entry author is missing
+
 ### 0.2.1
 
 * Add config option to delay mail sending

data/Gemfile.lock

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

data/LICENSE.txt

@@ -2,8 +2,19 @@ The MIT License
 
 Copyright (c) 2013 Aggelos Orfanakos
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -4,9 +4,11 @@ RSS/Atom feed updates in your email
 
 ## Why
 
-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.
+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 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/
 
@@ -25,42 +27,54 @@ $ gem install feed2email
 
 Through a [YAML][] file at `~/.feed2email/config.yml`.
 
-There are two ways to send mail: SMTP and Sendmail. If `config.yml` contains options for both, feed2email will use SMTP.
+It is possible to send email via SMTP or an [MTA][]. 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`
+Each line in the configuration file contains a key-value pair. Each key-value
+pair is separated with a colon: `foo: bar`
 
 ### Generic options
 
 * `recipient` (required) is the email address to send email to
-* `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 turn off)
+* `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 turn off)
 
 ### SMTP
 
 * `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_user` is the username of your email account
+* `smtp_pass` is the password of your email 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`)
+* `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`.
+**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
+### MTA
 
-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].
+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][].
 
-* `sendmail_path` (optional) is the path to the Sendmail binary (default is `/usr/sbin/sendmail`)
+* `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
 
-Create `~/.feed2email/feeds.yml` and add the address of each feed you want to subscribe to, prefixed with a dash and a space.
+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:
 
@@ -68,12 +82,18 @@ Then run it:
 $ feed2email
 ~~~
 
-When run for the first time, feed2email enters "dry run" mode and exits almost immediately. During dry run mode:
+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
+* 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.
+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.
 

data/feed2email.gemspec

@@ -2,6 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'feed2email/version'
+require 'date'
 
 Gem::Specification.new do |gem|
   gem.name          = 'feed2email'

data/lib/feed2email.rb

@@ -5,6 +5,7 @@ require 'mail'
 require 'net/smtp'
 require 'yaml'
 
+require 'feed2email/config'
 require 'feed2email/version'
 require 'feed2email/core_ext'
 require 'feed2email/mail'

data/lib/feed2email/config.rb

@@ -0,0 +1,32 @@
+module Feed2Email
+  CONFIG_DIR = File.expand_path('~/.feed2email')
+
+  class Config
+    include Singleton
+
+    CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')
+
+    attr_reader :config
+
+    def read!
+      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
+    end
+  end
+end

data/lib/feed2email/feed.rb

@@ -1,34 +1,14 @@
 module Feed2Email
-  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
+    FEEDS_FILE = File.join(CONFIG_DIR, 'feeds.yml')
+    STATE_FILE = File.join(CONFIG_DIR, 'state.yml')
+
     def self.process(uri)
       Feed.new(uri).process
     end
 
     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
+      Feed2Email::Config.instance.read!
 
       feed_uris = YAML.load(open(FEEDS_FILE)) rescue nil
 
@@ -64,9 +44,15 @@ module Feed2Email
     private
 
     def data
-      @fetched_at ||= Time.now
-      fetch_opts = { :user_agent => USER_AGENT, :compress => true }
-      @data ||= Feedzirra::Feed.fetch_and_parse(@uri, fetch_opts)
+      if @data.nil?
+        @data = Feedzirra::Feed.fetch_and_parse(@uri,
+          :user_agent => "feed2email/#{VERSION}",
+          :compress   => true
+        )
+        @fetched_at = Time.now
+      end
+
+      @data
     end
 
     def entries

data/lib/feed2email/mail.rb

@@ -5,9 +5,9 @@ module Feed2Email
     end
 
     def send
-      sleep $config['send_delay'] || 10 # avoid Net::SMTPServerBusy errors
+      sleep config['send_delay'] || 10 # avoid Net::SMTPServerBusy errors
 
-      if smtp_config_present?
+      if send_with_smtp?
         send_with_smtp
       else
         send_with_sendmail
@@ -36,6 +36,10 @@ module Feed2Email
       }.gsub(/^\s+/, '') % body_data
     end
 
+    def config
+      Feed2Email::Config.instance.config
+    end
+
     def from
       from_data = {
         :name  => @entry.feed.title,
@@ -47,8 +51,13 @@ module Feed2Email
     def from_address
       if @entry.author && @entry.author['@']
         @entry.author
+      elsif send_with_smtp?
+        '%{user}@%{host}' % {
+          :user => config['smtp_user'],
+          :host => config['smtp_host']
+        }
       else
-        to
+        to # recipient as a last resort
       end
     end
 
@@ -75,12 +84,12 @@ module Feed2Email
     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
+      host = config['smtp_host']
+      port = config['smtp_port']
+      user = config['smtp_user']
+      pass = config['smtp_pass']
+      tls  = config['smtp_tls'].nil? ? true : config['smtp_tls'] # default: true
+      auth = (config['smtp_auth'] || 'login').to_sym # default: 'login'
 
       smtp = Net::SMTP.new(host, port)
       smtp.enable_starttls if tls
@@ -89,15 +98,15 @@ module Feed2Email
       end
     end
 
-    def sendmail_bin
-      $config['sendmail_path'] || '/usr/sbin/sendmail'
+    def send_with_smtp?
+      config['smtp_host'] &&
+        config['smtp_port'] &&
+        config['smtp_user'] &&
+        config['smtp_pass']
     end
 
-    def smtp_config_present?
-      $config['smtp_host'] &&
-        $config['smtp_port'] &&
-        $config['smtp_user'] &&
-        $config['smtp_pass']
+    def sendmail_bin
+      config['sendmail_path'] || '/usr/sbin/sendmail'
     end
 
     def subject
@@ -105,7 +114,7 @@ module Feed2Email
     end
 
     def to
-      $config['recipient']
+      config['recipient']
     end
   end
 end

data/lib/feed2email/version.rb

@@ -1,3 +1,3 @@
 module Feed2Email
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.2.2
 platform: ruby
 authors:
 - Aggelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: RSS/Atom feed updates in your email
@@ -62,6 +57,7 @@ files:
 - feed2email.gemspec
 - feeds.yml.sample
 - lib/feed2email.rb
+- lib/feed2email/config.rb
 - lib/feed2email/core_ext.rb
 - lib/feed2email/entry.rb
 - lib/feed2email/feed.rb
@@ -69,32 +65,25 @@ files:
 - lib/feed2email/version.rb
 homepage: http://github.com/agorf/feed2email
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1285304786354070987
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1285304786354070987
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RSS/Atom feed updates in your email
 test_files: []