mailhandler 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 638f7cfc88aa7e83259905c127723c0ecc5f26ea
-  data.tar.gz: cbfdb4fa89e30bfd374e850cf63933f753589cac
+  metadata.gz: a290f9049b44faf3abc87592583dfd76063c5442
+  data.tar.gz: 61bdcf1d9d8c1355463d5e7bc0678158e7087864
 SHA512:
-  metadata.gz: 78c12824348df632bacb66983cc0d0bd582619af1bca973825d4dcc605b29b14f48d39ff6e8ab79bc880f802bf3937750b74c2314c949cc1aee244fc8c7af891
-  data.tar.gz: 83c3993bace242b2f05ec806f7a2ab8ef5fb478fe3acbdecb444e6be614ed92bc5a3d27f74ac3e0cf00b7be26e5190e831caaeb1f515ed8364770e162cf3837c
+  metadata.gz: c9c6e5a41a9f4dbb9ec1631be903839104f52fd10a1aec1d182dd9a320131481b29b79ad22c5368d40b7e422b77699fd3a567e2c59f7002f0b48683234020007
+  data.tar.gz: 6409f13a167cef7deaf8ebb9aac4be757626f5a39d148b77667f26e3da5025852d0f84a7d49078203d7c19e969a62aae525b7b1b810eb449b4ccc5075e23c56f

data/lib/mailhandler.rb

@@ -3,6 +3,10 @@ require_relative 'mailhandler/receiver'
 
 require_relative 'mailhandler/receiving/notification/email'
 require_relative 'mailhandler/receiving/notification/console'
+require_relative 'mailhandler/errors'
+
+# Main MailHandler class, that allows you to create sender and receiver objects.
+# Sender objects for sending emails, receiver objects for receiving emails from certain mailboxes.
 
 module MailHandler
 
@@ -72,6 +76,7 @@ module MailHandler
 
     private
 
+    # method for adding custom notifications, in case email delivery is delayed.
     def add_receiving_notifications(receiver, notifications)
 
       if (notifications - NOTIFICATION_TYPES.keys).empty?
@@ -84,7 +89,7 @@ module MailHandler
 
     def verify_type(type, types)
 
-      raise StandardError, "Unknown type - #{type}, possible options: #{types.keys}" unless types.keys.include? type
+      raise MailHandler::TypeError, "Unknown type - #{type}, possible options: #{types.keys}" unless types.keys.include? type
 
     end
 

data/lib/mailhandler/errors.rb

@@ -0,0 +1,14 @@
+module MailHandler
+
+  class Error < StandardError
+
+    def initialize(message = nil)
+      super(message)
+    end
+
+  end
+
+  class UnknownError        < Error; end
+  class TypeError           < Error; end
+
+end

data/lib/mailhandler/receiver.rb

@@ -10,7 +10,7 @@ module MailHandler
 
     attr_accessor :checker,
                   :search,
-                  :search_max_duration
+                  :max_search_duration
 
     module DEFAULTS
 
@@ -32,7 +32,7 @@ module MailHandler
     def initialize(checker)
 
       @checker = checker
-      @search_max_duration = DEFAULTS::MAX_SEARCH_DURATION
+      @max_search_duration = DEFAULTS::MAX_SEARCH_DURATION
 
     end
 
@@ -62,7 +62,7 @@ module MailHandler
       @search = Search.new
       @search.options = options
       @search.started_at = Time.now
-      @search.max_duration = @search_max_duration
+      @search.max_duration = @max_search_duration
 
     end
 
@@ -78,7 +78,7 @@ module MailHandler
 
     def search_time_expired?
 
-      (Time.now - search.started_at) > @search_max_duration
+      (Time.now - search.started_at) > @max_search_duration
 
     end
 

data/lib/mailhandler/receiving/base.rb

@@ -1,3 +1,5 @@
+require_relative '../errors'
+
 module MailHandler
 
   module Receiving
@@ -22,21 +24,16 @@ module MailHandler
 
       ]
 
-      DEFAULT_SEARCH_OPTIONS = [
-
-          :archive
-      ]
-
       def initialize
 
-        base_search_options
+        set_base_search_options
         reset_found_emails
 
       end
 
       def find(options)
 
-        raise StandardError, 'Method not implemented'
+        raise MailHandler::Error, 'Method not implemented'
 
       end
 
@@ -54,31 +51,61 @@ module MailHandler
 
       protected
 
-      def base_search_options
+      def verify_and_set_search_options(options)
 
