appium_lib_core 1.6.0 → 1.7.0

data/lib/appium_lib_core/android/device/clipboard.rb

@@ -0,0 +1,42 @@
+require 'base64'
+
+module Appium
+  module Core
+    module Android
+      module Device
+        module Clipboard
+          def self.add_methods
+            ::Appium::Core::Device.add_endpoint_method(:get_clipboard) do
+              def get_clipboard(content_type: :plaintext)
+                unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                  raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+                end
+
+                params = { contentType: content_type }
+
+                data = execute(:get_clipboard, {}, params)
+                Base64.decode64 data
+              end
+            end
+
+            ::Appium::Core::Device.add_endpoint_method(:set_clipboard) do
+              def set_clipboard(content:, content_type: :plaintext, label: nil)
+                unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                  raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+                end
+
+                params = {
+                  contentType: content_type,
+                  content: Base64.encode64(content)
+                }
+                params[:label] = label unless label.nil?
+
+                execute(:set_clipboard, {}, params)
+              end
+            end
+          end
+        end # module Clipboard
+      end # module Device
+    end # module Android
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/android/device/emulator.rb

@@ -1,168 +1,170 @@
 module Appium
-  module Android
-    module Device
-      module Emulator
-        GSM_CALL_ACTIONS = [:call, :accept, :cancel, :hold].freeze
-
-        GSM_VOICE_STATES = [:on, :off, :denied, :searching, :roaming, :home, :unregistered].freeze
-
-        GSM_SIGNALS = { none_or_unknown: 0, poor: 1, moderate: 2, good: 3, great: 4 }.freeze
-
-        # :gsm   // GSM/CSD (up: 14.4, down: 14.4).
-        # :scsd  // HSCSD (up: 14.4, down: 57.6).
-        # :gprs  // GPRS (up: 28.8, down: 57.6).
-        # :edge  // EDGE/EGPRS (up: 473.6, down: 473.6).
-        # :umts  // UMTS/3G (up: 384.0, down: 384.0).
-        # :hsdpa // HSDPA (up: 5760.0, down: 13,980.0).
-        # :lte   // LTE (up: 58,000, down: 173,000).
-        # :evdo  // EVDO (up: 75,000, down: 280,000).
-        # :full  // No limit, the default (up: 0.0, down: 0.0).
-        NET_SPEED = [:gsm, :scsd, :gprs, :edge, :umts, :hsdpa, :lte, :evdo, :full].freeze
-
-        POWER_AC_STATE = [:on, :off].freeze
-
-        # @!method send_sms(phone_number:, message:)
-        #     Emulate send SMS event on the connected emulator.
-        #
-        # @param [String] phone_number: The phone number of message sender
-        # @param [String] message: The message to send
-        #
-        # @example
-        #
-        #   @driver.send_sms phone_number: '00000000000', message: 'test message'
-        #
-
-        # @!method gsm_call(phone_number:, action:)
-        #     Emulate GSM call event on the connected emulator.
-        #
-        # @param [String] phone_number: The phone number of message sender
-        # @param [Hash] action: One of available GSM call actions. Available action is GSM_CALL_ACTION.
-        #
-        # @example
-        #
-        #   @driver.gsm_call phone_number: '00000000000', action: :call
-        #
-
-        # @!method gsm_signal(signal_strength)
-        #     Emulate GSM signal strength change event on the connected emulator.
-        #
-        # @param [Hash] signal_strength One of available GSM signal strength. Available action is GSM_SIGNAL.
-        #
-        # @example
-        #
-        #   @driver.gsm_signal :good
-        #
-
-        # @!method gsm_voice(state)
-        #     Emulate GSM voice event on the connected emulator.
-        #
-        # @param [Hash] state One of available GSM voice state. Available action is GSM_VOICE_STATE.
-        #
-        # @example
-        #
-        #   @driver.gsm_voice :on
-        #
-
-        # @!method set_network_speed(netspeed)
-        #     Emulate network speed change event on the connected emulator.
-        #
-        # @param [Hash] netspeed One of available Network Speed values. Available action is NET_SPEED.
-        #
-        # @example
-        #
-        #   @driver.set_network_speed :gsm
-        #
-
-        # @!method set_power_capacity(percent)
-        #     Emulate power capacity change on the connected emulator.
-        #
-        # @param [Integer] percent Percentage value in range [0, 100].
-        #
-        # @example
-        #
-        #   @driver.set_power_capacity 10
-        #
-
-        # @!method set_power_ac(state)
-        #     Emulate power state change on the connected emulator.
-        #
-        # @param [Hash] state One of available power AC state. Available action is POWER_AC_STATE.
-        #
-        # @example
-        #
-        #   @driver.set_power_ac :on
-        #
-
-        ####
-        ## self.emulator_commands
-        ####
-
-        def self.emulator_commands
-          Appium::Core::Device.add_endpoint_method(:send_sms) do
-            def send_sms(phone_number:, message:)
-              execute(:send_sms, {}, { phoneNumber: phone_number, message: message })
+  module Core
+    module Android
+      module Device
+        module Emulator
+          GSM_CALL_ACTIONS = [:call, :accept, :cancel, :hold].freeze
+
+          GSM_VOICE_STATES = [:on, :off, :denied, :searching, :roaming, :home, :unregistered].freeze
+
+          GSM_SIGNALS = { none_or_unknown: 0, poor: 1, moderate: 2, good: 3, great: 4 }.freeze
+
+          # :gsm   // GSM/CSD (up: 14.4, down: 14.4).
+          # :scsd  // HSCSD (up: 14.4, down: 57.6).
+          # :gprs  // GPRS (up: 28.8, down: 57.6).
+          # :edge  // EDGE/EGPRS (up: 473.6, down: 473.6).
+          # :umts  // UMTS/3G (up: 384.0, down: 384.0).
+          # :hsdpa // HSDPA (up: 5760.0, down: 13,980.0).
+          # :lte   // LTE (up: 58,000, down: 173,000).
+          # :evdo  // EVDO (up: 75,000, down: 280,000).
+          # :full  // No limit, the default (up: 0.0, down: 0.0).
+          NET_SPEED = [:gsm, :scsd, :gprs, :edge, :umts, :hsdpa, :lte, :evdo, :full].freeze
+
+          POWER_AC_STATE = [:on, :off].freeze
+
+          # @!method send_sms(phone_number:, message:)
+          #     Emulate send SMS event on the connected emulator.
+          #
+          # @param [String] phone_number: The phone number of message sender
+          # @param [String] message: The message to send
+          #
+          # @example
+          #
+          #   @driver.send_sms phone_number: '00000000000', message: 'test message'
+          #
+
+          # @!method gsm_call(phone_number:, action:)
+          #     Emulate GSM call event on the connected emulator.
+          #
+          # @param [String] phone_number: The phone number of message sender
+          # @param [Hash] action: One of available GSM call actions. Available action is GSM_CALL_ACTION.
+          #
+          # @example
+          #
+          #   @driver.gsm_call phone_number: '00000000000', action: :call
+          #
+
+          # @!method gsm_signal(signal_strength)
+          #     Emulate GSM signal strength change event on the connected emulator.
+          #
+          # @param [Hash] signal_strength One of available GSM signal strength. Available action is GSM_SIGNAL.
+          #
+          # @example
+          #
+          #   @driver.gsm_signal :good
+          #
+
+          # @!method gsm_voice(state)
+          #     Emulate GSM voice event on the connected emulator.
+          #
+          # @param [Hash] state One of available GSM voice state. Available action is GSM_VOICE_STATE.
+          #
+          # @example
+          #
+          #   @driver.gsm_voice :on
+          #
+
+          # @!method set_network_speed(netspeed)
+          #     Emulate network speed change event on the connected emulator.
+          #
+          # @param [Hash] netspeed One of available Network Speed values. Available action is NET_SPEED.
+          #
+          # @example
+          #
+          #   @driver.set_network_speed :gsm
+          #
+
+          # @!method set_power_capacity(percent)
+          #     Emulate power capacity change on the connected emulator.
+          #
+          # @param [Integer] percent Percentage value in range [0, 100].
+          #
+          # @example
+          #
+          #   @driver.set_power_capacity 10
+          #
+
+          # @!method set_power_ac(state)
+          #     Emulate power state change on the connected emulator.
+          #
+          # @param [Hash] state One of available power AC state. Available action is POWER_AC_STATE.
+          #
+          # @example
+          #
+          #   @driver.set_power_ac :on
+          #
+
+          ####
+          ## self.emulator_commands
+          ####
+
+          def self.add_methods
+            ::Appium::Core::Device.add_endpoint_method(:send_sms) do
+              def send_sms(phone_number:, message:)
+                execute(:send_sms, {}, { phoneNumber: phone_number, message: message })
+              end
             end
-          end
 
-          Appium::Core::Device.add_endpoint_method(:gsm_call) do
-            def gsm_call(phone_number:, action:)
-              unless GSM_CALL_ACTIONS.member? action.to_sym
-                raise "action: should be member of #{GSM_CALL_ACTIONS}. Not #{action}."
-              end
+            ::Appium::Core::Device.add_endpoint_method(:gsm_call) do
+              def gsm_call(phone_number:, action:)
+                unless GSM_CALL_ACTIONS.member? action.to_sym
+                  raise "action: should be member of #{GSM_CALL_ACTIONS}. Not #{action}."
+                end
 
-              execute(:gsm_call, {}, { phoneNumber: phone_number, action: action })
+                execute(:gsm_call, {}, { phoneNumber: phone_number, action: action })
+              end
             end
-          end
 
-          Appium::Core::Device.add_endpoint_method(:gsm_signal) do
-            def gsm_signal(signal_strength)
-              raise "#{signal_strength} should be member of #{GSM_SIGNALS} " if GSM_SIGNALS[signal_strength.to_sym].nil?
+            ::Appium::Core::Device.add_endpoint_method(:gsm_signal) do
+              def gsm_signal(signal_strength)
+                raise "#{signal_strength} should be member of #{GSM_SIGNALS} " if GSM_SIGNALS[signal_strength.to_sym].nil?
 
-              execute(:gsm_signal, {}, { signalStrengh: GSM_SIGNALS[signal_strength] })
+                execute(:gsm_signal, {}, { signalStrengh: GSM_SIGNALS[signal_strength] })
+              end
             end
-          end
 
-          Appium::Core::Device.add_endpoint_method(:gsm_voice) do
-            def gsm_voice(state)
-              unless GSM_VOICE_STATES.member? state.to_sym
-                raise "The state should be member of #{GSM_VOICE_STATES}. Not #{state}."
-              end
+            ::Appium::Core::Device.add_endpoint_method(:gsm_voice) do
+              def gsm_voice(state)
+                unless GSM_VOICE_STATES.member? state.to_sym
+                  raise "The state should be member of #{GSM_VOICE_STATES}. Not #{state}."
+                end
 
-              execute(:gsm_voice, {}, { state: state })
+                execute(:gsm_voice, {}, { state: state })
+              end
             end
-          end
 
-          Appium::Core::Device.add_endpoint_method(:set_network_speed) do
-            def set_network_speed(netspeed)
-              unless NET_SPEED.member? netspeed.to_sym
-                raise "The netspeed should be member of #{NET_SPEED}. Not #{netspeed}."
-              end
+            ::Appium::Core::Device.add_endpoint_method(:set_network_speed) do
+              def set_network_speed(netspeed)
+                unless NET_SPEED.member? netspeed.to_sym
+                  raise "The netspeed should be member of #{NET_SPEED}. Not #{netspeed}."
+                end
 
-              execute(:set_network_speed, {}, { netspeed: netspeed })
+                execute(:set_network_speed, {}, { netspeed: netspeed })
+              end
             end
-          end
 
-          Appium::Core::Device.add_endpoint_method(:set_power_capacity) do
-            def set_power_capacity(percent)
-              unless (0..100).member? percent
-                raise "The  percent should be between 0 and 100. Not #{percent}."
-              end
+            ::Appium::Core::Device.add_endpoint_method(:set_power_capacity) do
+              def set_power_capacity(percent)
+                unless (0..100).member? percent
+                  raise "The  percent should be between 0 and 100. Not #{percent}."
+                end
 
-              execute(:set_power_capacity, {}, { percent: percent })
+                execute(:set_power_capacity, {}, { percent: percent })
+              end
             end
-          end
 
-          Appium::Core::Device.add_endpoint_method(:set_power_ac) do
-            def set_power_ac(state)
-              unless POWER_AC_STATE.member? state.to_sym
-                raise "The state should be member of #{POWER_AC_STATE}. Not #{state}."
-              end
+            ::Appium::Core::Device.add_endpoint_method(:set_power_ac) do
+              def set_power_ac(state)
+                unless POWER_AC_STATE.member? state.to_sym
+                  raise "The state should be member of #{POWER_AC_STATE}. Not #{state}."
+                end
 
-              execute(:set_power_ac, {}, { state: state })
+                execute(:set_power_ac, {}, { state: state })
+              end
             end
-          end
-        end # def self.emulator_commands
-      end # module Emulator
-    end # module Device
-  end # module Android
+          end # def self.emulator_commands
+        end # module Emulator
+      end # module Device
+    end # module Android
+  end # module Core
 end # module Appium

data/lib/appium_lib_core/android/device/network.rb

@@ -0,0 +1,47 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Network
+          def self.add_methods
+            ::Appium::Core::Device.add_endpoint_method(:get_network_connection) do
+              def get_network_connection
+                execute :get_network_connection
+              end
+            end
+
+            ::Appium::Core::Device.add_endpoint_method(:toggle_wifi) do
+              def toggle_wifi
+                execute :toggle_wifi
+              end
+            end
+
+            ::Appium::Core::Device.add_endpoint_method(:toggle_data) do
+              def toggle_data
+                execute :toggle_data
+              end
+            end
+
+            ::Appium::Core::Device.add_endpoint_method(:set_network_connection) do
+              def set_network_connection(mode)
+                # TODO. Update set_network_connection as well
+                # connection_type = {airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0}
+                # raise ArgumentError, 'Invalid connection type' unless type_to_values.keys.include? mode
+                # type = connection_type[mode]
+                # execute :set_network_connection, {}, type: type
+                execute :set_network_connection, {}, type: mode
+              end
+            end
+
+            ::Appium::Core::Device.add_endpoint_method(:toggle_airplane_mode) do
+              def toggle_airplane_mode
+                execute :toggle_airplane_mode
+              end
+              alias_method :toggle_flight_mode, :toggle_airplane_mode
+            end
+          end
+        end # module Network
+      end # module Device
+    end # module Android
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/android/device/performance.rb

@@ -0,0 +1,24 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Performance
+          def self.add_methods
+            ::Appium::Core::Device.add_endpoint_method(:get_performance_data_types) do
+              def get_performance_data_types
+                execute :get_performance_data_types
+              end
+            end
+
+            ::Appium::Core::Device.add_endpoint_method(:get_performance_data) do
+              def get_performance_data(package_name:, data_type:, data_read_timeout: 1000)
+                execute(:get_performance_data, {},
+                        packageName: package_name, dataType: data_type, dataReadTimeout: data_read_timeout)
+              end
+            end
+          end
+        end # module Performance
+      end # module Device
+    end # module Android
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/android/device/screen.rb

@@ -0,0 +1,39 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Screen
+          def self.add_methods
+            ::Appium::Core::Device.add_endpoint_method(:get_display_density) do
+              def get_display_density
+                execute :get_display_density
+              end
+            end
+
+            ::Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
+              # rubocop:disable Metrics/ParameterLists
+              def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil,
+                                         video_size: nil, time_limit: '180', bit_rate: nil, bug_report: nil)
+                option = ::Appium::Core::Device::ScreenRecord.new(
+                  remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
+                ).upload_option
+
+                option[:videoSize] = video_size unless video_size.nil?
+                option[:timeLimit] = time_limit
+                option[:bitRate] = bit_rate unless bit_rate.nil?
+
+                unless bug_report.nil?
+                  raise 'bug_report should be true or false' unless [true, false].member?(bug_report)
+                  option[:bugReport] = bug_report
+                end
+
+                execute(:start_recording_screen, {}, { options: option })
+              end
+              # rubocop:enable Metrics/ParameterLists
+            end
+          end
+        end # module Screen
+      end # module Device
+    end # module Android
+  end # module Core
+end # module Appium