feedigest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab1e04866f9a432849b17e607d1c90366e248a7d42ea3d44aec0e6749dd1405e
+  data.tar.gz: f0948b0ddd6910cee3bd237e0b2a0a74abcf6167af8e7e1f92a2ec3a978867d1
+SHA512:
+  metadata.gz: 57b418b0d2d9ddb580b3ec746012ffc2b00fe5125b3c2a7b9553614ff1db5d79a7b4440df4e13849f7913a736135ecc94af3529f402030d379cadaa7f1353d33
+  data.tar.gz: 9ca032d6a782bd4b9a3589a000651df5f660383b79f0f1e51d123150f6f71b9f799e9434a7428d3d70f4cb96a6c0ace5f53843a1ddfc57bea8c28b17a8e5e4e7

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License
+
+Copyright (c) 2018 Angelos Orfanakos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/feedigest-generate

@@ -0,0 +1,9 @@
+#!/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

@@ -0,0 +1,14 @@
+#!/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

data/lib/feedigest.rb

@@ -0,0 +1,192 @@
+require 'dotenv/load'
+require 'feedjira'
+require 'mail'
+require 'nokogiri'
+require 'reverse_markdown'
+
+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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: feedigest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Angelos Orfanakos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-12 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: reverse_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email: me@agorf.gr
+executables:
+- feedigest-send
+- feedigest-generate
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- bin/feedigest-generate
+- bin/feedigest-send
+- lib/feedigest.rb
+homepage: https://github.com/agorf/feedigest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: RSS/Atom feed updates as a digest email
+test_files: []