ad_localize 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a46683de0e489838b53aae0ddd3a4e7e52a0089013fac5b49a07a558bfd322
-  data.tar.gz: 11523ebff556f015ae9e0a7ec76bf50f75d9317b9fd272e2f0b28e84ae0a070d
+  metadata.gz: e814ce7a840c1c9da11fc1f34574929e7ad4805f410319b3c6f79e8f8027024e
+  data.tar.gz: 65864cb313e53121a7d9fc06028f944853f3842ee3eb060b7ccdff099b3477a2
 SHA512:
-  metadata.gz: 7432f6a5dd72d4635b3c07215ffb2d7afe357a5f93aca0d04635c20c15494571d580af9572ce38b0805afb1762d714dc73ef71ae8f5bd855ebfdfb8dbe9eef0d
-  data.tar.gz: 5e726801cb6f26bf2c58787297a1e0639cd403f7d9d22c3a8ce82d04fb65a8e3d8cd3b6a94cf1057f9d0b32ebcab9d79ba00867f50d3add3815cd450b945b097
+  metadata.gz: f84b9f8ef16b073e98c4e41a87575e35c5881586e1bebe44c226005bbdcf3b9704bc6b869ae4cb6fb4162866560a2e6c69e154b505b058f6923d852093ba1624
+  data.tar.gz: 02fe755026fad1ef4bca910a6457ef7d2806b40077fe3acbfc4d7b469372b7382bb7c98098c3220d6fc977cef40255e2c3cf85cc8f927cc1b3f78d9bf7ff31b7

data/.github/workflows/ruby.yml

@@ -1,6 +1,6 @@
 name: Ruby
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:

data/.gitignore

@@ -9,4 +9,5 @@ ad_localize/tmp/
 .idea
 .byebug_history
 .ruby-version
-
+pkg/
+exports/

