phraseapp_updater 0.1.7 → 2.0.0

data/lib/phraseapp_updater/locale_file/json_file.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'multi_json'
 require 'oj'
 
 # We're working with pure JSON, not
 # serialized Ruby objects
-Oj.default_options = {mode: :strict}
+Oj.default_options = { mode: :strict }
 
 class PhraseAppUpdater
   class LocaleFile
@@ -11,21 +13,26 @@ class PhraseAppUpdater
       EXTENSION      = "json"
       PHRASEAPP_TYPE = "nested_json"
 
-      def self.from_hash(name, hash)
-        new(name, MultiJson.dump(hash))
-      end
+      class << self
+        def load(content)
+          Oj.load(content)
+        rescue Oj::ParseError => e
+          raise ArgumentError.new("Provided content was not valid JSON: #{e}")
+        end
 
-      def parse(content)
-        MultiJson.load(content)
-      rescue MultiJson::ParseError => e
-        raise ArgumentError.new("Provided content was not valid JSON: #{e}")
-      end
+        def dump(hash)
+          # Add indentation for better diffs
+          Oj.dump(hash, indent: 2, mode: :strict)
+        end
 
-      def format_content!
-        # Add indentation for better diffs
-        @content = MultiJson.dump(MultiJson.load(@content), pretty: true)
+        def extension
+          EXTENSION
+        end
+
+        def phraseapp_type
+          PHRASEAPP_TYPE
+        end
       end
     end
   end
 end
-

data/lib/phraseapp_updater/locale_file/yaml_file.rb

@@ -5,17 +5,24 @@ class PhraseAppUpdater
       EXTENSION      = "yml"
       PHRASEAPP_TYPE = "yml"
 
-      def self.from_hash(name, hash)
-        new(name, Psych.dump(hash))
-      end
+      class << self
+        def load(content)
+          Psych.load(content)
+        rescue Psych::SyntaxError => e
+          raise ArgumentError.new("Provided content was not valid YAML")
+        end
 
-      def parse(content)
-        Psych.load(content)
-      rescue Psych::SyntaxError => e
-        raise ArgumentError.new("Provided content was not valid YAML")
-      end
+        def dump(hash)
+          Psych.dump(hash)
+        end
+
+        def extension
+          EXTENSION
+        end
 
-      def format_content!
+        def phraseapp_type
+          PHRASEAPP_TYPE
+        end
       end
     end
   end

data/lib/phraseapp_updater/phraseapp_api.rb

@@ -1,44 +1,100 @@
+# frozen_string_literal: true
+
 require 'phraseapp_updater/locale_file'
+require 'phraseapp_updater/index_by'
 require 'phraseapp-ruby'
-require 'thread'
+require 'parallel'
 require 'tempfile'
 
 class PhraseAppUpdater
+  using IndexBy
   class PhraseAppAPI
+    GIT_TAG_PREFIX = 'gitancestor_'
+
     def initialize(api_key, project_id, locale_file_class)
       @client            = PhraseApp::Client.new(PhraseApp::Auth::Credentials.new(token: api_key))
       @project_id        = project_id
       @locale_file_class = locale_file_class
     end
 
-    def download_locales
-      # This is a paginated API, however the maximum page size of 100
-      # is well above our expected locale size,
-      # so we take the first page only for now
+    def create_project(name, parent_commit)
+      params = PhraseApp::RequestParams::ProjectParams.new(
+        name: name,
+        main_format: @locale_file_class.phraseapp_type)
+      project = phraseapp_request { @client.project_create(params) }
+      STDERR.puts "Created project #{name} for #{parent_commit}"
+
+      @project_id = project.id
+      store_parent_commit(parent_commit)
+
+      project.id
+    end
+
+    # We mark projects with their parent git commit using a tag with a
+    # well-known prefix. We only allow one tag with this prefix at once.
+    def read_parent_commit
+      tags = phraseapp_request { @client.tags_list(@project_id, 1, 100) }
+      git_tag = tags.detect { |t| t.name.start_with?(GIT_TAG_PREFIX) }
+      raise MissingGitParentError.new if git_tag.nil?
+
+      git_tag.name.delete_prefix(GIT_TAG_PREFIX)
+    end
+
+    def update_parent_commit(commit_hash)
+      previous_parent = read_parent_commit
+      phraseapp_request do
+        @client.tag_delete(@project_id, GIT_TAG_PREFIX + previous_parent)
+      end
+      store_parent_commit(commit_hash)
+    end
+
+    def fetch_locales
+      # This is a paginated API, however the maximum page size of 100 is well
+      # above our expected locale size, so we take the first page only for now
       phraseapp_request { @client.locales_list(@project_id, 1, 100) }.map do |pa_locale|
         Locale.new(pa_locale)
       end
     end
 
