mailhandler 1.0.18 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 083df235cda02401f6ed87e997e235def311840e
-  data.tar.gz: bbc739fa0de274bb0d87733a418346d796526c3f
+  metadata.gz: ecef71152a0c0d0fe88836302a0a1d21943aa982
+  data.tar.gz: cad86ec06626c41396a2c5cc62c458cc1206b28a
 SHA512:
-  metadata.gz: a067e385d21369f0eef498fc2c6f3843fe40ccb134f917e0b32b5e344660b8c7812f834b5cdba0e73e6c8c7f5760e21edc8e0d827496f8057f8160e9cc6d2c8c
-  data.tar.gz: 3b5f4dac54ef936fd3976dc847bfe82691c5656032bf243e57c5f9186ec37d294f256f69bf5e1aaf77a562bf5d0537e2f17385dca406f9d3ba08eb116f719186
+  metadata.gz: 969fd41cda3bd806293f955545b8b424cbb3da04bbab0353267de32ecc3db2f06f7e09bf4c557e96c8ad03bc1244558582fb2a624002ad57d7b4c6668199d43d
+  data.tar.gz: 129595a692c4e5bed2cc34f6bba7099f419cec6ae76ffde2049a0e658867b432391b9059ef9eb97efad0f7f714fd3433faa16b00a608004e3124c430d905e9b9

data/lib/mailhandler/receiving/base.rb

@@ -87,6 +87,12 @@ module MailHandler
 
         end
 
+        if options[:by_recipient]
+
+          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)

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

@@ -5,58 +5,59 @@ module MailHandler
 
   module Receiving
 
-    module Filter
+    class FileList
 
-      class Base
+      def self.get(pattern)
 
-        def Base.sort(files)
+        Dir.glob(pattern).map { |file| File.absolute_path(file) }
 
-          swapped = true
-          j = 0
+      end
+
+      def self.sort(files)
 
-          while swapped do
+        swapped = true
+        j = 0
 
-            swapped = false
-            j+=1
+        while swapped do
 
-            (files.size - j).times do |i|
+          swapped = false
+          j+=1
 
-              if File.new(files[i]).ctime < File.new(files[i + 1]).ctime
-                tmp = files[i]
-                files[i] = files[i + 1]
-                files[i + 1] = tmp
-                swapped = true
+          (files.size - j).times do |i|
 
-              end
+            if File.new(files[i]).ctime < File.new(files[i + 1]).ctime
+              tmp = files[i]
+              files[i] = files[i + 1]
+              files[i + 1] = tmp
+              swapped = true
 
             end
 
           end
 
-          files
-
         end
 
-        def get(pattern)
-
-          files = []
-          Dir.glob(pattern).each { |file| files << File.absolute_path(file) }
-          files
+        files
 
-        end
+      end
 
-        protected
+    end
 
-        def read_email(content)
+  end
 
-          Mail.read_from_string(content)
+end
 
-        end
+=begin
 
-      end
+TEST EXAMPLE
 
-    end
+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
 
-  end
+f = FileList::Filter::ByEmailSubject.new(FileList.get("*.*"), "binding")
+puts f.get
 
-end
+=end

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

@@ -5,166 +5,134 @@ module MailHandler
 
   module Receiving
 
-    module Filter
+    class FileList
 
-      class ByFilename < Base
+      module Filter
 
-        def get(pattern)
+        class Base
 
-          super(pattern)
+          attr_accessor :files
 
-        end
-
-      end
-
-      class ContentBase < Base
-
-        def initialize(content)
-
-          @content = content.to_s
+          def initialize(files)
 
-        end
-
-        protected
+            @files=files
 
-        def filter_files(files)
+          end
 
-          files.select do |file|
+          def get
 
-            begin
+            files.select { |file| ignore_exception { meets_expectation?(file) } }
 
-              file_match_filter?(file)
+          end
 
-            rescue
+          protected
 
-              # return false if error occurred or content was not found
-              false
+          def meet_expectation?(file)
 
-            end
+            raise StandardError, 'Needs to be implemented.'
 
           end
 
-        end
+          def read_file(file)
 
-        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)
 
-          raise StandardError, 'Not implemented'
+          end
 
