mail_fetcher 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2b9c145d27321e349f33b17aa56c5dcc796c899
+  data.tar.gz: 01f673555ae9c88ba16fd3d1c304b1e180940489
+SHA512:
+  metadata.gz: 4aa76e4a22aaa7b6f76825181b4f9330d5ca89e8b1799da2ef3a8ef13b1de1a9dfc1b4121d958f8dd5086f603e0f39eac01926f358b5a129fa279f3854ee50fe
+  data.tar.gz: df19f660f6d909c2758cae2540b4d893a9985139abc70b426c2ff4a54c9d482d93404bc0e63b21b647d016301308aebe317fd67b0956135d89b26e1060599e62

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mail_fetcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Vitalii Grygoruk
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# MailFetcher
+
+Simple API for accessing MailCatcher and GMail inbox. Useful for end-2-end test automation projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail_fetcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail_fetcher
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/vgrigoruk/mail_fetcher/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/mail_fetcher.rb

@@ -0,0 +1,5 @@
+require "mail_fetcher/version"
+require 'mail_fetcher/client'
+
+module MailFetcher
+end

data/lib/mail_fetcher/client.rb

@@ -0,0 +1,59 @@
+require_relative 'gmail_client'
+require_relative 'mail_catcher_client'
+require 'yaml'
+
+module MailFetcher
+  class Client
+    class << self
+      attr_accessor :server_type, :max_wait_time, :host, :port, :client_id, :client_secret, :account, :refresh_token, :clean_inbox, :logger
+
+      def configure
+        self.max_wait_time = 30
+        self.clean_inbox = false
+        yield self
+        if debug_mode && !self.logger
+          self.logger = self.create_default_logger
+        end
+      end
+
+      def find(*args)
+        client.find(*args)
+      end
+
+      protected
+
+      def client
+        @client ||= create_client
+      end
+
+      private
+
+      def create_client
+        case self.server_type
+          when :mail_catcher
+            _client = MailCatcherClient.new(host, port, clean_inbox = clean_inbox)
+          when :gmail
+            _client = GmailClient.new(account, client_id, client_secret, refresh_token)
+          else
+            raise InvalidArgument.new('Unsupported server type')
+        end
+        _client.logger = self.logger if self.logger
+        _client
+      end
+
+      def debug_mode
+        YAML.load(ENV.fetch('DEBUG', 'false'))
+      end
+
+      def create_default_logger
+        _logger = Logger.new(STDOUT)
+        _logger.level = Logger::DEBUG
+        _logger.formatter = proc do |severity, datetime, progname, msg|
+          "[#{severity}][#{datetime}] - #{msg}\n"
+        end
+        _logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+        _logger
+      end
+    end
+  end
+end

data/lib/mail_fetcher/email_message.rb

@@ -0,0 +1,10 @@
+module MailFetcher
+  class EmailMessage
+    URL_PATTERN = /https?:\/\/[_a-zA-Z0-9\.\/?=&-]+/
+
+    def initialize(connection, message_id)
+      @connection = connection
+      @message_id = message_id
+    end
+  end
+end

data/lib/mail_fetcher/gmail_client.rb

