Class: Fastlane::Actions::LokaliseMetadataAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



496
497
498
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 496

def self.authors
  ["Fedya-L", "BasouKazuma"]
end

.available_options ⇒ Object 



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 445

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :platform,
                                 env_name: "FASTLANE_PLATFORM_NAME",
                                 description: "Fastlane platform name"),
    FastlaneCore::ConfigItem.new(key: :api_token,
                                 env_name: "LOKALISE_API_TOKEN",
                                 description: "API Token for Lokalise",
                                 verify_block: proc do |value|
                                    UI.user_error! "No API token for Lokalise given, pass using `api_token: 'token'`" unless (value and not value.empty?)
                                 end),
    FastlaneCore::ConfigItem.new(key: :project_identifier,
                                 env_name: "LOKALISE_PROJECT_ID",
                                 description: "Lokalise Project ID",
                                 verify_block: proc do |value|
                                    UI.user_error! "No Project Identifier for Lokalise given, pass using `project_identifier: 'identifier'`" unless (value and not value.empty?)
                                 end),
    FastlaneCore::ConfigItem.new(key: :metadata_path,
                                 description: "Location where the metadata files should be stored and read from",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :add_languages,
                                 description: "Add missing languages in lokalise",
                                 optional: true,
                                 is_string: false,
                                 default_value: false,
                                 verify_block: proc do |value|
                                   UI.user_error! "Add languages should be true or false" unless [true, false].include? value
                                 end),
    FastlaneCore::ConfigItem.new(key: :override_translation,
                                 description: "Override translations in lokalise",
                                 optional: true,
                                 is_string: false,
                                 default_value: false,
                                 verify_block: proc do |value|
                                   UI.user_error! "Override translation should be true or false" unless [true, false].include? value
                                 end),
    FastlaneCore::ConfigItem.new(key: :action,
                                 description: "Action to perform (download_from_lokalise, upload_to_lokalise)",
                                 optional: false,
                                 is_string: true,
                                 verify_block: proc do |value|
                                   UI.user_error! "Action should be one of the following: download_from_lokalise, upload_to_lokalise" unless ["download_from_lokalise", "upload_to_lokalise"].include? value
                                 end),
    FastlaneCore::ConfigItem.new(key: :release_number,
                                description: "Release number is required for Android actions",
                                optional: true,
                                is_string: false),
  ]
end

.create_languages(languages) ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 60

def self.create_languages(languages)
  data = {
    iso: languages.map { |language| fix_language_name(language, true) } .to_json
  }
  make_request("language/add", data)
end

.description ⇒ Object 



435
436
437
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 435

def self.description
  "Upload metadata to lokalise."
end

.details ⇒ Object 



440
441
442
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 440

def self.details
  "This action scans fastlane/metadata folder and uploads metadata to lokalise.co"
end

.filter_metadata(metadata, other_metadata) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 68

def self.filter_metadata(metadata, other_metadata)
  filtered_metadata = {}
  metadata.each { |language, translations|
    other_translations = other_metadata[language]
    filtered_translations = {}
    
    if other_translations != nil && other_translations.empty? == false
      translations.each { |key, value|
        other_value = other_translations[key]
        filtered_translations[key] = value unless other_value != nil && other_value.empty? == false
      }
    else 
      filtered_translations = translations
    end

    filtered_metadata[language] = filtered_translations unless filtered_translations.empty?
  }
  return filtered_metadata
end

.fix_language_name(language, for_lokalise = false) ⇒ Object 



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 407

def self.fix_language_name(language, for_lokalise = false)
  if @params[:platform] == "android"
    language_map = googleplay_to_lokalise_language_map()
  else
    language_map = itunes_to_lokalise_language_map()
  end
  if for_lokalise
    if language_map.key?(language)
      return language_map[language]
    else
      return language.gsub("-", "_")
    end
  else
    language_map = language_map.invert
    if language_map.key?(language)
      return language_map[language]
    else
      return language.gsub("_", "-")
    end
  end
end

.get_metadata ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 228

def self.get_metadata()
  case @params[:platform]
  when "ios"
    available_languages = itunes_connect_languages
  when "android"
    available_languages = google_play_languages
  end
  metadata_path = get_metadata_path()
  complete_metadata = {}
  available_languages.each { |iso_code|
    language_directory = File.join(metadata_path, iso_code)
    if Dir.exist? language_directory
      language_metadata = {}
      case @params[:platform]
      when "ios"
        metadata_key_file_itunes().each { |key, file|
          populate_hash_key_from_file(language_metadata, key, File.join(language_directory, "#{file}.txt"))
        }
      when "android"
        metadata_key_file_googleplay().each { |key, file|
          if file == "changelogs"
            changelog_directory = File.join(language_directory, "changelogs")
            files = Dir.entries("#{changelog_directory}")
            collectedFiles = files.collect { |s| s.partition(".").first.to_i }
            sortedFiles = collectedFiles.sort
            populate_hash_key_from_file(language_metadata, key, File.join(language_directory, "changelogs", "#{sortedFiles.last}.txt"))
          else
            populate_hash_key_from_file(language_metadata, key, File.join(language_directory, "#{file}.txt"))
          end
        }
      end
      complete_metadata[iso_code] = language_metadata
    end
  }
  return complete_metadata
end

.get_metadata_from_lokalise ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 266

def self.get_metadata_from_lokalise()
  case @params[:platform]
  when "ios"
    valid_keys = metadata_key_file_itunes().keys
    valid_languages = itunes_connect_languages_in_lokalise()
    key_name = "key_ios"
  when "android"
    valid_keys = metadata_key_file_googleplay().keys
    valid_languages = google_play_languages_in_lokalise()
    key_name = "key_android"
  end
  data = {
    platform_mask: 16,
    keys: valid_keys.to_json,
  }
  response = make_request("string/list", data)
  metadata = {}
  response["strings"].each { |lang, translation_objects|
    if valid_languages.include?(lang)
      translations = {}
      translation_objects.each { |object|
        # The key can named differently depending on how the Lokalise Project was set up
        key = object[key_name]
        if !key
          key = object['key']
        end
        translation = object["translation"]
        if valid_keys.include?(key) && translation != nil && translation.empty? == false 
          translations[key] = translation
        end
      }
      if translations.empty? == false
        metadata[fix_language_name(lang)] = translations
      end
    end
  }
  return metadata
end

.get_metadata_path ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 213

def self.get_metadata_path()
  if @params[:metadata_path]
    metadata_path = @params[:metadata_path]
  else
    case @params[:platform]
    when "android"
      metadata_path = "fastlane/metadata/android/"
    else
      metadata_path = "fastlane/metadata/"
    end
  end
  return metadata_path
end

.google_play_languages ⇒ Object 



365
366
367
368
369
370
371
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 365

def self.google_play_languages()
  languages = Supply::Languages::ALL_LANGUAGES
  languages.each do |lang|
      lang.gsub!("_", '-')
  end
  return languages
end

.google_play_languages_in_lokalise ⇒ Object 



349
350
351
352
353
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 349

def self.google_play_languages_in_lokalise()
  return google_play_languages().map { |lang| 
    fix_language_name(lang, true) 
  }
end

.googleplay_to_lokalise_language_map ⇒ Object 



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 385

def self.googleplay_to_lokalise_language_map()
  return {
    "cs-CZ" => "cs",
    "da-DK" => "da",
    "fi-FI" => "fi",
    "iw-IL" => "he",
    "hu-HU" => "hu",
    "hy-AM" => "hy",
    "ja-JP" => "ja",
    "ko-KR" => "ko",
    "ky-KG" => "ky",
    "lo-LA" => "lo",
    "mr-IN" => "mr",
    "my-MM" => "my",
    "no-NO" => "no",
    "si-LK" => "si",
    "sl" => "sl_SI",
    "tr-TR" => "tr"
  }
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


501
502
503
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 501

def self.is_supported?(platform)
  [:ios, :android, :mac].include? platform
end

.itunes_connect_languages ⇒ Object 



356
357
358
359
360
361
362
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 356

def self.itunes_connect_languages()
  languages = FastlaneCore::Languages::ALL_LANGUAGES
  languages.each do |lang|
      lang.gsub!("_", '-')
  end
  return languages
end

.itunes_connect_languages_in_lokalise ⇒ Object 



342
343
344
345
346
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 342

def self.itunes_connect_languages_in_lokalise()
  return itunes_connect_languages().map { |lang| 
    fix_language_name(lang, true) 
  }
end

.itunes_to_lokalise_language_map ⇒ Object 



374
375
376
377
378
379
380
381
382
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 374

def self.itunes_to_lokalise_language_map()
  return {
    "nl-NL" => "nl",
    "en-US" => "en",
    "hi" => "hi_IN",
    "zh-Hans" => "zh_CN",
    "zh-Hant" => "zh_TW"
  }
end

.make_key_object_from_metadata(key, metadata) ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 193

def self.make_key_object_from_metadata(key, metadata)
  key_data = {
    "key" => key,
    "platform_mask" => 16,
    "translations" => {}
  }
  metadata.each { |iso_code, data|
    translation = data[key]
    unless translation == nil || translation.empty?
      key_data["translations"][fix_language_name(iso_code, true)] = translation
    end
  }
  unless key_data["translations"].empty? 
    return key_data
  else
    return nil
  end
end

.make_request(path, data) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 138

def self.make_request(path, data)

  request_data = {
    api_token: @params[:api_token],
    id: @params[:project_identifier]
  }.merge(data)

  uri = URI("https://api.lokalise.co/api/#{path}")
  request = Net::HTTP::Post.new(uri)
  request.set_form_data(request_data)
  
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true
  response = http.request(request)

  jsonResponse = JSON.parse(response.body)
  raise "Bad response 🉐\n#{response.body}" unless jsonResponse.kind_of? Hash
  if jsonResponse["response"]["status"] == "success"  then
    UI.success "Response #{jsonResponse} 🚀"
  elsif jsonResponse["response"]["status"] == "error"
    code = jsonResponse["response"]["code"]
    message = jsonResponse["response"]["message"]
    raise "Response error code #{code} (#{message}) 📟"
  else
    raise "Bad response 🉐\n#{jsonResponse}"
  end
  return jsonResponse
end

.metadata_key_file_googleplay ⇒ Object 



332
333
334
335
336
337
338
339
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 332

def self.metadata_key_file_googleplay()
  return {
    "googleplay.app.title" => "title",
    "googleplay.app.full_description" => "full_description",
    "googleplay.app.short_description" => "short_description",
    "googleplay.app.changelogs" => "changelogs",
  }
end

.metadata_key_file_itunes ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 317

def self.metadata_key_file_itunes()
  return {
    "appstore.app.name" => "name",
    "appstore.app.description" => "description",
    "appstore.app.keywords" => "keywords",
    "appstore.app.promotional_text" => "promotional_text",
    "appstore.app.release_notes" => "release_notes",
    "appstore.app.subtitle" => "subtitle",
    "appstore.app.marketing_url" => "marketing_url",
    "appstore.app.privacy_url" => "privacy_url",
    "appstore.app.support_url" => "support_url",
  }
end

.populate_hash_key_from_file(hash, key, filepath) ⇒ Object 



306
307
308
309
310
311
312
313
314
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 306

def self.populate_hash_key_from_file(hash, key, filepath)
  begin
    text = File.read filepath
    text.chomp!
    hash[key] = text unless text.empty?
  rescue => exception
    raise exception
  end
end

.run(params) ⇒ Object 



9
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 9

def self.run(params)
  @params = params

  case @params[:platform]
  when "ios"
      case @params[:action]
      when "download_from_lokalise"
          metadata = get_metadata_from_lokalise()
          write_lokalise_translations_to_itunes_metadata(metadata)
      when "upload_to_lokalise"
          metadata = get_metadata()
          add_languages = params[:add_languages]
          override_translation = params[:override_translation]
          if add_languages == true
            create_languages(metadata.keys)
          end
          if override_translation == true
            upload_metadata_itunes(metadata) unless metadata.empty?
          else
            lokalise_metadata = get_metadata_from_lokalise()
            filtered_metadata = filter_metadata(metadata, lokalise_metadata)
            upload_metadata_itunes(filtered_metadata) unless filtered_metadata.empty?
          end
      end
  when "android"
      case @params[:action]
      when "download_from_lokalise"
          release_number = params[:release_number]
          UI.user_error! "Release number is required for Android (should be an integer and greater that 0)" unless (release_number and release_number.is_a?(Integer) and release_number > 0)
          metadata = get_metadata_from_lokalise()
          write_lokalise_translations_to_googleplay_metadata(metadata, release_number)
      when "upload_to_lokalise"
          metadata = get_metadata()
          add_languages = params[:add_languages]
          override_translation = params[:override_translation]
          if add_languages == true 
            create_languages(metadata.keys)
          end
          if override_translation == true
            upload_metadata_google_play(metadata) unless metadata.empty?
          else
            lokalise_metadata = get_metadata_from_lokalise()
            filtered_metadata = filter_metadata(metadata, lokalise_metadata)
            upload_metadata_google_play(filtered_metadata) unless filtered_metadata.empty?
          end
      end
  end

end

.upload_metadata(metadata_keys, metadata) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 168

def self.upload_metadata(metadata_keys, metadata)
  keys = []
  metadata_keys.each do |key, value|
    key = make_key_object_from_metadata(key, metadata)
    if key 
      keys << key
    end
  end
  data = {
    data: keys.to_json
  }
  make_request("string/set", data)
end

.upload_metadata_google_play(metadata) ⇒ Object 



188
189
190
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 188

def self.upload_metadata_google_play(metadata)
  upload_metadata(metadata_key_file_googleplay, metadata)
end

.upload_metadata_itunes(metadata) ⇒ Object 



183
184
185
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 183

def self.upload_metadata_itunes(metadata)
  upload_metadata(metadata_key_file_itunes, metadata)
end

.write_lokalise_translations_to_googleplay_metadata(metadata, release_number) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 111

def self.write_lokalise_translations_to_googleplay_metadata(metadata, release_number)
  metadata_key_file_googleplay().each { |key, parameter|
    final_translations = {}
    metadata.each { |lang, translations|
      if translations.empty? == false
        translation = translations[key]
        final_translations[lang] = translation if translation != nil && translation.empty? == false
        metadata_path = get_metadata_path()
        if "#{parameter}" ==  "changelogs"
          path = File.join(metadata_path, lang, parameter)
          filename = "#{release_number}.txt"
        else
          path = File.join(metadata_path, lang)
          filename = "#{parameter}.txt"
        end
        output_file = File.join(path, filename)
        FileUtils.mkdir_p(path) unless File.exist?(path)
        puts "Updating '#{output_file}'..."
        File.open(output_file, 'wb') do |file|
          file.write(final_translations[lang])
        end
      end
    }
  }
end

.write_lokalise_translations_to_itunes_metadata(metadata) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/fastlane/plugin/lokalise/actions/lokalise_metadata_action.rb', line 89

def self.write_lokalise_translations_to_itunes_metadata(metadata)
  metadata_key_file_itunes().each { |key, parameter|
    final_translations = {}
    metadata.each { |lang, translations|
      if translations.empty? == false
        translation = translations[key]
        final_translations[lang] = translation if translation != nil && translation.empty? == false
        metadata_path = get_metadata_path()
        path = File.join(metadata_path, lang)
        filename = "#{parameter}.txt"
        output_file = File.join(path, filename)
        FileUtils.mkdir_p(path) unless File.exist?(path)
        puts "Updating '#{output_file}'..."
        File.open(output_file, 'wb') do |file|
          file.write(final_translations[lang])
        end
      end 
    }
  }
end