Class: Fastlane::Actions::RegisterDeviceAction

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

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, deprecated_notes, lane_context, method_missing, other_action, output, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.api_token(params) ⇒ Object 



40
41
42
43
44
45
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 40

def self.api_token(params)
  params[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
  api_token ||= Spaceship::ConnectAPI::Token.create(params[:api_key]) if params[:api_key]
  api_token ||= Spaceship::ConnectAPI::Token.from_json_file(params[:api_key_path]) if params[:api_key_path]
  return api_token
end

.author ⇒ Object 



123
124
125
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 123

def self.author
  "pvinis"
end

.available_options ⇒ Object 



51
52
53
54
55
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 51

def self.available_options
  user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
  user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
  platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME].to_s

  [
    FastlaneCore::ConfigItem.new(key: :name,
                                 env_name: "FL_REGISTER_DEVICE_NAME",
                                 description: "Provide the name of the device to register as"),
    FastlaneCore::ConfigItem.new(key: :platform,
                                 env_name: "FL_REGISTER_DEVICE_PLATFORM",
                                 description: "Provide the platform of the device to register as (ios, mac)",
                                 optional: true,
                                 default_value: platform.empty? ? "ios" : platform,
                                 verify_block: proc do |value|
                                   UI.user_error!("The platform can only be ios or mac") unless %('ios', 'mac').include?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :udid,
                                 env_name: "FL_REGISTER_DEVICE_UDID",
                                 description: "Provide the UDID of the device to register as"),
    FastlaneCore::ConfigItem.new(key: :api_key_path,
                                 env_name: "FL_REGISTER_DEVICE_API_KEY_PATH",
                                 description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)",
                                 optional: true,
                                 conflicting_options: [:api_key],
                                 verify_block: proc do |value|
                                   UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :api_key,
                                 env_name: "FL_REGISTER_DEVICE_API_KEY",
                                 description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option)",
                                 type: Hash,
                                 optional: true,
                                 sensitive: true,
                                 conflicting_options: [:api_key_path]),
    FastlaneCore::ConfigItem.new(key: :team_id,
                               env_name: "REGISTER_DEVICE_TEAM_ID",
                               code_gen_sensitive: true,
                               default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
                                 default_value_dynamic: true,
                               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_DEVICE_TEAM_NAME",
                                 description: "The name of your Developer Portal team if you're in multiple teams",
                                 optional: true,
                                 code_gen_sensitive: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_name),
                                 default_value_dynamic: true,
                                 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",
                                 optional: true,
                                 default_value: user,
                                 default_value_dynamic: true)
  ]
end

.category ⇒ Object 



146
147
148
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 146

def self.category
  :code_signing
end

.description ⇒ Object 



47
48
49
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 47

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

.details ⇒ Object 



115
116
117
118
119
120
121
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 115

def self.details
  [
    "This will register an iOS device with the Developer Portal so that you can include it in your provisioning profiles.",
    "This is an optimistic action, in that it will only ever add a device to the member center. If the device has already been registered within the member center, it will be left alone in the member center.",
    "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."
  ].join("\n")
end

.example_code ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 127

def self.example_code
  [
    'register_device(
      name: "Luka iPhone 6",
      udid: "1234567890123456789012345678901234567890"
    ) # Simply provide the name and udid of the device',
    'register_device(
      name: "Luka iPhone 6",
      udid: "1234567890123456789012345678901234567890",
      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:



6
7
8
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 6

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

.return_type ⇒ Object 



142
143
144
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 142

def self.return_type
  :string
end

.run(params) ⇒ Object 



10
11
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
 
# File 'fastlane/lib/fastlane/actions/register_device.rb', line 10

def self.run(params)
  require 'spaceship'

  name = params[:name]
  platform = params[:platform]
  udid = params[:udid]

  platform = Spaceship::ConnectAPI::BundleIdPlatform.map(platform)

  if (token = api_token(params))
    UI.message("Using App Store Connect API token...")
    Spaceship::ConnectAPI.token = token
  else
    UI.message("Login to App Store Connect (#{params[:username]})")
    credentials = CredentialsManager::AccountManager.new(user: params[:username])
    Spaceship::ConnectAPI.(credentials.user, credentials.password, use_portal: true, use_tunes: false)
    UI.message("Login successful")
  end

  begin
    Spaceship::ConnectAPI::Device.create(name: name, platform: platform, udid: udid)
  rescue => ex
    UI.error(ex.to_s)
    UI.crash!("Failed to register new device (name: #{name}, platform: #{platform}, UDID: #{udid})")
  end

  UI.success("Successfully registered new device")
  return udid
end