@@ -0,0 +1,66 @@
+require 'mail'
+require 'gmail_xoauth'
+require 'faraday'
+require_relative 'gmail_message'
+require_relative 'retry_helper'
+
+module MailFetcher
+  class GmailClient
+    include MailFetcher::RetryHelper
+
+    HOST = 'imap.gmail.com'
+    PORT = 993
+
+    attr_accessor :logger
+
+    def initialize(account, client_id, client_secret, refresh_token)
+      @account = account
+      @client_id = client_id
+      @client_secret = client_secret
+      @refresh_token = refresh_token
+    end
+
+    def find(recipient, subject='', wait=MailFetcher::Client.max_wait_time)
+      @connection ||= authenticated_connection
+
+      message_id = eventually(:tries => wait, :delay => 1) do
+        begin
+          @connection.examine('INBOX')
+          search_filter = ['TO', recipient, 'SUBJECT', subject]
+          results = @connection.search(search_filter)
+          logger.error("Inbox contains #{results.length} messages matching search criteria") if logger && results.length > 1
+          results.first
+        rescue => e
+          logger.error("Error while trying trying to find a message in INBOX (#{e.message})") if logger
+          nil
+        end
+      end
+
+      message_id ? GmailMessage.new(@connection, message_id) : nil
+    end
+
+    private
+
+    def authenticated_connection
+      connection = Net::IMAP.new(HOST, PORT, usessl = true, certs = nil, verify = false)
+      connection.authenticate('XOAUTH2', @account, get_access_token)
+      connection
+    end
+
+    def get_access_token
+      params = {}
+      params['client_id'] = @client_id
+      params['client_secret'] = @client_secret
+      params['refresh_token'] = @refresh_token
+      params['grant_type'] = 'refresh_token'
+      request_url = 'https://accounts.google.com'
+      conn = Faraday.new(:url => request_url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
+      end
+
+      response = conn.post('/o/oauth2/token', params)
+      JSON.parse(response.body)['access_token']
+    end
+  end
+end

data/lib/mail_fetcher/gmail_message.rb

@@ -0,0 +1,41 @@
+require 'mail'
+require_relative 'email_message'
+module MailFetcher
+  class GmailMessage < EmailMessage
+    CONTENT_TYPE_PLAIN = /text\/plain/
+    CONTENT_TYPE_HTML = /text\/html/
+
+    def plain_text_body
+      find_part_by_content_type(CONTENT_TYPE_PLAIN).body.decoded
+    end
+
+    def plain_text_urls
+      plain_text_body.match(URL_PATTERN).to_a
+    end
+
+    def html_body
+      find_part_by_content_type(CONTENT_TYPE_HTML).body.decoded
+    end
+
+    def html_urls
+      html_body.scan(%r{href="(#{URL_PATTERN.source})"}).flatten
+    end
+
+    private
+
+    def find_part_by_content_type(content_type)
+      if email.content_type =~ content_type
+        email
+      else
+        email.parts.find { |p| p.content_type =~ content_type }
+      end
+    end
+
+    def email
+      @email ||= begin
+        raw_message = @connection.fetch(@message_id, 'RFC822.TEXT')[0].attr['RFC822.TEXT']
+        Mail.new(raw_message)
+      end
+    end
+  end
+end

data/lib/mail_fetcher/mail_catcher_client.rb

@@ -0,0 +1,40 @@
+require 'faraday_middleware'
+require_relative 'retry_helper'
+require_relative 'mail_catcher_message'
+
+module MailFetcher
+  class MailCatcherClient
+
+    attr_accessor :logger
+
+    def initialize(host, port, clean_inbox=false)
+      base_url = "http://#{host}:#{port}"
+      @connection = Faraday.new base_url do |conn|
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+        conn.use :instrumentation
+        conn.adapter Faraday.default_adapter
+      end
+      delete_all_messages if clean_inbox
+    end
+
+    ## @return MailCatcherMessage if message found or nil
+    def find(recipient, subject='', wait=1)
+      message_id = eventually(:tries => wait, :delay => 1) do
+        message_data = all.find { |m| m['recipients'][0].include?(recipient) && m['subject'].include?(subject) }
+        message_data ? message_data['id'] : nil
+      end
+      message_id ? MailCatcherMessage.new(@connection, message_id) : nil
+    end
+
+    private
+
+    def delete_all_messages
+      @connection.delete('/messages')
+    end
+
+    def all
+      @connection.get('/messages').body
+    end
+  end
+end

data/lib/mail_fetcher/mail_catcher_message.rb

@@ -0,0 +1,28 @@
+require_relative 'email_message'
+
+module MailFetcher
+  class MailCatcherMessage < EmailMessage
+    def plain_text_body
+      body(:plain)
+    end
+
+    def plain_text_urls
+      plain_text_body.match(URL_PATTERN).to_a
+    end
+
+    def html_body
+      body(:html)
+    end
+
+    def html_urls
+      html_body.scan(%r{href="(#{URL_PATTERN.source})"}).flatten
+    end
+
+    private
+
+    ## @param format - :html, :plain, :json
+    def body(format=:json)
+      @connection.get("/messages/#{@message_id}.#{format}").body
+    end
+  end
+end

data/lib/mail_fetcher/retry_helper.rb

@@ -0,0 +1,26 @@
+module MailFetcher
+  module RetryHelper
+    def eventually(options = {})
+      options = {:tries => 10, :delay => 1, :catch => []}.merge(options)
+      last_error = nil
+      start_time = Time.now.to_i
+      options[:tries].times do |i|
+        begin
+          result = yield i
+          return result if result
+        rescue => e
+          raise e unless Array(options[:catch]).any? { |type| e.is_a?(type) }
+          last_error = e
+        end
+        timeout = options[:timeout] || (options[:tries] * options[:delay])
+        if (Time.now.to_i - start_time) > timeout
+          break
+        else
+          sleep(options[:delay])
+        end
+      end
+      raise last_error if last_error
+      nil
+    end
+  end
+end

data/lib/mail_fetcher/version.rb

@@ -0,0 +1,3 @@
+module MailFetcher
+  VERSION = "0.0.2"
+end

data/mail_fetcher.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail_fetcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail_fetcher"
+  spec.version       = MailFetcher::VERSION
+  spec.authors       = ["Vitalii Grygoruk"]
+  spec.email         = ["vitaliy[dot]grigoruk[at]gmail[dot]com"]
+  spec.summary       = %q{Simple utility that allows to fetch email messages from Gmail and MailCatcher}
+  spec.description   = %q{Find email messages in Gmail and MailCatcher using the same Ruby API. Extremely useful for acceptance testing, that relies on emails sent by application under test.}
+  spec.homepage      = "https://github.com/vgrigoruk/mail_fetcher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mailcatcher"
+
+  spec.add_dependency "mail"
+  spec.add_dependency "gmail_xoauth"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+end

data/spec/features/gmail_spec.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+describe 'Gmail client' do
+
+  it 'should find email message in Gmail' do
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: mail_fetcher
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Vitalii Grygoruk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mailcatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gmail_xoauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Find email messages in Gmail and MailCatcher using the same Ruby API.
+  Extremely useful for acceptance testing, that relies on emails sent by application
+  under test.
+email:
+- vitaliy[dot]grigoruk[at]gmail[dot]com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mail_fetcher.rb
+- lib/mail_fetcher/client.rb
+- lib/mail_fetcher/email_message.rb
+- lib/mail_fetcher/gmail_client.rb
+- lib/mail_fetcher/gmail_message.rb
+- lib/mail_fetcher/mail_catcher_client.rb
+- lib/mail_fetcher/mail_catcher_message.rb
+- lib/mail_fetcher/retry_helper.rb
+- lib/mail_fetcher/version.rb
+- mail_fetcher.gemspec
+- spec/features/gmail_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vgrigoruk/mail_fetcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple utility that allows to fetch email messages from Gmail and MailCatcher
+test_files:
+- spec/features/gmail_spec.rb
+- spec/spec_helper.rb