Class: Supply::Client

Inherits:
AbstractGoogleServiceClient show all
Defined in:
supply/lib/supply/client.rb

Constant Summary collapse

SERVICE = 
Androidpublisher::AndroidPublisherService
SCOPE = 
Androidpublisher::AUTH_ANDROIDPUBLISHER

Instance Attribute Summary collapse

Attributes inherited from AbstractGoogleServiceClient

#client

Login collapse

Handling the edit lifecycle collapse

Getting data collapse

Modifying data collapse

Screenshots collapse

Methods inherited from AbstractGoogleServiceClient

#initialize, make_from_config

Constructor Details

This class inherits a constructor from Supply::AbstractGoogleServiceClient

Instance Attribute Details

#current_edit ⇒ Object

Editing something Reference to the entry we’re currently editing. Might be nil if don’t have one open



104
105
106
 
# File 'supply/lib/supply/client.rb', line 104

def current_edit
  @current_edit
end

#current_package_name ⇒ Object

Package name of the currently edited element



106
107
108
 
# File 'supply/lib/supply/client.rb', line 106

def current_package_name
  @current_package_name
end

Class Method Details

.service_account_authentication(params: nil) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'supply/lib/supply/client.rb', line 112

def self.(params: nil)
  if params[:json_key] || params[:json_key_data]
    super(params: params)
  elsif params[:key] && params[:issuer]
    require 'google/api_client/auth/key_utils'
    UI.important("This type of authentication is deprecated. Please consider using JSON authentication instead")
    key = Google::APIClient::KeyUtils.load_from_pkcs12(File.expand_path(params[:key]), 'notasecret')
    cred_json = {
      private_key: key.to_s,
      client_email: params[:issuer]
    }
     = StringIO.new(JSON.dump(cred_json))
    
  else
    UI.user_error!("No authentication parameters were specified. These must be provided in order to authenticate with Google")
  end
end

Instance Method Details

#aab_version_codes ⇒ Object

Get a list of all AAB version codes - returns the list of version codes



214
215
216
217
218
219
220
 
# File 'supply/lib/supply/client.rb', line 214

def aab_version_codes
  ensure_active_edit!

  result = call_google_api { client.list_edit_bundles(current_package_name, current_edit.id) }

  return Array(result.bundles).map(&:version_code)
end

#abort_current_edit ⇒ Object

Aborts the current edit deleting all pending changes



144
145
146
147
148
149
150
151
 
# File 'supply/lib/supply/client.rb', line 144

def abort_current_edit
  ensure_active_edit!

  call_google_api { client.delete_edit(current_package_name, current_edit.id) }

  self.current_edit = nil
  self.current_package_name = nil
end

#apk_listings(apk_version_code) ⇒ Object

Get a list of all apk listings (changelogs) - returns the list



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'supply/lib/supply/client.rb', line 223

def apk_listings(apk_version_code)
  ensure_active_edit!

  result = call_google_api do
    client.list_apk_listings(
      current_package_name,
      current_edit.id,
      apk_version_code
    )
  end

  return (result.listings || []).map do |row|
    ApkListing.new(row.recent_changes, row.language, apk_version_code)
  end
end

#apks_version_codes ⇒ Object

Get a list of all APK version codes - returns the list of version codes



205
206
207
208
209
210
211
 
# File 'supply/lib/supply/client.rb', line 205

def apks_version_codes
  ensure_active_edit!

  result = call_google_api { client.list_apks(current_package_name, current_edit.id) }

  return Array(result.apks).map(&:version_code)
end

#begin_edit(package_name: nil) ⇒ Object

Begin modifying a certain package



135
136
137
138
139
140
141
 
# File 'supply/lib/supply/client.rb', line 135

def begin_edit(package_name: nil)
  UI.user_error!("You currently have an active edit") if @current_edit

  self.current_edit = call_google_api { client.insert_edit(package_name) }

  self.current_package_name = package_name
end

#clear_screenshots(image_type: nil, language: nil) ⇒ Object 



424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'supply/lib/supply/client.rb', line 424

def clear_screenshots(image_type: nil, language: nil)
  ensure_active_edit!

  call_google_api do
    client.delete_all_images(
      current_package_name,
      current_edit.id,
      language,
      image_type
    )
  end
end

#commit_current_edit! ⇒ Object

Commits the current edit saving all pending changes on Google Play



161
162
163
164
165
166
167
168
 
# File 'supply/lib/supply/client.rb', line 161

def commit_current_edit!
  ensure_active_edit!

  call_google_api { client.commit_edit(current_package_name, current_edit.id) }

  self.current_edit = nil
  self.current_package_name = nil
end

#fetch_images(image_type: nil, language: nil) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'supply/lib/supply/client.rb', line 393

def fetch_images(image_type: nil, language: nil)
  ensure_active_edit!

  result = call_google_api do
    client.list_images(
      current_package_name,
      current_edit.id,
      language,
      image_type
    )
  end

  (result.images || []).map(&:url)
end

#listing_for_language(language) ⇒ Object

Returns the listing for the given language filled with the current values if it already exists



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'supply/lib/supply/client.rb', line 187

def listing_for_language(language)
  ensure_active_edit!

  begin
    result = client.get_listing(
      current_package_name,
      current_edit.id,
      language
    )

    return Listing.new(self, language, result)
  rescue Google::Apis::ClientError => e
    return Listing.new(self, language) if e.status_code == 404 # create a new empty listing
    raise
  end
end

#listings ⇒ Object

Get a list of all languages - returns the list make sure to have an active edit



176
177
178
179
180
181
182
183
184
 
# File 'supply/lib/supply/client.rb', line 176