-        end
+          private
 
-      end
+          def ignore_exception
 
-      class BySubject < ContentBase
+            begin
 
-        def initialize(content)
+              yield
 
-          super(content)
+            rescue
 
-        end
+              false
 
-        def get(pattern)
+            end
 
-          files = super(pattern)
-          filter_files(files)
+          end
 
         end
 
-        private
-
-        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
+        class ByDate < Base
 
-        end
-
-      end
+          def initialize(files, date)
 
-      class ByContent < ContentBase
+            super(files)
+            @date = date
 
-        def initialize(content)
+          end
 
-          super(content)
+          private
 
-        end
+          def meets_expectation?(file)
 
-        def get(pattern)
+            (File.exists? file)? (File.ctime file) > @date : false
 
-          files = super(pattern)
-          filter_files(files)
+          end
 
         end
 
-        private
+        class Email < Base
 
-        def file_match_filter?(file)
+          def initialize(files)
 
-          File.read(file).include? @content
+            super(files)
 
-        end
+          end
 
-      end
+          protected
 
-      class ByDate < ContentBase
+          def read_email_from_file(file)
 
-        def initialize(date)
+            Mail.read(file)
 
-          @date = date
+          end
 
         end
 
-        def get(pattern)
-
-          files = super(pattern)
-          filter_files(files)
+        class ByEmailContent < Email
 
-        end
-
-        private
+          def initialize(files, content)
 
-        def file_match_filter?(file)
+            super(files)
+            @content = content
 
-          file = File.new(file)
-          if file != nil
+          end
 
-            file.ctime > @date
+          protected
 
-          else
+          def meets_expectation?(file)
 
-            false
+            read_file(file).include? @content
 
           end
 
         end
 
-      end
-
-      module Email
+        class ByEmailSubject < ByEmailContent ; end
 
-        class ByRecipient < ContentBase
+        class ByEmailRecipient < Email
 
-          def initialize(recipient)
+          def initialize(files, recipient)
 
+            super(files)
             @recipient = recipient
 
           end
 
-          def get(pattern)
-
-            files = super(pattern)
-            filter_files(files)
-
-          end
-
           private
 
-          def file_match_filter?(file)
+          def meets_expectation?(file)
 
-            email = read_email(File.read(file))
-            email[@recipient.keys.first].to_s.include? @recipient.values.first
+            read_email_from_file(file)[@recipient.keys.first].to_s.include? @recipient.values.first
 
           end
 

data/lib/mailhandler/receiving/folder.rb

@@ -45,10 +45,10 @@ module MailHandler
       # filter options which need to be done by searching files
       FILE_SEARCH_CLASSES = {
 
-          :by_subject => Filter::BySubject,
-          :by_content => Filter::ByContent,
-          :since => Filter::ByDate,
-          :by_recipient => Filter::Email::ByRecipient
+          :by_subject => FileList::Filter::ByEmailSubject,
+          :by_content => FileList::Filter::ByEmailContent,
+          :since => FileList::Filter::ByDate,
+          :by_recipient => FileList::Filter::ByEmailRecipient
       }
 
       def search_pattern
@@ -59,7 +59,7 @@ module MailHandler
 
       def read_found_emails(files, count)
 
-        files.first(count).map { |file| Mail.read_from_string(File.read(file)) }
+        files.first(count).map { |file| Mail.read(file ) }
 
       end
 
@@ -67,15 +67,15 @@ module MailHandler
       # this will ignore filter criteria options which can't be done on files directly
       def find_files(options)
 
-        files = Filter::Base.new.get(search_pattern)
+        files = FileList.get(search_pattern)
 
         options.each do |key, value|
 
-          files = (files & FILE_SEARCH_CLASSES[key].new(value).get(search_pattern)) if FILE_SEARCH_CLASSES[key] != nil
+          files = FILE_SEARCH_CLASSES[key].new(files, value).get if FILE_SEARCH_CLASSES[key] != nil
 
         end
 
-        Filter::Base.sort(files)
+        FileList.sort(files)
 
       end
 

data/lib/mailhandler/version.rb

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

data/readme.md

