device_api-ios 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e0d6fee430df723821822f044a27761bec4932d
+  data.tar.gz: a38729c9ef0cc3a0266ee14892ee0d83b942f284
+SHA512:
+  metadata.gz: 610556e7181893924af71a2764d2e18e668c82f60514b1950308fa373e1fc4342d45f53e2e754a1fe36ef9738623cbb97cfa5370c8000361eea945922397ff92
+  data.tar.gz: 8a8a987c173cf19d285d20307be932add6046ede1bedf419c8224ed53e4bca6a7914e9f9aee47ca31872667caf1f85af3f305086258918fe6a2c862843bb731e

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+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)
+    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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  device_api (>= 1.0.0)
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 BBC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# DeviceAPI-IOS
+
+
+*DeviceAPI-IOS* is the iOS implementation of *DeviceAPI* - an initiative to allow full automation of device activities
+
+## Dependencies
+
+*DeviceAPI-IOS* shells out to a number of iOS command line tools. You will need to make sure that the libimobiledevice library is installed and the following commands are available on your path:
+* ideviceinfo
+
+## Using the gem
+
+Add the device_api-ios gem to your gemfile - this will automatically bring in the device_api base gem on which the iOS gem is built.
+
+    gem 'device_api-ios'
+
+You'll need to require the library in your code:
+
+    require 'device_api/ios'
+
+Try connecting an iOS device with USB and run:
+
+    devices = DeviceAPI::IOS.devices
+
+You might need to accept the 'Trust this computer' dialog on your device.
+
+### Detecting devices
+
+There are two methods for detecting devices:
+    DeviceAPI::IOS.devices
+This returns an array of objects representing the connected devices. You will get an empty array if there are no connected devices.
+    DeviceAPI::IOS.device(serial_id)
+This looks for a device with a matching serial_id and returns a single device object.
+
+### Device object
+
+When *DeviceAPI* detects a device, it returns a device object that lets you interact with and query the device with various iOS tools.
+
+For example:
+
+        device = DeviceAPI::IOS.device(serial_id)
+        device.serial # '50d9299992726df277bg6befdf88e1704f4f8f8b'
+        device.model # 'iPad mini 3'
+
+## License
+
+*DeviceAPI-IOS* 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

data/device_api-ios.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'device_api-ios'
+  s.version     = '1.0.1'
+  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.summary     = 'IOS Device Management API'
+  s.description = 'iOS implementation of DeviceAPI'
+  s.authors     = ['BBC', 'Jon Wilson', 'Kedar Barde']
+  s.email       = ['jon.wilson01@bbc.co.uk', 'kedar_barde@mindtree.com']
+  s.files       = `git ls-files`.split "\n"
+  s.homepage    = 'https://github.com/bbc/device_api-ios'
+  s.license     = 'MIT'
+  s.add_runtime_dependency 'device_api', '>=1.0', '<2.0'
+  s.add_development_dependency 'rspec'
+end

data/lib/device_api/ios.rb

@@ -0,0 +1,25 @@
+require 'yaml'
+require 'device_api/ios/device'
+require 'device_api/ios/idevice'
+
+module DeviceAPI
+  module IOS
+
+    # Returns an array of connected iOS devices
+    def self.devices
+      IDevice.devices.map do |d|
+        if d.keys.first
+          DeviceAPI::IOS::Device.new(serial: d.keys.first, display: d.values.flatten.first, state: 'ok')
+        end
+      end
+    end
+
+    # Retrieve a Device object by serial ID
+    def self.device(serial)
+      if serial.to_s.empty?
+        raise DeviceAPI::BadSerialString.new("Serial was '#{ serial.nil? ? 'nil' : serial }'")
+      end
+      DeviceAPI::IOS::Device.new(serial: serial, state: 'ok')
+    end
+  end
+end

data/lib/device_api/ios/device.rb

@@ -0,0 +1,68 @@
+require 'device_api/device'
+require 'device_api/ios/device'
+require 'device_api/ios/idevice'
+require 'ios/devices'
+
+# DeviceAPI - an interface to allow for automation of devices
+module DeviceAPI
+  # iOS component of DeviceAPI
+  module IOS
+    # Namespace for the Device object.
+    class Device < DeviceAPI::Device
+      def initialize(options = {})
+        @serial = options[:serial]
+        @state = options[:state]
+      end
+
+      # Mapping of device status - used to provide a consistent status across platforms
+      # @return (String) common status string
+      def status
+        {
+            'device' => :ok,
+            'no device' => :dead,
+            'offline' => :offline
+        }[@state]
+      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
+        Ios::Devices.search(get_prop('ProductType')).name
+      end
+
+      # Returns the devices iOS version number - i.e. 8.2
+      # @return (String) iOS version number
+      def version
+        get_prop('ProductVersion')
+      end
+
+      # Return the device class - i.e. iPad, iPhone, etc
+      # @return (String) iOS device class
+      def device_class
+        get_prop('DeviceClass')
+      end
+
+      # Get the IMEI number of the device
+      # @return (String) IMEI number of current device
+      def imei
+        get_prop('InternationalMobileEquipmentIdentity')
+      end
+
+      # Has the 'Trust this device' dialog been accepted?
+      # @return (Boolean) true if the device is trusted, otherwise false
+      def trusted?
+        IDevice.trusted?(serial)
+      end
+
+      private
+
+      def get_prop(key)
+        if !@props || !@props[key]
+          @props = IDevice.get_props(serial)
+        end
+        @props[key]
+      end
+
+    end
+  end
+end

data/lib/device_api/ios/idevice.rb

@@ -0,0 +1,68 @@
+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 IDevice < Execution
+
+      # Returns an array of hashes representing connected devices
+      # @return (Array) Hash containing serial and device name
+      def self.devices
+        result = execute_with_timeout_and_retry('idevice_id -l')
+
+        raise IDeviceCommandError.new(result.stderr) if result.exit != 0
+
+        lines = result.stdout.split("\n")
+        results = []
+
+        lines.each do |ln|
+          if /[0-9a-zA-Z].*/.match(ln)
+            results.push(ln => execute_with_timeout_and_retry("ideviceinfo -u #{ln} -k DeviceName").stdout.split("\n"))
+          end
+        end
+        results
+      end
+
+      # Check to see if device has trusted the computer
+      # @param device_id uuid of the device
+      # @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
+        false
+      end
+
+      # Returns a Hash containing properties of the specified device using idevice_id.
+      # @param device_id uuid of the device
+      # @return (Hash) key value pair of properties
+      def self.get_props(device_id)
+        result = execute("ideviceinfo -u '#{device_id}'")
+
+        raise IDeviceCommandError.new(result.stderr) if result.exit != 0
+
+        result = result.stdout
+        props = {}
+        unless result.start_with?('Usage:')
+          prop_list = result.split("\n")
+          prop_list.each do |line|
+            matches = line.scan(/(.*): (.*)/)
+            prop_name, prop_value = matches[0]
+            props[prop_name.strip] = prop_value.strip
+          end
+        end
+
+        props
+      end
+    end
+
+    # Exception class to handle exceptions related to IDevice Class
+    class IDeviceCommandError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+
+  end
+end

data/spec/ios_device_spec.rb

@@ -0,0 +1,104 @@
+$LOAD_PATH.unshift( './lib/' )
+
+require 'device_api/execution'
+require 'device_api/ios/idevice'
+require 'device_api/ios/device'
+require 'yaml'
+
+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")
+    end
+
+    it "returns model of device" do
+        props = DeviceAPI::IOS::IDevice.get_props(@test_device_uuid)
+        expect(props['ModelNumber']).to eq(@ios_device.model)
+    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")
+      
+    end
+
+    it "returns successfully installed message once ios app is installed on a device" do
+        expect(@ios_device.install(@app_path)).to eq :success
+    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
+      
+    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_idevice_spec.rb

@@ -0,0 +1,109 @@
+$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
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: device_api-ios
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- BBC
+- Jon Wilson
+- Kedar Barde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: device_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: iOS implementation of DeviceAPI
+email:
+- jon.wilson01@bbc.co.uk
+- kedar_barde@mindtree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- device_api-ios.gemspec
+- lib/device_api/ios.rb
+- lib/device_api/ios/device.rb
+- lib/device_api/ios/idevice.rb
+- spec/ios_device_spec.rb
+- spec/ios_idevice_spec.rb
+homepage: https://github.com/bbc/device_api-ios
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: IOS Device Management API
+test_files: []
+has_rdoc: