feedigest 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab1e04866f9a432849b17e607d1c90366e248a7d42ea3d44aec0e6749dd1405e
-  data.tar.gz: f0948b0ddd6910cee3bd237e0b2a0a74abcf6167af8e7e1f92a2ec3a978867d1
+  metadata.gz: 401be82539f92da17495ec1bbdc38e9308ee2c1d2bf1d991dd2440f8c7ce9dfd
+  data.tar.gz: 9ed6fdf1eb2ddfef7862cf3de2cf0052ed38d02eeb3f7a2e054692163234dc07
 SHA512:
-  metadata.gz: 57b418b0d2d9ddb580b3ec746012ffc2b00fe5125b3c2a7b9553614ff1db5d79a7b4440df4e13849f7913a736135ecc94af3529f402030d379cadaa7f1353d33
-  data.tar.gz: 9ca032d6a782bd4b9a3589a000651df5f660383b79f0f1e51d123150f6f71b9f799e9434a7428d3d70f4cb96a6c0ace5f53843a1ddfc57bea8c28b17a8e5e4e7
+  metadata.gz: 52813c1c6d54b757a5173673d65d436ce5418222314ddac2ddeb7c9b811089e72efbf6a194bf55e0c761cb7ee8d45a7fd86db180c867c8fa98ed160ef3ebc483
+  data.tar.gz: b8bb424b7a4fd0b7fcede8ccea5709b4ec88f666de8faf5fe8e5916123ae82c70e4f66a3c8960a677e06e6662bf8f3521b408fdef41da02762fcfb4c53544815

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][] and this project adheres to
+[Semantic Versioning][].
+
+## [Unreleased][]
+
+## [0.1.0][] - 2018-07-04
+
+### Changed
+
+- Bump version to 0.1.0 to signify 0.0.2 (which should have been 0.1.0) has
+  breaking changes.
+
+## [0.0.3][] - 2018-07-03 [YANKED]
+
+### Changed
+
+- Use subcommands instead of symlinks to feedigest binary.
+- Do not require SMTP options when printing the email.
+
+## [0.0.2][] - 2018-06-29 [YANKED]
+
+### Added
+
+- README file.
+- This CHANGELOG file.
+- Signature in digest email.
+- `bundler-audit` as a development dependency.
+
+### Removed
+
+- `FEEDIGEST_DELIVERY_METHOD` option. Now only SMTP is supported.
+
+### Changed
+
+- Clean up and refactor code.
+- `dotenv` to be a development dependency.
+- `FEEDIGEST_SMTP_HOST` option to `FEEDIGEST_SMTP_ADDRESS`
+- `feedigest-generate` command to `feedigest-print`
+
+## 0.0.1 - 2018-06-12
+
+Initial release.
+
+[Keep a Changelog]: http://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: http://semver.org/spec/v2.0.0.html
+[0.0.2]: https://github.com/agorf/feedigest/compare/0.0.1...0.0.2
+[0.0.3]: https://github.com/agorf/feedigest/compare/0.0.2...0.0.3
+[0.1.0]: https://github.com/agorf/feedigest/compare/0.0.3...0.1.0
+[Unreleased]: https://github.com/agorf/feedigest/compare/0.1.0...HEAD

data/README.md

