howitzer 1.1.1 → 2.0.0

data/lib/howitzer/capybara_helpers.rb

@@ -0,0 +1,194 @@
+require 'rest-client'
+require 'howitzer/exceptions'
+
+module Howitzer
+  # This module holds capybara helpers methods
+  module CapybaraHelpers
+    CHECK_YOUR_SETTINGS_MSG = 'Please check your settings'.freeze
+
+    # @return [Boolean] true if current driver related with SauceLab,
+    #   Testingbot or Browserstack cloud service
+
+    def cloud_driver?
+      [:sauce, :testingbot, :browserstack].include?(Howitzer.driver.to_sym)
+    end
+
+    # @return [Boolean] whether or not current browser is
+    #   Internet Explorer.
+    # @raise [CloudBrowserNotSpecifiedError] if cloud driver and missing browser name
+    # @raise [SelBrowserNotSpecifiedError] if selenium driver and missing browser name
+
+    def ie_browser?
+      browser? :ie, :iexplore
+    end
+
+    # @return [Boolean] whether or not current browser is FireFox.
+    # @raise [CloudBrowserNotSpecifiedError] if cloud driver and missing browser name
+    # @raise [SelBrowserNotSpecifiedError] if selenium driver and missing browser name
+
+    def ff_browser?
+      browser? :ff, :firefox
+    end
+
+    # @return [Boolean] whether or not current browser is Google Chrome.
+    # @raise [CloudBrowserNotSpecifiedError] if cloud driver and missing browser name
+    # @raise [SelBrowserNotSpecifiedError] if selenium driver and missing browser name
+
+    def chrome_browser?
+      browser? :chrome
+    end
+
+    # @return [Boolean] whether or not current browser is Safari.
+    # @raise [CloudBrowserNotSpecifiedError] if cloud driver and missing browser name
+    # @raise [SelBrowserNotSpecifiedError] if selenium driver and missing browser name
+
+    def safari_browser?
+      browser? :safari
+    end
+
+    # @param time_in_numeric [Integer] number of seconds
+    # @return [String] formatted duration time
+
+    def duration(time_in_numeric)
+      secs = time_in_numeric.to_i
+      mins = secs / 60
+      hours = mins / 60
+      return "[#{hours}h #{mins % 60}m #{secs % 60}s]" if hours.positive?
+      return "[#{mins}m #{secs % 60}s]" if mins.positive?
+      return "[0m #{secs}s]" if secs >= 0
+    end
+
+    # Updates a job status on the job cloud
+    # @note SauceLabs is currently supported only
+    # @param json_data [String] (for example, {passed: true})
+
+    def update_cloud_job_status(json_data = {})
+      case Howitzer.driver.to_sym
+      when :sauce then update_sauce_job_status(json_data)
+      else
+        '[NOT IMPLEMENTED]'
+      end
+    end
+
+    # Tries to load appropriate driver gem
+    # @param driver [String] a driver name
+    # @param lib [String] what is required to load
+    # @param gem [String] a gem name
+    # @raise [LoadError] if the gem is missing in a bunder context
+
+    def load_driver_gem!(driver, lib, gem)
+      require lib
+    rescue LoadError
+      raise LoadError,
+            "`:#{driver}` driver is unable to load `#{lib}`, please add `gem '#{gem}'` to your Gemfile."
+    end
+
+    # @return [Hash] selenium capabilities required for a cloud driver
+
+    def required_cloud_caps
+      {
+        platform: Howitzer.cloud_platform,
+        browserName: Howitzer.cloud_browser_name,
+        version: Howitzer.cloud_browser_version,
+        name: "#{prefix_name} #{Howitzer.cloud_browser_name}"
+      }
+    end
+
+    # Buids selenium driver for a cloud service
+    # @param app [<Rack>] a rack application that this server will contain
+    # @param caps [Hash] remote capabilities
+    # @param url [String] a remote hub url
+    # @return [Capybara::Selenium::Driver]
+
+    def cloud_driver(app, caps, url)
+      http_client = ::Selenium::WebDriver::Remote::Http::Default.new
+      http_client.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)
+      driver.browser.file_detector = remote_file_detector
+      driver
+    end
+
+    # @return [String] path to cloud resources (logs, videos, etc.)
+    # @note Currently SauceLabs is supported only
+    # @raise [ArgumentError] if unknown kind
+
+    def cloud_resource_path(kind)
+      case Howitzer.driver.to_sym
+      when :sauce then sauce_resource_path(kind)
+      else
+        '[NOT IMPLEMENTED]'
+      end
+    end
+
+    private
+
+    def browser?(*browser_aliases)
+      return cloud_browser?(*browser_aliases) if cloud_driver?
+      return selenium_browser?(*browser_aliases) if selenium_driver? || selenium_grid_driver?
+    end
+
+    def cloud_browser?(*browser_aliases)
+      unless Howitzer.cloud_browser_name.nil?
+        return browser_aliases.include?(Howitzer.cloud_browser_name.to_s.to_sym)
+      end
+      raise Howitzer::CloudBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG
+    end
+
+    def selenium_browser?(*browser_aliases)
+      unless Howitzer.selenium_browser.nil?
+        return browser_aliases.include?(Howitzer.selenium_browser.to_s.to_sym)
+      end
+      raise Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG
+    end
+
+    def selenium_driver?
+      Howitzer.driver.to_sym == :selenium
+    end
+
+    def selenium_grid_driver?
+      Howitzer.driver.to_sym == :selenium_grid
+    end
+
+    def prefix_name
+      (Howitzer.current_rake_task || 'ALL').upcase
+    end
+
+    def sauce_resource_path(kind)
+      name =
+        case kind
+        when :video then 'video.flv'
+        when :server_log then 'selenium-server.log'
+        else
+          raise ArgumentError, "Unknown '#{kind}' kind"
+        end
+      host = "https://#{Howitzer.cloud_auth_login}:#{Howitzer.cloud_auth_pass}@saucelabs.com"
+      path = "/rest/#{Howitzer.cloud_auth_login}/jobs/#{session_id}/results/#{name}"
+      "#{host}#{path}"
+    end
+
+    def update_sauce_job_status(json_data = {})
+      host = "http://#{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
+    end
+
+    def session_id
+      Capybara.current_session.driver.browser.instance_variable_get(:@bridge).session_id
+    end
+
+    def remote_file_detector
+      lambda do |args|
+        str = args.first.to_s
+        str if File.exist?(str)
+      end
+    end
+  end
+end

