simple_mailing_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 876826ef49ceb87b9cde436ec1e710e201235c6b
+  data.tar.gz: 11146f4b0668fd4a82d52ddcbddab47c44d319c0
+SHA512:
+  metadata.gz: 681ba3200cde48683fe55e9f08cff82593cbe5bf0e065608e1c5e35e76322c7a3254960a978a94d2df4ba75211cfd17d213a2fdd5b028ef3a763f853d9822df6
+  data.tar.gz: f5ba4251379ffa68c4ce0c41db8a2e95649aba52e38d6cc2f3511bbd5b38ddce393811e730211c0fd3637ec284b06cdfed59b1f0aeb4354383e00f9914846563

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_mailing_list.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    simple_mailing_list (0.1.0)
+      activerecord
+      daemons
+      liquid
+      mail
+      sqlite3
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
+      arel (~> 8.0)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    daemons (1.2.6)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    liquid (4.0.0)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    sqlite3 (1.3.13-x86-mingw32)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  simple_mailing_list!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 nodai2hITC
+
+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/README.ja.md

@@ -0,0 +1,78 @@
+# SimpleMailingList
+
+シンプルなメーリングリスト／メールマガジンシステムです。
+
+一般的なそうしたシステムと異なり、「最低限必要なもの」が非常に少ないのが特徴です。
+
+## 動作環境
+
+### 最低動作環境
+
+- 送受信可能なメールアドレス１つ
+- Ruby が動作するコンピュータ１台
+
+### 推奨動作環境
+
+- 送信可能なメールアドレス１つ
+- 受信可能なメールアドレス３つ以上
+一般的なそうしたシステムと異なり、「最低限必要なもの」が非常に少ないのが特徴です。
+
+## 動作環境
+
+### 最低動作環境
+
+- 送受信可能なメールアドレス１つ
+- Ruby が動作するコンピュータ１台
+
+### 推奨動作環境
+
+- 送信可能なメールアドレス１つ
+- 受信可能なメールアドレス３つ以上
+- Linux など、プロセスを Daemon 化可能な環境のコンピュータ１台
+
+## インストール
+
+Gemfile に以下を追加し、```$ bundle```
+
+```ruby
+gem 'simple_mailing_list'
+gem 'sqlite3'
+# gem 'mysql2'
+# gem 'pg'
+```
+
+または、以下のようにしてインストール:
+
+    $ gem install simple_mailing_list
+
+## 使い方
+
+YAML 形式のコンフィグファイルを用意し、
+
+    $ simple_mailing_list setup -c <config.yaml>
+
+でデータベースやディレクトリを作成する。
+
+    $ simple_mailing_list <mode> -c <config.yaml>
+
+で実行。
+
+```<mode>``` を省略すると、「メールの受信・処理」「古いデータの削除」といった一連の処理を行います。
+
+```-c``` を省略すると、「 config.yaml 」が使用されます。
+
+コンフィグファイルの書き方については、[config_example.ja.yaml](https://github.com/nodai2hITC/simple_mailing_list/blob/master/example/config_example.ja.yaml) を参考に。
+
+### Daemon 化
+
+    $ daemons_simple_mailing_list start -- loop -c <config.yaml>
+
+で、「メールの受信・処理」「古いデータの削除」といった一連の処理をずっと繰り返します。
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nodai2hITC/simple_mailing_list.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/README.md

@@ -0,0 +1,31 @@
+# SimpleMailingList
+
+[日本語説明（こちらの方が詳細）](https://github.com/nodai2hITC/simple_mailing_list/blob/master/README.ja.md)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_mailing_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_mailing_list
+
+## Usage
+
+    $ simple_mailing_list help
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nodai2hITC/simple_mailing_list.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_mailing_list"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/config_example.ja.yaml

@@ -0,0 +1,127 @@
+log:
+  filename: "logs/%v.log" # ログファイル名。Time#strftime の書式を使用可。省略すると標準出力。
+  rotation: daily         # ログローテーション。Ruby の Logger を参照。
+  level:    debug         # 記録するログのレベル。Ruby の Logger を参照。
+
+lockfile: lock/lock.file  # ロック用のファイル名。省略するとロックを行わない。
+
+maillogs_dir:    maillogs # メールログを記録するフォルダ名。
+maillogs_period: -1       # メールログを記録する秒数。マイナスにすると永遠。
+
+validity_time:   86400    # 登録/削除確認メールの有効時間。（デフォルト：86400s==一日）
+max_check_times: 5        # 同じメールアドレスから登録/削除要求メールが何度も来た場合、
+                          # 有効時間内にはこの数以上の確認メールを送らない。
+
+sleep_time1:     0.1      # メールを送った後の待機時間。
+sleep_time2:     1.5      # 同じドメインに連続してメールを送る際の待機時間。
+
+# 許可された人だけがメール転送をできるようにする設定。
+# 指定されたメールアドレスからのメールか、
+# 件名に「チェックコード」を含むメール（あるいはその両方）のみ転送される。
+# 省略した場合、誰でもメール転送ができる。
+permitted_users:
+  - address: yamada@mail.example.com
+  - check_code: "forward!"
+# ↑例） yamada@mail.example.com からのメール、または
+#      件名に「forward!」を含むメールのみを転送。
+
+# メール配信に登録されている人だけがメール転送をできるようにする。
+registered_user_only:   false
+
+# 転送メールの差出人を、もとのメールの差出人にする。
+use_address_camouflage: false
+
+# HTMLメールを有効にする。
+enable_html_mail:       false
+
+# 使用するデータベースの設定。
+database:
+  adapter:  sqlite3
+  database: sml_test
+
+# メール受信の設定。
+# https://www.school.ctc-g.co.jp/columns/masuidrive/masuidrive07.html
+# https://github.com/mikel/mail 等を参照。
+receive_server:
+  protocol: pop3
+  options:
+    address:    mail.example.com
+    port:       110
+    user_name:  simpleml
+    password:   "simpleml_pass"
+    enable_ssl: false
+
+# メール送信の設定。同上
+deliver_server:
+  protocol: smtp
+  address:  '"シンプルメーリングリスト" <simpleml@mail.example.com>'
+  charset:  utf-8
+  options:
+    address:              mail.example.com
+    port:                 25
+    domain:               mail.example.com
+    authentication:       null
+    user_name:            null
+    password:             null
+    ssl:                  null
+    enable_starttls_auto: false
+    openssl_verify_mode:  null
+
+# 登録要求メールの設定。
+# 指定されたメールアドレスへのメールか、
+# 件名・本文に特定の「チェックコード」を含むメールを
+# 登録要求メールと判断する。
+register:
+  - address: register1@mail.example.com
+    options: { grade: 1 }
+  - address: register2@mail.example.com
+    options: { grade: 2 }
+  - address: register3@mail.example.com
+    options: { grade: 3 }
+  - address: register@mail.example.com
+    subject: !ruby/regexp /(1|１|一)年/
+    options: { grade: 1 }
+# ↑例）
+# 「register(数値)@mail.example.com」にメールを送ると、
+# その数値のgrade（学年）として登録される。
+# または、「register@mail.example.com」に、件名に「1年」等を
+# 含むメールを送ると、1年として登録される。
+
+# 登録確認メールの件名・本文
+register_confirm_subject: "登録確認メール：{{checkcode}}"
+register_confirm_body: |
+  登録ありがとうございます。
+  24時間以内に、このメールに返信するか、
+  以下の認証コードを本文中にコピーしたメールを送ってください。
+  認証コード：{{checkcode}}
+# 登録完了メールの件名・本文
+register_success_subject: "登録完了"
+register_success_body: |
+  登録が完了しました。
+  登録を解除するには、delete@mail.example.com にメールを送ってください。
+
+# 削除要求メールの設定。register 参照。
+delete:
+  - address: delete@mail.example.com
+delete_confirm_subject: "登録解除確認メール：{{checkcode}}"
+delete_confirm_body: |
+  登録を解除するには24時間以内に、このメールに返信するか、
+  以下の認証コードを本文中にコピーしたメールを送ってください。
+  認証コード：{{checkcode}}
+delete_success_subject: "登録解除完了"
+delete_success_body: |
+  登録を解除しました。
+
+# 転送メールの設定。
+forward:
+  - address: forward@mail.example.com
+  - address: forward1@mail.example.com
+    options: { grade: 1 }
+  - address: forward2@mail.example.com
+    options: { grade: 2 }
+  - address: forward3@mail.example.com
+    options: { grade: 3 }
+# ↑例）
+# forward@mail.example.com に送ると登録者全員に、
+# forward(数値)@mail.example.com に送ると
+# 該当学年の登録者のみにメールを転送する。

data/example/config_example.yaml

@@ -0,0 +1,89 @@
+log:
+  filename: "logs/%v.log"
+  rotation: daily
+  level:    debug
+
+lockfile: lock/lock.file
+
+maillogs_dir:    maillogs
+maillogs_period: -1
+
+validity_time:   86400
+max_check_times: 5
+
+sleep_time1:     0.1
+sleep_time2:     1.5
+
+permitted_users:
+  - address: yamada@mail.example.com
+  - check_code: "forward!"
+
+registered_user_only:   false
+
+use_address_camouflage: false
+
+enable_html_mail:       false
+
+database:
+  adapter:  sqlite3
+  database: sml_test
+
+receive_server:
+  protocol: pop3
+  options:
+    address:    mail.example.com
+    port:       110
+    user_name:  simpleml
+    password:   "simpleml_pass"
+    enable_ssl: false
+
+deliver_server:
+  protocol: smtp
+  address:  '"SimpleMailingList" <simpleml@mail.example.com>'
+  charset:  utf-8
+  options:
+    address:              mail.example.com
+    port:                 25
+    domain:               mail.example.com
+    authentication:       null
+    user_name:            null
+    password:             null
+    ssl:                  null
+    enable_starttls_auto: false
+    openssl_verify_mode:  null
+
+register:
+  - address: register1@mail.example.com
+    options: { grade: 1 }
+  - address: register2@mail.example.com
+    options: { grade: 2 }
+  - address: register3@mail.example.com
+    options: { grade: 3 }
+  - address: register@mail.example.com
+    subject: !ruby/regexp /1st|first/i
+    options: { grade: 1 }
+
+register_confirm_subject: "Registration Confirmation: {{checkcode}}"
+register_confirm_body: |
+  Authentication key ... {{checkcode}}
+register_success_subject: "Registration Complete !"
+register_success_body: |
+  Registration Complete !
+
+delete:
+  - address: delete@mail.example.com
+delete_confirm_subject: "Deletion Confirmation: {{checkcode}}"
+delete_confirm_body: |
+  Authentication key ... {{checkcode}}
+delete_success_subject: "Deletion Complete !"
+delete_success_body: |
+  Registration Complete !
+
+forward:
+  - address: forward@mail.example.com
+  - address: forward1@mail.example.com
+    options: { grade: 1 }
+  - address: forward2@mail.example.com
+    options: { grade: 2 }
+  - address: forward3@mail.example.com
+    options: { grade: 3 }

data/exe/daemons_simple_mailing_list

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "simple_mailing_list"
+require "daemons"
+
+options = {
+  ARGV: ARGV,
+  dir_mode: :normal,
+  dir: Dir.pwd,
+  log_output: true
+}
+options[:ARGV] += ["--", "loop"] unless options[:ARGV].index("--")
+
+Daemons.run("simple_mailing_list", options)

data/exe/simple_mailing_list

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "simple_mailing_list"
+
+SimpleMailingList::CLI.start(ARGV)

data/lib/simple_mailing_list/configfile.rb

@@ -0,0 +1,87 @@
+module SimpleMailingList
+  module System
+    DEFAULT_CONFIGFILE = "config.yaml"
+
+    private
+
+    def load_configfile(configfile)
+      return if @path
+
+      # basic
+      config = YAML.load(File.read(configfile, encoding: "utf-8"))
+      @path = Dir.getwd
+
+      # log
+      config["log"] ||= {}
+      file = config["log"]["filename"] ?
+        File.expand_path(Time.now.strftime(config["log"]["filename"]), @path) : STDOUT
+      @log = (config["log"]["rotation"].is_a? Integer) ?
+        Logger.new(file, config["log"]["rotation"], config["log"]["shift_size"] || 1048576) :
+        Logger.new(file, config["log"]["rotation"] || 0)
+      if config["log"]["level"]
+        @log.level = config["log"]["level"].is_a?(String) ?
+          %w[debug info warn error fatal].index(config["log"]["level"].downcase) :
+          config["log"]["level"]
+      end
+
+      # others
+      @lockfile                 = config["lockfile"]
+      @maillogs_dir             = File.expand_path(config["maillogs_dir"] || "maillogs", @path)
+      @maillogs_period          = config["maillogs_period"] || -1
+
+      @validity_time            = config["validity_time"] || 86400
+      @max_check_times          = config["max_check_times"] || 5
+
+      @sleep_time1              = config["sleep_time1"] || 0.1
+      @sleep_time2              = config["sleep_time2"] || 1.5
+      @permitted_users          = config["permitted_users"]
+      @registered_user_only     = !!config["registered_user_only"]
+      @use_address_camouflage   = !!config["use_address_camouflage"]
+      @enable_html_mail         = !!config["enable_html_mail"]
+
+      @receive_servers          = config["receive_servers"] || []
+      @deliver_server           = config["deliver_server"] ||
+        { "protocol" => "sendmail", "charset" => "utf-8", "options" => {} }
+      
+      @register = config["register"] || []
+      @register_confirm_subject = config["register_confirm_subject"] || ""
+      @register_confirm_body    = config["register_confirm_body"] || ""
+      @register_success_subject = config["register_success_subject"] || ""
+      @register_success_body    = config["register_success_body"] || ""
+
+      @delete                   = config["delete"] || []
+      @delete_confirm_subject   = config["delete_confirm_subject"] || ""
+      @delete_confirm_body      = config["delete_confirm_body"] || ""
+      @delete_success_subject   = config["delete_success_subject"] || ""
+      @delete_success_body      = config["delete_success_body"] || ""
+
+      @forward                  = config["forward"] || []
+      @reply_to_address         = config["reply_to_address"]
+
+      # database
+      if config["database_require"]
+        require config["database_require"]
+      else
+        case config["database"]["adapter"]
+        when "mysql2"
+          require "mysql2"
+        when "postgresql"
+          require "pg"
+        when "sqlite3"
+          require "sqlite3"
+        else
+          require config["database"]["adapter"]
+        end
+      end
+      ActiveRecord::Base.establish_connection(config["database"])
+
+      # mail server
+      @receive_servers = Array(config["receive_server"]) if config["receive_server"]
+      deliver_server = @deliver_server
+      Mail.defaults do
+          delivery_method(deliver_server["protocol"].to_sym,
+                          deliver_server["options"].symbolize_keys)
+      end
+    end
+  end
+end

data/lib/simple_mailing_list/delete_old.rb

@@ -0,0 +1,45 @@
+class User         < ActiveRecord::Base ; end
+class Confirmation < ActiveRecord::Base ; end
+
+module SimpleMailingList
+  module System
+    private
+
+    def _delete_failed_users(failed_count = 10, time = 5 * 24 * 60 * 60)
+      @log.debug "Delete failed users."
+      last_failed_at = Time.now - time
+      users = User.where("last_failed_at > ? AND failed_count > ?", last_failed_at, failed_count)
+      users.each do |user|
+        @log.info "user[#{user.mail_address}] was deleted."
+      end
+      users.destroy_all()
+      User.find_each do |user|
+        user.failed_count = 0
+        user.save
+      end
+    end
+
+    def _delete_old_confirmations()
+      @log.debug "Delete old confirmations."
+      time = Time.now - @validity_time
+      confirmations = Confirmation.where("created_at < ?", time)
+      num = confirmations.size
+      confirmations.destroy_all()
+      @log.info "#{num} confirmation#{num > 1 ? 's' : ''} #{num > 1 ? 'were' : 'was'} deleted." if num > 0
+    end
+
+    def _delete_old_maillogs()
+      return unless @maillogs_period >= 0
+
+      @log.debug "Delete old maillogs."
+      time = Time.now - @maillogs_period
+      num = 0
+      maillogs = Dir.glob(File.join(@maillogs_dir, "*", "*.eml")).select do |maillog|
+        File.mtime(maillog) < time
+      end
+      num = maillogs.size
+      maillogs.each { |maillog| File.delete(maillog) }
+      @log.info "#{num} maillog#{num > 1 ? 's' : ''} #{num > 1 ? 'were' : 'was'} deleted." if num > 0
+    end
+  end
+end

data/lib/simple_mailing_list/lock.rb

@@ -0,0 +1,22 @@
+module SimpleMailingList
+  module System
+    private
+
+    def lock()
+      if @lockfile
+        open(File.expand_path(@lockfile, @path), "w") do |lockfile|
+          if lockfile.flock(File::LOCK_EX | File::LOCK_NB)
+            @log.debug("Lock successed.")
+            yield
+            lockfile.flock(File::LOCK_UN)
+            @log.debug("Unlocked.")
+          else
+            @log.debug("Lock failed.")
+          end
+        end
+      else
+        yield
+      end
+    end
+  end
+end