@@ -1,11 +1,13 @@
+<img src="http://assets.wildbit.com/postmark/blog/images/mailhandler-logo.png" alt="MailHandler Logo" title="MailHandler" width="148" height="149">
+
 # MailHandler Gem
 
 [![Build Status](https://travis-ci.org/wildbit/mailhandler.svg?branch=master)](https://travis-ci.org/wildbit/mailhandler)
 
-MailHandler is a simple wrapper on top of [mail gem](https://github.com/mikel/mail) and [postmark gem](https://github.com/wildbit/postmark-gem) libraries which allows you to send and retrieve emails and get details on how long these operations took.
+MailHandler is a simple wrapper on top of [Mail gem](https://github.com/mikel/mail) and [Postmark gem](https://github.com/wildbit/postmark-gem) libraries. It allows you to send and retrieve emails and at the same time get details on how long these operations took.
 Main purpose of the gem is easier email sending/delivery testing with notifications if sending or retrieving email is taking too long. 
 
-The library supports sending email by SMTP and Postmark API and checking email delivery by IMAP protocol, or by folder, if you have a local mailbox. 
+The library supports sending email by SMTP and Postmark API and checking email delivery by IMAP protocol, or by folder if you have a local mailbox. 
 
 # Install the gem
 
@@ -32,8 +34,8 @@ Folders can be the same if you don't plan to archive found emails. Retrieving em
 
 ``` ruby
 email_receiver = MailHandler.receiver(:folder) do |checker|
-    checker.inbox_folder = folder_of_your_inbox
-    checker.archive_folder = folder_of_your_inbox_archive_folder
+    checker.inbox_folder = '/folder/mailbox/'
+    checker.archive_folder = '/folder/mailbox/archive/'
 end
 ```  
 
@@ -126,7 +128,7 @@ email_sender = MailHandler.sender(type) do |dispatcher|
 end
 ```
 
-* `:type` - type can be `:postmark_api` or `postmark_batch_api`
+* `:type` - type can be `:postmark_api` or `:postmark_batch_api`
 * `:api_token` - api token of one of your Postmark sending servers 
   
 ### Sending email by SMTP

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

@@ -22,14 +22,14 @@ describe MailHandler::Receiving::FolderChecker do
         it 'by multiple search options' do
 
           time = Time.now
-          checker.find({:by_subject => 'test', :by_content => 'test', :since => time, :by_recipient => 'igor@example.com'})
+          checker.find({:by_subject => 'test', :by_content => 'test', :since => time, :by_recipient => { :to => 'igor@example.com'}})
           expect(checker.search_options).to eq(
                                                 {:count=>50,
                                                  :archive=>false,
                                                  :by_subject => 'test',
                                                  :by_content => 'test',
                                                  :since => time,
-                                                 :by_recipient => 'igor@example.com'})
+                                                 :by_recipient => {:to => 'igor@example.com'}})
 
         end
 
@@ -78,8 +78,8 @@ describe MailHandler::Receiving::FolderChecker do
 
         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' })
+          checker.find({:by_recipient => {:to => 'igor@example.com'}})
+          expect(checker.search_options).to eq({:count=>50, :archive=>false, :by_recipient =>  {:to => 'igor@example.com' }})
 
         end
 
@@ -321,5 +321,4 @@ describe MailHandler::Receiving::FolderChecker do
 
   end
 
-
 end

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

@@ -28,13 +28,13 @@ describe MailHandler::Receiving::IMAPChecker do
 
     it 'by multiple search options' do
 
-      checker.find({:by_subject => 'test', :by_content => 'test', :by_recipient => 'igor@example.com'})
+      checker.find({:by_subject => 'test', :by_content => 'test', :by_recipient => {:to => 'igor@example.com'}})
       expect(checker.search_options).to eq(
                                             {:count=>50,
                                              :archive=>false,
                                              :by_subject => 'test',
                                              :by_content => 'test',
-                                             :by_recipient => 'igor@example.com'})
+                                             :by_recipient => {:to => 'igor@example.com'}})
 
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailhandler
 version: !ruby/object:Gem::Version
-  version: 1.0.18
+  version: 1.0.19
 platform: ruby
 authors:
 - Igor Balos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail