feed2email 0.0.1 → 0.1.0

data/.gitignore

@@ -1,5 +1,4 @@
 *.gem
 *.yml
 .bundle
-Gemfile.lock
 pkg/

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+### 0.1.0
+
+* Skip entry if pubDate is in the future
+* Fix feed fetching by accepting compression
+* Fix crashing for missing multi-level directories in config path
+* Accept recipient address as the first command-line argument
+* Append feed2email signature to email body
+* Use full HTTPS address for RubyGems source in Gemfile
+* Add this changelog
+
+### 0.0.1
+
+* Initial release

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    feed2email (0.0.2)
+      feedzirra
+      mail
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.1.12)
+      multi_json (~> 1.0)
+    builder (3.2.0)
+    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.4)
+    json (1.7.7)
+    loofah (1.2.1)
+      nokogiri (>= 1.4.4)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    nokogiri (1.5.9)
+    polyglot (0.3.3)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sax-machine (0.1.0)
+      nokogiri (> 0.0.0)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  feed2email!

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 the [rss2email][] program which is rather big, slow, bloated and hard to use.
+The script 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/
 
@@ -32,24 +32,22 @@ Create `~/.feed2email/feeds.yml` and add the address of each feed you want to su
 When run for the first time, the script 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/cache.yml` is created containing the timestamp of when each feed was last fetched
+* `~/.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 alter the timestamp for that feed in `cache.yml` to a value in the past. Next time you run the script, 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 the script, all entries published past that timestamp will be sent with email.
 
-Here's how to run the script:
+To run the script:
 
 ~~~ sh
-$ MAILTO=agorfatagorfdotgr feed2email
+$ feed2email name@example.com
 ~~~
 
 It's also possible to override the path to the [Sendmail][] binary:
 
 ~~~ sh
-$ SENDMAIL=/path/to/sendmail MAILTO=agorfatagorfdotgr feed2email
+$ SENDMAIL=/path/to/sendmail feed2email name@example.com
 ~~~
 
-**Note:** Email symbols in the above examples have been replaced with words to avoid spam.
-
 You can use [cron][] to run the script e.g. once every hour.
 
 [cron]: http://en.wikipedia.org/wiki/Cron

data/bin/feed2email

@@ -1,5 +1,10 @@
 #!/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
+Feed2Email::Feed.process_all(:recipient => ARGV[0] || ENV['MAILTO'])

data/lib/feed2email/core_ext.rb

@@ -3,3 +3,9 @@ class String
     CGI.escapeHTML(self)
   end
 end
+
+class Time
+  def past?
+    self < Time.now
+  end
+end

data/lib/feed2email/entry.rb

@@ -20,21 +20,27 @@ module Feed2Email
     end
 
     def process
-      to_mail.send if new?
+      to_mail.send if to_be_sent?
     end
 
     def title
       @data.title
     end
 
-    def url
+    def uri
       @data.url
     end
 
     private
 
-    def new?
-      @data.published > @feed.fetch_time
+    def published_at
+      @data.published
+    end
+
+    def to_be_sent?
+      published_at &&
+        published_at.past? && # respect entry future pubDate
+        published_at > @feed.fetch_time
     end
 
     def to_mail

data/lib/feed2email/feed.rb

@@ -1,26 +1,29 @@
 module Feed2Email
   FEEDS_FILE = File.expand_path('~/.feed2email/feeds.yml')
-  CACHE_FILE = File.expand_path('~/.feed2email/cache.yml')
+  STATE_FILE = File.expand_path('~/.feed2email/state.yml')
   USER_AGENT = "feed2email/#{VERSION}"
 
   class Feed
-    def self.process(uri)
-      Feed.new(uri).process
+    def self.process(uri, options)
+      Feed.new(uri, options).process
     end
 
-    def self.process_all
-      Dir.mkdir(File.dirname(CACHE_FILE)) rescue nil
+    def self.process_all(options)
+      FileUtils.mkdir_p(File.dirname(STATE_FILE)) rescue nil
 
-      @@fetch_times = YAML.load(open(CACHE_FILE)) rescue {}
+      @@fetch_times = YAML.load(open(STATE_FILE)) rescue {}
 
       feed_uris = YAML.load(open(FEEDS_FILE)) rescue []
-      feed_uris.each {|uri| Feed.process(uri) }
+      feed_uris.each {|uri| Feed.process(uri, options) }
 
-      open(CACHE_FILE, 'w') {|f| f.write(@@fetch_times.to_yaml) }
+      open(STATE_FILE, 'w') {|f| f.write(@@fetch_times.to_yaml) }
     end
 
-    def initialize(uri)
+    attr_reader :options
+
+    def initialize(uri, options)
       @uri = uri
+      @options = options
     end
 
     def fetch_time
@@ -40,7 +43,8 @@ module Feed2Email
 
     def data
       @fetched_at ||= Time.now
-      @data ||= Feedzirra::Feed.fetch_and_parse(@uri, :user_agent => USER_AGENT)
+      fetch_opts = { :user_agent => USER_AGENT, :compress => true }
+      @data ||= Feedzirra::Feed.fetch_and_parse(@uri, fetch_opts)
     end
 
     def entries
@@ -52,7 +56,7 @@ module Feed2Email
     end
 
     def have_entries?
-      data.entries.any?
+      entries.any?
     end
 
     def process_entries

data/lib/feed2email/mail.rb

@@ -1,6 +1,5 @@
 module Feed2Email
   SENDMAIL = ENV['SENDMAIL'] || '/usr/sbin/sendmail'
-  MAILTO   = ENV['MAILTO'] || ENV['USER']
 
   class Mail
     def initialize(entry)
@@ -9,16 +8,19 @@ module Feed2Email
 
     def body
       body_data = {
-        :url     => @entry.url.escape_html,
+        :uri     => @entry.uri.escape_html,
         :title   => @entry.title.escape_html,
         :content => @entry.content,
       }
       %{
         <html>
         <body>
-        <h1><a href="%{url}">%{title}</a></h1>
+        <h1><a href="%{uri}">%{title}</a></h1>
         %{content}
-        <p><a href="%{url}">%{url}</a></p>
+        <p><a href="%{uri}">%{uri}</a></p>
+        <p>--<br>
+        Sent by <a href="https://github.com/agorf/feed2email">feed2email
+        #{VERSION}</a> at #{Time.now}</p>
         </body>
         </html>
       }.gsub(/^\s+/, '') % body_data
@@ -64,7 +66,7 @@ module Feed2Email
     end
 
     def to
-      MAILTO
+      @entry.feed.options[:recipient]
     end
   end
 end

data/lib/feed2email/version.rb

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

data/lib/feed2email.rb

@@ -1,5 +1,6 @@
 require 'cgi'
 require 'feedzirra'
+require 'fileutils'
 require 'mail'
 require 'yaml'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
@@ -52,7 +52,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -90,3 +92,4 @@ signing_key:
 specification_version: 3
 summary: RSS/Atom feed updates in your email
 test_files: []
+has_rdoc: