toptranslation_cli 1.0.0

data/lib/toptranslation_cli/check.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module ToptranslationCli
+  class Check
+    class << self
+      def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        puts "Toptranslation command line client, version #{VERSION} - Configuration check\n\n"
+        puts "Configuration file present:\t#{check_configuration_file}"
+        puts " * includes access_token:\t#{check_access_token}"
+        puts " * includes project_identifier:\t#{check_project_identifier}"
+        puts " * includes files:\t\t#{check_file_paths_present}\n\n"
+
+        puts 'Checking connection:'
+        puts " * API URL:\t\t\t#{ToptranslationCli.configuration.api_base_url}"
+        puts " * Files URL:\t\t\t#{ToptranslationCli.configuration.files_base_url}"
+        puts " * access_token:\t\t#{ToptranslationCli.configuration.access_token}"
+        puts " * project_identifier:\t\t#{ToptranslationCli.configuration.project_identifier}"
+        puts " * project found:\t\t#{check_for_project}\n\n"
+
+        check_matching_files
+      end
+
+      private
+
+        def check_configuration_file
+          if ToptranslationCli.configuration.exist?
+            pastel.green('ok')
+          else
+            pastel.red('configuration file missing')
+          end
+        end
+
+        def check_access_token
+          ToptranslationCli.configuration.load
+          if !ToptranslationCli.configuration.access_token.nil?
+            pastel.green('ok')
+          else
+            pastel.red('access token missing from configuration file')
+          end
+        end
+
+        def check_project_identifier
+          ToptranslationCli.configuration.load
+          if !ToptranslationCli.configuration.project_identifier.nil?
+            pastel.green('ok')
+          else
+            pastel.red('project_identifier missing from configuration file')
+          end
+        end
+
+        def find_remote_project(project_identifier)
+          ToptranslationCli.connection.projects.find(project_identifier)
+        rescue StandardError => e
+          puts pastel.red(e)
+        end
+
+        def check_for_project
+          project_identifier = ToptranslationCli.configuration.project_identifier
+          remote_project = find_remote_project(project_identifier)
+
+          if remote_project&.identifier == project_identifier
+            pastel.green('ok')
+          else
+            pastel.red('project not found')
+          end
+        end
+
+        def check_file_paths_present
+          ToptranslationCli.configuration.load
+          if ToptranslationCli.configuration.files.any?
+            pastel.green('ok')
+          else
+            pastel.red('file paths missing from configuration file')
+          end
+        end
+
+        def check_matching_files
+          puts 'Matching files:'
+
+          ToptranslationCli.configuration.load
+          ToptranslationCli.configuration.files.each do |path_definition|
+            puts " * #{path_definition}: #{matching_files_output(path_definition)}"
+          end
+        end
+
+        def matching_files_output(path_definition)
+          count = FileFinder.new(path_definition).files.count
+
+          if count != 0
+            pastel.green("#{count} matching files")
+          else
+            pastel.red('no matching files')
+          end
+        end
+
+        def pastel
+          @pastel ||= Pastel.new
+        end
+    end
+  end
+end

data/lib/toptranslation_cli/configuration.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ToptranslationCli
+  class Configuration
+    attr_accessor :project_identifier, :access_token, :files, :api_base_url, :files_base_url, :verbose
+
+    FILENAME = '.toptranslation.yml'
+
+    def load
+      @project_identifier = configuration['project_identifier']
+      @access_token = configuration['access_token']
+      @files = configuration['files'] || []
+      @files_base_url = configuration['files_base_url'] || 'https://files.toptranslation.com'
+      @api_base_url = configuration['api_base_url'] || 'https://api.toptranslation.com'
+      @verbose = !ENV['VERBOSE'].nil?
+    end
+
+    def save
+      File.open(FILENAME, 'w') do |file|
+        # Psych can't stringify keys so we dump it to json before dumping to yml
+        Psych.dump(JSON.parse(configuration_hash.to_json), file)
+      end
+    end
+
+    def use_examples
+      @project_identifier = '<PROJECT_IDENTIFIER>'
+      @access_token = '<YOUR_ACCESS_TOKEN>'
+      @files = ['config/locales/{locale_code}/**/*.yml']
+    end
+
+    def exist?
+      File.exist?(FILENAME)
+    end
+
+    private
+
+      def configuration
+        @configuration ||= Psych.safe_load(File.read(FILENAME, encoding: 'bom|utf-8'))
+      rescue StandardError => e
+        puts Pastel.new.red('Could not read configuration'), e
+        exit 1
+      end
+
+      def configuration_hash
+        {
+          project_identifier: @project_identifier,
+          access_token: @access_token,
+          files: @files
+        }
+      end
+  end
+end

