mailhandler 1.0.36 → 1.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e3e402f4b95ef68f6d3e14782e9df18f45a7ff0
-  data.tar.gz: 6285982ac47bfafa48410c2a1c98f6d21c3f0510
+  metadata.gz: 8f4daed68e55b824dbcad5321f41fd3aa4374769
+  data.tar.gz: 12934cc4aa8d94d6647c2049291f40910b939a7b
 SHA512:
-  metadata.gz: e132dcab6529c17c696390bac5c052d92ea91d8d718715d575a28342da1f85b57d6bdd370b737c5494ae82c0e64f9cc279287d825b11c0fbfee24e2d44554524
-  data.tar.gz: 3daf78e47d35f23add73b1484667f1b5f9b54385013924ae3ce2ee56778bca044856a4b256665dfb342efc83ab0e41558307eb64e97ee6ec1199e519ad6ed4c0
+  metadata.gz: 5f3f94f0de2600cc2d99d8cfeeb43f3b33ec74e5917a0a045b103f0f2c63ccb52ecdcc1bd0a77300ea13de5f8820d834c679edfc6e955a01754d2dcf72a95f09
+  data.tar.gz: 23355aac8afd26e73c3f04b34a75dd65d823e78cdf8f95cce040df3482a5cf1f14c18d276726b42df23d86eb626a44b58bd26c716cc42fd65b3de2c9fb0caf33

data/Gemfile

@@ -1,7 +1,7 @@
 # A sample Gemfile
 source 'https://rubygems.org'
 
-gem 'rspec'
 gem 'mail'
 gem 'postmark'
-gem 'pry'
+gem 'pry'
+gem 'rspec'

data/Rakefile

@@ -1,3 +1,3 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:default)
+RSpec::Core::RakeTask.new(:default)

data/lib/mailhandler.rb

@@ -8,31 +8,26 @@ require_relative 'mailhandler/errors'
 # Main MailHandler class, for creating sender and receiver objects.
 # Sender objects for sending emails, receiver objects for searching and receiving emails.
 module MailHandler
-
-  extend self
+  module_function
 
   # sending accessor
   # @return [Object] - sender for sending emails
   def sender(type = :postmark_api)
-
     handler = Handler.new
     handler.init_sender(type)
     yield(handler.sender.dispatcher) if block_given?
 
     handler.sender
-
   end
 
   # receiving accessor
   # @return [Object] - receiver for searching emails
   def receiver(type = :folder, notifications = [])
-
     handler = Handler.new
     handler.init_receiver(type, notifications)
     yield(handler.receiver.checker) if block_given?
 
     handler.receiver
-
   end
 
   # Holder for receiving and sending handlers
@@ -40,92 +35,73 @@ module MailHandler
   # @param [Receiving::Class] receiver
   # @param [Sending::Class] sender
   def handler(receiver, sender)
-
     handler = Handler.new
     handler.handler(receiver, sender)
-
   end
 
   # main handler class for creating sender, receiver handlers
   class Handler
-
     attr_accessor :sender,
                   :receiver
 
     def init_sender(type = :postmark_api)
-
       verify_type(type, SENDER_TYPES)
       @sender = MailHandler::Sender.new(SENDER_TYPES[type].new)
-
     end
 
-
     def init_receiver(type = :folder, notifications = [])
-
       verify_type(type, CHECKER_TYPES)
       @receiver = MailHandler::Receiver.new(CHECKER_TYPES[type].new)
       add_receiving_notifications(@receiver, notifications)
       @receiver
-
     end
 
     def handler(sender, receiver)
-
       handler = new
       handler.sender = sender
       handler.receiver = receiver
       handler
-
     end
 
     private
 
-    # Add notifications, in case email receiving is delayed. 
+    # Add notifications, in case email receiving is delayed.
     # When email is delayed, email notification can be sent or console status update.
     #
     # @param [Receiving::Object] receiver
     # @param [Array<Receiving::Notification::Class>] notifications
     def add_receiving_notifications(receiver, notifications)
-
       if (notifications - NOTIFICATION_TYPES.keys).empty?
 
         notifications.each { |n| receiver.add_observer(NOTIFICATION_TYPES[n].new) }
 
       end
-
     end
 
     def verify_type(type, types)
-
-      raise MailHandler::TypeError, "Unknown type - #{type}, possible options: #{types.keys}." unless types.keys.include? type
-
+      raise MailHandler::TypeError, "Unknown type - #{type}, possible options: #{types.keys}." unless types.key?(type)
     end
 
     CHECKER_TYPES = {
 
-        :folder => Receiving::FolderChecker,
-        :imap => Receiving::IMAPChecker
+      folder: Receiving::FolderChecker,
+      imap: Receiving::IMAPChecker
 
-    }
+    }.freeze
 
     SENDER_TYPES = {
 
-        :postmark_api => Sending::PostmarkAPISender,
-        :postmark_batch_api => Sending::PostmarkBatchAPISender,
-        :smtp => Sending::SMTPSender
+      postmark_api: Sending::PostmarkAPISender,
+      postmark_batch_api: Sending::PostmarkBatchAPISender,
+      smtp: Sending::SMTPSender
 
-    }
+    }.freeze
 
     NOTIFICATION_TYPES = {
 
-        :console => Receiving::Notification::Console,
-        :email => Receiving::Notification::Email
-
-    }
+      console: Receiving::Notification::Console,
+      email: Receiving::Notification::Email
 
+    }.freeze
   end
-
 end
-
-
-

data/lib/mailhandler/errors.rb

@@ -1,16 +1,12 @@
 module MailHandler
-
   class Error < StandardError
-
     def initialize(message = nil)
       super(message)
     end
-
   end
 
   class UnknownError        < Error; end
   class TypeError           < Error; end
   class FileError           < Error; end
   class InterfaceError      < Error; end
-
-end
+end

data/lib/mailhandler/receiver.rb

@@ -4,9 +4,7 @@ require_relative 'receiving/observer'
 require_relative 'receiving/mail.rb'
 
 module MailHandler
-
   class Receiver
-
     include Receiving::Observer
 
     attr_accessor :checker,
@@ -15,10 +13,8 @@ module MailHandler
                   :search_frequency
 
     module DEFAULTS
-
       MAX_SEARCH_DURATION = 240 # maximum time for search to last in [seconds]
       SEARCH_FREQUENCY = 0.5 # how frequently to check for email in inbox [seconds]
-
     end
 
     # @param [Hash] - search options
@@ -31,18 +27,15 @@ module MailHandler
     # @param [boolean] - result of search
     # @param [Mail] - first email found
     # @param [Array] - all emails found
-    Search = Struct.new( :options, :started_at, :finished_at, :duration, :max_duration, :result, :email, :emails)
+    Search = Struct.new(:options, :started_at, :finished_at, :duration, :max_duration, :result, :email, :emails)
 
     def initialize(checker)
-
       @checker = checker
       @max_search_duration = DEFAULTS::MAX_SEARCH_DURATION
       @search_frequency = DEFAULTS::SEARCH_FREQUENCY
-
     end
 
     def find_email(options)
-
       init_search_details(options)
       checker.start
 
@@ -58,40 +51,29 @@ module MailHandler
 
       notify_observers(search)
       checker.search_result
-
-      ensure
-
-        checker.stop
-
+    ensure
+      checker.stop
     end
 
     private
 
     def init_search_details(options)
-
       @search = Search.new
       @search.options = options
       @search.started_at = Time.now
       @search.max_duration = @max_search_duration
-
     end
 
     def update_search_details
-
       search.finished_at = Time.now
       search.duration = search.finished_at - search.started_at
       search.result = checker.search_result
       search.emails = checker.found_emails
       search.email = search.emails.first
-
     end
 
     def search_time_expired?
-
       (Time.now - search.started_at) > @max_search_duration
-
     end
-
   end
-
-end
+end

data/lib/mailhandler/receiving/base.rb

@@ -1,83 +1,64 @@
 require_relative '../errors'
 
 module MailHandler
-
   module Receiving
-
     #
     # Email receiving checker main class.
     # @see MailHandler::Receiving::FolderChecker for example for one of implemented checkers.
     #
     class Checker
-
       attr_accessor :search_options,
                     :found_emails,
                     :available_search_options
 
       def initialize
-
         @available_search_options = AVAILABLE_SEARCH_OPTIONS
         set_base_search_options
         reset_found_emails
-
       end
 
-      def start
-
-      end
+      def start; end
 
-      def stop
-
-      end
-
-      def find(options)
+      def stop; end
 
+      def find(_options)
         raise MailHandler::InterfaceError, 'Find interface not implemented.'
-
       end
 
       def search_result
-
         !found_emails.empty?
-
       end
 
       def reset_found_emails
-
         @found_emails = []
-
       end
 
       private
 