-        # Default number of email results to return, and whether to archive emails.
-        @search_options = {:count => 50, :archive => false}
+        validate_used_options(options)
+        validate_option_values(options)
+
+        set_base_search_options
+        add_additional_search_options(options)
+        reset_found_emails
 
       end
 
-      def verify_and_set_search_options(options)
+      def validate_option_values(options)
 
-        base_search_options
-        validate_used_options(options)
+        if options[:by_date]
 
-        @search_options = search_options.merge options
-        reset_found_emails
+          raise MailHandler::Error, "Incorrect option options[:by_date]=#{options[:date]}" unless options[:by_date].is_a? Time
+
+        end
+
+        unless options[:count].nil?
+
+          count = options[:count]
+          raise MailHandler::Error, "Incorrect option options[:count]=#{options[:count]}" if count < 0 or count > 2000
+
+        end
+
+        if options[:archive]
+
+          raise MailHandler::Error, "Incorrect option options[:archive]=#{options[:archive]}" unless options[:archive] == true or options[:archive] == false
+
+        end
 
       end
 
       def validate_used_options(options)
 
         unless (options.keys - AVAILABLE_SEARCH_OPTIONS).empty?
-          raise StandardError, "#{(options.keys - AVAILABLE_SEARCH_OPTIONS)} - Incorrect search option values, options are #{AVAILABLE_SEARCH_OPTIONS}"
+          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}
+
+      end
+
+      def add_additional_search_options(options)
+
+        @search_options = @search_options.merge options
+
+      end
+
     end
 
   end

data/lib/mailhandler/receiving/filter.rb

@@ -56,7 +56,7 @@ module Filter
 
     def initialize(content)
 
-      @content = content
+      @content = content.to_s
 
     end
 

data/lib/mailhandler/receiving/folder.rb

@@ -1,6 +1,7 @@
 require_relative 'base.rb'
 require_relative 'filter'
 require 'mail'
+require_relative '../errors'
 
 module MailHandler
 
@@ -107,7 +108,7 @@ module MailHandler
       # create folders if they don't exist
       def setup_inbox_folders
 
-        raise StandardError, 'Folder variables are not set' if inbox_folder.nil? or archive_folder.nil?
+        raise MailHandler::Error, 'Folder variables are not set' if inbox_folder.nil? or archive_folder.nil?
 
         Dir::mkdir inbox_folder unless File.directory? inbox_folder
         Dir::mkdir archive_folder unless File.directory? archive_folder

data/lib/mailhandler/receiving/imap.rb

@@ -1,6 +1,8 @@
+# encoding: utf-8
+
 require 'mail'
 require_relative 'base.rb'
-# encoding: utf-8
+require_relative '../errors'
 
 module MailHandler
 
@@ -18,6 +20,7 @@ module MailHandler
       AVAILABLE_SEARCH_OPTIONS = [
 
           :by_subject,
+          :by_content,
           :count,
           :archive,
           :by_recipient
@@ -111,7 +114,11 @@ module MailHandler
 
             when :by_subject
 
-              keys << 'SUBJECT' << options[:by_subject]
+              keys << 'SUBJECT' << options[:by_subject].to_s
+
+            when :by_content
+
+              keys << 'BODY' << options[:by_content].to_s
 
             else
 
@@ -128,7 +135,7 @@ module MailHandler
       def validate_options(options)
 
         unless (options.keys - AVAILABLE_SEARCH_OPTIONS).empty?
-          raise StandardError, "#{(options.keys - AVAILABLE_SEARCH_OPTIONS)} - Not supported search option values for imap, options are #{AVAILABLE_SEARCH_OPTIONS}"
+          raise MailHandler::Error, "#{(options.keys - AVAILABLE_SEARCH_OPTIONS)} - Not supported search option values for imap, options are #{AVAILABLE_SEARCH_OPTIONS}"
         end
 
       end

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

@@ -1,5 +1,6 @@
 require_relative 'email/content'
 require_relative 'email/states'
+require_relative '../../errors'
 
 module MailHandler
 
@@ -58,7 +59,7 @@ module MailHandler
 
         def verify_email_type(type)
 
-          raise StandardError, "Incorrect type: #{type}, allowed types: #{EMAIL_TYPES}" unless EMAIL_TYPES.include? type
+          raise MailHandler::TypeError, "Incorrect type: #{type}, allowed types: #{EMAIL_TYPES}" unless EMAIL_TYPES.include? type
 
         end
 

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

@@ -1,4 +1,5 @@
 require_relative '../email'
+require_relative '../../../errors'
 
 module MailHandler
 
@@ -25,7 +26,7 @@ module MailHandler
 
         def notify(search)
 
-          raise StandardError, 'notify(search) interface has to be implemented'
+          raise MailHandler::Error, 'notify(search) interface has to be implemented'
 
         end
 

data/lib/mailhandler/sending/api_batch.rb

@@ -1,4 +1,5 @@
 require_relative 'api.rb'
+require_relative '../errors'
 
 module MailHandler
 
@@ -18,7 +19,7 @@ module MailHandler
 
       def verify_email(emails)
 
-        raise StandardError, "Invalid type error, only Array of Mail::Message object types for sending allowed" unless emails.is_a?(Array) && emails.all? { |e| e.is_a? Mail::Message }
+        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? Mail::Message }
 
       end
 

