percy-appium-app 0.0.1 → 0.0.2.pre.beta.0

data/percy/lib/cli_wrapper.rb

@@ -9,124 +9,132 @@ require_relative '../exceptions/exceptions'
 require_relative '../version'
 require_relative '../environment'
 
-CLIENT_INFO = "percy-appium-app/#{SDK_VERSION}"
-ENV_INFO = ["appium/#{Appium::VERSION}", "ruby/#{RUBY_VERSION}"].freeze
+module Percy
+  CLIENT_INFO = "percy-appium-app/#{VERSION}"
+  ENV_INFO = ["appium/#{Appium::VERSION}", "ruby/#{RUBY_VERSION}"].freeze
 
-PERCY_CLI_API = ENV['PERCY_CLI_API'] || 'http://localhost:5338'
+  PERCY_CLI_API = ENV['PERCY_CLI_API'] || 'http://localhost:5338'
 
-class CLIWrapper
-  def initialize; end
+  class CLIWrapper
+    def initialize; end
 
-  def self.percy_enabled?
-    @percy_enabled ||= begin
-      uri = URI("#{PERCY_CLI_API}/percy/healthcheck")
-      response = Net::HTTP.get_response(uri)
+    def self.percy_enabled?
+      @percy_enabled ||= begin
+        uri = URI("#{PERCY_CLI_API}/percy/healthcheck")
+        response = Net::HTTP.get_response(uri)
 
-      raise CLIException, response.body unless response.is_a?(Net::HTTPSuccess)
+        raise CLIException, response.body unless response.is_a?(Net::HTTPSuccess)
 
-      data = JSON.parse(response.body)
-      raise CLIException, data['error'] unless data['success']
+        data = JSON.parse(response.body)
+        raise CLIException, data['error'] unless data['success']
+
+        Percy::Environment.percy_build_id = data['build']['id']
+        Percy::Environment.percy_build_url = data['build']['url']
+        Percy::Environment.session_type = data.fetch('type', nil)
 
-      Environment.percy_build_id = data['build']['id']
-      Environment.percy_build_url = data['build']['url']
-      Environment.session_type = data.fetch('type', nil)
+        version = response['x-percy-core-version']
+        if version.split('.')[0] != '1'
+          log("Unsupported Percy CLI version, #{version}")
+          return false
+        end
+        return true unless version.split('.')[1].to_i < 27
 
-      version = response['x-percy-core-version']
-      if version.split('.')[0] != '1'
-        log("Unsupported Percy CLI version, #{version}")
+        log('Please upgrade to the latest CLI version for using this SDK. Minimum compatible version is 1.27.0-beta.0')
+        return false
+      rescue StandardError => e
+        log('Percy is not running, disabling screenshots')
+        log(e, on_debug: true)
         return false
       end
-      return true unless version.split('.')[1].to_i < 27
-
-      log('Please upgrade to the latest CLI version for using this SDK. Minimum compatible version is 1.27.0-beta.0')
-      return false
-    rescue StandardError => e
-      log('Percy is not running, disabling screenshots')
-      log(e, on_debug: true)
-      return false
     end
-  end
 
-  def post_screenshots(name, tag, tiles, external_debug_url = nil, ignored_elements_data = nil,
-                       considered_elements_data = nil)
-    body = request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data)
-    body['client_info'] = Environment.get_client_info
-    body['environment_info'] = Environment.get_env_info
+    def post_screenshots(name, tag, tiles, external_debug_url = nil, ignored_elements_data = nil,
+                        considered_elements_data = nil, sync = nil)
+      body = request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data, sync)
+      body['client_info'] = Percy::Environment.get_client_info
+      body['environment_info'] = Percy::Environment.get_env_info
 
-    uri = URI("#{PERCY_CLI_API}/percy/comparison")
-    http = Net::HTTP.new(uri.host, uri.port)
-    request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
-    request.body = body.to_json
+      uri = URI("#{PERCY_CLI_API}/percy/comparison")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = 600 # seconds
+      request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+      request.body = body.to_json
 
