actionmailbox-imap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cce84e603505d4bdcb54d4935e5378acd69e3c0426dad9cbf3d3195801260862
+  data.tar.gz: f9a75e4fe6651894c49c3784f8a068ad015b3d54c1621bb33cbeb3887e03c1c4
+SHA512:
+  metadata.gz: e7d9ab1a7b2c4b8a16ffe2c0fd97f5b85885ad607160985ea77db290f1aa095db72ea64d81ff59d68e9271a58adc6fe7edced957aa6eba5ad0514017ceb3773f
+  data.tar.gz: 8fa950ea432d4ec17a5f32b3e0ac253dd16a7bae2d8ab34bcbb2b0c5fcbc7e6b7c1014eec4f0248bd5f0d32bf023a71dfacfd23a8d410c4ff4e94811bf489338

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Ethan Knowlton
+
+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,82 @@
+# Actionmailbox::IMAP
+[![CircleCI](https://circleci.com/gh/kimmelsg/actionmailbox-imap.svg?style=svg)](https://circleci.com/gh/kimmelsg/actionmailbox-imap)
+
+A IMAP relay for ActionMailbox.
+
+This is a very simple gem that provides a rake task which will connect to an IMAP server, grab some (`take`) emails, attempt to relay them to ActionMailbox.
+
+If the rake task successfully relays a message to ActionMailbox then it will flag the message as "Deleted" on the IMAP server, and continue to the next message.
+
+If the rake task fails to relay a message to ActionMailbox then it will ignore it and move on to the next message leaving the message on the IMAP server.
+
+### Why it was created
+
+It seems that there is no plans to create some sort of IMAP implementation relay in ActionMailbox. 
+https://github.com/rails/actionmailbox/issues/14
+
+There is probably a reason for this. We did not want to setup or maintain a mailserver which would probably be the route to go for a robust inboud email application.
+
+## Usage
+
+### Install ActionMailbox
+
+Per [ActionMailbox documentation](https://edgeguides.rubyonrails.org/action_mailbox_basics.html)
+
+```bash
+$ rails action_mailbox:install
+$ rails db:migrate
+```
+
+```ruby
+# config/environments/production.rb
+config.action_mailbox.ingress = :relay
+```
+
+```bash
+$ rails credentials:edit
+```
+
+```yaml
+action_mailbox:
+    ingress_password: "YourIngressPassword"
+```
+
+
+### Install ActionMailbox::IMAP
+
+```bash
+$ rails g imap:install
+```
+
+Prepare your IMAP server and account by ensuring/creating the mailboxes for `ingress_mailbox`, ex: "INBOX".
+
+Update the `config/imap.yml` that was generated to include server and credentials information, `ingress_mailbox` and an appropriate `take` amount ( the amount of emails to grab in a single run ).
+
+Run or schedule `rails action_mailbox:ingress:imap URL="http://localhost/rails/action_mailbox/inbound_email" INGRESS_PASSWORD="YourIngressPassword"` to run at a selected interval. 
+
+The command behaves much like that of the other `action_mailbox:ingress:...` commands in that it relays the message the same way. Although messages should be piped to the other ingress commands and `rails action_mailbox:ingress:imap ...` needs to be scheduled appropriately.
+
+## Installation
+Add this line to your application's Gemfile:
+( Gem is not published to rubygems.org currently, you can point to this github url though )
+
+```ruby
+gem 'actionmailbox-imap'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install actionmailbox-imap
+```
+
+## Contributing
+
+Want to contribute? Please do. PR's and passing tests (lint, test) will be required.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Actionmailbox::Imap'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/actionmailbox/imap.rb

@@ -0,0 +1,29 @@
+require "actionmailbox/imap/railtie"
+require "actionmailbox/imap/mailbox"
+
+module ActionMailbox
+  module IMAP
+    class Base
+      def initialize(adapter:)
+        @adapter = adapter
+      end
+
+      def login(username:, password:)
+        adapter.login(username: username, password: password)
+      end
+
+      def select_mailbox(mailbox)
+        adapter.select_mailbox(mailbox)
+        Mailbox.new(adapter: adapter, mailbox: mailbox)
+      end
+
+      def disconnect
+        adapter.disconnect
+      end
+
+      private
+
+      attr_reader :adapter
+    end
+  end
+end

data/lib/actionmailbox/imap/adapters/net_imap.rb

@@ -0,0 +1,47 @@
+require "net/imap"
+
+module ActionMailbox
+  module IMAP
+    module Adapters
+      class NetImap
+        def initialize(server:, port: 993, usessl: true)
+          @imap = Net::IMAP.new(server, port, usessl)
+        end
+
+        def login(username:, password:)
+          imap.login(username, password)
+        end
+
+        def select_mailbox(mailbox)
+          imap.select(mailbox)
+        end
+
+        def disconnect
+          imap.expunge
+          imap.disconnect
+        end
+
+        def messages_not_deleted
+          imap.search(["NOT", "DELETED"])
+        end
+
+        def delete_message(id)
+          move_message_to(id, "TRASH")
+        end
+
+        def move_message_to(id, mailbox)
+          imap.copy(id, mailbox)
+          imap.store(id, "+FLAGS", [:Deleted])
+        end
+
+        def fetch_message_attr(id, attr)
+          imap.fetch(id, attr).first.attr[attr]
+        end
+
+        private
+
+        attr_reader :imap
+      end
+    end
+  end
+end

data/lib/actionmailbox/imap/mailbox.rb

@@ -0,0 +1,21 @@
+require "actionmailbox/imap/messages"
+
+module ActionMailbox
+  module IMAP
+    class Mailbox
+      def initialize(adapter:, mailbox:)
+        @adapter = adapter
+        @mailbox = mailbox
+      end
+
+      def not_deleted
+        result = adapter.messages_not_deleted
+        Messages.new(adapter: adapter, message_ids: result)
+      end
+
+      private
+
+      attr_reader :adapter, :mailbox
+    end
+  end
+end

data/lib/actionmailbox/imap/message.rb

@@ -0,0 +1,28 @@
+module ActionMailbox
+  module IMAP
+    class Message
+      RFC822 = "RFC822".freeze
+
+      def initialize(adapter:, id:)
+        @adapter = adapter
+        @id = id
+      end
+
+      def rfc822
+        adapter.fetch_message_attr(id, RFC822)
+      end
+
+      def delete
+        adapter.delete_message(id)
+      end
+
+      def move_to(mailbox)
+        adapter.move_message_to(id, mailbox)
+      end
+
+      private
+
+      attr_reader :adapter, :id
+    end
+  end
+end

data/lib/actionmailbox/imap/messages.rb

@@ -0,0 +1,33 @@
+require "actionmailbox/imap/message"
+
+module ActionMailbox
+  module IMAP
+    class Messages
+      def initialize(adapter:, message_ids:)
+        @adapter = adapter
+        @message_ids = message_ids
+      end
+
+      def take(n)
+        taken_ids = message_ids.take(n)
+        Messages.new(adapter: adapter, message_ids: taken_ids)
+      end
+
+      def length
+        message_ids.length
+      end
+
+      def each
+        return unless block_given? # @TODO Need to test this branch
+
+        message_ids.each do |id|
+          yield Message.new(adapter: adapter, id: id)
+        end
+      end
+
+      private
+
+      attr_reader :adapter, :message_ids
+    end
+  end
+end

data/lib/actionmailbox/imap/railtie.rb

@@ -0,0 +1,10 @@
+module Actionmailbox
+  module Imap
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        path = File.expand_path("../tasks/actionmailbox/ingress.rake", File.dirname(__dir__))
+        load path
+      end
+    end
+  end
+end

data/lib/actionmailbox/imap/version.rb

@@ -0,0 +1,5 @@
+module Actionmailbox
+  module Imap
+    VERSION = "0.1.0"
+  end
+end

data/lib/generators/imap/install_generator.rb

@@ -0,0 +1,7 @@
+class Imap::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_imap_config_file
+    copy_file "config.yml", "config/actionmailbox_imap.yml"
+  end
+end

data/lib/generators/imap/templates/config.yml

@@ -0,0 +1,14 @@
+default: &default
+  server: <%= ENV.fetch("IMAP_SERVER") { "" } %>
+  port: <%= ENV.fetch("IMAP_PORT") { 993 } %>
+  usessl: <%= ENV.fetch("IMAP_USE_SSL") { true } %>
+  username: <%= ENV.fetch("IMAP_ACCOUNT_USERNAME") { "" } %>
+  password: <%= ENV.fetch("IMAP_ACCOUNT_PASSWORD") { "" } %>
+  ingress_mailbox: "INBOX"
+  take: <%= ENV.fetch("IMAP_TAKE") { 100 } %>
+
+development:
+  <<: *default
+
+production:
+  <<: *default

data/lib/tasks/actionmailbox/ingress.rake

@@ -0,0 +1,39 @@
+require "actionmailbox/imap/adapters/net_imap"
+
+namespace :action_mailbox do
+  namespace :ingress do
+    task :environment do
+      require "active_support"
+      require "active_support/core_ext/object/blank"
+      require "action_mailbox/relayer"
+    end
+
+    desc "Relays inbound IMAP email to Action Mailbox (URL and INGRESS_PASSWORD required)"
+    task imap: "action_mailbox:ingress:environment" do
+      url, password = ENV.values_at("URL", "INGRESS_PASSWORD")
+
+      config = Rails.application.config_for(:actionmailbox_imap)
+
+      adapter = ActionMailbox::IMAP::Adapters::NetImap.new(
+        server: config[:server],
+        port: config[:port],
+        usessl: config[:usessl]
+      )
+
+      imap = ActionMailbox::IMAP::Base.new(adapter: adapter)
+
+      imap.login(username: config[:username], password: config[:password])
+
+      mailbox = imap.select_mailbox(config[:ingress_mailbox])
+
+      mailbox.not_deleted.take(config[:take]).each do |message|
+        ActionMailbox::Relayer.new(url: url, password: password).relay(message.rfc822).tap do |result|
+          message.delete if result.success?
+          message.move_to(config[:retry_mailbox]) unless result.success?
+        end
+      end
+
+      imap.disconnect
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: actionmailbox-imap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ethan Knowlton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: minitest-stub-const
+  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: standard
+  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: Relay IMAP messages to ActionMailbox
+email:
+- eknowlton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/actionmailbox/imap.rb
+- lib/actionmailbox/imap/adapters/net_imap.rb
+- lib/actionmailbox/imap/mailbox.rb
+- lib/actionmailbox/imap/message.rb
+- lib/actionmailbox/imap/messages.rb
+- lib/actionmailbox/imap/railtie.rb
+- lib/actionmailbox/imap/version.rb
+- lib/generators/imap/install_generator.rb
+- lib/generators/imap/templates/config.yml
+- lib/tasks/actionmailbox/ingress.rake
+homepage: https://github.com/kimmelsg
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Relay IMAP messages to ActionMailbox
+test_files: []