data/lib/mailhandler/sending/base.rb

@@ -1,3 +1,5 @@
+require_relative '../errors'
+
 module MailHandler
 
   module Sending
@@ -10,7 +12,15 @@ module MailHandler
 
       def verify_email(email)
 
-        raise StandardError, "Invalid type error, only #{Mail.new.class} object type for sending allowed" unless email.is_a? Mail.new.class
+        raise MailHandler::TypeError, "Invalid type error, only #{allowed_email_type} object type for sending allowed" unless email.is_a? allowed_email_type
+
+      end
+
+      private
+
+      def allowed_email_type
+
+        Mail::Message
 
       end
 

data/lib/mailhandler/version.rb

@@ -1,5 +1,5 @@
 module MailHandler
 
-  VERSION = '1.0.9'
+  VERSION = '1.0.10'
 
 end

data/mailhandler.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
 
   s.files       = `git ls-files`.split($/)
   s.test_files  = `git ls-files -- {spec}/*`.split("\n")
-  s.homepage    = 'https://github.com/wildbit'
+  s.homepage    = 'https://github.com/wildbit/mailhandler'
   s.require_paths = ["lib"]
 
   s.post_install_message = %q{

data/readme.md

@@ -61,11 +61,16 @@ email_receiver.find_email(:by_subject => subject, :archive => true)
 You can search imap mailbox by following options:
 
 * `:by_subject` - subject of the email
+* `:by_content` - search email content by keywords
+* `:by_recipient` - by email recipient
 
 You can search local mailbox by following options:
 
 * `:by_subject` - subject of the email   
 * `:by_recipient` - by email recipient
+* `:by_content` - search email content by keywords
+
+Recipient to search by needs to by added in following form: `by_recipient => { :to => 'igor@example.com' }`.
 
 If you would like email to be archived after its read, use `:archive => true` option (recommended)
 

data/spec/unit/mailhandler/receiver_spec.rb

@@ -23,7 +23,7 @@ describe MailHandler::Receiver do
 
       it { is_expected.to respond_to(:checker) }
       it { is_expected.to respond_to(:search) }
-      it { is_expected.to respond_to(:search_max_duration) }
+      it { is_expected.to respond_to(:max_search_duration) }
 
     end
 
@@ -31,7 +31,7 @@ describe MailHandler::Receiver do
 
       it { is_expected.to respond_to(:checker=) }
       it { is_expected.to respond_to(:search=) }
-      it { is_expected.to respond_to(:search_max_duration=) }
+      it { is_expected.to respond_to(:max_search_duration=) }
 
     end
 
@@ -80,7 +80,7 @@ describe MailHandler::Receiver do
 
         it "max duration - #{duration} seconds" do
 
-          receiver.search_max_duration = duration
+          receiver.max_search_duration = duration
           receiver.find_email(default_search_option)
 
           expect(receiver.search.duration).to be_within(1).of(duration)

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

@@ -20,4 +20,10 @@ describe MailHandler::Receiving::Checker do
 
   end
 
+  it '.find' do
+
+    expect { subject.find(:by_subject => 'test') }.to raise_error(MailHandler::Error, 'Method not implemented')
+
+  end
+
 end

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

@@ -18,13 +18,93 @@ describe MailHandler::Receiving::FolderChecker do
 
       context 'search options' do
 
-        it 'default' do
+        it 'by multiple search options' do
+
+          time = Time.now
+          checker.find({:by_subject => 'test', :by_content => 'test', :by_date => time, :by_recipient => 'igor@example.com'})
+          expect(checker.search_options).to eq(
+                                                {:count=>50,
+                                                 :archive=>false,
+                                                 :by_subject => 'test',
+                                                 :by_content => 'test',
+                                                 :by_date => time,
+                                                 :by_recipient => 'igor@example.com'})
+
+        end
+
+        it 'by_subject' do
 
           checker.find({:by_subject => 'test'})
           expect(checker.search_options).to eq({:count=>50, :archive=>false, :by_subject=>'test'})
 
         end
 
+        it 'by_content' do
+
+          checker.find({:by_content => 'test'})
+          expect(checker.search_options).to eq({:count=>50, :archive=>false, :by_content => 'test'})
+
+        end
+
+        context 'archive' do
+
+          it 'invalid' do
+
+            expect { checker.find({:archive => 'test'}) }.to raise_error MailHandler::Error
+
+          end
+
+        end
+
+        context 'by_date' do
+
+          it 'valid' do
+
+            time = Time.now
+            checker.find({:by_date => time})
+            expect(checker.search_options).to eq({:count=>50, :archive=>false, :by_date => time })
+
+          end
+
+          it 'invalid' do
+
+            time = Time.now.to_s
+            expect { checker.find({:by_date => time}) }.to raise_error MailHandler::Error
+
+          end
+
+        end
+
+        it 'by_recipient' do
+
+          checker.find({:by_recipient => 'igor@example.com'})
+          expect(checker.search_options).to eq({:count=>50, :archive=>false, :by_recipient =>  'igor@example.com' })
+
+        end
+
+        context 'count' do
+
+          it 'valid' do
+
+            checker.find({:count => 1})
+            expect(checker.search_options).to eq({:count=>1, :archive=>false})
+
+          end
+
+          it 'invalid - below limit' do
+
+            expect { checker.find({:count => -1}) }.to raise_error MailHandler::Error
+
+          end
+
+          it 'invalid - above limit' do
+
+            expect { checker.find({:count => 3000 }) }.to raise_error MailHandler::Error
+
+          end
+
+        end
+
       end
 
       context 'not found' do

data/spec/unit/mailhandler/receiving/notification/email_spec.rb

@@ -3,5 +3,4 @@ require 'spec_helper'
 describe MailHandler::Receiving::Notification::Email do
 
 
-
 end

data/spec/unit/mailhandler/sending/sender_api_batch_spec.rb

@@ -32,7 +32,7 @@ describe MailHandler::Sending::PostmarkBatchAPISender do
 
       sender = subject.new(api_token)
       expect{sender.send('test')}.
-          to raise_error StandardError, 'Invalid type error, only Array of Mail::Message object types for sending allowed'
+          to raise_error MailHandler::TypeError, 'Invalid type error, only Array of Mail::Message object types for sending allowed'
 
     end
 
@@ -40,7 +40,7 @@ describe MailHandler::Sending::PostmarkBatchAPISender do
 
       sender = subject.new(api_token)
       expect{sender.send([1,2,2])}.
-          to raise_error StandardError, 'Invalid type error, only Array of Mail::Message object types for sending allowed'
+          to raise_error MailHandler::TypeError, 'Invalid type error, only Array of Mail::Message object types for sending allowed'
 
     end
 

data/spec/unit/mailhandler_spec.rb

@@ -9,7 +9,7 @@ describe MailHandler::Handler do
     it 'create - invalid type' do
 
       expect { subject.init_receiver(:test) }.
-          to raise_error(StandardError, 'Unknown type - test, possible options: [:folder, :imap]')
+          to raise_error(MailHandler::TypeError, 'Unknown type - test, possible options: [:folder, :imap]')
 
     end
 
@@ -32,7 +32,7 @@ describe MailHandler::Handler do
     it 'create - invalid type' do
 
       expect { subject.init_sender(:test) }.
-          to raise_error(StandardError, 'Unknown type - test, possible options: [:postmark_api, :postmark_batch_api, :smtp]')
+          to raise_error(MailHandler::TypeError, 'Unknown type - test, possible options: [:postmark_api, :postmark_batch_api, :smtp]')
 
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailhandler
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Igor Balos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -59,6 +59,7 @@ files:
 - Gemfile.lock
 - Rakefile
 - lib/mailhandler.rb
+- lib/mailhandler/errors.rb
 - lib/mailhandler/receiver.rb
 - lib/mailhandler/receiving/base.rb
 - lib/mailhandler/receiving/filter.rb
@@ -90,7 +91,7 @@ files:
 - spec/unit/mailhandler/sending/sender_api_batch_spec.rb
 - spec/unit/mailhandler/sending/sender_api_spec.rb
 - spec/unit/mailhandler_spec.rb
-homepage: https://github.com/wildbit
+homepage: https://github.com/wildbit/mailhandler
 licenses:
 - MIT
 metadata: {}