howitzer 2.2.0 → 2.5.0

data/generators/root/templates/Gemfile.erb

@@ -1,7 +1,9 @@
 source 'https://rubygems.org'
 
+ruby '>=2.6.8'
+
 gem 'capybara-screenshot'
-<%= "gem 'cucumber', '~>3.0'\n" if cucumber -%>
+<%= "gem 'cucumber', '>=3.0', '<7'\n" if cucumber -%>
 <%= "gem 'cuke_sniffer', require: false\n" if cucumber -%>
 gem 'factory_bot'
 gem 'howitzer'
@@ -11,18 +13,6 @@ gem 'repeater'
 gem 'rest-client'
 <%= "gem 'rspec', '~>3.2'\n" if rspec || turnip -%>
 gem 'rubocop'
+<%= "gem 'rubocop-rspec'\n" if rspec || turnip -%>
 <%= "gem 'turnip'\n" if turnip -%>
 <%= "gem 'syntax'\n" if cucumber -%>
-
-# Uncomment it if you are going to use 'appium' driver. Appium and Android SDK should be installed.
-# See https://appium.io/docs/en/about-appium/getting-started/
-# gem 'appium_capybara'
-
-# Uncomment it if you are going to use 'webkit' driver. QT library should be installed.
-# See https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit
-#
-# gem 'capybara-webkit'
-
-# Uncomment it if you are going to use 'poltergeist' driver. PhantomJS should be installed.
-# See https://github.com/jnicklas/capybara#poltergeist
-# gem 'poltergeist', git: 'https://github.com/teampoltergeist/poltergeist.git', branch: :master

data/generators/rspec/templates/spec_helper.rb

@@ -2,7 +2,7 @@ require 'capybara/rspec/features'
 require_relative '../config/boot'
 require_relative '../config/capybara'
 
-Dir['./spec/support/**/*.rb'].each { |f| require f }
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
 RSpec.configure do |config|
   Howitzer::Log.settings_as_formatted_text
@@ -17,7 +17,7 @@ RSpec.configure do |config|
   config.wait_timeout = Howitzer.rspec_wait_timeout
   config.order = Howitzer.test_order.presence || :defined
 
-  config.before(:each) do
+  config.before do
     scenario_name =
       if RSpec.current_example.description.blank?
         RSpec.current_example.metadata[:full_description]
@@ -28,12 +28,12 @@ RSpec.configure do |config|
     @session_start = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
   end
 
-  config.after(:each) do
+  config.after do
     Howitzer::Cache.clear_all_ns
     if CapybaraHelpers.cloud_driver?
       session_end = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
-      Howitzer::Log.info "CLOUD VIDEO #{@session_start} - #{session_end}" \
-               " URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
+      Howitzer::Log.info "CLOUD VIDEO #{@session_start} - #{session_end} " \
+                         "URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
     elsif CapybaraHelpers.ie_browser?
       Howitzer::Log.info 'IE reset session'
       Capybara.current_session.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")

data/generators/turnip/templates/spec_helper.rb

@@ -1,7 +1,7 @@
 require_relative '../config/boot'
 require_relative '../config/capybara'
 
-Dir['./spec/support/**/*.rb'].each { |f| require f }
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
 RSpec.configure do |config|
   Howitzer::Log.settings_as_formatted_text
@@ -16,7 +16,7 @@ RSpec.configure do |config|
   config.wait_timeout = Howitzer.rspec_wait_timeout
   config.order = Howitzer.test_order.presence || :defined
 
-  config.before(:each) do
+  config.before do
     scenario_name =
       if RSpec.current_example.description.blank?
         RSpec.current_example.metadata[:full_description]
@@ -27,12 +27,12 @@ RSpec.configure do |config|
     @session_start = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
   end
 
-  config.after(:each) do
+  config.after do
     Howitzer::Cache.clear_all_ns
     if CapybaraHelpers.cloud_driver?
       session_end = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
-      Howitzer::Log.info "CLOUD VIDEO #{@session_start} - #{session_end}" \
-               " URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
+      Howitzer::Log.info "CLOUD VIDEO #{@session_start} - #{session_end} " \
+                         "URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
     elsif CapybaraHelpers.ie_browser?
       Howitzer::Log.info 'IE reset session'
       Capybara.current_session.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")

data/generators/web/templates/example_page.rb

@@ -1,7 +1,7 @@
 # This class is example of web page
 class ExamplePage < Howitzer::Web::Page
   path '/'
-  validate :url, %r{\A(?:.*?:\/\/)?[^\/]*\/?\z}
+  validate :url, %r{\A(?:.*?://)?[^/]*/?\z}
 
   section :menu
 

data/lib/howitzer/cache.rb

@@ -4,7 +4,7 @@ module Howitzer
   # Data can be stored in memory using this class
   #
   module Cache
-    SPECIAL_NS_LIST = [:cloud].freeze #:nodoc:
+    SPECIAL_NS_LIST = [:cloud].freeze # :nodoc:
     @data ||= {}
 
     class << self

data/lib/howitzer/capybara_helpers.rb

@@ -1,11 +1,35 @@
 require 'rest-client'
 require 'howitzer/exceptions'
 
+# There is an issue with supporting Ruby 3 by Selenium Webdriver 3.x version
+# https://github.com/SeleniumHQ/selenium/issues/9001
+# Migration to Selenium Webdriver 4 is planned when it will be released without alfa, beta stages.
+# :nocov:
+if Gem::Requirement.new('>=3').satisfied_by?(Gem::Version.new(RUBY_VERSION)) &&
+   Gem::Requirement.new(['>=3', '<4']).satisfied_by?(Gem::Version.new(Selenium::WebDriver::VERSION))
+  module Selenium
+    module WebDriver
+      module Remote
+        class Bridge # rubocop:disable Style/Documentation
+          class << self
+            alias original_handshake handshake
+
+            def handshake(opts = {})
+              original_handshake(**opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+# :nocov:
+
 module Howitzer
   # This module holds capybara helpers methods
   module CapybaraHelpers
-    CHECK_YOUR_SETTINGS_MSG = 'Please check your settings'.freeze #:nodoc:
-    HOWITZER_KNOWN_BROWSERS = [ #:nodoc:
+    CHECK_YOUR_SETTINGS_MSG = 'Please check your settings'.freeze # :nodoc:
+    HOWITZER_KNOWN_BROWSERS = [ # :nodoc:
       CLOUD_BROWSERS = [
         SAUCE = :sauce,
         TESTINGBOT = :testingbot,
@@ -15,10 +39,8 @@ module Howitzer
       LOCAL_BROWSERS = [
         HEADLESS_CHROME = :headless_chrome,
         HEADLESS_FIREFOX = :headless_firefox,
-        POLTERGEIST = :poltergeist,
         SELENIUM = :selenium,
-        SELENIUM_GRID = :selenium_grid,
-        WEBKIT = :webkit
+        SELENIUM_GRID = :selenium_grid
       ].freeze
     ].freeze
 
@@ -110,6 +132,21 @@ module Howitzer
       }
     end
 
+    # @return [Hash] selenium W3C capabilities required for a cloud driver
+
+    def required_w3c_cloud_caps
+      {
+        browserName: Howitzer.cloud_browser_name,
+        browserVersion: Howitzer.cloud_browser_version
+      }
+    end
+
+    # @return [Boolean] whether or not Selenium is W3C compatible.
+
+    def w3c_selenium?
+      Gem::Requirement.new('>=4').satisfied_by?(Gem::Version.new(Selenium::WebDriver::VERSION))
+    end
+
     # Buids selenium driver for a cloud service
     # @param app [<Rack>] a rack application that this server will contain
     # @param caps [Hash] remote capabilities
@@ -120,14 +157,14 @@ module Howitzer
       http_client = ::Selenium::WebDriver::Remote::Http::Default.new
       http_client.read_timeout = Howitzer.cloud_http_idle_timeout
       http_client.open_timeout = Howitzer.cloud_http_idle_timeout
-
       options = {
         url: url,
-        desired_capabilities: ::Selenium::WebDriver::Remote::Capabilities.new(caps),
         http_client: http_client,
         browser: :remote
       }
-      driver = Capybara::Selenium::Driver.new(app, options)
+      options[w3c_selenium? ? :capabilities : :desired_capabilities] =
+        ::Selenium::WebDriver::Remote::Capabilities.new(caps)
+      driver = Capybara::Selenium::Driver.new(app, **options)
       driver.browser.file_detector = remote_file_detector
       driver
     end
@@ -199,7 +236,7 @@ module Howitzer
     end
 
     def update_sauce_job_status(json_data = {})
-      host = "http://#{Howitzer.cloud_auth_login}:#{Howitzer.cloud_auth_pass}@saucelabs.com"
+      host = "https://#{Howitzer.cloud_auth_login}:#{Howitzer.cloud_auth_pass}@saucelabs.com"
       path = "/rest/v1/#{Howitzer.cloud_auth_login}/jobs/#{session_id}"
       url = "#{host}#{path}"
       ::RestClient.put url, json_data.to_json, content_type: :json, accept: :json

data/lib/howitzer/email.rb

@@ -79,8 +79,8 @@ module Howitzer
     def self.find_by_recipient(recipient, params = {})
       if defined?(subject_value).nil? || subject_value.nil?
         raise Howitzer::NoEmailSubjectError, "Please specify email subject. For example:\n" \
-                                    "class SomeEmail < Howitzer::Email\n" \
-                                    "  subject ‘some subject text’\nend"
+                                             "class SomeEmail < Howitzer::Email\n  " \
+                                             "subject ‘some subject text’\nend"
       end
       new(adapter.find(recipient, expand_subject(params), wait: wait_time_value))
     end

data/lib/howitzer/exceptions.rb

@@ -1,24 +1,24 @@
 # This module holds all custom howitzer exceptions
 module Howitzer
-  CommunicationError = Class.new(StandardError) #:nodoc:
-  ParseError = Class.new(StandardError) #:nodoc:
-  InvalidApiKeyError = Class.new(StandardError) #:nodoc:
-  BadElementParamsError = Class.new(StandardError) #:nodoc:
-  NoValidationError = Class.new(StandardError) #:nodoc:
-  UnknownValidationError = Class.new(StandardError) #:nodoc:
-  EmailNotFoundError = Class.new(StandardError) #:nodoc:
-  NoAttachmentsError = Class.new(StandardError) #:nodoc:
-  DriverNotSpecifiedError = Class.new(StandardError) #:nodoc:
-  UnknownDriverError = Class.new(StandardError) #:nodoc:
-  CloudBrowserNotSpecifiedError = Class.new(StandardError) #:nodoc:
-  SelBrowserNotSpecifiedError = Class.new(StandardError) #:nodoc:
-  UnknownBrowserError = Class.new(StandardError) #:nodoc:
-  IncorrectPageError = Class.new(StandardError) #:nodoc:
-  AmbiguousPageMatchingError = Class.new(StandardError) #:nodoc:
-  NoMailAdapterError = Class.new(StandardError) #:nodoc:
-  NoPathForPageError = Class.new(StandardError) #:nodoc:
-  NoEmailSubjectError = Class.new(StandardError) #:nodoc:
-  NoDataError = Class.new(StandardError) #:nodoc:
-  UndefinedElementError = Class.new(StandardError) #:nodoc:
-  UndefinedSexySettingError = Class.new(StandardError) #:nodoc:
+  CommunicationError = Class.new(StandardError) # :nodoc:
+  ParseError = Class.new(StandardError) # :nodoc:
+  InvalidApiKeyError = Class.new(StandardError) # :nodoc:
+  BadElementParamsError = Class.new(StandardError) # :nodoc:
+  NoValidationError = Class.new(StandardError) # :nodoc:
+  UnknownValidationError = Class.new(StandardError) # :nodoc:
+  EmailNotFoundError = Class.new(StandardError) # :nodoc:
+  NoAttachmentsError = Class.new(StandardError) # :nodoc:
+  DriverNotSpecifiedError = Class.new(StandardError) # :nodoc:
+  UnknownDriverError = Class.new(StandardError) # :nodoc:
+  CloudBrowserNotSpecifiedError = Class.new(StandardError) # :nodoc:
+  SelBrowserNotSpecifiedError = Class.new(StandardError) # :nodoc:
+  UnknownBrowserError = Class.new(StandardError) # :nodoc:
+  IncorrectPageError = Class.new(StandardError) # :nodoc:
+  AmbiguousPageMatchingError = Class.new(StandardError) # :nodoc:
+  NoMailAdapterError = Class.new(StandardError) # :nodoc:
+  NoPathForPageError = Class.new(StandardError) # :nodoc:
+  NoEmailSubjectError = Class.new(StandardError) # :nodoc:
+  NoDataError = Class.new(StandardError) # :nodoc:
+  UndefinedElementError = Class.new(StandardError) # :nodoc:
+  UndefinedSexySettingError = Class.new(StandardError) # :nodoc:
 end

data/lib/howitzer/gmail_api/client.rb

@@ -1,11 +1,16 @@
-require 'gmail'
-
 module Howitzer
   module GmailApi
     # A GmailApi::Client object is used to communicate with the Gmail API.
     class Client
+      def self.load_gmail_gem!
+        require 'gmail'
+      rescue LoadError
+        raise LoadError, "Unable to load `gmail` library, please add following code to your Gemfile:\n\ngem 'gmail'"
+      end
+      load_gmail_gem!
+
       def initialize
-        @client = Gmail.connect(Howitzer.gmail_login, Howitzer.gmail_password)
+        self.client = Gmail.connect(Howitzer.gmail_login, Howitzer.gmail_password)
       end
 
       # Finds message according to given parameters
@@ -15,8 +20,12 @@ module Howitzer
       # @return [Gmail::Message] gmail message object
 
       def find_message(recipient, subject)
-        @client.inbox.emails(to: recipient, subject: subject).last
+        client.inbox.emails(to: recipient, subject: subject).last
       end
+
+      private
+
+      attr_accessor :client
     end
   end
 end

data/lib/howitzer/log.rb

@@ -80,13 +80,13 @@ module Howitzer
       Logger['ruby_log'].trace = true
     end
 
-    #:nocov:
+    # :nocov:
     def log_without_formatting
       self.base_formatter = blank_formatter
       yield
       self.base_formatter = default_formatter
     end
-    #:nocov:
+    # :nocov:
 
     def console_log
       StdoutOutputter.new(:console).tap { |o| o.only_at(INFO, DEBUG, WARN) }
@@ -96,13 +96,13 @@ module Howitzer
       StderrOutputter.new(:error, 'level' => ERROR)
     end
 
-    #:nocov:
+    # :nocov:
     def blank_formatter
       PatternFormatter.new(pattern: '%m')
     end
-    #:nocov:
+    # :nocov:
 
-    #:nocov:
+    # :nocov:
     def default_formatter
       params = if Howitzer.hide_datetime_from_log
                  { pattern: '[%l] %m' }
@@ -111,7 +111,7 @@ module Howitzer
                end
       PatternFormatter.new(params)
     end
-    #:nocov:
+    # :nocov:
 
     def base_formatter=(formatter)
       @logger.outputters.each { |outputter| outputter.formatter = formatter }

data/lib/howitzer/mail_adapters/mailgun.rb

@@ -89,7 +89,7 @@ module Howitzer
 
       def self.event_by(recipient, subject)
         events.to_h['items'].find do |hash|
-          hash['message']['recipients'].first == recipient && hash['message']['headers']['subject'] == subject
+          hash['message']['recipients'].first == recipient && subject === hash['message']['headers']['subject']
         end
       end
       private_class_method :event_by

data/lib/howitzer/mail_adapters/mailtrap.rb

@@ -24,19 +24,19 @@ module Howitzer
       # @return [String] plain text body of the email message
 
       def plain_text_body
-        message['text_body']
+        Howitzer::MailtrapApi::Client.new.get_txt_body(message)
       end
 
       # @return [String] html body of the email message
 
       def html_body
-        message['html_body']
+        Howitzer::MailtrapApi::Client.new.get_html_body(message)
       end
 
       # @return [String] stripped text
 
       def text
-        message['text_body']
+        Howitzer::MailtrapApi::Client.new.get_raw_body(message)
       end
 
       # @return [String] an email address specified in `From` field

data/lib/howitzer/mail_adapters/onesecmail.rb

@@ -0,0 +1,80 @@
+require 'howitzer/exceptions'
+require 'howitzer/mail_adapters/abstract'
+require 'howitzer/onesecmail_api/client'
+
+module Howitzer
+  module MailAdapters
+    # This class represents 1secMail mail adapter
+    class Onesecmail < 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['body']
+      end
+
+      # @return [String] html body of the email message
+
+      def html_body
+        message['htmlBody']
+      end
+
+      # @return [String] stripped text
+
+      def text
+        message['textBody']
+      end
+
+      # @return [String] an email address specified in `From` field
+
+      def mail_from
+        message['from']
+      end
+
+      # @return [String] when email was received
+
+      def received_time
+        Time.parse(message['date']).to_s
+      end
+
+      # @return [String] a real sender email address
+
+      def sender_email
+        message['from']
+      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::OnesecmailApi::Client.new.find_message(recipient, subject)
+        raise Howitzer::EmailNotFoundError, 'Message not received yet, retry...' unless message
+
+        message
+      end
+      private_class_method :retrieve_message
+    end
+  end
+end

data/lib/howitzer/mail_adapters/testmail.rb

@@ -0,0 +1,102 @@
+require 'howitzer/exceptions'
+require 'howitzer/mail_adapters/abstract'
+require 'howitzer/testmail_api/client'
+
+module Howitzer
+  module MailAdapters
+    # This class represents testmail.app mail adapter
+    class Testmail < 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']
+      end
+
+      # @return [String] html body of the email message
+
+      def html_body
+        message['html']
+      end
+
+      # @return [String] stripped text
+
+      def text
+        message['text']
+      end
+
+      # @return [String] an email address specified in `From` field
+
+      def mail_from
+        message['from']
+      end
+
+      # @return [String] recipient emails separated with `, `
+
+      def recipients
+        message['to'].split ', '
+      end
+
+      # @return [String] when email was received
+
+      def received_time
+        Time.parse(message['timestamp']).to_s
+      end
+
+      # @return [String] a real sender email address
+
+      def sender_email
+        message['from']
+      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.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::TestmailApi::Client.new.find_message(recipient, subject)
+        raise Howitzer::EmailNotFoundError, 'Message not received yet, retry...' unless message
+
+        message
+      end
+      private_class_method :retrieve_message
+    end
+  end
+end

data/lib/howitzer/mailgun_api/client.rb

@@ -9,9 +9,10 @@ module Howitzer
     # wrapper around RestClient so you don't have to worry about the HTTP aspect
     # of communicating with Mailgun API.
     class Client
-      USER_AGENT = 'mailgun-sdk-ruby'.freeze #:nodoc:
+      USER_AGENT = 'mailgun-sdk-ruby'.freeze # :nodoc:
       attr_reader :api_user, :api_key, :api_host, :api_version, :ssl
-      def initialize(api_user: 'api', api_key:, api_host: 'api.mailgun.net', api_version: 'v3', ssl: true)
+
+      def initialize(api_user: 'api', api_key: 'key', api_host: 'api.mailgun.net', api_version: 'v3', ssl: true)
         @api_user = api_user
         @api_key = api_key
         @api_host = api_host

data/lib/howitzer/mailgun_api/response.rb

@@ -6,8 +6,7 @@ module Howitzer
     # by the Client request. The Response object supports deserialization of
     # the JSON result.
     class Response
-      attr_accessor :body
-      attr_accessor :code
+      attr_accessor :body, :code
 
       def initialize(response)
         @body = response.body

data/lib/howitzer/mailtrap_api/client.rb

@@ -5,7 +5,7 @@ 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:
+      BASE_URL = "https://mailtrap.io/api/v1/inboxes/#{Howitzer.mailtrap_inbox_id}".freeze # :nodoc:
 
       def initialize
         @api_token = Howitzer.mailtrap_api_token
@@ -32,6 +32,24 @@ module Howitzer
         JSON.parse(RestClient.get("#{BASE_URL}/messages/#{message['id']}/attachments", 'Api-Token' => @api_token))
       end
 
+      def get_html_body(message)
+        RestClient.get("#{BASE_URL}/messages/#{message['id']}/body.html", 'Api-Token' => @api_token).body
+      rescue => e
+        raise Howitzer::CommunicationError, e.message
+      end
+
+      def get_txt_body(message)
+        RestClient.get("#{BASE_URL}/messages/#{message['id']}/body.txt", 'Api-Token' => @api_token).body
+      rescue => e
+        raise Howitzer::CommunicationError, e.message
+      end
+
+      def get_raw_body(message)
+        RestClient.get("#{BASE_URL}/messages/#{message['id']}/body.raw", 'Api-Token' => @api_token).body
+      rescue => e
+        raise Howitzer::CommunicationError, e.message
+      end
+
       private
 
       def messages(recipient)