Class: Spaceship::Portal::Device

Inherits:
Spaceship::PortalBase show all
Defined in:
lib/spaceship/portal/device.rb

Overview

Represents a device from the Apple Developer Portal

Instance Attribute Summary collapse

Attributes inherited from Base

#client, #raw_data

Class Method Summary collapse

Methods inherited from Spaceship::PortalBase

client

Methods inherited from Base

attr_accessor, attr_mapping, #attributes, attributes, #initialize, #inspect, mapping_module, method_missing, set_client, #setup, #to_s

Constructor Details

This class inherits a constructor from Spaceship::Base

Instance Attribute Details

#device_type ⇒ String

Returns Device type.

Examples:

'pc'     - Apple TV
'watch'  - Apple Watch
'ipad'   - iPad
'iphone' - iPhone
'ipod'   - iPod
'pc'     - Apple TV

Returns:



43
44
45
 
# File 'lib/spaceship/portal/device.rb', line 43

def device_type
  @device_type
end

#id ⇒ String

Returns The ID given from the developer portal. You’ll probably not need it.

Examples:

"XJXGVS46MW"

Returns:

  • (String) —

    The ID given from the developer portal. You’ll probably not need it.



8
9
10
 
# File 'lib/spaceship/portal/device.rb', line 8

def id
  @id
end

#model ⇒ String

Returns Model (can be nil).

Examples:

'iPhone 6', 'iPhone 4 GSM'

Returns:

  • (String) —

    Model (can be nil)



33
34
35
 
# File 'lib/spaceship/portal/device.rb', line 33

def model
  @model
end

#name ⇒ String

Returns The name of the device.

Examples:

"Felix Krause's iPhone 6"

Returns:

  • (String) —

    The name of the device



13
14
15
 
# File 'lib/spaceship/portal/device.rb', line 13

def name
  @name
end

#platform ⇒ String

Returns The platform of the device. This is probably always “ios”.

Examples:

"ios"

Returns:

  • (String) —

    The platform of the device. This is probably always “ios”



23
24
25
 
# File 'lib/spaceship/portal/device.rb', line 23

def platform
  @platform
end

#status ⇒ String

Returns Status of the device. Probably always “c”.

Examples:

"c"

Returns:

  • (String) —

    Status of the device. Probably always “c”



28
29
30
 
# File 'lib/spaceship/portal/device.rb', line 28

def status
  @status
end

#udid ⇒ String

Returns The UDID of the device.

Examples:

"4c24a7ee5caaa4847f49aaab2d87483053f53b65"

Returns:

  • (String) —

    The UDID of the device



18
19
20
 
# File 'lib/spaceship/portal/device.rb', line 18

def udid
  @udid
end

Class Method Details

.all ⇒ Array

Returns all devices registered for this account

Returns:

  • (Array) —

    Returns all devices registered for this account



63
64
65
 
# File 'lib/spaceship/portal/device.rb', line 63

def all
  client.devices.map { |device| self.factory(device) }
end

.all_apple_tvs ⇒ Array

Returns all Apple TVs registered for this account

Returns:

  • (Array) —

    Returns all Apple TVs registered for this account



68
69
70
 
# File 'lib/spaceship/portal/device.rb', line 68

def all_apple_tvs
  client.devices_by_class('pc').map { |device| self.factory(device) }
end

.all_ipads ⇒ Array

Returns all iPads registered for this account

Returns:

  • (Array) —

    Returns all iPads registered for this account



78
79
80
 
# File 'lib/spaceship/portal/device.rb', line 78

def all_ipads
  client.devices_by_class('ipad').map { |device| self.factory(device) }
end

.all_iphones ⇒ Array

Returns all iPhones registered for this account

Returns:

  • (Array) —

    Returns all iPhones registered for this account



83
84
85
 
# File 'lib/spaceship/portal/device.rb', line 83

def all_iphones
  client.devices_by_class('iphone').map { |device| self.factory(device) }
end

.all_ipod_touches ⇒ Array

Returns all iPods registered for this account

Returns:

  • (Array) —

    Returns all iPods registered for this account



88
89
90
 
# File 'lib/spaceship/portal/device.rb', line 88

def all_ipod_touches
  client.devices_by_class('ipod').map { |device| self.factory(device) }
end

.all_watches ⇒ Array

Returns all Watches registered for this account

Returns:

  • (Array) —

    Returns all Watches registered for this account



73
74
75
 
# File 'lib/spaceship/portal/device.rb', line 73

def all_watches
  client.devices_by_class('watch').map { |device| self.factory(device) }
end

.create!(name: nil, udid: nil) ⇒ Device

Register a new device to this account

Examples:

Spaceship.device.create!(name: "Felix Krause's iPhone 6", udid: "4c24a7ee5caaa4847f49aaab2d87483053f53b65")

Parameters:

  • name (String) (defaults to: nil) —

    (required): The name of the new device

  • udid (String) (defaults to: nil) —

    (required): The UDID of the new device

Returns:

  • (Device) —

    : The newly created device



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/spaceship/portal/device.rb', line 120

def create!(name: nil, udid: nil)
  # Check whether the user has passed in a UDID and a name
  unless udid && name
    raise "You cannot create a device without a device_id (UDID) and name"
  end

  # Find the device by UDID, raise an exception if it already exists
  if self.find_by_udid(udid)
    raise "The device UDID '#{udid}' already exists on this team."
  end

  # It is valid to have the same name for multiple devices

  device = client.create_device!(name, udid)

  # Update self with the new device
  self.new(device)
end

.factory(attrs) ⇒ Object

Create a new object based on a hash. This is used to create a new object based on the server response.



58
59
60
 
# File 'lib/spaceship/portal/device.rb', line 58

def factory(attrs)
  self.new(attrs)
end

.find(device_id) ⇒ Device

Returns Find a device based on the ID of the device. Attention: This is not the UDID. nil if no device was found.

Returns:

  • (Device) —

    Find a device based on the ID of the device. Attention: This is not the UDID. nil if no device was found.



94
95
96
97
98
 
# File 'lib/spaceship/portal/device.rb', line 94

def find(device_id)
  all.find do |device|
    device.id == device_id
  end
end

.find_by_name(device_name) ⇒ Device

Returns Find a device based on its name. nil if no device was found.

Returns:

  • (Device) —

    Find a device based on its name. nil if no device was found.



108
109
110
111
112
 
# File 'lib/spaceship/portal/device.rb', line 108

def find_by_name(device_name)
  all.find do |device|
    device.name == device_name
  end
end

.find_by_udid(device_udid) ⇒ Device

Returns Find a device based on the UDID of the device. nil if no device was found.

Returns:

  • (Device) —

    Find a device based on the UDID of the device. nil if no device was found.



101
102
103
104
105
 
# File 'lib/spaceship/portal/device.rb', line 101

def find_by_udid(device_udid)
  all.find do |device|
    device.udid == device_udid
  end
end