mailhandler 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad4de21ce6ad278dd2916e5cb898691c10961b87
-  data.tar.gz: caedb45d153cbfa44d41b13328a9afb20c81b2fa
+  metadata.gz: 9d007dfe2c9742d1099adc9d58f156bb147c9350
+  data.tar.gz: 5d6a258c2706b9718379cf5ec101723f686010bd
 SHA512:
-  metadata.gz: a0da923ce9b696ca05ce4cc1b322678bd272b44227ca25a330239375fac65c3bdddbe3fbc08b6b425a27b89c24907b4a48fd259a5a99cec88f5e4ac6f165f8c4
-  data.tar.gz: 7667ee7a964c55262104b954abd8289f7855b4107056041587702d76dbecab016425b139d49a3989ddcc53d7a905d781c029f39ca339cb122278d75542c46eae
+  metadata.gz: ec4bee8fcdbcbc9444e9b12a0cc328128971836e6ec435f4309784d3c619afac4b250b9e9d71772a7cecef69993d2c0163be61f515a0d9de53f089831f3596ff
+  data.tar.gz: 4b61c6b691b1c016ffd64c0411a91480f3fe5fa82744e6a6fd4a6d79ebea19c5cda1b2caa3ecff8b43bb04bc678926a6d41d0b08e052de4343d4420c6105e9ba

data/Gemfile

@@ -0,0 +1,7 @@
+# A sample Gemfile
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'mail'
+gem 'postmark'
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    json (1.8.3)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.2)
+    postmark (1.7.0)
+      json
+      rake
+    pry (0.10.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mail
+  postmark
+  pry
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:default)

data/lib/mailhandler/receiving/checker.rb

@@ -27,7 +27,7 @@ module MailHandler
       def initialize
 
         # Default number of email results to return, and whether to archive emails.
-        @search_options = {:count => 10, :archive => false}
+        @search_options = {:count => 50, :archive => false}
 
       end
 

data/lib/mailhandler/sending/sender_api.rb

@@ -12,12 +12,12 @@ module MailHandler
                     :api_token,
                     :use_ssl
 
-      def initialize(host = nil, api_token = nil, use_ssl = false)
+      def initialize(api_token = nil)
 
         @type = :postmark_api
-        @host = host
+        @host = DEFAULT_HOST
         @api_token = api_token
-        @use_ssl = use_ssl
+        @use_ssl = false
 
       end
 
@@ -30,6 +30,8 @@ module MailHandler
 
       protected
 
+      DEFAULT_HOST = 'api.postmarkapp.com'
+
       def setup_sending_client
 
         # clearing cache so valid host is accepted, and not the cached one

data/lib/mailhandler/version.rb

@@ -1,5 +1,5 @@
 module MailHandler
 
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 
 end

data/mailhandler.gemspec

@@ -18,8 +18,17 @@ 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/ibalosh'
   s.require_paths = ["lib"]
+
+  s.post_install_message = %q{
+    ==================
+    Thanks for installing the mailhandler gem.
+    Review the README.md for implementation details and examples.
+    ==================
+  }
+
   s.required_rubygems_version = ">= 1.8.7"
 
   s.add_dependency "mail"

data/readme.md

@@ -1,8 +1,11 @@
 # MailHandler Gem
 
