feed2email 0.8.0 → 0.9.0

data/lib/feed2email/cli.rb

@@ -1,126 +1,155 @@
 require 'thor'
-require 'feed2email'
-require 'feed2email/feed_autodiscoverer'
-require 'feed2email/redirection_checker'
 
 module Feed2Email
   class Cli < Thor
-    desc 'add URL', 'subscribe to feed at URL'
+    desc 'add URL', 'Subscribe to feed at URL'
     def add(uri)
-      uri = handle_permanent_redirection(uri)
-      uri = perform_feed_autodiscovery(uri)
+      require 'feed2email/feed'
+      require 'feed2email/feed_autodiscoverer'
 
-      begin
-        feed_list << uri
-      rescue FeedList::DuplicateFeedError => e
-        abort e.message
+      uri = autodiscover_feeds(uri)
+
+      if feed = Feed[uri: uri]
+        abort "Feed already exists: #{feed}"
       end
 
-      if feed_list.sync
-        puts "Added feed #{uri} at index #{feed_list.size - 1}"
+      feed = Feed.new(uri: uri)
+
+      if feed.save(raise_on_failure: false)
+        puts "Added feed: #{feed}"
       else
         abort 'Failed to add feed'
       end
     end
 
-    desc 'fetch FEED', 'clear fetch cache for feed at index FEED'
-    def fetch(index)
-      index = check_feed_index(index, in: (0...feed_list.size))
-      feed_list.clear_fetch_cache(index)
+    desc 'backend', 'Open an SQLite console to the database'
+    def backend
+      require 'feed2email/database'
+      exec('sqlite3', Feed2Email.database_path)
+    end
 
-      if feed_list.sync
-        puts "Cleared fetch cache for feed at index #{index}"
+    desc 'config', 'Open configuration file with $EDITOR'
+    def config
+      if ENV['EDITOR']
+        require 'feed2email'
+        exec(ENV['EDITOR'], Feed2Email.config_path)
       else
-        abort "Failed to clear fetch cache for feed at index #{index}"
+        abort 'EDITOR not set'
       end
     end
 
-    desc 'history FEED', 'edit history file of feed at index FEED with $EDITOR'
-    def history(index)
-      abort '$EDITOR not set' unless ENV['EDITOR']
+    desc 'export PATH', 'Export feed subscriptions as OPML to PATH'
+    def export(path)
+      require 'feed2email/feed'
 
-      index = check_feed_index(index, in: (0...feed_list.size))
-      require 'feed2email/feed_history'
-      history_path = FeedHistory.new(feed_list[index][:uri]).path
-      exec(ENV['EDITOR'], history_path)
-    end
+      if Feed.empty?
+        abort 'No feeds to export'
+      end
 
-    desc 'remove FEED', 'unsubscribe from feed at index FEED'
-    def remove(index)
-      index = check_feed_index(index, in: (0...feed_list.size))
-      deleted = feed_list.delete_at(index)
+      unless File.exist?(path)
+        require 'feed2email/opml_exporter'
 
-      if deleted && feed_list.sync
-        puts "Removed feed at index #{index}"
+        puts 'This may take a bit. Please wait...'
 
-        if feed_list.size != index # feed was not the last
-          puts 'Warning: Feed list indices have changed!'
+        if n = OPMLExporter.export(path)
+          puts "Exported #{'feed subscription'.pluralize(n)} to #{path}"
+        else
+          abort 'Failed to export feed subscriptions'
         end
       else
-        abort "Failed to remove feed at index #{index}"
+        abort 'File already exists'
       end
     end
 
-    desc 'toggle FEED', 'enable/disable feed at index FEED'
-    def toggle(index)
-      index   = check_feed_index(index, in: (0...feed_list.size))
-      toggled = feed_list.toggle(index)
-      enabled = feed_list[index][:enabled]
+    desc 'import PATH', 'Import feed subscriptions as OPML from PATH'
+    def import(path)
+      if File.exist?(path)
+        require 'feed2email/opml_importer'
 
-      if toggled && feed_list.sync
-        puts "#{enabled ? 'En' : 'Dis'}abled feed at index #{index}"
+        puts 'Importing...'
+
+        if n = OPMLImporter.import(path)
+          if n > 0
+            puts "Imported #{'feed subscription'.pluralize(n)} from #{path}"
+          end
+        else
+          abort 'Failed to import feed subscriptions'
+        end
       else
-        abort "Failed to #{enabled ? 'en' : 'dis'}able feed at index #{index}"
+        abort 'File does not exist'
       end
     end
 
