feed2mail 0.0.1

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright 2011 Thibault Jouan. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+  * Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+  * Neither the name of the software nor the names of its contributors may be
+    used to endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,20 @@
+# feed2mail
+
+Feed to mail gateway.
+
+
+## Usage
+
+Create a `$HOME/.feed2mail/config.yaml` file in your home directory:
+
+  - uri: http://blog.example.net/feed.rss
+  - uri: http://another-blog.example.net/feed.rss
+
+Now you can run:
+
+  feed2mail
+
+
+## Requirements
+
+- ruby

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+namespace :rcov do
+  RSpec::Core::RakeTask.new :spec do |t|
+    t.rcov = true
+    t.rcov_opts = %w[-Ilib -Ispec --exclude "gems/*"]
+    t.rcov_opts << %w[--no-html --text-report]
+  end
+end
+
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+Rake::GemPackageTask.new gemspec do |pkg|
+  pkg.need_tar = true
+end

data/TODO

@@ -0,0 +1 @@
+* add some tests!

data/bin/feed2mail.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'feed2mail'
+
+Feed2Mail::CLI.run ARGV

data/feed2mail.gemspec

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
+require 'feed2mail'
+
+Gem::Specification.new do |s|
+  s.name    = 'feed2mail'
+  s.version = Feed2Mail::VERSION
+  s.summary = 'Read feeds and send items by mail'
+  s.description = <<-eoh
+    Feed2Mail is a feed to mail gateway. Feeds can be listed in a
+    config file, and new feed items will be reported by mail.
+  eoh
+
+  s.author  = 'Thibault Jouan'
+  s.email   = 'tj@a13.fr'
+
+  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_dependency 'htmlentities', '>= 4.2.4'
+  s.add_dependency 'pony', '>= 1.1'
+  s.add_dependency 'simple-rss', '>= 1.2.3'
+
+  s.add_development_dependency 'rspec', '>= 2.5.0'
+end

data/lib/feed2mail.rb

@@ -0,0 +1,12 @@
+require 'feed2mail/cli'
+require 'feed2mail/config'
+require 'feed2mail/feed'
+require 'feed2mail/history'
+require 'feed2mail/item'
+require 'feed2mail/report'
+
+module Feed2Mail
+  VERSION     = '0.0.1'
+  CONFIG_PATH = '~/.feed2mail/config.yaml'
+  HIST_FILE   = '~/.feed2mail/history.yaml'
+end

data/lib/feed2mail/cli.rb

@@ -0,0 +1,26 @@
+require 'optparse'
+
+module Feed2Mail
+  class CLI
+    def self.run(args)
+      config = Feed2Mail::Config.new
+      config.load
+
+      OptionParser.new do |o|
+        o.banner = "Usage: #{File.basename $0} [options]"
+        o.on '-v', '--verbose', 'verbose mode' do |v|
+          config.verbose = v
+        end
+        o.on_tail '-h', '--help', 'show this message' do
+          puts o
+          exit
+        end
+      end.parse!
+
+      report = Feed2Mail::Report.new config
+      report.update
+
+      report.mail :from => 'tj+from@a13.fr', :to => 'tj+to@a13.fr'
+    end
+  end
+end

data/lib/feed2mail/config.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+
+module Feed2Mail
+  class Config
+    attr_reader   :feeds
+    attr_accessor :verbose, :hist_file
+
+    def initialize
+      @feeds = []
+    end
+
+    def load(file = CONFIG_PATH)
+      @rc = YAML.load_file(File.expand_path(file))
+      @rc['feeds'].each do |f|
+        @feeds << Feed.new(f['uri'])
+      end
+    end
+  end
+end

data/lib/feed2mail/feed.rb

@@ -0,0 +1,18 @@
+require 'simple-rss'
+require 'open-uri'
+
+module Feed2Mail
+  class Feed
+    attr_reader :uri
+
+    def initialize(uri)
+      @uri = uri
+      @data = nil
+    end
+
+    def items
+      @data ||= SimpleRSS.parse open @uri
+      @data.entries.collect { |e| Item.new e }
+    end
+  end
+end

data/lib/feed2mail/history.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+
+module Feed2Mail
+  class History
+    def initialize(config)
+      @hist_file = config.hist_file || HIST_FILE
+      begin
+        @hist = YAML.load_file(File.expand_path(@hist_file))
+      rescue Errno::ENOENT
+        @hist = []
+      end
+    end
+
+    def has?(uri)
+      @hist.include?(uri) ? true : false
+    end
+
+    def <<(other)
+      @hist << other
+    end
+
+    def save!
+      File.open File.expand_path(@hist_file), 'w' do |h|
+        h.write @hist.to_yaml
+      end
+    end
+  end
+end

data/lib/feed2mail/item.rb

@@ -0,0 +1,16 @@
+require 'htmlentities'
+
+module Feed2Mail
+  class Item
+    attr_reader :uri, :title, :description
+
+    def initialize(entry)
+      @uri          = entry[:guid] || entry[:link]
+
+      coder = HTMLEntities.new
+
+      @title        = coder.decode entry[:title]
+      @description  = coder.decode entry[:description]
+    end
+  end
+end

data/lib/feed2mail/report.rb

@@ -0,0 +1,53 @@
+require 'pony'
+
+module Feed2Mail
+  class Report
+    attr_reader :items
+
+    def initialize(config)
+      @feeds = config.feeds
+      @items = []
+      @history = History.new config
+    end
+
+    def to_s
+      out = ''
+      @items.each do |i|
+        out << <<-eoh
+#{i.title}
+#{i.uri}
+
+        eoh
+      end
+
+      out
+    end
+
+    def mail(opts)
+      Pony.mail(
+        :via_options  => { :arguments => '-i' },
+        :charset      => 'UTF-8',
+        :from         => opts[:from],
+        :to           => opts[:to],
+        :subject      => 'Feed2Mail: new feed items published',
+        :body         => to_s
+      )
+    end
+
+    def update
+      @feeds.each do |f|
+        f.items.each do |i|
+          unless seen? i
+            @items << i
+            @history << i.uri
+          end
+        end
+      end
+      @history.save!
+    end
+
+    def seen?(item)
+      @history.has?(item.uri) ? true : false
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Config do
+  before do
+    @config = Feed2Mail::Config.new
+  end
+
+  context '#new' do
+    it 'has no feed when created' do
+      @config.feeds.should be_empty
+    end
+  end
+
+  context 'attribute storing' do
+    it 'stores feed' do
+      uri = 'http://example.net/feed.rss'
+      @config.feeds << Feed2Mail::Feed.new(uri)
+      @config.should have(1).feeds
+      @config.feeds.first.uri.should == uri
+    end
+  end
+
+  context '#load' do
+    it 'parses config file' do
+      @config.load(File.expand_path(File.dirname(__FILE__) + '/data/config.yaml'))
+      @config.feeds[0].uri.should == 'http://example.net/feed.rss'
+      @config.feeds[1].uri.should == 'http://example.example.net/other_feed.rss'
+    end
+  end
+end

data/spec/data/config.yaml

@@ -0,0 +1,3 @@
+feeds:
+  - uri: http://example.net/feed.rss
+  - uri: http://example.example.net/other_feed.rss

data/spec/data/feed.rss

@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<rss version="2.0">
+  <channel>
+    <title>Feed sample</title>
+    <link>http://feed-sample.example.net/</link>
+    <description>Feed description.</description>
+    <item>
+      <title>Item 1 title</title>
+      <link>http://feed-sample.example.net/item/1</link>
+      <description><![CDATA[Item 1 description]]></description>
+    </item>
+    <item>
+      <title>Item 2 title &#171;&#160;&amp;&#160;&#187;</title>
+      <link>http://feed-sample.example.net/item/2</link>
+      <description>
+       Item 2 description with entity &#171;&#160;test&#160;&#187;
+      </description>
+    </item>
+  </channel>
+</rss>

data/spec/data/history.yaml

@@ -0,0 +1,2 @@
+- http://example.net/sample-uri-1
+- http://example.net/sample-uri-2

data/spec/feed_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'Feed' do
+  before do
+    @feed_uri = File.expand_path(File.dirname(__FILE__) + '/data/feed.rss')
+    @feed = Feed2Mail::Feed.new(@feed_uri)
+  end
+
+  context '#new' do
+    it 'has an URI when created' do
+      @feed.uri.should == @feed_uri
+    end
+  end
+
+  context 'feeds' do
+    it 'load all items' do
+      @feed.should have(2).items
+    end
+  end
+end

data/spec/history_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe 'History' do
+  before do
+    @config = Feed2Mail::Config.new
+    @hist_file = Tempfile.new 'hist'
+    FileUtils.cp File.expand_path(File.dirname(__FILE__) + '/data/history.yaml'),
+      @hist_file.path
+    @config.hist_file = @hist_file.path
+    @history = Feed2Mail::History.new @config
+  end
+
+  after do
+    @hist_file.close
+    @hist_file.unlink
+  end
+
+  it 'load history file' do
+    @history.has?('http://example.net/sample-uri-1').should be_true
+    @history.has?('http://example.net/sample-uri-2').should be_true
+    @history.has?('http://example.net/sample-uri-3').should be_false
+  end
+
+  it 'save history file' do
+    @history << 'http://example.net/sample-uri-new'
+    @history.save!
+
+    @new_history = Feed2Mail::History.new @config
+    @new_history.has?('http://example.net/sample-uri-1').should be_true
+    @new_history.has?('http://example.net/sample-uri-2').should be_true
+    @new_history.has?('http://example.net/sample-uri-new').should be_true
+  end
+
+  context 'no history file' do
+    before do
+      config = Feed2Mail::Config.new
+      hist_file = File.expand_path(File.dirname(__FILE__) + '/data/NONE.yaml')
+      config.hist_file = hist_file
+      @history = Feed2Mail::History.new config
+    end
+
+    it 'has empty history when no history file' do
+      @history.instance_variable_get('@hist').should be_empty
+    end
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Item' do
+  before do
+    feed_uri = File.expand_path(File.dirname(__FILE__) + '/data/feed.rss')
+    feed = Feed2Mail::Feed.new feed_uri
+    @item_0 = feed.items[0]
+    @item_1 = feed.items[1]
+  end
+
+  context '#new' do
+    it 'has an URI when created' do
+      @item_0.uri.should == 'http://feed-sample.example.net/item/1'
+    end
+
+    it 'has a title when created' do
+      @item_0.title.should == 'Item 1 title'
+    end
+
+    it 'has a description when created' do
+      @item_0.description.should == 'Item 1 description'
+    end
+  end
+
+  context 'entities' do
+    it 'convert in title' do
+      @item_1.title.should == 'Item 2 title « & »'
+    end
+
+    it 'convert in description' do
+      @item_1.description.should == 'Item 2 description with entity « test »'
+    end
+  end
+end

data/spec/report_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe 'Report' do
+  before do
+    @config = Feed2Mail::Config.new
+    @hist_file = Tempfile.new 'hist'
+    FileUtils.cp File.expand_path(File.dirname(__FILE__) + '/data/history.yaml'),
+      @hist_file.path
+    @config.hist_file = @hist_file.path
+  end
+
+  after do
+    @hist_file.close
+    @hist_file.unlink
+  end
+
+  context '#new' do
+    it 'return empty output with no items' do
+      report = Feed2Mail::Report.new @config
+      report.to_s.should == ''
+    end
+  end
+
+  context 'reporting' do
+    before do
+      feed_uri = File.expand_path(File.dirname(__FILE__) + '/data/feed.rss')
+      @config.feeds << Feed2Mail::Feed.new(feed_uri)
+      @report = Feed2Mail::Report.new @config
+      @report.update
+    end
+
+    it 'contains feed items' do
+      @report.to_s.should match('Item 1 title')
+      @report.to_s.should match('Item 2 title « & »')
+    end
+
+    it 'contains feed items links' do
+      @report.to_s.should match('http://feed-sample.example.net/item/1')
+      @report.to_s.should match('http://feed-sample.example.net/item/2')
+    end
+
+    it 'mails the content' do
+      Pony.stub!(:deliver)
+      Pony.should_receive(:deliver) do |mail|
+        mail.to_s.should match /^From: from@example.net\r$/
+        mail.to_s.should match /^To: to@example.net\r$/
+        mail.to_s.should match /^Subject: Feed2Mail: new feed items published\r$/
+        mail.to_s.should match /^http:\/\/feed-sample\.example\.net\/item\/1\r$/
+        #FIXME use 8bit instead of quoted-printable?
+        #mail.to_s.should match /^Item 2 title « & »\r$/
+      end
+      @report.mail :from => 'from@example.net', :to => 'to@example.net'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'tempfile'
+require 'fileutils'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/feed2mail')

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: feed2mail
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thibault Jouan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 4
+        - 2
+        - 4
+        version: 4.2.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pony
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simple-rss
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id004
+description: "    Feed2Mail is a feed to mail gateway. Feeds can be listed in a\n    config file, and new feed items will be reported by mail.\n"
+email: tj@a13.fr
+executables: 
+- feed2mail.rb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- bin/feed2mail.rb
+- feed2mail.gemspec
+- lib/feed2mail.rb
+- lib/feed2mail/cli.rb
+- lib/feed2mail/config.rb
+- lib/feed2mail/feed.rb
+- lib/feed2mail/history.rb
+- lib/feed2mail/item.rb
+- lib/feed2mail/report.rb
+- spec/config_spec.rb
+- spec/data/config.yaml
+- spec/data/feed.rss
+- spec/data/history.yaml
+- spec/feed_spec.rb
+- spec/history_spec.rb
+- spec/item_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Read feeds and send items by mail
+test_files: 
+- spec/config_spec.rb
+- spec/data/config.yaml
+- spec/data/feed.rss
+- spec/data/history.yaml
+- spec/feed_spec.rb
+- spec/history_spec.rb
+- spec/item_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb