mailhandler 1.0.38 → 1.0.39

data/lib/mailhandler/receiving/mail.rb

@@ -1,8 +1,9 @@
 module Mail
+  # IMAP class patch to better manage connection and search of emails
   class IMAP
     attr_accessor :imap_connection
 
-    def find_emails(options = {}, &block)
+    def find_emails(options = {}, &block) # rubocop:disable all
       options = validate_options(options)
       options[:read_only] ? imap_connection.examine(options[:mailbox]) : imap_connection.select(options[:mailbox])
       uids = imap_connection.uid_search(options[:keys])
@@ -13,7 +14,6 @@ module Mail
                        (options[:what].to_sym != :last && options[:order].to_sym == :desc)
 
       if block_given?
-
         uids.each do |uid|
           uid = options[:uid].to_i unless options[:uid].nil?
           fetchdata = imap_connection.uid_fetch(uid, ['RFC822'])[0]
@@ -26,14 +26,12 @@ module Mail
             yield new_message
           end
 
-          imap_connection.uid_store(uid, '+FLAGS', [Net::IMAP::DELETED]) if options[:delete_after_find] && new_message.is_marked_for_delete?
+          imap_connection.uid_store(uid, '+FLAGS', [Net::IMAP::DELETED]) if options[:delete_after_find] &&
+                                                                            new_message.is_marked_for_delete?
           break unless options[:uid].nil?
         end
-
         imap_connection.expunge if options[:delete_after_find]
-
       else
-
         emails = []
 
         uids.each do |uid|
@@ -46,12 +44,11 @@ module Mail
 
         imap_connection.expunge if options[:delete_after_find]
         emails.size == 1 && options[:count] == 1 ? emails.first : emails
-
       end
     end
 
     # Start an IMAP session
-    def connect(_config = Mail::Configuration.instance)
+    def connect(_config = Mail::Configuration.instance) # rubocop:disable all
       @imap_connection = Net::IMAP.new(settings[:address], settings[:port], settings[:enable_ssl], nil, false)
 
       if settings[:authentication].nil?
@@ -64,11 +61,7 @@ module Mail
     end
 
     def disconnect
-      if defined?(imap_connection) && imap_connection && !imap_connection.disconnected?
-
-        imap_connection.disconnect
-
-      end
+      imap_connection.disconnect if defined?(imap_connection) && imap_connection && !imap_connection.disconnected?
     end
   end
 end

data/lib/mailhandler/receiving/notification/console.rb

@@ -1,6 +1,7 @@
 module MailHandler
   module Receiving
     module Notification
+      # notification in form of console output
       class Console
         def notify(search)
           output_delay Time.now - search.started_at
@@ -15,7 +16,7 @@ module MailHandler
         # print to screen delay length
         def output_delay(delay)
           delay_seconds = delay.to_i
-          output(delay_seconds) if [0, 1].include? (delay_seconds % Seconds::TO_SHOW)
+          output(delay_seconds) if [0, 1].include?(delay_seconds % Seconds::TO_SHOW)
         end
 
         # print to screen delay length

data/lib/mailhandler/receiving/notification/email.rb

@@ -5,6 +5,7 @@ require_relative '../../errors'
 module MailHandler
   module Receiving
     module Notification
+      # notification in form of sent email
       class Email
         attr_accessor :sender,
                       :from,
@@ -21,7 +22,7 @@ module MailHandler
           @from = from
           @contacts = to
           init_state
-          set_content_handler(EmailContent.new)
+          change_content_handler(EmailContent.new)
         end
 
         def notify(search)
@@ -30,7 +31,7 @@ module MailHandler
           @current_state.notify(search)
         end
 
-        def set_state(state)
+        def change_state(state)
           @current_state = state
         end
 
@@ -42,7 +43,7 @@ module MailHandler
 
         # Allow users to specify their own content classes.
         # Class must match by methods to the interface of MailHandler::Receiving::Notification::EmailContent
-        def set_content_handler(content_handler)
+        def change_content_handler(content_handler)
           @content_handler = content_handler
         end
 
@@ -55,7 +56,9 @@ module MailHandler
         EMAIL_TYPES = %i[delayed received].freeze
 
         def verify_email_type(type)
-          raise MailHandler::TypeError, "Incorrect type: #{type}, allowed types: #{EMAIL_TYPES}." unless EMAIL_TYPES.include? type
+          return if EMAIL_TYPES.include?(type)
+
+          raise MailHandler::TypeError, "Incorrect type: #{type}, allowed types: #{EMAIL_TYPES}."
         end
       end
     end

data/lib/mailhandler/receiving/notification/email/content.rb

@@ -3,6 +3,7 @@ require 'mail'
 module MailHandler
   module Receiving
     module Notification
+      # email notification sent
       class EmailContent
         # @param [Symbol] type - notification type
         # @param [Hash] options - search options used for searching for an email
@@ -16,19 +17,15 @@ module MailHandler
           delay = (delay.to_f / 60).round(2)
 
           case type
-
           when :received
-
             mail.subject = "Received - delay was #{delay} minutes"
             mail.body = "Received - delay was #{delay} minutes - search by #{options}"
 
           when :delayed
