appium_lib 4.1.0 → 5.0.0

data/lib/appium_lib/common/helper.rb

@@ -1,3 +1,5 @@
+require 'selenium/webdriver/common/error'
+
 # Generic helper methods not specific
 # to a particular tag name
 module Appium
@@ -53,28 +55,14 @@ module Appium
       find_elements :xpath, xpath_str
     end
 
-    # Prints xml of the current page
-    # @return [void]
-    def source
-      source = @driver.page_source
+    def _print_source source
+      opts = Nokogiri::XML::ParseOptions::NOBLANKS | Nokogiri::XML::ParseOptions::NONET
       if source.start_with? '<html'
-        doc = Nokogiri::HTML(source) do |config|
-          config.options = Nokogiri::XML::ParseOptions::NOBLANKS | Nokogiri::XML::ParseOptions::NONET
-        end
-        puts doc.to_xhtml indent: 2
+        doc = Nokogiri::HTML(source) { |cfg| cfg.options = opts }
       else
-        doc = Nokogiri::XML(source) do |config|
-          config.options = Nokogiri::XML::ParseOptions::NOBLANKS | Nokogiri::XML::ParseOptions::NONET
-        end
-        puts doc.to_xml indent: 2
+        doc = Nokogiri::XML(source)  { |cfg| cfg.options = opts }
       end
-    end
-
-    # Returns XML string for the current page
-    # Same as driver.page_source
-    # @return [String]
-    def get_source
-      @driver.page_source
+      puts doc.to_xml indent: 2
     end
 
     # @private
@@ -93,7 +81,7 @@ module Appium
       # http://nokogiri.org/Nokogiri/XML/SAX/Document.html
       def start_element name, attrs = []
         # Count only visible elements. Android is always visible
-        element_visible = $driver.device_is_android? ? true : attrs.to_h['visible'] == 'true'
+        element_visible = $driver.device_is_android? ? true : Hash[attrs]['visible'] == 'true'
         @result[name]   += 1 if element_visible
       end
 
@@ -140,7 +128,9 @@ module Appium
 
     # @private
     def lazy_load_strings
-      @strings_xml ||= app_strings
+      # app strings only works on local apps.
+      # on disk apps (ex: com.android.settings) will error
+      @strings_xml ||= ignore { app_strings } || {}
     end
 
     # Search strings.xml's values for target.
@@ -185,16 +175,18 @@ module Appium
       end
 
       def reset
-        @element_stack = []
+        @element_stack     = []
         @elements_in_order = []
-        @skip_element = false
+        @skip_element      = false
       end
 
       def result
         @elements_in_order.reduce('') do |r, e|
-          name = e.delete :name
+          name        = e.delete :name
           attr_string = e.reduce('') do |string, attr|
-            string += "  #{attr[0]}: #{attr[1]}\n"
+            attr_1 = attr[1]
+            attr_1 = attr_1 ? attr_1.strip : attr_1
+            string += "  #{attr[0]}: #{attr_1}\n"
           end
 
           unless attr_string.nil? || attr_string.empty?
@@ -207,8 +199,8 @@ module Appium
       def start_element name, attrs = []
         @skip_element = filter && !filter.include?(name.downcase)
         unless @skip_element
-          element = {name: name}
-          attrs.each {|a| element[a[0]] = a[1]}
+          element = { name: name }
+          attrs.each { |a| element[a[0]] = a[1] }
           @element_stack.push element
           @elements_in_order.push element
         end
@@ -216,16 +208,20 @@ module Appium
 
       def end_element name
         return if filter && !filter.include?(name.downcase)
-        element_index = @element_stack.rindex {|e| e[:name] == name}
+        element_index = @element_stack.rindex { |e| e[:name] == name }
         @element_stack.delete_at element_index
       end
 
       def characters(chars)
         unless @skip_element
-          element = @element_stack.last
+          element        = @element_stack.last
           element[:text] = chars
         end
       end
     end
+
+    def _no_such_element
+      raise Selenium::WebDriver::Error::NoSuchElementError, 'An element could not be located on the page using the given search parameters.'
+    end
   end # module Common
-end # module Appium
+end # module Appium

data/lib/appium_lib/common/patch.rb

@@ -1,3 +1,5 @@
+require_relative 'version'
+
 module Appium
   module Common
     # Implement useful features for element.
@@ -89,6 +91,7 @@ def patch_webdriver_bridge
       path_str   = path.sub(path_match[0], '') unless path_match.nil?
 
       puts "#{verb} #{path_str}"
+
       # must check to see if command_hash is a hash. sometimes it's not.
       if command_hash.is_a?(Hash) && !command_hash.empty?
         print_command = command_hash.clone
@@ -104,6 +107,10 @@ def patch_webdriver_bridge
         else
           ap print_command
         end
+      else # non-standard command hash
+        # It's important to output this for debugging problems.
+        # for example invalid JSON will not be a Hash
+        ap command_hash if command_hash
       end
       delay = $driver.global_webdriver_http_sleep
       sleep delay if !delay.nil? && delay > 0
@@ -131,4 +138,9 @@ class Selenium::WebDriver::Remote::Response
 
     msg
   end
+end
+
+class Selenium::WebDriver::Remote::Http::Common
+  remove_const :DEFAULT_HEADERS if defined? DEFAULT_HEADERS
+  DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }
 end

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '4.1.0' unless defined? ::Appium::VERSION
-  DATE    = '2014-07-21' unless defined? ::Appium::DATE
+  VERSION = '5.0.0' unless defined? ::Appium::VERSION
+  DATE    = '2014-12-23' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/device/device.rb

@@ -8,14 +8,15 @@ module Appium
       post: {
         open_notifications:   'session/:session_id/appium/device/open_notifications',
         shake:                'session/:session_id/appium/device/shake',
-        launch:               'session/:session_id/appium/app/launch',
+        launch_app:           'session/:session_id/appium/app/launch',
         close_app:            'session/:session_id/appium/app/close',
         reset:                'session/:session_id/appium/app/reset',
         toggle_airplane_mode: 'session/:session_id/appium/device/toggle_airplane_mode',
       },
       get:  {
-        current_activity:   'session/:session_id/appium/device/current_activity',
-        current_context:    'session/:session_id/context',
+        current_activity:       'session/:session_id/appium/device/current_activity',
+        current_context:        'session/:session_id/context',
+        get_network_connection: 'session/:session_id/network_connection',
       }
     }
 
@@ -32,7 +33,7 @@ module Appium
 
     # @!method current_activity
 
-    # @!method launch
+    # @!method launch_app
     #   Start the simulator and applicaton configured with desired capabilities  
 
     # @!method reset
@@ -92,6 +93,13 @@ module Appium
     #   Android only;  Ends the test coverage and writes the results to the given path on device.
     #   @param path (String) Path on the device to write too.
     #   @param intent (String) Intent to broadcast when ending coverage.
+
+    # @!method get_settings
+    #   Get appium Settings for current test session
+
+    # @!method update_settings
+    #   Update appium Settings for current test session
+    #   @param settings (hash) Settings to update, keys are settings, values to value to set each setting to
     class << self
       def extended(mod)
         extend_webdriver_with_forwardable
@@ -120,15 +128,15 @@ module Appium
           end
         end
 
-        add_endpoint_method(:install, 'session/:session_id/appium/device/install_app') do
-          def install(path)
-            execute :install, {}, :appPath => path
+        add_endpoint_method(:install_app, 'session/:session_id/appium/device/install_app') do
+          def install_app(path)
+            execute :install_app, {}, :appPath => path
           end
         end
 
-        add_endpoint_method(:remove, 'session/:session_id/appium/device/remove_app') do
-          def remove(id)
-            execute :remove, {}, :appId => id
+        add_endpoint_method(:remove_app, 'session/:session_id/appium/device/remove_app') do
+          def remove_app(id)
+            execute :remove_app, {}, :appId => id
           end
         end
 
@@ -144,6 +152,36 @@ module Appium
           end
         end
 
+        # @!method start_activity
+        #   Start a new activity within the current app or launch a new app and start the target activity.
+        #
+        #   Android only.
+        #   @param [String] The package owning the activity [required]
+        #   @param [String] The target activity [required]
+        #   @param [String] The package to start before the target package [optional]
+        #   @param [String] The activity to start before the target activity [optional]
+        #
+        #   ```ruby
+        #   start_activity app_package: 'io.appium.android.apis', app_activity: '.accessibility.AccessibilityNodeProviderActivity'
+        #   ```
+        add_endpoint_method(:start_activity, 'session/:session_id/appium/device/start_activity') do
+          def start_activity(opts)
+            raise 'opts must be a hash' unless opts.is_a? Hash
+            app_package = opts[:app_package]
+            raise 'app_package is required' unless app_package
+            app_activity = opts[:app_activity]
+            raise 'app_activity is required' unless opts[:app_activity]
+            app_wait_package  = opts.fetch(:app_wait_package, '')
+            app_wait_activity = opts.fetch(:app_wait_activity, '')
+
+            unknown_opts = opts.keys - [:app_package, :app_activity, :app_wait_package, :app_wait_activity]
+            raise "Unknown options #{unknown_opts}" unless unknown_opts.empty?
+
+            execute :start_activity, {}, { appPackage:     app_package,      appActivity: app_activity,
+                                           appWaitPackage: app_wait_package, appWaitActivity: app_wait_activity }
+          end
+        end
+
         add_endpoint_method(:set_context, 'session/:session_id/context') do
           def set_context(context=null)
             execute :set_context, {}, :name => context
@@ -181,7 +219,7 @@ module Appium
         # TODO TEST ME
         add_endpoint_method(:set_immediate_value, 'session/:session_id/appium/element/:id/value') do
           def set_immediate_value(element, value)
-            execute :set_immediate_value, { :id => element.ref }, value
+            execute :set_immediate_value, { :id => element.ref }, value: value
           end
         end
 
@@ -214,6 +252,39 @@ module Appium
           end
         end
 
+        add_endpoint_method(:get_settings, 'session/:session_id/appium/settings', :get) do
+          def get_settings
+            execute :get_settings, {}
+          end
+        end
+
+        add_endpoint_method(:update_settings, 'session/:session_id/appium/settings') do
+          def update_settings(settings)
+            execute :update_settings, {}, settings: settings
+          end
+        end
+
+        # @!method get_network_connection
+        #   Get the device network connection current status
+        #   See set_network_connection method for return value
+
+        # @!method set_network_connection
+        #   Set the device network connection mode
+        #   @param path (String) Bit mask that represent the network mode
+        #   Value (Alias)      | Data | Wifi | Airplane Mode
+        #   -------------------------------------------------
+        #   1 (Airplane Mode)  | 0    | 0    | 1
+        #   6 (All network on) | 1    | 1    | 0
+        #   4 (Data only)      | 1    | 0    | 0
+        #   2 (Wifi only)      | 0    | 1    | 0
+        #   0 (None)           | 0    | 0    | 0
+        #
+        add_endpoint_method(:set_network_connection, 'session/:session_id/network_connection') do
+          def set_network_connection(mode)
+            execute :set_network_connection, {}, type: mode
+          end
+        end
+
         add_touch_actions
         extend_search_contexts
       end
@@ -280,7 +351,7 @@ module Appium
       def add_touch_actions
         add_endpoint_method(:touch_actions, 'session/:session_id/touch/perform') do
           def touch_actions(actions)
-            actions = [actions].flatten
+            actions = { actions: [actions].flatten }
             execute :touch_actions, {}, actions
           end
         end

data/lib/appium_lib/driver.rb

@@ -223,19 +223,32 @@ module Appium
 
     # attr readers are promoted to global scope. To avoid clobbering, they're
     # made available via the driver_attributes method
+    #
+    # attr_accessor is repeated for each one so YARD documents them properly.
+
 
     # The amount to sleep in seconds before every webdriver http call.
-    attr_accessor :global_webdriver_http_sleep,
-                  :caps,
-                  :custom_url,
-                  :export_session,
-                  :default_wait,
-                  :last_waits,
-                  :sauce_username,
-                  :sauce_access_key,
-                  :appium_port,
-                  :appium_device,
-                  :appium_debug
+    attr_accessor :global_webdriver_http_sleep
+    # Selenium webdriver capabilities
+    attr_accessor :caps
+    # Custom URL for the selenium server
+    attr_accessor :custom_url
+    # Export session id to textfile in /tmp for 3rd party tools
+    attr_accessor :export_session
+    # Default wait time for elements to appear
+    attr_accessor :default_wait
+    # Array of previous wait time values
+    attr_accessor :last_waits
+    # Username for use on Sauce Labs
+    attr_accessor :sauce_username
+    # Access Key for use on Sauce Labs
+    attr_accessor :sauce_access_key
+    # Appium's server port
+    attr_accessor :appium_port
+    # Device type to request from the appium server
+    attr_accessor :appium_device
+    # Boolean debug mode for the Appium Ruby bindings
+    attr_accessor :appium_debug
 
     # Creates a new driver
     #
@@ -475,8 +488,7 @@ module Appium
         raise 'ERROR: Unable to connect to Appium. Is the server running?'
       end
 
-      # Set implicit wait by default unless we're using Pry.
-      @driver.manage.timeouts.implicit_wait = @default_wait unless defined? Pry
+      @driver.manage.timeouts.implicit_wait = @default_wait
 
       @driver
     end
@@ -592,4 +604,4 @@ end # module Appium
 # Paging in Pry is annoying :q required to exit.
 # With pager disabled, the output is similar to IRB
 # Only set if Pry is defined.
-Pry.config.pager = false if defined?(Pry)
+Pry.config.pager = false if defined?(Pry)

data/lib/appium_lib/ios/element/button.rb

@@ -10,7 +10,7 @@ module Appium
     def button value
       # return button at index.
       return ele_index UIAButton, value if value.is_a? Numeric
-      xpath_visible_contains UIAButton, value
+      ele_by_json_visible_contains UIAButton, value
     end
 
     # Find all UIAButtons containing value.
@@ -19,7 +19,7 @@ module Appium
     # @return [Array<UIAButton>]
     def buttons value=false
       return tags UIAButton unless value
-      xpaths_visible_contains UIAButton, value
+      eles_by_json_visible_contains UIAButton, value
     end
 
     # Find the first UIAButton.
@@ -38,14 +38,14 @@ module Appium
     # @param value [String] the value to match exactly
     # @return [UIAButton]
     def button_exact value
-      xpath_visible_exact UIAButton, value
+      ele_by_json_visible_exact UIAButton, value
     end
 
     # Find all UIAButtons that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<UIAButton>]
     def buttons_exact value
-      xpaths_visible_exact UIAButton, value
+      eles_by_json_visible_exact UIAButton, value
     end
   end # module Ios
 end # module Appium

data/lib/appium_lib/ios/element/generic.rb

@@ -5,28 +5,28 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def find value
-      xpath_visible_contains '*', value
+      ele_by_json_visible_contains '*', value
     end
 
     # Find all elements containing value
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def finds value
-      xpaths_visible_contains '*', value
+      eles_by_json_visible_contains '*', value
     end
 
     # Find the first element exactly matching value
     # @param value [String] the value to search for
     # @return [Element]
     def find_exact value
-      xpath_visible_exact '*', value
+      ele_by_json_visible_exact '*', value
     end
 
     # Find all elements exactly matching value
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def finds_exact value
-      xpaths_visible_exact '*', value
+      eles_by_json_visible_exact '*', value
     end
   end # module Ios
 end # module Appium

data/lib/appium_lib/ios/element/text.rb

@@ -9,7 +9,7 @@ module Appium
     # @return [UIAStaticText]
     def text value
       return ele_index UIAStaticText, value if value.is_a? Numeric
-      xpath_visible_contains UIAStaticText, value
+      ele_by_json_visible_contains UIAStaticText, value
     end
 
     # Find all UIAStaticText containing value.
@@ -18,7 +18,7 @@ module Appium
     # @return [Array<UIAStaticText>]
     def texts value=false
       return tags UIAStaticText unless value
-      xpaths_visible_contains UIAStaticText, value
+      eles_by_json_visible_contains UIAStaticText, value
     end
 
     # Find the first UIAStaticText.
@@ -37,14 +37,14 @@ module Appium
     # @param value [String] the value to match exactly
     # @return [UIAStaticText]
     def text_exact value
-      xpath_visible_exact UIAStaticText, value
+      ele_by_json_visible_exact UIAStaticText, value
     end
 
     # Find all UIAStaticTexts that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<UIAStaticText>]
     def texts_exact value
-      xpaths_visible_exact UIAStaticText, value
+      eles_by_json_visible_exact UIAStaticText, value
     end
   end # module Ios
 end # module Appium