@@ -0,0 +1,117 @@
+# feedigest [![Gem Version](https://badge.fury.io/rb/feedigest.svg)](http://badge.fury.io/rb/feedigest)
+
+feedigest is a [headless][] [RSS][]/[Atom][] feed aggregator that sends feed
+updates as a single digest email.
+
+It was written as a simpler alternative to [feed2email][].
+
+[headless]: http://en.wikipedia.org/wiki/Headless_software
+[RSS]: http://www.rssboard.org/rss-specification
+[Atom]: https://tools.ietf.org/html/rfc4287
+[feed2email]: https://github.com/agorf/feed2email
+
+## Installation
+
+As a [gem][] from [RubyGems][]:
+
+~~~ sh
+gem install feedigest
+~~~
+
+If the above command fails, make sure the following system packages are
+installed. For Debian/Ubuntu, issue as root:
+
+~~~ sh
+apt-get install build-essential patch ruby-dev zlib1g-dev liblzma-dev
+~~~
+
+[gem]: http://rubygems.org/gems/feedigest
+[RubyGems]: http://rubygems.org/
+
+## Configuration
+
+feedigest is configured through shell environment variables. Instead of passing
+them one by one when you run it, you can store them in a separate file and
+source it to make them available:
+
+~~~ sh
+$ mkdir -p ~/.feedigest
+$ touch ~/.feedigest/env
+$ chmod 600 ~/.feedigest/env
+$ cat > ~/.feedigest/env
+FEEDIGEST_EMAIL_RECIPIENT=me@mydomain.com
+...
+^D
+~~~
+
+**Note:** In the example above, `^D` stands for pressing `Ctrl-D`.
+
+The following environment variables are supported:
+
+* `FEEDIGEST_ENTRY_WINDOW` (default: `86400`) the maximum age, in seconds, of
+  entries to include in the digest
+* `FEEDIGEST_EMAIL_SENDER` (default: `feedigest@hostname`) the "from" address in
+  the email
+* `FEEDIGEST_EMAIL_RECIPIENT` the email address to send the email to
+
+feedigest uses SMTP to send emails. You can get a free plan from [Mailgun][].
+The relevant environment variables are:
+
+[Mailgun]: http://www.mailgun.com/
+
+* `FEEDIGEST_SMTP_ADDRESS`
+* `FEEDIGEST_SMTP_PORT` (default: `587`)
+* `FEEDIGEST_SMTP_USERNAME`
+* `FEEDIGEST_SMTP_PASSWORD`
+* `FEEDIGEST_SMTP_AUTH` (default: `plain`)
+* `FEEDIGEST_SMTP_STARTTLS` (default: `true`)
+
+Finally, you need to provide to the standard input (stdin) of feedigest, a
+line-separated list of feed URLs:
+
+~~~ sh
+$ cat > ~/.feedigest/feeds.txt
+https://github.com/agorf/feed2email/commits.atom
+https://github.com/agorf.atom
+...
+^D
+~~~
+
+## Use
+
+~~~ sh
+export $(cat ~/.feedigest/env | xargs) && feedigest send < ~/.feedigest/feeds.txt
+~~~
+
+You can run this with [cron][] e.g. once per day at 10 am:
+
+[cron]: https://en.wikipedia.org/wiki/Cron
+
+~~~
+0 10 * * * export $(cat ~/.feedigest/env | xargs) && feedigest send < ~/.feedigest/feeds.txt
+~~~
+
+Alternatively, you can have feedigest simply print the generated email so that
+you can send it yourself e.g. by piping it to sendmail. To do that, you simply
+replace `feedigest send` with `feedigest print`:
+
+~~~ sh
+feedigest print < ~/.feedigest/feeds.txt
+~~~
+
+## Contributing
+
+Using feedigest and want to help? Please [let me know][contact] how you use it
+and if you have any ideas on how to improve it.
+
+[contact]: https://agorf.gr/contact/
+
+## License
+
+Licensed under the MIT license (see [LICENSE.txt][license]).
+
+[license]: https://github.com/agorf/feedigest/blob/master/LICENSE.txt
+
+## Author
+
+Angelos Orfanakos, <https://agorf.gr/>

data/bin/feedigest

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+if !%w[send print].include?(ARGV[0])
+  puts "#$0 <send|print>"
+  exit 1
+end
+
+require 'feedigest'
+
+puts 'Please provide a list of feed URLs (one per line) and press Ctrl-D'
+
+feed_urls = $stdin.readlines.map(&:strip)
+feeds = Feedigest::FeedFetcher.new(feed_urls).feeds
+
+exit if feeds.empty?
+
+mail = Feedigest::MailComposer.new(feeds).mail
+mail_sender = Feedigest::MailSender.new(mail)
+
+case ARGV[0]
+when 'send' then mail_sender.deliver
+when 'print' then puts mail_sender
+end

data/lib/feedigest.rb

@@ -1,192 +1,6 @@
-require 'dotenv/load'
-require 'feedjira'
-require 'mail'
-require 'nokogiri'
-require 'reverse_markdown'
+module Feedigest; end
 
