yui_rest_client 0.5.0

data/lib/yui_rest_client/logger.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'logger'
+
+module YuiRestClient
+  class Logger
+    extend Forwardable
+
+    def_delegators :@logger, :debug, :debug?,
+                   :info, :info?,
+                   :warn, :warn?,
+                   :error, :error?,
+                   :fatal, :fatal?,
+                   :level
+
+    def initialize
+      @logger = create_logger($stdout)
+    end
+
+    def create_logger(output)
+      logger = ::Logger.new(output)
+      logger.progname = 'YuiRestClient'
+      logger.level = default_level
+      logger
+    end
+
+    def default_level
+      ENV['DEBUG'] ? :debug : :info
+    end
+  end
+end

data/lib/yui_rest_client/timer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Timer
+    module_function
+
+    # Execute code block with the interval until timeout reached.
+    # @param timeout [Numeric] how many time in seconds to wait
+    # @param interval [Numeric] time in seconds between attempts
+    def wait(timeout, interval)
+      return yield if timeout.zero?
+
+      end_time = Time.now.to_f + timeout
+      while Time.now.to_f <= end_time
+        yield
+        sleep interval
+      end
+    end
+  end
+end

data/lib/yui_rest_client/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  VERSION = '0.5.0'
+  API_VERSION = 'v1'
+end

data/lib/yui_rest_client/wait.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Wait
+    def self.until(timeout:, interval:, message: nil, object: nil)
+      Timer.wait(timeout, interval) do
+        result = yield(object)
+        return result if result
+      end
+      raise Error::TimeoutError, "timed out after #{timeout} seconds. #{message}"
+    end
+
+    def self.while(timeout:, interval:, message: nil, object: nil)
+      Timer.wait(timeout, interval) do
+        result = yield(object)
+        return unless result
+      end
+      raise Error::TimeoutError, "timed out after #{timeout} seconds. #{message}"
+    end
+  end
+end

data/lib/yui_rest_client/waitable.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Waitable
+    # Waits until the block evaluation will return true, raises Error::TimeoutError on timeout.
+    # @param timeout [Numeric] how long to wait (in seconds). Default is YuiRestClient.timeout.
+    # @param interval [Numeric] time in seconds between attempts. Default is YuiRestClient.interval.
+    # @param message [String] message to be sent in case timeout is reached.
+    # @raise Error::TimeoutError
+    # @return [Waitable] waitable object
+    # @example Wait for checkbox to be checked
+    #   app.checkbox(id: 'test').wait_until(&:checked?)
+    def wait_until(timeout: YuiRestClient.timeout, interval: YuiRestClient.interval, message: nil, &block)
+      @timeout = timeout
+      @interval = interval
+      Wait.until(timeout: timeout, interval: interval, message: message, object: self, &block)
+      @timeout = YuiRestClient.timeout
+      @interval = YuiRestClient.interval
+      self
+    end
+
+    # Waits while the block evaluation returns true, raises Error::TimeoutError on timeout.
+    # @param timeout [Numeric] how long to wait (in seconds). Default is YuiRestClient.timeout.
+    # @param interval [Numeric] time in seconds between attempts. Default is YuiRestClient.interval.
+    # @param message [String] message to be sent in case timeout is reached.
+    # @raise Error::TimeoutError
+    # @return [Waitable] waitable object
+    # @example Wait for checkbox to be unchecked
+    #   app.checkbox(id: 'test').wait_while(&:checked?)
+    def wait_while(timeout: YuiRestClient.timeout, interval: YuiRestClient.interval, message: nil, &block)
+      @timeout = timeout
+      @interval = interval
+      Wait.while(timeout: timeout, interval: interval, message: message, object: self, &block)
+      @timeout = YuiRestClient.timeout
+      @interval = YuiRestClient.interval
+      self
+    end
+  end
+end