data/lib/howitzer/email.rb

@@ -1,134 +1,126 @@
 require 'rspec/matchers'
-require 'howitzer/mailgun/connector'
 require 'howitzer/exceptions'
 
-class Email
-  include RSpec::Matchers
+module Howitzer
+  # This class describes single email
+  class Email
+    include ::RSpec::Matchers
 
-  ##
-  #
-  # Creates new email with message
-  #
-  # *Parameters:*
-  # * +message+ - email message
-  #
+    attr_reader :message
 
-  def initialize(message)
-    @message = message
-  end
+    # @return [<MailAdapters::Abstract>] a mail adapter class
+
+    def self.adapter
+      return @adapter if @adapter
+      self.adapter = Howitzer.mail_adapter.to_sym
+      @adapter
+    end
 
-  ##
-  #
-  # Search mail by recepient
-  #
-  # *Parameters:*
-  # * +recepient+ - recepient's email address
-  #
+    class << self
+      attr_reader :adapter_name
 
-  def self.find_by_recipient(recipient)
-    find(recipient, self::SUBJECT)
-  end
+      protected
 
-  ##
-  #
-  # Search mail by recepient and subject.
-  #
-  # *Parameters:*
-  # * +recepient+ - recepient's email address
-  # * +subject+ - email subject
-  #
-
-  def self.find(recipient, subject)
-    message = {}
-    retryable(timeout: settings.timeout_small, sleep: settings.timeout_short, silent: true, logger: log, on: Howitzer::EmailNotFoundError) do
-      events = Mailgun::Connector.instance.client.get("#{Mailgun::Connector.instance.domain}/events", event: 'stored')
-      event = events.to_h['items'].find do |hash|
-        hash['message']['recipients'].first == recipient && hash['message']['headers']['subject'] == subject
+      # DSL method to specify a subject pattern directly in an email class
+      # @param value [String] an email subject with optional placeholders (strings started with : symbol)
+      # @example
+      #   class WelcomeEmail < Howitzer::Email
+      #     subject 'Welcome on board :name'
+      #   end
+      #
+      #   WelcomeEmail.find_by_recipient('john.smith@example.com', name: 'John')
+      # @!visibility public
+
+      def subject(value)
+        @subject = value
       end
-      if event
-        message = Mailgun::Connector.instance.client.get_url(event['storage']['url']).to_h
-      else
-        raise Howitzer::EmailNotFoundError.new('Message not received yet, retry...')
+    end
+
+    # Specifies a mail adapter
+    # @param adapter_name [String, Symbol] an email adapter name
+    # @raise [NoMailAdapterError] when the adapter name is not String or Symbol
+
+    def self.adapter=(adapter_name)
+      @adapter_name = adapter_name
+      case adapter_name
+        when Symbol, String
+          require "howitzer/mail_adapters/#{adapter_name}"
+          @adapter = MailAdapters.const_get(adapter_name.to_s.capitalize.to_s)
+        else
+          raise Howitzer::NoMailAdapterError
       end
     end
-    log.error Howitzer::EmailNotFoundError, "Message with subject '#{subject}' for recipient '#{recipient}' was not found." if message.empty?
-    new(message)
-  end
 
-  ##
-  #
-  # Returns plain text body of email message
-  #
+    # Searches a mail by a recepient
+    # @param recepient [String] recepient's email address
+    # @param params [Hash] placeholders with appropriate values
+    # @raise [NoEmailSubjectError] when a subject is not specified for the email class
+    # @return [Email] an instance of the email message
+    # @see .subject
+
+    def self.find_by_recipient(recipient, params = {})
+      raise Howitzer::NoEmailSubjectError, "Please specify email subject. For example:\n" \
+                                  "class SomeEmail < Howitzer::Email\n" \
+                                  "  subject ‘some subject text’\nend" if @subject.nil?
+      new(adapter.find(recipient, expand_subject(params)))
+    end
 
-  def plain_text_body
-    @message['body-plain']
-  end
+    def initialize(message)
+      @message = message
+    end
 
-  ##
-  #
-  # Returns html body of email message
-  #
+    # @return [String, nil] a plain text of the email message
 
-  def html_body
-    @message['stripped-html']
-  end
+    def plain_text_body
+      message.plain_text_body
+    end
 
-  ##
-  #
-  # Returns mail text
-  #
+    # @return [String, nil] a html body of the email message
 
-  def text
-    @message['stripped-text']
-  end
+    def html_body
+      message.html_body
+    end
 
-  ##
-  #
-  # Returns who has send email data in format: User Name <user@email>
-  #
+    # @return [String, nil] a mail text
 
-  def mail_from
-    @message['From']
-  end
+    def text
+      message.text
+    end
 
-  ##
-  #
-  # Returns array of recipients who has received current email
-  #
+    # @return [String] who has sent the email data in format: User Name <user@email>
 
-  def recipients
-    @message['To'].split ', '
-  end
+    def mail_from
+      message.mail_from
+    end
 
-  ##
-  #
-  # Returns email received time in format:
-  #
+    # @return [Array<String>] array of recipients who has received current email
 
-  def received_time
-    @message['Received'][/\w+, \d+ \w+ \d+ \d+:\d+:\d+ -\d+ \(\w+\)$/]
-  end
+    def recipients
+      message.recipients
+    end
 
-  ##
-  #
-  # Returns sender user email
-  #
+    # @return [String] email received time
 
-  def sender_email
-    @message['sender']
-  end
+    def received_time
+      message.received_time
+    end
 
-  ##
-  #
-  # Allows to get email MIME attachment
-  #
+    # @return [String] a sender user email
+
+    def sender_email
+      message.sender_email
+    end
+
+    # Allows to get email MIME attachment
+
+    def mime_part
+      message.mime_part
+    end
 
-  def get_mime_part
-    files = @message['attachments']
-    if files.empty?
-      log.error Howitzer::NoAttachmentsError, 'No attachments where found.'
-      return
+    def self.expand_subject(params)
+      params.each { |k, v| @subject.sub!(":#{k}", v.to_s) }
+      @subject
     end
-    files
+    private_class_method :expand_subject
   end
 end

data/lib/howitzer/exceptions.rb

@@ -1,18 +1,22 @@
+# This module holds all custom howitzer exceptions
 module Howitzer
   CommunicationError = Class.new(StandardError)
   ParseError = Class.new(StandardError)
   InvalidApiKeyError = Class.new(StandardError)
-  LocatorNotDefinedError = Class.new(StandardError)
-  BadLocatorParamsError = Class.new(StandardError)
-  WrongOptionError = Class.new(StandardError)
+  BadElementParamsError = Class.new(StandardError)
   NoValidationError = Class.new(StandardError)
   UnknownValidationError = Class.new(StandardError)
   EmailNotFoundError = Class.new(StandardError)
   NoAttachmentsError = Class.new(StandardError)
   DriverNotSpecifiedError = Class.new(StandardError)
-  SlBrowserNotSpecifiedError = Class.new(StandardError)
-  TbBrowserNotSpecifiedError = Class.new(StandardError)
+  UnknownDriverError = Class.new(StandardError)
+  CloudBrowserNotSpecifiedError = Class.new(StandardError)
   SelBrowserNotSpecifiedError = Class.new(StandardError)
+  UnknownBrowserError = Class.new(StandardError)
   IncorrectPageError = Class.new(StandardError)
   AmbiguousPageMatchingError = Class.new(StandardError)
-end
+  NoMailAdapterError = Class.new(StandardError)
+  NoPathForPageError = Class.new(StandardError)
+  NoEmailSubjectError = Class.new(StandardError)
+  NoDataError = Class.new(StandardError)
+end