-
             mail.subject = "Over #{delay} minutes delay"
             mail.body = "Over #{delay} minutes delay - search by #{options}"
 
           else
-
             raise StandardError, "Incorrect type: #{type}"
 
           end

data/lib/mailhandler/receiving/notification/email/states.rb

@@ -4,6 +4,7 @@ require_relative '../../../errors'
 module MailHandler
   module Receiving
     module Notification
+      # base state
       class DelayState
         attr_accessor :context,
                       :notified
@@ -23,52 +24,54 @@ module MailHandler
         protected
 
         def send_notification_email(type, search)
-          unless notified
+          return if notified
 
-            context.send_email(type, search)
-            notification_fired
+          context.send_email(type, search)
+          notification_fired
+        end
 
-          end
+        def change_notification_state(search, state)
+          context.change_state(state)
+          context.notify(search)
         end
       end
 
+      # there was no delay
       class NoDelay < DelayState
         def notify(search)
-          if Time.now - search.started_at >= context.min_time_to_notify
+          return unless Time.now - search.started_at >= context.min_time_to_notify
 
-            context.set_state(Delay.new(context))
-            context.notify(search)
-
-          end
+          change_notification_state(search, Delay.new(context))
         end
       end
 
+      # delay happened
       class Delay < DelayState
         def notify(search)
           if search.result
-
-            context.set_state(Received.new(context))
-            context.notify(search)
-
-          elsif Time.now - search.started_at >= context.max_time_to_notify
-
-            context.set_state(MaxDelay.new(context))
-            context.notify(search)
-
+            change_notification_state(search, Received.new(context))
+          elsif max_time_to_notify?(search)
+            change_notification_state(search, MaxDelay.new(context))
           else
-
             send_notification_email(:delayed, search)
-
           end
         end
+
+        private
+
+        def max_time_to_notify?(search)
+          Time.now - search.started_at >= context.max_time_to_notify
+        end
       end
 
+      # maximum delay checked happened
       class MaxDelay < DelayState
         def notify(search)
           send_notification_email(:delayed, search)
         end
       end
 
+      # no more delays will be fired
       class Received < DelayState
         def notify(search)
           send_notification_email(:received, search)

data/lib/mailhandler/receiving/observer.rb

@@ -1,11 +1,12 @@
 module MailHandler
   module Receiving
+    # observer handler
     module Observer
       def init_observer
         @observers = []
       end
 
-      def get_observers()
+      def observers
         @observers
       end
 

data/lib/mailhandler/sender.rb

@@ -2,8 +2,8 @@ require_relative 'sending/smtp'
 require_relative 'sending/api'
 require_relative 'sending/api_batch'
 
-# Class for sending email, and storing details about the sending.
 module MailHandler
+  # Class for sending email, and storing details about the sending.
   class Sender
     attr_accessor :dispatcher,
                   :sending

data/lib/mailhandler/sending/api.rb

@@ -4,6 +4,7 @@ require_relative 'base.rb'
 
 module MailHandler
   module Sending
+    # sending email by Postmark API
     class PostmarkAPISender < Sender
       attr_accessor :host,
                     :api_token,
@@ -35,11 +36,10 @@ module MailHandler
       def setup_sending_client
         # clearing cache so valid host is accepted, and not the cached one
         Postmark::HttpClient.instance_variable_set('@http', nil)
-        Postmark::ApiClient.new(api_token, http_open_timeout: http_open_timeout, http_read_timeout: http_read_timeout, host: host, secure: @use_ssl)
+        Postmark::ApiClient.new(api_token, http_open_timeout: http_open_timeout, http_read_timeout: http_read_timeout,
+                                           host: host, secure: @use_ssl)
       end
 
-      protected
-
       DEFAULT_HOST = 'api.postmarkapp.com'.freeze
     end
   end

data/lib/mailhandler/sending/api_batch.rb

@@ -3,6 +3,7 @@ require_relative '../errors'
 
 module MailHandler
   module Sending
+    # sending batch email by Postmark API
     class PostmarkBatchAPISender < PostmarkAPISender
       def initialize(api_token = nil)
         super(api_token)
@@ -17,7 +18,9 @@ module MailHandler
       protected
 
       def verify_email(emails)
-        raise MailHandler::TypeError, 'Invalid type error, only Array of Mail::Message object types for sending allowed' unless emails.is_a?(Array) && emails.all? { |e| e.is_a? allowed_email_type }
+        return if emails.is_a?(Array) && emails.all? { |e| e.is_a? allowed_email_type }
+
+        raise MailHandler::TypeError, 'Invalid type error, only Array of Mail::Message object types for sending allowed'
       end
     end
   end

data/lib/mailhandler/sending/base.rb

@@ -2,6 +2,7 @@ require_relative '../errors'
 
 module MailHandler
   module Sending
+    # email sending handler class
     class Sender
       attr_reader :type
 
@@ -12,7 +13,9 @@ module MailHandler
       protected
 
       def verify_email(email)
