mailhandler 1.0.17 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2494cc0dc22949823fe4c21f75ff4c358ce78da
-  data.tar.gz: 56ef36817c503bec109aeb97492ca0380275d569
+  metadata.gz: 083df235cda02401f6ed87e997e235def311840e
+  data.tar.gz: bbc739fa0de274bb0d87733a418346d796526c3f
 SHA512:
-  metadata.gz: 77b6c9b2f301025df73abe7f4fcc595c0088605e8df4718b9f7385bd11be1b32802b4b39b326b3d8e419816bd5a54d8213dff61852e871158c0cf488647211ac
-  data.tar.gz: d5b01f41f9fbb8675aaccf2b28e36b1e99a703bae3b104e582c1a613a72b2fefe660c7c010725bc3d10d61a0aa62741854f661ab903da8c37e1e696909993e90
+  metadata.gz: a067e385d21369f0eef498fc2c6f3843fe40ccb134f917e0b32b5e344660b8c7812f834b5cdba0e73e6c8c7f5760e21edc8e0d827496f8057f8160e9cc6d2c8c
+  data.tar.gz: 3b5f4dac54ef936fd3976dc847bfe82691c5656032bf243e57c5f9186ec37d294f256f69bf5e1aaf77a562bf5d0537e2f17385dca406f9d3ba08eb116f719186

data/lib/mailhandler/receiving/base.rb

@@ -11,21 +11,12 @@ module MailHandler
     class Checker
 
       attr_accessor :search_options,
-                    :found_emails
-
-      AVAILABLE_SEARCH_OPTIONS = [
-
-          :by_subject,
-          :by_content,
-          :by_date,
-          :by_recipient,
-          :count,
-          :archive
-
-      ]
+                    :found_emails,
+                    :available_search_options
 
       def initialize
 
+        @available_search_options = AVAILABLE_SEARCH_OPTIONS
         set_base_search_options
         reset_found_emails
 
@@ -49,6 +40,19 @@ module MailHandler
 
       end
 
+      private
+
+      AVAILABLE_SEARCH_OPTIONS = [
+
+          :by_subject,
+          :by_content,
+          :since,
+          :by_recipient,
+          :count,
+          :archive
+
+      ]
+
       protected
 
       def verify_and_set_search_options(options)
@@ -64,9 +68,9 @@ module MailHandler
 
       def validate_option_values(options)
 
-        if options[:by_date]
+        if options[:since]
 
-          raise MailHandler::Error, "Incorrect option options[:by_date]=#{options[:date]}." unless options[:by_date].is_a? Time
+          raise MailHandler::Error, "Incorrect option options[:since]=#{options[:since]}." unless options[:since].is_a? Time
 
         end
 
@@ -87,8 +91,8 @@ module MailHandler
 
       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}."
+        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

data/lib/mailhandler/receiving/file_filter/filter.rb

@@ -73,8 +73,11 @@ module MailHandler
 
         def file_match_filter?(file)
 
+          # TODO: add UTF support
+          # string need to be read and converted
+          # read_email(file_content).subject.include?(@content) - 10x slower, use something else for reading
+          # Mail::Encodings.unquote_and_convert_to(content, "UTF-8") - 6x slower
           File.read(file).include? @content
-          #read_email(file_content).subject.include?(@content) slow, use something else for reading
 
         end
 

data/lib/mailhandler/receiving/folder.rb

@@ -47,7 +47,7 @@ module MailHandler
 
           :by_subject => Filter::BySubject,
           :by_content => Filter::ByContent,
-          :by_date => Filter::ByDate,
+          :since => Filter::ByDate,
           :by_recipient => Filter::Email::ByRecipient
       }
 

data/lib/mailhandler/receiving/imap.rb

@@ -17,25 +17,10 @@ module MailHandler
                     :authentication,
                     :use_ssl
 
-      # search options:
-      # by_subject - String, search by a whole string as part of the subject of the email
-      # by_content - String, search by a whole string as part of the content of the email
-      # count - Int, number of found emails to return
-      # archive - Boolean
-      # by_recipient - Hash, accepts a hash like: :to => 'igor@example.com'
-      AVAILABLE_SEARCH_OPTIONS = [
-
-          :by_subject,
-          :by_content,
-          :count,
-          :archive,
-          :by_recipient
-
-      ]
-
       def initialize
 
         super
+        @available_search_options = AVAILABLE_SEARCH_OPTIONS
 
       end
 
@@ -51,6 +36,22 @@ module MailHandler
 
       private
 
+      # search options:
+      # by_subject - String, search by a whole string as part of the subject of the email
+      # by_content - String, search by a whole string as part of the content of the email
+      # count - Int, number of found emails to return
+      # archive - Boolean
+      # by_recipient - Hash, accepts a hash like: :to => 'igor@example.com'
+      AVAILABLE_SEARCH_OPTIONS = [
+
+          :by_subject,
+          :by_content,
+          :count,
+          :archive,
+          :by_recipient
+
+      ]
+
       # delegate retrieval details to Mail library
       def init_retriever
 

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

