poeditor-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3981c762a561c1d20ae5e66b5f200f00a2e3e6b
+  data.tar.gz: adfdd3ff5b171bc1d4098af35299e87d677bb086
+SHA512:
+  metadata.gz: 21c12379f59d9d8bfd10c4f56e5f22c6c230906cf9053d0ab358247ed46db22ef3d2d088623ebd35ccb249f20f8d8e5ad903811f374f96bcc8435b3af8ad3bfd
+  data.tar.gz: 8cd8959d0dec9bd5e33b962ecb493fe75d936df16eac5bda2d9dff3e41afdb624e7bbd24781986c1dc8d69d39a23b4af89072c7529702a22118f06ad63f9310e

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,50 @@
+# poeditor-cli
+
+[![Gem](https://img.shields.io/gem/v/cocoaseeds.svg)](https://rubygems.org/gems/cocoaseeds)
+[![Build Status](https://travis-ci.org/StyleShare/poeditor-cli.svg?branch=master)](https://travis-ci.org/StyleShare/poeditor-cli)
+
+Command line application for [POEditor](https://poeditor.com).
+
+<img width="682" alt="poeditor-cli" src="https://cloud.githubusercontent.com/assets/931655/22509884/2aebebc2-e8d3-11e6-86e2-a9915ca755b5.png">
+
+## Usage
+
+1. **Create `poeditor.yml` file**
+
+    Here is an example.
+
+    ```yaml
+    api_key: YOUR_API_KEY
+    project_id: PROJECT_ID
+    languages: [en, ko, jp, zh-Hans, zh-Hant, fr, es]
+    path: example/Resources/{LANGUAGE}.lproj/Localizable.strings
+    type: apple_strings
+    tags: [ios]  # optional
+    ```
+
+    | Field | Description |
+    |---|---|
+    | `api_key` | Your POEditor API key. You can check it on [POEditor API Access](https://poeditor.com/account/api). |
+    | `project_id` | POEditor project ID. You can check this value on the web browser's address bar.<br />For example: `https://poeditor.com/projects/view?id=XXXXX` |
+    | `languages` | Language codes to export. Use your project's language code.<br />For example, use `zh-Hans` if you're working on Xcode project even though POEditor uses `zh-CN` for simplified chinese. |
+    | `path` | The path for translation files to be downloaded. Each values of `languages` will be used for filling `{LANGUAGE}` placeholder. |
+    | `type` | Translation file format. (po, pot, mo, xls, csv, resw, resx, android_strings, apple_strings, xliff, properties, key_value_json, json, xmb, xtb) |
+    | `tags` | (Optional) Terms which contain whole tags will be exported. (`&&`) |
+
+2. **Export using CLI**
+
+    ```console
+    $ poeditor export
+    ```
+
+3. **You're done! 🎉**
+
+## Installation
+
+```console
+$ [sudo] gem install poeditor-cli
+```
+
+## License
+
+**poeditor-cli** is written by [Suyeol Jeon](https://github.com/devxoul) and available under MIT license.

data/bin/poeditor

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "poeditor"
+
+POEditor::Command.run(ARGV)

data/lib/poeditor.rb

@@ -0,0 +1,23 @@
+require "colorize"
+require "fileutils"
+require "shellwords"
+require "yaml"
+
+module POEditor
+  autoload :Version,   "poeditor/version"
+  autoload :Exception, "poeditor/exception"
+  autoload :UI,        "poeditor/ui"
+
+  # core
+  autoload :Exporter,   "poeditor/core/exporter"
+  autoload :Formatter,  "poeditor/core/formatter"
+
+  # command
+  autoload :Command,        "poeditor/commands/command"
+  autoload :ExportCommand,  "poeditor/commands/export_command"
+  autoload :HelpCommand,    "poeditor/commands/help_command"
+  autoload :VersionCommand, "poeditor/commands/version_command"
+
+  # configuration
+  autoload :ExportConfiguration, "poeditor/configurations/export_configuration"
+end

data/lib/poeditor/commands/command.rb

@@ -0,0 +1,25 @@
+module POEditor
+  class Command
+    # The entry point of the CLI application
+    def self.run(argv)
+      UI.enabled = true
+      command = self.command_class(argv).new
+      begin
+        command.run(argv)
+      rescue POEditor::Exception => e
+        puts "[!] #{e.message}".red
+      end
+    end
+
+    def self.command_class(argv)
+      case argv[0]
+      when "export"
+        ExportCommand
+      when "--version"
+        VersionCommand
+      else
+        HelpCommand
+      end
+    end
+  end
+end

data/lib/poeditor/commands/export_command.rb

@@ -0,0 +1,64 @@
+module POEditor
+  class ExportCommand
+    def run(argv)
+      UI.puts "Reading configuration"
+      configuration = get_configuration(argv)
+      UI.puts configuration
+      exporter = POEditor::Exporter.new(configuration)
+      exporter.export_all()
+    end
+
+    # Detects and returns the location of `poeditor.yml` file from the given
+    # system arguments.
+    #
+    # @param argv [Array<String>] System arguments
+    #
+    # @return [String] The detected path of `poeditor.yml` file
+    def get_configuration_file_path(argv)
+      config_index = argv.index("-c") or argv.index("--config")
+      if config_index
+        config_path = argv[config_index + 1]
+      else
+        config_path = "poeditor.yml"
+      end
+    end
+
+    # Returns {#POEditor::ExportConfiguration} from the given system arguments.
+    #
+    # @param argv [Array<String>] System arguments
+    #
+    # @return [POEditor::ExportConfiguration] The export configuration
+    def get_configuration(argv)
+      config_path = get_configuration_file_path(argv)
+      unless File.exist?(config_path)
+        raise POEditor::Exception.new %{\
+Configuration file doesn't exist: #{config_path}.
+    Try creating `poeditor.yml` or specifying the path using '--config'.\
+        }
+      end
+      yaml = YAML.load(File.read(config_path))
+      ExportConfiguration.new(
+        api_key: get_or_raise(yaml, "api_key"),
+        project_id: get_or_raise(yaml, "project_id"),
+        languages: get_or_raise(yaml, "languages"),
+        type: get_or_raise(yaml, "type"),
+        tags: yaml["tags"],
+        path: get_or_raise(yaml, "path"),
+      )
+    end
+
+    # Returns the value of specified key from the given yaml instance. Raise
+    # exception when there's no key in the yaml.
+    #
+    # @param yaml [YAML]
+    # @param key [String]
+    #
+    # @return The value for the specified key from yaml
+    # @raise [POEditor::Exception]
+    def get_or_raise(yaml, key)
+      yaml[key] or raise POEditor::Exception.new \
+        "Missing configuration key: '#{key}'"
+    end
+
+  end
+end

data/lib/poeditor/commands/help_command.rb

@@ -0,0 +1,7 @@
+module POEditor
+  class HelpCommand
+    def run(argv)
+      puts "Usage: poeditor export"
+    end
+  end
+end

data/lib/poeditor/commands/version_command.rb

@@ -0,0 +1,7 @@
+module POEditor
+  class VersionCommand
+    def run(argv)
+      puts POEditor::VERSION
+    end
+  end
+end

data/lib/poeditor/configurations/export_configuration.rb

@@ -0,0 +1,46 @@
+module POEditor
+  class ExportConfiguration
+    # @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 [Array<String>] The languages codes
+    attr_accessor :languages
+
+    # @return [String] Export file type (po, apple_strings, android_strings)
+    attr_accessor :type
+
+    # @return [Array<String>] Tag filters (optional)
+    attr_accessor :tags
+
+    attr_accessor :path
+
+    def initialize(api_key:, project_id:, languages:, type:, tags:nil, path:)
+      @api_key = api_key
+      @project_id = project_id
+      @languages = languages
+      @type = type
+      @tags = tags or []
+      @path = path
+    end
+
+    def default_path(type)
+      Formatter.cls(type).default_path
+    end
+
+    def to_s
+      values = {
+        "api_key" => self.api_key,
+        "project_id" => self.project_id,
+        "languages" => self.languages,
+        "type" => self.type,
+        "tags" => self.tags,
+        "path" => self.path,
+      }
+      values.map { |key, value| "  - #{key}: #{value}" }.join "\n"
+    end
+  end
+end

data/lib/poeditor/core/exporter.rb

@@ -0,0 +1,96 @@
+require "json"
+require "net/http"
+
+module POEditor
+  class Exporter
+    # @return [POEditor::ExportConfiguration] The configuration for export
+    attr_accessor :configuration
+
+    # @param configuration [POEditor::ExportConfiguration]
+    def initialize(configuration)
+      unless configuration.is_a? ExportConfiguration
+        raise POEditor::Exception.new \
+          "`configuration` should be an `ExportConfiguration`"
+      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("https://poeditor.com/api/")
+      options["action"] = action
+      options["api_token"] = api_token
+      return Net::HTTP.post_form(uri, options)
+    end
+
+    # Exports all translations
+    def export_all()
+      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)
+        Formatter.write(@configuration.path, language, content)
+      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>]
+    #
+    # @return Downloaded translation content
+    def export(api_key:, project_id:, language:, type:, tags:nil)
+      options = {
+        "id" => project_id,
+        "language" => convert_to_poeditor_language(language),
+        "type" => type,
+        "tags" => (tags or []).join(","),
+      }
+      response = self.api("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["item"])
+      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
+
+      return content
+    end
+
+    def convert_to_poeditor_language(language)
+      if language.downcase.match(/zh.+hans/)
+        'zh-CN'
+      elsif language.downcase.match(/zh.+hant/)
+        'zh-TW'
+      else
+        language
+      end
+    end
+
+  end
+end

data/lib/poeditor/core/formatter.rb

@@ -0,0 +1,16 @@
+module POEditor
+  class Formatter
+    def self.build_path(path_template, language)
+      path_template.gsub "{LANGUAGE}", language
+    end
+
+    def self.write(path_template, language, content)
+      path = build_path(path_template, language)
+      unless File.exist?(path)
+        raise POEditor::Exception.new "#{path} doesn't exist"
+      end
+      File.write(path, content)
+      UI.puts "      #{"\xe2\x9c\x93".green} Saved at '#{path}'"
+    end
+  end
+end

data/lib/poeditor/exception.rb

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

data/lib/poeditor/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/poeditor/version.rb

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: poeditor-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Suyeol Jeon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-01 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: POEditor CLI
+email: devxoul@gmail.com
+executables:
+- poeditor
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/poeditor
+- lib/poeditor.rb
+- lib/poeditor/commands/command.rb
+- lib/poeditor/commands/export_command.rb
+- lib/poeditor/commands/help_command.rb
+- lib/poeditor/commands/version_command.rb
+- lib/poeditor/configurations/export_configuration.rb
+- lib/poeditor/core/exporter.rb
+- lib/poeditor/core/formatter.rb
+- lib/poeditor/exception.rb
+- lib/poeditor/ui.rb
+- lib/poeditor/version.rb
+homepage: https://github.com/devxoul/poeditor-cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: POEditor CLI
+test_files: []