rrimm 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmQzYTUzZjAyMWExYTJhZjQ5M2YyZmEzMzBkZDY1ZjY5MzNlZGQxZQ==
+    YjVmZjhiNTQwODZhMDc1YTFkMmE1MjU2NDdiMWMxOTFmMGRjYjQ4Yg==
   data.tar.gz: !binary |-
-    NzQ4N2YwM2Q5NzIzZjdkZDZmNDFlNDdlOWY4NmU4ZDZjZWFhMDI2MQ==
+    NGViNGJlOGFiYWYxODU2MWE1OTk3MmNkN2JjY2I4Njk5MGMyODNmYw==
 SHA512:
   metadata.gz: !binary |-
-    NDAxYmVhMWU0NjRhM2JjMDdiZTgyODdmMDQwYzI1NTY5NTM3NTBkNjUwODYz
-    NTg3NGRiYTM4NGJmYTQ3ZjhlNmUyMTgyNDk0ZjUyYmFlYWZjZjg2N2YyNzI1
-    YmYwZDVjZjllN2Y4MjM3NTdlYzZhYTJmY2Y1MDFhZWI2NWQwYjI=
+    MzEzMGE3NTIzNjU2MTViOTI4ZmNlZTRhZGI5YzYzOWM5M2M0Yzc0MGEwNDc4
+    MTNlMjJlZGVjNWZkMzcyYmRiZTkyOWU5ODU5YzZkZTc3N2E1NGI4YjQ2ZTYz
+    M2UyOGQ2ZWEzMDJmNzdkYWFjMzJiNDJiMjc1OWI2MTE5MTRkMDM=
   data.tar.gz: !binary |-
-    NzlhYTc2NDI4MzhjNGI1MDAzYWFiNzUzOWQ1MzI1ZDhjOTIxZDhiYjE0NjUz
-    MzQyMDNmOTZjYzQ3MWNjMGEwYTQ0MWRkMmY2ZDJjNzRjNTZjMTRjODhkNDBm
-    NjQ1ODFiYmMwYTM3ZTAxNzM1MjY4YmEzZTliZGQzOTc3OTE0ZTI=
+    ZTY4YjFiMzNjYjE5ZjU1YjZiMDlmY2IzM2MzMzY4ZTJjZjJhYTU4ZmZhNDY2
+    OTRhMzNmOTBlZGZiNmM5ZjVlMzljODllNjZjNmVhYzliZTBjM2E4NGVjYzU1
+    NWU3NTNjY2VkYThjMWVkNWY1YmJhMjBlY2U4ODg3MmFlMjE3Yjc=

data/.travis.yml

@@ -4,6 +4,9 @@ rvm:
 - 2.0.0
 - 2.1.0
 - ruby-head
+addons:
+  code_climate:
+    repo_token: 80336b2292acc1d2838cc43c583642601efa411f78917a5bd257ee8233a7de1d
 script: bundle exec rspec spec
 deploy:
   provider: rubygems

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+How-to
+------
+
+There are several ways to contribute and all kinds are welcome.
+
+Report bugs : open a github issue, describe the issue and how to reproduce it
+Feature request : open a github issue, describe the feature of your dreams
+Propose a patch : open a PR

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rrimm (0.4.0)
+    rrimm (0.5.0)
       colorize
       feedzirra
       open_uri_redirections
