actionmailbox-imap 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf597bbca58917880d28d6b9ea482e0c67d0dc1aba28c3ce643f297e5c0860df
-  data.tar.gz: be76ffc403639b411d67d18e651b7933633c95e0abe5be55cfbf365e84bc369f
+  metadata.gz: 376f10979ea6f2c65fccb83629829919116f6022940af536622fb4873d1745d2
+  data.tar.gz: 12b8fa355b3dab2f0a1f5d3aafc6f1dbf2ebf9cdf653e85dc74e8925c97e7a94
 SHA512:
-  metadata.gz: b501f7a5e650d176d287c773115f11cebcaf639a54dfd81ce781350c9fbedfd89134fbf0011764dd7efc500bc0d6947faf0724be58a4d78bb2269ef0ce66e0dd
-  data.tar.gz: d8c7e4a75a3b89fac41c5a426aaf8f3b1b34cc06369be9657bbeaaea275fc11947a7376f34c47fc89d296b69d35af05f957263670b0d593d34b565e8e7d88d19
+  metadata.gz: 8b5e9f33726a4607eaf3b2eb848004b8e9f237900a952e3240bebb5f5ecedfb941b3e0ae9a57e67b510e2d9fd25ccb0deaeece0c87963fe415f6202dcfccd04a
+  data.tar.gz: c4d1d058b1a1277e2c35d32d33fe1ada479f8e4bd4887bb97f62581c3049802f744543f0e3a58ff647f62ac40ee9f8209d3c4912190d70f6814a8d34f67993f8

data/README.md

@@ -1,19 +1,18 @@
 # ActionMailbox::IMAP
-[![CircleCI](https://circleci.com/gh/kimmelsg/actionmailbox-imap.svg?style=svg)](https://circleci.com/gh/kimmelsg/actionmailbox-imap) 
-[![RubyGems](https://badge.fury.io/rb/actionmailbox-imap.svg)](https://rubygems.org/gems/actionmailbox-imap) 
+[![CircleCI](https://circleci.com/gh/kimmelsg/actionmailbox-imap.svg?style=svg)](https://circleci.com/gh/kimmelsg/actionmailbox-imap)
+[![RubyGems](https://badge.fury.io/rb/actionmailbox-imap.svg)](https://rubygems.org/gems/actionmailbox-imap)
 [![Standard](https://camo.githubusercontent.com/58fbab8bb63d069c1e4fb3fa37c2899c38ffcd18/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d7374616e646172642d627269676874677265656e2e737667)](https://github.com/testdouble/standard)
 
 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.
+This is a very simple gem that provides a rake task attempt to relay messsages to ActionMailbox from the [ActionMailbox::IMAP Client](https://github.com/kimmelsg/actionmailbox-imap/blob/master/CLIENT.md).
 
-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.
+If a message is successuflly relayed to ActionMailbox, then the message will be marked deleted.
+If a message is not successfully relayed to ActionMailbox, then the message will be marked Unread in order to be processed again later.
 
 ### Why it was created
 
-It seems that there is no plans to create some sort of IMAP implementation relay in ActionMailbox. 
+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 inbound email application.
@@ -52,11 +51,13 @@ $ 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 ).
+Update the `config/imap.yml` that was generated to include server and credentials information, `mailbox`. Currently SSL is required.
+
+Run the [ActionMailbox::IMAP Client](https://github.com/kimmelsg/actionmailbox-imap/blob/master/CLIENT.md) like so `URL=... INGRESS_PASSWORD=... ./actionmailbox-imap` to begin processing emails.
 
-Run or schedule `rails action_mailbox:ingress:imap URL="http://localhost/rails/action_mailbox/relay/inbound_email" INGRESS_PASSWORD="YourIngressPassword"` to run at a selected interval. 
+### Rake Task
 
-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.
+The rake task 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:

data/config/actionmailbox_imap.yaml

@@ -0,0 +1,6 @@
+server: "smtp.testing.com"
+port: 993
+tls: true
+username: "test@test.com"
+password: "test"
+mailbox: "INBOX"

data/lib/actionmailbox/imap.rb

@@ -1,29 +1,8 @@
 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 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/version.rb

@@ -1,5 +1,5 @@
 module Actionmailbox
   module Imap
-    VERSION = "0.1.2"
+    VERSION = "0.2.1"
   end
 end

data/lib/generators/imap/install_generator.rb

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

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

@@ -1,14 +1,6 @@
-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
+server: "imap.domain.com"
+port: 993
+tls: true
+username: "username"
+password: "password"
+mailbox: "INBOX"

data/lib/tasks/actionmailbox/ingress.rake

@@ -1,5 +1,3 @@
-require "actionmailbox/imap/adapters/net_imap"
-
 namespace :action_mailbox do
   namespace :ingress do
     task :environment do
@@ -12,34 +10,22 @@ namespace :action_mailbox do
     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.mailbox(config[:ingress_mailbox])
-
-      relayer = ActionMailbox::Relayer.new(url: url, password: password)
-
-      messages = mailbox.messages.take(config[:take])
+      if url.blank? || password.blank?
+        print "URL and INGRESS_PASSWORD are required"
+        exit 64 # EX_USAGE
+      end
 
-      messages.mark_read
+      ActionMailbox::Relayer.new(url: url, password: password).relay(STDIN.read).tap do |result|
+        print result.message
 
-      messages.each do |message|
-        relayer.relay(message.rfc822).tap do |result|
-          message.delete if result.success?
-          message.mark_unread unless result.success?
+        if result.success?
+          exit 0
+        elsif result.transient_failure?
+          exit 75 # EX_TEMPFAIL
+        else
+          exit 69 # EX_UNAVAILABLE
         end
       end
-
-      imap.disconnect
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionmailbox-imap
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Ethan Knowlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2019-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Relay IMAP messages to ActionMailbox
+description: Relay IMAP messages to ActionMailbox. This package requires the rust
+  imap client binary to be run. Visit the repository ReadMe for more information.
 email:
 - eknowlton@gmail.com
 executables: []
@@ -76,11 +77,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- config/actionmailbox_imap.yaml
 - 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
@@ -106,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Relay IMAP messages to ActionMailbox

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

@@ -1,50 +0,0 @@
-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
-          imap.search(["NOT", "DELETED", "NOT", "SEEN"])
-        end
-
-        def delete_message(id)
-          imap.store(id, "+FLAGS", [:Deleted])
-        end
-
-        def mark_message_seen(id)
-          imap.store(id, "+FLAGS", [:Seen])
-        end
-
-        def mark_message_unseen(id)
-          imap.store(id, "-FLAGS", [:Seen])
-        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

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

data/lib/actionmailbox/imap/message.rb

@@ -1,32 +0,0 @@
-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 mark_read
-        adapter.mark_message_seen(id)
-      end
-
-      def mark_unread
-        adapter.mark_message_unseen(id)
-      end
-
-      private
-
-      attr_reader :adapter, :id
-    end
-  end
-end

data/lib/actionmailbox/imap/messages.rb

@@ -1,45 +0,0 @@
-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
-
-      def mark_read
-        message_ids.each do |id|
-          adapter.mark_message_seen(id)
-        end
-      end
-
-      def mark_unread
-        message_ids.each do |id|
-          adapter.mark_message_unseen(id)
-        end
-      end
-
-      private
-
-      attr_reader :adapter, :message_ids
-    end
-  end
-end