mailhandler 1.0.38 → 1.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa5320fb5d5625deccf6cdcf0376f5b7e2ec5adb
-  data.tar.gz: 46b58bc289f75deda7e8deb31e1baa9770fa4807
+SHA256:
+  metadata.gz: 7110dbb8ad938a31bdb9b4364e2cca1938aa1c9db573fc71acc00381946104a3
+  data.tar.gz: 60f583b519a3794cbca7c0efabc396808754557875c345d763d0fb28c9e182f7
 SHA512:
-  metadata.gz: 2b8b6c4594b2a8c797e70d647a92e34f18d261a1b6e35904d8058506d296300664f506e16bd40bf0f36e8923f3ab7af1bac9416b90a83120d7fff23593c3e47d
-  data.tar.gz: 63e2a18ba075c7203d8b92371646f67d14e67b53fcb2fccb35c07852dc6602f92b7abf6c84798ab20cd6b6ce3bb99b3f462e9661dcfd394c10b53bc842ef58f2
+  metadata.gz: 4a2af60b8ace6be532020704039cd57e38cc9a01af02fd0677936c96fc36fdc427c6836b958d91ad2786d0701880464702c563f8f44e032b4827b714193af6c7
+  data.tar.gz: 268ce1771328c25865e6c3059faf4411326f139170956a3be3a476330037ec712597fa5308390b93dc02769af047b0e339cccbfc8beaba0810b1d59cdfa4a5ef

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require: rubocop-rspec
+
+# increase line length since we are checking test files
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 120
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/NestedGroups:
+ Max: 7
+
+Metrics/BlockLength:
+  Max: 200
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10

data/Gemfile

@@ -5,3 +5,5 @@ gem 'mail'
 gem 'postmark'
 gem 'pry'
 gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/lib/mailhandler.rb

@@ -71,11 +71,9 @@ module MailHandler
     # @param [Receiving::Object] receiver
     # @param [Array<Receiving::Notification::Class>] notifications
     def add_receiving_notifications(receiver, notifications)
-      if (notifications - NOTIFICATION_TYPES.keys).empty?
+      return unless (notifications - NOTIFICATION_TYPES.keys).empty?
 
-        notifications.each { |n| receiver.add_observer(NOTIFICATION_TYPES[n].new) }
-
-      end
+      notifications.each { |n| receiver.add_observer(NOTIFICATION_TYPES[n].new) }
     end
 
     def verify_type(type, types)
@@ -83,25 +81,19 @@ module MailHandler
     end
 
     CHECKER_TYPES = {
-
       folder: Receiving::FolderChecker,
       imap: Receiving::IMAPChecker
-
     }.freeze
 
     SENDER_TYPES = {
-
       postmark_api: Sending::PostmarkAPISender,
       postmark_batch_api: Sending::PostmarkBatchAPISender,
       smtp: Sending::SMTPSender
-
     }.freeze
 
     NOTIFICATION_TYPES = {
-
       console: Receiving::Notification::Console,
       email: Receiving::Notification::Email
-
     }.freeze
   end
 end

data/lib/mailhandler/errors.rb

@@ -1,4 +1,5 @@
 module MailHandler
+  # base error
   class Error < StandardError
     def initialize(message = nil)
       super(message)

data/lib/mailhandler/receiver.rb

@@ -4,6 +4,7 @@ require_relative 'receiving/observer'
 require_relative 'receiving/mail.rb'
 
 module MailHandler
+  # handling receiving email
   class Receiver
     include Receiving::Observer
 
@@ -40,13 +41,9 @@ module MailHandler
       checker.start
 
       until search_time_expired?
+        break if single_search(options)
 
-        received = checker.find(options)
-        update_search_details
-        notify_observers(search)
-        break if received
         sleep search_frequency
-
       end
 
       notify_observers(search)
@@ -57,6 +54,13 @@ module MailHandler
 
     private
 
+    def single_search(options)
+      received = checker.find(options)
+      update_search_details
+      notify_observers(search)
+      received
+    end
+
     def init_search_details(options)
       @search = Search.new
       @search.options = options
@@ -68,8 +72,12 @@ module MailHandler
       search.finished_at = Time.now
       search.duration = search.finished_at - search.started_at
       search.result = checker.search_result
