device_api-android 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc299fd6553b73df6928d551ceb30f7bbfc43e87
-  data.tar.gz: 18327f25f6fed8d4c9401ec2ff7d42a75800058d
+  metadata.gz: c09f0413dc5506bd026fdaa5f8bf85af6a18a404
+  data.tar.gz: 2bc91a6a0affe29634f881f5592d3be10bde1efb
 SHA512:
-  metadata.gz: 1c7268f823bd12658fff01b5c186f83a62a05d5d68e937eaf06bc0245f0777bdafd4672a24365fc3d35681532a29dc9a05441753acbf9296b6e35ded3d58dfb4
-  data.tar.gz: fd850b7e8544c44cba97ddbbee27260590164b5fd448c67db0d2c49a6def61b44f1bac420e7db2e90d982dcec2d83de16ec307eabe0cde89050af75012e1ff76
+  metadata.gz: 5247d30f5ce2233891a6f3770c5283b753466f6e9fd81249e1184ec14ea9a9064843228f924c01ea07325449b95a76c3e119b933634d95f81558068188438856
+  data.tar.gz: 9fb2718ad39a1ceceaefa7ce4e1b2251d0b39d5afbbb109819f299b635d0d75b1438f8d76d7f28f8d4e48f3462775aaf1c2cfef578ffbc2fac41e97054c30855

data/README.md

@@ -25,6 +25,34 @@ Try connecting an android device with usb, and run:
 
 You might need to set your device to developer mode, and turn on usb debugging so that the android debug bridge can detect your device.
 
+### Connecting and disconnecting from Remote Devices
+
+You can connect to devices via their IP address and port number. The syntax is:
+
+    DeviceAPI::Android.connect(<IP address>,<port number>=5555)
+
+This should add a device to the already connected devices, which you can query with DeviceAPI::Android.devices. You can disconnect from a device like so:
+
+    DeviceAPI::Android.disconnect(<IP address>,<port number>=5555)
+
+Once connected, the IP address and port number combination becomes the serial for the device, and you can execute commands such as adb shell through specifying the IP address/port number instead of the serial number. For both Android.connect and Android.disconnect, if port number is not specified, and ip address is only specified, port number defaults to 5555. (Note that Android.disconnect doesn't automagically disconnect you from a connection with a port number that is not 5555 when it is called without a port argument)
+
+You can also use the disconnect method on a Android device object, without any arguments to disconnect a device. It will throw an error if the device is not connected. 
+
+    device.disconnect
+
+You can use device.is_remote? to determine if the device is a remote device, e.g. it has a ipaddress and port as an adb serial, and can attempt to be connected to.
+
+    device.is_remote?
+
+DeviceAPI::Android::ADB::DeviceAlreadyConnectedError is raised when DeviceAPI::Android.connect is called on an already connected device.
+
+DeviceAPI::Android::DeviceDisconnectedWhenNotARemoteDevice is raised when we are attempting to call disconnect on a device that is not a remote device, e.g. it has no hope of being disconnected from.
+
+DeviceAPI::Android::ADBCommandError is raised when we cannot connect to a device, e.g. adb times out.
+
+DeviceAPI::Android::ADBCommandError is raised when we cannot disconnect from a device, e.g. adb times out or we were already disconnected.
+
 ### Detecting devices
 
 There are two methods for detecting devices:
@@ -105,7 +133,7 @@ You should be presented with something similar to this:
             Bus 001 Device 011: ID 05c6:6765 Qualcomm, Inc.
             Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
             
-The important thing to note here is the Vendor ID and Product ID for the device. In the case of the above, the device is a Tesco Hudl (showing as an Archos device) with the combinded ID of 0e79:5009 - 0e79 is the Vendor ID while 5009 is the Product ID. Open the 51-android.rules file and add the following line:
+The important thing to note here is the Vendor ID and Product ID for the device. In the case of the above, the device is a Tesco Hudl (showing as an Archos device) with the combined ID of 0e79:5009 - 0e79 is the Vendor ID while 5009 is the Product ID. Open the 51-android.rules file and add the following line:
 
             SUBSYSTEM=="usb", ATTR{idVendor}=="0e79", ATTR{idProduct}=="5009", MODE="0666", OWNER="hive"
 
@@ -115,4 +143,4 @@ Change the Vendor and Product IDs where appropriate, also check that the owner m
 
 *DeviceAPI-Android* is available to everyone under the terms of the MIT open source licence. Take a look at the LICENSE file in the code.
 
-Copyright (c) 2015 BBC
+Copyright (c) 2016 BBC

data/lib/device_api/android/adb.rb

@@ -233,6 +233,30 @@ module DeviceAPI
         shell(serial, cmd)
       end
 
+      def self.connect(ipaddress, port = 5555)
+        ipaddressandport = "#{ipaddress}:#{port}"
+        check_ip_address(ipaddressandport)
+        cmd = "adb connect #{ipaddressandport}"
+        result = execute(cmd)
+        if result.stdout.to_s =~ /.*already connected to.*/
+          raise DeviceAlreadyConnectedError.new("Device #{ipaddressandport} already connected")
+        else 
+          unless result.stdout.to_s =~ /.*connected to.*/
+            raise ADBCommandError.new("Unable to adb connect to #{ipaddressandport} result was: #{result.stdout}")
+          end
+        end 
+      end
+
+      def self.disconnect(ipaddress, port = 5555)
+        ipaddressandport = "#{ipaddress}:#{port}"
+        check_ip_address(ipaddressandport)
+        cmd = "adb disconnect #{ipaddressandport}"
+        result = execute(cmd)
+        unless result.exit == 0
+          raise ADBCommandError.new("Unable to adb disconnect to #{ipaddressandport} result was: #{result.stdout}")
+        end
+      end
+
       # Returns wifi status and access point name
       # @param serial serial number of device
       # @example
@@ -254,8 +278,7 @@ module DeviceAPI
       # @param [String] serial serial number of device
       # @param [String] command command to execute
       def self.shell(serial, command)
-        result = execute("adb -s #{serial} shell #{command}")
-
+        result = execute("adb -s '#{serial}' shell #{command}")
         case result.stderr
         when /^error: device unauthorized./
           raise DeviceAPI::UnauthorizedDevice, result.stderr
@@ -275,8 +298,8 @@ module DeviceAPI
       # @option coords [String] :x_to (0) Coordinate to end on on the X axis
       # @option coords [String] :y_from (0) Coordinate to start from on the Y axis
       # @option coords [String] :y_to (0) Coordinate to end on on the Y axis
-      def self.swipe(serial, coords = {x_from: 0, x_to: 0, y_from: 0, y_to: 0 })
-        shell(serial, "input swipe #{coords[:x_from]} #{coords[:x_to]} #{coords[:y_from]} #{coords[:y_to]}").stdout
+      def self.swipe(serial, coords = {x_from: 0, y_from: 0, x_to: 0, y_to: 0 })
+        shell(serial, "input swipe #{coords[:x_from]} #{coords[:y_from]} #{coords[:x_to]} #{coords[:y_to]}").stdout
       end
 
       # Starts intent using adb 
@@ -315,7 +338,11 @@ module DeviceAPI
         result.include?('true')
       end
 
-
+      def self.check_ip_address(ipaddressandport)
+        unless ipaddressandport =~ /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3}):[0-9]+\Z/ 
+             raise ADBCommandError.new("Invalid IP address and port #{ipaddressandport}")
+        end
+      end
     end
 
     # ADB Error class
@@ -324,6 +351,11 @@ module DeviceAPI
         super(msg)
       end
     end
+    class DeviceAlreadyConnectedError < ADBCommandError
+      def initialize(msg)
+        super(msg)
+      end
+    end
 
   end
 end

data/lib/device_api/android/device/kindle.rb

@@ -7,7 +7,11 @@ module DeviceAPI
       # work due to Amazons implementation of the Keyguard.
       def unlock
         ADB.keyevent(serial, '26') unless screen_on?
-        ADB.swipe(serial, { x_from: 900, x_to: 300, y_from: 100, y_to: 100 } )
+        if orientation == :landscape
+          ADB.swipe(serial, { x_from: 500, y_from: 575, x_to: 500, y_to: 250 } )
+        else
+          ADB.swipe(serial, { x_from: 300, y_from: 900, x_to: 300, y_to: 600 } )
+        end
       end
     end
   end

data/lib/device_api/android/device.rb

@@ -27,6 +27,11 @@ module DeviceAPI
       def initialize(options = {})
         @serial = options[:serial]
         @state = options[:state]
+        @remote = options[:remote] ? true : false
+      end
+
+      def is_remote?
+        @remote || false
       end
 
       # Mapping of device status - used to provide a consistent status across platforms
@@ -41,6 +46,13 @@ module DeviceAPI
         }[@state]
       end
 
+      def disconnect
+        unless is_remote?
+          raise DeviceAPI::Android::DeviceDisconnectedWhenNotARemoteDevice.new("Asked to disconnect device #{serial} when it is not a remote device")
+        end
+        ADB.disconnect(serial)
+      end
+
       # Return the device range
       # @return (String) device range string
       def range
@@ -278,7 +290,7 @@ module DeviceAPI
           wifi[:mac] unless wifi.nil?
         end
       end
-      
+
       private
 
       def get_network_info
@@ -323,7 +335,6 @@ module DeviceAPI
         ADB.getpowerinfo(serial)
       end
 
-
       def get_phoneinfo
         ADB.getphoneinfo(serial)
       end
@@ -340,5 +351,12 @@ module DeviceAPI
         ADB.get_device_dpi(serial)
       end
     end
+
+    class DeviceDisconnectedWhenNotARemoteDevice < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+
   end
 end

data/lib/device_api/android.rb

@@ -19,7 +19,9 @@ module DeviceAPI
     def self.devices
       ADB.devices.map do |d|
         if d.keys.first && !d.keys.first.include?('?')
-          DeviceAPI::Android::Device.create( self.get_device_type(d), { serial: d.keys.first, state: d.values.first } )
+          serial = d.keys.first
+          remote = check_if_remote_device?(serial)
+          DeviceAPI::Android::Device.create( self.get_device_type(d), { serial: serial, state: d.values.first, remote: remote} )
         end
       end.compact
     end
@@ -30,18 +32,38 @@ module DeviceAPI
         raise DeviceAPI::BadSerialString.new("serial was '#{serial.nil? ? 'nil' : serial}'")
       end
       state = ADB.get_state(serial)
-      DeviceAPI::Android::Device.create( self.get_device_type({ :"#{serial}" => state}),  { serial: serial, state: state })
+      remote = check_if_remote_device?(serial)
+      DeviceAPI::Android::Device.create( self.get_device_type({ :"#{serial}" => state}),  { serial: serial, state: state, remote: remote })
+    end
+
+    def self.connect(ipaddress,port=5555)
+      ADB.connect(ipaddress,port)
+    end
+
+    def self.disconnect(ipaddress,port=5555)
+      ADB.disconnect(ipaddress,port)
+    end
+
+    def self.check_if_remote_device?(serial)
+      begin
+        ADB::check_ip_address(serial)
+        true
+      rescue ADBCommandError
+        false 
+      end 
     end
 
     # Return the device type used in determining which Device Object to create
     def self.get_device_type(options)
       return :default if options.values.first == 'unauthorized'
+      serial = options.keys.first
+      state = ADB.get_state(serial)
       begin
-        man = Device.new(serial: options.keys.first, state: options.values.first).manufacturer
+        man = Device.new(serial: serial, state: state).manufacturer
       rescue DeviceAPI::DeviceNotFound
         return :default
       rescue => e
-        puts "Unrecognised exception whilst finding device '#{options.keys.first}' (state: #{options.values.first})"
+        puts "Unrecognised exception whilst finding device '#{serial}' (state: #{options.values.first})"
         puts e.message
         puts e.backtrace.inspect
         return :default
@@ -57,9 +79,9 @@ module DeviceAPI
       end
       type
     end
-  end
 
   # Serial error class
-  class BadSerialString < StandardError
+    class BadSerialString < StandardError
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: device_api-android
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - David Buckhurst
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: device_api
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Android Device Management API