data/lib/toptranslation_cli/file_finder.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ToptranslationCli
+  class FileFinder
+    def initialize(path_definition)
+      @path_definition = path_definition
+    end
+
+    def files(locale_code = '**')
+      Dir.glob(@path_definition.gsub('{locale_code}', locale_code))
+    end
+
+    class << self
+      def local_files(project)
+        ToptranslationCli.configuration.files.each_with_object({}) do |path_definition, mem|
+          project&.locales&.map(&:code)&.each do |locale_code|
+            mem.merge!(local_files_for_path_definition(path_definition, locale_code))
+          end
+        end
+      end
+
+      def remote_files(project)
+        project_locales = project&.locales
+        project&.documents&.each_with_object({}) do |document, files|
+          project_locales&.each do |locale|
+            translation = document.translations.find { |t| t.locale.code == locale.code }
+            next unless translation
+
+            path = document.path.gsub('{locale_code}', locale.code)
+            files[path] = remote_file(document, locale, translation)
+          end
+        end
+      end
+
+      private
+
+        def add_remote_file(document, locale, translation)
+          {
+            sha1: translation.sha1,
+            identifier: document.identifier,
+            locale_code: locale.code
+          }
+        end
+
+        def local_files_for_path_definition(path_definition, locale_code)
+          new(path_definition)
+            .files(locale_code)
+            .map { |path| { path => checksum(path) } }
+            .reduce({}, &:merge)
+        end
+
+        def checksum(path)
+          Digest::SHA1.file(path).hexdigest
+        end
+    end
+  end
+end

data/lib/toptranslation_cli/info.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ToptranslationCli
+  class Info
+    def self.print_help
+      print_version
+
+      puts <<~INFO
+        Usage:\t\ttt [command]\n\n"
+        Commands:'
+           init\t\tCreates example configuration file #{Configuration::FILENAME}"
+           check\tChecks current configuration"
+           push\t\tUploads local documents"
+           pull\t\tPulls remote translations, overwrites local documents"
+           --version\tDisplays current version of application"
+           --help\tDisplays this help screen\n\n"
+        Twitter:\t@tt_developers\n\n"
+        Websites:\thttps://www.toptranslation.com"
+        \t\thttps://developer.toptranslation.com"
+        \t\thttps://github.com/Toptranslation/tt_cli"
+      INFO
+    end
+
+    def self.print_version
+      puts "Toptranslation command line client, version #{VERSION}"
+    end
+  end
+end

data/lib/toptranslation_cli/initializer.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'pastel'
+require 'tty-prompt'
+require 'tty-spinner'
+
+module ToptranslationCli
+  class Initializer # rubocop:disable Metrics/ClassLength
+    class << self
+      def run
+        new.run
+      end
+    end
+
+    def initialize
+      @prompt = TTY::Prompt.new
+      @client = Toptranslation.new({})
+      @pastel = Pastel.new
+      format = "[#{@pastel.yellow(':spinner')}] :title"
+      @spinner = TTY::Spinner.new(format, success_mark: @pastel.green('+'), error_mark: @pastel.red('-'))
+    end
+
+    def run
+      create_config(ask_config)
+      @prompt.ok("Generated #{Configuration::FILENAME}")
+    end
+
+    private
+
+      def ask_config
+        {
+          token: sign_in(ask_auth_method),
+          project_id: ask_project,
+          file_selectors: ask_file_selectors
+        }
+      end
+
+      def projects?
+        @spinner.update(title: 'Fetching projects...')
+        @spinner.auto_spin
+        @client.projects.any?.tap do |any|
+          if any
+            @spinner.success(@pastel.green('done'))
+          else
+            @spinner.error(@pastel.red('could not find any projects'))
+          end
+        end
+      end
+
+      def ask_project
+        exit 1 unless projects?
+
+        @prompt.select('Project:') do |menu|
+          each_project_with_index.map do |project, index|
+            menu.default(index + 1) if File.basename(Dir.pwd).casecmp?(project.name)
+            menu.choice name: project.name, value: project.identifier
+          end
+        end
+      end
+
+      def ask_auth_method
+        @prompt.select('Authentication method:') do |menu|
+          menu.choice name: 'Email and password', value: :email
+          menu.choice name: 'Access token', value: :token
+        end
+      end
+
+      def ask_file_selectors
+        result = []
+        loop do
+          result << @prompt.ask('File selector:') do |q|
+            q.required true
+            q.default 'config/locales/{locale_code}/**/*.yml'
+          end
+          break unless @prompt.yes?('Add another file selector?', default: false)
+        end
+        result
+      end
+
+      def sign_in(auth_method)
+        @spinner.update(title: 'Signing in...')
+        if auth_method == :email
+          ask_email_and_password
+        else
+          ask_access_token
+        end
+      end
+
+      def ask_email_and_password
+        email = @prompt.ask('Email:', required: true)
+        password = @prompt.mask('Password:', required: true, echo: false)
+        token = @client.sign_in!(email: email, password: password)
+        @spinner.success(@pastel.green('done'))
+        token
+      rescue RestClient::Unauthorized
+        @spinner.error(@pastel.red('credentials are invalid'))
+        retry
+      end
+
+      def ask_access_token
+        token = @prompt.ask('Access token:', required: true)
+        @client.access_token = token
+        @spinner.auto_spin
+        @client.projects.to_a
+        @spinner.success(@pastel.green('done'))
+        token
+      rescue RestClient::Forbidden
+        @spinner.error(@pastel.red('invalid access token'))
+        @spinner.stop
+        retry
+      end
+
+      def create_config(answers)
+        config = ToptranslationCli::Configuration.new
+        config.project_identifier = answers[:project_id]
+        config.access_token = answers[:token]
+        config.files = answers[:file_selectors]
+        config.save
+      end
+
+      def each_project_with_index
+        @client.projects.sort_by(&:name).each_with_index
+      end
+  end
+end

data/lib/toptranslation_cli/placeholder_path.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class PlaceholderPath
+  def initialize(path_definition)
+    @path_definition = path_definition
+  end
+
+  # Returns a filepath with {locale_code} placeholder e.g. for the parameters
+  # path:             "/locales/de/admin/index.de.po"
+  # path_definition:  "/locales/{locale_code}/**/*{locale_code}.po"
+  # locale_code:      "de"
+  # it will return:   "/locales/{locale_code}/admin/index.{locale_code}.po"
+  def for_path(path, locale_code)
+    regex = regex(locale_code)
+    path.match(regex).captures.join('{locale_code}')
+  end
+
+  private
+
+    # Replaces UNIX wildcards in a path definition and returns a regular
+    # expression of the path definition
+    # e.g. "/config/**/*{locale_code}.po"  => /\/config\/.*de\.po/
+    #
+    # (1) - Replaces ** and * wildcards with .*
+    # (2) - Replaces duplicate wildcards like .*/.* with one .*
+    # (3) - splits path_definition at {locale_code}
+    # (4) - Puts each part of splits in parantesis and joins them with locale_code
+    def regex(locale_code)
+      string = @path_definition
+
+      string = string.gsub(/\./, '\.')
+      string = string.gsub(/((?<!\*)\*(?!\*))|(\*\*)/, '.*') # (1)
+      string = string.gsub('.*/.*', '.*') # (2)
+
+      splits = string.split('{locale_code}') # (3)
+      path = splits.map { |segment| "(#{segment})" }.join(locale_code) # (4)
+
+      Regexp.new(path)
+    end
+end

data/lib/toptranslation_cli/pull.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tty-spinner'
+require 'pastel'
+require 'tty-progressbar'
+
+module ToptranslationCli
+  class Pull
+    using Threaded
+
+    def self.run
+      new.run
+    end
+
+    def initialize
+      ToptranslationCli.configuration.load
+
+      @pastel = Pastel.new
+      @spinner_settings = { success_mark: @pastel.green('+'), error_mark: @pastel.red('-') }
+      @spinner = TTY::Spinner.new("[#{@pastel.yellow(':spinner')}] :title", @spinner_settings)
+    end
+
+    def run
+      changed = changed_files(remote_files, local_files)
+      download_files(changed)
+    rescue RestClient::BadRequest
+      @spinner.error(@pastel.red('invalid access token')) if @spinner.spinning?
+      exit 1
+    rescue RestClient::NotFound
+      @spinner.error(@pastel.red('project not found')) if @spinner.spinning?
+      exit 1
+    end
+
+    private
+
+      def changed_files(remote_files, local_files)
+        @spinner.update(title: 'Checking for changed files...')
+        files = remote_files.reject do |file|
+          local_files[file[:path]] == file[:sha1]
+        end
+        @spinner.auto_spin
+        @spinner.success(@pastel.green("found #{files.count} changed file(s)"))
+        files
+      end
+
+      def download_files(files)
+        return if files.empty?
+
+        bar = TTY::ProgressBar.new('Downloading [:bar] :percent [:current/:total]', total: files.count)
+        bar.render
+
+        files.each_in_threads(8) do |file|
+          file[:document].download(file[:locale].code, path: file[:path])
+          bar.synchronize { bar.log(file[:path]) }
+          bar.advance
+        end
+      end
+
+      def local_files
+        @spinner.update(title: 'Checking local files...')
+        @spinner.auto_spin
+        files = FileFinder.local_files(project)
+        @spinner.success(@pastel.green("found #{files.count} file(s)"))
+        files
+      end
+
+      def path(document, locale)
+        document.path.gsub('{locale_code}', locale.code)
+      end
+
+      def project_locales
+        @project_locales ||= project.locales
+      end
+
+      def project
+        @project ||= ToptranslationCli.connection.projects.find(ToptranslationCli.configuration.project_identifier)
+      end
+
+      def remote_files
+        @spinner.update(title: 'Checking remote files...')
+        @spinner.auto_spin
+        files = project&.documents&.flat_map do |document|
+          document.translations.map do |translation|
+            file_to_download(document, translation)
+          end
+        end
+        @spinner.success(@pastel.green("found #{files.count} file(s)"))
+        files
+      end
+
+      def file_to_download(document, translation)
+        {
+          path: path(document, translation.locale),
+          document: document,
+          sha1: translation.sha1,
+          locale: translation.locale
+        }
+      end
+  end
+end