toptranslation_cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: defb641490501211a681e34f71c9f977d19829c3d9cb806d5a862ac34ea2a51f
+  data.tar.gz: 9f09c3b6f69b06edc69e2bb9a68f5e8033d996395e52998769ebe817ad5db2fb
+SHA512:
+  metadata.gz: 45521958d418d25fd2c6b4064835c58c8a7d21ee48fd9adc752c8157066a83d9d2dc538cf4014730c0c1b8b987081aac05d7a247e66917c0e2f48f5b5161cb24
+  data.tar.gz: a9db0159effc82e260e9abe6ce288e332cc93a980ccbb320b5a1c1bf250ae771ef94945c1298b8503b422f3d07ec40ba39c3ace5aab7b3a73d6b17b4f5db3acb

data/.github/workflows/tests.yml

@@ -0,0 +1,22 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Bundle install
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+
+    - name: Run RSpec and Rubocop
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.toptranslation.yml
+
+# Rubocop remote config
+.rubocop-*
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://raw.githubusercontent.com/tt-laboratories/dotfiles/master/.rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.3

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+<a name="1.0.0"></a>
+### 1.0.0 (2019-10-08)
+
+#### Features
+
+* show spinners for tt pull	 ([f798e74](/../commit/f798e74))
+* show spinners for tt push	 ([65b4386](/../commit/65b4386))
+* show spinner while fetching projects	 ([a30b512](/../commit/a30b512))
+* preselect project guessed from pwd in tt init	 ([ecefdd6](/../commit/ecefdd6))
+* show spinner while signing in from tt init	 ([1ed6da3](/../commit/1ed6da3))
+* make tt init interactive	 ([01ce165](/../commit/01ce165))
+* show progress bar for tt push	 ([9bb8369](/../commit/9bb8369))
+* show progressbar for tt pull	 ([05bba1c](/../commit/05bba1c))
+* add tt status command	 ([f265e64](/../commit/f265e64))
+* use .toptranslation.yml as config file	 ([7a2ea17](/../commit/7a2ea17))
+* don't swallow errors silently	 ([a31ed4a](/../commit/a31ed4a))
+* show help message when no command is given	 ([0363b3e](/../commit/0363b3e))
+
+#### Bug Fixes
+
+* upload translations for the same document sequentially	 ([3183693](/../commit/3183693))
+* fix deadlock issue by fetching all documents beforehand	 ([f713136](/../commit/f713136))
+* correctly specify file format when downloading document	 ([c58fbba](/../commit/c58fbba))
+* get identifier from created document	 ([15f0e45](/../commit/15f0e45))
+* make sure help works with a subcommand	 ([af75810](/../commit/af75810))
+* fix configuration spec	 ([e3d9c8d](/../commit/e3d9c8d))
+* load gemspec from Gemfile	 ([7ff98a4](/../commit/7ff98a4))
+
+#### maintain
+
+* use github actions instead of travis-ci	 ([fb0763f](/../commit/fb0763f))
+* list projects in tt init in alphabetical order	 ([bfd7a63](/../commit/bfd7a63))
+* update .rubocop-todo.yml	 ([feab797](/../commit/feab797))
+* remove paint and use pastel everywhere	 ([60e364c](/../commit/60e364c))
+* calculate sha1 sums of local files before uploading	 ([5c70218](/../commit/5c70218))
+* update toptranslation_api to 2.3	 ([1de342c](/../commit/1de342c))
+* don't set file_type when pulling	 ([918cb9d](/../commit/918cb9d))
+* use toptranslation_api ~> 2.2	 ([ffe9159](/../commit/ffe9159))
+* use Thor to handle command line options	 ([b29c729](/../commit/b29c729))
+* set required ruby version to >= 2.3	 ([e980f2e](/../commit/e980f2e))
+* run non-verbose by default to avoid leaking access tokens	 ([f1a1348](/../commit/f1a1348))
+* use some sensible rspec settings from bundlers default config	 ([92ed15c](/../commit/92ed15c))
+* use pry	 ([e0b200c](/../commit/e0b200c))
+* update to toptranslation_api ~> 2.0	 ([e3960c3](/../commit/e3960c3))
+* add rubocop to default rake task	 ([11de902](/../commit/11de902))
+* specify rubocop and rubocop-rspec version	 ([c513de0](/../commit/c513de0))
+* update MIT license Copyright	 ([e6f03cc](/../commit/e6f03cc))
+* remote Gemfile.lock	 ([17cfaa5](/../commit/17cfaa5))
+* use travis-ci	 ([90c4ffd](/../commit/90c4ffd))
+* add .ruby-version file	 ([0bbf497](/../commit/0bbf497))
+* change toptranslation_api git url to github	 ([b2fa1d5](/../commit/b2fa1d5))
+
+#### formatting, missing semi colons, …
+
+* fix rubocop offenses from .rubocop_todoy.yml	 ([f1fb401](/../commit/f1fb401))
+* satisfy rubocop	 ([608186c](/../commit/608186c))
+* change rubocop target ruby version to 2.3	 ([1826381](/../commit/1826381))
+* use rubocop	 ([68af8ce](/../commit/68af8ce))
+* some refactoring based on the output of `bundle gem`	 ([1177161](/../commit/1177161))
+

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Toptranslation GmbH
+
+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,154 @@
+# toptranslation_cli
+Gem to provide a command line tool for synching documents with the Toptranslation translations service.
+
+## Installation
+
+Install `toptranslation_cli` via `gem install`
+
+```
+$ gem install toptranslation_cli
+```
+
+or add it as a dependency to your project's Gemfile
+
+```ruby
+gem 'toptranslation_cli', group: :development
+```
+
+## Configuration
+
+Configuration is stored in `.toptranslation.yml`. A configuration can be created with [`$ tt init`](#initialization). The configuration can be checked with [`$ tt check`](#check-configuration).
+
+### Example configuration
+
+An example configuration file `.toptranslation.yml:
+
+```yaml
+project_identifier: "<PROJECT_IDENTIFIER>"
+access_token: "<YOUR_ACCESS_TOKEN>"
+files:
+  - config/locales/{locale_code}/**/*.yml # matches config/locales/en/foo.yml
+  - config/locales/**/*.{locale_code}.yml # matches config/locales/foo.en.yml
+```
+
+#### Used attributes:
++ **project_identifier** - Identifier of the synched project (see project settings in Toptranslation dashboard)
++ **access_token** - An access token used for authentication (see project settings in Toptranslation dashboard)
++ **files** - An array of paths that will be used to find documents to be synched. The path attribute may use wildcards like `/**/` or `*.yml` and placeholders (see below).
+
+#### Placeholders in paths
+
++ **{locale_code}** - Will be replaced with the locale code of project locales
+
+## Usage
+
+### Initialization
+
+Starts an interactive configuration dialog that will generate a `.toptranslation.yml` configuration.
+
+```
+tt init
+```
+
+[![asciicast](https://asciinema.org/a/3wFSWXz5Z7YCDQB1necBXsSoc.png)](https://asciinema.org/a/3wFSWXz5Z7YCDQB1necBXsSoc)
+
+### Check configuration
+
+Checks configuration settings in `.toptranslation.yml` and counts files matching the file path definitions (see configuration).
+
+```bash
+$ tt check
+Toptranslation command line client, version 1.0.0 - Configuration check
+
+Configuration file present:     ok
+ * includes access_token:       ok
+ * includes project_identifier: ok
+ * includes files:              ok
+
+Matching files:
+ * config/locales/{locale_code}/**/*.yml: 3 matching files
+```
+
+### Status
+
+Shows which files differ or exist only locally/remotely.
+
+```bash
+$ tt status
+Local: These documents exist only locally
+
+	config/locales/de/new.yml
+
+Changed: These documents exist both locally and remotely but differ
+
+	config/locales/en/changed.yml
+
+Remote: These documents exist only remotely
+
+	config/locales/fr/foo.yml
+```
+
+### Push local documents
+
+Pushes locals translations to Toptranslation.
+
+```bash
+$ tt push
+```
+
+[![asciicast](https://asciinema.org/a/3HT7WtvkQG3Zs3XO3orBeOdb3.svg)](https://asciinema.org/a/3HT7WtvkQG3Zs3XO3orBeOdb3)
+
+### Pull remote translations
+
+Pulls translations from Toptranslation and overwrites local translations.
+
+```bash
+$ tt pull
+```
+
+[![asciicast](https://asciinema.org/a/MrW1FGaAgljvWO3r9V6mCa3Pi.svg)](https://asciinema.org/a/MrW1FGaAgljvWO3r9V6mCa3Pi)
+
+### Help
+
+Display help page with usage instructions, examples and contact options.
+
+```
+$ tt help
+Toptranslation command line client, version 0.2.0
+
+tt commands:
+  tt check    # Check current configuration
+  tt help     # Print usage information
+  tt init     # Create a .toptranslation.yml configuration
+  tt pull     # Download remote translations, overwriting local documents
+  tt push     # Upload local documents
+  tt status   # Show local documents that differ from remote documents
+  tt version  # Print version
+
+twitter:
+  @tt_developers (https://twitter.com/tt_developers)
+
+websites:
+  https://www.toptranslation.com
+  https://developer.toptranslation.com
+  https://github.com/Toptranslation/tt_cli
+```
+
+### Version
+
+Displays the current version of this software.
+
+```
+$ tt version
+Toptranslation command line client, version 0.2.0
+```
+
+## Contact
+Web: [https://developer.toptranslation.com](https://developer.toptranslation.com) or
+[https://www.toptranslation.com](https://www.toptranslation.com)
+
+Github: [https://www.github.com/toptranslation](https://www.github.com/toptranslation)
+
+Twitter: [@tt_developers](http://www.twitter.com/tt_developers) or [@toptranslation](http://www.twitter.com/toptranslation)
+
+Mail: tech@toptranslation.com

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/exe/tt

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'toptranslation_cli'
+require 'thor'
+
+class Tt < Thor
+  package_name :tt
+
+  desc :check, 'Check current configuration'
+  def check
+    ToptranslationCli::Check.run
+  end
+
+  desc :help, 'Print usage information'
+  def help(*args, **kwargs)
+    return super(*args, **kwargs) if !args.empty? || !kwargs.empty?
+
+    version
+
+    # We need to call super without arguments
+    super()
+
+    puts <<~URLS
+      twitter:
+        @tt_developers (https://twitter.com/tt_developers)
+
+      websites:
+        https://www.toptranslation.com
+        https://developer.toptranslation.com
+        https://github.com/Toptranslation/tt_cli
+    URLS
+  end
+
+  desc :init, "Create a #{ToptranslationCli::Configuration::FILENAME} configuration"
+  def init
+    ToptranslationCli::Initializer.run
+  end
+
+  desc :push, 'Upload local documents'
+  def push
+    ToptranslationCli::Push.run
+  end
+
+  desc :pull, 'Download remote translations, overwriting local documents'
+  def pull
+    ToptranslationCli::Pull.run
+  end
+
+  desc :status, 'Show local documents that differ from remote documents'
+  method_option :exit_code,
+                type: :boolean,
+                default: false,
+                desc: 'Set the return code to the total number of changed files'
+  def status
+    changed_documents_amount = ToptranslationCli::Status.run
+    exit changed_documents_amount if options[:exit_code]
+  end
+
+  desc :version, 'Print version'
+  def version
+    puts "Toptranslation command line client, version #{ToptranslationCli::VERSION}"
+    puts ''
+  end
+end
+
+Tt.start(ARGV)

data/lib/toptranslation_cli.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'psych'
+require 'toptranslation_api'
+
+require 'toptranslation_cli/threaded'
+
+require 'toptranslation_cli/check'
+require 'toptranslation_cli/configuration'
+require 'toptranslation_cli/file_finder'
+require 'toptranslation_cli/info'
+require 'toptranslation_cli/initializer'
+require 'toptranslation_cli/placeholder_path'
+require 'toptranslation_cli/pull'
+require 'toptranslation_cli/push'
+require 'toptranslation_cli/status'
+require 'toptranslation_cli/version'
+
+module ToptranslationCli
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def connection
+      @connection ||= Toptranslation.new(access_token: configuration.access_token,
+                                         base_url: configuration.api_base_url,
+                                         files_url: configuration.files_base_url,
+                                         verbose: configuration.verbose)
+    end
+  end
+end