poeditor-pull 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0f1ce426ca44d45275e5dfea07c7196dd55e65b
+  data.tar.gz: 9b72ddf1d38c7ba1b3862a7edf9552ebc2921a03
+SHA512:
+  metadata.gz: f98cb2d867e2982a0047c5e0b60b42a989d325a3373f025945527654528b19a4933351e73e9caf396b0bc33ff647707212dc5ab8f0a67879460328e16c07ad7c
+  data.tar.gz: b4a9c22b645bd2af056b483e61d79f233ea9e665bc517c13c3e7e8265add5641a053b704d1599683143efc65ea30e33eaad48c5f779d04b9087100b58b44f3ee

data/CHANGELOG

@@ -0,0 +1,10 @@
+This tool has been forked from https://github.com/StyleShare/poeditor-cli (v.0.5.0) and adjusted.
+
+List of changes introduced to source codebase:
+
+1. Changed format of input config file: YAML -> JSON
+2. Added: creating missing directory structures on the fly in case new translations appear while pulling
+3. Added: logic filtering out languages with no translations
+4. Added: support for project main dir definition and relative translations paths in config
+5. Added: formatting paths with target/flavor name based on {TARGET_NAME} as parameter.
+6. Implemented language-region combination support [Android] and Chinese language coding support

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Suyeol Jeon (xoul.kr)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+POEditor scripts have been provided in order to speed up process of pulling new translations into mobile projects.
+They are written in Ruby, support both mobile platforms: Android, iOS and are intendend to be shared across them.
+
+There are 2 ways to use provided functionality:
+
+1. Instantiating `PullCommand` class instance directly in your Ruby code and calling its methods accordingly to API.
+2. Installing Ruby gem: `[sudo] gem install poeditor-pull` and calling `poeditor-pull` from command line with arguments and treating it as a black box with no need to write any line in Ruby to take advantage of it. 
+
+Both ways require preparing and providing POEditor config JSON file that defines project setup as shown in the example below:
+
+```json
+{
+  "api_key": "$POEDITOR_API_KEY",
+  "project_id": 11111,
+  "type": "android_strings",
+  "languages": [
+    "en-us",
+    "en-gb",
+    "es",
+    "pt-Br"
+  ],
+  "filters": [
+    "translated"
+  ],
+  "path": "path/to/your/project/src/main/res/values-{LANGUAGE}/po_strings.xml",
+  "path_replace": {
+    "en-us": "path/to/your/project/src/main/res/values/po_strings.xml"
+  }
+}
+```
+
+`"api_key"` can be defined directly in JSON or defined as environment variable: `POEDITOR_API_KEY`
+
+`"path"` and `"path_replace"` paths can be defined as both: absolute and relative. If they are relative
+you also need to define project main directory while initializing `PullCommand` class or calling
+`poeditor-pull` script with `-p` parameter.
+
+```
+Usage: poeditor-pull [options]
+    -c, --config-path CONFIG_PATH          Path to your POEditor JSON config
+    -p, --project-path PROJECT_PATH        Path to your project's main directory [optional]
+```
+
+JSON supports defitions based on POEDitor v2 API like: `type, tags, filters` etc. For further information regarding that visit:
+https://poeditor.com/docs/api and https://github.com/StyleShare/poeditor-cli (keep in mind YAML -> JSON change)
+
+As it's stated in `CHANGELOG` - scripts are based on POEditor Ruby CLI tool: https://github.com/StyleShare/poeditor-cli
+and support everything what's supported in v.0.5.0. In addition to that there were new functionalites implemented.
+For more information regarding introduced adjustments please review `CHANGELOG` file.