-class Feedigest
-  ENTRY_WINDOW = ENV.fetch('FEEDIGEST_ENTRY_WINDOW', 60 * 60 * 24) # Seconds
-  EMAIL_SENDER = ENV.fetch(
-    'FEEDIGEST_EMAIL_SENDER',
-    "feedigest@#{`hostname`.strip}"
-  )
-  EMAIL_RECIPIENT = ENV.fetch('FEEDIGEST_EMAIL_RECIPIENT')
-  DELIVERY_METHOD = ENV.fetch('FEEDIGEST_DELIVERY_METHOD', 'sendmail').to_sym
-
-  Feed = Struct.new(:url, :title, :entries, :error)
-
-  attr_reader :feed_urls
-
-  def initialize(feed_urls)
-    @feed_urls = feed_urls
-  end
-
-  def send_email
-    build_email.deliver if send_email?
-  end
-
-  def to_s
-    build_email.to_s
-  end
-
-  private
-
-  def send_email?
-    feeds.any?
-  end
-
-  def build_email
-    return @build_email if @build_email
-
-    mail = Mail.new
-    mail.from = EMAIL_SENDER
-    mail.to = EMAIL_RECIPIENT
-    mail.subject = email_subject
-    mail.text_part = build_email_text_part
-    mail.html_part = build_email_html_part
-
-    setup_delivery_method(mail)
-
-    @build_email = mail
-  end
-
-  def setup_delivery_method(mail)
-    mail.delivery_method(DELIVERY_METHOD, delivery_method_options)
-  end
-
-  def delivery_method_options
-    case DELIVERY_METHOD
-    when :smtp
-      {
-        address: ENV.fetch('FEEDIGEST_SMTP_HOST'),
-        port: ENV.fetch('FEEDIGEST_SMTP_PORT', '587').to_i,
-        user_name: ENV.fetch('FEEDIGEST_SMTP_USERNAME'),
-        password: ENV.fetch('FEEDIGEST_SMTP_PASSWORD'),
-        authentication: ENV.fetch('FEEDIGEST_SMTP_AUTH', 'plain'),
-        enable_starttls: ENV.fetch('FEEDIGEST_SMTP_STARTTLS', 'true') == 'true'
-      }
-    else
-      {}
-    end
-  end
-
-  def email_subject
-    sprintf(
-      'Digest for %s in %s',
-      pluralize(entries_count, 'entry', 'entries'),
-      pluralize(feeds_without_error.size, 'feed')
-    )
-  end
-
-  def build_email_text_part
-    Mail::Part.new.tap do |p|
-      p.content_type 'text/plain; charset=utf-8'
-      p.body email_body_text
-    end
-  end
-
-  def build_email_html_part
-    Mail::Part.new.tap do |p|
-      p.content_type 'text/html; charset=utf-8'
-      p.body email_body_html
-    end
-  end
-
-  def email_body_html
-    @email_body_html ||=
-      Nokogiri::HTML::Builder.new(encoding: 'utf-8') { |builder|
-        builder.div do
-          feeds.each do |feed|
-            feed_html(builder, feed)
-          end
-        end
-      }.to_html
-  end
-
-  def email_body_text
-    ReverseMarkdown.convert(email_body_html)
-  end
-
-  def feed_html(builder, feed)
-    builder.div do
-      if feed.error
-        builder.h2 feed.url
-        builder.p "Error: #{feed.error}"
-      else
-        builder.h2 feed.title
-        entries_html(builder, feed.entries)
-      end
-    end
-  end
-
-  def entries_html(builder, entries)
-    entries.group_by { |e| e.published.to_date }.each do |date, date_entries|
-      builder.h3 date
-
-      date_entries.each do |entry|
-        entry_html(builder, entry)
-      end
-    end
-  end
-
-  def entry_html(builder, entry)
-    builder.p do
-      builder.a(entry.title, href: entry.url)
-    end
-  end
-
-  def feeds
-    @feeds ||= all_feeds.select { |f| process_feed?(f) }
-  end
-
-  def feeds_without_error
-    feeds.select { |feed| feed[:error].nil? }
-  end
-
-  def process_feed?(feed)
-    feed[:error] || feed[:entries].any?
-  end
-
-  def all_feeds
-    feed_urls.map { |url| feed_from_url(url) }
-  end
-
-  def feed_from_url(url)
-    feed, error = fetch_and_parse_feed(url)
-    Feed.new(
-      url,
-      feed&.title,
-      error ? [] : feed_entries(feed),
-      error
-    )
-  end
-
-  def fetch_and_parse_feed(url)
-    feed = Feedjira::Feed.fetch_and_parse(url)
-    [feed, nil]
-  rescue StandardError => e
-    [nil, e.message]
-  end
-
-  def feed_entries(feed)
-    feed.entries.
-      select { |e| process_entry?(e) }.
-      sort_by { |e| -e.published.to_i }
-  end
-
-  def process_entry?(entry)
-    !entry.published.nil? && entry.published >= window_start
-  end
-
-  def window_start
-    @window_start ||= Time.now - ENTRY_WINDOW
-  end
-
-  def entries_count
-    feeds.reduce(0) { |s, f| s + f.entries.size }
-  end
-
-  def pluralize(count, singular, plural = singular + 's')
-    [count, count == 1 ? singular : plural].join(' ')
-  end
-end
+require 'feedigest/options'
+require 'feedigest/feed_fetcher'
+require 'feedigest/mail_composer'
+require 'feedigest/mail_sender'