-    desc 'list', 'list feed subscriptions'
+    desc 'list', 'List feed subscriptions'
     def list
-      puts feed_list
+      require 'feed2email/feed'
+
+      if Feed.any?
+        puts Feed.by_smallest_id.to_a
+      else
+        puts 'No feeds'
+      end
     end
 
-    desc 'process', 'process feed subscriptions'
+    desc 'process', 'Process feed subscriptions'
     def process
-      feed_list.process
+      require 'feed2email/feed'
+      Feed.enabled.by_smallest_id.each(&:process)
     end
 
-    desc 'version', 'show feed2email version'
-    def version
-      require 'feed2email/version'
-      puts "feed2email #{Feed2Email::VERSION}"
-    end
+    desc 'remove ID', 'Unsubscribe from feed with id ID'
+    def remove(id)
+      require 'feed2email/feed'
 
-    no_commands do
-      def check_feed_index(index, options = {})
-        if index.to_i.to_s != index ||
-            (options[:in] && !options[:in].include?(index.to_i))
-          puts if index.nil? # Ctrl-D
-          abort 'Invalid index'
-        end
+      feed = Feed[id]
 
-        index.to_i
+      if feed && feed.delete
+        puts "Removed feed: #{feed}"
+      else
+        abort "Failed to remove feed. Is #{id} a valid id?"
       end
+    end
+
+    desc 'toggle ID', 'Enable/disable feed with id ID'
+    def toggle(id)
+      require 'feed2email/feed'
+
+      feed = Feed[id]
 
-      def feed_list
-        Feed2Email.feed_list # delegate
+      if feed && feed.toggle
+        puts "Toggled feed: #{feed}"
+      else
+        abort "Failed to toggle feed. Is #{id} a valid id?"
       end
+    end
 
-      def handle_permanent_redirection(uri)
-        checker = RedirectionChecker.new(uri)
+    desc 'uncache ID', 'Clear fetch cache for feed with id ID'
+    def uncache(id)
+      require 'feed2email/feed'
 
-        if checker.permanently_redirected?
-          puts "Got permanently redirected to #{checker.location}"
-          checker.location
-        else
-          uri
-        end
+      feed = Feed[id]
+
+      if feed && feed.uncache
+        puts "Uncached feed: #{feed}"
+      else
+        abort "Failed to uncache feed. Is #{id} a valid id?"
       end
+    end
 
-      def perform_feed_autodiscovery(uri)
+    desc 'version', 'Show feed2email version'
+    def version
+      require 'feed2email/version'
+      puts "feed2email #{Feed2Email::VERSION}"
+    end
+
+    no_commands do
+      def autodiscover_feeds(uri)
         discoverer = FeedAutodiscoverer.new(uri)
 
+        # Exclude already subscribed feeds from results
+        subscribed_feed_uris = Feed.select_map(:uri)
         discovered_feeds = discoverer.feeds.reject {|feed|
-          feed_list.include?(feed[:uri])
+          subscribed_feed_uris.include?(feed[:uri])
         }
 
         if discovered_feeds.empty?
@@ -150,8 +179,16 @@ module Feed2Email
           exit
         end
 
-        index = check_feed_index(response, in: (0...discovered_feeds.size))
-        discovered_feeds[index][:uri]
+        unless response.numeric? &&
+            (0...discovered_feeds.size).include?(response.to_i)
+          abort 'Invalid index'
+        end
+
+        feed = discovered_feeds[response.to_i]
+
+        abort 'Invalid index' unless feed && feed[:uri]
+
+        feed[:uri]
       end
     end
   end

data/lib/feed2email/config.rb

@@ -1,52 +1,62 @@
+require 'forwardable'
 require 'yaml'
 
 module Feed2Email
   class Config
-    class MissingConfigError < StandardError; end
-    class InvalidConfigPermissionsError < StandardError; end
-    class InvalidConfigSyntaxError < StandardError; end
-    class InvalidConfigDataTypeError < StandardError; end
-    class MissingConfigOptionError < StandardError; end
+    class ConfigError < StandardError; end
+    class MissingConfigError < ConfigError; end
+    class InvalidConfigPermissionsError < ConfigError; end
+    class InvalidConfigSyntaxError < ConfigError; end
+    class InvalidConfigDataTypeError < ConfigError; end
+    class MissingConfigOptionError < ConfigError; end
+    class InvalidConfigOptionError < ConfigError; end
 
-    def initialize(path)
-      @path = File.expand_path(path)
-      check
-    end
+    SEND_METHODS = %w{file sendmail smtp}
 
