howitzer 2.0.3 → 2.1.0

data/howitzer.gemspec

@@ -20,14 +20,16 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport', '~>5.0'
   gem.add_runtime_dependency 'capybara', ['>= 2.1', '< 3.0']
+  gem.add_runtime_dependency 'colorize'
   gem.add_runtime_dependency 'gli'
+  gem.add_runtime_dependency 'gmail'
   gem.add_runtime_dependency 'launchy'
   gem.add_runtime_dependency 'log4r', '~>1.1.10'
   gem.add_runtime_dependency 'nokogiri', '~> 1.6' if gem.platform.to_s =~ /mswin|mingw/
   gem.add_runtime_dependency 'rake'
   gem.add_runtime_dependency 'rspec', '~>3.2'
   gem.add_runtime_dependency 'rspec-wait'
-  gem.add_runtime_dependency 'selenium-webdriver', '< 4.0'
+  gem.add_runtime_dependency 'selenium-webdriver', ['>= 3.4.1', '< 4.0']
   gem.add_runtime_dependency 'sexy_settings'
 
   gem.add_development_dependency('aruba')

data/lib/howitzer/capybara_helpers.rb

@@ -5,12 +5,28 @@ module Howitzer
   # This module holds capybara helpers methods
   module CapybaraHelpers
     CHECK_YOUR_SETTINGS_MSG = 'Please check your settings'.freeze #:nodoc:
+    HOWITZER_KNOWN_BROWSERS = [ #:nodoc:
+      CLOUD_BROWSERS = [
+        SAUCE = :sauce,
+        TESTINGBOT = :testingbot,
+        BROWSERSTACK = :browserstack,
+        CROSSBROWSERTESTING = :crossbrowsertesting
+      ].freeze,
+      LOCAL_BROWSERS = [
+        HEADLESS_CHROME = :headless_chrome,
+        PHANTOMJS = :phantomjs,
+        POLTERGEIST = :poltergeist,
+        SELENIUM = :selenium,
+        SELENIUM_GRID = :selenium_grid,
+        WEBKIT = :webkit
+      ].freeze
+    ].freeze
 
     # @return [Boolean] true if current driver related with SauceLab,
     #   Testingbot or Browserstack cloud service
 
     def cloud_driver?
-      %i[sauce testingbot browserstack].include?(Howitzer.driver.to_sym)
+      CLOUD_BROWSERS.include?(Howitzer.driver.to_sym)
     end
 
     # @return [Boolean] whether or not current browser is
@@ -35,7 +51,7 @@ module Howitzer
     # @raise [SelBrowserNotSpecifiedError] if selenium driver and missing browser name
 
     def chrome_browser?
-      browser? :chrome
+      browser?(:chrome) || Howitzer.driver == HEADLESS_CHROME.to_s
     end
 
     # @return [Boolean] whether or not current browser is Safari.
@@ -64,7 +80,7 @@ module Howitzer
 
     def update_cloud_job_status(json_data = {})
       case Howitzer.driver.to_sym
-      when :sauce then update_sauce_job_status(json_data)
+      when SAUCE then update_sauce_job_status(json_data)
       else
         '[NOT IMPLEMENTED]'
       end
@@ -102,7 +118,8 @@ module Howitzer
 
     def cloud_driver(app, caps, url)
       http_client = ::Selenium::WebDriver::Remote::Http::Default.new
