email-fetch-and-process 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd4238e5ce660f30d31bc897a198999950931fe26bdc70d0422bc352bf0f8bf6
+  data.tar.gz: d4f266e248827632948a51d044abad845b9c148d10c7d284bb693947e40d6def
+SHA512:
+  metadata.gz: 2ee4d00950c8672c0d89e0312212beb48c8207515a32d3905a935bd907874c726738507a9ca2f1079819317dc60319c6b2b84e0fcdc430f9e700d8afbf579057
+  data.tar.gz: a7ab8cbed33ea683f9acdf10776efda4256818e655c010c90bf766b707f966405b07d8ae354f8a7b4cf8edc8c33a6ca9dbd8b9474d3e408a481f9649f3c170b9

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.6
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Naming/FileName:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in email-fetch-and-process.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kirk Haines
+
+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,41 @@
+# EmailFetchAndProcess
+
+This little gem encapsulates some logic distilled and extracted from a bunch of different scripts used to access a mailbox, find an email, and get the file attachment from it.
+
+It is currently very focused and limited to that job and that job only, but with a little TLC it could become a more general email access/extract/process tool.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email-fetch-and-process'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email-fetch-and-process
+
+## Usage
+
+```
+require 'email-fetch-and-process'
+
+jobs = []
+jobs << EmailFetchAndProcess::Job.new({fetch: ['SUBJECT', 'Some subject line']})
+
+r = EmailFetchAndProcess.new({host: 'imap.gmail.com',port: 993, id: 'YOURID', password: 'YOURPASSWORD'})
+r.run(jobs)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wyhaines/email-fetch-and-process.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

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/email-fetch-and-process.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email-fetch-and-process/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'email-fetch-and-process'
+  spec.version       = EmailFetchAndProcess::VERSION
+  spec.authors       = ['Kirk Haines']
+  spec.email         = ['wyhaines@gmail.com']
+
+  spec.summary       = 'Simple utility gem for pulling emails and processing them.'
+  spec.description   = 'This is an extraction of a useful pattern for pulling emails and their attached files and processing them.'
+  spec.homepage      = 'https://github.com/wyhaines/email-fetch-and-process'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) 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_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/email-fetch-and-process.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'net/imap'
+require 'fileutils'
+require 'mail'
+require 'time'
+require 'email-fetch-and-process/version'
+
+# Wrap up the logic to iterate through a bunch of fetch and handle
+# jobs. This is the simplest thing that can work code. It could be
+# generalized a lot pretty easily.
+class EmailFetchAndProcess
+  # Class tp encapsulate a fetch and handle job.
+  class Job
+    def initialize(args = {})
+      @args = default_args.merge args
+    end
+
+    def default_args
+      {
+        fetch: ['SUBJECT', ''],
+        filename: '',
+        action: 'echo FILEPATH',
+        subdirectory: nil
+      }
+    end
+
+    def fetch
+      @args[:fetch]
+    end
+
+    def filename
+      @args[:filename]
+    end
+
+    def action
+      @args[:action]
+    end
+
+    def subdirectory
+      @args[:subdirectory]
+    end
+  end
+
+  attr_accessor :destination
+
+  def initialize(args = {})
+    @args = default_args.merge args
+    @destination = '/tmp'
+  end
+
+  def default_args
+    {
+      host: '127.0.0.1',
+      port: 993,
+      tls: true,
+      id: nil,
+      password: nil,
+      mailbox: 'INBOX'
+    }
+  end
+
+  def imap_connection
+    imap = Net::IMAP.new(@args[:host], {:port => @args[:port], :ssl => {:verify_mode => OpenSSL::SSL::VERIFY_NONE}})
+    imap.login(@args[:id], @args[:password])
+    imap.examine(@args[:mailbox])
+    imap
+  end
+
+  def handle_parts(parts, job, msg_ids)
+    parts.each do |part|
+      if !part.parts.empty?
+        handle_parts(part.parts, job, msg_ids)
+      else
+        begin
+          name = if job.filename.to_s.empty?
+                   part.header[:content_disposition].filename || part.filename rescue part.filename
+                 else
+                   job.filename
+                 end
+          name = Mail::Encodings.decode_encode(name, :decode) if name rescue name
+        rescue StandardError => e
+          puts e, e.backtrace.inspect
+          next
+        end
+        next unless name
+
+        @body_index += 1
+        attachment = part
+        attachment_path = File.expand_path(File.join(@destination, name))
+        attachment_path = nil unless attachment_path =~ /^#{@destination}/
+        next unless @destination != attachment_path
+
+        if attachment && attachment_path
+          file_path = File.join([@destination, job.subdirectory, name].compact)
+          atch = attachment.body.to_s
+          FileUtils.mkdir_p File.dirname(file_path) unless FileTest.exist? File.dirname(file_path)
+          File.open(file_path, 'wb+') do |fh|
+            fh.write atch.respond_to?(:each) ? atch.join : atch
+          end
+          sha_new = `/usr/bin/shasum "#{file_path}"`.split(/\s+/).first
+          sha_old = nil
+          FileTest.exist?("#{file_path}.sha") &&
+            File.open("#{file_path}.sha", 'r') { |fh| sha_old = fh.read.chomp }
+          if sha_new != sha_old
+            command_to_run = job.action.gsub(/FILEPATH/, file_path)
+            if system(command_to_run)
+              File.open("#{file_path}.sha","w+") {|fh| fh.write sha_new }
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def run(jobs = [])
+    @imap = imap_connection
+
+    jobs.each do |job|
+      msg_ids = @imap.search(job.fetch)
+      next if msg_ids.nil? || msg_ids.empty?
+      begin
+        msgs = @imap.fetch(msg_ids, %w[ENVELOPE RFC822])
+        msg = msgs.max_by { |m| Time.parse(m['attr']['ENVELOPE'].date) }.attr['RFC822']
+
+        @body_index = 1
+      rescue StandardError => err
+        puts "Error: #{err}\n#{err.backtrace.join("\n")}"
+        @imap = imap_connection
+        next
+      end
+      body = Mail.read_from_string msg
+      handle_parts(body.attachments, job, msg_ids) unless body.attachments.empty?
+    end
+
+    @imap.close
+  end
+end

data/lib/email-fetch-and-process/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class EmailFetchAndProcess
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: email-fetch-and-process
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirk Haines
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This is an extraction of a useful pattern for pulling emails and their
+  attached files and processing them.
+email:
+- wyhaines@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- email-fetch-and-process.gemspec
+- lib/email-fetch-and-process.rb
+- lib/email-fetch-and-process/version.rb
+homepage: https://github.com/wyhaines/email-fetch-and-process
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Simple utility gem for pulling emails and processing them.
+test_files: []