mail-sanitizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acc55c6284437b73ceac4e11958d1685566a7a06d03f46fff836a1f3abf71d37
+  data.tar.gz: e80e3a56c249e6fa321a38a383a3f4a90fa6de756c72c849d834e8166940898d
+SHA512:
+  metadata.gz: 2e86abffcdcbe539de3eed561690daff6f4944a4d4138ec62ee81793f20a3efa677b2b641fc738c321f97121cd4df8a25fe4fbe138e89b88bf6b6ab56f81ef2d
+  data.tar.gz: 3f611010a8ffa81e46a4148f12370dbb7fa456b74d11b2765975cc8830737e66f7dbfba22f8080de3b253b2e5a452ffad15f4deab45301c8d6df24118b736271

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at miyoshi@sitebridge.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 mail-sanitizer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 MasatoMiyoshi
+
+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.md

@@ -0,0 +1,89 @@
+# Mail::Sanitizer
+
+A sanitizer for email's body.
+It removes quotation and signature contents from the body.
+The following is an example.
+
+Before sanitizing:
+```
+To: Alice
+
+This is Bob.
+Thanks.
+
+Alice wrote:
+> To: Bob
+>
+> This is Alice.
+> Hello
+
+---------------
+Bob Corporation
+Tel: xxx-xxxx-xxxx
+Email: bob@example.com
+---------------
+```
+
+After sanitizing:
+```
+To: Alice
+
+This is Bob.
+Thanks.
+```
+
+## Dependencies
+
+- ruby 2.3+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail-sanitizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail-sanitizer
+
+## Usage
+
+Use as follows:
+
+```ruby
+# initialize a sanitizer with email's body
+sanitizer = Mail::Sanitizer::Sanitizer.new(body)
+
+# sanitize email's body
+sanitized_body = sanitizer.sanitize
+
+# get quotation contents after sanitizing
+quot = sanitizer.quot
+
+# get signature contents after sanitizing
+sign = sanitizer.sign
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MasatoMiyoshi/mail-sanitizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mail::Sanitizer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/MasatoMiyoshi/mail-sanitizer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mail/sanitizer"
+
+# 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/lib/mail/sanitizer.rb

@@ -0,0 +1,8 @@
+require "mail/sanitizer/version"
+require "mail/sanitizer/constant"
+require "mail/sanitizer/sanitizer"
+
+module Mail
+  module Sanitizer
+  end
+end

data/lib/mail/sanitizer/constant.rb

@@ -0,0 +1,15 @@
+module Mail
+  module Sanitizer
+    class Constant
+      QUOT_SYMBOL_PATTERN = /^>/
+      QUOT_PATTERN = /wrote:|-originalmessage-|-forwardedmessage-/
+      QUOT_DATETIME_PATTERN = /^(on|at)/
+      QUOT_KEYWORD_SET = [
+        ['from:', 'sent:', 'to:', 'subject:'],
+        ['差出人:', '送信日時:', '宛先:', '件名:']
+      ]
+      SIGN_SYMBOL_PATTERN = /^--[ ]*$/
+      SIGN_PATTERN = /^[^[[:alnum:]]|\p{Hiragana}|\p{Katakana}|[一-龠々]]{5,}$/
+    end
+  end
+end

data/lib/mail/sanitizer/sanitizer.rb

@@ -0,0 +1,147 @@
+module Mail
+  module Sanitizer
+    class Sanitizer
+      attr_reader :sanitized_body
+      attr_reader :quot
+      attr_reader :sign
+
+      def initialize(body)
+        @src = body.dup
+        @sanitized_body = nil
+        @quot = nil
+        @sign = nil
+      end
+
+      def sanitize
+        @sanitized_body, @quot, @sign = delete_quot_sign(@src)
+        @sanitized_body
+      end
+
+      private
+
+      def delete_quot_sign(str)
+        lines = split_line(str.strip)
+        quot_lines = []
+        sign_lines = []
+
+        blocks = split_block(lines.join("\n").strip)
+        case blocks.last[:type]
+        when :quot
+          quot_lines += lines.slice!(blocks.last[:start]..blocks.last[:end])
+          if blocks.size > 1 && blocks[-2][:type] == :sign
+            sign_lines += lines.slice!(blocks[-2][:start]..blocks[-2][:end])
+          end
+        when :sign
+          sign_lines += lines.slice!(blocks.last[:start]..blocks.last[:end])
+          if blocks.size > 1 && blocks[-2][:type] == :quot
+            quot_lines += lines.slice!(blocks[-2][:start]..blocks[-2][:end])
+          end
+        end
+
+        return lines.join("\n").strip, quot_lines.join("\n").strip, sign_lines.join("\n").strip
+      end
+
+      def split_line(str)
+        str.split(/[\r\n]/)
+      end
+
+      def downcase(str)
+        str.downcase.gsub(/[[:space:]]/, '')
+      end
+
+      def include_datetime?(str)
+        DateTime.parse(str)
+        true
+      rescue
+        false
+      end
+
+      def split_block(str)
+        lines = split_line(str)
+        numrow = lines.size
+
+        line_types = Array.new(numrow, :normal)
+        sign = false
+        look_sign_symbol = false
+        lines.each_with_index.reverse_each do |line, i|
+          if line =~ Mail::Sanitizer::Constant::QUOT_SYMBOL_PATTERN
+            line_types[i] = :quot
+          elsif line =~ Mail::Sanitizer::Constant::SIGN_PATTERN
+            line_types[i] = :sign
+            sign = !sign
+          elsif line =~ Mail::Sanitizer::Constant::SIGN_SYMBOL_PATTERN
+            next if look_sign_symbol
+            if line_types[i..-1].include?(:quot)
+              j = line_types[i..-1].index(:quot)
+            else
+              j = numrow - i
+            end
+            line_types[i, j] = Array.new(j, :sign)
+            look_sign_symbol = true
+          elsif line =~ /^[[:space:]]*$/
+            line_types[i] = nil
+          elsif sign
+            line_types[i] = :sign
+          end
+        end
+
+        lines.each_with_index do |line, i|
+          keywords = {}
+          Mail::Sanitizer::Constant::QUOT_KEYWORD_SET.each do |set|
+            keywords.clear
+            sidx = 0
+            set.each do |key|
+              keywords[key] = false
+              while (i + sidx) < numrow do
+                downcased_line = downcase(lines[i + sidx])
+                unless downcased_line.empty?
+                  keywords[key] = true if downcased_line =~ /^#{key}/
+                  sidx += 1
+                  break
+                end
+                sidx += 1
+              end
+              break unless keywords[key]
+            end
+            break if keywords.values.all?
+          end
+
+          if keywords.values.all? || downcase(line) =~ Mail::Sanitizer::Constant::QUOT_PATTERN ||
+             (downcase(line) =~ Mail::Sanitizer::Constant::QUOT_DATETIME_PATTERN && include_datetime?(line))
+            line_types[i, numrow - i] = Array.new(numrow - i, :quot) unless line_types[i] == :quot
+            break
+          end
+        end
+
+        concat_line_types(line_types)
+      end
+
+      def concat_line_types(line_types)
+        blocks = []
+        s_pos  = 0
+        pre_line_type = nil
+
+        line_types.each_with_index do |line_type, i|
+          unless line_type == pre_line_type
+            unless pre_line_type.nil?
+              if !blocks.empty? && blocks.last[:type] == pre_line_type
+                blocks.last[:end] = i - 1
+              else
+                blocks << { type: pre_line_type, start: s_pos, end: i - 1 }
+              end
+            end
+            s_pos = i
+          end
+          pre_line_type = line_type
+        end
+
+        if !blocks.empty? && blocks.last[:type] == pre_line_type
+          blocks.last[:end] = line_types.size - 1
+        else
+          blocks << { type: pre_line_type, start: s_pos, end: line_types.size - 1 }
+        end
+        blocks
+      end
+    end
+  end
+end

data/lib/mail/sanitizer/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  module Sanitizer
+    VERSION = "0.1.0"
+  end
+end

data/mail-sanitizer.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mail/sanitizer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail-sanitizer"
+  spec.version       = Mail::Sanitizer::VERSION
+  spec.authors       = ["MasatoMiyoshi"]
+  spec.email         = ["miyoshi@sitebridge.co.jp"]
+
+  spec.summary       = %q{A simple sanitizer for mail bodies}
+  spec.description   = %q{A simple sanitizer for mail bodies}
+  spec.homepage      = "https://github.com/MasatoMiyoshi/mail-sanitizer"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mail-sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MasatoMiyoshi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple sanitizer for mail bodies
+email:
+- miyoshi@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mail/sanitizer.rb
+- lib/mail/sanitizer/constant.rb
+- lib/mail/sanitizer/sanitizer.rb
+- lib/mail/sanitizer/version.rb
+- mail-sanitizer.gemspec
+homepage: https://github.com/MasatoMiyoshi/mail-sanitizer
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple sanitizer for mail bodies
+test_files: []