def listings
  ensure_active_edit!

  result = call_google_api { client.list_listings(current_package_name, current_edit.id) }

  return result.listings.map do |row|
    Listing.new(self, row.language, row)
  end
end

#track_version_codes(track) ⇒ Object

Get list of version codes for track



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'supply/lib/supply/client.rb', line 337

def track_version_codes(track)
  ensure_active_edit!

  begin
    result = client.get_track(
      current_package_name,
      current_edit.id,
      track
    )
    return result.version_codes || []
  rescue Google::Apis::ClientError => e
    return [] if e.status_code == 404 && e.to_s.include?("trackEmpty")
    raise
  end
end

#update_apk_listing_for_language(apk_listing) ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'supply/lib/supply/client.rb', line 353

def update_apk_listing_for_language(apk_listing)
  ensure_active_edit!

  apk_listing_object = Androidpublisher::ApkListing.new({
    language: apk_listing.language,
    recent_changes: apk_listing.recent_changes
  })

  call_google_api do
    client.update_apk_listing(
      current_package_name,
      current_edit.id,
      apk_listing.apk_version_code,
      apk_listing.language,
      apk_listing_object
    )
  end
end

#update_listing_for_language(language: nil, title: nil, short_description: nil, full_description: nil, video: nil) ⇒ Object

Updates or creates the listing for the specified language



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'supply/lib/supply/client.rb', line 244

def update_listing_for_language(language: nil, title: nil, short_description: nil, full_description: nil, video: nil)
  ensure_active_edit!

  listing = Androidpublisher::Listing.new({
    language: language,
    title: title,
    full_description: full_description,
    short_description: short_description,
    video: video
  })

  call_google_api do
    client.update_listing(
      current_package_name,
      current_edit.id,
      language,
      listing
    )
  end
end

#update_obb(apk_version_code, expansion_file_type, references_version, file_size) ⇒ Object 



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'supply/lib/supply/client.rb', line 372

def update_obb(apk_version_code, expansion_file_type, references_version, file_size)
  ensure_active_edit!

  call_google_api do
    client.update_expansion_file(
      current_package_name,
      current_edit.id,
      apk_version_code,
      expansion_file_type,
      Google::Apis::AndroidpublisherV2::ExpansionFile.new(
        references_version: references_version,
        file_size: file_size
      )
    )
  end
end

#update_track(track, rollout, apk_version_code) ⇒ Object

Updates the track for the provided version code(s)



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'supply/lib/supply/client.rb', line 310

def update_track(track, rollout, apk_version_code)
  ensure_active_edit!

  track_version_codes = apk_version_code.kind_of?(Array) ? apk_version_code : [apk_version_code]

  # This change happened on 2018-04-24
  # rollout cannot be sent on any other track besides "rollout"
  # https://github.com/fastlane/fastlane/issues/12372
  rollout = nil unless track == "rollout"

  track_body = Androidpublisher::Track.new({
    track: track,
    user_fraction: rollout,
    version_codes: track_version_codes
  })

  call_google_api do
    client.update_track(
      current_package_name,
      current_edit.id,
      track,
      track_body
    )
  end
end

#upload_apk(path_to_apk) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'supply/lib/supply/client.rb', line 265

def upload_apk(path_to_apk)
  ensure_active_edit!

  result_upload = call_google_api do
    client.upload_apk(
      current_package_name,
      current_edit.id,
      upload_source: path_to_apk
    )
  end

  return result_upload.version_code
end

#upload_bundle(path_to_aab) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'supply/lib/supply/client.rb', line 294

def upload_bundle(path_to_aab)
  ensure_active_edit!

  result_upload = call_google_api do
    client.upload_edit_bundle(
      current_package_name,
      self.current_edit.id,
      upload_source: path_to_aab,
      content_type: "application/octet-stream"
    )
  end

  return result_upload.version_code
end

#upload_image(image_path: nil, image_type: nil, language: nil) ⇒ Object

Parameters:

  • image_type (e.g. phoneScreenshots, sevenInchScreenshots, ...) (defaults to: nil) 


409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'supply/lib/supply/client.rb', line 409

def upload_image(image_path: nil, image_type: nil, language: nil)
  ensure_active_edit!

  call_google_api do
    client.upload_image(
      current_package_name,
      current_edit.id,
      language,
      image_type,
      upload_source: image_path,
      content_type: 'image/*'
    )
  end
end

#upload_mapping(path_to_mapping, apk_version_code) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'supply/lib/supply/client.rb', line 279

def upload_mapping(path_to_mapping, apk_version_code)
  ensure_active_edit!

  call_google_api do
    client.upload_edit_deobfuscationfile(
      current_package_name,
      current_edit.id,
      apk_version_code,
      "proguard",
      upload_source: path_to_mapping,
      content_type: "application/octet-stream"
    )
  end
end

#upload_obb(obb_file_path: nil, apk_version_code: nil, expansion_file_type: nil) ⇒ Object 



437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'supply/lib/supply/client.rb', line 437

def upload_obb(obb_file_path: nil, apk_version_code: nil, expansion_file_type: nil)
  ensure_active_edit!

  call_google_api do
    client.upload_expansion_file(
      current_package_name,
      current_edit.id,
      apk_version_code,
      expansion_file_type,
      upload_source: obb_file_path,
      content_type: 'application/octet-stream'
    )
  end
end

#validate_current_edit! ⇒ Object

Validates the current edit - does not change data on Google Play



154
155
156
157
158
 
# File 'supply/lib/supply/client.rb', line 154

def validate_current_edit!
  ensure_active_edit!

  call_google_api { client.validate_edit(current_package_name, current_edit.id) }
end