device_api-ios 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e0d6fee430df723821822f044a27761bec4932d
-  data.tar.gz: a38729c9ef0cc3a0266ee14892ee0d83b942f284
+  metadata.gz: 44a319cbde8d0c83a2c6ce73f50a9f659381363e
+  data.tar.gz: 5a5251780401174266d85ce74f4c547f8736633b
 SHA512:
-  metadata.gz: 610556e7181893924af71a2764d2e18e668c82f60514b1950308fa373e1fc4342d45f53e2e754a1fe36ef9738623cbb97cfa5370c8000361eea945922397ff92
-  data.tar.gz: 8a8a987c173cf19d285d20307be932add6046ede1bedf419c8224ed53e4bca6a7914e9f9aee47ca31872667caf1f85af3f305086258918fe6a2c862843bb731e
+  metadata.gz: 62bd6649f4d4beceb65bbbae499a0daec718543557380eaefb6d6717c62369af546d50806961c720ee30ed8f22d20c8587777773ca842c2c3afe5f2e8110158b
+  data.tar.gz: 0654d20a10cc4b7d461c3d31253f50fa2ea090d9d3af46be195e62ef6cf9c2a7fbc0f7b4e1b1b637e2fab4985f0feb2276b165a502f0855f8c1cc5566bdc5a70

data/Gemfile

@@ -1,12 +1,10 @@
 source 'https://rubygems.org'
-source 'https://gems.cloud.bbc.co.uk'
 
 gem 'device_api', '>=1.0.0'
 gem 'ios-devices'
+gem 'ox'
 
 group :test do
   gem 'rspec'
-  gem 'yaml'
-  gem 'open3'
-  gem 'ostruct'
+  gem 'pry'
 end

data/Gemfile.lock

@@ -1,33 +1,37 @@
 GEM
   remote: https://rubygems.org/
-  remote: https://gems.cloud.bbc.co.uk/
   specs:
-    columnize (0.8.9)
-    debugger (1.6.8)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.3.5)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.3.5)
-    device_api (1.0.0)
+    coderay (1.1.0)
+    device_api (1.0.1)
     diff-lcs (1.2.5)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.4)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.1)
+    ios-devices (0.2.1)
+    method_source (0.8.2)
+    ox (2.2.1)
+    pry (0.10.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.1)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    slop (3.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  debugger
   device_api (>= 1.0.0)
+  ios-devices
+  ox
+  pry
   rspec

data/device_api-ios.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'device_api-ios'
-  s.version     = '1.0.1'
+  s.version     = '1.0.3'
   s.date        = Time.now.strftime("%Y-%m-%d")
   s.summary     = 'IOS Device Management API'
   s.description = 'iOS implementation of DeviceAPI'
@@ -10,5 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bbc/device_api-ios'
   s.license     = 'MIT'
   s.add_runtime_dependency 'device_api', '>=1.0', '<2.0'
+  s.add_runtime_dependency 'ios-devices', '>=0.2'
+  s.add_runtime_dependency 'ox', '>=2.1.0'
   s.add_development_dependency 'rspec'
 end

data/lib/device_api/ios.rb

@@ -1,6 +1,13 @@
 require 'yaml'
 require 'device_api/ios/device'
 require 'device_api/ios/idevice'
+require 'device_api/ios/ideviceinstaller'
+require 'device_api/ios/signing'
+require 'device_api/ios/plistutil'
+require 'device_api/ios/idevicedebug'
+require 'device_api/ios/ipaddress'
+require 'device_api/ios/ideviceprovision'
+require 'device_api/ios/idevicename'
 
 module DeviceAPI
   module IOS
@@ -19,7 +26,7 @@ module DeviceAPI
       if serial.to_s.empty?
         raise DeviceAPI::BadSerialString.new("Serial was '#{ serial.nil? ? 'nil' : serial }'")
       end
-      DeviceAPI::IOS::Device.new(serial: serial, state: 'ok')
+      DeviceAPI::IOS::Device.new(serial: serial, state: 'device')
     end
   end
 end

data/lib/device_api/ios/device.rb

@@ -1,6 +1,8 @@
 require 'device_api/device'
 require 'device_api/ios/device'
 require 'device_api/ios/idevice'
+require 'device_api/ios/plistutil'
+require 'device_api/ios/idevicename'
 require 'ios/devices'
 
 # DeviceAPI - an interface to allow for automation of devices
@@ -24,6 +26,12 @@ module DeviceAPI
         }[@state]
       end
 
+      # Look up device name - i.e. Bob's iPhone
+      # @return (String) iOS device name
+      def name
+        IDeviceName.name(serial)
+      end
+
       # Look up device model using the ios-devices gem - changing 'iPad4,7' to 'iPad mini 3'
       # @return (String) human readable model and version (where applicable)
       def model
@@ -54,6 +62,64 @@ module DeviceAPI
         IDevice.trusted?(serial)
       end
 
+      # Get the app bundle ID from the specified app
+      # @return [String] app bundle id
+      def package_name(app)
+        app_info = Plistutil.get_bundle_id_from_app(app)
+        app_info['CFBundleIdentifier']
+      end
+
+      # Get the app version from the specified app
+      # @return [String] app version
+      def app_version_number(app)
+        app_info = Plistutil.get_bundle_id_from_app(app)
+        app_info['CFBundleVersion']
+      end
+
+      # Get the IP Address from the device
+      # @return [String] IP Address of current device
+      def ip_address
+        IPAddress.address(serial)
+      end
+
+      # Get the Wifi Mac address for the current device
+      # @return [String] Mac address of current device
+      def wifi_mac_address
+        get_prop('WiFiAddress')
+      end
+
+      # Install a specified IPA
+      # @param [String] ipa string containing path to the IPA to install
+      # @return [Boolean, Exception] true when the IPA installed successfully, otherwise an error is raised
+      def install(ipa)
+        fail StandardError, 'No IPA or app specified.', caller if ipa.empty?
+
+        res = install_ipa(ipa)
+
+        fail StandardError, res, caller unless res
+        true
+      end
+
+      # Uninstall a specified package
+      # @param [String] package_name string containing name of package to uninstall
+      # @return [Boolean, Exception] true when the package is uninstalled successfully, otherwise an error is raised
+      def uninstall(package_name)
+        res = uninstall_package(package_name)
+
+        fail StandardError, res, caller unless res
+        true
+      end
+
+      # Return whether or not the device is a tablet or mobile
+      # @return [Symbol] :tablet or :mobile depending on device_class
+      def type
+        if device_class.downcase == 'ipad'
+          :tablet
+        else
+          :mobile
+        end
+      end
+
       private
 
       def get_prop(key)
@@ -63,6 +129,13 @@ module DeviceAPI
         @props[key]
       end
 
+      def install_ipa(ipa)
+        IDeviceInstaller.install_ipa(ipa: ipa, serial: serial)
+      end
+
+      def uninstall_package(package_name)
+        IDeviceInstaller.uninstall_package(package: package_name, serial: serial)
+      end
     end
   end
 end

data/lib/device_api/ios/idevice.rb

@@ -30,7 +30,8 @@ module DeviceAPI
       # @return true if the device returns information to ideviceinfo, otherwise false
       def self.trusted?(device_id)
         result = execute("ideviceinfo -u '#{device_id}'")
-        return true if result.exit == 0
+
+        return true if result.exit == 0 && !result.stdout.split("\n")[0].match('Usage')
         false
       end
 

data/lib/device_api/ios/idevicedebug.rb

@@ -0,0 +1,36 @@
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for all methods encapsulating idevice calls
+    class IDeviceDebug < Execution
+
+      # idevicedebug doesn't return until the app you are attempting to run
+      # exits. By passing in a timeout value we can limit how long we wait
+      # before terminating the debug session
+      # @param [Hash] options options for debug running
+      # @option options [String] :serial serial of the device run
+      # @option options [String] :bundle_id ID of the app to run
+      # @option options [Integer] :timeout Number of seconds before the debug session should be killed
+      # @return [Hash] Returns the stdout of the debug session
+      def self.run(options = {})
+        serial = options[:serial]
+        bundle_id = options[:bundle_id]
+        timeout = options[:timeout] || 10
+
+        result = execute("doalarm () { perl -e 'alarm shift; exec @ARGV' \"$@\"; }; doalarm #{timeout} idevicedebug -u #{serial} -d run #{bundle_id}")
+
+        raise IDeviceDebugError.new(result.stderr) unless [0, 255, 142].include?(result.exit)
+
+        result.stdout.split("\r\n")
+      end
+    end
+
+    # Error class for the IDeviceDebug class
+    class IDeviceDebugError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/device_api/ios/ideviceinstaller.rb

@@ -0,0 +1,96 @@
+require 'device_api/execution'
+
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for all methods encapsulating idevice calls
+    class IDeviceInstaller < Execution
+      # Installs a given IPA to the specified device
+      # @param [Hash] options options for installing the app
+      # @option options [String] :ipa path to the IPA to install
+      # @option options [String] :serial serial of the target device
+      # @return [Boolean] true if successful, otherwise false
+      def self.install_ipa(options = {})
+        options[:action] = :install
+        change_package(options)
+      end
+
+      # Uninstalls a specified package from a device
+      # @param [Hash] options options for uninstalling the app
+      # @option options [String] :package bundle ID of the package to be uninstalled
+      # @option options [String] :serial serial of the target device
+      # @return [Boolean] true if successful, otherwise false
+      def self.uninstall_package(options = {})
+        options[:action] = :uninstall
+        change_package(options)
+      end
+
+      def self.change_package(options = {})
+        package = options[:package]
+        ipa = options[:ipa]
+        serial = options[:serial]
+        action = options[:action]
+
+        command = nil
+        if action == :install
+          command = "ideviceinstaller -u '#{serial}' -i '#{ipa}'"
+        elsif action == :uninstall
+          command = "ideviceinstaller -u '#{serial}' -U '#{package}'"
+        end
+
+        raise IDeviceInstallerError.new('No action specified') if command.nil?
+
+        result = execute(command)
+
+        raise IDeviceInstallerError.new(result.stderr) if result.exit != 0
+
+        lines = result.stdout.split("\n").map { |line| line.gsub('-', '').strip }
+
+        return true if lines.last.match('Complete')
+        false
+      end
+
+      # Lists packages installed on the specified device
+      # @param [String] serial serial of the target device
+      # @return [Hash] hash containing installed packages
+      def self.list_installed_packages(serial)
+        result = execute("ideviceinstaller -u '#{serial}' -l")
+
+        raise IDeviceInstallerError.new(result.stderr) if result.exit != 0
+
+        lines = result.stdout.split("\n")
+        lines.shift
+        packages = {}
+        lines.each do |line|
+          if /(.*)\s+-\s+(.*)\s+(\d.*)/.match(line)
+            packages[Regexp.last_match[2]] = { package_name: Regexp.last_match[1], version: Regexp.last_match[3] }
+          end
+        end
+        packages
+      end
+
+      # Check to see if a package is installed
+      # @param [Hash] options options for checking for installed package
+      # @option options [String] :package package ID to check for
+      # @option options [String] :serial serial of the target device
+      # @return [Boolean] true if the package is installed, false otherwise
+      def self.package_installed?(options = {})
+        package = options[:package]
+        serial  = options[:serial]
+
+        installed_packages = list_installed_packages(serial)
+
+        matches = installed_packages.select { |_, values| values[:package_name] == package }
+        return !matches.empty?
+      end
+    end
+
+    # Error class for IDeviceInstaller class
+    class IDeviceInstallerError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/device_api/ios/idevicename.rb

@@ -0,0 +1,25 @@
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for all methods encapsulating idevicename calls
+    class IDeviceName < Execution
+
+      # Returns the device name based on the provided UUID
+      # @param device_id uuid of the device
+      # @return device name if device is connected
+      def self.name(device_id)
+        result = execute("idevicename -u #{device_id}")
+        return IDeviceNameError.new(result.stderr) if result.exit != 0
+        result.stdout.strip
+      end
+    end
+
+    # Error class for the IDeviceName class
+    class IDeviceNameError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/device_api/ios/ideviceprovision.rb

@@ -0,0 +1,98 @@
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for all methods encapsulating ideviceprovision calls
+    class IDeviceProvision < Execution
+      # Lists all profiles on the specified device
+      # @param [String] serial serial of the device to check
+      # @return [Hash] hash of profile name and UUID
+      def self.list_profiles(serial)
+        result = execute("ideviceprovision -u #{serial} list")
+
+        raise IDeviceProvisionError.new(result.stderr) if result.exit != 0
+
+        Hash[result.stdout.split("\n").map { |a| b = a.split(' - '); [b[0], b[1]] }[1..-1]]
+      end
+
+      # Checks to see if a profile is installed on the specified device
+      # @param [Hash] options options used for checking profiles
+      # @option options [String] :name name of the profile (optional when uuid provided)
+      # @option options [String] :uuid UUID of the profile (optional when name provided)
+      # @option options [String] :serial serial of the device to check
+      # @return [Boolean] true if the profile is installed, false otherwise
+      def self.has_profile?(options = {})
+        name = options[:name]
+        uuid = options[:uuid]
+        serial = options[:serial]
+
+        profiles = list_profiles(serial)
+
+        profiles.key?(uuid) || profiles.value?(name)
+      end
+
+      # Removes the specified profile from the device
+      # @param [Hash] options options used for removing a profile
+      # @option options [String] :uuid UUID of the profile to be removed
+      # @option options [String] :serial serial of the device to remove the profile from
+      # @return [Boolean, IDeviceProvisionError] true if the profile is removed from the device, an error otherwise
+      def self.remove_profile(options = {})
+        uuid = options[:uuid]
+        serial = options[:serial]
+
+        return true unless has_profile?(serial: serial, uuid: uuid)
+
+        result = execute("ideviceprovision -u #{serial} remove #{uuid}")
+
+        raise IDeviceProvisionError.new(result.stderr) if result.exit != 0
+        true
+      end
+
+      # Installs the specified profile to the device
+      # @param [Hash] options options used for installing a profile
+      # @option options [String] :file path to the provisioning profile
+      # @option options [String] :serial serial of the device to install the profile to
+      # @return [Boolean, IDeviceProvisionError] true if the profile is installed, an error otherwise
+      def self.install_profile(options = {})
+        serial = options[:serial]
+        file = options[:file]
+
+        info = get_profile_info(file)
+
+        # Check to see if the profile has already been added to the device
+        return true if has_profile?(serial: serial, uuid: info['UUID'])
+
+        result = execute("ideviceprovision -u #{serial} install #{file}")
+
+        raise IDeviceProvisionError.new(result.stderr) if result.exit != 0
+        true
+      end
+
+      # Gets information about a provisioning profile
+      # @param [String] file path to the provisioning profile
+      # @return [Hash] hash containing provisioning profile information
+      def self.get_profile_info(file)
+        result = execute("ideviceprovision dump #{file}")
+
+        raise IDeviceProvisionError.new(result.stderr) if result.exit != 0
+
+        lines = result.stdout.split("\n")
+
+        info = {}
+        lines.each do |l|
+          if /(.*):\s+(.*)/.match(l)
+            info[Regexp.last_match[1]] = Regexp.last_match[2]
+          end
+        end
+        info
+      end
+    end
+
+    # Provisioning error class
+    class IDeviceProvisionError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/device_api/ios/ipaddress.rb

@@ -0,0 +1,51 @@
+require 'device_api/ios/idevicedebug'
+require 'device_api/ios/ideviceinstaller'
+
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for all methods encapsulating idevice calls
+    class IPAddress < Execution
+
+      # Package name for the IP Address app
+      def self.ipaddress_bundle_id
+        'uk.co.bbc.titan.IPAddress'
+      end
+
+      # Check to see if the IPAddress app is installed
+      # @param [String] serial serial of the target device
+      # @return [Boolean] returns true if the app is installed
+      def self.installed?(serial)
+        if DeviceAPI::IOS::IDeviceInstaller.package_installed?( serial: serial, package: ipaddress_bundle_id )
+          return true
+        else
+          raise IPAddressError.new('IP Address package not installed: Please see https://github.com/bbc/ios-test-helper')
+        end
+      end
+
+      # Get the IP Address from the installed app
+      # @param [String] serial serial of the target device
+      # @return [String] IP Address if found
+      def self.address(serial)
+        installed?(serial)
+        result = IDeviceDebug.run(serial: serial, bundle_id: ipaddress_bundle_id )
+
+        ip_address = nil
+        result.each do |line|
+          if /"en0\/ipv4" = "(.*)"/.match(line)
+            ip_address = Regexp.last_match[1]
+          end
+        end
+        ip_address
+      end
+    end
+
+    # Error class for the IPAddress class
+    class IPAddressError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/device_api/ios/plistutil.rb

@@ -0,0 +1,58 @@
+require 'device_api/execution'
+require 'device_api/ios/signing'
+require 'ox'
+
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for all methods encapsulating plistutil calls
+    class Plistutil < Execution
+
+      # Check to ensure that plistutil is available
+      # @return [Boolean] true if plistutil is available, false otherwise
+      def self.plistutil_available?
+        result = execute('which plistutil')
+        result.exit == 0
+      end
+
+      # Gets properties from the IPA and returns them in a hash
+      # @param [String] path path to the IPA/App
+      # @return [Hash] list of properties from the app
+      def self.get_bundle_id_from_app(path)
+        path = Signing.unpack_ipa(path) if Signing.is_ipa?(path)
+        get_bundle_id_from_plist("#{path}/Info.plist")
+      end
+
+      # Gets properties from the IPA and returns them in a hash
+      # @param [String] plist path to the plist
+      # @return [Hash] list of properties from the app
+      def self.get_bundle_id_from_plist(plist)
+        raise PlistutilCommandError.new('plistutil not found') unless plistutil_available?
+        result = execute("plistutil -i #{plist}")
+        raise PlistutilCommandError.new(result.stderr) if result.exit != 0
+        info = Ox.parse(result.stdout)
+        nodes = info.locate('*/dict')
+        values = {}
+        last_key = nil
+        nodes.each do |node|
+          node.nodes.each do |child|
+            if child.value == 'key'
+              last_key = child.nodes.first
+            elsif child.value == 'string'
+              values[last_key] = child.nodes.first
+            end
+          end
+        end
+        values
+      end
+    end
+
+    # plistutil error class
+    class PlistutilCommandError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/device_api/ios/signing.rb

@@ -0,0 +1,86 @@
+require 'device_api/execution'
+
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for all methods encapsulating idevice calls
+    class Signing < Execution
+
+      # Check to see if the path is an IPA
+      def self.is_ipa?(path)
+        return true if (File.extname path).downcase == '.ipa'
+        false
+      end
+
+      def self.unpack_ipa(path)
+        folder = File.dirname(path)
+        target = (File.basename path, (File.extname path))
+
+        # Check to see if the target has already been unzipped
+        return Dir["#{folder}/#{target}/Payload/*.app"].first if File.exists? ("#{folder}/#{target}/Payload/")
+
+        result = execute("unzip '#{path}' -d '#{folder}/#{target}'")
+        raise SigningCommandError.new(result.stderr) if result.exit != 0
+
+        Dir["#{folder}/#{target}/Payload/*.app"].first
+      end
+
+      def self.is_app_signed?(app_path)
+        app_path = unpack_ipa(app_path) if is_ipa?(app_path)
+        result = execute("codesign -d -vvvv '#{app_path}'")
+
+        if result.exit != 0
+          return false if /is not signed/.match(result.stderr)
+          raise SigningCommandError.new(result.stderr)
+        end
+
+        true
+      end
+
+      def self.sign_app(options = {})
+        cert          = options[:cert]
+        entitlements  = options[:entitlements]
+        app           = options[:app]
+
+        result = execute("codesign --force --sign #{cert} --entitlements #{entitlements} '#{app}'")
+
+        raise SigningCommandError.new(result.stderr) if result.exit != 0
+
+      end
+
+      def self.get_signing_certs
+        result = execute('security find-identity -p codesigning -v')
+
+        raise SigningCommandError.new(result.stderr) if result.exit != 0
+
+        certs = []
+        result.stdout.split("\n").each do |line|
+          if /\)\s*(\S*)\s*"(.*)"/.match(line)
+            certs << { id: Regexp.last_match[1], name: Regexp.last_match[2] }
+          end
+        end
+        certs
+      end
+
+      def self.get_entitlements(app_path)
+        app_path = unpack_ipa(app_path) if is_ipa?(app_path)
+        result = execute("codesign -d --entitlements - #{app_path}")
+
+        require 'pry'
+        binding.pry
+        if result.exit != 0
+          raise SigningCommandError.new(result.stderr)
+        end
+        return result.stdout
+      end
+    end
+
+    # Signing error class
+    class SigningCommandError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/spec/ios_device_spec.rb

@@ -1,104 +1,51 @@
-$LOAD_PATH.unshift( './lib/' )
-
 require 'device_api/execution'
 require 'device_api/ios/idevice'
 require 'device_api/ios/device'
-require 'yaml'
+require 'device_api/ios'
 
 include RSpec
 
-ProcessStatusStub = Struct.new(:exitstatus)
-$STATUS_ZERO = ProcessStatusStub.new(0)
-
 describe DeviceAPI::IOS do
 
-  before(:all) do
-   
-    config_file = '../../config.yml'
-    CONFIG = YAML.load_file(File.expand_path(config_file, __FILE__))
-    @bundle_id = CONFIG["bundle_id"]
-    @app_path = File.expand_path(CONFIG["app_path"])
-    @arr_devices = DeviceAPI::IOS::IDevice.get_list_of_devices
-    keys = @arr_devices[0].keys
-    @test_device_uuid = keys[0]
-    @app_name = CONFIG["app_name"]
-
-  end
-
   describe ".model" do
 
-    before(:each) do
-      @ios_device = DeviceAPI::IOS::Device.new(:serial=>@test_device_uuid,:state => "ok",:type => "Device")
+    it 'returns the model of the attached device' do
+      device = DeviceAPI::IOS.device('123456')
+      expect(device.model).to eq('Unknown iOS device')
     end
 
-    it "returns model of device" do
-        props = DeviceAPI::IOS::IDevice.get_props(@test_device_uuid)
-        expect(props['ModelNumber']).to eq(@ios_device.model)
+    it 'returns the correct result when a device is trusted' do
+      device = DeviceAPI::IOS.device('123456')
+      output = <<end
+ActivationState: Activated
+ActivationStateAcknowledged: true
+end
+      allow(Open3).to receive(:capture3) {
+        [output, '', (Struct.new(:exitstatus)).new(0)]
+      }
+      expect(device.trusted?).to eq(true)
     end
 
-             
-  end
- 
-  
-
-  describe ".install" do
-
-    before(:each) do
-      
-      result = DeviceAPI::Execution.execute("ideviceinstaller -u #{@test_device_uuid} -l")
-      if(result.stdout.include? @bundle_id and result.stderr=="")
-          DeviceAPI::Execution.execute("ideviceinstaller -u '#{@test_device_uuid}' -U #{@bundle_id}")
-       end 
-
-       @ios_device = DeviceAPI::IOS::Device.new(:serial=>@test_device_uuid,:state => "ok",:type => "Device")
-      
+    it 'returns the correct result when a device is not trusted' do
+      device = DeviceAPI::IOS.device('123456')
+      expect(device.trusted?).to eq(false)
     end
 
-    it "returns successfully installed message once ios app is installed on a device" do
-        expect(@ios_device.install(@app_path)).to eq :success
+    it 'returns device state' do
+      device = DeviceAPI::IOS.device('123456')
+      expect(device.status).to eq(:ok)
     end
-    
 
-  end
-
-  describe ".uninstall" do
-
-    before(:each) do
-      @ios_device = DeviceAPI::IOS::Device.new(:serial=>@test_device_uuid,:state => "ok",:type => "Device")
-      app_bundle_list = @ios_device.bundle_id_list
-      app_names = app_bundle_list.keys
-      result = DeviceAPI::Execution.execute("ideviceinstaller -u #{@test_device_uuid} -l")
-
-      if(!app_names.include? @app_name)
-          DeviceAPI::Execution.execute("ideviceinstaller -u '#{@test_device_uuid}' -i #{@app_path}")
-          @local_bundle_id = (@ios_device.bundle_id_list)[@app_name]
-       else
-          @local_bundle_id = app_bundle_list[@app_name]
-       end 
-    end
-    
-   it "Uninstalls the app from ios device" do
-      res = @ios_device.uninstall(@local_bundle_id)
-      expect( res ).to eq :success
-      
+    it 'returns the device name' do
+      output = <<-end
+        Test Device
+      end
+      allow(Open3).to receive(:capture3) {
+        [output, '', (Struct.new(:exitstatus)).new(0)]
+      }
+      device = DeviceAPI::IOS.device('123456')
+      expect(device.name).to eq('Test Device')
     end
-   
-    
   end
-  
-  describe ".get_props" do
-    before(:each) do
-      @ios_device = DeviceAPI::IOS::Device.new(:serial=>@test_device_uuid,:state => "ok",:type => "Device")
-    end
-    
-    it "Returns a hash of name value pair properties" do
-      props = @ios_device.get_props
-      expect( props ).to be_a Hash
-      expect( props['ActivationState']).to eq('Activated')
-    end
-    
-  end
-
-    
 end
 

data/spec/ios_ideviceinstaller_spec.rb

@@ -0,0 +1,97 @@
+require 'device_api/ios/ideviceinstaller'
+
+describe DeviceAPI::IOS::IDeviceInstaller do
+  describe '.list_installed_packages' do
+    it 'returns a list of installed apps' do
+      output = <<end
+Total: 2 apps
+uk.co.bbc.titan.IPAddress - IPAddress 1
+uk.co.bbc.iplayer - BBC iPlayer 4.10.0.196
+end
+      allow(Open3).to receive(:capture3) do
+        [output, '', (Struct.new(:exitstatus)).new(0)]
+      end
+      apps = DeviceAPI::IOS::IDeviceInstaller.list_installed_packages('123456')
+      expect(apps.count).to eq(2)
+    end
+  end
+
+  describe '.install_ipa' do
+    it 'installs an app' do
+      output = <<end
+Installing 'uk.co.mediaat.iplayer'
+ - CreatingStagingDirectory (5%)
+ - ExtractingPackage (15%)
+ - InspectingPackage (20%)
+ - TakingInstallLock (20%)
+ - PreflightingApplication (30%)
+ - InstallingEmbeddedProfile (30%)
+ - VerifyingApplication (40%)
+ - CreatingContainer (50%)
+ - InstallingApplication (60%)
+ - PostflightingApplication (70%)
+ - SandboxingApplication (80%)
+ - GeneratingApplicationMap (90%)
+ - Complete
+end
+      allow(Open3).to receive(:capture3) do
+        [output, '', (Struct.new(:exitstatus)).new(0)]
+      end
+      result = DeviceAPI::IOS::IDeviceInstaller.install_ipa(serial: '123456', ipa: 'iplayer.ipa' )
+      expect(result).to eq(true)
+    end
+  end
+
+  describe '.uninstall_app' do
+    it 'uninstalls an app' do
+      output = <<end
+Uninstalling 'uk.co.bbc.iplayer'
+ - RemovingApplication (50%)
+ - GeneratingApplicationMap (90%)
+ - Complete
+end
+      allow(Open3).to receive(:capture3) do
+        [output, '', (Struct.new(:exitstatus)).new(0)]
+      end
+      result = DeviceAPI::IOS::IDeviceInstaller.uninstall_package(package: 'uk.co.bbc.iplayer', serial: '123456')
+      expect(result).to eq(true)
+    end
+
+    it 'fails to remove an app that is not installed' do
+      output = <<end
+Uninstalling 'uk.co.bbc.iplaye'
+ - RemovingApplication (50%)
+ - GeneratingApplicationMap (90%)
+ - Error occurred: APIInternalError
+end
+      allow(Open3).to receive(:capture3) do
+        [output, '', (Struct.new(:exitstatus)).new(0)]
+      end
+      result = DeviceAPI::IOS::IDeviceInstaller.uninstall_package(package: 'uk.co.bbc.iplaye', serial: '123456')
+      expect(result).to eq(false)
+    end
+  end
+
+  describe '.package_installed?' do
+    before(:each) do
+      output = <<end
+Total: 2 apps
+uk.co.bbc.titan.IPAddress - IPAddress 1
+uk.co.bbc.iplayer - BBC iPlayer 4.10.0.196
+end
+      allow(Open3).to receive(:capture3) do
+        [output, '', (Struct.new(:exitstatus)).new(0)]
+      end
+    end
+
+    it 'identifies when a package is installed' do
+      result = DeviceAPI::IOS::IDeviceInstaller.package_installed?(package: 'uk.co.bbc.iplayer', serial: '123456')
+      expect(result).to eq(true)
+    end
+
+    it 'identifies when a package is not installed' do
+      result = DeviceAPI::IOS::IDeviceInstaller.package_installed?(package: 'uk.co.bbc.sport', serial: '123456')
+      expect(result).to eq(false)
+    end
+  end
+end

data/spec/ios_ipaddress_spec.rb

@@ -0,0 +1,35 @@
+require 'device_api/execution'
+require 'device_api/ios/ipaddress'
+
+describe DeviceAPI::IOS::IPAddress do
+
+  describe '.address' do
+    it 'gets the correct IP Address' do
+
+      apps = <<end
+Total: 2 apps\r
+uk.co.bbc.titan.IPAddress - IPAddress 1\r
+uk.co.bbc.iplayer - BBC iPlayer 4.10.0.196\r
+end
+
+      output = <<end
+  2015-07-06 09:27:33.670 IPAddress[801:299377] addresses: {
+      "awdl0/ipv6" = "fe80::dce9:ge0f:fee7:aaad";
+  "en0/ipv4" = "10.10.1.80";
+  "en0/ipv6" = "fe80::147c:1496:fce9:ed2";
+  "lo0/ipv4" = "127.0.0.1";
+  "lo0/ipv6" = "fe80::1";
+  "pdp_ip0/ipv4" = "10.7.195.3";
+  }
+  2015-07-06 09:27:33.672 IPAddress[801:299377] 10.10.1.80
+end
+      allow(Open3).to receive(:capture3).and_return(
+                [apps, '', (Struct.new(:exitstatus)).new(0)],
+                [output, '', (Struct.new(:exitstatus)).new(0)]
+      )
+
+      ip_address = DeviceAPI::IOS::IPAddress.address('123456')
+      expect(ip_address).to eq('10.10.1.80')
+    end
+  end
+end

data/spec/ios_plistutil_spec.rb

@@ -0,0 +1,25 @@
+require 'device_api/ios/plistutil'
+
+describe DeviceAPI::IOS::Plistutil do
+  describe ".get_app_bundle_id" do
+    it "returns the correct app bundle" do
+
+      xml = <<end
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>CFBundleIdentifier</key>
+    <string>com.example.apple-samplecode.UICatalog</string>
+  </dict>
+</plist>
+end
+
+      allow(Open3).to receive(:capture3) {
+        [xml, '', (Struct.new(:exitstatus)).new(0)]
+      }
+      bundle = DeviceAPI::IOS::Plistutil.get_bundle_id_from_plist('Info.plist')
+      expect(bundle['CFBundleIdentifier']).to eq('com.example.apple-samplecode.UICatalog')
+    end
+  end
+end

data/spec/ios_signing_spec.rb

@@ -0,0 +1,62 @@
+$LOAD_PATH.unshift( './lib/' )
+
+require 'device_api/execution'
+require 'device_api/ios/signing'
+require 'yaml'
+
+include RSpec
+
+describe DeviceAPI::IOS::Signing do
+
+  before(:all) do
+
+  end
+
+  describe ".is_ipa?" do
+    it "correctly identifies an IPA" do
+      expect(DeviceAPI::IOS::Signing.is_ipa?('/path/to/ipa.ipa')).to be(true)
+    end
+
+    it "correctly identifies a file that isn't an IPA" do
+      expect(DeviceAPI::IOS::Signing.is_ipa?('/path/to/app.app')).to be(false)
+    end
+  end
+
+  describe ".get_signing_certs" do
+    it "returns an Array of Hashes containing iOS Signing Certificates" do
+      expect(DeviceAPI::IOS::Signing.get_signing_certs).to be_kind_of(Array)
+    end
+
+    it "returns an Array of Hashes containing correct certificates" do
+      out = <<-eos
+        1) 43ED4FA24518B1F72EE4FB3E6F7476E886A8E5D0 "iPhone Developer: Test Developer (ABC1234567)"
+        2) 289765876A0FB55327F8F3C2A3D4FA3F1A484CFB "iPhone Developer: Test Developer (ABC1234526)"
+        3) 132128763516473546816751267AFA217036217B "iPhone Developer: Test Developer (ABC1235343)"
+        3 valid identities found
+      eos
+      allow(Open3).to receive(:capture3) {
+        [out, '', (Struct.new(:exitstatus)).new(0)]
+      }
+
+      expect(DeviceAPI::IOS::Signing.get_signing_certs.count).to eq(3)
+    end
+  end
+
+  describe "entitlements" do
+    it 'returns a list of entitlements for an app' do
+      out = <<-eos
+      <dict>
+        <key>application-identifier</key>
+        <string>uk.co.bbc.test</string>
+        <key>get-task-allow</key>
+        <false/>
+      </dict>
+      eos
+      allow(Open3).to receive(:capture3) {
+        [out, '', (Struct.new(:exitstatus)).new(0)]
+      }
+
+      expect(DeviceAPI::IOS::Signing.get_entitlements('test.ipa')).to eq(true)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: device_api-ios
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - BBC
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: device_api
@@ -32,6 +32,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ios-devices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,8 +90,18 @@ files:
 - lib/device_api/ios.rb
 - lib/device_api/ios/device.rb
 - lib/device_api/ios/idevice.rb
+- lib/device_api/ios/idevicedebug.rb
+- lib/device_api/ios/ideviceinstaller.rb
+- lib/device_api/ios/idevicename.rb
+- lib/device_api/ios/ideviceprovision.rb
+- lib/device_api/ios/ipaddress.rb
+- lib/device_api/ios/plistutil.rb
+- lib/device_api/ios/signing.rb
 - spec/ios_device_spec.rb
-- spec/ios_idevice_spec.rb
+- spec/ios_ideviceinstaller_spec.rb
+- spec/ios_ipaddress_spec.rb
+- spec/ios_plistutil_spec.rb
+- spec/ios_signing_spec.rb
 homepage: https://github.com/bbc/device_api-ios
 licenses:
 - MIT
@@ -84,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: IOS Device Management API
 test_files: []
-has_rdoc: 

data/spec/ios_idevice_spec.rb

@@ -1,109 +0,0 @@
-$LOAD_PATH.unshift( './lib/' )
-
-require 'device_api/execution'
-require 'device_api/ios/idevice'
-require 'yaml'
-
-include RSpec
-
-ProcessStatusStub = Struct.new(:exitstatus)
-$STATUS_ZERO = ProcessStatusStub.new(0)
-
-describe DeviceAPI::IOS::IDevice do
-
-  before(:all) do
-   
-    config_file = '../../config.yml'
-    CONFIG = YAML.load_file(File.expand_path(config_file, __FILE__))
-    @bundle_id = CONFIG["bundle_id"]
-    @app_path = File.expand_path(CONFIG["app_path"])
-    @arr_devices = DeviceAPI::IOS::IDevice.get_list_of_devices
-    keys = @arr_devices[0].keys
-    @test_device_uuid = keys[0]
-
-  end
-
-  describe ".get_list_of_devices" do
-
-    before(:each) do
-      @arr_devices = DeviceAPI::IOS::IDevice.get_list_of_devices
-    end
-
-    it "returns an Array of connected ios devices" do
-        expect(@arr_devices.class).to eq(Array)
-    end
-
-    it "returns an Array of Hash of connected ios devices - When atleast one devices is connected" do
-        expect(@arr_devices[0].class).to eq(Hash)
-    end
-          
-  end
-  
-  describe ".get_state" do
- 
-    it "returns state of a device based on the device - When atleast one device is connected" do
-       expect( DeviceAPI::IOS::IDevice.get_state(@test_device_uuid)).to eq("Activated")
-    end
-
-
-  end
-
-  describe ".install_app" do
-
-    before(:each) do
-      
-      result = DeviceAPI::Execution.execute("ideviceinstaller -u #{@test_device_uuid} -l")
-      if(result.stdout.include? @bundle_id and result.stderr=="")
-          DeviceAPI::Execution.execute("ideviceinstaller -u '#{@test_device_uuid}' -U #{@bundle_id}")
-       end 
-      
-    end
-
-    it "returns successfully installed message once ios app is installed on a device" do
-       expect( DeviceAPI::IOS::IDevice.install_app(@test_device_uuid,@app_path)).to eq true
-    end
-    
-
-  end
-
-  describe ".launch_app" do
-
-    before(:each) do
-      
-      result = DeviceAPI::Execution.execute("ideviceinstaller -u #{@test_device_uuid} -l")
-      if(result.stdout.include? @bundle_id and result.stderr=="")
-          DeviceAPI::Execution.execute("ideviceinstaller -u '#{@test_device_uuid}' -U #{@bundle_id}")
-       end 
-      
-    end
-    
-   it "Launches the app on the ios device" do
-      props = DeviceAPI::IOS::IDevice.launch_app(@test_device_uuid,@app_path)
-      expect( props ).to eq true
-      
-    end
-   
-    
-  end
-  
-  describe ".get_props" do
-    
-    it "Returns a hash of name value pair properties" do
-      props = DeviceAPI::IOS::IDevice.get_props(@test_device_uuid)
-      expect( props ).to be_a Hash
-      expect( props['ActivationState']).to eq('Activated')
-    end
-    
-  end
-
-  describe ".bundle_id_list" do
-    
-    it "Returns a hash of name value pair of application name and bundle_id" do
-      list = DeviceAPI::IOS::IDevice.bundle_id_list(@test_device_uuid)
-      expect(list).to be_a Hash
-    end
-    
-  end
-  
-end
-