data/lib/feedigest/feed_fetcher.rb

@@ -0,0 +1,55 @@
+require 'feedigest/options'
+require 'feedjira'
+
+class Feedigest::FeedFetcher
+  Feed = Struct.new(:url, :title, :entries, :error)
+
+  attr_reader :feed_urls
+
+  def initialize(feed_urls)
+    @feed_urls = feed_urls
+  end
+
+  def feeds
+    @feeds ||= all_feeds.select { |f| process_feed?(f) }
+  end
+
+  private
+
+  def process_feed?(feed)
+    feed[:error] || feed[:entries].any?
+  end
+
+  def all_feeds
+    feed_urls.map { |url| feed_from_url(url) }
+  end
+
+  def feed_from_url(url)
+    feed, error = fetch_and_parse_feed(url)
+    Feed.new(
+      url,
+      feed&.title,
+      error ? [] : feed_entries(feed),
+      error
+    )
+  end
+
+  def fetch_and_parse_feed(url)
+    feed = Feedjira::Feed.fetch_and_parse(url)
+    [feed, nil]
+  rescue StandardError => e
+    [nil, e.message]
+  end
+
+  def feed_entries(feed)
+    feed.entries.select { |e| process_entry?(e) }.sort_by(&:published).reverse
+  end
+
+  def process_entry?(entry)
+    !entry.published.nil? && entry.published >= window_start
+  end
+
+  def window_start
+    @window_start ||= Time.now - Feedigest.options[:entry_window]
+  end
+end

data/lib/feedigest/mail_composer.rb

@@ -0,0 +1,103 @@
+require 'feedigest/options'
+require 'feedigest/version'
+require 'nokogiri'
+require 'reverse_markdown'
+
+class Feedigest::MailComposer
+  Mail = Struct.new(:from, :to, :subject, :html_body, :text_body)
+
+  attr_reader :feeds
+
+  def initialize(feeds)
+    @feeds = feeds
+  end
+
+  def mail
+    @mail ||= Mail.new(
+      Feedigest.options[:email_sender],
+      Feedigest.options[:email_recipient],
+      subject,
+      html_body,
+      text_body
+    )
+  end
+
+  private
+
+  def subject
+    sprintf(
+      'Digest for %s in %s',
+      pluralize(entries_count, 'entry', 'entries'),
+      pluralize(feeds_without_error.size, 'feed')
+    )
+  end
+
+  def html_body
+    @html_body ||=
+      Nokogiri::HTML::Builder.new(encoding: 'utf-8') { |builder|
+        builder.div do
+          feeds.each do |feed|
+            feed_html(builder, feed)
+          end
+
+          signature_html(builder)
+        end
+      }.to_html
+  end
+
+  def text_body
+    ReverseMarkdown.convert(html_body)
+  end
+
+  def feed_html(builder, feed)
+    builder.div do
+      if feed.error
+        builder.h2 feed.url
+        builder.p "Error: #{feed.error}"
+      else
+        builder.h2 feed.title
+        entries_html(builder, feed.entries)
+      end
+    end
+  end
+
+  def entries_html(builder, entries)
+    entries.group_by { |e| e.published.to_date }.each do |date, date_entries|
+      builder.h3 date
+
+      date_entries.each do |entry|
+        entry_html(builder, entry)
+      end
+    end
+  end
+
+  def entry_html(builder, entry)
+    builder.p do
+      builder.a(entry.title, href: entry.url)
+    end
+  end
+
+  def signature_html(builder)
+    builder.p do
+      builder.text '--'
+      builder.br
+      builder.text 'Sent by '
+      builder.a(
+        "feedigest #{Feedigest::VERSION}",
+        href: 'https://github.com/agorf/feedigest'
+      )
+    end
+  end
+
+  def feeds_without_error
+    feeds.select { |feed| feed[:error].nil? }
+  end
+
+  def entries_count
+    feeds.reduce(0) { |count, feed| count + feed.entries.size }
+  end
+
+  def pluralize(count, singular, plural = singular + 's')
+    [count, count == 1 ? singular : plural].join(' ')
+  end
+end

data/lib/feedigest/mail_sender.rb

@@ -0,0 +1,52 @@
+require 'feedigest/options'
+require 'forwardable'
+require 'mail'
+
+class Feedigest::MailSender
+  extend Forwardable
+
+  attr_reader :mail_data
+
+  delegate %i[to_s] => :mail
+
+  def initialize(mail_data)
+    @mail_data = mail_data
+  end
+
+  def deliver
+    setup_delivery_method!(mail)
+    mail.deliver
+  end
+
+  private
+
+  def mail
+    return @mail if @mail
+
+    @mail = Mail.new
+    @mail.from = mail_data.from
+    @mail.to = mail_data.to
+    @mail.subject = mail_data.subject
+    @mail.html_part = html_part
+    @mail.text_part = text_part
+    @mail
+  end
+
+  def html_part
+    Mail::Part.new.tap do |p|
+      p.content_type 'text/html; charset=utf-8'
+      p.body mail_data.html_body
+    end
+  end
+
+  def text_part
+    Mail::Part.new.tap do |p|
+      p.content_type 'text/plain; charset=utf-8'
+      p.body mail_data.text_body
+    end
+  end
+
+  def setup_delivery_method!(mail)
+    mail.delivery_method(:smtp, Feedigest.smtp_options)
+  end
+end

data/lib/feedigest/options.rb

@@ -0,0 +1,23 @@
+module Feedigest
+  def self.options
+    @options ||= {
+      entry_window: ENV.fetch('FEEDIGEST_ENTRY_WINDOW', 60 * 60 * 24), # Seconds
+      email_sender: ENV.fetch(
+        'FEEDIGEST_EMAIL_SENDER',
+        "feedigest@#{`hostname`.strip}"
+      ),
+      email_recipient: ENV.fetch('FEEDIGEST_EMAIL_RECIPIENT')
+    }
+  end
+
+  def self.smtp_options
+    @smtp_options ||= {
+      address: ENV.fetch('FEEDIGEST_SMTP_ADDRESS'),
+      port: ENV.fetch('FEEDIGEST_SMTP_PORT', '587').to_i,
+      user_name: ENV.fetch('FEEDIGEST_SMTP_USERNAME'),
+      password: ENV.fetch('FEEDIGEST_SMTP_PASSWORD'),
+      authentication: ENV.fetch('FEEDIGEST_SMTP_AUTH', 'plain'),
+      enable_starttls: ENV.fetch('FEEDIGEST_SMTP_STARTTLS', 'true') == 'true'
+    }
+  end
+end

data/lib/feedigest/version.rb

@@ -0,0 +1,3 @@
+module Feedigest
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: feedigest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Angelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: feedjira
   requirement: !ruby/object:Gem::Requirement
@@ -80,18 +66,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: 
 email: me@agorf.gr
 executables:
-- feedigest-send
-- feedigest-generate
+- feedigest
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
-- bin/feedigest-generate
-- bin/feedigest-send
+- README.md
+- bin/feedigest
 - lib/feedigest.rb
+- lib/feedigest/feed_fetcher.rb
+- lib/feedigest/mail_composer.rb
+- lib/feedigest/mail_sender.rb
+- lib/feedigest/options.rb
+- lib/feedigest/version.rb
 homepage: https://github.com/agorf/feedigest
 licenses:
 - MIT
@@ -112,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: RSS/Atom feed updates as a digest email

data/bin/feedigest-generate

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'feedigest'
-
-puts 'Please provide a list of feed URLs (one per line) and press Ctrl-D'
-
-feed_urls = $stdin.readlines.map(&:strip)
-
-puts Feedigest.new(feed_urls)

data/bin/feedigest-send

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'feedigest'
-
-if ENV['FEEDIGEST_EMAIL_RECIPIENT'].nil?
-  puts 'Please set $FEEDIGEST_EMAIL_RECIPIENT and try again'
-  exit 1
-end
-
-puts 'Please provide a list of feed URLs (one per line) and press Ctrl-D'
-
-feed_urls = $stdin.readlines.map(&:strip)
-
-Feedigest.new(feed_urls).send_email