data/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.5.0] - 2020-05-12
+### Added
+  - add support for private spreadsheet using google service acccount by [@sjcqs](https://github.com/sjcqs). Fixes [#31](https://github.com/applidium/ad_localize/issues/31)
+  - add makefile for easier testing by [@felginep](https://github.com/felginep)
+
+### Changed
+  - improve error message to have useful information in case of google spreadsheet use by [@felginep](https://github.com/felginep). Fixes [#27](https://github.com/applidium/ad_localize/issues/27)
+  - platform folder is no longer generated when there is only one platform selected. The files are directly generated in the output path. By [@felginep](https://github.com/felginep). Fixes [#29](https://github.com/applidium/ad_localize/issues/29)
+  - raise error when google spreadsheet key is invalid by [@felginep](https://github.com/felginep)
+
+### Fixed
+  - auto escape strings in Localizable.strings by [@felginep](https://github.com/felginep). Fixes [#26](https://github.com/applidium/ad_localize/issues/26)
+  - trim keys to prevent user error by [@felginep](https://github.com/felginep). Fixes [#16](https://github.com/applidium/ad_localize/issues/16)
+
 ## [3.4.0] - 2019-02-10
 ### Added
   - Rails folks, [@epaillous](https://github.com/epaillous) has improved the YAML support. You can now have multi-level wording.

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    ad_localize (3.4.0)
+      activesupport (>= 4.2.10)
+      colorize (~> 0.8)
+      googleauth (~> 0.12.0)
+      nokogiri (~> 1.8, >= 1.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.6)
+    diffy (3.3.0)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    googleauth (0.12.0)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jwt (2.1.0)
+    memoist (0.16.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_json (1.14.1)
+    multipart-post (2.0.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    os (1.1.0)
+    public_suffix (2.0.5)
+    rake (12.3.3)
+    ruby-progressbar (1.10.1)
+    signet (0.14.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ad_localize!
+  bundler (>= 1.12.0, < 3.0.0)
+  byebug (~> 11.0)
+  diffy (~> 3.3)
+  minitest (~> 5.11)
+  minitest-reporters (~> 1.3)
+  rake (~> 12.3)
+
+BUNDLED WITH
+   2.1.4

data/Makefile

@@ -0,0 +1,11 @@
+build:
+	gem build ad_localize.gemspec
+
+install: clean build
+	gem install ad_localize-*.gem
+
+clean:
+	rm -f ad_localize-*.gem
+
+tests:
+	bundle exec rake test

data/README.md

@@ -29,15 +29,22 @@ $ gem install ad_localize
 $ bundle exec ad_localize -h
 ```
 
-* Export wording from a google drive spreadsheet, using the file key
+* Export wording from a google spreadsheet, using the file key. Make sure to enable _Allow external access_ in sharing options.
 ```
 $ bundle exec ad_localize -k <your-spreadsheet-drive-key>
 ```
-* Export wording from a google drive spreadsheet, using the file key and specifying a sheet (useful when your file has multiple sheets)
+
+* Export wording from a google spreadsheet, using the file key and specifying a sheet (useful when your file has multiple sheets)
 ```
 $ bundle exec ad_localize -k <your-spreadsheet-drive-key> -s <your-specific-sheet-id>
 ```
 
+* Export wording from a private google spreadsheet using an authorized google account
+```
+$ export GCLOUD_CLIENT_SECRET=$(cat <client-secret.json>)
+$ bundle exec ad_localize -k <your-spreadsheet-drive-key> -a
+```
+
 * Only generate wording files for the specified platforms
 ```
 $ bundle exec ad_localize -o ios
@@ -62,10 +69,11 @@ $ bundle exec ad_localize -d
 | favorites | Mes favoris | My favorites |
 | from_to | du %1$@ au %2$@ | from %1$@ to %2$@ |
 
-- Any column after the `key` column will be considered as a locale column (except from the optional `comment columns) 
+- Any column after the `key` column will be considered as a locale column (except from the optional `comment columns)
 - Keys should be written in Android format : [a-z0-9_]+
 - Format specifiers must be numeroted if there are more than one in a translation string (eg: "%1$@ %2$@'s report").
 
+
 #### Comment columns
 
 In iOS (and only iOS) you can add a comment to a missing translation.
@@ -111,6 +119,8 @@ exports/
     └── fr.yml
 ```
 
+NB: If you select only one platform, the wording files will directly be generated in the output path. The output path is the `exports` folder in the current directory by default and you can change it using the option `-o`.
+
 ## Plurals
 
 Plurals are supported for iOS and Android.

data/ad_localize.gemspec

@@ -19,14 +19,16 @@ Gem::Specification.new do |spec|
     'Nicolas Braun',
     'Corentin Huard',
     'Claire Peyron',
-    'Claire Dufetrelle'
+    'Claire Dufetrelle',
+    'Pierre Felgines',
+    'Satyan Jacquens'
   ]
   spec.email         = %w(joanna.vigne@fabernovel.com hugo.hache@fabernovel.com edouard.siegel@fabernovel.com)
 
   spec.summary       = %q{AdLocalize helps with mobile and web applications wording}
   spec.description   = %q{AdLocalize produces localization files from platform agnostic wording.
                           Supported wording format : CSV. Supported export format: iOS, Android, JSON and YAML}
-  spec.homepage      = 'https://technologies.fabernovel.com'
+  spec.homepage      = 'https://github.com/applidium/ad_localize'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -44,9 +46,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest-reporters', '~> 1.3'
   spec.add_development_dependency 'diffy', '~> 3.3'
 
-  spec.add_dependency 'activesupport', '>= 4.2.10'
-  spec.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'
+  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'googleauth', '~> 0.12'
 
   spec.required_ruby_version     = '~> 2.3'
 end

data/lib/ad_localize.rb

@@ -8,6 +8,8 @@ require 'csv'
 require 'logger'
 require 'colorize'
 require 'open-uri'
+require 'stringio'
+require 'googleauth'
 require 'optparse'
 require 'nokogiri'
 

data/lib/ad_localize/csv_file_manager.rb

@@ -8,13 +8,20 @@ module AdLocalize
       end
 
       # Returns the downloaded file name (it is located in the current directory)
-      def download_from_drive(key, sheet)
+      def download_from_drive(key, sheet, use_service_account=false)
         LOGGER.log(:info, :green, "Downloading file from google drive...")
         download_string_path = "./#{key}.csv"
         begin
           File.open(download_string_path, "wb") do |saved_file|
+            download_url = drive_download_url(key, sheet)
+            headers = {}
+            if use_service_account
+              LOGGER.log(:debug, :green, "Using a service account...")
+              token = service_account_access_token()
+              headers["Authorization"] = "#{token["token_type"]} #{token["access_token"]}"
+            end
             # the following "open" is provided by open-uri
-            open(drive_download_url(key, sheet), "rb") do |read_file|
+            open(download_url, "rb", headers) do |read_file|
               saved_file.write(read_file.read)
             end
             File.basename saved_file
@@ -42,6 +49,16 @@ module AdLocalize
         query_id = sheet ? "gid=#{sheet}" : "id=#{key}"
         "https://docs.google.com/spreadsheets/d/#{key}/export?format=csv&#{query_id}"
       end
+      private
+      def service_account_access_token()
+          scope = "https://www.googleapis.com/auth/drive.readonly"
+          json_key_io = StringIO.new ENV["GCLOUD_CLIENT_SECRET"]
+          authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
+            json_key_io: json_key_io,
+            scope: scope
+          )
+         authorizer.fetch_access_token!
+      end
     end
   end
 end

data/lib/ad_localize/csv_parser.rb

@@ -99,7 +99,7 @@ module AdLocalize
     end
 
     def parse_key(row)
-      key = row.field(CSV_WORDING_KEYS_COLUMN)
+      key = row.field(CSV_WORDING_KEYS_COLUMN).strip
       plural_prefix = key.match(PLURAL_KEY_REGEXP)
       plural_identifier = nil
       invalid_plural = false

data/lib/ad_localize/option_handler.rb

@@ -20,11 +20,15 @@ module AdLocalize
           end
           opts.on("-k", "--drive-key #{GOOGLE_DRIVE_DOCUMENT_ID.dig(:length)}_characters", String, "Use google drive spreadsheets") do |key|
             is_valid_drive_key = !!(key =~ GOOGLE_DRIVE_DOCUMENT_ID.dig(:regexp)) && (key.size >= GOOGLE_DRIVE_DOCUMENT_ID.dig(:length))
-            args[:drive_key] = is_valid_drive_key ? key : nil
+            raise ArgumentError.new("Invalid google drive spreadsheet key \"#{key}\"") unless is_valid_drive_key
+            args[:drive_key] = key
           end
           opts.on("-s", "--drive-sheet SHEET_ID", String, "Use a specific sheet id for Google Drive spreadsheets with several sheets") do |value|
             args[:sheet_id] = value
           end
+          opts.on("-a", "--use-service-account", "Use a Google Cloud Service Account to access the file. An GCLOUD_CLIENT_SECRET environment variable containting the client_secret.json content is needed.") do
+            args[:use_service_account] = true
+          end
           opts.on("-o", "--only platform1,platform2", Array, "Only generate localisation files for the specified platforms. Supported platforms : #{Constant::SUPPORTED_PLATFORMS.join(', ')}") do |platforms|
             args[:only] = filter_option_args("-o", platforms) { |platform| !!Constant::SUPPORTED_PLATFORMS.index(platform) }
           end
@@ -44,6 +48,7 @@ module AdLocalize
           LOGGER.log(:error, :red, "Missing argument for option #{e.args.join(',')}")
         rescue ArgumentError => e
           LOGGER.log(:error, :red, e.message)
+          raise e
         end
         args
       end

data/lib/ad_localize/platform/ios_formatter.rb

@@ -90,11 +90,16 @@ module AdLocalize::Platform
 
     private
 
+    def escape_quotes_if_needed(value)
+      value.gsub(/(?<!\\)\"/, "\\\"") # match " unless there is a \ before
+    end
+
     def write_localizable(locale:, singulars:, wording_type:, filename:)
       locale = locale.to_sym
 
       singulars.each do |key, locales_wording|
         value = locales_wording.dig(locale, wording_type)
+        value = escape_quotes_if_needed(value)
         comment = locales_wording.dig(locale, AdLocalize::Constant::COMMENT_KEY_SYMBOL)
         export_dir(locale).join(filename).open("a") do |file|
           line = ""

data/lib/ad_localize/platform/platform_formatter.rb

@@ -5,12 +5,13 @@ module AdLocalize::Platform
     OPTIONS = {output_path: ".."}
 
     attr_accessor :platform_dir
-    attr_reader :default_locale, :output_path
+    attr_reader :default_locale, :output_path, :add_intermediate_platform_dir
 
-    def initialize(default_locale, output_path)
+    def initialize(default_locale, output_path, add_intermediate_platform_dir)
       @default_locale = default_locale.to_sym
       @output_path = output_path # Must be set before platform_dir
-      @platform_dir = export_base_directory.join(platform.to_s)
+      @platform_dir = add_intermediate_platform_dir ? export_base_directory.join(platform.to_s) : export_base_directory
+      @add_intermediate_platform_dir = add_intermediate_platform_dir
       create_platform_dir
     end
 
@@ -52,7 +53,7 @@ module AdLocalize::Platform
     end
 
     def create_platform_dir
-      if platform_dir.directory?
+      if platform_dir.directory? && add_intermediate_platform_dir
         FileUtils.rm_rf("#{platform_dir}/.", secure: true)
       else
         platform_dir.mkpath

data/lib/ad_localize/runner.rb

@@ -15,10 +15,14 @@ module AdLocalize
         file_to_parse = args.first
         LOGGER.log(:warn, :yellow, "Only one CSV can be treated - the priority goes to #{file_to_parse}") if input_files.length > 1
         if args.empty?
-          options[:drive_file] = CsvFileManager.download_from_drive(options.dig(:drive_key), options.dig(:sheet_id))
+          options[:drive_file] = CsvFileManager.download_from_drive(options.dig(:drive_key), options.dig(:sheet_id), options.dig(:use_service_account))
           file_to_parse = options.dig(:drive_file)
         end
-        CsvFileManager.csv?(file_to_parse) ? export(file_to_parse) : LOGGER.log(:error, :red, "#{file_to_parse} is not a csv")
+        if CsvFileManager.csv?(file_to_parse)
+          export(file_to_parse)
+        else
+          LOGGER.log(:error, :red, "#{file_to_parse} is not a csv. Make sure to enable \"Allow external access\" in sharing options.")
+        end
         CsvFileManager.delete_drive_file(options[:drive_file]) if options[:drive_file]
       end
     end
@@ -34,8 +38,13 @@ module AdLocalize
         LOGGER.log(:error, :red, "No data were found in the file - check if there is a key column in the file")
       else
         export_platforms = options.dig(:only) || Constant::SUPPORTED_PLATFORMS
+        add_intermediate_platform_dir = export_platforms.length > 1
         export_platforms.each do |platform|
-          platform_formatter = "AdLocalize::Platform::#{platform.to_s.camelize}Formatter".constantize.new(parser.locales.first, options.dig(:output_path))
+          platform_formatter = "AdLocalize::Platform::#{platform.to_s.camelize}Formatter".constantize.new(
+            parser.locales.first,
+            options.dig(:output_path),
+            add_intermediate_platform_dir
+          )
           parser.locales.each do |locale|
             platform_formatter.export(locale, data)
           end

data/lib/ad_localize/version.rb

@@ -1,3 +1,3 @@
 module AdLocalize
-  VERSION = "3.4.0"
+  VERSION = "3.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ad_localize
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Edouard Siegel
@@ -15,6 +15,8 @@ authors:
 - Corentin Huard
 - Claire Peyron
 - Claire Dufetrelle
+- Pierre Felgines
+- Satyan Jacquens
 autorequire: 
 bindir: exe
 cert_chain: []
@@ -114,36 +116,30 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +154,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 description: |-
   AdLocalize produces localization files from platform agnostic wording.
                             Supported wording format : CSV. Supported export format: iOS, Android, JSON and YAML
@@ -176,7 +186,9 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - ad_localize.gemspec
@@ -197,7 +209,7 @@ files:
 - lib/ad_localize/platform/yml_formatter.rb
 - lib/ad_localize/runner.rb
 - lib/ad_localize/version.rb
-homepage: https://technologies.fabernovel.com
+homepage: https://github.com/applidium/ad_localize
 licenses:
 - MIT
 metadata: {}