ETLane 0.1.42 → 0.1.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09b7a6a431d95a787e1c8071545b9d6808d4cd20e50e51b5912b83cc38b52e4d'
-  data.tar.gz: 7e68797c237de69e55ea50012fbc88b61f70a39b80beb44544987850976e6e72
+  metadata.gz: 5146fbf20c0df981bb51ee0f37f91bece981ed31ca24389d218633006e08faec
+  data.tar.gz: dac0822eb320f54a86083f64854e3c966ec452fbabb44ba29bede0af00069196
 SHA512:
-  metadata.gz: f26cdb1c032c33f01a51e6a3fd97d5a452e968e0d7eb56274780cac8f7506e1b881b6aad548a942061f694596d2364e4bbb1d159a9d1b5dcbf9ce6b01bdb721f
-  data.tar.gz: 646ff2101de9044f35330d239062677cc30308cf603baeeccc8a899893a80db736a8050fcb8694c8dea09c318b11a5e9a650a3a2bd61c6cfa448ce61bfb54277
+  metadata.gz: '086753d189a8cac283d86923f8106bc97b71c4c9acd64c3fe09670aae36499d5faad527c7cb857ac539c5355b77b5533acd18a04604e25b107ab538c547c33f7'
+  data.tar.gz: a45ac892f8da6b842b5e7520274ed3fab49ee3fc93f73c24566b390824f62951b7f13a7c683cf273a0a6e9691dc2d6308aba39afc95ebb177ccc20cc64dcf757

data/Lanes/CommonFastfile

@@ -10,7 +10,6 @@ platform :ios do
   
   build_folder = File.join(Dir.pwd, "..", "build")
   last_commit_path = File.join(Dir.pwd, "last_commit")
-  scripts_dir = File.join(Dir.pwd, "../Pods/ETLane/Scripts")
 
   desc "Push a new beta build to TestFlight"
   lane :beta do |options|
@@ -44,6 +43,7 @@ platform :ios do
       },
     )
     last_commit = File.read(last_commit_path)
+    last_commit = last_commit.strip! || last_commit if last_commit
     changelog = changelog_from_git_commits(
       quiet: true,
       between: [last_commit, "HEAD"],  # Optional, lets you specify a revision/tag range between which to collect commit info
@@ -58,7 +58,6 @@ platform :ios do
     branch_name = "feature/#{build_number}"
     sh("git", "checkout", "-B", branch_name)
     increment_and_push()
-    ENV["FL_CHANGELOG"] = nil
 
     beta_app_review_info = {}
     if ENV["ET_BETA_APP_REVIEW_INFO"]
@@ -70,7 +69,7 @@ platform :ios do
       upload_to_testflight(
         username: username,
         beta_app_review_info: beta_app_review_info,
-        changelog: "",
+        changelog: changelog,
         groups: ["#{distribute_group_name}"]
       )
       tag = get_version_number(target: project_name) + "." + build_number
@@ -120,11 +119,8 @@ platform :ios do
     if download_screenshots
       FileUtils.rm_rf(screenshots_path)
     end
-
-    cocoapods(
-      try_repo_update_on_error: true,
-      use_bundle_exec: true,
-    )
+    lane_path = %x( bundle info ETLane --path )
+    scripts_dir = File.join(lane_path.strip, "Scripts")
 
     Dir.chdir(scripts_dir) do
       sh(

data/Lanes/actions/README.md

@@ -0,0 +1,47 @@
+# Lokalise Fastlane Actions
+
+Collection of actions for integrating Lokalise into your iOS project using Fastlane. Learn more in our [blog post.](https://blog.lokalise.com/automating-itunes-connect-deployment-with-fastlane-and-lokalise/)
+
+For Android actions please check [here](https://github.com/lokalise/lokalise-fastlane-actions/tree/master/android)
+
+## Note
+
+These are Fastlane actions, not plugins. Add them to `fastlane/actions` folder in the root of your project.
+
+## lokalise
+
+This action downloads .strings and .stringsdict files to destination folder.
+
+Parameters:
+
+- `api_token`. Your API token. Can be set up using enviromental parameter `LOKALISE_API_TOKEN`
+- `project_identifier`. Your Project ID. Can be set up using enviromental parameter `LOKALISE_PROJECT_ID`
+- `destination`. Localization files destination.
+- `clean_destination`. Cleans destination folder if set to `true` *(`false` by default)*.
+- `languages`. Languages to download *(must be passed as array of strings, leave empty to download all)*.
+- `include_comments`. Include comments in exported files.
+- `use_original`. Use original filenames/formats.
+
+## lokalise_metadata
+
+This action imports metadata from files generated by Deliver action and uploads iTunes Connect metadata using information from Lokalise.
+
+- `api_token`. Your API token. Can be set up using enviromental parameter `LOKALISE_API_TOKEN`
+- `project_identifier`. Your Project ID. Can be set up using enviromental parameter `LOKALISE_PROJECT_ID`
+- `action`. Action to perform *(can be `update_lokalise_itunes`, `update_itunes`, `update_lokalise_googleplay` or `update_googleplay`)*. 
+- `add_languages`. Add missing languages to lokalise *(`false` by default)*.
+- `override_translation`. Override translations in lokalise.
+- `release_number`. Application release number. Required with `update_googleplay` action.
+- `validate_only`. Only validate the metadata. Used with `update_googleplay` action *(`false` by default)*.
+
+## add_keys_to_lokalise
+
+This actions allow you upload keys to Lokalise.
+
+Parameters:
+
+- `api_token`. Your API token. Can be set up using enviromental parameter `LOKALISE_API_TOKEN`
+- `project_identifier`. Your Project ID. Can be set up using enviromental parameter `LOKALISE_PROJECT_ID`
+- `platform_mask`. Platform mask to asign to keys *(1 is iOS, 2 is Android, 4 is Web and 16 is Other)*.
+- `keys`. Keys to add *(must be passed as array of strings)*.
+

data/Lanes/actions/add_keys_to_lokalise.rb

@@ -0,0 +1,106 @@
+module Fastlane
+  module Actions
+
+    class AddKeysToLokaliseAction < Action
+      def self.run(params)
+        require 'net/http'
+
+        token = params[:api_token]
+        project_identifier = params[:project_identifier]
+        keys = params[:keys]
+        platform_mask = params[:platform_mask]
+
+        keysObjects = []
+
+        keys.each do |key|
+          keysObjects << {
+            key: key,
+            platform_mask: platform_mask
+          }
+        end
+
+        request_data = {
+          api_token: token,
+          id: project_identifier,
+          data: keysObjects.to_json
+        }
+
+        uri = URI("https://api.lokalise.com/api/string/set")
+        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}".red unless jsonResponse.kind_of? Hash
+        if jsonResponse["response"]["status"] == "success"  then
+          inserted = jsonResponse["result"]["inserted"]
+          updated = jsonResponse["result"]["updated"]
+          Helper.log.info "Keys uploaded. #{inserted} inserted and #{updated} updated 🚀".green
+        elsif jsonResponse["response"]["status"] == "error"
+          code = jsonResponse["response"]["code"]
+          message = jsonResponse["response"]["message"]
+          raise "Response error code #{code} (#{message}) 📟".red
+        else
+          raise "Bad response 🉐\n#{jsonResponse}".red
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Add keys to lokalise"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "LOKALISE_API_TOKEN",
+                                       description: "API Token for Lokalise",
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                          raise "No API token for Lokalise given, pass using `api_token: 'token'`".red unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_identifier,
+                                       env_name: "LOKALISE_PROJECT_ID",
+                                       description: "Lokalise Project Identifier",
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                          raise "No Project Identifier for Lokalise given, pass using `project_identifier: 'identifier'`".red unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :platform_mask,
+                                       description: "Platform mask where 1 is iOS, 2 is Android, 4 is Web and 16 is Other",
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: 1,
+                                       verify_block: proc do |value|
+                                          raise "Platfrom mask is an integer value".red unless value.is_a?(Integer)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :keys,
+                                       description: "Keys to add",
+                                       optional: false,
+                                       is_string: false,
+                                       verify_block: proc do |value|
+                                          raise "Keys must be passed as array of strings".red unless (value.kind_of? Array and not value.empty?)
+                                          value.each_with_index do |key, index|
+                                            raise "Key at index #{index} must be string".red unless key.kind_of? String
+                                            raise "Key at index #{index} can't be empty".red if key.empty?
+                                          end
+                                       end)
+        ]
+      end
+
+      def self.authors
+        "Fedya-L"
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include? platform 
+      end
+    end
+  end
+end

data/Lanes/actions/android/README.md

@@ -0,0 +1,53 @@
+# Lokalise Fastlane Actions for Android
+
+Fastlane actions for integrating Lokalise into your Android project using Fastlane.
+
+All Android actions based on APIs V2
+
+## Note
+
+These are Fastlane actions, not plugins. Add them to `fastlane/actions` folder in the root of your project.
+
+## lokalise_download
+
+This action downloads strings.xml files to you main resources folder `./app/src/main/res`.
+
+>That will replace your local strings.xml file with the latest version from lokalise project. 
+>So make sure to call lokalise_upload first to don't miss any added keys.
+
+Parameters:
+
+- `api_token`. Your API token. Can be set up using enviromental parameter `LOKALISE_API_TOKEN`
+- `project_identifier`. Your Project ID. Can be set up using enviromental parameter `LOKALISE_PROJECT_ID`
+- `languages`. Languages to download *(must be passed as array of strings)* Ex. `["en", "ar"]`.
+
+Sample:
+```
+lokalise_download(
+    api_token: "YOUR_API_TOKEN",
+    project_identifier: "YOUR_PROJECT_ID",
+    languages: ["en", "ar"]
+)
+        
+```
+
+## lokalise_upload
+
+This action uploads the new keys from your local strings.xml files to lokalise project.
+
+- `api_token`. Your API token. Can be set up using enviromental parameter `LOKALISE_API_TOKEN`
+- `project_identifier`. Your Project ID. Can be set up using enviromental parameter `LOKALISE_PROJECT_ID`
+- `languages`. Languages to download *(must be passed as array of strings)* Ex. `["en", "ar"]`.
+
+Sample:
+```
+lokalise_upload(
+    api_token: "YOUR_API_TOKEN",
+    project_identifier: "YOUR_PROJECT_ID",
+    languages: ["en", "ar"]
+)
+        
+```
+
+
+_All this actions are the basic ones, and can be enhanced for supporting flavors_

data/Lanes/actions/android/lokalise_download.rb

@@ -0,0 +1,144 @@
+module Fastlane
+  module Actions
+    class LokaliseAction < Action
+      def self.run(params)
+        require 'net/http'
+        require 'json'
+        require 'zip'
+        require 'rubygems'
+
+        token = params[:api_token]
+        project_identifier = params[:project_identifier]
+        destination = params[:destination]
+
+        request_data = {
+            format: "xml",
+            original_filenames: false,
+            bundle_structure: "values-%LANG_ISO%/strings.%FORMAT%",
+            ota_plugin_bundle: 0,
+            export_empty: "base",
+            include_comments: false,
+            replace_breaks: true
+        }
+
+        languages = params[:languages]
+        if languages.kind_of? Array
+          request_data["langs"] = languages.to_json
+        end
+
+        tags = params[:tags]
+        if tags.kind_of? Array
+          request_data["include_tags"] = tags.to_json
+        end
+
+        uri = URI("https://api.lokalise.com/api2/projects/#{project_identifier}/files/download")
+        request = Net::HTTP::Post.new(uri)
+        request["content-type"] = 'application/json'
+        request["x-api-token"] = token
+        request.body = request_data.to_json
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        response = http.request(request)
+
+        jsonResponse = JSON.parse(response.body)
+        UI.error "Bad response 🉐\n#{response.body}" unless jsonResponse.kind_of? Hash
+        if jsonResponse["bundle_url"].kind_of?(String)  then
+          UI.message "Downloading localizations archive 📦"
+          FileUtils.mkdir_p("lokalisetmp")
+          fileURL = jsonResponse["bundle_url"]
+          uri = URI(fileURL)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          zipRequest = Net::HTTP::Get.new(uri)
+          response = http.request(zipRequest)
+          if response.content_type == "application/zip" or response.content_type == "application/octet-stream" then
+            FileUtils.mkdir_p("lokalisetmp")
+            open("lokalisetmp/a.zip", "wb") { |file|
+              file.write(response.body)
+            }
+            unzip_file("lokalisetmp/a.zip", destination)
+            FileUtils.remove_dir("lokalisetmp")
+            UI.success "Localizations extracted to #{destination} 📗 📕 📘"
+          else
+            UI.error "Response did not include ZIP"
+          end
+        elsif jsonResponse["error"]["code"].kind_of?(Integer)
+          code = jsonResponse["error"]["code"]
+          message = jsonResponse["error"]["message"]
+          UI.error "Response error code #{code} (#{message}) 📟"
+        else
+          UI.error "Bad response 🉐\n#{jsonResponse}"
+        end
+      end
+
+
+      def self.unzip_file(file, destination)
+        Zip::File.open(file) { |zip_file|
+          UI.message "Unarchiving localizations to destination 📚"
+          zip_file.each { |f|
+            f_path= File.join(destination, f.name)
+            FileUtils.mkdir_p(File.dirname(f_path))
+            FileUtils.rm(f_path) if File.file? f_path
+            zip_file.extract(f, f_path)
+          }
+        }
+      end
+
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Download Android localization from Lokalise"
+      end
+
+      def self.available_options
+        [
+            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: :destination,
+                                         description: "Localization destination",
+                                         verify_block: proc do |value|
+                                           UI.user_error! "Things are pretty bad" unless (value and not value.empty?)
+                                           UI.user_error! "Directory you passed is in your imagination" unless File.directory?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :languages,
+                                         description: "Languages to download",
+                                         optional: true,
+                                         is_string: false,
+                                         verify_block: proc do |value|
+                                           UI.user_error! "Language codes should be passed as array" unless value.kind_of? Array
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :tags,
+                                         description: "Include only the keys tagged with a given set of tags",
+                                         optional: true,
+                                         is_string: false,
+                                         verify_block: proc do |value|
+                                           UI.user_error! "Tags should be passed as array" unless value.kind_of? Array
+                                         end),
+
+        ]
+      end
+
+      def self.authors
+        "simonkarmy"
+      end
+
+      def self.is_supported?(platform)
+        [:android].include? platform
+      end
+    end
+  end
+end

data/Lanes/actions/android/lokalise_upload.rb

@@ -0,0 +1,98 @@
+module Fastlane
+  module Actions
+    class LokaliseUploadAction < Action
+      def self.run(params)
+        require 'net/http'
+        require 'json'
+        require 'base64'
+
+        token = params[:api_token]
+        project_identifier = params[:project_identifier]
+        languages = params[:languages]
+
+        for lang_code in languages do
+          file_path = (lang_code == "en" ? "./app/src/main/res/values/strings.xml" : "./app/src/main/res/values-#{lang_code}/strings.xml")
+          self.upload_lang(token, project_identifier, lang_code, file_path)
+        end
+      end
+
+      def self.upload_lang(token, project_id, lang_code, lang_file_path)
+
+        file_data = File.open(lang_file_path, "r").read
+        file_data_64 = Base64.encode64(file_data).delete("\n")
+
+        request_data = {
+            filename: "strings.xml",
+            data: file_data_64 ,
+            lang_iso: lang_code,
+            convert_placeholders: true ,
+            slashn_to_linebreak: true
+        }
+
+        uri = URI("https://api.lokalise.com/api2/projects/#{project_id}/files/upload")
+        request = Net::HTTP::Post.new(uri)
+        request["content-type"] = 'application/json'
+        request["x-api-token"] = token
+        request.body = request_data.to_json
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        response = http.request(request)
+
+        jsonResponse = JSON.parse(response.body)
+        UI.error "Bad response 🉐\n#{response.body}" unless jsonResponse.kind_of? Hash
+        if jsonResponse["project_id"].kind_of?(String)  then
+          UI.message "Uploaded localization file for #{lang_code} successfully #{jsonResponse["result"]}"
+        elsif jsonResponse["error"]["code"].kind_of?(Integer)
+          code = jsonResponse["error"]["code"]
+          message = jsonResponse["error"]["message"]
+          UI.error "Response error code #{code} (#{message}) 📟"
+        else
+          UI.error "Bad response 🉐\n#{jsonResponse}"
+        end
+      end
+
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Upload Android strings.xml to Lokalise"
+      end
+
+      def self.available_options
+        [
+            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: :languages,
+                                         description: "Languages to download",
+                                         optional: true,
+                                         is_string: false,
+                                         verify_block: proc do |value|
+                                           UI.user_error! "Language codes should be passed as array" unless value.kind_of? Array
+                                         end),
+
+        ]
+      end
+
+      def self.authors
+        "simonkarmy"
+      end
+
+      def self.is_supported?(platform)
+        [:android].include? platform
+      end
+    end
+  end
+end