rrimm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4e9e1bbc213cefa46c98c7b54bbad044b6a9475
+  data.tar.gz: 4be8b7dec27cf1a18f527c44b625c2a215d9e6e3
+SHA512:
+  metadata.gz: f0e3732e0467b531dd617b1d8c4b3a123d0e28e03f09c2d39aef9696eed479ec555084769a07a4992771b9fc2d8adc215e7da4e55640c84a5817c7ba7bc4901f
+  data.tar.gz: 1be89e81c363110f4a55b1f3a662abb04272472a782ceaa6bfab4f3c94a7a78c9eab2148da934e467d11ccc81b35b7d389eb259d3796830e5d03a107f37a05b9

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    rrimm (0.1.0)
+      open_uri_redirections
+      parallel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    open_uri_redirections (0.1.4)
+    parallel (0.9.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rrimm!
+  rspec

data/README.md

@@ -0,0 +1,67 @@
+=========
+About rrimm
+=========
+
+[![Build Status](https://travis-ci.org/kamaradclimber/rrimm.png?branch=master)](https://travis-ci.org/kamaradclimber/rrimm)
+
+In a nutshell
+-------------
+
+**Technically**, *rrimm* is a little tool that retrieves a list of RSS/Atom feeds and send them by email.
+
+**Functionally**, *rrimm* makes it possible to use mail readers for feeds, for the sake of *I-want-the-mutt-of-feed-readers* zealots.
+
+**Originally**, *rrimm* is the ruby reboot of the excellent k0ral's *imm* (https://github.com/k0ral/imm).
+The original concept, this README and a lot of ideas are extracted from *imm*. 
+
+*rrimm* is written and configured in *Ruby*.
+
+Informations about versions, dependencies, source repositories and contacts can be found on rubygems.org_.
+
+
+Need & purpose
+--------------
+
+Following numerous RSS/Atom feeds needs organization and aggregation.
+Such needs are usually met by feed readers.
+Although there are a lot of those, some people still feel unsatisfied with the existing implementations.
+
+The expected features of a feed reader could be defined as follows:
+
+- it retrieves items with the following attributes: an author, a date/time, a (possibly enriched) body;
+- items can be sorted, categorized, marked as read/unread, tagged, shared/forwarded;
+- items must be available from anywhere on the internet.
+
+Luckily, there's already a widespread solution that provides such features: mail readers.
+Considering that, *rrimm* aims at projecting the RSS/Atom paradigm onto the mail one; this way, all the existing tools that work on mails can be leveraged to work on RSS/Atom feeds as well, no wheel reinventing.
+
+Such need is already covered by *imm*, a tool written and maintained by k0ral.
+imm's code has grown and is now using powerful concepts for beauty sake. Its source code has lost its readability.
+*rrimm* intends to keep it (really) simple both in features and source code.
+
+
+Function
+--------
+
+*rrimm* does only one thing and does it well: it downloads an RSS/Atom feeds list, and for each new item it writes an email on the standard output. How to write mail is setup in *rrimm*'s configuration file.
+
+No *SMTP* sending, no *IMAP* serving, no aggregating: those should be performed by external tools.
+
+
+Example usage
+-------------
+
+It is possible to setup a Google Reader-like on a server using the following steps:
+
+- schedule *rrimm* to check feeds regularly and write new items into mail format;
+- pipe these emails into any smtp tool (msmtp, sendmail)
+- setup a webmail, bound to the IMAP server above, to read feeds from any computer connected to the internet.
+
+
+Getting started
+---------------
+
+To get started, please fill the configuration file at ``~/.config/rrimm/rrimm.rb`` with your feeds list and settings. An example configuration file is provided with the package. Configuring *rrimm* requires virtually no knowledge of *Ruby* language.
+
+
+.. _rubygems: https://rubygems.org/rrimm

data/bin/rrimm

@@ -0,0 +1,52 @@
+#!/bin/env ruby
+
+begin
+  load 'lib/rrimm.rb'
+rescue LoadError
+  require 'rrimm'
+end
+
+require 'optparse'
+
+options = {
+  'action' => :sync,
+  'conf_file' => File.join(ENV['HOME'], '.config', 'rrimm', 'rrimm.rb'),
+  'concurrency' => 1,
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: rrimm "
+  opts.on('-c', '--config [file]',
+          'configuration file used by rrimm') do |conf_file|
+    options['conf_file'] = conf_file
+  end
+
+  opts.on('-C', '--concurrency N',
+          'concurrency level to fetch feeds. Default 1') do |c|
+    options['concurrency'] = c.to_i
+  end
+
+  opts.on('-a', '--action [action]', [:sync, :show],
+          'Specify what to do: "sync" feeds, "show" config') do |action|
+    options['action'] = action
+  end
+
+  opts.on_tail("-h", "--help", "You know what it does") do
+    puts opts
+    exit
+  end
+end.parse!(ARGV)
+
+
+
+conf = RRImm::Config.new
+conf.load(options['conf_file'])
+
+fetcher = RRImm::Fetcher.new(conf)
+
+case options['action']
+when :sync
+  fetcher.parallel_fetch(options['concurrency'])
+when :show
+  conf.show
+end

data/examples/complete_config.rb

@@ -0,0 +1,24 @@
+default_formatter RRImm::ItemFormatter::Mail.new(
+  from: 'rrimm@example.com',
+  to: 'me@me.com'
+)
+pipe "msmtp -t --read-envelope-from"
+#pipe "cat"
+
+feed "http://planet.haskell.org/rss20.xml"
+feed "http://www.archlinux.org/feeds/news/"
+feed "http://alan.petitepomme.net/cwn/cwn.rss"
+
+feed "xkcd" do
+  uri "http://xkcd.com/rss.xml"
+  category "webcomics"
+end
+feed 'Cartesian comics' do
+  uri 'http://feeds.feedburner.com/CartesianClosedComic?format=xml'
+  category "webcomics"
+end
+feed 'SMBC' do
+  uri "http://www.smbc-comics.com/rss.php"
+  category 'webcomics'
+end
+

data/examples/most_simple_config.rb

@@ -0,0 +1,5 @@
+feed "http://planet.haskell.org/rss20.xml"
+feed "XKCD" do
+  uri "http://xkcd.com/rss.xml"
+  category "webcomics"
+end

data/lib/rrimm.rb

@@ -0,0 +1,7 @@
+require_relative 'rrimm/feed'
+require_relative 'rrimm/config'
+require_relative 'rrimm/fetcher'
+require_relative 'rrimm/item_formatter'
+require_relative 'rrimm/cache'
+require_relative 'rrimm/generic_item'
+require_relative 'rrimm/generic_feed'

data/lib/rrimm/cache.rb

@@ -0,0 +1,60 @@
+module RRImm
+  class Cache
+
+    attr_accessor :name
+    attr_accessor :path
+
+    REMOVE_PATTERNS = [
+        /^.*:\/\/\/?/,
+        /^(http|ftp|file)s?___/,
+        /_+$/,
+    ]
+
+    INVALID_PATTERNS = [
+        /[^\w]/,
+    ]
+
+    DEFAULT_TIMESTAMP = 1
+
+    def initialize(name)
+       @name = name
+       @path = name
+    end
+
+    def path(arg=nil)
+      if arg
+        @path = arg
+      end
+      @path
+    end
+
+    def cache_file(feed)
+      filename = sanitize(feed.uri)
+      File.join(path, filename)
+    end
+
+    def read(feed)
+      file_path = cache_file(feed)
+
+      return DEFAULT_TIMESTAMP unless File.exists?(file_path)
+      timestamp = File.read(file_path)
+      timestamp.to_i
+    end
+
+    def save(feed, timestamp)
+      file_path = cache_file(feed)
+      File.write(file_path, timestamp)
+    end
+
+
+    private
+    def sanitize(name)
+      cleaned_name = INVALID_PATTERNS.inject(name) do |memo,pattern|
+        memo.gsub(pattern, '_')
+      end
+      REMOVE_PATTERNS.inject(cleaned_name) do |memo,pattern|
+        memo.gsub(pattern, '')
+      end
+    end
+  end
+end

data/lib/rrimm/config.rb

@@ -0,0 +1,79 @@
+module RRImm
+  class Config
+    attr :feeds, :cache
+    attr :default_formatter, :pipe
+
+    def initialize
+      @feeds = {}
+      cache "default cache" do
+        path File.join(ENV['HOME'], '.cache', 'rrimm')
+      end
+      @pipe = "cat"
+    end
+
+    def feeds
+      @feeds
+    end
+
+    def get_cache
+      @cache
+    end
+
+    def show
+      puts "Cache: #{@cache.name}"
+      puts "  path: #{@cache.path}" unless @cache.path.eql? @cache.name
+
+      puts "Default formatter: #{default_formatter}" if default_formatter
+      
+      puts "Feeds:"
+      @feeds.values.group_by { |f| f.category }.map do |cat, feeds|
+        puts "#{cat}:" unless cat.nil? or cat.empty?
+        feeds.each do |feed|
+          fqdn = [feed.name]
+          fqdn << feed.uri unless feed.name.eql? feed.uri
+          puts "- #{fqdn.join ': '}"
+        end
+      end
+    end
+
+    def evaluate_feed_definition(feed_name, &block)
+      #this allow to redefine feeds if necessary
+      existing_feed = @feeds[feed_name]
+      new_feed = (existing_feed || Feed.new(feed_name))
+      new_feed.formatter = default_formatter if default_formatter
+      new_feed.pipe = pipe if pipe
+      new_feed.instance_eval(&block) if block
+      new_feed
+    end
+
+    def default_formatter(arg=nil)
+      if arg
+        @default_formatter = arg
+      end
+      @default_formatter
+    end
+
+    def pipe(arg=nil)
+      if arg
+        @pipe = arg
+      end
+      @pipe
+    end
+
+    def feed(name, *args, &block)
+      feed_def = evaluate_feed_definition(name, *args, &block)
+      @feeds[name] = feed_def
+    end
+
+    def load(file)
+      instance_eval(File.read(file), file)
+    end
+
+    def cache(name, *args, &block)
+      @cache = Cache.new name
+      @cache.instance_eval(&block) if block
+      @cache
+    end
+
+  end
+end

data/lib/rrimm/feed.rb

@@ -0,0 +1,55 @@
+module RRImm
+  class Feed
+ 
+    attr_accessor :name
+    attr_accessor :uri
+    attr_accessor :formatter_class, :formatter
+    attr_accessor :category
+    attr_accessor :pipe
+
+    def initialize(name)
+      @name = name
+      @uri = name
+      @formatter_class = RRImm::ItemFormatter::Default
+    end
+
+    def format(feed, item)
+      @formatter ||= @formatter_class.new
+      cmd = %Q<#{pipe}>
+      IO.popen(cmd,'w+') do |pipe|
+        @formatter.format(feed, item, self, pipe)
+        pipe.close_write
+        pipe.read.split("\n").each { |l| puts l }
+      end
+    end
+
+    def category(arg=nil)
+      if arg
+        @category = arg
+      end
+      @category
+    end
+
+    def uri(arg=nil)
+      if arg
+        @uri = arg
+      end
+      @uri
+    end
+
+    def formatter_class(arg=nil)
+      if arg
+        @formatter_class = arg
+      end
+      @formatter_class
+    end
+
+    def pipe(arg=nil)
+      if arg
+        @pipe = arg
+      end
+      @pipe
+    end
+
+  end
+end

data/lib/rrimm/fetcher.rb

@@ -0,0 +1,42 @@
+require 'rss'
+require 'open-uri'
+require 'open_uri_redirections'
+require 'parallel'
+
+module RRImm
+  class Fetcher
+
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def parallel_fetch(concurrency)
+      Parallel.map(@config.feeds, :in_threads => concurrency) do |name,feed_config|
+        fetch_feed(name, feed_config)
+      end
+    end
+
+    def fetch
+      @config.feeds.map do |name,feed_config|
+        fetch_feed(name, feed_config)
+      end
+    end
+
+    def fetch_feed(name, feed_config)
+      last_read = Time.at(@config.get_cache.read(feed_config))
+      puts name
+      open(feed_config.uri, :allow_redirections => :safe) do |rss|
+        feed = RSS::Parser.parse(rss)
+        feed = GenericFeed.new feed
+        items = feed.items.select { |item| item.date > last_read }
+        last_read = items.collect { |item| item.date }.max unless items.empty?
+        items.each do |item|
+          feed_config.format(feed, item)
+        end
+      end
+      @config.get_cache.save(feed_config, last_read.to_i)
+    end
+  end
+end

data/lib/rrimm/generic_feed.rb

@@ -0,0 +1,20 @@
+module RRImm
+  class GenericFeed
+    def initialize(feed)
+      @underlying = feed
+      @items = feed.items.map {|item| GenericItem.new item }
+      case feed
+      when RSS::Rss
+        @title = feed.channel.title
+      when RSS::Atom
+      end
+    end
+
+    attr_accessor :underlying
+    attr_accessor :title
+
+    attr_accessor :items
+
+
+  end
+end

data/lib/rrimm/generic_item.rb

@@ -0,0 +1,38 @@
+module RRImm
+  class GenericItem
+    def initialize(item)
+      @underlying = item
+      case item
+      when RSS::Rss::Channel::Item
+        @date = item.date
+        @title = item.title
+        @link = item.link
+        @content = item.description
+        @author = item.author
+      when RSS::Atom::Feed::Entry
+        @date = item.date || item.updated.content
+        @title = item.title.content
+        @link = item.link
+        @content = item.content
+        @author = item.author
+      else
+        puts item.class
+        fail "Please code this case !"
+        @updated_date = item.updated_date
+        @content = item.content
+      end
+    end
+
+    attr_accessor :underlying
+
+    attr_accessor :title
+    attr :updated_date, :date
+    attr_accessor :link
+    attr_accessor :content
+    attr_accessor :author
+
+    def date
+      @updated_date || @date
+    end
+  end
+end

data/lib/rrimm/item_formatter.rb

@@ -0,0 +1,2 @@
+require_relative 'item_formatter/default'
+require_relative 'item_formatter/mail'

data/lib/rrimm/item_formatter/default.rb

@@ -0,0 +1,10 @@
+module RRImm
+  module ItemFormatter
+    class Default
+      def format(feed, item, feed_config, pipe)
+        pipe.write "#{feed.channel.title}: #{item.title} (#{item.date})"
+        pipe.write "\n"
+      end
+    end
+  end
+end

data/lib/rrimm/item_formatter/mail.rb

@@ -0,0 +1,39 @@
+module RRImm
+  module ItemFormatter
+    class Mail
+
+      attr_accessor :dest, :sender
+
+      def initialize(hash)
+        @dest = hash[:to]
+        @sender = hash[:from]
+      end
+
+      def from(item)
+        if item.author and item.author.include? '@'
+          item.author
+        else
+          @sender
+        end
+      end
+
+      def subject(feed, item, feed_config)
+        subject = item.title
+        subject = "[#{feed_config.category}]#{item.title}" if feed_config.category
+        subject
+      end
+
+      def format(feed, item, feed_config, pipe)
+        pipe.write "From: #{from(item)}\n"
+        pipe.write "To: #{dest}\n"
+        pipe.write "Subject: #{subject(feed, item, feed_config)}\n"
+        pipe.write "Content-Type: text/html;\n"
+        pipe.write "\n"
+        pipe.write item.link
+        pipe.write "\n\n"
+        pipe.write item.content if item.content
+        pipe.write "\n"
+      end
+    end
+  end
+end

data/rrimm.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'rrimm'
+  s.version     = '0.1.0'
+  s.licenses    = ['Apache Licence v2']
+  s.summary     = "RSS to email tool"
+  s.description = "imm reboot in ruby. Retrieve rss feeds and send them by email"
+  s.authors     = ["Grégoire Seux"]
+  s.email       = 'rrimm@familleseux.net'
+  s.homepage    = "http://github.com/kamaradclimber/mosespa"
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- spec/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_development_dependency 'rspec'
+  s.add_dependency 'open_uri_redirections'
+  s.add_dependency 'parallel'
+end

data/spec/cache_spec.rb

@@ -0,0 +1,31 @@
+require 'rspec'
+require_relative '../lib/rrimm'
+
+require 'tmpdir'
+
+describe RRImm::Cache do
+  describe '#new' do
+    it 'uses the name as default path' do
+      cache = RRImm::Cache.new 'default location'
+      expect(cache.path).to eq 'default location'
+    end
+  end
+
+  it 'reads default timestamp if cache is not present' do
+    feed = RRImm::Feed.new 'http://kernel.org/rss'
+    Dir.mktmpdir do |dir|
+      cache = RRImm::Cache.new dir
+      expect(cache.read(feed)).to eq RRImm::Cache::DEFAULT_TIMESTAMP
+    end
+  end
+
+  it 'reads the correct timestamp' do
+    feed = RRImm::Feed.new 'http://kernel.org/rss'
+    now = Time.now.to_i
+    Dir.mktmpdir do |dir|
+      cache = RRImm::Cache.new dir
+      cache.save(feed, now)
+      expect(cache.read(feed)).to eq now
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require_relative '../lib/rrimm'
+
+describe RRImm::Config do
+  describe "#load" do
+    it 'loads feeds properly' do
+      conf = RRImm::Config.new
+      expect(conf.feeds.size).to be 0
+      conf.load(File.join(File.dirname(__FILE__), '..', 'examples', 'most_simple_config.rb'))
+      expect(conf.feeds.size).to be 2
+    end
+  end
+end

data/spec/feed_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require_relative '../lib/rrimm'
+
+describe RRImm::Feed do
+  describe "#new" do
+    it 'uses the name as uri by default' do
+      f = RRImm::Feed.new 'a random feed'
+      expect(f.name).to eq('a random feed')
+      expect(f.uri).to eq('a random feed')
+    end
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rrimm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grégoire Seux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: open_uri_redirections
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: imm reboot in ruby. Retrieve rss feeds and send them by email
+email: rrimm@familleseux.net
+executables:
+- rrimm
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/rrimm
+- examples/complete_config.rb
+- examples/most_simple_config.rb
+- lib/rrimm.rb
+- lib/rrimm/cache.rb
+- lib/rrimm/config.rb
+- lib/rrimm/feed.rb
+- lib/rrimm/fetcher.rb
+- lib/rrimm/generic_feed.rb
+- lib/rrimm/generic_item.rb
+- lib/rrimm/item_formatter.rb
+- lib/rrimm/item_formatter/default.rb
+- lib/rrimm/item_formatter/mail.rb
+- rrimm.gemspec
+- spec/cache_spec.rb
+- spec/config_spec.rb
+- spec/feed_spec.rb
+homepage: http://github.com/kamaradclimber/mosespa
+licenses:
+- Apache Licence v2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: RSS to email tool
+test_files:
+- spec/cache_spec.rb
+- spec/config_spec.rb
+- spec/feed_spec.rb