feed2email 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,9 @@
+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:
+
+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.

data/README.md

@@ -0,0 +1,63 @@
+# feed2email
+
+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.
+
+The script was written primarily as a replacement of the [rss2email][] program which is rather big, slow, bloated and hard to use.
+
+[rss2email]: http://www.allthingsrss.com/rss2email/
+
+## Installation
+
+Install as a [gem][] from [RubyGems][]:
+
+~~~ sh
+$ 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
+
+Create `~/.feed2email/feeds.yml` and add the address of each feed you want to subscribe to, prefixed with a dash and a space.
+
+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
+
+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.
+
+Here's how to run the script:
+
+~~~ sh
+$ MAILTO=agorfatagorfdotgr feed2email
+~~~
+
+It's also possible to override the path to the [Sendmail][] binary:
+
+~~~ sh
+$ SENDMAIL=/path/to/sendmail MAILTO=agorfatagorfdotgr feed2email
+~~~
+
+**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
+
+## License
+
+Licensed under the MIT license (see `LICENSE.txt`).
+
+## Author
+
+Aggelos Orfanakos, <http://agorf.gr/>

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/feed2email

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'feed2email'
+
+Feed2Email::Feed.process_all

data/feed2email.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feed2email/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'feed2email'
+  gem.version       = Feed2Email::VERSION
+
+  gem.authors       = ['Aggelos Orfanakos']
+  gem.date          = Date.today
+  gem.email         = ['agorf@agorf.gr']
+  gem.homepage      = 'http://github.com/agorf/feed2email'
+
+  gem.description   = %q{RSS/Atom feed updates in your email}
+  gem.summary       = gem.description
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map {|f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'feedzirra'
+  gem.add_dependency 'mail'
+end

data/feeds.yml.sample

@@ -0,0 +1,3 @@
+---
+- http://feeds.feedburner.com/agorf
+- http://api.twitter.com/1/statuses/user_timeline.rss?screen_name=agorf

data/lib/feed2email/core_ext.rb

@@ -0,0 +1,5 @@
+class String
+  def escape_html
+    CGI.escapeHTML(self)
+  end
+end

data/lib/feed2email/entry.rb

@@ -0,0 +1,44 @@
+module Feed2Email
+  class Entry
+    attr_reader :feed
+
+    def self.process(data, feed)
+      Entry.new(data, feed).process
+    end
+
+    def initialize(data, feed)
+      @data = data
+      @feed = feed
+    end
+
+    def author
+      @data.author
+    end
+
+    def content
+      @data.content || @data.summary
+    end
+
+    def process
+      to_mail.send if new?
+    end
+
+    def title
+      @data.title
+    end
+
+    def url
+      @data.url
+    end
+
+    private
+
+    def new?
+      @data.published > @feed.fetch_time
+    end
+
+    def to_mail
+      Mail.new(self)
+    end
+  end
+end

data/lib/feed2email/feed.rb

@@ -0,0 +1,72 @@
+module Feed2Email
+  FEEDS_FILE = File.expand_path('~/.feed2email/feeds.yml')
+  CACHE_FILE = File.expand_path('~/.feed2email/cache.yml')
+  USER_AGENT = "feed2email/#{VERSION}"
+
+  class Feed
+    def self.process(uri)
+      Feed.new(uri).process
+    end
+
+    def self.process_all
+      Dir.mkdir(File.dirname(CACHE_FILE)) rescue nil
+
+      @@fetch_times = YAML.load(open(CACHE_FILE)) rescue {}
+
+      feed_uris = YAML.load(open(FEEDS_FILE)) rescue []
+      feed_uris.each {|uri| Feed.process(uri) }
+
+      open(CACHE_FILE, 'w') {|f| f.write(@@fetch_times.to_yaml) }
+    end
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def fetch_time
+      @@fetch_times[@uri]
+    end
+
+    def process
+      process_entries if seen_before? && fetched? && have_entries?
+      sync_fetch_time if !seen_before? || fetched?
+    end
+
+    def title
+      data.title
+    end
+
+    private
+
+    def data
+      @fetched_at ||= Time.now
+      @data ||= Feedzirra::Feed.fetch_and_parse(@uri, :user_agent => USER_AGENT)
+    end
+
+    def entries
+      data.entries
+    end
+
+    def fetched?
+      data.respond_to?(:entries)
+    end
+
+    def have_entries?
+      data.entries.any?
+    end
+
+    def process_entries
+      entries.each do |entry_data|
+        Entry.process(entry_data, self)
+      end
+    end
+
+    def seen_before?
+      fetch_time.is_a?(Time)
+    end
+
+    def sync_fetch_time
+      @@fetch_times[@uri] = @fetched_at || Time.now
+    end
+  end
+end

data/lib/feed2email/mail.rb

@@ -0,0 +1,70 @@
+module Feed2Email
+  SENDMAIL = ENV['SENDMAIL'] || '/usr/sbin/sendmail'
+  MAILTO   = ENV['MAILTO'] || ENV['USER']
+
+  class Mail
+    def initialize(entry)
+      @entry = entry
+    end
+
+    def body
+      body_data = {
+        :url     => @entry.url.escape_html,
+        :title   => @entry.title.escape_html,
+        :content => @entry.content,
+      }
+      %{
+        <html>
+        <body>
+        <h1><a href="%{url}">%{title}</a></h1>
+        %{content}
+        <p><a href="%{url}">%{url}</a></p>
+        </body>
+        </html>
+      }.gsub(/^\s+/, '') % body_data
+    end
+
+    def from
+      from_data = {
+        :name  => @entry.feed.title,
+        :email => @entry.author,
+      }
+
+      if from_data[:email].nil? || from_data[:email]['@'].nil?
+        from_data[:email] = to
+      end
+
+      '"%{name}" <%{email}>' % from_data
+    end
+
+    def html_part
+      part = ::Mail::Part.new
+      part.content_type = 'text/html; charset=UTF-8'
+      part.body = body
+      part
+    end
+
+    def mail
+      ::Mail.new.tap do |m|
+        m.from      = from
+        m.to        = to
+        m.subject   = subject
+        m.html_part = html_part
+      end
+    end
+
+    def send
+      open("|#{SENDMAIL} #{to}", 'w') do |f|
+        f.write(mail)
+      end
+    end
+
+    def subject
+      @entry.title
+    end
+
+    def to
+      MAILTO
+    end
+  end
+end

data/lib/feed2email/version.rb

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

data/lib/feed2email.rb

@@ -0,0 +1,10 @@
+require 'cgi'
+require 'feedzirra'
+require 'mail'
+require 'yaml'
+
+require 'feed2email/version'
+require 'feed2email/core_ext'
+require 'feed2email/mail'
+require 'feed2email/entry'
+require 'feed2email/feed'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: feed2email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aggelos Orfanakos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 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
+email:
+- agorf@agorf.gr
+executables:
+- feed2email
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/feed2email
+- feed2email.gemspec
+- feeds.yml.sample
+- lib/feed2email.rb
+- lib/feed2email/core_ext.rb
+- lib/feed2email/entry.rb
+- lib/feed2email/feed.rb
+- lib/feed2email/mail.rb
+- lib/feed2email/version.rb
+homepage: http://github.com/agorf/feed2email
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RSS/Atom feed updates in your email
+test_files: []