-      AVAILABLE_SEARCH_OPTIONS = [
+      AVAILABLE_SEARCH_OPTIONS = %i[
 
-          :by_subject,
-          :by_content,
-          :since,
-          :before,
-          :by_recipient,
-          :count,
-          :archive,
-          :fast_check
-
-      ]
+        by_subject
+        by_content
+        since
+        before
+        by_recipient
+        count
+        archive
+        fast_check
+      ].freeze
 
       protected
 
       def verify_and_set_search_options(options)
-
         validate_used_options(options)
         validate_option_values(options)
 
         set_base_search_options
         add_additional_search_options(options)
         reset_found_emails
-
       end
 
       def validate_option_values(options)
-
         if options[:since]
 
           raise MailHandler::Error, "Incorrect option options[:since]=#{options[:since]}." unless options[:since].is_a? Time
@@ -87,13 +68,13 @@ module MailHandler
         unless options[:count].nil?
 
           count = options[:count]
-          raise MailHandler::Error, "Incorrect option options[:count]=#{options[:count]}." if count < 0 or count > 2000
+          raise MailHandler::Error, "Incorrect option options[:count]=#{options[:count]}." if (count < 0) || (count > 2000)
 
         end
 
         if options[:archive]
 
-          raise MailHandler::Error, "Incorrect option options[:archive]=#{options[:archive]}." unless options[:archive] == true or options[:archive] == false
+          raise MailHandler::Error, "Incorrect option options[:archive]=#{options[:archive]}." unless (options[:archive] == true) || (options[:archive] == false)
 
         end
 
@@ -102,32 +83,22 @@ module MailHandler
           raise MailHandler::Error, "Incorrect option options[:by_recipient]=#{options[:by_recipient]}." unless options[:by_recipient].is_a?(Hash)
 
         end
-
       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
-
       end
 
       def set_base_search_options
-
         # Default number of email results to return, and whether to archive emails.
-        @search_options = {:count => 50, :archive => false}
-
+        @search_options = { count: 50, archive: false }
       end
 
       def add_additional_search_options(options)
-
         @search_options = @search_options.merge options
-
       end
-
     end
-
   end
-
 end

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

@@ -4,25 +4,17 @@ require 'fileutils'
 # Patterns to be used can be checked here: http://ruby-doc.org/core-1.9.3/Dir.html
 
 module MailHandler
-
   module Receiving
-
     module FileHandling
-
       # if file exists, execute file operation, otherwise return default return value when it doesn't
-      def access_file(file, default_return = false, &block)
-
-        if File.exists? file
+      def access_file(file, default_return = false)
+        if File.exist? file
 
           begin
-
-            block.call
-
-          rescue => e
-
-            raise e if File.exists? file
+            yield
+          rescue StandardError => e
+            raise e if File.exist? file
             default_return
-
           end
 
         else
@@ -30,69 +22,53 @@ module MailHandler
           default_return
 
         end
-
       end
-
     end
 
     class FileList
-
       include FileHandling
 
       def get(pattern)
-
         Dir.glob(pattern)
-
       end
 
       def sort(files)
-
         swapped = true
         j = 0
 
-        while swapped do
+        while swapped
 
           swapped = false
-          j+=1
+          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 }
-
-            if file1 && file2 && file1 < file2
-              tmp = files[i]
-              files[i] = files[i + 1]
-              files[i + 1] = tmp
-              swapped = true
-
-            end
+            file2 = access_file(files[i + 1], false) { File.new(files[i + 1]).ctime }
 
+            next unless file1 && file2 && file1 < file2
+            tmp = files[i]
+            files[i] = files[i + 1]
+            files[i + 1] = tmp
+            swapped = true
           end
 
         end
 
         files
-
       end
-
     end
-
   end
-
 end
 
-=begin
-
-TEST EXAMPLE
-
-FileList.get('*.*')
-FileList::Filter::ByEmailSubject.new(files,'subject').get
-FileList::Filter::ByEmailContent.new(files,'content').get
-FileList::Filter::ByEmailDate.new(files, date).get
-FileList::Filter::ByEmailRecipient.new(files, recipient).get
-
-f = FileList::Filter::ByEmailSubject.new(FileList.get("*.*"), "binding")
-puts f.get
-
-=end
+#
+# TEST EXAMPLE
+#
+# FileList.get('*.*')
+# FileList::Filter::ByEmailSubject.new(files,'subject').get
+# FileList::Filter::ByEmailContent.new(files,'content').get
+# FileList::Filter::ByEmailDate.new(files, date).get
+# FileList::Filter::ByEmailRecipient.new(files, recipient).get
+#
+# f = FileList::Filter::ByEmailSubject.new(FileList.get("*.*"), "binding")
+# puts f.get
+#