mailhandler 1.0.36 → 1.0.37

data/lib/mailhandler/sending/api.rb

@@ -3,11 +3,8 @@ require 'postmark'
 require_relative 'base.rb'
 
 module MailHandler
-
   module Sending
-
     class PostmarkAPISender < Sender
-
       attr_accessor :host,
                     :api_token,
                     :use_ssl,
@@ -43,10 +40,7 @@ module MailHandler
 
       protected
 
-      DEFAULT_HOST = 'api.postmarkapp.com'
-
+      DEFAULT_HOST = 'api.postmarkapp.com'.freeze
     end
-
   end
-
 end

data/lib/mailhandler/sending/api_batch.rb

@@ -2,35 +2,23 @@ require_relative 'api.rb'
 require_relative '../errors'
 
 module MailHandler
-
   module Sending
-
     class PostmarkBatchAPISender < PostmarkAPISender
-
       def initialize(api_token = nil)
-
         super(api_token)
-
       end
 
       def send(emails)
-
         verify_email(emails)
         init_client
         client.deliver_messages(emails)
-
       end
 
       protected
 
       def verify_email(emails)
-
-        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? allowed_email_type }
-
+        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? allowed_email_type }
       end
-
     end
-
   end
-
 end

data/lib/mailhandler/sending/base.rb

@@ -1,37 +1,25 @@
 require_relative '../errors'
 
 module MailHandler
-
   module Sending
-
     class Sender
-
       attr_reader :type
 
-      def send(email)
-
+      def send(_email)
         raise MailHandler::InterfaceError, 'Send interface not implemented.'
-
       end
 
       protected
 
       def verify_email(email)
-
         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
-
     end
-
   end
-
 end

data/lib/mailhandler/sending/smtp.rb

@@ -1,14 +1,11 @@
-# encoding: utf-8
+
 require 'net/imap'
 require_relative 'base'
 
 module MailHandler
-
   module Sending
-
     # class which describes methods to send and receive emails
     class SMTPSender < Sender
-
       attr_accessor :address,
                     :port,
                     :domain,
@@ -17,45 +14,46 @@ module MailHandler
                     :authentication,
                     :use_ssl
 
-      def initialize
+      attr_accessor :open_timeout,
+                    :read_timeout,
+                    :save_response
 
+      def initialize
         @type = :smtp
         @authentication = 'plain'
         @use_ssl = false
+        @save_response = false
 
+        @open_timeout = 60
+        @read_timeout = 60
       end
 
       def send(email)
-
         verify_email(email)
         email = configure_sending(email)
-        email.deliver
-
+        save_response ? email.deliver! : email.deliver
       end
 
       private
 
       def configure_sending(email)
-
         options = {
-
-            :address => address,
-            :port => port,
-            :domain => domain,
-            :user_name => username,
-            :password => password,
-            :authentication => @authentication,
-            :enable_starttls_auto => @use_ssl
-
+          address: address,
+          port: port,
+          domain: domain,
+          user_name: username,
+          password: password,
+          authentication: @authentication,
+          enable_starttls_auto: @use_ssl,
+
+          return_response: save_response,
+          open_timeout: open_timeout,
+          read_timeout: read_timeout
         }
 
         email.delivery_method :smtp, options
         email
-
       end
-
     end
-
   end
-
 end

data/lib/mailhandler/version.rb

@@ -1,3 +1,3 @@
 module MailHandler
-  VERSION = '1.0.36'
-end
+  VERSION = '1.0.37'.freeze
+end

data/mailhandler.gemspec

@@ -1,37 +1,34 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mailhandler/version'
 
 Gem::Specification.new do |s|
-
   s.name        = 'mailhandler'
   s.version     = MailHandler::VERSION
   s.platform    = Gem::Platform::RUBY
   s.license     = 'MIT'
 
-  s.authors     = ["Igor Balos"]
-  s.email       = ["ibalosh@gmail.com", "igor@wildbit.com"]
+  s.authors     = ['Igor Balos']
+  s.email       = ['ibalosh@gmail.com', 'igor@wildbit.com']
 
-  s.summary     = "Postmark email receiving and sending handler."
-  s.description = "Use this gem to send emails through SMTP and Postmark API. Check if email arrived by imap or folder check."
+  s.summary     = 'Postmark email receiving and sending handler.'
+  s.description = 'Use this gem to send emails through SMTP and Postmark API. Check if email arrived by imap or folder check.'
 
-
-  s.files       = `git ls-files`.split($/)
+  s.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.test_files  = `git ls-files -- {spec}/*`.split("\n")
   s.homepage    = 'https://github.com/wildbit/mailhandler'
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.post_install_message = %q{
+  s.post_install_message = '
     ==================
     Thanks for installing the mailhandler gem.
     Review the README.md for implementation details and examples.
     ==================
-  }
-
-  s.required_rubygems_version = ">= 1.9.3"
+  '
 
-  s.add_dependency "mail"
-  s.add_dependency "postmark", '>= 1.7.0'
+  s.required_rubygems_version = '>= 1.9.3'
 
-end
+  s.add_dependency 'mail'
+  s.add_dependency 'postmark', '>= 1.7.0'
+end

data/readme.md

@@ -33,23 +33,36 @@ In order to search for email, all you need to do is setup inbox folder and archi
 Folders can be the same if you don't plan to archive found emails. Retrieving emails from a folder would look like following:
 
 ``` ruby
+
+inbox_folder = '/folder/mailbox/inbox'
+archive_folder = '/folder/mailbox/archive/'
+
 email_receiver = MailHandler.receiver(:folder) do |checker|
-    checker.inbox_folder = '/folder/mailbox/'
-    checker.archive_folder = '/folder/mailbox/archive/'
+    checker.inbox_folder = inbox_folder
+    checker.archive_folder = archive_folder
 end
 ```  
 
 ## Configure imap mailbox email to check
 
