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

data/percy/metadata/driver_metadata.rb

@@ -2,39 +2,41 @@
 
 require_relative '../lib/cache'
 
-class DriverMetadata
-  def initialize(driver)
-    @driver = driver
-  end
+module Percy
+  class DriverMetadata
+    def initialize(driver)
+      @driver = driver
+    end
 
-  def session_id
-    @driver.session_id
-  end
+    def session_id
+      @driver.session_id
+    end
 
-  def command_executor_url
-    url = Cache.get_cache(session_id, Cache::COMMAND_EXECUTOR_URL)
-    if url.nil?
-      url = @driver.instance_variable_get(:@bridge).instance_variable_get(:@http).instance_variable_get(:@server_url).to_s
-      Cache.set_cache(session_id, Cache::COMMAND_EXECUTOR_URL, url)
+    def command_executor_url
+      url = Percy::Cache.get_cache(session_id, Percy::Cache::COMMAND_EXECUTOR_URL)
+      if url.nil?
+        url = @driver.instance_variable_get(:@bridge).instance_variable_get(:@http).instance_variable_get(:@server_url).to_s
+        Percy::Cache.set_cache(session_id, Percy::Cache::COMMAND_EXECUTOR_URL, url)
+      end
+      url
     end
-    url
-  end
 
-  def capabilities
-    caps = Cache.get_cache(session_id, Cache::SESSION_CAPABILITIES)
-    if caps.nil?
-      caps = @driver.capabilities.dup # In Ruby, use dup to create a shallow copy of the hash
-      Cache.set_cache(session_id, Cache::SESSION_CAPABILITIES, caps)
+    def capabilities
+      caps = Percy::Cache.get_cache(session_id, Percy::Cache::SESSION_CAPABILITIES)
+      if caps.nil?
+        caps = @driver.capabilities.dup # In Ruby, use dup to create a shallow copy of the hash
+        Percy::Cache.set_cache(session_id, Percy::Cache::SESSION_CAPABILITIES, caps)
+      end
+      caps
     end
-    caps
-  end
 
-  def session_capabilities
-    session_caps = Cache.get_cache(session_id, Cache::SESSION_CAPABILITIES)
-    if session_caps.nil?
-      session_caps = @driver.desired_capabilities.dup # Assuming there is a desired_capabilities method
-      Cache.set_cache(session_id, Cache::SESSION_CAPABILITIES, session_caps)
+    def session_capabilities
+      session_caps = Percy::Cache.get_cache(session_id, Percy::Cache::SESSION_CAPABILITIES)
+      if session_caps.nil?
+        session_caps = @driver.desired_capabilities.dup # Assuming there is a desired_capabilities method
+        Percy::Cache.set_cache(session_id, Percy::Cache::SESSION_CAPABILITIES, session_caps)
+      end
+      session_caps
     end
-    session_caps
   end
 end

data/percy/metadata/ios_metadata.rb

@@ -3,81 +3,83 @@
 require_relative 'metadata'
 require_relative '../lib/cache'
 
-class IOSMetadata < Metadata
-  attr_reader :_window_size
+module Percy
+  class IOSMetadata < Percy::Metadata
+    attr_reader :_window_size
 
-  def initialize(driver)
-    super(driver)
-    @_viewport = {}
-    @_window_size = {}
-  end
+    def initialize(driver)
+      super(driver)
+      @_viewport = {}
+      @_window_size = {}
+    end
 
-  def device_screen_size
-    vp = viewport
-    height = vp.fetch('top', 0) + vp.fetch('height', 0)
-    width = vp.fetch('width', 0)
-    if  height.zero? && width.zero?
-      scale_factor = value_from_devices_info('scale_factor', device_name)
-      height = get_window_size['height'] * scale_factor
-      width = get_window_size['width'] * scale_factor
+    def device_screen_size
+      vp = viewport
+      height = vp.fetch('top', 0) + vp.fetch('height', 0)
+      width = vp.fetch('width', 0)
+      if  height.zero? && width.zero?
+        scale_factor = value_from_devices_info('scale_factor', device_name)
+        height = get_window_size['height'] * scale_factor
+        width = get_window_size['width'] * scale_factor
+      end
+      { 'width' => width, 'height' => height }
     end
-    { 'width' => width, 'height' => height }
-  end
 
-  def status_bar
-    height = 0
-    view_port = viewport
-    if view_port.fetch('top', 0) != 0
-      height = view_port['top']
-    else
-      scale_factor = value_from_devices_info('scale_factor', device_name)
-      status_bar_height = value_from_devices_info('status_bar', device_name)
-      height = status_bar_height.to_i * scale_factor.to_i
+    def status_bar
+      height = 0
+      view_port = viewport
+      if view_port.fetch('top', 0) != 0
+        height = view_port['top']
+      else
+        scale_factor = value_from_devices_info('scale_factor', device_name)
+        status_bar_height = value_from_devices_info('status_bar', device_name)
+        height = status_bar_height.to_i * scale_factor.to_i
+      end
+      { 'height' => height }
     end
-    { 'height' => height }
-  end
 
-  def navigation_bar
-    { 'height' => 0 }
-  end
+    def navigation_bar
+      { 'height' => 0 }
+    end
 
-  def get_window_size
-    @_window_size = Cache.get_cache(session_id, Cache::WINDOW_SIZE)
-    unless @_window_size
-      @_window_size = driver.get_window_size
-      Cache.set_cache(session_id, Cache::WINDOW_SIZE, @_window_size)
+    def get_window_size
+      @_window_size = Percy::Cache.get_cache(session_id, Percy::Cache::WINDOW_SIZE)
+      unless @_window_size
+        @_window_size = driver.get_window_size
+        Percy::Cache.set_cache(session_id, Percy::Cache::WINDOW_SIZE, @_window_size)
+      end
+      @_window_size
     end
-    @_window_size
-  end
 
-  def viewport
-    @_viewport = Cache.get_cache(session_id, Cache::VIEWPORT)
-    if @_viewport.nil? || (@_viewport.is_a?(Hash) && @_viewport.empty?)
-      begin
-        @_viewport = execute_script('mobile: viewportRect')
-        Cache.set_cache(session_id, Cache::VIEWPORT, @_viewport)
-      rescue StandardError
-        log('Could not use viewportRect; using static config', on_debug: true)
-        # setting `viewport` as empty hash so that it's not nil anymore
-        Cache.set_cache(session_id, Cache::VIEWPORT, {})
+    def viewport
+      @_viewport = Percy::Cache.get_cache(session_id, Percy::Cache::VIEWPORT)
+      if @_viewport.nil? || (@_viewport.is_a?(Hash) && @_viewport.empty?)
+        begin
+          @_viewport = execute_script('mobile: viewportRect')
+          Percy::Cache.set_cache(session_id, Percy::Cache::VIEWPORT, @_viewport)
+        rescue StandardError
+          log('Could not use viewportRect; using static config', on_debug: true)
+          # setting `viewport` as empty hash so that it's not nil anymore
+          Percy::Cache.set_cache(session_id, Percy::Cache::VIEWPORT, {})
+        end
       end
+      @_viewport || { 'top' => 0, 'height' => 0, 'width' => 0 }
     end
-    @_viewport || { 'top' => 0, 'height' => 0, 'width' => 0 }
-  end
 
-  def device_name
-    if @device_name.nil?
-      caps = capabilities
-      caps = caps.as_json unless caps.is_a?(Hash)
-      @device_name = caps['deviceName']
+    def device_name
+      if @device_name.nil?
+        caps = capabilities
+        caps = caps.as_json unless caps.is_a?(Hash)
+        @device_name = caps['deviceName']
+      end
+      @device_name
     end
-    @device_name
-  end
 
-  def scale_factor
-    scale_factor = value_from_devices_info('scale_factor', device_name)
-    return viewport['width'] / get_window_size['width'] if scale_factor.zero?
+    def scale_factor
+      scale_factor = value_from_devices_info('scale_factor', device_name)
+      return viewport['width'] / get_window_size['width'] if scale_factor.zero?
 
-    scale_factor
+      scale_factor
+    end
   end
-end
+end

data/percy/metadata/metadata.rb

@@ -7,102 +7,104 @@ require_relative '../common/common'
 DEVICE_INFO_FILE_PATH = File.join(File.dirname(__FILE__), '..', 'configs', 'devices.json')
 DEVICE_INFO = JSON.parse(File.read(DEVICE_INFO_FILE_PATH))
 
-class Metadata
-  attr_reader :driver, :device_info
-  attr_accessor :device_name, :os_version, :device_info
-
-  def initialize(driver)
-    @driver = driver
-    @device_name = nil
-    @os_version = nil
-    @device_info = {}
-  end
-
-  def capabilities
-    caps = driver.capabilities
-    caps = caps.as_json unless caps.is_a?(Hash)
-    caps
-  end
+module Percy
+  class Metadata
+    attr_reader :driver, :device_info
+    attr_accessor :device_name, :os_version, :device_info
+
+    def initialize(driver)
+      @driver = driver
+      @device_name = nil
+      @os_version = nil
+      @device_info = {}
+    end
 
-  def session_id
-    driver.session_id
-  end
+    def capabilities
+      caps = driver.capabilities
+      caps = caps.as_json unless caps.is_a?(Hash)
+      caps
+    end
 
-  def os_name
-    capabilities['platformName']
-  end
+    def session_id
+      driver.session_id
+    end
 
-  def os_version
-    caps = capabilities
-    caps = caps.as_json unless caps.is_a?(Hash)
+    def os_name
+      capabilities['platformName']
+    end
 
-    os_version = caps['os_version'] || caps['platformVersion'] || ''
-    os_version = @os_version || os_version
-    begin
-      os_version.to_f.to_i.to_s
-    rescue StandardError
-      ''
+    def os_version
+      caps = capabilities
+      caps = caps.as_json unless caps.is_a?(Hash)
+
+      os_version = caps['os_version'] || caps['platformVersion'] || ''
+      os_version = @os_version || os_version
+      begin
+        os_version.to_f.to_i.to_s
+      rescue StandardError
+        ''
+      end
     end
-  end
 
-  def remote_url
-    driver.instance_variable_get(:@bridge).instance_variable_get(:@http).instance_variable_get(:@server_url).to_s
-  end
+    def remote_url
+      driver.instance_variable_get(:@bridge).instance_variable_get(:@http).instance_variable_get(:@server_url).to_s
+    end
 
-  def get_orientation(**kwargs)
-    orientation = kwargs[:orientation] || capabilities['orientation'] || 'PORTRAIT'
-    orientation = orientation.downcase
-    orientation = orientation == 'auto' ? _orientation : orientation
-    orientation.upcase
-  end
+    def get_orientation(**kwargs)
+      orientation = kwargs[:orientation] || capabilities['orientation'] || 'PORTRAIT'
+      orientation = orientation.downcase
+      orientation = orientation == 'auto' ? _orientation : orientation
+      orientation.upcase
+    end
 
-  def _orientation
-    driver.orientation.downcase
-  end
+    def _orientation
+      driver.orientation.downcase
+    end
 
-  def device_screen_size
-    raise NotImplementedError
-  end
+    def device_screen_size
+      raise NotImplementedError
+    end
 
-  def _device_name
-    raise NotImplementedError
-  end
+    def _device_name
+      raise NotImplementedError
+    end
 
-  def status_bar
-    raise NotImplementedError
-  end
+    def status_bar
+      raise NotImplementedError
+    end
 
-  def status_bar_height
-    status_bar['height']
-  end
+    def status_bar_height
+      status_bar['height']
+    end
 
-  def navigation_bar
-    raise NotImplementedError
-  end
+    def navigation_bar
+      raise NotImplementedError
+    end
 
-  def navigation_bar_height
-    navigation_bar['height']
-  end
+    def navigation_bar_height
+      navigation_bar['height']
+    end
 
-  def viewport
-    raise NotImplementedError
-  end
+    def viewport
+      raise NotImplementedError
+    end
 
-  def execute_script(command)
-    driver.execute_script(command)
-  end
+    def execute_script(command)
+      driver.execute_script(command)
+    end
 
-  def value_from_devices_info(key, device_name, os_version = nil)
-    device_info = get_device_info(device_name)
-    device_info = device_info[os_version] || {} if os_version
-    device_info[key].to_i || 0
-  end
+    def value_from_devices_info(key, device_name, os_version = nil)
+      device_info = get_device_info(device_name)
+      device_info = device_info[os_version] || {} if os_version
+      device_info[key].to_i || 0
+    end
 
-  def get_device_info(device_name)
-    return @device_info unless @device_info.empty?
+    def get_device_info(device_name)
+      return @device_info unless @device_info.empty?
 
-    @device_info = DEVICE_INFO[device_name.downcase] || {}
-    log("#{device_name.downcase} does not exist in config.") if @device_info.empty?
-    @device_info
+      @device_info = DEVICE_INFO[device_name.downcase] || {}
+      log("#{device_name.downcase} does not exist in config.") if @device_info.empty?
+      @device_info
+    end
   end
 end

data/percy/metadata/metadata_resolver.rb

@@ -4,18 +4,20 @@ require_relative '../exceptions/exceptions'
 require_relative 'android_metadata'
 require_relative 'ios_metadata'
 
-class MetadataResolver
-  def self.resolve(driver)
-    capabilities = driver.capabilities
-    capabilities = capabilities.as_json unless capabilities.is_a?(Hash)
-    platform_name = capabilities.fetch('platformName', '').downcase
-    case platform_name
-    when 'android'
-      AndroidMetadata.new(driver)
-    when 'ios'
-      IOSMetadata.new(driver)
-    else
-      raise PlatformNotSupported
+module Percy
+  class MetadataResolver
+    def self.resolve(driver)
+      capabilities = driver.capabilities
+      capabilities = capabilities.as_json unless capabilities.is_a?(Hash)
+      platform_name = capabilities.fetch('platformName', '').downcase
+      case platform_name
+      when 'android'
+        Percy::AndroidMetadata.new(driver)
+      when 'ios'
+        Percy::IOSMetadata.new(driver)
+      else
+        raise PlatformNotSupported
+      end
     end
   end
 end

data/percy/{screenshot.rb → percy-appium-app.rb}

@@ -7,14 +7,14 @@ require_relative 'lib/cli_wrapper'
 require_relative 'environment'
 
 def percy_screenshot(driver, name, **kwargs)
-  return nil unless CLIWrapper.percy_enabled?
+  return nil unless Percy::CLIWrapper.percy_enabled?
 
   app_percy = nil
-  provider_class = Environment.session_type == 'automate' ? PercyOnAutomate : AppPercy
+  provider_class = Percy::Environment.session_type == 'automate' ? Percy::PercyOnAutomate : Percy::AppPercy
   app_percy = provider_class.new(driver)
   app_percy.screenshot(name, **kwargs)
 rescue StandardError => e
-  CLIWrapper.post_failed_event(e.to_s)
+  Percy::CLIWrapper.post_failed_event(e.to_s)
   log("Could not take screenshot \"#{name}\"")
   raise e if app_percy && !app_percy.percy_options.ignore_errors