@@ -10,6 +10,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    codeclimate-test-reporter (0.3.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     colorize (0.7.0)
     coveralls (0.7.0)
       multi_json (~> 1.3)
@@ -59,6 +61,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter
   coveralls
   rrimm!
   rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Grégoire Seux
+
+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

@@ -6,6 +6,7 @@ About rrimm
 [![Gem Version](https://badge.fury.io/rb/rrimm.png)](http://badge.fury.io/rb/rrimm)
 [![Dependency Status](https://gemnasium.com/kamaradclimber/rrimm.png)](https://gemnasium.com/kamaradclimber/rrimm)
 [![Coverage Status](https://coveralls.io/repos/kamaradclimber/rrimm/badge.png?branch=master)](https://coveralls.io/r/kamaradclimber/rrimm?branch=master)
+[![Code Climate](https://codeclimate.com/github/kamaradclimber/rrimm.png)](https://codeclimate.com/github/kamaradclimber/rrimm)
 
 In a nutshell
 -------------

data/bin/rrimm

@@ -25,6 +25,11 @@ OptionParser.new do |opts|
     options['concurrency'] = c.to_i
   end
 
+  opts.on('-q', '--quiet',
+          'Activate quiet mode, will only print errors') do
+    options['quiet'] = true
+  end
+
   opts.on('-a', '--action [action]', [:sync, :show, :status],
           'Specify what to do: "sync" feeds, "show" config, display feed "status"') do |action|
     options['action'] = action
@@ -42,16 +47,17 @@ conf = RRImm::Config.new
 conf.load(options['conf_file'])
 
 fetcher = RRImm::Fetcher.new(conf)
-
-case options['action']
-when :sync
-  fetcher.fetch(options['concurrency'])
-when :show
-  conf.show
-when :status
-  one_month = 30 * 86400
-  one_month_ago = Time.now.to_i - one_month
-  six_months_ago = Time.now.to_i - 6 * one_month
-
-  conf.status(one_month_ago, six_months_ago, false)
+IO.open STDOUT.fileno do |ios|
+  case options['action']
+  when :sync
+    fetcher.fetch(options['concurrency'], options['quiet'])
+  when :show
+    conf.show(ios)
+  when :status
+    one_month = 30 * 86400
+    one_month_ago = Time.now.to_i - one_month
+    six_months_ago = Time.now.to_i - 6 * one_month
+
+    conf.status(ios, one_month_ago, six_months_ago, false)
+  end
 end

data/examples/complete_config.rb

@@ -3,22 +3,30 @@ default_formatter RRImm::ItemFormatter::Mail.new(
   to: 'me@me.com'
 )
 pipe "msmtp -t --read-envelope-from"
-#pipe "cat"
 
-feed "http://planet.haskell.org/rss20.xml"
+# most simple declaration : feed [uri]
 feed "http://www.archlinux.org/feeds/news/"
-feed "http://alan.petitepomme.net/cwn/cwn.rss"
 
+# full declaration feed [name] do [block] end
 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
 
+# namespace by category (and soon with all attributes)
+category 'languages' do 
+  feed 'ocaml' do
+    uri 'http://alan.petitepomme.net/cwn/cwn.rss'
+  end
+  feed "http://planet.haskell.org/rss20.xml"
+end

data/lib/rrimm/config.rb

@@ -4,6 +4,7 @@ module RRImm
   class Config
     attr :feeds, :cache
     attr :default_formatter, :pipe
+    attr_accessor :output
 
     def initialize
       @feeds = {}
@@ -21,38 +22,32 @@ module RRImm
       @cache
     end
 
-    def show
-      puts "Cache: #{@cache.name}"
-      puts "  path: #{@cache.path}" unless @cache.path.eql? @cache.name
+    def show(ios)
+      ios.write "Cache: #{@cache.name}\n"
+      ios.write "  path: #{@cache.path}\n" unless @cache.path.eql? @cache.name
 
-      puts "Default formatter: #{default_formatter}" if default_formatter
+      ios.write "Default formatter: #{default_formatter}\n" if default_formatter
       
-      puts "Feeds:"
+      ios.write "Feeds:\n"
       @feeds.values.group_by { |f| f.category }.map do |cat, feeds|
-        if cat.nil? or cat.empty?
-          puts ""
-        else
-          puts "#{cat}:"
-        end
+        ios.write "#{cat || "unamed category"}:\n"
         feeds.each do |feed|
-          fqdn = [feed.name]
-          fqdn << feed.uri unless feed.name.eql? feed.uri
-          puts "- #{fqdn.join ': '}"
+          fqdn = [feed.name, feed.uri].uniq
+          ios.write "- #{fqdn.join ': '}\n"
         end
       end
     end
 
-    def status(old_timestamp, very_old_timestamp, display_old_only)
-      ordered_feeds = @feeds.values.map { |f| [get_cache.read(f), f] }.sort_by { |el| el.first }
-      ordered_feeds.each do |el|
-        f = el[1]
-        case el.first
+    def status(ios, old_timestamp, very_old_timestamp, display_old_only)
+      @feeds.values.map { |f| [ Time.at(get_cache.read(f)), f] }.sort_by { |el| el.first }.each do |el|
+        date, f = el
+        case date.to_i
         when 0..very_old_timestamp
-          puts "#{Time.at(el.first)} #{f.name}".colorize(:red)
+          ios.write "#{date} #{f.name}\n".red
         when very_old_timestamp..old_timestamp
-          puts "#{Time.at(el.first)} #{f.name}".colorize(:yellow)
+          ios.write "#{date} #{f.name}\n".yellow
         else
-          puts "#{Time.at(el.first)} #{f.name}".colorize(:green) unless display_old_only
+          ios.write "#{date} #{f.name}\n".green unless display_old_only
         end
       end
     end

data/lib/rrimm/feed.rb

@@ -7,10 +7,11 @@ module RRImm
     attr_accessor :category
     attr_accessor :pipe
 
-    def initialize(name)
+    def initialize(name, &block)
       @name = name
       @uri = name
       @formatter_class = RRImm::ItemFormatter::Default
+      self.instance_eval(&block) if block
     end
 
     def format(feed, item)

data/lib/rrimm/fetcher.rb

@@ -12,7 +12,8 @@ module RRImm
       @config = config
     end
 
-    def fetch(concurrency=nil)
+    def fetch(concurrency=nil, quiet=false)
+      @quiet ||= quiet
       if concurrency
         parallel_fetch(concurrency)
       else
@@ -34,7 +35,7 @@ module RRImm
 
     def fetch_feed(name, feed_config)
       last_read = Time.at(@config.get_cache.read(feed_config))
-      puts name
+      puts name unless @quiet
       feed = Feedzirra::Feed.fetch_and_parse(feed_config.uri)
       items = feed.entries.select { |item| item.published > last_read }
       last_read = items.collect { |item| item.published }.max unless items.empty?

data/rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/rrimm.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'rrimm'
-  s.version     = '0.4.0'
+  s.version     = '0.5.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"
@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'codeclimate-test-reporter'
 end

data/script/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+
+which bundle > /dev/null 2>&1 || echo "You need ruby and bundler installed. "
+bundle install

data/script/test

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+rspec

data/spec/config_spec.rb

@@ -8,5 +8,42 @@ describe RRImm::Config do
       conf.load(File.join(File.dirname(__FILE__), '..', 'examples', 'most_simple_config.rb'))
       expect(conf.feeds.size).to be 2
     end
+
+    it 'loads feeds properly with complex conf' do
+      conf = RRImm::Config.new
+      expect(conf.feeds.size).to be 0
+      conf.load(File.join(File.dirname(__FILE__), '..', 'examples', 'complete_config.rb'))
+      expect(conf.feeds.size).to be 6
+      expect(conf.feeds['SMBC'].category).to eq 'webcomics'
+      expect(conf.feeds['ocaml'].category).to eq 'languages'
+    end
+  end
+
+  describe 'show' do
+    it 'displays config properly' do
+      ios = StringIO.new
+      conf = RRImm::Config.new
+      conf.load(File.join(File.dirname(__FILE__), '..', 'examples', 'complete_config.rb'))
+      expect{ conf.show(ios) }.not_to raise_error
+      expect(ios.string).to include "default cache"
+    end
+  end
+
+  describe 'status' do
+    it 'prints status properly' do
+      cache = double('cache')
+      allow(cache).to receive(:read).and_return(1, 4, 7)
+      allow(cache).to receive(:path)
+      ios = StringIO.new
+      allow(RRImm::Cache).to receive(:new).and_return(cache)
+      conf = RRImm::Config.new
+      conf.feeds['1_very_old'] = RRImm::Feed.new 'very_old'
+      conf.feeds['3_old'] = RRImm::Feed.new 'old'
+      conf.feeds['7_recent'] = RRImm::Feed.new 'recent'
+      expect{ conf.status(ios, 5, 3, false) }.not_to raise_error
+      expect(ios.string).to include "#{Time.at(1)} very_old\n".red
+      expect(ios.string).to include "#{Time.at(4)} old\n".yellow
+      expect(ios.string).to include "#{Time.at(7)} recent\n".green
+    end
   end
 end

data/spec/feed_spec.rb

@@ -6,7 +6,27 @@ describe RRImm::Feed do
       f = RRImm::Feed.new 'a random feed'
       expect(f.name).to eq('a random feed')
       expect(f.uri).to eq('a random feed')
+      expect(f.default_name?).to be true
+    end
+
+    it 'calls the block if one is specifed' do
+      f = RRImm::Feed.new 'a another feed' do
+        pipe "cat | cat"
+        formatter_class RRImm::ItemFormatter::Mail
+      end
+      expect(f.pipe).to eq "cat | cat"
+      expect(f.formatter_class).to eq RRImm::ItemFormatter::Mail
     end
   end
 
+  describe ".format" do
+    it 'calls formatter' do
+      formatter = double('formatter')
+      f = RRImm::Feed.new 'a random feed'
+      f.pipe "cat /dev/null"
+      f.formatter = formatter
+      expect(formatter).to receive(:format)
+      expect { f.format(nil, nil) }.not_to raise_error
+    end
+  end
 end

data/spec/fetcher_spec.rb

@@ -0,0 +1,37 @@
+require_relative 'spec_helper'
+
+describe RRImm::Fetcher do
+  let(:basic_conf) do
+    xkcd_file = File.join('file://', File.dirname(__FILE__), 'xkcd.xml')
+    feed = RRImm::Feed.new xkcd_file do
+      pipe 'cat > /dev/null'
+    end
+    cache = double('cache_mock')
+    allow(RRImm::Cache).to receive(:new).and_return(cache)
+    allow(cache).to receive(:path)
+
+    allow(cache).to receive(:read).and_return(3829)
+    allow(cache).to receive(:save)
+
+    config = RRImm::Config.new
+    config.feeds['local_xkcd'] = feed
+    config
+  end
+
+  describe '#initialize' do
+    it 'createscorrectly' do
+      expect { RRImm::Fetcher.new basic_conf }.not_to raise_error
+    end
+  end
+
+  describe '#fetch' do
+    it 'fetches correctly' do
+      fetcher = RRImm::Fetcher.new basic_conf
+      expect { fetcher.fetch }.not_to raise_error
+    end
+    it 'fetches correctly when using concurrency' do
+      fetcher = RRImm::Fetcher.new basic_conf
+      expect { fetcher.fetch(5) }.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 require 'coveralls'
 Coveralls.wear!
 
+SimpleCov.minimum_coverage 95
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+
 require 'rspec'
 require_relative '../lib/rrimm'

data/spec/xkcd_spec.rb

@@ -12,11 +12,14 @@ describe RRImm::ItemFormatter::Mail do
     expect(feed.entries.size).to be > 0
     s = StringIO.new
     config = double('config')
-    config.should_receive(:category).and_return nil
-    config.should_receive(:default_name?).and_return(true)
+    config.should_receive(:category).twice.and_return nil
+    config.should_receive(:default_name?).and_return(true, false)
     mail_formatter.format(feed, feed.entries.first, config, s)
-    s.close
     expect(s.string).to eq "From: RRImm <from@example.com>\nTo: to@example.com\nSubject: When You Assume\nContent-Type: text/html;\n\nhttp://xkcd.com/1339/\n\n<img src=\"http://imgs.xkcd.com/comics/when_you_assume.png\" title=\"You know what happens when you assert--you make an ass out of the emergency response team.\" alt=\"You know what happens when you assert--you make an ass out of the emergency response team.\" />\n"
+    s = StringIO.new
+
+    config.should_receive(:name).and_return "Randall Munroe"
+    mail_formatter.format(feed, feed.entries.first, config, s)
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rrimm
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Grégoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_uri_redirections
@@ -94,6 +94,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
 description: imm reboot in ruby. Retrieve rss feeds and send them by email
 email: rrimm@familleseux.net
 executables:
@@ -104,8 +118,10 @@ files:
 - .coveralls.yml
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - bin/rrimm
 - examples/complete_config.rb
@@ -118,10 +134,14 @@ files:
 - lib/rrimm/item_formatter.rb
 - lib/rrimm/item_formatter/default.rb
 - lib/rrimm/item_formatter/mail.rb
+- rakefile
 - rrimm.gemspec
+- script/setup
+- script/test
 - spec/cache_spec.rb
 - spec/config_spec.rb
 - spec/feed_spec.rb
+- spec/fetcher_spec.rb
 - spec/spec_helper.rb
 - spec/xkcd.xml
 - spec/xkcd_spec.rb
@@ -153,6 +173,7 @@ test_files:
 - spec/cache_spec.rb
 - spec/config_spec.rb
 - spec/feed_spec.rb
+- spec/fetcher_spec.rb
 - spec/spec_helper.rb
 - spec/xkcd.xml
 - spec/xkcd_spec.rb