-If you plan to search for emails in your remote inbox which support IMAP, you can use Mailhandler with provided IMAP settings: 
+If you plan to search for emails in your remote inbox which supports IMAP, you can use Mailhandler by providing IMAP settings.
+We recommend to keep credentials for your IMAP settings safe, and read them from config file or environment variables.
+Do NOT keep credentials in your repositories. 
  
 ``` ruby
+
+address = 'imap.example.com'
+port = 993
+username = 'john'
+password = 'xxxxxxxxxxxxxx'
+use_ssl = true
+
 email_receiver = MailHandler.receiver(:imap) do |checker|
-  checker.address = 'imap.example.com'
-  checker.port = 993
-  checker.username = 'username'
-  checker.password = 'password'
-  checker.use_ssl  =  true
+  checker.address = address
+  checker.port = port
+  checker.username = username
+  checker.password = password
+  checker.use_ssl  =  use_ssl
 end
 ``` 
 
@@ -124,6 +137,8 @@ There are three ways you can send email, which we will describe below. To send e
 To send email with Postmark, you need to choose type of sending, api token options.
  
 ``` ruby
+api_token = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+
 email_sender = MailHandler.sender(type) do |dispatcher|
     dispatcher.api_token = api_token
 end
@@ -135,8 +150,18 @@ end
 ### Sending email by SMTP
 
 To send email with SMTP you need to configure standard SMTP settings.
+We recommend to keep credentials for your SMTP settings safe, and read them from config file or environment variables.
+Do NOT keep credentials in your repositories. 
 
 ``` ruby
+
+address = 'imap.example.com'
+domain = 'example.com'
+port = 587
+username = 'john'
+password = 'xxxxxxxxxxxxxx'
+use_ssl = true
+
 email_sender = MailHandler.sender(:smtp) do |dispatcher|
     dispatcher.address = address
     dispatcher.port = port

data/spec/spec_helper.rb

@@ -8,15 +8,11 @@ $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
   c.formatter = :documentation
   c.color = true
-
-end
+end

data/spec/unit/mailhandler/receiver_spec.rb

@@ -1,13 +1,11 @@
 require 'spec_helper'
 
 describe MailHandler::Receiver do
-
   context 'valid receiver' do
-
-    let(:default_search_option) { {:by_subject => 'test'} }
+    let(:default_search_option) { { by_subject: 'test' } }
     let(:receiving_duration) { 5 }
     let(:found_email) { Mail.new { subject 'test email' } }
-    let(:checker) {
+    let(:checker) do
       checker = double('Checker')
 
       allow(checker).to receive(:find) { sleep receiving_duration; true }
@@ -17,43 +15,33 @@ describe MailHandler::Receiver do
       allow(checker).to receive(:start) { nil }
       allow(checker).to receive(:stop) { nil }
       checker
-
-    }
+    end
     subject(:receiver) { MailHandler::Receiver.new(checker) }
 
     context 'att readers' do
-
       it { is_expected.to respond_to(:checker) }
       it { is_expected.to respond_to(:search) }
       it { is_expected.to respond_to(:max_search_duration) }
-
     end
 
     context 'att writters' do
-
       it { is_expected.to respond_to(:checker=) }
       it { is_expected.to respond_to(:search=) }
       it { is_expected.to respond_to(:max_search_duration=) }
-
     end
 
     it 'create' do
-
       is_expected.to be_kind_of MailHandler::Receiver
-
     end
 
     it '.find_email' do
-
       expect(receiver.find_email(default_search_option)).to be true
-
     end
 
     it '.search' do
-
       receiver.find_email(default_search_option)
 
-      aggregate_failures "search details" do
+      aggregate_failures 'search details' do
         expect(receiver.search.options).to eq default_search_option
         expect(receiver.search.started_at).to be_within(1).of(Time.now - receiving_duration)
         expect(receiver.search.finished_at).to be_within(1).of(Time.now)
@@ -62,12 +50,10 @@ describe MailHandler::Receiver do
         expect(receiver.search.emails).to eq [found_email]
         expect(receiver.search.email).to eq found_email
       end
-
     end
 
     context '.search' do
-
-      let(:checker) {
+      let(:checker) do
         checker = double('Checker')
 
         allow(checker).to receive(:find) { sleep 1; false }
@@ -77,24 +63,16 @@ describe MailHandler::Receiver do
         allow(checker).to receive(:start) { nil }
         allow(checker).to receive(:stop) { nil }
         checker
+      end
 
-      }
-
-      [1,3,5].each do |duration|
-
+      [1, 3, 5].each do |duration|
         it "max duration - #{duration} seconds" do
-
           receiver.max_search_duration = duration
           receiver.find_email(default_search_option)
 
           expect(receiver.search.duration).to be_within(1).of(duration)
-
         end
-
       end
-
     end
-
   end
-
-end
+end

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

@@ -1,35 +1,25 @@
 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})
+    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
 
   it '.find' do
-
-    expect { subject.find(:by_subject => 'test') }.to raise_error(MailHandler::InterfaceError, 'Find interface not implemented.')
-
+    expect { subject.find(by_subject: 'test') }.to raise_error(MailHandler::InterfaceError, 'Find interface not implemented.')
   end
 
   it '.search_result' do
-
     expect(subject.search_result).to be false
-
   end
-
-end
+end