mc_translator 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8df4b86675486570431856d5a8a58c608afcccb4603010670dba38a5319c401f
+  data.tar.gz: 90ac2cd1d8e9f67ac41044a54eaa40f195c2ff63d32c291a9c1f5b4a83b3bcc2
+SHA512:
+  metadata.gz: 5b533b9881a2065743d0f20d4294ea4395237cde0cc24fab8c36b5d09906572240a582e3482ab01e2fd4d67c6e07be6330f366ee4c8f5c758371478d98fd9194
+  data.tar.gz: d390634b64d849bf06d492dbb0a1c21a9d87015da5466a04b18e1a68dd8c27cee253a64d29b2283e8f5ce14cb610edeff068ffdb5ae1025212d7bfb8d80dd58c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mc_translator.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    mc_translator (0.1.3)
+      git (~> 1.8.1)
+      smartling
+      yaml (~> 0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_json (1.15.0)
+    netrc (0.11.0)
+    oj (3.11.5)
+    rake (13.0.3)
+    rchardet (1.8.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    smartling (2.0.3)
+      multi_json (~> 1.0)
+      oj (~> 3.0)
+      rest-client (~> 2.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    yaml (0.1.1)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  mc_translator!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.15

data/README.md

@@ -0,0 +1,53 @@
+# Translator Gem
+
+This gem is for pushing and pulling translations to and from Smartling.
+
+## Installation
+
+Add this line to your application's [Gemfile](https://github.com/yankaindustries/masterclass/blob/i18n/mc_translator/Gemfile#L188):
+
+```ruby
+gem 'mc_translator', github: 'yankaindustries/mc_translator', branch: 'main', require: 'smartling'
+```
+
+And then execute:
+
+```zsh
+$ bundle install
+```
+
+Then, in your [Rakefile](https://github.com/yankaindustries/masterclass/blob/i18n/mc_translator/Rakefile#L8):
+
+```rb
+require 'mc_translator
+```
+
+Once you've got it installed, you'll need some basic configuration by adding a [.translations.yml](https://github.com/yankaindustries/masterclass/blob/i18n/mc_translator/.translator.yml):
+
+```yaml
+userId:     xxxxxxxxxxxxxxxxxx
+userSecret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+projectId:  xxxxxxx
+locales:
+  - en-GB
+matches:
+  - pattern: '**/*en-US.yml'
+    type: YAML
+  - pattern: '**/*en-US.json'
+    type: JSON
+parentBranch: master
+```
+
+## Usage
+
+To keep things as simple as possible, we've added some Rake commands so that you can do this as simply as running:
+
+```zsh
+$ rake translator:push
+```
+
+and 
+
+```zsh
+$ rake translator:pull
+```

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+# require "mc_translator"
+require_relative "lib/mc_translator"

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mc_translator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mc_translator.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require_relative 'mc_translator/version'
+require_relative 'mc_translator/tasks'
+require_relative 'smartling/job'
+require 'yaml'
+require 'git'
+require 'smartling'
+
+
+module McTranslator
+  class Error < StandardError; end
+
+  class Translator
+    def print_msg(msg)
+      puts
+      puts msg
+    end
+
+    def initialize
+      args = {
+        userId: config['userId'],
+        userSecret: config['userSecret'],
+        projectId: config['projectId'],
+      }
+
+      @files = Smartling::File.new(args)
+      @jobs = Smartling::Job.new(args)
+    end
+
+    def push_changed
+      push changed_files
+    end
+
+    def push_all
+      push all_files
+    end
+
+    def pull_job
+      pull job_files
+    end
+
+    def pull_all
+      pull all_files
+    end
+
+    private
+
+    def config
+      YAML.safe_load(File.read('.translator.yml'))
+    end
+
+    def git
+      Git.open(Dir.getwd)
+    end
+
+    def origin
+      current_branch = git.current_branch
+      parent_branch = config['parentBranch']
+
+      if current_branch == config['parentBranch']
+        first_commit = git.log.last
+      else
+        first_commit = git.log.between(parent_branch, current_branch).last
+      end
+
+      first_commit.parent
+    end
+
+    def changed_files
+      config['matches'].flat_map do |matcher|
+        git.diff(origin.sha)
+          .select { |file| File.fnmatch(matcher['pattern'], file.path) }
+          .select { |file| %w(new modified).include? file.type }
+          .map { |file| { path: file.path, name: file.path, type: matcher['type'] } }
+      end
+    end
+
+    def all_files
+      config['matches'].flat_map do |matcher|
+        Dir.glob(matcher['pattern']).map do |file|
+          { path: file, name: file, type: matcher['type'] }
+        end
+      end
+    end
+
+    def job_files
+      current_branch = git.current_branch
+
+      print_msg 'Getting job and files...'
+      job = @jobs.list['items'].detect { |j| j['jobName'] == current_branch }
+      @jobs.files(job['translationJobUid'])['items'].map do |file|
+        { path: file['uri'], name: file['uri'] }
+      end
+    end
+
+    def push(files)
+      current_branch = git.current_branch
+
+      print_msg 'Setting up job...'
+      job = @jobs.find_or_create current_branch
+      p job['translationJobUid']
+
+      print_msg 'Uploading files...'
+      files.each do |file|
+        p file[:path]
+        begin
+          @files.upload file[:path], file[:path], file[:type]
+          @jobs.add_file job['translationJobUid'], file[:path], config['locales']
+        rescue => error
+          p error
+        end
+      end
+
+      # There's some sort of lag between the creating a job and the API
+      # returning the correct status, so we add a little delay to compensate
+      sleep 2
+
+      print_msg 'Checking job...'
+      job = @jobs.detail job['translationJobUid']
+      p job['jobStatus']
+
+      if job['jobStatus'] == 'AWAITING_AUTHORIZATION'
+        print_msg 'Authorizing job...'
+        @jobs.authorize job["translationJobUid"]
+      end
+
+      job
+    end
+
+    def pull(files)
+      files
+        .map do |file| file[:path] end
+        .each do |file|
+          config['locales'].each do |locale|
+            expansion = {
+              locale: locale,
+              dir: File.dirname(file),
+              name: File.basename(file, '.*').gsub(/en-US/, ''),
+              ext: File.extname(file),
+            }
+
+            name = File.expand_path(config['rewrite'] % expansion)
+            content = @files.download_translated(
+                        file,
+                        locale,
+                        { retrievalType: 'published' }
+                      )
+
+            p file
+            p name
+
+            dir = File.dirname(name)
+            Dir.mkdir(dir) unless Dir.exist?(dir)
+            File.write(name, content)
+          end
+        end
+    end
+  end
+end

data/lib/mc_translator/tasks.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+path = File.expand_path(__dir__)
+# Dir.glob("#{path}/tasks/test.rake").each { |f| import f }
+Dir.glob("#{path}/**/*.rake").each { |f| import f }

data/lib/mc_translator/tasks/translator/pull.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :translator do
+  desc 'Download translated files of current job from Smartling'
+  task 'pull:job' do
+    translator = McTranslator::Translator.new
+    translator.pull_job
+  end
+  task 'pull' => 'pull:job'
+
+  desc 'Download all translated files from Smartling'
+  task 'pull:all' do
+    translator = McTranslator::Translator.new
+    translator.pull_all
+  end
+end

data/lib/mc_translator/tasks/translator/push.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :translator do
+  desc 'Upload changed base locale files to Smartling'
+  task 'push:changed' do
+    translator = McTranslator::Translator.new
+    translator.push_changed
+  end
+  task 'push' => 'push:changed'
+
+  desc 'Upload all base locale files to Smartling'
+  task 'push:all' do
+    translator = McTranslator::Translator.new
+    translator.push_all
+  end
+end

data/lib/mc_translator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module McTranslator
+  VERSION = "0.1.3"
+end

data/lib/smartling/job.rb

@@ -0,0 +1,48 @@
+require 'smartling'
+
+module Smartling
+  class Job < Api
+    def initialize(args = {})
+      super(args)
+      @project_id = args[:projectId]
+    end
+
+    def list
+      uri = uri("jobs-api/v3/projects/#{@project_id}/jobs")
+      return get(uri)
+    end
+
+    def detail(job_id)
+      uri = uri("/jobs-api/v3/projects/#{@project_id}/jobs/#{job_id}")
+      return get(uri)
+    end
+
+    def create(name)
+      keys = { jobName: name }
+      uri = uri("jobs-api/v3/projects/#{@project_id}/jobs", keys)
+      return post(uri, uri.params)
+    end
+
+    def find_or_create(name)
+      list['items'].find do |job| job['jobName'] == name end ||
+        create(name)
+    end
+
+    def files(job_id)
+      uri = uri("jobs-api/v3/projects/#{@project_id}/jobs/#{job_id}/files")
+      return get(uri)
+    end
+
+    def add_file(job_id, file_uri, locales)
+      keys = { fileUri: file_uri, targetLocaleIds: locales }
+      uri = uri("jobs-api/v3/projects/#{@project_id}/jobs/#{job_id}/file/add", keys)
+      return post(uri, uri.params)
+    end
+
+    def authorize(job_id)
+      uri = uri("jobs-api/v3/projects/#{@project_id}/jobs/#{job_id}/authorize")
+      return post(uri, uri.params)
+    end
+
+  end
+end

data/mc_translator.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/mc_translator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mc_translator"
+  spec.version       = McTranslator::VERSION
+  spec.authors       = ["justinjones53@gmail.com"]
+  spec.email         = ["justinjones53@gmail.com"]
+
+  spec.summary       = "Translates locale files"
+  spec.description   = "Translates locale files"
+  spec.homepage      = "http://github.com/yankaindustries/mc_translator"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "http://mygemserver.com"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://github.com/yankaindustries/mc_translator"
+  spec.metadata["changelog_uri"] = "http://github.com/yankaindustries/mc_translator"
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "git", "~> 1.8.1"
+  spec.add_dependency "yaml", "~> 0.1.1"
+  spec.add_dependency "smartling", "~> 2.0.3"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: mc_translator
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- justinjones53@gmail.com
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: smartling
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+description: Translates locale files
+email:
+- justinjones53@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mc_translator.rb
+- lib/mc_translator/tasks.rb
+- lib/mc_translator/tasks/translator/pull.rake
+- lib/mc_translator/tasks/translator/push.rake
+- lib/mc_translator/version.rb
+- lib/smartling/job.rb
+- mc_translator.gemspec
+homepage: http://github.com/yankaindustries/mc_translator
+licenses: []
+metadata:
+  homepage_uri: http://github.com/yankaindustries/mc_translator
+  source_code_uri: http://github.com/yankaindustries/mc_translator
+  changelog_uri: http://github.com/yankaindustries/mc_translator
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Translates locale files
+test_files: []