jekyll-mail-comments 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ebed81f1e8338d62ed7b4260a85053cebba168a7ad734785ba90ba4e2358a4f
+  data.tar.gz: 8a06546dd5307ca7c0142fd9dcca55542510c419edd62d93fb8898a12fb9b65e
+SHA512:
+  metadata.gz: b1261991ca3b7f61b1b9f2f81a7ad5517f7ba50d2cb4801cc57c4b9a40412e569e15e80c3d803df7952750ed498652b4ba3c3051b78eb335dbf24356f6b08c12
+  data.tar.gz: 5291b56543dc5b8fb8fe97275a942c40500327380d3d877bb6d2fff112845097b9694c19687d8ceed8631c07e8795b685475bcd7a50ee48c5be6144dc39d86ec

data/.env.dist

@@ -0,0 +1,5 @@
+export MC_LOGIN="username@mailhost.com"
+export MC_PASSWORD=p4ss0rd
+export MC_HOST="imap.mailhost.com"
+export MC_PORT=993
+export MC_SUBJECT_SUFFIX="Jekyll"

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle
+/.rbenv-vars
+/.ruby-version
+/.rvmrc
+/corpus
+/coverage
+/Gemfile.lock
+/gems
+/mail-*.gem
+/rdoc
+*~
+.env
+*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+gemspec
+gem 'mail'
+gem 'jekyll'

data/README.md

@@ -0,0 +1,70 @@
+# Jekyll Mail comments
+
+This gem fetches email from your mailbox by filtering with specific suffix, it makes data files which you can use to generate Jekyll comments.
+
+## How it works ? 
+
+* You've to setup mailbox, on Jekyll pages you will have mailto link which opens native system mail client with pre filled subject. 
+* Person who wants to comment message write message to your specific email address. 
+* Fetch program watch for special subject suffix to distinct comments from other emails
+* Fetch program generate json based data files which perfectly fits to Jekyll data system https://jekyllrb.com/docs/datafiles/
+
+
+## What is the purpose ?
+
+* Jekyll static site generator has no comments system
+* Don't want to inject 3rdparty javascript code to work with SaSS comments system
+* Any RDBS for static site generator is overhead
+
+
+## How-to Setup
+
+* Go to your jekyll site `cd ~/jekull_site`
+* Install gem `gem install mail_comments`
+* Setup credentials
+
+There few credentials your have to setup before run:
+
+** MC_LOGIN - Login to imap server
+** MC_PASSWORD - Password for imap server
+** MC_HOST - IMAP server hostname
+** MC_PORT - IMAP server port 
+** MC_SUBJECT_SUFFIX - Suffix to filter comments
+
+* You have put this as environment variables `see .env.dist`
+* `jekyll-mail-comments-fetch`
+* After that you will get comments data files inside Jekyll data directory - **_data**
+
+After that if new comments are present it will generate data files with comments which you can process with Jekyll with data tag.
+See here. https://jekyllrb.com/docs/datafiles/ or below.
+
+Here is how to you can include comments block into your Jekyll post template
+
+```
+
+	<section>
+	    {% include comments-count.html replies_to=page.path %}
+	    
+	    {% if comment_count %}
+	    <h2>Comments ({{- comment_count -}}) <small class="text-muted">Read carefuly </small> </h2>
+	    {% include comments.html replies_to=page.path indent_class="ml-auto" title=page.title %}
+	    {% else %}
+	    <h2>No comments here yet <small class="text-muted">Write here gently</small></h2>
+	    {% endif %}
+	    <div class="mt-3"><a class="btn btn-outline-secondary btn-block" href="mailto:{{site.comments.email}}?subject=RE:{{page.path}}:{{site.comments.subject_suffix}}:{{post.title}}">Write a comment</a> </div>
+	</section>
+```
+Templates can be found inside **templates** directory of this gem.
+
+
+## Credits
+
+Inspiration while searching for already existing gem for email comments
+
+* https://stevescott.ca/2017-04-03-static-site-comments-via-email.html
+* https://github.com/aioobe/dead-simple-jekyll-comments/
+
+
+## Example
+
+* https://blog.falsetrue.io

data/bin/jekyll-mail-comments-fetch

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'jekyll-mail-comments'
+Jekyll::MailComments.fetch

data/jekyll-mail-comments.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'jekyll-mail-comments'
+  s.version     = '0.0.2'
+  s.date        = '2022-01-01'
+  s.summary     = "Email based comment system for Jekyll static site generator"
+  s.description = <<DESC 
+Provides html generator of threaded comments pages fetched from an IMAP for Jekyll
+DESC
+  s.authors     = "Dmitry Rodichev"
+  s.email       = 'noroot@falsetrue.io'
+  s.files = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'jekyll'
+  s.homepage    = 'https://github.com/noroot/jekyll-mail-comments'
+  s.license       = 'GPL-3.0'
+  s.post_install_message = <<MSG
+Don't forget to put credentials inside .env file, see .env.dist inside gem source.
+MSG
+end

data/lib/jekyll-mail-comments.rb

@@ -0,0 +1,103 @@
+require 'net/imap'
+require 'mail'
+require 'fileutils'
+require "base64"
+require 'yaml'
+require 'digest'
+require 'jekyll'
+
+module Jekyll
+  
+  module MailComments
+
+    class Configuration
+      attr_accessor :login
+      attr_accessor :password
+      attr_accessor :host
+      attr_accessor :port
+      attr_accessor :subject_suffix
+
+      def initialize
+        @login = ENV.fetch('MC_LOGIN', '')
+        @password = ENV.fetch('MC_PASSWORD', '')
+        @host = ENV.fetch('MC_HOST', '')
+        @port = ENV.fetch('MC_PORT', '')
+        @subject_suffix = ENV.fetch('MC_SUBJECT_SUFFIX', '')     
+      end
+    end
+
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.fetch
+      
+      login = MailComments.configuration.login 
+      password = MailComments.configuration.password 
+      host = MailComments.configuration.host 
+      port = MailComments.configuration.port 
+      subject_suffix = MailComments.configuration.subject_suffix
+
+      imap = Net::IMAP.new(host, 993, true)
+      imap.login(login, password)
+      imap.select("INBOX")
+      cx = imap.search(["SUBJECT", subject_suffix, "UNSEEN"])
+      if !cx.nil? && cx.length > 0
+        puts "Comments found CX=#{cx.length}"
+        comments = {}
+        cx.each do |message_id| 
+          msg = imap.fetch(message_id,'RFC822')[0].attr['RFC822']    
+          mail = Mail.read_from_string(msg)
+          if mail.multipart?
+            body = mail.multipart?? mail.text_part.body.decoded : mail.html_part.body.decoded
+          else
+            body = mail.body.decoded
+          end
+          
+          author = mail.header['From'].field.addrs.first.display_name    
+
+          begin
+            tmp = mail.subject.split(":")
+            if tmp.length == 4
+              reply_id = mail.subject.split(":")[1].strip()
+              post_title = mail.subject.split(":")[3].strip()
+              
+              message_id = Digest::SHA1.hexdigest(mail['Message-ID'].value)
+              comment = {
+                title: post_title,
+                reply_to: reply_id,
+                id:  message_id,
+                author: author,
+                from: mail.from.first,
+                date: mail.date,        
+                text: body
+              }
+              file_name = "#{mail.date.strftime("%s").to_s}-#{message_id}.yaml"
+              File.open("_data/comments/#{file_name}", "w") do |f|
+                f.write(comment.transform_keys(&:to_s).to_yaml)
+              end
+              puts "Comment from #{comment[:author]} - <#{comment[:from]}> on \"#{comment[:title]}\" at #{comment[:date]}"
+            else
+              puts "Wrong subject for #{msg}"
+            end
+
+          rescue => e
+            puts e
+          end
+        end
+      else
+        puts "No messages found."
+      end
+
+    end
+  end
+end

data/lib/jekyll_mail_comments.rb

@@ -0,0 +1,100 @@
+require 'net/imap'
+require 'mail'
+require 'fileutils'
+require "base64"
+require 'yaml'
+require 'digest'
+
+
+module MailComments
+
+  class Configuration
+    attr_accessor :login
+    attr_accessor :password
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :subject_suffix
+
+    def initialize
+      @login = ENV.fetch('MC_LOGIN', '')
+      @password = ENV.fetch('MC_PASSWORD', '')
+      @host = ENV.fetch('MC_HOST', '')
+      @port = ENV.fetch('MC_PORT', '')
+      @subject_suffix = ENV.fetch('MC_SUBJECT_SUFFIX', '')     
+    end
+  end
+
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.fetch
+    
+    login = MailComments.configuration.login 
+    password = MailComments.configuration.password 
+    host = MailComments.configuration.host 
+    port = MailComments.configuration.port 
+    subject_suffix = MailComments.configuration.subject_suffix
+
+    imap = Net::IMAP.new(host, 993, true)
+    imap.login(login, password)
+    imap.select("INBOX")
+    cx = imap.search(["SUBJECT", subject_suffix, "UNSEEN"])
+    if !cx.nil? && cx.length > 0
+      puts "Comments found CX=#{cx.length}"
+      comments = {}
+      cx.each do |message_id| 
+        msg = imap.fetch(message_id,'RFC822')[0].attr['RFC822']    
+        mail = Mail.read_from_string(msg)
+        if mail.multipart?
+          body = mail.multipart?? mail.text_part.body.decoded : mail.html_part.body.decoded
+        else
+          body = mail.body.decoded
+        end
+        
+        author = mail.header['From'].field.addrs.first.display_name    
+
+        begin
+          tmp = mail.subject.split(":")
+          if tmp.length == 4
+            reply_id = mail.subject.split(":")[1].strip()
+            post_title = mail.subject.split(":")[3].strip()
+            
+            message_id = Digest::SHA1.hexdigest(mail['Message-ID'].value)
+            comment = {
+              title: post_title,
+              reply_to: reply_id,
+              id:  message_id,
+              author: author,
+              from: mail.from.first,
+              date: mail.date,        
+              text: body
+            }
+            file_name = "#{mail.date.strftime("%s").to_s}-#{message_id}.yaml"
+            File.open("_data/comments/#{file_name}", "w") do |f|
+              f.write(comment.transform_keys(&:to_s).to_yaml)
+            end
+            puts "Comment from #{comment[:author]} - <#{comment[:from]}> on \"#{comment[:title]}\" at #{comment[:date]}"
+          else
+            puts "Wrong subject for #{msg}"
+          end
+
+        rescue => e
+          puts e
+        end
+      end
+    else
+      puts "No messages found."
+    end
+
+  end
+end

data/templates/comments-count.html

@@ -0,0 +1,7 @@
+{%- for entry in site.data.comments -%}
+{%- if entry[1].reply_to == include.replies_to -%}
+{%- assign comment_count = comment_count | plus: 1 -%}
+{%- assign com_id = entry[0] -%}
+{%- include comments-count.html replies_to=com_id -%}
+{%- endif -%}
+{%- endfor -%}

data/templates/comments.html

@@ -0,0 +1,30 @@
+{% assign sorted = site.data.comments | sort  %}
+{%- for entry in sorted -%}
+
+{%- assign cid = entry[0] -%}
+{%- assign com = entry[1] -%}
+{%- assign indent_class = include.indent_class %}
+{%- assign title = include.title %}
+{%- if com.reply_to != include.replies_to -%}
+{%- continue -%}
+{%- endif -%}
+
+<div class="{{ indent_class }} comment" id="{{ cid }}">
+    <div class="d-flex">
+	<div><a href="" class="comment-author">{{ com.author | escape | strip_newlines }}</a> - <span class="comment-date"> {{ com.date | date_to_rfc822 }}</span></div>
+	<!-- <div class="ml-auto">at {{ com.date | date_to_rfc822 }}</div> -->
+    </div>
+    <div>
+	{{ com.text | escape | newline_to_br | strip_newlines | markdownify | replace: "&amp;#39;", "'" | replace: "&amp;quot;", '"' }}
+	
+	<!-- <div class="comment-controls">
+	     <a href="#{{cid}}">Permalink</a> | <a href="mailto:{{site.comments.email}}?subject=RE:{{cid}}:{{site.comments.subject_suffix}}:{{ page.path}}">Reply</a>
+	     </div> -->
+    </div>
+    <div class="d-flex">
+	<div class="ml-auto"><a href="#{{cid}}">Permalink</a> | <a href="mailto:{{site.comments.email}}?subject=RE:{{cid}}:{{site.comments.subject_suffix}}:{{title}}">Reply</a> </div>
+    </div>
+    {%- include comments.html replies_to=cid indent_class="ml-3 comment-indent" title=title -%}
+</div>
+
+{%- endfor -%}

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-mail-comments
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dmitry Rodichev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Provides html generator of threaded comments pages fetched from an IMAP
+  for Jekyll
+
+'
+email: noroot@falsetrue.io
+executables:
+- jekyll-mail-comments-fetch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.dist"
+- ".gitignore"
+- Gemfile
+- README.md
+- bin/jekyll-mail-comments-fetch
+- jekyll-mail-comments.gemspec
+- lib/jekyll-mail-comments.rb
+- lib/jekyll_mail_comments.rb
+- templates/comments-count.html
+- templates/comments.html
+homepage: https://github.com/noroot/jekyll-mail-comments
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 'Don''t forget to put credentials inside .env file, see .env.dist
+  inside gem source.
+
+'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Email based comment system for Jekyll static site generator
+test_files: []