Class: Fastlane::Actions::RegisterDevicesAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/register_devices.rb

Constant Summary collapse

UDID_REGEXP = 
/^\h{40}$/

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, lane_context, method_missing, other_action, output, return_value, sample_return_value, sh, step_text

Class Method Details

.author ⇒ Object 



104
105
106
 
# File 'lib/fastlane/actions/register_devices.rb', line 104

def self.author
  "lmirosevic"
end

.available_options ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/fastlane/actions/register_devices.rb', line 56

def self.available_options
  user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
  user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)

  [
    FastlaneCore::ConfigItem.new(key: :devices,
                                 env_name: "FL_REGISTER_DEVICES_DEVICES",
                                 description: "A hash of devices, with the name as key and the UDID as value",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :devices_file,
                                 env_name: "FL_REGISTER_DEVICES_FILE",
                                 description: "Provide a path to the devices to register",
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Could not find file '#{value}'") unless File.exist?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :team_id,
                               env_name: "REGISTER_DEVICES_TEAM_ID",
                               default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
                               description: "The ID of your Developer Portal team if you're in multiple teams",
                               optional: true,
                               verify_block: proc do |value|
                                 ENV["FASTLANE_TEAM_ID"] = value.to_s
                               end),
    FastlaneCore::ConfigItem.new(key: :team_name,
                                 env_name: "REGISTER_DEVICES_TEAM_NAME",
                                 description: "The name of your Developer Portal team if you're in multiple teams",
                                 optional: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_name),
                                 verify_block: proc do |value|
                                   ENV["FASTLANE_TEAM_NAME"] = value.to_s
                                 end),
    FastlaneCore::ConfigItem.new(key: :username,
                                 env_name: "DELIVER_USER",
                                 description: "Optional: Your Apple ID",
                                 default_value: user)
  ]
end

.category ⇒ Object 



127
128
129
 
# File 'lib/fastlane/actions/register_devices.rb', line 127

def self.category
  :code_signing
end

.description ⇒ Object 



52
53
54
 
# File 'lib/fastlane/actions/register_devices.rb', line 52

def self.description
  "Registers new devices to the Apple Dev Portal"
end

.details ⇒ Object 



96
97
98
99
100
101
102
 
# File 'lib/fastlane/actions/register_devices.rb', line 96

def self.details
  [
    "This will register iOS devices with the Developer Portal so that you can include them in your provisioning profiles.",
    "This is an optimistic action, in that it will only ever add new devices to the member center, and never remove devices. If a device which has already been registered within the member center is not passed to this action, it will be left alone in the member center and continue to work.",
    "The action will connect to the Apple Developer Portal using the username you specified in your `Appfile` with `apple_id`, but you can override it using the `username` option, or by setting the env variable `ENV['DELIVER_USER']`."
  ].join("\n")
end

.example_code ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/fastlane/actions/register_devices.rb', line 108

def self.example_code
  [
    'register_devices(
      devices: {
        "Luka iPhone 6" => "1234567890123456789012345678901234567890",
        "Felix iPad Air 2" => "abcdefghijklmnopqrstvuwxyzabcdefghijklmn"
      }
    ) # Simply provide a list of devices as a Hash',
    'register_devices(
      devices_file: "./devices.txt"
    ) # Alternatively provide a standard UDID export .txt file, see the Apple Sample (https://devimages.apple.com.edgekey.net/downloads/devices/Multiple-Upload-Samples.zip)',
    'register_devices(
      devices_file: "./devices.txt", # You must pass in either `devices_file` or `devices`.
      team_id: "XXXXXXXXXX",         # Optional, if you"re a member of multiple teams, then you need to pass the team ID here.
      username: "[email protected]"   # Optional, lets you override the Apple Member Center username.
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'lib/fastlane/actions/register_devices.rb', line 8

def self.is_supported?(platform)
  platform == :ios
end

.run(params) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/fastlane/actions/register_devices.rb', line 12

def self.run(params)
  require 'spaceship'

  devices = params[:devices]
  devices_file = params[:devices_file]

  credentials = CredentialsManager::AccountManager.new(user: params[:username])
  Spaceship.(credentials.user, credentials.password)
  Spaceship.select_team

  if devices
    device_objs = devices.map do |k, v|
      UI.user_error!("Passed invalid UDID: #{v} for device: #{k}") unless UDID_REGEXP =~ v
      Spaceship::Device.create!(name: k, udid: v)
    end
  elsif devices_file
    require 'csv'

    devices_file = CSV.read(File.expand_path(File.join(devices_file)), col_sep: "\t")
    UI.user_error!("Please provide a file according to the Apple Sample UDID file (https://devimages.apple.com.edgekey.net/downloads/devices/Multiple-Upload-Samples.zip)") unless devices_file.first == ['Device ID', 'Device Name']

    UI.message("Fetching list of currently registered devices...")
    existing_devices = Spaceship::Device.all

    device_objs = devices_file.drop(1).map do |device|
      next if existing_devices.map(&:udid).include?(device[0])

      UI.user_error!("Invalid device line, please provide a file according to the Apple Sample UDID file (https://devimages.apple.com.edgekey.net/downloads/devices/Multiple-Upload-Samples.zip)") unless device.count == 2
      UI.user_error!("Passed invalid UDID: #{device[0]} for device: #{device[1]}") unless UDID_REGEXP =~ device[0]

      Spaceship::Device.create!(name: device[1], udid: device[0])
    end
  else
    UI.user_error!("You must pass either a valid `devices` or `devices_file`. Please check the readme.")
  end

  UI.success("Successfully registered new devices.")
  return device_objs
end