feed2email 0.8.0 → 0.9.0

data/lib/feed2email/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Aggelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.18.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -168,8 +196,7 @@ description:
 email: me@agorf.gr
 executables:
 - f2e
-- feed2email-migrate-feedlist
-- feed2email-migrate-history
+- feed2email-migrate
 - feed2email
 extensions: []
 extra_rdoc_files: []
@@ -179,23 +206,28 @@ files:
 - README.md
 - bin/f2e
 - bin/feed2email
-- bin/feed2email-migrate-feedlist
-- bin/feed2email-migrate-history
+- bin/feed2email-migrate
 - lib/feed2email.rb
 - lib/feed2email/cli.rb
 - lib/feed2email/config.rb
 - lib/feed2email/configurable.rb
 - lib/feed2email/core_ext.rb
+- lib/feed2email/database.rb
 - lib/feed2email/entry.rb
 - lib/feed2email/feed.rb
 - lib/feed2email/feed_autodiscoverer.rb
-- lib/feed2email/feed_history.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/migrate/convert_feeds_migration.rb
+- lib/feed2email/migrate/feeds_import_migration.rb
+- lib/feed2email/migrate/history_import_migration.rb
+- lib/feed2email/migrate/migration.rb
+- lib/feed2email/migrate/split_history_migration.rb
+- lib/feed2email/open-uri.rb
+- lib/feed2email/opml_exporter.rb
+- lib/feed2email/opml_importer.rb
 - lib/feed2email/redirection_checker.rb
+- lib/feed2email/smtp_connection.rb
 - lib/feed2email/version.rb
 homepage: https://github.com/agorf/feed2email
 licenses:
@@ -203,31 +235,24 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  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.
+  * Since version 0.9.0, the default send method is `file` which writes emails to
+    a file under `~/Mail/`. To change it, edit your config file (`feed2email
+    config`) and set `send_method` to `sendmail` or `smtp`.
 
-  Important changes since version 0.8.0:
+  * Since version 0.9.0, SQLite (instead of YAML) is used to store the feed list
+    and the entry history. Please issue `feed2email-migrate` to migrate your data
+    before running feed2email.
 
-  * Feed metadata is stored in the feed list (~/.feed2email/feeds.yml). Please run
-    the provided migration script before using feed2email:
-    `feed2email-migrate-feedlist`
-
-    It is safe to remove any feed meta files: rm ~/.feed2email/meta-*.yml
-
-  * 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`
+  * Since version 0.8.0, a command-line interface is available. Running feed2email
+    without any arguments will display some help text. To have feed2email process
+    your feed list, issue `feed2email process`
 
     Don't forget to update any cron jobs too!
 
+  * Since version 0.6.0, `sender` is a required config option. Please update your
+    config file (`feed2email config`) to set it to an email address to send email
+    from.
+
 rdoc_options: []
 require_paths:
 - lib

data/bin/feed2email-migrate-feedlist

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'yaml'
-
-CONFIG_DIR = File.expand_path('~/.feed2email')
-FEEDS_FILE = File.join(CONFIG_DIR, 'feeds.yml')
-
-if !File.exist?(FEEDS_FILE)
-  $stderr.puts "Missing feed list file #{FEEDS_FILE}"
-  exit 1
-end
-
-feeds_data = YAML.load(open(FEEDS_FILE))
-
-unless feeds_data.is_a?(Array) && feeds_data.all? {|data| data.is_a?(String) }
-  $stderr.puts "Invalid data type for feed list file #{FEEDS_FILE}"
-  exit 2
-end
-
-File.rename(FEEDS_FILE, "#{FEEDS_FILE}.bak")
-
-begin
-  open(FEEDS_FILE, 'w') do |f|
-    f.write(
-      feeds_data.map {|uri|
-        { uri: uri, enabled: true }
-      }.to_yaml
-    )
-  end
-
-  puts "Migrated feed list file #{FEEDS_FILE}"
-  puts "Renamed #{FEEDS_FILE} to #{FEEDS_FILE}.bak"
-rescue
-  File.rename("#{FEEDS_FILE}.bak", FEEDS_FILE)
-  raise
-end

data/bin/feed2email-migrate-history

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'digest/md5'
-require 'yaml'
-
-CONFIG_DIR = File.expand_path('~/.feed2email')
-HISTORY_FILE = File.join(CONFIG_DIR, 'history.yml')
-
-if !File.exist?(HISTORY_FILE)
-  $stderr.puts "Missing history file #{HISTORY_FILE}"
-  exit 1
-end
-
-history_data = YAML.load(open(HISTORY_FILE))
-
-if !history_data.is_a?(Hash)
-  $stderr.puts "Invalid data type for history file #{HISTORY_FILE}"
-  exit 2
-end
-
-history_data.each do |feed_uri, entries|
-  hist_filename = "history-#{Digest::MD5.hexdigest(feed_uri)}.yml"
-  hist_path = File.join(CONFIG_DIR, hist_filename)
-  open(hist_path, 'w') {|f| f.write(entries.to_yaml) }
-  puts "Extracted history of #{feed_uri} to #{hist_filename}"
-end
-
-File.rename(HISTORY_FILE, "#{HISTORY_FILE}.bak")
-puts "Renamed #{HISTORY_FILE} to #{HISTORY_FILE}.bak"

data/lib/feed2email/feed_history.rb

@@ -1,82 +0,0 @@
-require 'digest/md5'
-require 'yaml'
-
-module Feed2Email
-  class FeedHistory
-    def initialize(uri)
-      @uri = uri
-      @dirty = false
-    end
-
-    def any?
-      @old_feed ||= File.exist?(path)
-    end
-
-    def path
-      File.join(CONFIG_DIR, filename)
-    end
-
-    def include?(entry_uri)
-      data.include?(entry_uri) # delegate
-    end
-
-    def sync
-      open(path, 'w') {|f| f.write(to_yaml) } if dirty
-    end
-
-    def uri=(new_uri)
-      return if new_uri == uri
-
-      data # load data if not already loaded
-      remove_file
-      mark_dirty
-      @uri = new_uri
-    end
-
-    def <<(entry_uri)
-      mark_dirty
-      data << entry_uri
-    end
-
-    private
-
-    def data
-      @data ||= load_data
-    end
-
-    def dirty; @dirty end
-
-    def filename
-      "history-#{filename_suffix}.yml"
-    end
-
-    def filename_suffix
-      Digest::MD5.hexdigest(uri)
-    end
-
-    def load_data
-      begin
-        @data = YAML.load(open(path))
-      rescue Errno::ENOENT
-        @data = []
-      end
-    end
-
-    def mark_dirty
-      @dirty = true
-    end
-
-    def remove_file
-      begin
-        File.unlink(path)
-      rescue Errno::ENOENT
-      end
-    end
-
-    def to_yaml
-      data.to_yaml # delegate
-    end
-
-    def uri; @uri end
-  end
-end

data/lib/feed2email/feed_list.rb

@@ -1,147 +0,0 @@
-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,35 +0,0 @@
-require 'net/smtp'
-require 'feed2email/configurable'
-
-module Feed2Email
-  class LazySMTPConnection
-    include Configurable
-
-    def connect
-      smtp.start('localhost', config['smtp_user'], config['smtp_pass'],
-                 config['smtp_auth'].to_sym)
-    end
-
-    def connected?
-      smtp.started?
-    end
-
-    def finalize
-      smtp.finish if connected?
-    end
-
-    def sendmail(*args, &block)
-      connect unless connected?
-      smtp.sendmail(*args, &block) # delegate
-    end
-
-    private
-
-    def smtp
-      return @smtp if @smtp
-      @smtp = Net::SMTP.new(config['smtp_host'], config['smtp_port'])
-      @smtp.enable_starttls if config['smtp_starttls']
-      @smtp
-    end
-  end
-end