-This gem represents a simple library which allows you to send email and check email delivery. 
-The library supports sending SMTP, Postmark API or Postmark Batch API, checking email delivery by IMAP, or by folder, 
-if you have a local mailbox. 
+[![Build Status](https://travis-ci.org/ibalosh/MailHandler.svg?branch=master)](https://travis-ci.org/ibalosh/MailHandler)
+
+MailHandler is a simple wrapper for [mail](https://github.com/mikel/mail) and [postmark](https://github.com/wildbit/postmark-gem) libraries which allows you to send and retrieve emails, 
+and get more details about email sending and delivery. Main purpose of the gem is easier email sending/delivery testing. 
+
+The library supports sending by SMTP, Postmark API and checking email delivery by IMAP protocol, or by folder, if you have a local mailbox. 
 
 # Install the gem
 
@@ -22,6 +25,9 @@ gem install mailhandler
 
 ## Configure local mailbox email to check
 
+Checking emails locally option can be used when you have emails stored in certain local path. In order to search for email, all you need to do is setup inbox and archive folder.
+They can be the same if you don't plan to archive checked files.
+
 ``` ruby
 email_receiver = MailHandler::Handler.receiver(:folder) do |checker|
     checker.inbox_folder = folder_of_your_inbox
@@ -30,6 +36,8 @@ end
 ```  
 
 ## Configure imap mailbox email to check
+
+If you plan to check for an email in your inbox which support IMAP, you can use mailhandler with provided IMAP settings. 
  
 ``` ruby
 email_receiver = MailHandler::Handler.receiver(:imap) do |checker|
@@ -79,7 +87,7 @@ Once email searching is finished, you can check search result by looking at: `em
 # Email search notifications
 
 While searching for an email, there is a possibility to get notification if emails sending is taking too long. 
-You can get an notification in console, by email or both.
+You can get an notification in console, by email or both. Console output is good if you are testing email delivery, and want to see how long its taking for email to arrive in console.
 
 To add notifications to email searching all you need to do is:
 
@@ -88,7 +96,7 @@ email_receiver.add_observer(MailHandler::Receiving::Notification::Email.new(emai
 email_receiver.add_observer(MailHandler::Receiving::Notification::Console.new)
 ``` 
 
-the parameters you need are:
+For email notifications, the parameters you need are:
 
 * `email_sender` - email sender you will use for sending an email (it should be one of senders described below)
 * `contacts` - list of contacts to receive the notification (for example: `john@example.com, igor@example.com`
@@ -103,20 +111,16 @@ To send email you can use SMTP protocol or Postmark.
 
 ### Send by Postmark API 
 
-To send email with Postmark, you need to choose type of sending, host, api token, and ssl options.
+To send email with Postmark, you need to choose type of sending, api token options.
  
 ``` ruby
 email_sender = MailHandler::Handler.sender(type) do |dispatcher|
-    dispatcher.host = host
     dispatcher.api_token = api_token
-    dispatcher.use_ssl = use_ssl
 end
 ```
 
 * `:type` - type can be `:postmark_api` or `postmark_batch_api`
-* `:host` - host is `api.postmarkapp.com`
 * `:api_token` - api token of one of your Postmark sending servers 
-* `:use_ssl` - can be true/false
   
 ### Sending email by SMTP
 
@@ -131,7 +135,17 @@ email_sender = MailHandler::Handler.sender(:smtp) do |dispatcher|
     dispatcher.password = password
     dispatcher.use_ssl = use_ssl
 end
-``` 
+```
+ 
+### Sending email
+ 
+Once you have setup your email sender, all you need to do is to send an email:
+
+``` ruby
+email_sender.send_email(email)
+```
+
+email has to be an email created with Mail gem. In order to send emails by Postmark batch, you will need to provide an Array of emails.
 
 ## Sending results
  

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+require 'mail'
+require 'postmark'
+require 'pry'
+require 'mailhandler'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+RSpec.configure do |c|
+
+  # Use the specified formatter, options are: # :documentation, :progress, :html, :textmate
+  c.formatter = :documentation
+  c.color = true
+
+end

data/spec/unit/mailhandler/receiver_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe MailHandler::Receiver do
+
+  subject { MailHandler::Receiver }
+  let(:default_search_option) { {:by_subject => 'test'} }
+  let(:receiving_duration) { 5 }
+  let(:checker) {
+    checker = double('Checker')
+
+    allow(checker).to receive(:find) { sleep receiving_duration ; true }
+    allow(checker).to receive(:search_result) { true }
+    allow(checker).to receive(:found_emails) { [] }
+    checker
+
+  }
+  
+  it '.find_email' do
+
+    receiver = subject.new(checker)
+    expect(receiver.find_email(default_search_option)).to be true
+
+  end
+
+  it '.search object' do
+
+    receiver = subject.new(checker)
+    receiver.find_email(default_search_option)
+
+    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)
+      expect(receiver.search.duration).to be_within(0.5).of(receiving_duration)
+      expect(receiver.search.result).to be true
+      expect(receiver.search.emails).to eq []
+    end
+
+  end
+
+end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe MailHandler::Receiving::Notification::Console do
+
+  subject { MailHandler::Receiving::Notification::Console  }
+
+  context 'notify of a delay' do
+
+    it '.notify' do
+
+      search = double('Search', :started_at => Time.now - 10)
+      expect{ subject.new.notify(search) }.to output(/.+email delay: 0(9|1)0 seconds/).to_stdout
+
+    end
+
+  end
+
+  context 'not notify of a delay' do
+
+    it '.notify' do
+
+      search = double('Search', :started_at => Time.now + 5)
+      expect{ subject.new.notify(search) }.to output('').to_stdout
+
+    end
+
+  end
+
+end

data/spec/unit/mailhandler/receiving/notification/email/content_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe MailHandler::Receiving::Notification::EmailContent do
+
+  subject { MailHandler::Receiving::Notification::EmailContent }
+
+  let(:to) { 'john@example.com' }
+  let(:from) { 'igor@example.com' }
+  let(:options) {{ :test => 'test' } }
+
+  context '.email_received' do
+
+    it 'create email' do
+
+      expect(subject.email_received(options, 60, from, to)).to be_kind_of Mail::Message
+
+    end
+
+    context 'email content' do
+
+      it 'sender' do
+
+        expect(subject.email_received(options, 60, from, to)[:from].to_s).to eq from
+
+      end
+
+      it 'single recipient' do
+
+        expect(subject.email_received(options, 60, from, to)[:to].to_s).to eq to
+
+      end
+
+      it 'multiple recipients' do
+
+        to = 'john1@example.com, john2@example.com'
+        expect(subject.email_received(options, 60, from, to)[:to].to_s).to eq to
+
+      end
+
+      it 'subject - 1 minute delay' do
+
+        expect(subject.email_received(options, 60, from, to).subject).to eq "Received - delay was 1.0 minutes"
+
+      end
+
+      it 'subject - 1.5 minute delay' do
+
+        expect(subject.email_received(options, 90, from, to).subject).to eq "Received - delay was 1.5 minutes"
+
+      end
+
+      it 'body' do
+
+        expect(subject.email_received(options, 90, from, to).body.to_s).
+            to eq "Received - delay was 1.5 minutes - search by #{options}"
+
+      end
+
+    end
+
+  end
+
+  context '.email_delayed' do
+
+    it 'sender' do
+
+      expect(subject.email_delayed(options, 60, from, to)[:from].to_s).to eq from
+
+    end
+
+    it 'single recipient' do
+
+      expect(subject.email_delayed(options, 60, from, to)[:to].to_s).to eq to
+
+    end
+
+    it 'multiple recipients' do
+
+      to = 'john1@example.com, john2@example.com'
+      expect(subject.email_delayed(options, 60, from, to)[:to].to_s).to eq to
+
+    end
+
+    it 'subject - 1 minute delay' do
+
+      expect(subject.email_delayed(options, 60, from, to).subject).to eq "Over 1.0 minutes delay"
+
+    end
+
+    it 'subject - 1.5 minute delay' do
+
+      expect(subject.email_delayed(options, 90, from, to).subject).to eq "Over 1.5 minutes delay"
+
+    end
+
+    it 'body' do
+
+      expect(subject.email_delayed(options, 90, from, to).body.to_s).
+          to eq "Over 1.5 minutes delay - search by #{options}"
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe MailHandler::Receiving::Notification::Email do
+
+
+
+end

data/spec/unit/mailhandler/sender_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe MailHandler::Sender do
+
+  subject { MailHandler::Sender }
+
+  let(:send_duration) { 3 }
+  let(:dispatcher) {
+    dispatcher = double('Dispatcher')
+
+    allow(dispatcher).to receive(:send) { sleep send_duration ; 'Sent' }
+    dispatcher
+
+  }
+  let(:mail) {
+
+    Mail.new do
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
+      subject "Hello!"
+      body "Hello Sheldon!"
+    end
+
+  }
+
+  it '.sending' do
+
+    expect(subject.new(dispatcher)).not_to be nil
+
+  end
+
+  it '.sending init' do
+
+    sender = subject.new(dispatcher)
+
+    aggregate_failures "sending details" do
+      expect(sender.sending.started_at).to be nil
+      expect(sender.sending.finished_at).to be nil
+      expect(sender.sending.duration).to be nil
+      expect(sender.sending.response).to be nil
+      expect(sender.sending.email).to be nil
+    end
+
+  end
+
+  it '.send_email' do
+
+    sender = subject.new(dispatcher)
+    sender.send_email(mail)
+
+    aggregate_failures "sending details" do
+      expect(sender.sending.started_at).to be_within(1).of(Time.now - send_duration)
+      expect(sender.sending.finished_at).to be_within(1).of(Time.now)
+      expect(sender.sending.duration).to be_within(0.5).of(send_duration)
+      expect(sender.sending.response).to eq 'Sent'
+      expect(sender.sending.email).to be mail
+    end
+
+  end
+
+end

data/spec/unit/mailhandler_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe MailHandler::Handler do
+
+  subject { MailHandler::Handler }
+
+  context 'receiver' do
+
+    let(:receiver_folder) {
+
+      subject.receiver(:folder)
+
+    }
+
+    it 'invalid type' do
+
+      expect{subject.receiver(:test)}.
+          to raise_error(StandardError, 'Unknown type - test, possible options: [:folder, :imap]')
+
+    end
+
+    context 'folder check' do
+
+      it 'object type' do
+
+        expect(receiver_folder).to match MailHandler::Receiver
+
+      end
+
+    end
+
+
+  end
+
+  context 'sender' do
+
+    it 'invalid type' do
+
+      expect{subject.sender(:test)}.
+          to raise_error(StandardError, 'Unknown type - test, possible options: [:postmark_api, :postmark_batch_api, :smtp]')
+
+    end
+
+    it 'create sender - postmark api' do
+
+      expect(subject.sender(:postmark_api)).to match MailHandler::Sender
+
+    end
+
+    it 'create sender - postmark batch api' do
+
+      expect(subject.sender(:postmark_batch_api)).to match MailHandler::Sender
+
+    end
+
+    it 'create sender - smtp' do
+
+      expect(subject.sender(:smtp)).to match MailHandler::Sender
+
+    end
+
+  end
+
+end

data/travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 1.8.7
+- 1.9.3
+- 2.0.0
+- 2.1.6
+- 2.2.2
+
+script: bundle exec rake spec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailhandler
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Igor Balos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -52,6 +52,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
 - lib/mailhandler.rb
 - lib/mailhandler/receiver.rb
 - lib/mailhandler/receiving/checker.rb
@@ -71,11 +74,21 @@ files:
 - lib/mailhandler/version.rb
 - mailhandler.gemspec
 - readme.md
+- spec/spec_helper.rb
+- spec/unit/mailhandler/receiver_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_spec.rb
+- travis.yml
 homepage: https://github.com/ibalosh
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n    ==================\n    Thanks for installing the mailhandler
+  gem.\n    Review the README.md for implementation details and examples.\n    ==================\n
+  \ "
 rdoc_options: []
 require_paths:
 - lib