-    response = http.request(request)
-    data = JSON.parse(response.body)
-
-    raise CLIException, data.fetch('error', 'UnknownException') if response.code != '200'
-
-    data
-  end
-
-  def self.post_failed_event(error)
-    body = {
-      'clientInfo' => Environment.get_client_info(true),
-      'message' => error,
-      'errorKind' => 'sdk'
-    }
+      response = http.request(request)
+      data = JSON.parse(response.body)
 
-    uri = URI("#{PERCY_CLI_API}/percy/events")
-    response = Net::HTTP.post(uri, body.to_json, 'Content-Type' => 'application/json')
+      raise CLIException, data.fetch('error', 'UnknownException') if response.code != '200'
 
-    # Handle errors
-    if response.code.to_i != 200
-      data = JSON.parse(response.body)
-      error_message = data.fetch('error', 'UnknownException')
-      raise CLIException, error_message
+      data
     end
 
-    JSON.parse(response.body)
-  rescue StandardError => e
-    log(e.message, on_debug: true)
-    nil
-  end
-
-  def post_poa_screenshots(name, session_id, command_executor_url, capabilities, desired_capabilities, options = nil)
-    body = {
-      'sessionId' => session_id,
-      'commandExecutorUrl' => command_executor_url,
-      'capabilities' => capabilities.dup, # In Ruby, you can duplicate the hash with `dup`
-      'sessionCapabilities' => desired_capabilities.dup,
-      'snapshotName' => name,
-      'options' => options
-    }
+    def self.post_failed_event(error)
+      body = {
+        'clientInfo' => Percy::Environment.get_client_info(true),
+        'message' => error,
+        'errorKind' => 'sdk'
+      }
+
+      uri = URI("#{PERCY_CLI_API}/percy/events")
+      response = Net::HTTP.post(uri, body.to_json, 'Content-Type' => 'application/json')
+
+      # Handle errors
+      if response.code.to_i != 200
+        data = JSON.parse(response.body)
+        error_message = data.fetch('error', 'UnknownException')
+        raise CLIException, error_message
+      end
 
-    body['client_info'] = Environment.get_client_info # Using class method without the underscore
-    body['environment_info'] = Environment.get_env_info
+      JSON.parse(response.body)
+    rescue StandardError => e
+      log(e.message, on_debug: true)
+      nil
+    end
 
-    uri = URI("#{PERCY_CLI_API}/percy/automateScreenshot")
-    response = Net::HTTP.post(uri, body.to_json, 'Content-Type' => 'application/json')
+    def post_poa_screenshots(name, session_id, command_executor_url, capabilities, desired_capabilities, options = nil)
+      body = {
+        'sessionId' => session_id,
+        'commandExecutorUrl' => command_executor_url,
+        'capabilities' => capabilities.dup, # In Ruby, you can duplicate the hash with `dup`
+        'sessionCapabilities' => desired_capabilities.dup,
+        'snapshotName' => name,
+        'options' => options
+      }
+
+      body['client_info'] = Percy::Environment.get_client_info # Using class method without the underscore
+      body['environment_info'] = Percy::Environment.get_env_info
+
+      uri = URI("#{PERCY_CLI_API}/percy/automateScreenshot")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = 600 # seconds
+      request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+      request.body = body.to_json
+      response = http.request(request)
+
+      # Handle errors
+      raise CLIException, "Error: #{response.message}" unless response.is_a?(Net::HTTPSuccess)
 
-    # Handle errors
-    raise CLIException, "Error: #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+      data = JSON.parse(response.body)
 
-    data = JSON.parse(response.body)
+      if response.code != '200'
+        error_message = data.fetch('error', 'UnknownException')
+        raise CLIException, error_message
+      end
 
-    if response.code != '200'
-      error_message = data.fetch('error', 'UnknownException')
-      raise CLIException, error_message
+      data
     end
 
-    data
-  end
-
-  def request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data)
-    tiles = tiles.map(&:to_h)
-    {
-      'name' => name,
-      'tag' => tag,
-      'tiles' => tiles,
-      'ignored_elements_data' => ignored_elements_data,
-      'external_debug_url' => external_debug_url,
-      'considered_elements_data' => considered_elements_data
-    }
+    def request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data, sync)
+      tiles = tiles.map(&:to_h)
+      {
+        'name' => name,
+        'tag' => tag,
+        'tiles' => tiles,
+        'ignored_elements_data' => ignored_elements_data,
+        'external_debug_url' => external_debug_url,
+        'considered_elements_data' => considered_elements_data,
+        'sync' => sync
+      }
+    end
   end
 end

data/percy/lib/ignore_region.rb

@@ -2,7 +2,8 @@
 
 # lib/ignore_region.rb
 require_relative 'region'
-
-class IgnoreRegion < Region
-  # Inherits everything from Region; no additional code needed unless you want to extend or modify the behavior
+module Percy
+  class IgnoreRegion < Percy::Region
+    # Inherits everything from Percy::Region; no additional code needed unless you want to extend or modify the behavior
+  end
 end

data/percy/lib/percy_automate.rb

@@ -10,50 +10,53 @@ IGNORE_ELEMENT_ALT_KEY = 'ignoreRegionAppiumElements'
 CONSIDER_ELEMENT_KEY = 'consider_region_appium_elements'
 CONSIDER_ELEMENT_ALT_KEY = 'considerRegionAppiumElements'
 
-class PercyOnAutomate
-  def initialize(driver)
-    unless driver.is_a?(Appium::Core::Base::Driver)
-      raise DriverNotSupported, 'The provided driver instance is not supported.'
+module Percy
+  class PercyOnAutomate
+    def initialize(driver)
+      unless driver.is_a?(Appium::Core::Base::Driver)
+        raise DriverNotSupported, 'The provided driver instance is not supported.'
+      end
+
+      @driver = driver
+      @percy_options = Percy::PercyOptions.new(@driver.capabilities)
     end
 
-    @driver = driver
-    @percy_options = PercyOptions.new(@driver.capabilities)
-  end
-
-  def screenshot(name, **options)
-    return nil unless @percy_options.enabled
-    raise TypeError, 'Argument name should be a string' unless name.is_a?(String)
-    raise KeyError, 'Please pass the last parameter as "options" key' unless options.key?(:options)
-
-    metadata = DriverMetadata.new(@driver)
-    options = options[:options] || {}
-
-    begin
-      options[IGNORE_ELEMENT_KEY] = options.delete(IGNORE_ELEMENT_ALT_KEY) if options.key?(IGNORE_ELEMENT_ALT_KEY)
-      options[CONSIDER_ELEMENT_KEY] = options.delete(CONSIDER_ELEMENT_ALT_KEY) if options.key?(CONSIDER_ELEMENT_ALT_KEY)
-
-      ignore_region_elements = options.fetch(IGNORE_ELEMENT_KEY, []).map(&:id)
-      consider_region_elements = options.fetch(CONSIDER_ELEMENT_KEY, []).map(&:id)
-      options.delete(IGNORE_ELEMENT_KEY)
-      options.delete(CONSIDER_ELEMENT_KEY)
-
-      additional_options = {
-        'ignore_region_elements' => ignore_region_elements,
-        'consider_region_elements' => consider_region_elements
-      }
-
-      CLIWrapper.new.post_poa_screenshots(
-        name,
-        metadata.session_id,
-        metadata.command_executor_url,
-        metadata.capabilities,
-        metadata.session_capabilities,
-        options.merge(additional_options)
-      )
-    rescue StandardError => e
-      log("Could not take Screenshot '#{name}'")
-      log(e.message, on_debug: true)
+    def screenshot(name, **options)
+      return nil unless @percy_options.enabled
+      raise TypeError, 'Argument name should be a string' unless name.is_a?(String)
+      raise KeyError, 'Please pass the last parameter as "options" key' unless options.key?(:options)
+
+      metadata = Percy::DriverMetadata.new(@driver)
+      options = options[:options] || {}
+
+      begin
+        options[IGNORE_ELEMENT_KEY] = options.delete(IGNORE_ELEMENT_ALT_KEY) if options.key?(IGNORE_ELEMENT_ALT_KEY)
+        options[CONSIDER_ELEMENT_KEY] = options.delete(CONSIDER_ELEMENT_ALT_KEY) if options.key?(CONSIDER_ELEMENT_ALT_KEY)
+
+        ignore_region_elements = options.fetch(IGNORE_ELEMENT_KEY, []).map(&:id)
+        consider_region_elements = options.fetch(CONSIDER_ELEMENT_KEY, []).map(&:id)
+        options.delete(IGNORE_ELEMENT_KEY)
+        options.delete(CONSIDER_ELEMENT_KEY)
+
+        additional_options = {
+          'ignore_region_elements' => ignore_region_elements,
+          'consider_region_elements' => consider_region_elements
+        }
+
+        response = Percy::CLIWrapper.new.post_poa_screenshots(
+          name,
+          metadata.session_id,
+          metadata.command_executor_url,
+          metadata.capabilities,
+          metadata.session_capabilities,
+          options.merge(additional_options)
+        )
+
+        response['data']
+      rescue StandardError => e
+        log("Could not take Screenshot '#{name}'")
+        log(e.message, on_debug: true)
+      end
     end
-    nil
   end
 end

data/percy/lib/percy_options.rb

@@ -1,37 +1,39 @@
 # frozen_string_literal: true
 
-class PercyOptions
-  IGNORE_ERRORS = 'ignoreErrors'
-  ENABLED = 'enabled'
-  PERCY_OPTIONS = ['percy:options', 'percyOptions'].freeze
+module Percy
+  class PercyOptions
+    IGNORE_ERRORS = 'ignoreErrors'
+    ENABLED = 'enabled'
+    PERCY_OPTIONS = ['percy:options', 'percyOptions'].freeze
 
-  def initialize(capabilities)
-    @capabilities = capabilities
-    @capabilities = @capabilities.as_json unless @capabilities.is_a?(Hash)
-    @percy_options = _parse_percy_options || {}
-  end
+    def initialize(capabilities)
+      @capabilities = capabilities
+      @capabilities = @capabilities.as_json unless @capabilities.is_a?(Hash)
+      @percy_options = _parse_percy_options || {}
+    end
 
-  def _parse_percy_options
-    options = PERCY_OPTIONS.map { |key| @capabilities.fetch(key, nil) }
-    options = if options.any? { |element| !element.nil? }
-                options[0] || options[1]
-              else
-                {}
-              end
+    def _parse_percy_options
+      options = PERCY_OPTIONS.map { |key| @capabilities.fetch(key, nil) }
+      options = if options.any? { |element| !element.nil? }
+                  options[0] || options[1]
+                else
+                  {}
+                end
 
-    if options
-      options[IGNORE_ERRORS] = @capabilities.fetch("percy.#{IGNORE_ERRORS}", true) unless options.key?(IGNORE_ERRORS)
-      options[ENABLED] = @capabilities.fetch("percy.#{ENABLED}", true) unless options.key?(ENABLED)
-    end
+      if options
+        options[IGNORE_ERRORS] = @capabilities.fetch("percy.#{IGNORE_ERRORS}", true) unless options.key?(IGNORE_ERRORS)
+        options[ENABLED] = @capabilities.fetch("percy.#{ENABLED}", true) unless options.key?(ENABLED)
+      end
 
-    options
-  end
+      options
+    end
 
-  def ignore_errors
-    @percy_options.fetch(IGNORE_ERRORS, true)
-  end
+    def ignore_errors
+      @percy_options.fetch(IGNORE_ERRORS, true)
+    end
 
-  def enabled
-    @percy_options.fetch(ENABLED, true)
+    def enabled
+      @percy_options.fetch(ENABLED, true)
+    end
   end
-end
+end

data/percy/lib/region.rb

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
 # lib/region.rb
-class Region
-  attr_accessor :top, :bottom, :left, :right
+module Percy
+  class Region
+    attr_accessor :top, :bottom, :left, :right
 
-  def initialize(top, bottom, left, right)
-    raise ArgumentError, 'Only Positive integer is allowed!' if [top, bottom, left, right].any?(&:negative?)
-    raise ArgumentError, 'Invalid ignore region parameters!' if top >= bottom || left >= right
+    def initialize(top, bottom, left, right)
+      raise ArgumentError, 'Only Positive integer is allowed!' if [top, bottom, left, right].any?(&:negative?)
+      raise ArgumentError, 'Invalid ignore region parameters!' if top >= bottom || left >= right
 
-    @top = top
-    @bottom = bottom
-    @left = left
-    @right = right
-  end
+      @top = top
+      @bottom = bottom
+      @left = left
+      @right = right
+    end
 
-  def valid?(screen_height, screen_width)
-    return false if @top >= screen_height || @bottom > screen_height || @left >= screen_width || @right > screen_width
+    def valid?(screen_height, screen_width)
+      return false if @top >= screen_height || @bottom > screen_height || @left >= screen_width || @right > screen_width
 
-    true
+      true
+    end
   end
 end

data/percy/lib/tile.rb

@@ -1,28 +1,30 @@
 # frozen_string_literal: true
 
-class Tile
-  attr_reader :filepath, :status_bar_height, :nav_bar_height, :header_height, :footer_height, :fullscreen, :sha
+module Percy
+  class Tile
+    attr_reader :filepath, :status_bar_height, :nav_bar_height, :header_height, :footer_height, :fullscreen, :sha
 
-  def initialize(status_bar_height, nav_bar_height, header_height, footer_height, filepath: nil, sha: nil,
-                 fullscreen: false)
-    @filepath = filepath
-    @status_bar_height = status_bar_height
-    @nav_bar_height = nav_bar_height
-    @header_height = header_height
-    @footer_height = footer_height
-    @fullscreen = fullscreen
-    @sha = sha
-  end
+    def initialize(status_bar_height, nav_bar_height, header_height, footer_height, filepath: nil, sha: nil,
+                  fullscreen: false)
+      @filepath = filepath
+      @status_bar_height = status_bar_height
+      @nav_bar_height = nav_bar_height
+      @header_height = header_height
+      @footer_height = footer_height
+      @fullscreen = fullscreen
+      @sha = sha
+    end
 
-  def to_h
-    {
-      'filepath' => @filepath,
-      'status_bar_height' => @status_bar_height,
-      'nav_bar_height' => @nav_bar_height,
-      'header_height' => @header_height,
-      'footer_height' => @footer_height,
-      'fullscreen' => @fullscreen,
-      'sha' => @sha
-    }
+    def to_h
+      {
+        'filepath' => @filepath,
+        'status_bar_height' => @status_bar_height,
+        'nav_bar_height' => @nav_bar_height,
+        'header_height' => @header_height,
+        'footer_height' => @footer_height,
+        'fullscreen' => @fullscreen,
+        'sha' => @sha
+      }
+    end
   end
 end

data/percy/metadata/android_metadata.rb

@@ -4,76 +4,78 @@ require 'json'
 require_relative 'metadata'
 require_relative '../lib/cache'
 
-class AndroidMetadata < Metadata
-  def initialize(driver)
-    super(driver)
-    @_bars = nil
-    @_viewport_rect = capabilities.to_json['viewportRect']
-  end
+module Percy
+  class AndroidMetadata < Percy::Metadata
+    def initialize(driver)
+      super(driver)
+      @_bars = nil
+      @_viewport_rect = capabilities.to_json['viewportRect']
+    end
 