data/bin/poeditor-pull

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+# If path to project main directory is missing then paths in JSON config are considered to be absolute
+# and are used directly. In other case target path is a result of concatenation of project main dir path
+# and relative paths in JSON config.
+
+require 'fileutils'
+require 'optparse'
+require 'PullCommand'
+require 'UI'
+require 'Version'
+
+include POEditor
+
+options = {}
+OptionParser.new do |parser|
+  parser.on_tail('-v', '--version', 'Show version') do
+    puts POEditor::VERSION
+    exit
+  end
+  parser.on('-c', '--config-path=CONFIG_PATH',
+  'Path to POEditor JSON config') do
+    |v| options[:config_path] = v
+  end
+  parser.on('-p', '--project-path=PROJECT_PATH',
+  'Path to project main directory [optional]') do
+    |v| options[:project_path] = v
+  end
+end.parse!
+
+json_config_path = options[:config_path]
+project_path = options[:project_path]
+if project_path == nil
+  project_path = ""
+end
+if json_config_path.nil? || json_config_path.empty?
+  abort("Path to POEditor JSON config is required to be non-empty.")
+end
+
+UI.enabled = true
+poEditor_pull_command = PullCommand.new(project_path)
+poEditor_pull_command.run_from_path(json_config_path)

data/lib/Configuration.rb

@@ -0,0 +1,56 @@
+module POEditor
+  class Configuration
+    # @return [String] POEditor API key
+    # @see https://poeditor.com/account/api POEditor API Access
+    attr_accessor :api_key
+
+    # @return [String] POEditor project ID
+    attr_accessor :project_id
+
+    # @return [String] Export file type (po, apple_strings, android_strings)
+    attr_accessor :type
+
+    # @return [Array<String>] Tag filters (optional)
+    attr_accessor :tags
+
+    # @return [Array<String>] Filters by 'translated', 'untranslated', 'fuzzy', 'not_fuzzy', 'automatic', 'not_automatic', 'proofread', 'not_proofread' (optional)
+    attr_accessor :filters
+
+    # @return [Array<String>] The languages codes
+    attr_accessor :languages
+
+    # @return [Hash{Sting => String}] The languages aliases
+    attr_accessor :language_alias
+
+    # @return [String] The path template
+    attr_accessor :path
+
+    # @return [Hash{Sting => String}] The path replacements
+    attr_accessor :path_replace
+
+    def initialize(api_key:, project_id:, type:, tags:nil,
+                   filters:nil, languages:, language_alias:nil,
+                   path:, path_replace:nil)
+      @api_key = from_env(api_key)
+      @project_id = from_env(project_id.to_s)
+      @type = type
+      @tags = tags || []
+      @filters = filters || []
+
+      @languages = languages
+      @language_alias = language_alias || {}
+
+      @path = path
+      @path_replace = path_replace || {}
+    end
+
+    def from_env(value)
+      if value.start_with?("$")
+        key = value[1..-1]
+        ENV[key]
+      else
+        value
+      end
+    end
+  end
+end

data/lib/Core.rb