data/lib/yui_rest_client/widgets.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    require 'yui_rest_client/waitable'
+    require 'yui_rest_client/widgets/base'
+    require 'yui_rest_client/widgets/bargraph'
+    require 'yui_rest_client/widgets/button'
+    require 'yui_rest_client/widgets/checkbox'
+    require 'yui_rest_client/widgets/combobox'
+    require 'yui_rest_client/widgets/datefield'
+    require 'yui_rest_client/widgets/label'
+    require 'yui_rest_client/widgets/menubutton'
+    require 'yui_rest_client/widgets/multilinebox'
+    require 'yui_rest_client/widgets/numberbox'
+    require 'yui_rest_client/widgets/progressbar'
+    require 'yui_rest_client/widgets/radiobutton'
+    require 'yui_rest_client/widgets/selectionbox'
+    require 'yui_rest_client/widgets/tab'
+    require 'yui_rest_client/widgets/table'
+    require 'yui_rest_client/widgets/textbox'
+    require 'yui_rest_client/widgets/timefield'
+    require 'yui_rest_client/widgets/label'
+    require 'yui_rest_client/widgets/richtext'
+    require 'yui_rest_client/widgets/tree'
+    # Class representing a Wizard UI. It can be YWizard
+    class Wizard < Widgets::Base
+    end
+  end
+end

data/lib/yui_rest_client/widgets/bargraph.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a bar graph in the UI, namely YBarGraph.
+    class Bargraph < Widgets::Base
+      # Returns the list of segments in the bar graph. Each segment is defined by
+      # label and value. Segment length is defined by proportional ratio of the
+      # segment value. For instance, if segment values are 100, 200, 700: it means
+      # first segment will take 100/1000=10%, second 20% and third one 70% accordingly.
+      # @return [Array] array of [Hash] objects with :label and :value keys which
+      #                 store label and segment value for given segment
+      # @example Get segments from the bargraph with id "test_id"
+      # {
+      #   "class" : "YBarGraph",
+      #   "id" : "test_id",
+      #   "segments" :
+      #   [
+      #     {
+      #       "label" : "Windows\nused\n%1 MB",
+      #       "value" : 600
+      #     },
+      #     {
+      #       "label" : "Windows\nfree\n%1 MB",
+      #       "value" : 350
+      #     },
+      #     {
+      #       "label" : "Linux\n%1 MB",
+      #       "value" : 800
+      #     }
+      #   ],
+      # }
+      # @example
+      #   app.bargraph(id: 'test_id').segments
+      # @example
+      #   app.bargraph(id: 'test_id').segments[1][:value]
+      # @example
+      #   app.bargraph(id: 'test_id').segments[1][:label]
+      def segments
+        property(:segments)
+      end
+
+      # Returns the labels list of all segments in the bar graph.
+      # @return [Array] array of labels in order they are stored in segments hash.
+      # @example Get labels of the segments in the bargraph with id "test_id"
+      # @example
+      #   app.bargraph(id: 'test_id').labels
+      def labels
+        segments.map { |segment| segment[:label] }
+      end
+
+      # Returns the values list of all segments in the bar graph.
+      # @return [Array] array of values in order they are stored in segments hash.
+      # @example Get values of the segments in the bargraph with id "test_id"
+      # @example
+      #   app.bargraph(id: 'test_id').values
+      def values
+        segments.map { |segment| segment[:value] }
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/base.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    class Base
+      include Waitable
+
+      def initialize(widget_controller, filter)
+        @widget_controller = widget_controller
+        @filter = filter
+      end
+
+      # Allows to check if widget exists on the current screen or not.
+      # Can be called against any widget.
+      # @return [Boolean] true if widget exists, false otherwise.
+      # @example Check if button with id 'test' exists
+      #   app.button(id: 'test').exists? # true
+      def exists?
+        YuiRestClient.logger.info("Checking if #{class_name} with #{@filter} exists")
+        find_widgets
+        YuiRestClient.logger.info("#{class_name} exists: #{@filter}")
+        true
+      rescue Error::WidgetNotFoundError
+        YuiRestClient.logger.info("#{class_name} does not exist: #{@filter}")
+        false
+      end
+
+      # Allows to check if widget enabled or disabled.
+      # Can be called against any widget. Widget that does not have "enabled" property is counted as enabled.
+      # @return [Boolean] true if widget enabled, false otherwise.
+      # @example Check if button with id 'test' enabled
+      #   app.button(id: 'test').enabled? # true
+      def enabled?
+        enabled_prop = property(:enabled)
+        enabled_prop.nil? || enabled_prop == true
+      end
+
+      # Returns debug_label value for widget.
+      # Can be called against any widget.
+      # @return [String] value of debug_label property
+      # @example Get debug_label value for button
+      #   {
+      #     "class": "YQWizardButton",
+      #     "debug_label": "Cancel",
+      #     "fkey": 9,
+      #     "id": "cancel",
+      #     "label": "&Cancel"
+      #   }
+      # @example
+      #   debug_label = app.button(id: 'cancel').debug_label # Cancel
+      def debug_label
+        property(:debug_label)
+      end
+
+      # Returns value of widget property.
+      # This method can be used to retrieve value of some specific property,
+      # but widget does not have a method to return the value.
+      # Can be called against any widget.
+      # @param property [Symbol] symbolic name of the property to get value for.
+      # @return [Object] value for property of a widget
+      # @example Get value of "label" property for button with id "test"
+      #   value = app.button(id: 'test').property(:label)
+      def property(property)
+        YuiRestClient.logger.info("Get #{property} for #{class_name} #{@filter}")
+        result = find_widgets.first[property.to_sym]
+        YuiRestClient.logger.info("Found '#{property}=#{result}' for #{class_name} #{@filter}")
+        result
+      end
+
+      # This method can be used to send any action to widget.
+      # Can be called against any widget.
+      # @param params [Hash] actions to be sent (e.g. action: 'press').
+      # @example Send action 'press' to button widget.
+      #   app.button(id: 'test').action(action: 'press')
+      def action(params)
+        unless @filter.regex.empty?
+          widget = find_widgets.first
+          @filter = FilterExtractor.new(widget)
+        end
+        YuiRestClient.logger.info("Send #{params} action for #{class_name} #{@filter}")
+        @widget_controller.send_action(@filter.plain, params)
+      end
+
+      # Get all widgets found with filter.
+      # The method is mainly introduced for "class" filter, which can return an array of widgets.
+      # It only makes sense to use this method whenever server side filters allow to find individually those
+      # collected widgets, otherwise those will not be able to access their internal properties.
+      # @return [Array] array of deserialized widgets.
+      # Then actions that are specified for the widget can be called while iterating over the returned array.
+      # @example Get all checkboxes and check all of them
+      #   checkboxes = app.checkbox(class: "YCheckBox").collect_all
+      #   checkboxes.each{ |checkbox| puts checkbox.check }
+      def collect_all
+        YuiRestClient.logger.info("Collect all #{class_name} widgets with filter #{@filter}")
+        widgets = find_widgets
+        YuiRestClient.logger.info("Found widgets for filter #{@filter}: #{widgets}")
+        widgets.map do |widget|
+          self.class.new(@widget_controller, FilterExtractor.new(widget))
+        end
+      end
+
+      private
+
+      def class_name
+        self.class.name.split('::').last
+      end
+
+      def find_widgets
+        YuiRestClient.logger.info("Search for #{class_name} #{@filter}")
+        @widget_controller.find(@filter.plain).body(regex_filter: @filter.regex)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/button.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a button in UI. It can be YQWizardButton, YPushButton.
+    class Button < Widgets::Base
+      # Sends action to click the button in UI.
+      # @return [Button] in case action is successful
+      # @example Click button with id 'test'
+      #   app.button(id: 'test').click
+      def click
+        action(action: Actions::PRESS)
+        self
+      end
+
+      # Returns fkey value for the button.
+      # @return [Integer] F (function) key that can be used as shortcut to press the button.
+      # @example Get fkey value for YQWizardButton
+      #   {
+      #     "class": "YQWizardButton",
+      #     "debug_label": "Cancel",
+      #     "fkey": 9,
+      #     "id": "cancel",
+      #     "label": "&Cancel"
+      #   }
+      # @example
+      #   fkey = app.button(id: 'cancel').fkey
+      def fkey
+        property(:fkey)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/checkbox.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a Checkbox in UI. It can be YCheckBox or YCheckBoxFrame.
+    class Checkbox < Widgets::Base
+      # Sends action to explicitly check the checkbox in UI (regardless of the current state).
+      # @return [Checkbox] in case action is successful
+      # @example Check checkbox with id 'test'
+      #   app.checkbox(id: 'test').check
+      def check
+        action(action: Actions::CHECK)
+        self
+      end
+
+      # Returns the state of checkbox (checked/unchecked).
+      # Gets value from 'value' parameter in JSON representation of YCheckBox or YCheckBoxFrame.
+      # @return [Boolean] true if it is checked, false otherwise.
+      # @example Get checkbox state
+      #   {
+      #     "class": "YCheckBox",
+      #     "debug_label": "Change the Time Now",
+      #     "id": "change_now",
+      #     "label": "Chan&ge the Time Now",
+      #     "notify": true,
+      #     "value": true
+      #   }
+      # @example
+      #   app.checkbox(id: 'change_now').checked? # true
+      def checked?
+        property(:value)
+      end
+
+      # Sends action to toggle the checkbox in UI (i.e. uncheck when checked, or check otherwise).
+      # @return [Checkbox] in case action is successful
+      # @example Toggle checkbox with id 'test'
+      #   app.checkbox(id: 'test').toggle
+      def toggle
+        action(action: Actions::TOGGLE)
+        self
+      end
+
+      # Sends action to explicitly uncheck the checkbox in UI (regardless of the current state).
+      # @return [Checkbox] in case action is successful
+      # @example Uncheck checkbox with id 'test'
+      #   checkbox(id: 'test').uncheck
+      def uncheck
+        action(action: Actions::UNCHECK)
+        self
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/combobox.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a ComboBox in the UI. It can be YComboBox.
+    class Combobox < Widgets::Base
+      # Returns the list of items available to select from combobox.
+      # @return [Array<String>] array of strings.
+      # @example Get items from combobox with id "nfs_version"
+      #   {
+      #     "class": "YComboBox",
+      #     "debug_label": "NFS Version",
+      #     "icon_base_path": "",
+      #     "id": "nfs_version",
+      #     "items": [
+      #       {
+      #         "label": "Any (Highest Available)",
+      #         "selected": true
+      #       },
+      #       {
+      #         "label": "Force NFSv3"
+      #       }
+      #     ],
+      #     "items_count": 5,
+      #     "label": "NFS &Version",
+      #     "value": "Any (Highest Available)"
+      #   }
+      # @example
+      #   app.combobox(id: 'nfs_version').items
+      #   # Any (Highest Available)
+      #   # Force NFSv3
+      def items
+        property(:items).map { |x| x[:label] }
+      end
+
+      # Sends action to select the item in combobox.
+      # @param item [String] item to select in combobox.
+      # List of items can be retrieved from JSON "items"->"label" manually or by using 'combobox(filter).items'.
+      # @return [Combobox] in case action is successful
+      # @raise YuiRestClient::Error::ItemNotFoundInWidgetError in case value is not found in combobox.
+      # @example Select "Force NFSv3" item in combobox with id "nfs_version"
+      #   app.combobox(id: 'nfs_version').select('Force NFSv3')
+      def select(item)
+        action(action: Actions::SELECT, value: item)
+        self
+      end
+
+      # Returns selected item in combobox.
+      # @example Get selected item in combobox with id "nfs_version"
+      #   {
+      #     "class": "YComboBox",
+      #     "debug_label": "NFS Version",
+      #     "icon_base_path": "",
+      #     "id": "nfs_version",
+      #     "items": [
+      #       {
+      #         "label": "Any (Highest Available)",
+      #         "selected": true
+      #       },
+      #       {
+      #         "label": "Force NFSv3"
+      #       }
+      #     ],
+      #     "items_count": 5,
+      #     "label": "NFS &Version",
+      #     "value": "Any (Highest Available)"
+      #   }
+      # @example
+      #   app.combobox(id: 'nfs_version').value
+      def value
+        property(:value)
+      end
+
+      # Sends action to set string to the editable combobox.
+      # @param item [String] value to set in the combobox.
+      # To check if combobox is editable, call editable?
+      # @return [Combobox] in case action is successful
+      # @raise YuiRestClient::Error::ItemNotFoundInWidgetError in case value is not found in combobox.
+      # @example Set "Custom Version" item in combobox with id "nfs_version"
+      #   app.combobox(id: 'nfs_version').select('Custom Version')
+      def set(value)
+        action(action: Actions::ENTER_TEXT, value: value)
+        self
+      end
+
+      # Allows to check if combobox is editable and allows setting .
+      # @return [Boolean] true if widget enabled, false otherwise.
+      # @example Check if combobox with id 'test' editable
+      #   app.combobox(id: 'test').editable? # true
+      def editable?
+        property(:editable) == true
+      end
+    end
+  end
+end