mailhandler 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba85d85b84b4c2e817d68569e19c27cbf69e04d5
-  data.tar.gz: d4f67dfcf82e2c85c085d3654902352469f4f5be
+  metadata.gz: 56df386f2849aba7d646aee2587fd5fa9231ad6b
+  data.tar.gz: 9d70e0d18c929d3901dc1fa7dcca275eb61c75bf
 SHA512:
-  metadata.gz: 6838dbf01a6b48e13ccd4e0397e4c236ee9757691c43e102662668bb3a41f03fbfb2f88a3b36f2f3eeb492abce5e4d91a9a8d86a0a89d70db06fb5b4908eae36
-  data.tar.gz: a8909cb9a470f336b5cf17d5e3fa2cb55cdbb9fb0efd3fc18fa6e2e92c8b8d28369828459aeea75e2766d03aa16e480b5ed03ad0e77f2d7b490fd3123c77a803
+  metadata.gz: d0b4fe86a6f9c41e5dd709883871c2cd3e542153325e8a767786e44528facc2ff34a4c1cc95ea9788dd429129ae4964c91b9a82e151bed1dc28a23190bd026f5
+  data.tar.gz: 05ec38a2fbc09c23e00b8e7587c6b3737393a7e58dac6aca10558db71275f87060099bac88edfa434b79343ac792c76ef348d3cfd82efc781dc61f476c6b4d3c

data/lib/mailhandler/receiving/base.rb

@@ -22,11 +22,16 @@ module MailHandler
 
       ]
 
+      DEFAULT_SEARCH_OPTIONS = [
+
+          :count, :archive
+      ]
+
       def initialize
 
         # Default number of email results to return, and whether to archive emails.
         @search_options = {:count => 50, :archive => false}
-        @found_emails = []
+        reset_found_emails
 
       end
 
@@ -36,19 +41,47 @@ module MailHandler
 
       end
 
+      def search_result
+
+        !found_emails.empty?
+
+      end
+
+      protected
+
       def verify_and_set_search_options(options)
 
+        validate_used_options(options)
+        validate_mandatory_options(options)
+
+        @search_options = search_options.merge options
+        reset_found_emails
+
+      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}"
         end
 
-        @search_options = search_options.merge options
+      end
+
+      def validate_mandatory_options(options)
+
+        search = AVAILABLE_SEARCH_OPTIONS - DEFAULT_SEARCH_OPTIONS
+
+        unless search.any? { |e| options[e] != nil }
+
+          raise StandardError, "At least one of the following search options has to be used: #{search}"
+
+        end
 
       end
 
-      def search_result
+      def reset_found_emails
 
-        !found_emails.empty?
+        @found_emails = []
 
       end
 

data/lib/mailhandler/receiving/imap.rb

@@ -19,7 +19,8 @@ module MailHandler
 
           :by_subject,
           :count,
-          :archive
+          :archive,
+          :by_recipient
 
       ]
 
@@ -34,17 +35,7 @@ module MailHandler
         verify_and_set_search_options(options)
         validate_options(options)
         init_retriever
-        emails = find_emails(search_options)
-
-        unless emails.empty?
-
-          emails.each do |email|
-
-            @found_emails << email if email.subject.include? search_options[:by_subject]
-
-          end
-
-        end
+        @found_emails = find_emails(search_options)
 
         search_result
 
@@ -94,14 +85,38 @@ module MailHandler
 
         if options[:archive]
 
-          Mail.find_and_delete(:what => :last, :count => search_options[:count], :order => :desc, :keys => ['SUBJECT', search_options[:by_subject]])
+          Mail.find_and_delete(:what => :last, :count => search_options[:count], :order => :desc, :keys => imap_filter_keys(options))
 
         else
 
-          Mail.find(:what => :last, :count => search_options[:count], :order => :desc, :keys => ['SUBJECT', search_options[:by_subject]])
+          Mail.find(:what => :last, :count => search_options[:count], :order => :desc, :keys => imap_filter_keys(options))
+
+        end
+
+      end
+
+      def imap_filter_keys(options)
+
+        keys = []
+
+        options.keys.each do |filter_option|
+
+          case filter_option
+
+            when :by_recipient
+
+              keys << options[:by_recipient].keys.first.to_s.upcase << options[:by_recipient].values.first
+
+            when :by_subject
+
+              keys << 'SUBJECT' << options[:by_subject]
+
+          end
 
         end
 
+        keys
+
       end
 
       def validate_options(options)

data/lib/mailhandler/version.rb

@@ -1,5 +1,5 @@
 module MailHandler
 
-  VERSION = '1.0.6'
+  VERSION = '1.0.7'
 
 end

data/spec/data/email1.txt

@@ -0,0 +1,11 @@
+Date: Tue, 13 Oct 2015 14:12:52 +0200
+From: igor@example.com
+To: igor1@example.com
+Message-ID: <561cf544ef064_c1863ffde50601f859577@Igors-MacBook-Pro.local.mail>
+Subject: test email 1878271
+Mime-Version: 1.0
+Content-Type: text/plain;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+test body 1878271

data/spec/data/email2.txt

@@ -0,0 +1,11 @@
+Date: Tue, 13 Oct 2015 14:12:52 +0200
+From: igor@example.com
+To: igor2@example.com
+Message-ID: <561cf544ef064_c1863ffde50601f859577@Igors-MacBook-Pro.local.mail>
+Subject: test email 1878275
+Mime-Version: 1.0
+Content-Type: text/plain;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+test body 1878275

data/spec/spec_helper.rb

@@ -7,6 +7,12 @@ require 'mailhandler'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+def data_folder
+
+  File.join(File.dirname(__FILE__), '/', 'data')
+
+end
+
 RSpec.configure do |c|
 
   # Use the specified formatter, options are: # :documentation, :progress, :html, :textmate

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

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe MailHandler::Receiving::Checker do
+
+  subject { MailHandler::Receiving::Checker.new }
+
+  it '.create' do
+
+    is_expected.to be_kind_of MailHandler::Receiving::Checker
+
+  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
+    end
+
+  end
+
+end

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

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+describe MailHandler::Receiving::FolderChecker do
+
+  subject { MailHandler::Receiving::FolderChecker.new }
+
+  it '.create' do
+
+    is_expected.to be_kind_of MailHandler::Receiving::Checker
+
+  end
+
+  context 'search emails' do
+
+    let(:checker) { MailHandler::Receiving::FolderChecker.new(data_folder, data_folder) }
+
+    context '.find email' do
+
+      context 'search options' do
+
+        it 'default' do
+
+          checker.find({:by_subject => 'test'})
+          expect(checker.search_options).to eq({:count=>50, :archive=>false, :by_subject=>'test'})
+
+        end
+
+      end
+
+      context 'not found' do
+
+        it 'result' do
+
+          expect(checker.find({:by_subject => 'test123'})).to be false
+
+        end
+
+        it 'by subject' do
+
+          checker.find({:by_subject => 'test123'})
+          expect(checker.found_emails).to be_empty
+
+        end
+
+        it 'by date' do
+
+          checker.find({:by_date => Time.now + 86400})
+          expect(checker.found_emails).to be_empty
+
+        end
+
+        it 'by recipient' do
+
+          checker.find({:by_recipient => { to: 'igor@example.com'} })
+          expect(checker.found_emails).to be_empty
+
+        end
+        
+      end
+
+      context 'found' 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")}
+
+        it 'result' do
+
+          expect(checker.find({:by_subject => mail1.subject})).to be true
+
+        end
+
+        it 'by subject - single' do
+
+          checker.find({:by_subject => mail1.subject})
+
+          aggregate_failures "found mail details" do
+            expect(checker.found_emails.size).to be 1
+            expect(checker.found_emails.first).to eq mail1
+            expect(checker.found_emails).not_to include mail2
+          end
+
+        end
+
+        it 'by subject - multiple' do
+
+          checker.find({:by_subject => 'test'})
+
+          aggregate_failures "found mail details" do
+            expect(checker.found_emails.size).to be 2
+            expect(checker.found_emails).to include mail1
+            expect(checker.found_emails).to include mail2
+          end
+
+        end
+
+        it 'by count' do
+
+          checker.find({:by_subject => 'test', :count => 1})
+          expect(checker.found_emails.size).to be 1
+
+        end
+
+        it 'by date' do
+
+          checker.find({:by_date => Time.new(2015,10,12,13,30,0, "+02:00")})
+          expect(checker.found_emails.size).to be 2
+
+        end
+
+        it 'by recipient' do
+
+          checker.find({:by_recipient => { to: 'igor1@example.com'} })
+          expect(checker.found_emails.size).to be 1
+
+          checker.find({:by_recipient => { to: 'igor2@example.com'} })
+          expect(checker.found_emails.size).to be 1
+
+        end
+
+        context 'archiving emails' do
+
+          after(:each) {
+
+            FileUtils.rm_r "#{data_folder}/checked", :force => true
+
+          }
+
+          let(:mail) {
+
+            mail = Mail.read_from_string(File.read "#{data_folder}/email2.txt")
+            mail.subject = 'test 872878278'
+            File.open("#{data_folder}/email3.txt",  "w") { |file| file.write(mail) }
+            mail
+
+          }
+
+          let(:checker_archive) { MailHandler::Receiving::FolderChecker.new(data_folder, "#{data_folder}/checked") }
+
+          it 'to same folder - delete' do
+
+            checker.find({:by_subject => mail.subject, :archive => true})
+            expect(checker.found_emails.size).to be 1
+
+            checker.find({:by_subject => mail.subject, :archive => true})
+            expect(checker.found_emails).to be_empty
+
+
+          end
+
+          it 'to separate folder' do
+
+            checker_archive.find({:by_subject => mail.subject, :archive => true})
+            expect(checker_archive.found_emails.size).to be 1
+
+            checker_archive.find({:by_subject => mail.subject, :archive => true})
+            expect(checker_archive.found_emails).to be_empty
+
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailhandler
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Igor Balos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -75,8 +75,12 @@ files:
 - lib/mailhandler/version.rb
 - mailhandler.gemspec
 - readme.md
+- spec/data/email1.txt
+- spec/data/email2.txt
 - spec/spec_helper.rb
 - spec/unit/mailhandler/receiver_spec.rb
+- spec/unit/mailhandler/receiving/base_spec.rb
+- spec/unit/mailhandler/receiving/folder_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