feed2email 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf67c31096e64a3b8e790b968fbd7fecd5384c78
+  data.tar.gz: 0a7567b5e3b8aa17aa9977d9a5485fa5d6fec138
+SHA512:
+  metadata.gz: e187b0d14d5687d410b9860b6ab5cbeed2fe5d38764d95da23f460a198f607547cc8b35e5faae8b65a74c2d0add7259ab37cfec13607ff9c3de0643d0264eda6
+  data.tar.gz: 4d735364a8a9f84d6a66de1c3a7f622056517ec72dd04f648c2a9fad9966ea188f44dea1c5222f9b1c3ff7f64ae64f81f66970e5b4733272ec8b5e0c10f65907

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.3.0
+
+* Add logging
+* Do not sync fetch time if there was an error
+* Extract email address from entry author
+* Prepend feed URI to path entry permalinks
+
 ### 0.2.3
 
 * Isolate feed processing failures

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    feed2email (0.2.3)
+    feed2email (0.3.0)
       feedzirra
       mail
 
@@ -10,7 +10,7 @@ GEM
   specs:
     activesupport (3.1.12)
       multi_json (~> 1.0)
-    builder (3.2.2)
+    builder (3.2.0)
     curb (0.7.18)
     feedzirra (0.1.3)
       activesupport (~> 3.1.1)
@@ -22,25 +22,24 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.8)
       sax-machine (~> 0.1.0)
-    i18n (0.6.5)
-    json (1.8.0)
+    i18n (0.6.4)
+    json (1.7.7)
     loofah (1.2.1)
       nokogiri (>= 1.4.4)
-    mail (2.5.4)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.24)
-    mini_portile (0.5.1)
-    multi_json (1.7.9)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    nokogiri (1.5.9)
     polyglot (0.3.3)
-    rake (10.1.0)
+    rake (10.0.4)
     rdoc (3.12.2)
       json (~> 1.4)
     sax-machine (0.1.0)
       nokogiri (> 0.0.0)
-    treetop (1.4.15)
+    treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
 

data/README.md

@@ -42,7 +42,9 @@ pair is separated with a colon: `foo: bar`
 
 * `recipient` (required) is the email address to send email to
 * `send_delay` (optional) is the number of seconds to wait between each email to
-   avoid SMTP server throttling errors (default is `10`; use `0` to turn off)
+  avoid SMTP server throttling errors (default is `10`; use `0` to disable)
+* `log_path` (optional) is the _absolute_ path to the log file (default is
+  `true` which logs to standard output; use `false` to disable)
 
 ### SMTP
 
@@ -74,9 +76,19 @@ interface setup and working in your system. I suggest [msmtp][] or [Postfix][].
 ## Use
 
 Create `~/.feed2email/feeds.yml` and add the address of each feed you want to
-subscribe to, prefixed with a dash and a space.
+subscribe to, prefixed with a dash and a space:
 
-Then run it:
+~~~ yaml
+- https://github.com/agorf/feed2email/commits.atom
+~~~
+
+To disable a feed temporarily, comment it:
+
+~~~ yaml
+#- https://github.com/agorf/feed2email/commits.atom
+~~~
+
+You are now ready to run the program:
 
 ~~~ sh
 $ feed2email

data/lib/feed2email.rb

@@ -1,11 +1,14 @@
 require 'cgi'
 require 'feedzirra'
 require 'fileutils'
+require 'logger'
 require 'mail'
 require 'net/smtp'
+require 'singleton'
 require 'yaml'
 
 require 'feed2email/config'
+require 'feed2email/logger'
 require 'feed2email/version'
 require 'feed2email/core_ext'
 require 'feed2email/mail'

data/lib/feed2email/entry.rb

@@ -20,7 +20,14 @@ module Feed2Email
     end
 
     def process
-      to_mail.send if to_be_sent?
+      log :debug, "Processing entry #{uri} ..."
+
+      if send?
+        log :debug, 'Sending email...'
+        to_mail.send
+      else
+        log :debug, 'Entry should not be sent; skipping...'
+      end
     end
 
     def title
@@ -28,19 +35,46 @@ module Feed2Email
     end
 
     def uri
-      @data.url
+      @uri ||= begin
+        if @data.url[0] == '/'
+          @feed.uri.chomp('/') + @data.url
+        else
+          @data.url
+        end
+      end
     end
 
     private
 
+    def log(*args)
+      Feed2Email::Logger.instance.log(*args)
+    end
+
     def published_at
       @data.published
     end
 
-    def to_be_sent?
-      published_at &&
-        published_at.past? && # respect entry future pubDate
-        published_at > @feed.fetch_time
+    def send?
+      if published_at
+        log :debug, 'Entry has publication timestamp'
+
+        if published_at.past? # respect entries published in the future
+          log :debug, 'Entry published in the past'
+
+          if published_at > @feed.fetch_time
+            log :debug, 'Entry not seen before'
+            return true
+          else
+            log :debug, 'Entry seen before'
+          end
+        else
+          log :warn, "Entry #{uri} published in the future"
+        end
+      else
+        log :warn, "Entry #{uri} does not have publication timestamp"
+      end
+
+      false
     end
 
     def to_mail

data/lib/feed2email/feed.rb

@@ -3,6 +3,14 @@ module Feed2Email
     FEEDS_FILE = File.join(CONFIG_DIR, 'feeds.yml')
     STATE_FILE = File.join(CONFIG_DIR, 'state.yml')
 
+    def self.log(*args)
+      Feed2Email::Logger.instance.log(*args)
+    end
+
+    def self.pluralize(n, singular, plural)
+      "#{n} #{n == 1 ? singular : plural}"
+    end
+
     def self.process(uri)
       Feed.new(uri).process
     end
@@ -10,6 +18,7 @@ module Feed2Email
     def self.process_all
       Feed2Email::Config.instance.read!
 
+      log :debug, 'Loading feed subscriptions...'
       feed_uris = YAML.load(open(FEEDS_FILE)) rescue nil
 
       if !feed_uris.is_a? Array
@@ -17,19 +26,19 @@ module Feed2Email
         exit 4
       end
 
+      log :info, "Subscribed to #{pluralize(feed_uris.size, 'feed', 'feeds')}"
+
+      log :debug, 'Loading fetch times...'
       @@fetch_times = YAML.load(open(STATE_FILE)) rescue {}
 
-      feed_uris.each do |uri|
-        begin
-          Feed.process(uri)
-        rescue
-          # TODO log failure
-        end
-      end
+      feed_uris.each {|uri| Feed.process(uri) }
 
+      log :debug, 'Writing fetch times...'
       open(STATE_FILE, 'w') {|f| f.write(@@fetch_times.to_yaml) }
     end
 
+    attr_reader :uri
+
     def initialize(uri)
       @uri = uri
     end
@@ -38,9 +47,41 @@ module Feed2Email
       @@fetch_times[@uri]
     end
 
+    def pluralize(*args)
+      Feed2Email::Feed.pluralize(*args) # delegate
+    end
+
     def process
-      process_entries if seen_before? && fetched? && have_entries?
-      sync_fetch_time if !seen_before? || fetched?
+      log :info, "Processing feed #{@uri} ..."
+
+      if seen_before?
+        log :debug, 'Feed seen before'
+
+        if fetched?
+          log :debug, 'Feed is fetched'
+
+          if have_entries?
+            log :info, "Processing #{pluralize(entries.size, 'entry', 'entries')}..."
+
+            begin
+              process_entries
+            rescue => e
+              log :error, "#{e.class}: #{e.message.strip}"
+            end
+          else
+            log :warn, 'Feed does not have entries'
+          end
+        else
+          log :error, 'Feed could not be fetched'
+        end
+      else
+        log :info, 'Feed not seen before; skipping...'
+      end
+
+      if e.nil? && (!seen_before? || fetched?)
+        log :debug, 'Syncing fetch time...'
+        sync_fetch_time
+      end
     end
 
     def title
@@ -51,6 +92,7 @@ module Feed2Email
 
     def data
       if @data.nil?
+        log :debug, 'Fetching and parsing feed...'
         @data = Feedzirra::Feed.fetch_and_parse(@uri,
           :user_agent => "feed2email/#{VERSION}",
           :compress   => true
@@ -73,6 +115,10 @@ module Feed2Email
       entries.any?
     end
 
+    def log(*args)
+      Feed2Email::Feed.log(*args) # delegate
+    end
+
     def process_entries
       entries.each do |entry_data|
         Entry.process(entry_data, self)

data/lib/feed2email/logger.rb

@@ -0,0 +1,37 @@
+module Feed2Email
+  class Logger
+    include Singleton
+
+    def log(severity, message)
+      logger.add(::Logger.const_get(severity.upcase), message) if log?
+    end
+
+    private
+
+    def config
+      Feed2Email::Config.instance.config
+    end
+
+    def log?
+      log_path != false
+    end
+
+    def log_path
+      config['log_path']
+    end
+
+    def log_to
+      if log_path.nil? || log_path == true
+        STDOUT
+      else
+        log_path
+      end
+    end
+
+    def logger
+      @logger ||= ::Logger.new(log_to)
+      @logger.level = ::Logger::INFO
+      @logger
+    end
+  end
+end

data/lib/feed2email/mail.rb

@@ -50,7 +50,7 @@ module Feed2Email
 
     def from_address
       if @entry.author && @entry.author['@']
-        @entry.author
+        @entry.author[/\S+@\S+/]
       elsif send_with_smtp?
         '%{user}@%{host}' % {
           :user => config['smtp_user'],

data/lib/feed2email/version.rb

@@ -1,3 +1,3 @@
 module Feed2Email
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,48 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: feed2email
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Aggelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedzirra
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
 - !ruby/object:Gem::Dependency
   name: mail
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
 description: RSS/Atom feed updates in your email
 email:
 - agorf@agorf.gr
@@ -60,42 +55,35 @@ files:
 - Rakefile
 - bin/feed2email
 - feed2email.gemspec
-- feeds.yml.sample
 - lib/feed2email.rb
 - lib/feed2email/config.rb
 - lib/feed2email/core_ext.rb
 - lib/feed2email/entry.rb
 - lib/feed2email/feed.rb
+- lib/feed2email/logger.rb
 - lib/feed2email/mail.rb
 - lib/feed2email/version.rb
 homepage: http://github.com/agorf/feed2email
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4353394670092365916
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4353394670092365916
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RSS/Atom feed updates in your email
 test_files: []

data/feeds.yml.sample

@@ -1,3 +0,0 @@
----
-- http://feeds.feedburner.com/agorf
-- http://api.twitter.com/1/statuses/user_timeline.rss?screen_name=agorf