@@ -0,0 +1,140 @@
+require "json"
+require "net/http"
+require 'fileutils'
+require 'colorize'
+
+module POEditor
+  class Core
+
+    POEDITOR_BASE_URL = "https://api.poeditor.com/v2/"
+
+    # @return [POEditor::Configuration] The configuration for export
+    attr_accessor :configuration
+
+    # @param configuration [POEditor::Configuration]
+    def initialize(configuration)
+      unless configuration.is_a? Configuration
+        raise POEditor::Exception.new \
+          "`configuration` should be an `Configuration`"
+      end
+      @configuration = configuration
+    end
+
+    # Request POEditor API
+    #
+    # @param action [String]
+    # @param api_token [String]
+    # @param options [Hash{Sting => Object}]
+    #
+    # @return [Net::HTTPResponse] The response object of API request
+    #
+    # @see https://poeditor.com/api_reference/ POEditor API Reference
+    def api(action, api_token, options={})
+      uri = URI(POEDITOR_BASE_URL + "#{action}")
+      options["api_token"] = api_token
+      return Net::HTTP.post_form(uri, options)
+    end
+
+    # Pull translations
+    def pull()
+      UI.puts "\nExport translations"
+      for language in @configuration.languages
+        UI.puts "  - Exporting '#{language}'"
+        content = self.export(:api_key => @configuration.api_key,
+                              :project_id => @configuration.project_id,
+                              :language => language,
+                              :type => @configuration.type,
+                              :tags => @configuration.tags,
+                              :filters => @configuration.filters)
+        write(language, content)
+
+        for alias_to, alias_from in @configuration.language_alias
+          if language == alias_from
+            write(alias_to, content)
+          end
+        end
+      end
+    end
+
+    # Export translation for specific language
+    #
+    # @param api_key [String]
+    # @param project_jd [String]
+    # @param language [String]
+    # @param type [String]
+    # @param tags [Array<String>]
+    # @param filters [Array<String>]
+    #
+    # @return Downloaded translation content
+    def export(api_key:, project_id:, language:, type:, tags:nil, filters:nil)
+      options = {
+        "id" => project_id,
+        "language" => convert_to_poeditor_language(language),
+        "type" => type,
+        "tags" => (tags || []).join(","),
+        "filters" => (filters || []).join(","),
+      }
+      response = self.api("projects/export", api_key, options)
+      data = JSON(response.body)
+      unless data["response"]["status"] == "success"
+        code = data["response"]["code"]
+        message = data["response"]["message"]
+        raise POEditor::Exception.new "#{message} (#{code})"
+      end
+
+      download_uri = URI(data["result"]["url"])
+      content = Net::HTTP.get(download_uri)
+
+      case type
+      when "apple_strings"
+        content.gsub!(/(%(\d+\$)?)s/, '\1@')  # %s -> %@
+      when "android_strings"
+        content.gsub!(/(%(\d+\$)?)@/, '\1s')  # %@ -> %s
+      end
+
+      unless content.end_with? "\n"
+        content += "\n"
+      end
+      return content
+    end
+
+    def convert_to_poeditor_language(language)
+      language = language.downcase
+      android_region_language_regexp =  /(?<=[a-z]{2}-)[r](?=[a-z]{2})/i
+      chinese_regions_regexp = /(zh-)\K(hans|hant)/i
+      if language =~ android_region_language_regexp
+        return language.gsub(android_region_language_regexp, "")
+      elsif language =~ chinese_regions_regexp
+        return language.gsub(chinese_regions_regexp, {'hans' => 'cn', 'hant' => 'tw'})
+      end
+      language
+    end
+
+    # Write translation file
+    def write(language, content)
+      if content.to_s.strip.empty?
+        UI.puts "      #{"\xe2\x9c\x95".red} Ignoring language: #{language} because there are no any translations."
+        return
+      end
+      path = path_for_language(language)
+      if path.to_s.empty?
+        raise POEditor::Exception.new "#{path} doesn't exist"
+      end
+      dirname = File.dirname(path)
+      unless File.directory?(dirname)
+        FileUtils.mkdir_p(dirname)
+      end
+      File.write(path, content)
+      UI.puts "      #{"\xe2\x9c\x93".green} Saved at '#{path}'"
+    end
+
+    def path_for_language(language)
+      if @configuration.path_replace[language]
+        @configuration.path_replace[language]
+      else
+        @configuration.path.gsub("{LANGUAGE}", language)
+      end
+    end
+
+  end
+end

data/lib/Exception.rb

@@ -0,0 +1,4 @@
+module POEditor
+  class Exception < Exception
+  end
+end

data/lib/PullCommand.rb

@@ -0,0 +1,108 @@
+require_relative 'UI'
+require_relative 'Core'
+require_relative 'Configuration'
+require_relative 'Exception'
+
+module POEditor
+  class PullCommand
+
+    # @param project_path [String] Path of project main directory [optional] -
+    #                              if present then target paths would be created
+    #                              by concatenating it with paths in JSON config
+    #
+    def initialize(project_path = "")
+      @project_path = project_path
+    end
+
+    # Pulls POEditor translations based on passed POEditor JSON config and target name
+    #
+    # @param config [JSON] POEditor JSON config
+    #
+    # @param target_name [String] Target name for translations [optional] -
+    #                             if absent paths would not be parameterized
+    #
+    def run(config, target_name = "")
+      pull_translations(create_configuration(config, target_name))
+    end
+
+    # Pulls POEditor translations based on POEditor JSON config read
+    # from passed path and target name
+    #
+    # @param config_path [String] Path to POEditor config
+    #
+    # @param target_name [String] Target name for translations [optional] -
+    #                             if absent paths would not be parameterized
+    #
+    def run_from_path(config_path, target_name = "")
+      pull_translations(get_configuration(config_path, target_name))
+    end
+
+    private
+
+    # Pulls POEditor translations based on configuration
+    #
+    # @param configuration [Configuration] Configuration object
+    #
+    def pull_translations(configuration)
+      client = POEditor::Core.new(configuration)
+      client.pull()
+    end
+
+    # Returns {#POEditor::Configuration} based on POEditor JSON config and target name
+    #
+    # @param config_path [String] Path to POEditor config
+    #
+    # @param target_name [String] Target name for translations
+    #
+    # @return [POEditor::Configuration] The export configuration
+    def get_configuration(config_path, target_name)
+      UI.puts "Reading configuration"
+      unless File.exist?(config_path)
+        raise POEditor::Exception.new %{\
+Configuration file doesn't exist: #{config_path}.
+    Specify the path using '--config'.\
+        }
+      end
+      json_config = JSON(File.read(config_path))
+      create_configuration(json_config, target_name)
+    end
+
+    def create_configuration(json_config, target_name)
+      translations_path = File.join(@project_path, path_for_target(get_or_raise(json_config, "path"), target_name))
+      path_replace_array = json_config["path_replace"]
+      if path_replace_array != nil
+        path_replace_array.each { |language, language_filepath| path_replace_array[language] = File.join(@project_path,
+                                                                                                         path_for_target(language_filepath, target_name)) }
+      end
+      Configuration.new(
+        api_key: get_or_raise(json_config, "api_key"),
+        project_id: get_or_raise(json_config, "project_id"),
+        type: get_or_raise(json_config, "type"),
+        tags: json_config["tags"],
+        filters: json_config["filters"],
+        languages: get_or_raise(json_config, "languages"),
+        language_alias: json_config["language_alias"],
+        path: translations_path,
+        path_replace: path_replace_array,
+      )
+    end
+
+    # Returns the value of specified key from the given json instance. Raise
+    # exception when there's no key in the json.
+    #
+    # @param json_config [JSON]
+    # @param key [String]
+    #
+    # @return The value for the specified key from json
+    # @raise [POEditor::Exception]
+    def get_or_raise(json_config, key)
+      json_config[key] or raise POEditor::Exception.new \
+        "Missing configuration key: '#{key}'"
+    end
+
+    def path_for_target(path, target_name)
+      path.gsub("{TARGET_NAME}", target_name)
+    end
+
+  end
+end

data/lib/UI.rb

@@ -0,0 +1,17 @@
+module POEditor
+  class UI
+    @@enabled = false
+
+    def self.enabled
+      @@enabled
+    end
+
+    def self.enabled=enabled
+      @@enabled = enabled
+    end
+
+    def self.puts(*args)
+      Kernel.puts args.map { |x| x.to_s }.join(" ") if @@enabled
+    end
+  end
+end

data/lib/Version.rb

@@ -0,0 +1,3 @@
+module POEditor
+  VERSION = "1.0.3"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: poeditor-pull
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Suyeol Jeon
+- Konrad Stanik - Viacom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: This is a command line tool for pulling translations from POEditor.
+email: 
+executables:
+- poeditor-pull
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- LICENSE
+- README.md
+- bin/poeditor-pull
+- lib/Configuration.rb
+- lib/Core.rb
+- lib/Exception.rb
+- lib/PullCommand.rb
+- lib/UI.rb
+- lib/Version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: POEditor Pull CLI
+test_files: []