-  def device_screen_size
-    caps = capabilities
-    caps = caps.as_json unless caps.is_a?(Hash)
-    width, height = caps['deviceScreenSize'].split('x')
-    { 'width' => width.to_i, 'height' => height.to_i }
-  end
+    def device_screen_size
+      caps = capabilities
+      caps = caps.as_json unless caps.is_a?(Hash)
+      width, height = caps['deviceScreenSize'].split('x')
+      { 'width' => width.to_i, 'height' => height.to_i }
+    end
 
-  def get_system_bars
-    @_bars = Cache.get_cache(session_id, Cache::SYSTEM_BARS)
-    if @_viewport_rect
-      begin
-        @_bars = {
-          'statusBar' => { 'height' => @_viewport_rect['top'] },
-          'navigationBar' => {
-            'height' => device_screen_size['height'] - @_viewport_rect['height'] - @_viewport_rect['top']
+    def get_system_bars
+      @_bars = Percy::Cache.get_cache(session_id, Percy::Cache::SYSTEM_BARS)
+      if @_viewport_rect
+        begin
+          @_bars = {
+            'statusBar' => { 'height' => @_viewport_rect['top'] },
+            'navigationBar' => {
+              'height' => device_screen_size['height'] - @_viewport_rect['height'] - @_viewport_rect['top']
+            }
           }
-        }
-      rescue StandardError
-        @_bars = nil
+        rescue StandardError
+          @_bars = nil
+        end
       end
+      if @_bars.nil?
+        @_bars = driver.get_system_bars
+        Percy::Cache.set_cache(session_id, Percy::Cache::SYSTEM_BARS, @_bars)
+      end
+      @_bars
     end
-    if @_bars.nil?
-      @_bars = driver.get_system_bars
-      Cache.set_cache(session_id, Cache::SYSTEM_BARS, @_bars)
-    end
-    @_bars
-  end
 
-  def status_bar
-    status_bar = get_system_bars['statusBar']
-    if status_bar['height'] == 1
-      response = value_from_devices_info('status_bar', _device_name.upcase, os_version)
-      return { 'height' => response }
+    def status_bar
+      status_bar = get_system_bars['statusBar']
+      if status_bar['height'] == 1
+        response = value_from_devices_info('status_bar', _device_name.upcase, os_version)
+        return { 'height' => response }
+      end
+      status_bar
     end
-    status_bar
-  end
 
-  def navigation_bar
-    navigation_bar = get_system_bars['navigationBar']
-    if navigation_bar['height'] == 1
-      response = { 'height' => value_from_devices_info('nav_bar', _device_name.upcase, os_version) }
-      return response
+    def navigation_bar
+      navigation_bar = get_system_bars['navigationBar']
+      if navigation_bar['height'] == 1
+        response = { 'height' => value_from_devices_info('nav_bar', _device_name.upcase, os_version) }
+        return response
+      end
+      navigation_bar
     end
-    navigation_bar
-  end
 
-  def viewport
-    capabilities.to_json['viewportRect']
-  end
+    def viewport
+      capabilities.to_json['viewportRect']
+    end
 
-  def scale_factor
-    1
-  end
+    def scale_factor
+      1
+    end
 
-  def _device_name
-    if @device_name.nil?
-      desired_caps = capabilities.to_json['desired'] || {}
-      device_name = desired_caps['deviceName']
-      device = desired_caps['device']
-      device_name ||= device
-      device_model = capabilities.to_json['deviceModel']
-      @device_name = device_name || device_model
+    def _device_name
+      if @device_name.nil?
+        desired_caps = capabilities.to_json['desired'] || {}
+        device_name = desired_caps['deviceName']
+        device = desired_caps['device']
+        device_name ||= device
+        device_model = capabilities.to_json['deviceModel']
+        @device_name = device_name || device_model
+      end
+      @device_name
     end
-    @device_name
   end
 end