@@ -13,7 +13,8 @@ module MailHandler
         attr_reader   :sender,
                       :contacts,
                       :min_time_to_notify,
-                      :max_time_to_notify
+                      :max_time_to_notify,
+                      :current_state
 
         def initialize(sender, contacts, min_time_to_notify = 60)
 

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

@@ -8,6 +8,10 @@ module MailHandler
 
       class EmailContent
 
+        # @param [Hash] options - search options used for searching for an email
+        # @param [Int] delay - delay in seconds
+        # @param [String] from - email address
+        # @param [String] to - email address
         def self.email_received(options, delay, from, to)
 
           Mail.new do
@@ -21,6 +25,10 @@ module MailHandler
 
         end
 
+        # @param [Hash] options - search options used for searching for an email
+        # @param [Int] delay - delay in seconds
+        # @param [String] from - email address
+        # @param [String] to - email address
         def self.email_delayed(options, delay, from, to)
 
           Mail.new do
@@ -28,7 +36,7 @@ module MailHandler
             from from
             subject "Over #{(delay.to_f/60).round(2)} minutes delay"
             body "Over #{(delay.to_f/60).round(2)} minutes delay - search by #{options}"
-            to  to
+            to to
 
           end
 

data/lib/mailhandler/version.rb

@@ -1,5 +1,5 @@
 module MailHandler
 
-  VERSION = '1.0.17'
+  VERSION = '1.0.18'
 
 end

data/readme.md

@@ -76,7 +76,9 @@ You can search local mailbox by following options:
 Recipient to search by needs to by added in the following form: `by_recipient => { :to => 'igor@example.com' }`.
 Library supports searching by :to, :cc recipients. At the moment, only searching by a single recipient email address is supported.
 
-If you would like email to be archived after its read, use `:archive => true` option (recommended)
+If you would like email to be archived after its read, use `:archive => true` option (recommended).
+
+**For now, Unicode is not supported for search by local mailbox, only ASCII.**
 
 ## Search results
 

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

@@ -26,4 +26,10 @@ describe MailHandler::Receiving::Checker do
 
   end
 
+  it '.search_result' do
+
+    expect(subject.search_result).to be false
+
+  end
+
 end

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

@@ -22,13 +22,13 @@ describe MailHandler::Receiving::FolderChecker 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'})
+          checker.find({:by_subject => 'test', :by_content => 'test', :since => 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,
+                                                 :since => time,
                                                  :by_recipient => 'igor@example.com'})
 
         end
@@ -57,20 +57,20 @@ describe MailHandler::Receiving::FolderChecker do
 
         end
 
-        context 'by_date' do
+        context 'since' 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 })
+            checker.find({:since => time})
+            expect(checker.search_options).to eq({:count=>50, :archive=>false, :since => time })
 
           end
 
           it 'invalid' do
 
             time = Time.now.to_s
-            expect { checker.find({:by_date => time}) }.to raise_error MailHandler::Error
+            expect { checker.find({:since => time}) }.to raise_error MailHandler::Error
 
           end
 
@@ -125,7 +125,7 @@ describe MailHandler::Receiving::FolderChecker do
 
         it 'by date' do
 
-          checker.find({:by_date => Time.now + 86400})
+          checker.find({:since => Time.now + 86400})
           expect(checker.found_emails).to be_empty
 
         end
@@ -144,6 +144,30 @@ describe MailHandler::Receiving::FolderChecker do
         let(:mail1) { Mail.read_from_string(File.read "#{data_folder}/email1.txt")}
         let(:mail2) { Mail.read_from_string(File.read "#{data_folder}/email2.txt")}
 
+        context 'search results' do
+
+          let(:search) {
+
+            checker.find({:by_subject => mail1.subject})
+            checker
+
+          }
+
+          it '.search_result' do
+
+            expect(search.search_result).to be true
+
+          end
+
+          it '.reset_found_emails' do
+
+            search.reset_found_emails
+            expect(search.search_result).to be false
+
+          end
+
+        end
+
         it 'result' do
 
           expect(checker.find({:by_subject => mail1.subject})).to be true
@@ -190,7 +214,7 @@ describe MailHandler::Receiving::FolderChecker do
 
         it 'by date' do
 
-          checker.find({:by_date => Time.new(2015,10,12,13,30,0, "+02:00")})
+          checker.find({:since => Time.new(2015,10,12,13,30,0, "+02:00")})
           expect(checker.found_emails.size).to be 4
 
         end

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

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe MailHandler::Receiving::IMAPChecker do
+
+  let(:checker) { MailHandler::Receiving::IMAPChecker.new }
+
+  it '.create' do
+
+    expect(checker).to be_kind_of MailHandler::Receiving::Checker
+
+  end
+
+  it 'options' do
+
+    expect(checker.search_options).to eq({:count=>50, :archive=>false})
+
+  end
+
+  context 'search options' do
+
+    before(:each) do
+
+        allow(checker).to receive(:init_retriever) { true }
+        allow(checker).to receive(:find_emails) { []}
+
+    end
+
+    it 'by multiple search options' do
+
+      checker.find({:by_subject => 'test', :by_content => 'test', :by_recipient => 'igor@example.com'})
+      expect(checker.search_options).to eq(
+                                            {:count=>50,
+                                             :archive=>false,
+                                             :by_subject => 'test',
+                                             :by_content => 'test',
+                                             :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 'invalid' do
+
+      it 'by date' do
+
+        expect { checker.find({:since => Time.now}) }.to raise_error MailHandler::Error
+
+      end
+
+      it 'by_test' do
+
+        expect { checker.find({:by_test => 'test'}) }.to raise_error MailHandler::Error
+
+      end
+
+
+    end
+
+    context 'archive' do
+
+      it 'invalid' do
+
+        expect { checker.find({:archive => 'test'}) }.to raise_error MailHandler::Error
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -2,5 +2,78 @@ require 'spec_helper'
 
 describe MailHandler::Receiving::Notification::Email do
 
+  let(:search) { double('search') }
+  let(:sender) { double('sender') }
+  let(:notification) { MailHandler::Receiving::Notification::Email.new(sender, 'igor@example.com',1) }
+
+  before(:each) do
+
+    allow(sender).to receive(:send_email) { true }
+    allow(search).to receive(:max_duration) { 5 }
+
+  end
+
+  it '.create' do
+
+    aggregate_failures "init details" do
+
+      expect(notification.min_time_to_notify).to eq 1
+      expect(notification.max_time_to_notify).to eq nil
+      expect(notification.contacts).to eq 'igor@example.com'
+      expect(notification.sender).to eq sender
+
+    end
+
+  end
+
+  it '.notify' do
+
+    allow(search).to receive(:started_at) { Time.now }
+    notification.notify(search)
+    expect(notification.max_time_to_notify).to eq search.max_duration
+
+  end
+
+  context 'states' do
+
+    it 'no delay' do
+
+      allow(search).to receive(:started_at) { Time.now }
+      notification.notify(search)
+      expect(notification.current_state).to be_kind_of MailHandler::Receiving::Notification::NoDelay
+
+    end
+
+    it 'delayed' do
+
+      allow(search).to receive(:started_at) { Time.now - 2}
+      allow(search).to receive(:result) { false }
+      allow(notification).to receive(:send_email) { }
+      notification.notify(search)
+      expect(notification.current_state).to be_kind_of MailHandler::Receiving::Notification::Delay
+
+    end
+
+    it 'received' do
+
+      allow(search).to receive(:started_at) { Time.now - 2}
+      allow(search).to receive(:result) { true }
+      allow(notification).to receive(:send_email) { }
+      notification.notify(search)
+      expect(notification.current_state).to be_kind_of MailHandler::Receiving::Notification::Received
+
+    end
+
+    it 'max delayed' do
+
+      allow(search).to receive(:started_at) { Time.now - 10}
+      allow(search).to receive(:result) { false }
+      allow(notification).to receive(:send_email) { }
+      notification.notify(search)
+      expect(notification.current_state).to be_kind_of MailHandler::Receiving::Notification::MaxDelay
+
+    end
+
+  end
 
 end

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

@@ -19,7 +19,7 @@ describe MailHandler::Sending::PostmarkBatchAPISender do
 
   end
 
-  it '.send' do
+  it '.send - invalid auth' do
 
     sender = subject.new(api_token)
     expect{sender.send([Mail.new])}.to raise_error Postmark::InvalidApiKeyError

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

@@ -19,7 +19,7 @@ describe MailHandler::Sending::PostmarkAPISender do
 
   end
 
-  it '.send' do
+  it '.send - invalid auth' do
 
     sender = subject.new(api_token)
     expect{sender.send(Mail.new)}.to raise_error Postmark::InvalidApiKeyError

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

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe MailHandler::Sending::SMTPSender do
+
+  subject { MailHandler::Sending::SMTPSender }
+
+  context '.send' do
+
+    context 'invalid' do
+
+      it 'incorrect mail type' do
+
+        sender = subject.new
+        expect { sender.send('Test') }.to raise_error MailHandler::TypeError
+
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailhandler
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.0.18
 platform: ruby
 authors:
 - Igor Balos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-21 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -87,12 +87,14 @@ files:
 - spec/unit/mailhandler/receiver_spec.rb
 - spec/unit/mailhandler/receiving/base_spec.rb
 - spec/unit/mailhandler/receiving/folder_spec.rb
+- spec/unit/mailhandler/receiving/imap_spec.rb
 - spec/unit/mailhandler/receiving/notification/console_spec.rb
 - spec/unit/mailhandler/receiving/notification/email/content_spec.rb
 - spec/unit/mailhandler/receiving/notification/email_spec.rb
 - spec/unit/mailhandler/sender_spec.rb
 - spec/unit/mailhandler/sending/sender_api_batch_spec.rb
 - spec/unit/mailhandler/sending/sender_api_spec.rb
+- spec/unit/mailhandler/sending/sender_smtp_spec.rb
 - spec/unit/mailhandler_spec.rb
 homepage: https://github.com/wildbit/mailhandler
 licenses: