feed2email 0.7.0 → 0.8.0

data/lib/feed2email/feed_list.rb

@@ -0,0 +1,147 @@
+require 'forwardable'
+require 'thor'
+require 'yaml'
+
+module Feed2Email
+  class FeedList
+    class DuplicateFeedError < StandardError; end
+
+    extend Forwardable
+
+    def initialize(path)
+      @path = path
+      @dirty = false
+    end
+
+    def_delegators :data, :size, :each, :each_with_index, :empty?, :[]
+
+    def <<(uri)
+      if index = find_feed_by_uri(uri)
+        raise DuplicateFeedError, "Feed #{uri} already exists at index #{index}"
+      end
+
+      mark_dirty
+      data << { uri: uri, enabled: true }
+    end
+
+    def clear_fetch_cache(index)
+      mark_dirty
+      data[index].delete(:last_modified)
+      data[index].delete(:etag)
+    end
+
+    def delete_at(index)
+      if deleted = data.delete_at(index)
+        mark_dirty
+        deleted
+      end
+    end
+
+    def include?(uri)
+      !find_feed_by_uri(uri).nil?
+    end
+
+    def process
+      require 'feed2email/feed'
+
+      begin
+        each do |meta|
+          next unless meta[:enabled]
+
+          feed = Feed.new(meta)
+          processed = feed.process
+          sync_feed_meta(feed.meta, meta, processed)
+        end
+      ensure
+        smtp_connection.finalize
+      end
+
+      sync
+    end
+
+    def sync
+      if dirty?
+        open(path, 'w') {|f| f.write(to_yaml) } > 0
+      end
+    end
+
+    def to_s
+      return 'Empty feed list' if empty?
+
+      justify = size.to_s.size
+      disabled = Thor::Shell::Color.new.set_color('DISABLED', :red)
+
+      each_with_index.map do |feed, i|
+        '%{index}: %{disabled}%{uri}' % {
+          index:    i.to_s.rjust(justify),
+          disabled: feed[:enabled] ? '' : "#{disabled} ",
+          uri:      feed[:uri]
+        }
+      end.join("\n")
+    end
+
+    def toggle(index)
+      if data[index]
+        mark_dirty
+        data[index][:enabled] = !data[index][:enabled]
+        true
+      end
+    end
+
+    private
+
+    def data
+      return @data if @data
+
+      if File.exist?(path)
+        @data = YAML.load(read_file)
+      else
+        @data = []
+      end
+    end
+
+    def dirty?; @dirty end
+
+    def find_feed_by_uri(uri)
+      data.index {|feed| feed[:uri] == uri }
+    end
+
+    def mark_dirty
+      @dirty = true
+    end
+
+    def path; @path end
+
+    def read_file
+      File.read(path)
+    end
+
+    def smtp_connection
+      Feed2Email.smtp_connection # delegate
+    end
+
+    def sync_feed_meta(src, dest, processed)
+      if processed
+        if src[:last_modified]
+          mark_dirty
+          dest[:last_modified] = src[:last_modified]
+        end
+
+        if src[:etag]
+          mark_dirty
+          dest[:etag] = src[:etag]
+        end
+      end
+
+      # Check for permanent redirection and persist
+      if dest[:uri] != src[:uri]
+        mark_dirty
+        dest[:uri] = src[:uri]
+      end
+    end
+
+    def to_yaml
+      data.to_yaml # delegate
+    end
+  end
+end

data/lib/feed2email/lazy_smtp_connection.rb

@@ -1,10 +1,9 @@
 require 'net/smtp'
+require 'feed2email/configurable'
 
 module Feed2Email
   class LazySMTPConnection
-    def config
-      Feed2Email.config # delegate
-    end
+    include Configurable
 
     def connect
       smtp.start('localhost', config['smtp_user'], config['smtp_pass'],
@@ -19,11 +18,13 @@ module Feed2Email
       smtp.finish if connected?
     end
 
-    def send_message(*args)
+    def sendmail(*args, &block)
       connect unless connected?
-      smtp.send_message(*args)
+      smtp.sendmail(*args, &block) # delegate
     end
 
+    private
+
     def smtp
       return @smtp if @smtp
       @smtp = Net::SMTP.new(config['smtp_host'], config['smtp_port'])

data/lib/feed2email/loggable.rb

@@ -0,0 +1,7 @@
+module Feed2Email
+  module Loggable
+    def logger
+      Feed2Email.logger # delegate
+    end
+  end
+end

data/lib/feed2email/mail.rb

@@ -1,19 +1,18 @@
 require 'mail'
+require 'feed2email/configurable'
 require 'feed2email/version'
 
 module Feed2Email
   class Mail
+    include Configurable
+
     def initialize(entry, feed_title)
       @entry = entry
       @feed_title = feed_title
     end
 
     def send
-      if smtp_configured?
-        send_with_smtp
-      else
-        send_with_sendmail
-      end
+      build_mail.deliver!
     end
 
     private
@@ -43,31 +42,37 @@ module Feed2Email
       body_html.to_markdown
     end
 
-    def config
-      Feed2Email.config # delegate
-    end
-
-    def entry; @entry end
-
-    def feed_title; @feed_title end
-
-    def mail
+    def build_mail
       ::Mail.new.tap do |m|
         m.from      = %{"#{feed_title}" <#{config['sender']}>}
         m.to        = config['recipient']
         m.subject   = entry.title.strip_html
-        m.html_part = mail_part('text/html', body_html)
-        m.text_part = mail_part('text/plain', body_text)
-      end.to_s
+        m.html_part = build_mail_part('text/html', body_html)
+        m.text_part = build_mail_part('text/plain', body_text)
+
+        m.delivery_method(*delivery_method_params)
+      end
     end
 
-    def mail_part(content_type, body)
+    def build_mail_part(content_type, body)
       part = ::Mail::Part.new
       part.content_type = "#{content_type}; charset=UTF-8"
       part.body = body
       part
     end
 
+    def delivery_method_params
+      if config.smtp_configured?
+        [:smtp_connection, connection: Feed2Email.smtp_connection]
+      else
+        [:sendmail, location: config['sendmail_path']]
+      end
+    end
+
+    def entry; @entry end
+
+    def feed_title; @feed_title end
+
     def published
       return nil unless entry.author || entry.published
       text = 'Published'
@@ -75,26 +80,5 @@ module Feed2Email
       text << " at #{entry.published}" if entry.published
       text
     end
-
-    def send_with_sendmail
-      open("|#{config['sendmail_path']} #{config['recipient']}", 'w') do |f|
-        f.write(mail)
-      end
-    end
-
-    def send_with_smtp
-      smtp_connection.send_message(mail, config['sender'], config['recipient'])
-    end
-
-    def smtp_configured?
-      config['smtp_host'] &&
-        config['smtp_port'] &&
-        config['smtp_user'] &&
-        config['smtp_pass']
-    end
-
-    def smtp_connection
-      Feed2Email.smtp_connection
-    end
   end
 end

data/lib/feed2email/redirection_checker.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+require 'uri'
+
+module Feed2Email
+  class RedirectionChecker
+    def initialize(uri)
+      @uri = uri
+      check
+    end
+
+    def location; @location end
+
+    def permanently_redirected?
+      redirected? && code == 301
+    end
+
+    private
+
+    def check
+      parsed_uri   = URI.parse(uri)
+      http         = Net::HTTP.new(parsed_uri.host, parsed_uri.port)
+      http.use_ssl = (parsed_uri.scheme == 'https')
+      response     = http.head(parsed_uri.request_uri)
+      @code        = response.code.to_i
+      @location    = response['location']
+    end
+
+    def code; @code end
+
+    def redirected?
+      [301, 302].include?(code) &&
+        location != uri && # prevent redirection to the same location
+        location =~ %r{\Ahttps?://} # sanitize location
+    end
+
+    def uri; @uri end
+  end
+end

data/lib/feed2email/version.rb

@@ -1,3 +1,3 @@
 module Feed2Email
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aggelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +167,8 @@ dependencies:
 description: 
 email: me@agorf.gr
 executables:
+- f2e
+- feed2email-migrate-feedlist
 - feed2email-migrate-history
 - feed2email
 extensions: []
@@ -147,21 +177,25 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- TODO.md
+- bin/f2e
 - bin/feed2email
+- bin/feed2email-migrate-feedlist
 - bin/feed2email-migrate-history
 - lib/feed2email.rb
+- lib/feed2email/cli.rb
 - lib/feed2email/config.rb
+- lib/feed2email/configurable.rb
 - lib/feed2email/core_ext.rb
 - lib/feed2email/entry.rb
 - lib/feed2email/feed.rb
-- lib/feed2email/feed_data_file.rb
+- lib/feed2email/feed_autodiscoverer.rb
 - lib/feed2email/feed_history.rb
-- lib/feed2email/feed_meta.rb
-- lib/feed2email/feeds.rb
+- lib/feed2email/feed_list.rb
 - lib/feed2email/lazy_smtp_connection.rb
+- lib/feed2email/loggable.rb
 - lib/feed2email/logger.rb
 - lib/feed2email/mail.rb
+- lib/feed2email/redirection_checker.rb
 - lib/feed2email/version.rb
 homepage: https://github.com/agorf/feed2email
 licenses:
@@ -169,18 +203,30 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  WARNING! feed2email now maintains a separate history file per feed!
+  Important changes since version 0.6.0:
+
+  * Each feed has its own history file. Please run the provided migration script
+    to migrate your history before using feed2email: feed2email-migrate-history
+    If you don't, feed2email will think it is run for the first time and will
+    treat all entries as old (thus no email will be sent and you may miss some
+    entries).
+
+  * `sender` is a required config option. Please update your config file
+    (~/.feed2email/config.yml) to set it to an email address to send email from.
+
+  Important changes since version 0.8.0:
+
+  * Feed metadata is stored in the feed list (~/.feed2email/feeds.yml). Please run
+    the provided migration script before using feed2email:
+    `feed2email-migrate-feedlist`
 
-  Please run the provided migration script `feed2email-migrate-history` before
-  using feed2email. This will split an existing single history file to many small
-  ones, one for each feed.
+    It is safe to remove any feed meta files: rm ~/.feed2email/meta-*.yml
 
-  If history is not migrated, feed2email will think it is run for the first time
-  and will treat all entries as old (thus no email will be sent and you may miss
-  some entries).
+  * A command-line interface is available. Running feed2email without any options
+    will display some help text. To run it so that it processes your feed list,
+    issue: `feed2email process`
 
-  WARNING! "sender" is now a required config option. Please update your config
-  file by setting it to an email address to send email from.
+    Don't forget to update any cron jobs too!
 
 rdoc_options: []
 require_paths: