ams_layout 0.0.2

data/lib/ams_layout/delegate_writer.rb

@@ -0,0 +1,348 @@
+##############################################################################
+# File::    delegate_writer.rb
+# Purpose:: Generate a ruby source file that is a delegate class containing
+#           the fields on the Loan Entry screen.
+# 
+# Author::    Jeff McAffee 06/23/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ams_layout/core_ext'
+
+module AmsLayout
+  class DelegateWriter
+
+    attr_writer :source_file_name
+    attr_writer :class_name
+    attr_writer :delegated_class_name
+    #attr_writer :aliases
+
+    ##
+    # Name of this class' source file
+    #
+
+    def source_file_name
+      class_name.ams_layout_snakecase + '.rb'
+    end
+
+    ##
+    # Name of this class
+    #
+
+    def class_name
+      @class_name ||= AmsLayout.configuration.delegate_class_name
+    end
+
+    ##
+    # Name of class we will delegate to
+    #
+
+    def delegated_class_name
+      @delegated_class_name ||= AmsLayout.configuration.layout_class_name
+    end
+
+    ##
+    # List of aliases for specified fields
+    #
+
+    def aliases
+      @aliases ||= {}
+    end
+
+    def aliases=(data)
+      @aliases = Hash(data)
+    end
+
+    ##
+    # Write a class file, based on the the layout.yml, to the provided stream
+    #
+
+    def write stream, layout
+      stream << header
+
+      layout.each do |section_label, fields|
+        stream << section(section_label)
+
+        fields.each do |fld|
+          stream << field(fld[:label], fld[:id], fld[:type])
+          write_aliases stream, fld[:label], fld[:id], fld[:type]
+        end # fields
+      end # layout
+
+      stream << footer
+    end
+
+  private
+
+    ##
+    # Write a field's aliases to the stream
+    #
+
+    def write_aliases stream, label, id, type
+      label_aliases = aliases.key?(label) ? aliases[label] : []
+      label_aliases.each do |al|
+        stream << field_alias(al, id, type)
+      end
+    end
+
+    ##
+    # Emit a file header
+    #
+
+    def header
+      text =<<TEXT
+#############################################################################
+# #{source_file_name}
+#
+# This file has been generated by AmsLayout.
+# Do not modify this file manually.
+#
+#############################################################################
+
+require_relative 'loan_entry_fields'
+require 'nokogiri'
+
+class #{class_name} < DelegateClass(#{delegated_class_name})
+
+  ##
+  # Capture and parse the page's raw HTML with Nokogiri
+  # Returns a Nokogiri::HTML document
+  #
+
+  def html_doc
+    @html_doc ||= Nokogiri::HTML(__getobj__.raw_html)
+      #Nokogiri::HTML(html).css("table#ctl00_ContentPlaceHolder1_tblMain").each do |tbl|
+  end
+
+  ##
+  # Return the first element matching the given ID
+  # Returns a Nokogiri Element
+  #
+
+  def noko_element(id)
+    html_doc.css(id).first
+  end
+
+  ##
+  # Returns true if element is checked
+  #
+
+  def checked?(id)
+    # el['type'] = 'checkbox'
+    is_checked = noko_element(id)['checked']
+    ! is_checked.nil?
+  end
+
+  ##
+  # Returns a text element's value
+  #
+
+  def get_text_element_value(id)
+    # el['type'] = 'text'
+    value = noko_element(id)['value']
+  end
+
+  ##
+  # Returns a textarea element's value
+  #
+
+  def get_textarea_element_value(id)
+    noko_element(id).text
+  end
+
+  ##
+  # Returns the selected option, '-- Please Select --' if no option is selected
+  #
+
+  def get_selected_option id
+    elem = noko_element(id)
+    elem.children.each do |c|
+      if c.attributes.key? 'selected'
+        return c.text
+      end
+    end
+
+    # Return the default value if nothing is selected
+    '-- Please Select --'
+  end
+
+  #
+  # Fields (ordered by section as seen on screen)
+  #
+TEXT
+    end
+
+    ##
+    # Emit a section header
+    #
+
+    def section label
+      text =<<TEXT
+
+
+  # Section: #{label}
+TEXT
+    end
+
+    ##
+    # Emit field methods
+    #
+
+    def field label, id, type
+      case type
+      when 'text'
+        return text_field_methods(label, id, type)
+      when 'textarea'
+        return textarea_field_methods(label, id, type)
+      when 'select'
+        return select_field_methods(label, id, type)
+      when 'checkbox'
+        return checkbox_field_methods(label, id, type)
+      else
+        return "\n# unknown_field_type: #{label}, #{id}, #{type}\n"
+      end
+    end
+
+    ##
+    # Emit field methods for aliased fields
+    #
+
+    def field_alias label, id, type
+      field label, id, type
+    end
+
+    ##
+    # Emit text field methods
+    #
+
+    def text_field_methods label, id, type
+      field_label = label.ams_layout_snakecase
+      field_id = '#' + id
+
+      if field_id.include? 'PlaceHolder1_cn'
+        return float_field_methods label, id, type
+      end
+
+      text =<<TEXT
+
+  def #{field_label}=(value)
+    if get_text_element_value('#{field_id}') != value
+      super(value)
+    # else skip sending the value.
+    end
+  end
+TEXT
+    end
+
+    ##
+    # Emit float field methods
+    #
+
+    def float_field_methods label, id, type
+      field_label = label.ams_layout_snakecase
+      field_id = '#' + id
+
+      text =<<TEXT
+
+  def #{field_label}=(value)
+    current_value = get_text_element_value('#{field_id}')
+
+    current_value = '0' if current_value.empty?
+    value = '0' if value.empty?
+
+    if ((Float(current_value) * 1000) != (Float(value) * 1000))
+      super(value)
+    # else skip sending the value.
+    end
+  end
+TEXT
+    end
+
+    ##
+    # Emit textarea field methods
+    #
+
+    def textarea_field_methods label, id, type
+      field_label = label.ams_layout_snakecase
+      field_id = '#' + id
+
+      text =<<TEXT
+
+  def #{field_label}=(value)
+    if get_textarea_element_value('#{field_id}') != value
+      super(value)
+    # else skip sending the value.
+    end
+  end
+TEXT
+    end
+
+    ##
+    # Emit select field methods
+    #
+
+    def select_field_methods label, id, type
+      field_label = label.ams_layout_snakecase
+      field_id = '#' + id
+
+      text =<<TEXT
+
+  def #{field_label}=(value)
+    if get_selected_option('#{field_id}') != value
+      super(value)
+    # else skip sending the value.
+    end
+  end
+TEXT
+    end
+
+    ##
+    # Emit checkbox field methods
+    #
+
+    def checkbox_field_methods label, id, type
+      field_label = label.ams_layout_snakecase
+      field_id = '#' + id
+
+      text =<<TEXT
+
+  def check_#{field_label}
+    if ! checked?('#{field_id}')
+      super()
+    # else skip sending the value.
+    end
+  end
+
+  def uncheck_#{field_label}
+    if checked?('#{field_id}')
+      super()
+    # else skip sending the value.
+    end
+  end
+TEXT
+    end
+
+    ##
+    # Emit file footer
+    #
+
+    def footer
+      text =<<TEXT
+
+end # #{class_name}
+
+TEXT
+    end
+
+    ##
+    # Convert a field name to snake_case
+    #
+
+    def delme_snakecase str
+      snake = str.gsub /[^a-zA-Z0-9]/, '_'
+      snake = snake.gsub /_+/, '_'
+      snake.downcase
+    end
+  end # DelegateWriter
+end # AmsLayout

data/lib/ams_layout/pages/login_page.rb

@@ -0,0 +1,69 @@
+##############################################################################
+# File::    login_page.rb
+# Purpose:: AMS Login page
+# 
+# Author::    Jeff McAffee 06/22/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'page-object'
+
+module AmsLayout
+  module Pages
+
+  class LoginPage
+    include PageObject
+
+    page_url( AmsLayout.configuration.base_url )
+
+    text_field(:username, :id => "ctl00_ContentPlaceHolder1_Login1_txtUserName" )
+    text_field(:password_mask, :id => "ctl00_ContentPlaceHolder1_Login1_txtPasswordMask" )
+    text_field(:password, :id => "ctl00_ContentPlaceHolder1_Login1_txtPassword" )
+    button(:login, :id => "ctl00_ContentPlaceHolder1_Login1_btnLogin" )
+
+    # Part of the main menu visible after login
+    link(:pipelines, :text => "Pipelines")
+
+    def login_as(username, password)
+      self.username = username
+      allow_password_entry
+      self.password = password
+      login
+
+      trys = 0
+      # Make sure we wait until the (sometimes) slow login is finished.
+      while trys < 10 && !self.text.include?('LOAN PIPELINE')
+        trys += 1
+        sleep 1
+      end
+    end
+
+    def logout
+      navigate_to page_url_value + '/User/AppLogout.aspx'
+    end
+
+    def logged_in?
+      !self.username?
+    end
+
+    def allow_password_entry
+      # We used to have to click on the password mask before the page would let us enter the password itself:
+      #
+      # # For some unknown reason, we must click on a password mask input before
+      # # we can access the password field itself.
+      #   password_mask_element.click
+      #
+      # Now, we have to use javascript to hide the mask and display the password field.
+      hide_mask_script = <<EOS
+pwdmasks = document.getElementsByClassName('passwordmask');
+pwdmasks[0].style.display = 'none';
+pwds = document.getElementsByClassName('password');
+pwds[0].style.display = 'block';
+EOS
+
+      @browser.execute_script(hide_mask_script)
+    end
+  end # class LoginPage
+  end # Pages
+end # AmsLayout

data/lib/ams_layout/pages/prequal_detail.rb

@@ -0,0 +1,26 @@
+##############################################################################
+# File::    prequal_detail.rb
+# Purpose:: Loan Entry (flow) for AMS Portal
+#
+# Author::    Jeff McAffee 2014-06-21
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'page-object'
+
+module AmsLayout
+  module Pages
+
+class PrequalDetail
+  include PageObject
+
+  page_url(::AmsLayout.configuration.base_url + '/SubmitLoan/PrequalDetail.aspx')
+
+  def html
+    @browser.html
+  end
+end
+  end # Pages
+end # AmsLayout
+

data/lib/ams_layout/pages.rb

@@ -0,0 +1,36 @@
+##############################################################################
+# File::    pages.rb
+# Purpose:: Require all Page classes
+#
+# Author::    Jeff McAffee 2014-06-21
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ams_layout/browser_loader'
+require 'ams_layout/pages/login_page'
+require 'ams_layout/pages/prequal_detail'
+
+module AmsLayout
+  module Pages
+
+    ##
+    # Return a configured browser object. If a browser has already been created,
+    # this returns the existing browser.
+    #
+    # An +at_exit+ proc is created to close the browser when the program exits.
+
+    def browser
+      if @browser.nil?
+        BrowserLoader.user_data_path = AmsLayout.configuration.user_data_path
+        @browser = BrowserLoader.init_browser AmsLayout.configuration.browser_timeout
+
+        at_exit do
+          @browser.close unless @browser.nil?
+        end
+      end
+
+      @browser
+    end
+  end # Pages
+end # AmsLayout

data/lib/ams_layout/parser.rb

@@ -0,0 +1,137 @@
+##############################################################################
+# File::    parser.rb
+# Purpose:: Parse a Loan Entry screen and generate the layout data for the
+#           controls on the screen.
+#
+# Author::    Jeff McAffee 06/21/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'nokogiri'
+
+module AmsLayout
+  class Parser
+
+    def layout
+      @layout ||= {}
+    end
+
+    def parse html
+      # Table: ctl00_ContentPlaceHolder1_tblMain
+      Nokogiri::HTML(html).css("table#ctl00_ContentPlaceHolder1_tblMain").each do |tbl|
+        tbl.css('tr').each do |row|
+          parse_row row
+        end
+      end
+
+      layout
+    end
+
+  private
+    def parse_row row
+      cells = row.css('td')
+
+      if cells[0]['class'] == 'sectionheader'
+        add_section cells[0].text
+        return
+      end
+
+      if cells.size >= 2
+        add_control build_control(cells[0], cells[1])
+      end
+
+      if cells.size >= 4
+        add_control build_control(cells[2], cells[3])
+      end
+    end
+
+    def add_section section_name
+      @current_section = section_name
+    end
+
+    def current_section
+      fail "@current_section not set" if @current_section.nil?
+
+      if layout[@current_section].nil?
+        layout[@current_section] = Array.new
+      end
+
+      layout[@current_section]
+    end
+
+    def add_control control
+      current_section << control.to_hash unless control.is_a?(NullControl)
+    end
+
+    def build_control label_cell, control_cell
+      assert_label_td label_cell
+      assert_control_td control_cell
+
+      label = label_cell.text.gsub("\u00A0", ' ').strip
+      # Return if this is a blank cell
+      return NullControl.new if label.empty?
+
+      # Actual control is nested INPUT field
+      ctrl = find_input_element(control_cell)
+      if ctrl.nil?
+        fail "Unable to determine input element.\n#{control_cell.inspect}"
+      end
+      id = ctrl['id']
+      type = ctrl['type']
+      type = ctrl.name if type.nil?
+      assert_control_type type
+      Control.new label, id, type
+    end
+
+    def find_input_element cell
+      ctrl = cell.css('input').first
+      ctrl = cell.css('select').first if ctrl.nil?
+      ctrl = cell.css('textarea').first if ctrl.nil?
+      ctrl
+    end
+
+    def assert_label_td cell
+      label_classes = %w[LabelTD Mandatory]
+      fail "TD does not contain class attribute of 'LabelTD'" unless label_classes.include?(cell['class'])
+    end
+
+    def assert_control_td cell
+      fail "TD does not contain class attribute of 'ControlTD'" unless cell['class'] == 'ControlTD'
+    end
+
+    def assert_control_type type
+      fail 'nil control type' if type.nil?
+      fail "unexpected control type: #{type}" unless %w[text textarea select checkbox].include?(type)
+    end
+
+    class Control
+      attr_reader :label, :id, :type
+
+      def initialize label, id, type
+        @label = label
+        @id = id
+        @type = type
+      end
+
+      def to_hash
+        {label: @label, id: @id, type: @type}
+      end
+    end # Control
+
+    class NullControl
+      attr_reader :label, :id, :type
+
+      def initialize
+        @label = ''
+        @id = ''
+        @type = ''
+      end
+
+      def to_hash
+        {label: @label, id: @id, type: @type}
+      end
+    end # Control
+  end # Parser
+end # AmsLayout
+

data/lib/ams_layout/version.rb

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