howitzer 1.0.1 → 1.0.2

data/lib/howitzer/email.rb

@@ -0,0 +1,134 @@
+require 'rspec/matchers'
+require 'howitzer/mailgun/connector'
+require 'howitzer/exceptions'
+
+class Email
+  include RSpec::Matchers
+
+  ##
+  #
+  # Creates new email with message
+  #
+  # *Parameters:*
+  # * +message+ - email message
+  #
+
+  def initialize(message)
+    @message = message
+  end
+
+  ##
+  #
+  # Search mail by recepient
+  #
+  # *Parameters:*
+  # * +recepient+ - recepient's email address
+  #
+
+  def self.find_by_recipient(recipient)
+    find(recipient, self::SUBJECT)
+  end
+
+  ##
+  #
+  # 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
+      end
+      if event
+        message = Mailgun::Connector.instance.client.get("domains/#{Mailgun::Connector.instance.domain}/messages/#{event['storage']['key']}").to_h
+      else
+        raise Howitzer::EmailNotFoundError.new('Message not received yet, retry...')
+      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
+  #
+
+  def plain_text_body
+    @message['body-plain']
+  end
+
+  ##
+  #
+  # Returns html body of email message
+  #
+
+  def html_body
+    @message['stripped-html']
+  end
+
+  ##
+  #
+  # Returns mail text
+  #
+
+  def text
+    @message['stripped-text']
+  end
+
+  ##
+  #
+  # Returns who has send email data in format: User Name <user@email>
+  #
+
+  def mail_from
+    @message['From']
+  end
+
+  ##
+  #
+  # Returns array of recipients who has received current email
+  #
+
+  def recipients
+    @message['To'].split ', '
+  end
+
+  ##
+  #
+  # Returns email received time in format:
+  #
+
+  def received_time
+    @message['Received'][/\w+, \d+ \w+ \d+ \d+:\d+:\d+ -\d+ \(\w+\)$/]
+  end
+
+  ##
+  #
+  # Returns sender user email
+  #
+
+  def sender_email
+    @message['sender']
+  end
+
+  ##
+  #
+  # Allows to get email MIME attachment
+  #
+
+  def get_mime_part
+    files = @message['attachments']
+    if files.empty?
+      log.error Howitzer::NoAttachmentsError, 'No attachments where found.'
+      return
+    end
+    files
+  end
+end

data/lib/howitzer/exceptions.rb

@@ -0,0 +1,18 @@
+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)
+  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)
+  SelBrowserNotSpecifiedError = Class.new(StandardError)
+  IncorrectPageError = Class.new(StandardError)
+  AmbiguousPageMatchingError = Class.new(StandardError)
+end

data/lib/howitzer/helpers.rb

@@ -1,38 +1,37 @@
-DriverNotSpecified = Class.new(StandardError)
-SlBrowserNameNotSpecified = Class.new(StandardError)
-TbBrowserNameNotSpecified = Class.new(StandardError)
-SelBrowserNotSpecified = Class.new(StandardError)
+require 'howitzer/exceptions'
+
 CHECK_YOUR_SETTINGS_MSG = "Please check your settings"
-DRIVER_NOT_SPECIFIED = DriverNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
-SL_BROWSER_NAME_NOT_SPECIFIED = SlBrowserNameNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
-TB_BROWSER_NAME_NOT_SPECIFIED = TbBrowserNameNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
-SEL_BROWSER_NOT_SPECIFIED = SelBrowserNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
 
 def sauce_driver?
-  raise DRIVER_NOT_SPECIFIED if settings.driver.nil?
+  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
   settings.driver.to_sym == :sauce
 end
 
 def testingbot_driver?
-  raise DRIVER_NOT_SPECIFIED if settings.driver.nil?
+  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
   settings.driver.to_sym == :testingbot
 end
 
 def selenium_driver?
-  raise DRIVER_NOT_SPECIFIED if settings.driver.nil?
+  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
   settings.driver.to_sym == :selenium
 end
 
+def phantomjs_driver?
+  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
+  settings.driver.to_sym == :phantomjs
+end
+
 def ie_browser?
   ie_browsers = [:ie, :iexplore]
   if sauce_driver?
-    raise SL_BROWSER_NAME_NOT_SPECIFIED if settings.sl_browser_name.nil?
+    log.error Howitzer::SlBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sl_browser_name.nil?
     ie_browsers.include?(settings.sl_browser_name.to_sym)
   elsif testingbot_driver?
-    raise TB_BROWSER_NAME_NOT_SPECIFIED if settings.tb_browser_name.nil?
+    log.error Howitzer::TbBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.tb_browser_name.nil?
     ie_browsers.include?(settings.tb_browser_name.to_sym)
   elsif selenium_driver?
-    raise SEL_BROWSER_NOT_SPECIFIED if settings.sel_browser.nil?
+    log.error Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sel_browser.nil?
     ie_browsers.include?(settings.sel_browser.to_sym)
   end
 end
@@ -40,13 +39,13 @@ end
 def ff_browser?
   ff_browsers = [:ff, :firefox]
   if sauce_driver?
-    raise SL_BROWSER_NAME_NOT_SPECIFIED if settings.sl_browser_name.nil?
+    log.error Howitzer::SlBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sl_browser_name.nil?
     ff_browsers.include?(settings.sl_browser_name.to_sym)
   elsif testingbot_driver?
-    raise TB_BROWSER_NAME_NOT_SPECIFIED if settings.tb_browser_name.nil?
+    log.error Howitzer::TbBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.tb_browser_name.nil?
     ff_browsers.include?(settings.tb_browser_name.to_sym)
   elsif selenium_driver?
-    raise SEL_BROWSER_NOT_SPECIFIED if settings.sel_browser.nil?
+    log.error Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sel_browser.nil?
     ff_browsers.include?(settings.sel_browser.to_sym)
   end
 end
@@ -55,13 +54,13 @@ end
 def chrome_browser?
   chrome_browser = :chrome
   if sauce_driver?
-    raise SL_BROWSER_NAME_NOT_SPECIFIED if settings.sl_browser_name.nil?
+    log.error Howitzer::SlBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sl_browser_name.nil?
     settings.sl_browser_name.to_sym == chrome_browser
   elsif testingbot_driver?
-    raise TB_BROWSER_NAME_NOT_SPECIFIED if settings.tb_browser_name.nil?
+    log.error Howitzer::TbBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.tb_browser_name.nil?
     settings.tb_browser_name.to_sym == chrome_browser
   elsif selenium_driver?
-    raise SEL_BROWSER_NOT_SPECIFIED if settings.sel_browser.nil?
+    log.error Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sel_browser.nil?
     settings.sel_browser.to_sym == chrome_browser
   end
 end
@@ -136,9 +135,12 @@ class String
   # Returns page instance
   #
 
-
   def given
-    as_page_class.new
+    as_page_class.given
+  end
+
+  def wait_for_opened
+    as_page_class.wait_for_opened
   end
 
   ##
@@ -147,6 +149,15 @@ class String
   #
 
   def as_page_class
-    Object.const_get("#{self.capitalize}Page")
+    as_class('Page')
+  end
+
+  def as_email_class
+    as_class('Email')
+  end
+
+  private
+  def as_class(type)
+    "#{self.gsub(/\s/, '_').camelize}#{type}".constantize
   end
 end

data/lib/howitzer/init.rb

@@ -1,4 +1 @@
-include DataGenerator
-
-# Configure mail client
-Mailgun::init(settings.mailgun_api_key)
+include DataGenerator

data/lib/howitzer/mailgun/client.rb

@@ -0,0 +1,48 @@
+require 'rest_client'
+require 'json'
+require 'howitzer/mailgun/response'
+require 'howitzer/exceptions'
+
+module Mailgun
+
+  # A Mailgun::Client object is used to communicate with the Mailgun API. It is a
+  # wrapper around RestClient so you don't have to worry about the HTTP aspect
+  # of communicating with our API.
+
+  class Client
+
+    def initialize(api_key, api_host="api.mailgun.net", api_version="v2", ssl=true)
+      endpoint = endpoint_generator(api_host, api_version, ssl)
+      @http_client = RestClient::Resource.new(endpoint,
+                                              :user => "api",
+                                              :password => api_key,
+                                              :user_agent => "mailgun-sdk-ruby/1.0.1")
+    end
+
+    # Generic Mailgun GET Handler
+    #
+    # @param [String] resource_path This is the API resource you wish to interact
+    # with. Be sure to include your domain, where necessary.
+    # @param [Hash] query_string This should be a standard Hash
+    # containing required parameters for the requested resource.
+    # @return [Mailgun::Response] A Mailgun::Response object.
+
+    def get(resource_path, params=nil, accept="*/*")
+      http_params = {:accept => accept}
+      http_params = http_params.merge(params: params) if params
+      response = @http_client[resource_path].get(http_params)
+      Response.new(response)
+    rescue => e
+      log.error Howitzer::CommunicationError, e.message
+    end
+
+    private
+
+    def endpoint_generator(api_host, api_version, ssl)
+      scheme = "http#{'s' if ssl}"
+      res = "#{scheme}://#{api_host}"
+      res << "/#{api_version}" if api_version
+      res
+    end
+  end
+end

data/lib/howitzer/mailgun/connector.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+require 'howitzer/mailgun/client'
+require 'howitzer/exceptions'
+
+module Mailgun
+  class Connector
+    include Singleton
+
+    attr_reader :api_key
+
+    def client(api_key=settings.mailgun_key)
+      check_api_key(api_key)
+      if @api_key == api_key && @api_key
+        @client
+      else
+        @api_key = api_key
+        @client = Mailgun::Client.new(@api_key)
+      end
+    end
+
+    def domain
+      @domain || change_domain
+    end
+
+    def change_domain(domain_name=settings.mailgun_domain)
+      @domain = domain_name
+    end
+
+    private
+    def check_api_key(api_key)
+      log.error Howitzer::InvalidApiKeyError, "Api key can not be blank" if api_key.blank?
+    end
+  end
+end

data/lib/howitzer/mailgun/response.rb

@@ -0,0 +1,28 @@
+require 'howitzer/exceptions'
+
+module Mailgun
+  # A Mailgun::Response object is instantiated for each response generated
+  # by the Client request. The Response object supports deserialization of
+  # the JSON result.
+
+  class Response
+
+    attr_accessor :body
+    attr_accessor :code
+
+    def initialize(response)
+      @body = response.body
+      @code = response.code
+    end
+
+    # Return response as Ruby Hash
+    #
+    # @return [Hash] A standard Ruby Hash containing the HTTP result.
+
+    def to_h
+      JSON.parse(@body)
+    rescue Exception => e
+      log.error Howitzer::ParseError, e.message
+    end
+  end
+end

data/lib/howitzer/utils.rb

@@ -1,5 +1,5 @@
 require 'repeater'
-require 'capybara'
-require 'selenium-webdriver'
+require 'active_support'
+require 'active_support/core_ext'
 
 Dir[File.join(File.dirname(__FILE__), "./utils/**/*.rb")].each {|f| require f}

data/lib/howitzer/utils/data_generator/data_storage.rb

@@ -6,10 +6,11 @@ module DataGenerator
   #
 
   module DataStorage
+    SPECIAL_NS_LIST = ['sauce']
     @data ||= {}
 
     class << self
-
+      attr_reader :data
       ##
       #
       # Saves data into memory. Marking by namespace and key
@@ -52,13 +53,25 @@ module DataGenerator
         init_ns(ns)
       end
 
+      ##
+      #
+      # Deletes all namespaces with data
+      #
+      # *Parameters:*
+      # * +exception_list+ - Array of special namespaces for excluding
+      #
+
+      def clear_all_ns(exception_list=SPECIAL_NS_LIST)
+        (@data.keys - exception_list).each {|ns| clear_ns(ns) }
+      end
+
       private
 
       def check_ns(ns)
         if ns
           init_ns(ns) if ns_absent?(ns)
         else
-          raise 'Data storage namespace can not be empty'
+          log.error 'Data storage namespace can not be empty'
         end
       end
 

data/lib/howitzer/utils/data_generator/gen.rb

@@ -72,18 +72,18 @@ module DataGenerator
       ##
       #
       # Deletes mailboxes for all users that were generated before
-      #
+      #@deprecated
 
+      #:nocov:
       def delete_all_mailboxes
-        DataStorage.extract('user').each_value do |user|
-          user.delete_mailbox
-        end
+        warn "[WARN] Method '#{__method__}' has not been using anymore. You have to remove usage from here #{caller.first}"
       end
+      #:nocov:
 
       private
 
       def gen_user_email(serial=nil)
-        "#{gen_user_name(serial)}@#{settings.mail_pop3_domain}"
+        "#{gen_user_name(serial)}@#{settings.mailgun_domain}"
       end
 
       def gen_user_name(serial=nil)
@@ -105,7 +105,7 @@ module DataGenerator
 
     class User < Object
 
-      attr_reader :login, :domain, :email, :password, :mailbox, :first_name, :last_name, :full_name
+      attr_reader :login, :domain, :email, :password, :first_name, :last_name, :full_name
 
       def initialize(params={})
         @email = params.delete(:email)
@@ -115,17 +115,21 @@ module DataGenerator
         @first_name = params.delete(:first_name)
         @last_name = params.delete(:last_name)
         @full_name = "#@first_name #@last_name"
-        @mailbox = params.delete(:mailbox)
       end
 
+      #@deprecated
+      #:nocov:
       def create_mailbox
-        @mailbox = MailClient.create_mailbox(@email_name) if settings.mail_pop3_domain == @domain
-        self
+        warn "[WARN] Method '#{__method__}' has not been using anymore. You have to remove usage from here #{caller.first}"
       end
+      #:nocov:
 
+      #@deprecated
+      #:nocov:
       def delete_mailbox
-        MailClient.delete_mailbox(@mailbox) unless @mailbox.nil?
+        warn "[WARN] Method '#{__method__}' has not been using anymore. You have to remove usage from here #{caller.first}"
       end
+      #:nocov:
     end
   end
 end