-    def [](option)
-      config[option] # delegate
-    end
+    extend Forwardable
+
+    delegate [:[], :keys, :slice] => :config
 
-    def smtp_configured?
-      config['smtp_host'] && config['smtp_port'] && config['smtp_user'] &&
-        config['smtp_pass']
+    def initialize(path)
+      @path = path
     end
 
     private
 
-    def path
-      @path
+    def check_data_type
+      if !data.is_a?(Hash)
+        raise InvalidConfigDataTypeError,
+          "Invalid data type (not a Hash) for config file #{path}"
+      end
     end
 
-    def data
-      @data
+    def check_existence
+      if !File.exist?(path)
+        raise MissingConfigError, "Missing config file #{path}"
+      end
     end
 
-    def check
+    def check_file
       check_existence
       check_permissions
       check_syntax
       check_data_type
-      check_recipient_existence
-      check_sender_existence
     end
 
-    def check_existence
-      if !File.exist?(path)
-        raise MissingConfigError, "Missing config file #{path}"
+    def check_option(option)
+      if config[option].nil?
+        raise MissingConfigOptionError,
+          "Option #{option} missing from config file #{path}"
       end
     end
 
+    def check_options
+      check_recipient
+      check_sender
+      check_send_method
+      check_smtp_options if config['send_method'] == 'smtp'
+    end
+
     def check_permissions
       if '%o' % (File.stat(path).mode & 0777) != '600'
         raise InvalidConfigPermissionsError,
@@ -54,40 +64,53 @@ module Feed2Email
       end
     end
 
-    def check_syntax
-      begin
-        load_yaml
-      rescue Psych::SyntaxError
-        raise InvalidConfigSyntaxError,
-          "Invalid YAML syntax for config file #{path}"
-      end
+    def check_recipient
+      check_option('recipient')
     end
 
-    def check_data_type
-      if !data.is_a?(Hash)
-        raise InvalidConfigDataTypeError,
-          "Invalid data type (not a Hash) for config file #{path}"
+    def check_send_method
+      unless SEND_METHODS.include?(config['send_method'])
+        raise InvalidConfigOptionError,
+          "Option send_method not one of: #{SEND_METHODS.join(' ')}"
       end
     end
 
-    def check_recipient_existence
-      check_option_existence('recipient')
+    def check_sender
+      check_option('sender')
     end
 
-    def check_sender_existence
-      check_option_existence('sender')
+    def check_smtp_options
+      check_option('smtp_host')
+      check_option('smtp_port')
+      check_option('smtp_user')
+      check_option('smtp_pass')
     end
 
-    def load_yaml
-      @data = YAML.load(read_file)
+    def check_syntax
+      begin
+        data
+      rescue Psych::SyntaxError
+        raise InvalidConfigSyntaxError,
+          "Invalid YAML syntax for config file #{path}"
+      end
     end
 
-    def read_file
-      File.read(path)
+    def config
+      return @config if @config
+
+      begin
+        check_file
+        @config = defaults.merge(data)
+        check_options
+      rescue ConfigError => e
+        abort e.message
+      end
+
+      @config
     end
 
-    def config
-      @config ||= defaults.merge(data)
+    def data
+      @data ||= YAML.load(File.read(path))
     end
 
     def defaults
@@ -96,19 +119,16 @@ module Feed2Email
         'log_path'       => true,
         'log_shift_age'  => 0,
         'log_shift_size' => 1, # megabyte
+        'mail_path'      => File.join(ENV['HOME'], 'Mail'),
         'max_entries'    => 20,
         'send_delay'     => 10,
+        'send_method'    => 'file',
         'sendmail_path'  => '/usr/sbin/sendmail',
         'smtp_auth'      => 'login',
         'smtp_starttls'  => true,
       }
     end
 
-    def check_option_existence(option)
-      if data[option].nil?
-        raise MissingConfigOptionError,
-          "Option #{option} missing from config file #{path}"
-      end
-    end
+    def path; @path end
   end
 end

data/lib/feed2email/core_ext.rb

@@ -2,6 +2,12 @@ require 'cgi'
 require 'reverse_markdown'
 require 'sanitize'
 
+class Hash
+  def slice(*keys)
+    Hash[values_at(*keys).each_with_index.map {|v, i| [keys[i], v] }]
+  end
+end
+
 class Numeric
   def megabytes
     self * 1024 * 2014
@@ -13,6 +19,10 @@ class String
     CGI.escapeHTML(self)
   end
 
+  def numeric?
+    to_i.to_s == self
+  end
+
   def pluralize(count, plural = self + 's')
     "#{count} #{count == 1 ? self : plural}"
   end