+      update_search_email_details
+    end
+
+    def update_search_email_details
       search.emails = checker.found_emails
-      search.email = search.emails.first
+      search.email = checker.found_emails.first
     end
 
     def search_time_expired?

data/lib/mailhandler/receiving/base.rb

@@ -33,10 +33,7 @@ module MailHandler
         @found_emails = []
       end
 
-      private
-
       AVAILABLE_SEARCH_OPTIONS = %i[
-
         by_subject
         by_content
         since
@@ -59,36 +56,45 @@ module MailHandler
       end
 
       def validate_option_values(options)
-        if options[:since]
-
-          raise MailHandler::Error, "Incorrect option options[:since]=#{options[:since]}." unless options[:since].is_a?(Time)
-
-        end
-
-        unless options[:count].nil?
+        validate_since_option(options)
+        validate_count_option(options)
+        validate_archive_option(options)
+        validate_recipient_option(options)
+      end
 
-          count = options[:count]
-          raise MailHandler::Error, "Incorrect option options[:count]=#{options[:count]}." if (count < 0) || (count > 2000)
+      def validate_recipient_option(options)
+        return if options[:by_recipient].nil?
 
-        end
+        error_message = "Incorrect option options[:by_recipient]=#{options[:by_recipient]}."
+        raise MailHandler::Error, error_message unless options[:by_recipient].is_a?(Hash)
+      end
 
-        if options[:archive]
+      def validate_archive_option(options)
+        return if options[:archive].nil?
 
-          raise MailHandler::Error, "Incorrect option options[:archive]=#{options[:archive]}." unless (options[:archive] == true) || (options[:archive] == false)
+        error_message = "Incorrect option options[:archive]=#{options[:archive]}."
+        raise MailHandler::Error, error_message unless [true, false].include?(options[:archive])
+      end
 
-        end
+      def validate_since_option(options)
+        return if options[:since].nil?
 
-        if options[:by_recipient]
+        error_message = "Incorrect option options[:since]=#{options[:since]}."
+        raise MailHandler::Error, error_message unless options[:since].is_a?(Time)
+      end
 
-          raise MailHandler::Error, "Incorrect option options[:by_recipient]=#{options[:by_recipient]}." unless options[:by_recipient].is_a?(Hash)
+      def validate_count_option(options)
+        return if options[:count].nil?
 
-        end
+        count = options[:count]
+        error_message = "Incorrect option options[:count]=#{options[:count]}."
+        raise MailHandler::Error, error_message if (count < 0) || (count > 2000)
       end
 
       def validate_used_options(options)
-        unless (options.keys - available_search_options).empty?
-          raise MailHandler::Error, "#{(options.keys - available_search_options)} - Incorrect search option values, options are #{available_search_options}."
-        end
+        error_message = "#{(options.keys - available_search_options)} - Incorrect search option values,"\
+                                    " options are #{available_search_options}."
+        raise MailHandler::Error, error_message unless (options.keys - available_search_options).empty?
       end
 
       def set_base_search_options

data/lib/mailhandler/receiving/filelist/base.rb

@@ -2,9 +2,10 @@ require 'fileutils'
 
 # Base filtering class, which is used for reading list of all files based on passed pattern.
 # Patterns to be used can be checked here: http://ruby-doc.org/core-1.9.3/Dir.html
-
 module MailHandler
+  # namespace
   module Receiving
+    # namespace
     module FileHandling
       # if file exists, execute file operation, otherwise return default return value when it doesn't
       def access_file(file, default_return = false)
@@ -14,6 +15,7 @@ module MailHandler
             yield
           rescue StandardError => e
             raise e if File.exist? file
+
             default_return
           end
 
@@ -25,6 +27,7 @@ module MailHandler
       end
     end
 
+    # base filelist
     class FileList
       include FileHandling
 
@@ -37,25 +40,33 @@ module MailHandler
         j = 0
 
         while swapped
-
           swapped = false
           j += 1
 
           (files.size - j).times do |i|
-            file1 = access_file(files[i], false) { File.new(files[i]).ctime }
-            file2 = access_file(files[i + 1], false) { File.new(files[i + 1]).ctime }
+            next unless swap_files?(files[i], files[i + 1])
 
-            next unless file1 && file2 && file1 < file2
             tmp = files[i]
             files[i] = files[i + 1]
             files[i + 1] = tmp
             swapped = true
           end
-
         end
 
         files
       end
+
+      private
+
+      def swap_files?(current_file, next_file)
+        file1 = get_file(current_file)
+        file2 = get_file(next_file)
+        file1 && file2 && file1 < file2
+      end
+
+      def get_file(file)
+        access_file(file, false) { File.new(file).ctime }
+      end
     end
   end
 end

data/lib/mailhandler/receiving/filelist/filter/base.rb

@@ -3,8 +3,11 @@ require_relative '../../../errors'
 
 module MailHandler
   module Receiving
+    # namespace
     class FileList
+      # namespace
       module Filter
+        # base filter for files
         class Base
           attr_accessor :files, :fast_check
 
@@ -36,7 +39,7 @@ module MailHandler
         end
 
         module ByDate
-
+          # filter files by date
           class BaseDate < Base
             def initialize(files, date)
               super(files)
@@ -44,19 +47,21 @@ module MailHandler
             end
           end
 
+          # since date filter
           class Since < BaseDate
             private
 
             def meets_expectation?(file)
-              File.exist?(file)? (File.ctime file) > @date : false
+              File.exist?(file) ? (File.ctime file) > @date : false
             end
           end
 
+          # before date filter
           class Before < Base
             private
 
             def meets_expectation?(file)
-              File.exist?(file)? (File.ctime file) < @date : false
+              File.exist?(file) ? (File.ctime file) < @date : false
             end
           end
         end

data/lib/mailhandler/receiving/filelist/filter/email.rb

@@ -33,6 +33,7 @@ module MailHandler
           end
         end
 
+        # filter by email content
         class ByEmailContent < Email
           def initialize(files, content)
             super(files)
@@ -60,6 +61,7 @@ module MailHandler
           end
         end
 
+        # filter by email subject
         class ByEmailSubject < ByEmailContent
           private
 
@@ -72,6 +74,7 @@ module MailHandler
           end
         end
 
+        # filter by email recipient
         class ByEmailRecipient < Email
           def initialize(files, recipient)
             super(files)

data/lib/mailhandler/receiving/folder.rb

@@ -7,6 +7,7 @@ require_relative 'filelist/filter/email.rb'
 
 module MailHandler
   module Receiving
+    # folder checking base class
     class FolderChecker < Checker
       include FileHandling
 
@@ -76,7 +77,7 @@ module MailHandler
       end
 
       def move_files(files)
-        files.each { |file| (inbox_folder == archive_folder) ? delete_file(file) : archive_file(file) }
+        files.each { |file| inbox_folder == archive_folder ? delete_file(file) : archive_file(file) }
       end
 
       def parse_email_from_files(files, count)
@@ -94,7 +95,10 @@ module MailHandler
       end
 
       def archive_file(file)
-        access_file(file) { FileUtils.mv("#{inbox_folder}/#{File.basename(file)}", "#{archive_folder}/#{File.basename(file)}") }
+        access_file(file) do
+          FileUtils.mv("#{inbox_folder}/#{File.basename(file)}",
+                       "#{archive_folder}/#{File.basename(file)}")
+        end
       end
 
       def delete_file(file)
@@ -103,7 +107,8 @@ module MailHandler
 
       def verify_mailbox_folders
         raise MailHandler::Error, 'Folder variables are not set.' if inbox_folder.nil? || archive_folder.nil?
-        raise MailHandler::FileError, 'Mailbox folders do not exist.' unless File.directory?(inbox_folder) && File.directory?(archive_folder)
+        raise MailHandler::FileError, 'Mailbox folders do not exist.' unless File.directory?(inbox_folder) &&
+                                                                             File.directory?(archive_folder)
       end
     end
   end

data/lib/mailhandler/receiving/imap.rb

@@ -4,6 +4,7 @@ require_relative '../errors'
 
 module MailHandler
   module Receiving
+    # in charge of retrieving email by IMAP
     class IMAPChecker < Checker
       attr_accessor :address,
                     :port,
@@ -30,14 +31,16 @@ module MailHandler
       end
 
       def start
-        unless manual_connection_manage
-          init_retriever
-          connect
-        end
+        return if manual_connection_manage
+
+        init_retriever
+        connect
       end
 
       def stop
-        disconnect unless manual_connection_manage
+        return if manual_connection_manage
+
+        disconnect
       end
 
       def connect
@@ -45,21 +48,21 @@ module MailHandler
       end
 
       def disconnect
-        mailer.disconnect unless mailer.imap_connection.disconnected?
+        return if mailer.imap_connection.disconnected?
+
+        mailer.disconnect
       end
 
       # delegate retrieval details to Mail library
+      # set imap settings if they are not set
       def init_retriever
-        # set imap settings if they are not set
-        unless retriever_set?
-
-          imap_settings = retriever_settings
+        return if retriever_set?
 
-          Mail.defaults do
-            retriever_method :imap,
-                             imap_settings
-          end
+        imap_settings = retriever_settings
 
+        Mail.defaults do
+          retriever_method :imap,
+                           imap_settings
         end
       end
 
@@ -81,7 +84,6 @@ module MailHandler
       # archive - Boolean
       # by_recipient - Hash, accepts a hash like: :to => 'igor@example.com'
       AVAILABLE_SEARCH_OPTIONS = %i[
-
         by_subject
         by_content
         since
@@ -100,10 +102,8 @@ module MailHandler
 
       def retriever_settings
         {
-          address: address,
-          port: port,
-          user_name: username,
-          password: password,
+          address: address, port: port,
+          user_name: username, password: password,
           authentication: authentication,
           enable_ssl: use_ssl
         }
@@ -114,58 +114,60 @@ module MailHandler
       end
 
       def imap_search(retry_count, options)
-        result = mailer.find_emails(what: :last, count: search_options[:count], order: :desc, keys: imap_filter_keys(options), delete_after_find: options[:archive])
-        result.is_a?(Array)? result : [result]
+        result = mailer.find_emails(what: :last,
+                                    count: search_options[:count],
+                                    order: :desc,
+                                    keys: imap_filter_keys(options),
+                                    delete_after_find: options[:archive])
+        result.is_a?(Array) ? result : [result]
 
       # Silently ignore IMAP search errors, [RETRY_ON_ERROR_COUNT] times
       rescue Net::IMAP::ResponseError, EOFError, NoMethodError => e
-        if (retry_count -= 1) >= 0
-
-          puts e
+        if (retry_count -= 1) >= 0 # rubocop:disable all
           reconnect
           retry
-
         else
-
           raise e
-
         end
       end
 
       def imap_filter_keys(options)
         keys = []
+        options.each { |key, value| keys += retrieve_filter_setting(key, value) }
+        keys.empty? ? nil : keys
+      end
 
-        options.keys.each do |filter_option|
-          case filter_option
-
-          when :by_recipient
-
-            keys << options[:by_recipient].keys.first.to_s.upcase << options[:by_recipient].values.first
-
-          when :by_subject
-
-            keys << 'SUBJECT' << options[:by_subject].to_s
-
-          when :by_content
-
-            keys << 'BODY' << options[:by_content].to_s
-
-          when :since
+      def retrieve_filter_setting(key, value)
+        case key
+        when :by_recipient
+          imap_recipient_search_pair(value)
 
-            keys << 'SINCE' << Net::IMAP.format_date(options[:since])
+        when :by_subject
+          imap_string_search_pair('SUBJECT', value)
 
-          when :before
+        when :by_content
+          imap_string_search_pair('BODY', value)
 
-            keys << 'BEFORE' << Net::IMAP.format_date(options[:before])
+        when :since
+          imap_date_search_pair('SINCE', value)
 
-          else
+        when :before
+          imap_date_search_pair('BEFORE', value)
+        else
+          []
+        end
+      end
 
-            # do nothing
+      def imap_recipient_search_pair(value)
+        [value.keys.first.to_s.upcase, value.values.first]
+      end
 
-          end
-        end
+      def imap_string_search_pair(name, value)
+        [name, value.to_s]
+      end
 
-        keys.empty? ? nil : keys
+      def imap_date_search_pair(name, value)
+        [name, Net::IMAP.format_date(value)]
       end
     end
   end