chronicle-email 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc59f3989349d41ca82714928ef7dac76b8de15e574957f1ba1e43ef4d9d5582
+  data.tar.gz: ac02b231fc27d2d01d46df43cbcd21ef2942fcacca44b651e7d610fff0011b7f
+SHA512:
+  metadata.gz: af08b7775a33f812b4eb1f3521ee50b5d909a29871699c033a7090949a1a557e366da54bb869cfc2f74bc4e0f2af995535c81328c627ac941cb77def96b44a71
+  data.tar.gz: 54eac88a9005c840bfe1b0e289f2e063e9a9a40dfdf064c82bec51b7e985a5d911b59633ddffd2f37d4c605add8d9ae738bec886a21fc127c5c6efa364f069b3

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+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 andrew@hyfen.net. 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 chronicle-email.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    chronicle-email (0.1.0)
+      chronicle-etl (~> 0.1.3)
+      email_reply_parser (~> 0.5)
+      mail (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    chronicle-etl (0.1.3)
+      colorize (~> 0.8.1)
+      thor (~> 0.20)
+      tty-progressbar (~> 0.17)
+      tty-table (~> 0.11)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    email_reply_parser (0.5.10)
+    equatable (0.6.1)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (1.0.0)
+    mini_mime (1.0.2)
+    necromancer (0.6.0)
+    pastel (0.7.4)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    strings (0.1.8)
+      strings-ansi (~> 0.1)
+      unicode-display_width (~> 1.5)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.1.0)
+    thor (0.20.3)
+    tty-color (0.5.2)
+    tty-cursor (0.7.1)
+    tty-progressbar (0.17.0)
+      strings-ansi (~> 0.1.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      unicode-display_width (~> 1.6)
+    tty-screen (0.8.1)
+    tty-table (0.11.0)
+      equatable (~> 0.6)
+      necromancer (~> 0.5)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.5)
+      tty-screen (~> 0.7)
+    unicode-display_width (1.7.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  chronicle-email!
+  pry-byebug (~> 3.9)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrew Louis
+
+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,16 @@
+# Chronicle::Email
+
+Email importer for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
+
+## Available classes
+- `email:mbox` - Extractor for processing .mbox files
+- `email:chronicle` - Transformer that converts an email into a chronicle schema
+
+## Usage
+
+```bash
+gem install chronicle-etl
+gem install chronicle-email
+
+chronicle-etl --extractor email:mbox --extractor-opts filename:"./mail.mbox" --transformer email:chronicle --loader stdout
+```

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 "chronicle/email"
+
+# 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/chronicle-email.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chronicle/email/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chronicle-email"
+  spec.version       = Chronicle::Email::VERSION
+  spec.authors       = ["Andrew Louis"]
+  spec.email         = ["andrew@hyfen.net"]
+
+  spec.summary       = "Email importer for Chronicle"
+  spec.description   = "Various email importers for chronicle-etl"
+  spec.homepage      = "https://github.com/chronicle-app/chronicle-email"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/chronicle-app/chronicle-email"
+    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-email"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.add_dependency "chronicle-etl", "~> 0.1.3"
+  spec.add_dependency "mail", "~> 2.7"
+  spec.add_dependency 'email_reply_parser', '~> 0.5'
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "pry-byebug", "~> 3.9"
+end

data/lib/chronicle/email.rb

@@ -0,0 +1,9 @@
+require "chronicle/email/version"
+require "chronicle/email/chronicle_transformer"
+require "chronicle/email/mbox_extractor"
+
+module Chronicle
+  module Email
+    PROVIDER_NAME = "email"
+  end
+end

data/lib/chronicle/email/chronicle_transformer.rb

@@ -0,0 +1,150 @@
+require 'chronicle/etl'
+require 'mail'
+require 'timeout'
+require 'email_reply_parser'
+
+module Chronicle
+  module Email
+    class ChronicleTransformer < Chronicle::Etl::Transformer
+      def transform data
+        message = Mail.new(data.b)
+        build_messaged(message)
+      end
+
+      def build_messaged message
+        {
+          type: 'activities',
+          attributes: {
+            verb: 'messaged',
+            end_at: message.date,
+            provider: 'email',
+            provider_id: message.message_id,
+          },
+          meta: { dedupe_on: 'verb,provider,provider_id'},
+          relationships: {
+            actor: { data: build_actor(message) },
+            involved: { data: build_message(message) }
+          }
+        }
+      end
+
+      def build_actor message
+        # sometimes From: fields are malformed and we can't build an
+        # actor out of it.
+        return unless message[:from] && message[:from].addrs && message[:from].addrs.any?
+
+        {
+          type: 'entities',
+          attributes: {
+            represents: 'identity',
+            provider: 'email',
+            slug: message[:from].addrs.first.address,
+            title: message[:from].addrs.first.display_name
+          },
+          meta: { dedupe_on: 'represents,provider,slug'}
+        }
+      end
+
+      def build_message message
+        {
+          type: 'entities',
+          attributes: {
+            represents: 'message',
+            title: clean_subject(message.subject),
+            body: clean_body(message),
+            provider: 'email',
+            provider_id: message.message_id
+          },
+          meta: { dedupe_on: 'represents,provider,provider_id'},
+          relationships: {
+            consumers: { data: build_consumers(message) },
+            antecedents: { data: build_references(message) },
+            owners: { data: build_account(message) },
+            # contains: { data: build_attachments(message) }
+          }
+        }
+      end
+
+      def build_account message
+        return unless account_email = [message.header['delivered-to']].flatten[0]&.value
+
+        {
+          type: 'entities',
+          attributes: {
+            represents: 'identity',
+            provider: 'email',
+            slug: account_email
+          },
+          meta: { dedupe_on: 'provider,slug,represents' }
+        }
+      end
+
+      def build_consumers(message)
+        to = []
+        to += message[:to].addrs if message[:to]
+        to += message[:cc].addrs.flatten.compact if message[:cc]
+
+        to.collect do |consumer|
+          {
+            type: 'entities',
+            attributes: {
+              represents: 'identity',
+              provider: 'email',
+              slug: consumer.address,
+              title: consumer.display_name
+            },
+            meta: { dedupe_on: 'provider,slug' }
+          }
+        end
+      end
+
+      def build_references(message)
+        references = [message.references].flatten.compact
+        references.collect{|reference|
+          {
+            type: 'entities',
+            attributes: {
+              represents: 'message',
+              provider: 'email',
+              provider_id: reference
+            },
+            meta: { dedupe_on: 'represents,provider,provider_id' }
+          }
+        }
+      end
+
+      def clean_subject(subject)
+        subject&.encode("UTF-8", invalid: :replace, undef: :replace)
+      end
+
+      def clean_body message
+        # FIXME: this all needs to be refactored
+
+        if message.multipart?
+          body = message.text_part&.decoded rescue Mail::UnknownEncodingType
+        else
+          body = message.body&.decoded rescue Mail::UnknownEncodingType
+        end
+
+        if body && body != ""
+          begin
+            # regex in EmailReplyParse gem seems to get into infinite loops with
+            # certain long bodies that have binary data
+            parsed_body = Timeout::timeout(5) do
+              EmailReplyParser.parse_reply(body)
+            end
+          rescue Timeout::Error => e
+            return nil
+          rescue StandardError => e  # Whackamole game with these parsing / encoding problems
+            return nil
+          end
+
+          # Force UTF-8 encoding
+          return parsed_body.encode("UTF-8", invalid: :replace, undef: :replace)
+        else
+          return nil
+        end
+      end
+    end
+  end
+end

data/lib/chronicle/email/mbox_extractor.rb

@@ -0,0 +1,41 @@
+require 'chronicle/etl'
+require 'mail'
+require 'tempfile'
+
+module Chronicle
+  module Email
+    class MboxExtractor < Chronicle::Etl::Extractor
+      # mbox format is a bunch of emails concatanated together, separated
+      # by a line that starts with "From "
+      NEW_EMAIL_REGEX = Regexp.new('^From [^\s]+ .{24}')
+
+      def results_count
+        file = File.open(@options[:filename])
+        count = 0
+        file.each do |line|
+          count += 1 if line =~ NEW_EMAIL_REGEX
+        end
+        return count
+      end
+
+      def extract
+        file = File.open(@options[:filename])
+        tmp = Tempfile.new('chronicile-mbox')
+
+        file.each do |line|
+          if line =~ NEW_EMAIL_REGEX
+            if File.size(tmp) > 0
+              tmp.rewind
+              email = tmp.read
+              yield email
+              tmp.truncate(0)
+              tmp.rewind
+            end
+          end
+          tmp.write(line)
+        end
+        file.close
+      end
+    end
+  end
+end

data/lib/chronicle/email/version.rb

@@ -0,0 +1,5 @@
+module Chronicle
+  module Email
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: chronicle-email
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Louis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronicle-etl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !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: email_reply_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Various email importers for chronicle-etl
+email:
+- andrew@hyfen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chronicle-email.gemspec
+- lib/chronicle/email.rb
+- lib/chronicle/email/chronicle_transformer.rb
+- lib/chronicle/email/mbox_extractor.rb
+- lib/chronicle/email/version.rb
+homepage: https://github.com/chronicle-app/chronicle-email
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chronicle-app/chronicle-email
+  source_code_uri: https://github.com/chronicle-app/chronicle-email
+  changelog_uri: https://github.com/chronicle-app/chronicle-email
+post_install_message:
+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.1.2
+signing_key:
+specification_version: 4
+summary: Email importer for Chronicle
+test_files: []