-        raise MailHandler::TypeError, "Invalid type error, only #{allowed_email_type} object type for sending allowed." unless email.is_a?(allowed_email_type)
+        return if email.is_a?(allowed_email_type)
+
+        raise MailHandler::TypeError, "Invalid type error, only #{allowed_email_type} object type for sending allowed."
       end
 
       private

data/lib/mailhandler/sending/smtp.rb

@@ -1,4 +1,3 @@
-
 require 'net/imap'
 require_relative 'base'
 

data/lib/mailhandler/version.rb

@@ -1,3 +1,3 @@
 module MailHandler
-  VERSION = '1.0.38'.freeze
+  VERSION = '1.0.39'.freeze
 end

data/mailhandler.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mailhandler/version'
@@ -13,7 +12,7 @@ Gem::Specification.new do |s|
   s.email       = ['ibalosh@gmail.com', 'igor@wildbit.com']
 
   s.summary     = 'Postmark email receiving and sending handler.'
-  s.description = 'Use this gem to send emails through SMTP and Postmark API. Check if email arrived by imap or folder check.'
+  s.description = 'Use this gem to send emails through SMTP and Postmark API and check if email arrived.'
 
   s.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.test_files  = `git ls-files -- {spec}/*`.split("\n")

data/spec/unit/mailhandler/receiver_spec.rb

@@ -2,21 +2,26 @@ require 'spec_helper'
 
 describe MailHandler::Receiver do
   context 'valid receiver' do
+    subject(:receiver) { described_class.new(checker) }
+
     let(:default_search_option) { { by_subject: 'test' } }
     let(:receiving_duration) { 5 }
     let(:found_email) { Mail.new { subject 'test email' } }
     let(:checker) do
-      checker = double('Checker')
+      checker = instance_double('Checker')
+
+      allow(checker).to receive(:find) do
+        sleep receiving_duration
+        true
+      end
 
-      allow(checker).to receive(:find) { sleep receiving_duration; true }
-      allow(checker).to receive(:search_result) { true }
+      allow(checker).to receive(:search_result).and_return(true)
       allow(checker).to receive(:found_emails) { [found_email] }
-      allow(checker).to receive(:reset_found_emails) { [] }
-      allow(checker).to receive(:start) { nil }
-      allow(checker).to receive(:stop) { nil }
+      allow(checker).to receive(:reset_found_emails).and_return([])
+      allow(checker).to receive(:start).and_return(nil)
+      allow(checker).to receive(:stop).and_return(nil)
       checker
     end
-    subject(:receiver) { MailHandler::Receiver.new(checker) }
 
     context 'att readers' do
       it { is_expected.to respond_to(:checker) }
@@ -31,7 +36,7 @@ describe MailHandler::Receiver do
     end
 
     it 'create' do
-      is_expected.to be_kind_of MailHandler::Receiver
+      expect(receiver).to be_kind_of described_class
     end
 
     it '.find_email' do
@@ -54,14 +59,17 @@ describe MailHandler::Receiver do
 
     context '.search' do
       let(:checker) do
-        checker = double('Checker')
+        checker = instance_double('Checker')
 
-        allow(checker).to receive(:find) { sleep 1; false }
-        allow(checker).to receive(:search_result) { false }
-        allow(checker).to receive(:found_emails) { [] }
-        allow(checker).to receive(:reset_found_emails) { [] }
-        allow(checker).to receive(:start) { nil }
-        allow(checker).to receive(:stop) { nil }
+        allow(checker).to receive(:find) do
+          sleep 1
+          false
+        end
+        allow(checker).to receive(:search_result).and_return(false)
+        allow(checker).to receive(:found_emails).and_return([])
+        allow(checker).to receive(:reset_found_emails).and_return([])
+        allow(checker).to receive(:start).and_return(nil)
+        allow(checker).to receive(:stop).and_return(nil)
         checker
       end
 

data/spec/unit/mailhandler/receiving/base_spec.rb

@@ -1,25 +1,26 @@
 require 'spec_helper'
 
 describe MailHandler::Receiving::Checker do
-  subject { MailHandler::Receiving::Checker.new }
+  subject(:receiving_checker) { described_class.new }
 
   it '.create' do
-    is_expected.to be_kind_of MailHandler::Receiving::Checker
+    expect(receiving_checker).to be_kind_of described_class
   end
 
   it 'init details' do
     aggregate_failures 'receiving details' do
-      expect(subject.search_options).to eq(count: 50, archive: false)
-      expect(subject.found_emails).to eq []
-      expect(subject.search_result).to be false
+      expect(receiving_checker.search_options).to eq(count: 50, archive: false)
+      expect(receiving_checker.found_emails).to eq []
+      expect(receiving_checker.search_result).to be false
     end
   end
 
   it '.find' do
-    expect { subject.find(by_subject: 'test') }.to raise_error(MailHandler::InterfaceError, 'Find interface not implemented.')
+    expect { receiving_checker.find(by_subject: 'test') }
+      .to raise_error(MailHandler::InterfaceError, 'Find interface not implemented.')
   end
 
   it '.search_result' do
-    expect(subject.search_result).to be false
+    expect(receiving_checker.search_result).to be false
   end
 end