-    def download_files(locales, skip_unverified)
-      threaded_request(locales) do |locale|
-        puts "Downloading file for #{locale}"
+    def create_locale(name, default: false)
+      phraseapp_request do
+        params = PhraseApp::RequestParams::LocaleParams.new(
+          name: name,
+          code: name,
+          default: default,
+        )
+        @client.locale_create(@project_id, params)
+      end
+    end
+
+    def download_files(locales, skip_unverified:)
+      results = threaded_request(locales) do |locale|
+        STDERR.puts "Downloading file for #{locale}"
         download_file(locale, skip_unverified)
-      end.map do |locale, file_contents|
-        @locale_file_class.new(locale.name, file_contents)
+      end
+
+      locales.zip(results).map do |locale, file_contents|
+        @locale_file_class.from_file_content(locale.name, file_contents)
       end
     end
 
-    def upload_files(locale_files)
+    def upload_files(locale_files, default_locale:)
+      known_locales = fetch_locales.index_by(&:name)
+
       threaded_request(locale_files) do |locale_file|
-        puts "Uploading #{locale_file}"
+        unless known_locales.has_key?(locale_file.locale_name)
+          create_locale(locale_file.locale_name,
+                        default: (locale_file.locale_name == default_locale))
+        end
+
+        STDERR.puts "Uploading #{locale_file}"
         upload_file(locale_file)
-      end.map { |locale_file, upload_id | upload_id }
+      end
     end
 
     def remove_keys_not_in_uploads(upload_ids)
       threaded_request(upload_ids) do |upload_id|
-        puts "Removing keys not in upload #{upload_id}"
+        STDERR.puts "Removing keys not in upload #{upload_id}"
         remove_keys_not_in_upload(upload_id)
       end
     end
@@ -46,18 +102,18 @@ class PhraseAppUpdater
     def download_file(locale, skip_unverified)
       download_params = PhraseApp::RequestParams::LocaleDownloadParams.new
 
-      download_params.file_format                  = @locale_file_class.const_get(:PHRASEAPP_TYPE)
+      download_params.file_format                  = @locale_file_class.phraseapp_type
       download_params.skip_unverified_translations = skip_unverified
 
       phraseapp_request { @client.locale_download(@project_id, locale.id, download_params) }
     end
 
     def upload_file(locale_file)
-      upload_params = create_upload_params(locale_file.name)
+      upload_params = create_upload_params(locale_file.locale_name)
 
       # The PhraseApp gem only accepts a filename to upload,
       # so we need to write the file out and pass it the path
-      Tempfile.create(["#{locale_file.name}", ".json"]) do |f|
+      Tempfile.create([locale_file.locale_name, ".json"]) do |f|
         f.write(locale_file.content)
         f.close
 
@@ -72,7 +128,7 @@ class PhraseAppUpdater
 
       begin
         phraseapp_request { @client.keys_delete(@project_id, delete_params) }
-      rescue RuntimeError => e
+      rescue RuntimeError => _e
         # PhraseApp will accept but mark invalid uploads, however the gem
         # returns the same response in both cases. If we call this API
         # with the ID of an upload of a bad file, it will fail.
@@ -84,65 +140,51 @@ class PhraseAppUpdater
 
     private
 
+    def store_parent_commit(commit_hash)
+      params = PhraseApp::RequestParams::TagParams.new(
+        name: GIT_TAG_PREFIX + commit_hash)
+      phraseapp_request { @client.tag_create(@project_id, params) }
+    end
+
     def phraseapp_request(&block)
-      begin
-        res, err = block.call
-      rescue RuntimeError => e
-        if e.message[/\(401\)/]
-          raise BadAPIKeyError.new(e)
-        elsif e.message[/not found/]
-          raise BadProjectIDError.new(e)
-        else
-          raise e
-        end
-      end
+      res, err = block.call
 
       unless err.nil?
-        if err.respond_to?(:error)
-          error = err.error
-        else
-          error = err.errors.join("|")
-        end
+        error =
+          if err.respond_to?(:error)
+            err.error
+          else
+            err.errors.join('|')
+          end
 
         raise RuntimeError.new(error)
       end
 
       res
+
+    rescue RuntimeError => e
+      if e.message.match?(/\(401\)/)
+        raise BadAPIKeyError.new(e)
+      elsif e.message.match?(/not found/)
+        raise BadProjectIDError.new(e, @project_id)
+      elsif e.message.match?(/has already been taken/)
+        raise ProjectNameTakenError.new(e)
+      else
+        raise
+      end
     end
 
     # PhraseApp allows two concurrent connections at a time.
     THREAD_COUNT = 2
 
     def threaded_request(worklist, &block)
-      queue   = worklist.inject(Queue.new, :push)
-      threads = []
-
-      THREAD_COUNT.times do
-        threads << Thread.new do
-          Thread.current[:result] = {}
-
-          begin
-            while work = queue.pop(true) do
-              Thread.current[:result][work] = block.call(work)
-            end
-          rescue ThreadError => e
-            Thread.exit
-          end
-
-        end
-      end
-
-      threads.each(&:join)
-
-      threads.each_with_object({}) do |thread, results|
-        results.merge!(thread[:result])
-      end
+      Parallel.map(worklist, in_threads: THREAD_COUNT, &block)
     end
 
     def create_upload_params(locale_name)
       upload_params = PhraseApp::RequestParams::UploadParams.new
-      upload_params.file_encoding       = "UTF-8"
-      upload_params.file_format         = @locale_file_class.const_get(:PHRASEAPP_TYPE)
+      upload_params.file_encoding       = 'UTF-8'
+      upload_params.file_format         = @locale_file_class.phraseapp_type
       upload_params.locale_id           = locale_name
       upload_params.skip_unverification = false
       upload_params.update_translations = true
@@ -171,6 +213,12 @@ class PhraseAppUpdater
       end
     end
 
+    class MissingGitParentError < RuntimeError
+      def initialize
+        super('Could not locate tag representing git ancestor commit')
+      end
+    end
+
     class BadAPIKeyError < RuntimeError
       def initialize(original_error)
         super(original_error.message)
@@ -178,10 +226,18 @@ class PhraseAppUpdater
     end
 
     class BadProjectIDError < RuntimeError
+      attr_reader :project_id
+
+      def initialize(original_error, id)
+        @project_id = id
+        super(original_error.message)
+      end
+    end
+
+    class ProjectNameTakenError < RuntimeError
       def initialize(original_error)
         super(original_error.message)
       end
     end
   end
 end
-

data/lib/phraseapp_updater/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PhraseAppUpdater
-  VERSION = "0.1.7"
+  VERSION = "2.0.0"
 end

data/phraseapp_updater.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_json", "~> 1.12"
   spec.add_dependency "oj", "~> 2.18"
   spec.add_dependency "deep_merge", "~> 1.1"
+  spec.add_dependency "parallel", "~> 1.12"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp_updater
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 2.0.0
 platform: ruby
 authors:
 - Kevin Griffin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -168,14 +182,15 @@ files:
 - README.markdown
 - Rakefile
 - bin/console
+- bin/phraseapp_common.sh
 - bin/phraseapp_updater
 - bin/setup
+- bin/synchronize_phraseapp.sh
 - lib/phraseapp_updater.rb
 - lib/phraseapp_updater/differ.rb
 - lib/phraseapp_updater/index_by.rb
 - lib/phraseapp_updater/locale_file.rb
 - lib/phraseapp_updater/locale_file/json_file.rb
-- lib/phraseapp_updater/locale_file/loader.rb
 - lib/phraseapp_updater/locale_file/yaml_file.rb
 - lib/phraseapp_updater/phraseapp_api.rb
 - lib/phraseapp_updater/version.rb
@@ -201,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A three-way differ for PhraseApp projects.

data/lib/phraseapp_updater/locale_file/loader.rb

@@ -1,24 +0,0 @@
-require 'phraseapp_updater/locale_file'
-
-class PhraseAppUpdater
-  class LocaleFile
-    class Loader
-      def initialize(extension)
-        @extension = extension
-      end
-
-      def load(filename)
-        unless File.readable?(filename) && File.file?(filename)
-          raise RuntimeError.new("Couldn't read localization file at #{filename}")
-        end
-
-        LocaleFile.class_for_file_format(@extension).new(File.basename(filename).chomp(".#{@extension}"), File.read(filename))
-      end
-
-      def filenames(locale_directory)
-        Dir["#{locale_directory}/*.#{@extension}"]
-      end
-    end
-  end
-end
-