-      http_client.timeout = Howitzer.cloud_http_idle_timeout
+      http_client.read_timeout = Howitzer.cloud_http_idle_timeout
+      http_client.open_timeout = Howitzer.cloud_http_idle_timeout
 
       options = {
         url: url,
@@ -121,7 +138,7 @@ module Howitzer
 
     def cloud_resource_path(kind)
       case Howitzer.driver.to_sym
-      when :sauce then sauce_resource_path(kind)
+      when SAUCE then sauce_resource_path(kind)
       else
         '[NOT IMPLEMENTED]'
       end
@@ -136,7 +153,7 @@ module Howitzer
 
     def cloud_browser?(*browser_aliases)
       unless Howitzer.cloud_browser_name.nil?
-        return browser_aliases.include?(Howitzer.cloud_browser_name.to_s.to_sym)
+        return browser_aliases.include?(Howitzer.cloud_browser_name.to_s.downcase.to_sym)
       end
       raise Howitzer::CloudBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG
     end
@@ -149,11 +166,11 @@ module Howitzer
     end
 
     def selenium_driver?
-      Howitzer.driver.to_sym == :selenium
+      Howitzer.driver.to_sym == SELENIUM
     end
 
     def selenium_grid_driver?
-      Howitzer.driver.to_sym == :selenium_grid
+      Howitzer.driver.to_sym == SELENIUM_GRID
     end
 
     def prefix_name

data/lib/howitzer/gmail_api.rb

@@ -0,0 +1,7 @@
+module Howitzer
+  # This module holds simple implementation of gmail api client
+  module GmailApi
+  end
+end
+
+require 'howitzer/gmail_api/client'

data/lib/howitzer/gmail_api/client.rb

@@ -0,0 +1,22 @@
+require 'gmail'
+
+module Howitzer
+  module GmailApi
+    # A GmailApi::Client object is used to communicate with the Gmail API.
+    class Client
+      def initialize
+        @client = Gmail.connect(Howitzer.gmail_login, Howitzer.gmail_password)
+      end
+
+      # Finds message according to given parameters
+      #
+      # @param recipient [String] this is recipient mail address for message filtering
+      # @param subject [String] this is subject of the message to filter particular message
+      # @return [Gmail::Message] gmail message object
+
+      def find_message(recipient, subject)
+        @client.inbox.emails(to: recipient, subject: subject).last
+      end
+    end
+  end
+end

data/lib/howitzer/mail_adapters/gmail.rb

@@ -0,0 +1,93 @@
+require 'howitzer/exceptions'
+require 'howitzer/mail_adapters/abstract'
+require 'howitzer/gmail_api/client'
+
+module Howitzer
+  module MailAdapters
+    # This class represents Gmail mail adapter
+    class Gmail < Abstract
+      # Finds an email in storage
+      # @param recipient [String] an email
+      # @param subject [String]
+      # @param wait [Integer] how much time is required to wait an email
+      # @raise [EmailNotFoundError] if blank message
+
+      def self.find(recipient, subject, wait:)
+        message = {}
+        retryable(find_retry_params(wait)) { message = get_message(recipient, subject) }
+        return new(message) if message.present?
+        raise Howitzer::EmailNotFoundError,
+              "Message with subject '#{subject}' for recipient '#{recipient}' was not found."
+      end
+
+      # @return [String] plain text body of the email message
+
+      def plain_text_body
+        message.body.to_s
+      end
+
+      # @return [String] html body of the email message
+
+      def html_body
+        message.html_part.to_s
+      end
+
+      # @return [String] stripped text
+
+      def text
+        message.text_part.to_s
+      end
+
+      # @return [String] an email address specified in `From` field
+
+      def mail_from
+        "#{message.from[0]['mailbox']}@#{message.from[0]['host']}"
+      end
+
+      # @return [Array] recipient emails
+
+      def recipients
+        message.to.inject([]) { |ar, to| ar << "#{to['mailbox']}@#{to['host']}" }
+      end
+
+      # @return [String] when email was received
+
+      def received_time
+        Time.parse(message.date).strftime('%F %T')
+      end
+
+      # @return [Array] attachments
+
+      def mime_part
+        message.attachments
+      end
+
+      # @raise [NoAttachmentsError] if no attachments present
+      # @return [Array] attachments
+
+      def mime_part!
+        files = mime_part
+        return files if files.present?
+        raise Howitzer::NoAttachmentsError, 'No attachments were found.'
+      end
+
+      def self.get_message(recipient, subject)
+        message = Howitzer::GmailApi::Client.new.find_message(recipient, subject)
+        raise Howitzer::EmailNotFoundError if message.blank?
+        message
+      end
+      private_class_method :get_message
+
+      def self.find_retry_params(wait)
+        {
+          timeout: wait,
+          sleep: Howitzer.mail_sleep_time,
+          silent: true,
+          logger: Howitzer::Log,
+          on: Howitzer::EmailNotFoundError
+        }
+      end
+      private_class_method :find_retry_params
+    end
+  end
+end

data/lib/howitzer/mail_adapters/mailgun.rb

@@ -75,7 +75,7 @@ module Howitzer
       def mime_part!
         files = mime_part
         return files if files.present?
-        raise Howitzer::NoAttachmentsError, 'No attachments where found.'
+        raise Howitzer::NoAttachmentsError, 'No attachments were found.'
       end
 
       def self.events
@@ -95,7 +95,7 @@ module Howitzer
       def self.find_retry_params(wait)
         {
           timeout: wait || Howitzer.try(:mailgun_idle_timeout),
-          sleep: Howitzer.mailgun_sleep_time,
+          sleep: Howitzer.mail_sleep_time || Howitzer.mailgun_sleep_time,
           silent: true,
           logger: Howitzer::Log,
           on: Howitzer::EmailNotFoundError

data/lib/howitzer/mail_adapters/mailtrap.rb

@@ -0,0 +1,105 @@
+require 'howitzer/exceptions'
+require 'howitzer/mail_adapters/abstract'
+require 'howitzer/mailtrap_api/client'
+
+module Howitzer
+  module MailAdapters
+    # This class represents mailtrap mail adapter
+    class Mailtrap < Abstract
+      # Finds an email in storage
+      # @param recipient [String] an email
+      # @param subject [String]
+      # @param wait [Integer] how much time is required to wait an email
+      # @raise [EmailNotFoundError] if blank message
+
+      def self.find(recipient, subject, wait:)
+        message = {}
+        retryable(find_retry_params(wait)) { message = retrieve_message(recipient, subject) }
+        return new(message) if message.present?
+        raise Howitzer::EmailNotFoundError,
+              "Message with subject '#{subject}' for recipient '#{recipient}' was not found."
+      end
+
+      # @return [String] plain text body of the email message
+
+      def plain_text_body
+        message['text_body']
+      end
+
+      # @return [String] html body of the email message
+
+      def html_body
+        message['html_body']
+      end
+
+      # @return [String] stripped text
+
+      def text
+        message['text_body']
+      end
+
+      # @return [String] an email address specified in `From` field
+
+      def mail_from
+        message['from_email']
+      end
+
+      # @return [String] recipient emails separated with `, `
+
+      def recipients
+        message['to_email'].split ', '
+      end
+
+      # @return [String] when email was received
+
+      def received_time
+        Time.parse(message['created_at']).to_s
+      end
+
+      # @return [String] a real sender email address
+
+      def sender_email
+        message['from_email']
+      end
+
+      # @return [Array] attachments
+
+      def mime_part
+        retrieve_attachments(message)
+      end
+
+      # @raise [NoAttachmentsError] if no attachments present
+      # @return [Array] attachments
+
+      def mime_part!
+        files = mime_part
+        return files if files.present?
+        raise Howitzer::NoAttachmentsError, 'No attachments were found.'
+      end
+
+      def self.find_retry_params(wait)
+        {
+          timeout: wait,
+          sleep: Howitzer.mail_sleep_time,
+          silent: true,
+          logger: Howitzer::Log,
+          on: Howitzer::EmailNotFoundError
+        }
+      end
+      private_class_method :find_retry_params
+
+      def self.retrieve_message(recipient, subject)
+        message = Howitzer::MailtrapApi::Client.new.find_message(recipient, subject)
+        raise Howitzer::EmailNotFoundError, 'Message not received yet, retry...' unless message
+        message
+      end
+      private_class_method :retrieve_message
+
+      private
+
+      def retrieve_attachments(message)
+        Howitzer::MailtrapApi::Client.new.find_attachments(message)
+      end
+    end
+  end
+end

data/lib/howitzer/mailtrap_api.rb

@@ -0,0 +1,7 @@
+module Howitzer
+  # This module holds simple implementation of mailtrap api client
+  module MailtrapApi
+  end
+end
+
+require 'howitzer/mailtrap_api/client'

data/lib/howitzer/mailtrap_api/client.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'rest-client'
+
+module Howitzer
+  module MailtrapApi
+    # A Mailtrap::Client object is used to communicate with the Mailtrap API.
+    class Client
+      BASE_URL = "https://mailtrap.io/api/v1/inboxes/#{Howitzer.mailtrap_inbox_id}".freeze #:nodoc:
+
+      def initialize
+        @api_token = Howitzer.mailtrap_api_token
+      end
+
+      # Finds message according to given parameters
+      #
+      # @param recipient [String] this is recipient mail address for message filtering
+      # @param subject [String] this is subject of the message to filter particular message
+      # @return [Hash] json message parsed to ruby hash
+
+      def find_message(recipient, subject)
+        recipient = recipient.gsub('+', '%2B')
+        messages = filter_by_subject(messages(recipient), subject)
+        latest_message(messages)
+      end
+
+      # Finds attachments for message
+      #
+      # @param message [Hash] which attachments should be extracted
+      # @return [Array] returns array of attachments
+
+      def find_attachments(message)
+        JSON.parse(RestClient.get("#{BASE_URL}/messages/#{message['id']}/attachments", 'Api-Token' => @api_token))
+      end
+
+      private
+
+      def messages(recipient)
+        JSON.parse(RestClient.get("#{BASE_URL}/messages?search=#{recipient}", 'Api-Token' => @api_token))
+      end
+
+      def latest_message(messages)
+        messages[0]
+      end
+
+      def filter_by_subject(messages, subject)
+        result_messages = []
+        messages.each { |msg| result_messages << msg if msg['subject'] == subject }
+        result_messages
+      end
+    end
+  end
+end

data/lib/howitzer/version.rb

@@ -1,4 +1,4 @@
 # This module holds howitzer version
 module Howitzer
-  VERSION = '2.0.3'.freeze #:nodoc:
+  VERSION = '2.1.0'.freeze #:nodoc:
 end

data/lib/howitzer/web/page.rb

@@ -39,6 +39,7 @@ module Howitzer
 
       def self.open(validate: true, url_processor: nil, **params)
         url = expanded_url(params, url_processor)
+        modify_user_agent if Howitzer.user_agent.present?
         Howitzer::Log.info "Open #{name} page by '#{url}' url"
         retryable(tries: 2, logger: Howitzer::Log, trace: true, on: Exception) do |retries|
           Howitzer::Log.info 'Retry...' unless retries.zero?
@@ -147,13 +148,24 @@ module Howitzer
           "Current page matches more that one page class (#{page_list.join(', ')}).\n" \
                     "\tCurrent url: #{current_url}\n\tCurrent title: #{instance.title}"
         end
+
+        def modify_user_agent
+          driver = Capybara.current_session.driver
+          case Howitzer.driver.to_sym
+            when CapybaraHelpers::POLTERGEIST
+              driver.add_headers('User-Agent' => Howitzer.user_agent)
+            when CapybaraHelpers::WEBKIT
+              driver.header('User-Agent', Howitzer.user_agent)
+          end
+        end
       end
 
       site Howitzer.app_uri.site
 
       def initialize
         check_validations_are_defined!
-        current_window.maximize if Howitzer.maximized_window && Howitzer.driver != 'headless_chrome'
+        current_window.maximize if Howitzer.maximized_window &&
+                                   !%w[chrome headless_chrome].include?(Capybara.current_driver)
       end
 
       # Reloads current page in a browser