phraseapp_updater 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb9f8e20f3b078b508e5e427e98d9c62153e02e88542ecf43fc774bef05125f
-  data.tar.gz: e5110c0c2534f4e5819007aa0209ab2efec954a6ce461c404d01ff177b6cfd91
+  metadata.gz: f33deb3a77a37a47abdf44c354526cbe3ad3d10256bb2a046bf48922178187fd
+  data.tar.gz: f22f2ceed18653b09c24be4724707cdc40c39539535c226fd028bc03338437cd
 SHA512:
-  metadata.gz: 1a650fd825eb3f37e55388509b23f57b0cfb2a8e5a7235d275ce4b8259f8fc82c955ac54ad701bbfa1fcd7f2689ae16c796133b35a95417536d0632c1cde22a2
-  data.tar.gz: 6108be4a1d29345d3063dd4cf94972aae52de8f67088cd70ff6fcccd4907128f587fbfe721d90f4856bf07707b7271be28ddb81c4b55162fcdc8d944580d6704
+  metadata.gz: 822cc67247e2e2752397127f6b4e5e0d893cdfc3c64a29f14067d2bc5b6e131f3924d5cad982960df65da4b47971c12ad43fc9caf9c9ff15e756a596a64c163e
+  data.tar.gz: a2e1152e1a376690722722d73c2654d4ab4e417530b66b86f7562cd0b17e54f06976a295bae601ec0d4ed1e8570a518eef9a37ff317f24001643e711c0365e6c

data/bin/phraseapp_common.sh

@@ -1,13 +1,13 @@
 #!/usr/bin/env bash
 
 # Set up a working directory
-working_directory=$(mktemp -d -t phraseapp.XXXXXX)
+working_directory=$(mktemp -d phraseapp.XXXXXX)
 
 function cleanup_working_directory(){
   local now archive
   now="$(date "+%Y%m%d%H%M%S")"
   archive="/tmp/phraseapp-updater-$now.tar.gz"
-  tar czf "$archive" "${working_directory}"
+  tar -C "$(dirname "$working_directory")" -czf "$archive" "$(basename "${working_directory}")"
   rm -rf "${working_directory}"
   echo "Working files saved to $archive"
 }
@@ -41,15 +41,15 @@ function make_tree_from_directory() {
 }
 
 
-function extract_commit() {
-    extract_files "$1:${PREFIX}"
+function extract_prefix_from_commit() {
+    extract_files "$1" "$2:${PREFIX}"
 }
 
 function extract_files() {
     local path
-    path=$(make_temporary_directory "git.${1%%:*}")
+    path=$(make_temporary_directory "git.${1}.${2%%:*}")
 
-    git archive --format=tar "$1" | tar -x -C "${path}"
+    git archive --format=tar "$2" | tar -x -C "${path}"
 
     echo "${path}"
 }

data/bin/synchronize_phraseapp.sh

@@ -61,8 +61,8 @@ elif ! git merge-base --is-ancestor "${common_ancestor}" "${current_branch}"; th
     skip_ancestor_merge=t
 fi
 
-current_branch_path=$(extract_commit "${current_branch}")
-common_ancestor_path=$(extract_commit "${common_ancestor}")
+current_branch_path=$(extract_prefix_from_commit current_branch "${current_branch}")
+common_ancestor_path=$(extract_prefix_from_commit common_ancestor "${common_ancestor}")
 
 current_phraseapp_tree=$(make_tree_from_directory "${current_phraseapp_path}")
 

data/lib/phraseapp_updater/phraseapp_api.rb

@@ -2,7 +2,8 @@
 
 require 'phraseapp_updater/locale_file'
 require 'phraseapp_updater/index_by'
-require 'phraseapp-ruby'
+require 'uri'
+require 'phrase'
 require 'parallel'
 require 'tempfile'
 
@@ -13,16 +14,24 @@ class PhraseAppUpdater
     PAGE_SIZE = 100
 
     def initialize(api_key, project_id, locale_file_class)
-      @client            = PhraseApp::Client.new(PhraseApp::Auth::Credentials.new(token: api_key))
+      config = Phrase::Configuration.new do |c|
+        c.api_key['Authorization'] = api_key
+        c.api_key_prefix['Authorization'] = 'token'
+        c.debugging = false
+      end
+
+      @client            = Phrase::ApiClient.new(config)
       @project_id        = project_id
       @locale_file_class = locale_file_class
     end
 
     def create_project(name, parent_commit)
-      params = PhraseApp::RequestParams::ProjectParams.new(
+      params = Phrase::ProjectCreateParameters.new(
         name: name,
         main_format: @locale_file_class.phraseapp_type)
-      project = phraseapp_request { @client.project_create(params) }
+
+      project = phraseapp_request(Phrase::ProjectsApi, :project_create, params)
+
       STDERR.puts "Created project #{name} for #{parent_commit}"
 
       @project_id = project.id
@@ -32,7 +41,8 @@ class PhraseAppUpdater
     end
 
     def lookup_project_id(name)
-      result, = paginate_request(:projects_list, limit: 1) { |p| p.name == name }
+      result, = paginated_request(Phrase::ProjectsApi, :projects_list, { per_page: PAGE_SIZE }, limit: 1) { |p| p.name == name }
+
       raise ProjectNotFoundError.new(name) if result.nil?
 
       result.id
@@ -41,9 +51,10 @@ class PhraseAppUpdater
     # 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
-      git_tag, = paginate_request(:tags_list, @project_id, limit: 1) do |t|
+      git_tag, = paginated_request(Phrase::TagsApi, :tags_list, @project_id, limit: 1) do |t|
         t.name.start_with?(GIT_TAG_PREFIX)
       end
+
       raise MissingGitParentError.new if git_tag.nil?
 
       git_tag.name.delete_prefix(GIT_TAG_PREFIX)
@@ -51,35 +62,28 @@ class PhraseAppUpdater
 
     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
+      phraseapp_request(Phrase::TagsApi, :tag_delete, @project_id, GIT_TAG_PREFIX + previous_parent)
       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
+      locales = paginated_request(Phrase::LocalesApi, :locales_list, @project_id)
+      locales.map { |pa_locale| Locale.new(pa_locale) }
     end
 
     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
+      params = Phrase::LocaleCreateParameters.new(
+        name: name,
+        code: name,
+        default: default,
+      )
+      phraseapp_request(Phrase::LocalesApi, :locale_create, @project_id, params)
     end
 
     def download_files(locales, skip_unverified:)
       results = threaded_request(locales) do |locale|
         STDERR.puts "Downloading file for #{locale}"
-        download_file(locale, skip_unverified)
+        download_locale(locale, skip_unverified)
       end
 
       locales.zip(results).map do |locale, file_contents|
@@ -87,18 +91,65 @@ class PhraseAppUpdater
       end
     end
 
+    # Empirically, PhraseApp fails to parse the uploaded files when uploaded in
+    # parallel. Give it a better chance by uploading them one at a time.
     def upload_files(locale_files, default_locale:)
-      known_locales = fetch_locales.index_by(&:name)
+      is_default = ->(l) { l.locale_name == default_locale }
 
+      # Ensure the locales all exist
+      STDERR.puts('Creating locales')
+      known_locales = fetch_locales.index_by(&:name)
       threaded_request(locale_files) do |locale_file|
         unless known_locales.has_key?(locale_file.locale_name)
-          create_locale(locale_file.locale_name,
-                        default: (locale_file.locale_name == default_locale))
+          create_locale(locale_file.locale_name, default: is_default.(locale_file))
+        end
+      end
+
+      # Upload the files in a stable order, ensuring the default locale is first.
+      locale_files.sort! do |a, b|
+        next -1 if is_default.(a)
+        next 1  if is_default.(b)
+
+        a.locale_name <=> b.locale_name
+      end
+
+      uploads = {}
+
+      uploads = locale_files.to_h do |locale_file|
+        STDERR.puts("Uploading #{locale_file}")
+        upload_id = upload_file(locale_file)
+        [upload_id, locale_file]
+      end
+
+      # Validate the uploads, retrying failures as necessary
+      successful_upload_ids = {}
+
+      STDERR.puts('Verifying uploads...')
+      until uploads.empty?
+        threaded_request(uploads.to_a) do |upload_id, locale_file|
+          upload = phraseapp_request(Phrase::UploadsApi, :upload_show, @project_id, upload_id)
+
+          case upload.state
+          when "enqueued", "processing"
+            STDERR.puts("#{locale_file}: still processing")
+          when "success"
+            STDERR.puts("#{locale_file}: success")
+            successful_upload_ids[locale_file.locale_name] = upload_id
+            uploads.delete(upload_id)
+          when "error"
+            STDERR.puts("#{locale_file}: upload failure, retrying")
+            new_upload_id = upload_file(locale_file)
+            uploads.delete(upload_id)
+            uploads[new_upload_id] = locale_file
+          else
+            raise RuntimeError.new("Unknown upload state: #{upload.state}")
+          end
         end
 
-        STDERR.puts "Uploading #{locale_file}"
-        upload_file(locale_file)
+        sleep(2) unless uploads.empty?
       end
+
+      successful_upload_ids
     end
 
     def remove_keys_not_in_uploads(upload_ids)
@@ -108,105 +159,101 @@ class PhraseAppUpdater
       end
     end
 
-    def download_file(locale, skip_unverified)
-      download_params = PhraseApp::RequestParams::LocaleDownloadParams.new
-
-      download_params.file_format                  = @locale_file_class.phraseapp_type
-      download_params.skip_unverified_translations = skip_unverified
+    def download_locale(locale, skip_unverified)
+      opts = {
+        file_format: @locale_file_class.phraseapp_type,
+        skip_unverified_translations: skip_unverified,
+      }
 
-      phraseapp_request { @client.locale_download(@project_id, locale.id, download_params) }
+      # Avoid allocating a tempfile (and emitting unnecessary warnings) by using `return_type` of `String`
+      phraseapp_request(Phrase::LocalesApi, :locale_download, @project_id, locale.id, return_type: 'String', **opts)
     end
 
     def upload_file(locale_file)
-      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.locale_name, ".json"]) do |f|
         f.write(locale_file.content)
         f.close
 
-        upload_params.file = f.path
-        phraseapp_request { @client.upload_create(@project_id, upload_params) }.id
+        opts = {
+          file:                 f,
+          file_encoding:        'UTF-8',
+          file_format:          @locale_file_class.phraseapp_type,
+          locale_id:            locale_file.locale_name,
+          skip_unverification:  false,
+          update_translations:  true,
+          tags:                 [generate_upload_tag],
+        }
+
+        result = phraseapp_request(Phrase::UploadsApi, :upload_create, @project_id, **opts)
+
+        result.id
       end
     end
 
     def remove_keys_not_in_upload(upload_id)
-      delete_params   = PhraseApp::RequestParams::KeysDeleteParams.new
-      delete_params.q = "unmentioned_in_upload:#{upload_id}"
-
-      begin
-        phraseapp_request { @client.keys_delete(@project_id, delete_params) }
-      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.
-        # This usually occurs when sending up an empty file, which is
-        # a case we can ignore. However, it'd be better to have a way
-        # to detect a bad upload and find the cause.
-      end
+      delete_pattern = "unmentioned_in_upload:#{upload_id}"
+      phraseapp_request(Phrase::KeysApi, :keys_delete_collection, @project_id, q: delete_pattern)
     end
 
     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) }
+      params = Phrase::TagCreateParameters.new(name: GIT_TAG_PREFIX + commit_hash)
+      phraseapp_request(Phrase::TagsApi,:tag_create, @project_id, params)
+    end
+
+    def wrap_phrase_errors
+      yield
+    rescue Phrase::ApiError => e
+      if e.code == 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
 
-    def paginate_request(method, *params, limit: nil, &filter)
+    def paginated_request(api_class, method, *params, limit: nil, **opts, &filter)
+
+      api_instance = api_class.new(@client)
       page = 1
       results = []
 
       loop do
-        response = phraseapp_request do
-          @client.public_send(method, *params, page, PAGE_SIZE)
+        response = wrap_phrase_errors do
+          api_instance.public_send(method, *params, opts.merge(page: page, page_size: PAGE_SIZE))
         end
 
-        break if response.empty?
+        break if response.data.empty?
 
-        matches = response.filter(&filter)
+        matches = response.data
+        matches = matches.filter(&filter) if filter
         matches = matches[0, limit - results.size] if limit
 
-        unless matches.empty?
-          results.concat(matches)
+        results.concat(matches) unless matches.empty?
 
-          break if results.size == limit
-        end
+        break if results.size == limit
+        break unless response.next_page?
 
-        page += 1
+        page = response.next_page
       end
 
       results
     end
 
-    def phraseapp_request(&block)
-      res, err = block.call
+    def phraseapp_request(api_class, method, *params, **opts)
+      api_instance = api_class.new(@client)
 
-      unless err.nil?
-        error =
-          if err.respond_to?(:error)
-            err.error
-          else
-            err.errors.join('|')
-          end
-
-        raise RuntimeError.new(error)
+      response = wrap_phrase_errors do
+        api_instance.public_send(method, *params, opts)
       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
+      response.data
     end
 
     # PhraseApp allows two concurrent connections at a time.
@@ -216,17 +263,6 @@ class PhraseAppUpdater
       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.phraseapp_type
-      upload_params.locale_id           = locale_name
-      upload_params.skip_unverification = false
-      upload_params.update_translations = true
-      upload_params.tags                = [generate_upload_tag]
-      upload_params
-    end
-
     def generate_upload_tag
       "phraseapp_updater_upload_#{Time.now.strftime('%Y%m%d%H%M%S')}"
     end

data/lib/phraseapp_updater/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PhraseAppUpdater
-  VERSION = '2.1.2'
+  VERSION = '3.0.0'
 end

data/lib/phraseapp_updater.rb

@@ -102,13 +102,14 @@ class PhraseAppUpdater
     # We assert that the default locale contains all legitimate strings, and so
     # we clean up orphaned content on PhraseApp post-upload by removing keys not
     # in the default locale.
-    default_locale_index = locale_files.find_index { |f| f.locale_name == @default_locale }
-    raise RuntimeError.new("Missing default locale") unless default_locale_index
+    unless locale_files.find { |f| f.locale_name == @default_locale }
+      raise RuntimeError.new("Missing default locale")
+    end
 
     upload_ids = @phraseapp_api.upload_files(locale_files, default_locale: @default_locale)
-    default_upload_id = upload_ids[default_locale_index]
+    default_upload_id = upload_ids.fetch(@default_locale)
 
-    STDERR.puts "Removing keys not in default locale upload #{default_upload_id}"
+    STDERR.puts "Removing keys not in default locale '#{@default_locale}' upload '#{default_upload_id}'"
     @phraseapp_api.remove_keys_not_in_upload(default_upload_id)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp_updater
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
-- Kevin Griffin
+- iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: phraseapp-ruby
+  name: phrase
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.8.3
 - !ruby/object:Gem::Dependency
   name: hashdiff
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -167,23 +167,13 @@ dependencies:
 description: A tool for merging data on PhraseApp with local changes (usually two
   git revisions)
 email:
-- kev@bibo.com.ph
+- systems@iknow.jp
 executables:
 - phraseapp_updater
 extensions: []
 extra_rdoc_files: []
 files:
-- ".envrc"
-- ".github/workflows/gem-push.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.markdown
-- Gemfile
 - LICENSE.txt
-- README.markdown
-- Rakefile
 - bin/console
 - bin/phraseapp_common.sh
 - bin/phraseapp_updater
@@ -198,13 +188,7 @@ files:
 - lib/phraseapp_updater/phraseapp_api.rb
 - lib/phraseapp_updater/version.rb
 - lib/phraseapp_updater/yml_config_loader.rb
-- nix/gem/Gemfile
-- nix/gem/Gemfile.lock
-- nix/gem/gemset.nix
-- nix/generate.rb
-- phraseapp_updater.gemspec
-- shell.nix
-homepage: https://app.engoo.com
+homepage: https://github.com/iknow/phraseapp_updater
 licenses:
 - MIT
 metadata: {}

data/.envrc

@@ -1 +0,0 @@
-eval "$(lorri direnv)"

data/.github/workflows/gem-push.yml

@@ -1,31 +0,0 @@
-name: Publish Ruby Gem
-
-on:
-  push:
-    branches: [ "master" ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby 2.7
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -1,41 +0,0 @@
-name: Run Tests
-
-on:
-  pull_request:
-    branches: "**"
-
-permissions:
-  contents: read
-  checks: write
-  pull-requests: write
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
-    - name: Upload result
-      uses: actions/upload-artifact@v3
-      if: always()
-      with:
-        name: rspec.xml
-        path: test_results/rspec.xml
-    - name: Test Report
-      uses: dorny/test-reporter@v1
-      if: always()
-      with:
-        name: Rspec Tests - ${{ matrix.ruby-version }}
-        path: test_results/rspec.xml
-        reporter: java-junit

data/.gitignore

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

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.markdown

@@ -1,50 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at kev@bibo.com.ph. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
-

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in phraseapp_updater.gemspec
-gemspec
-gem 'byebug'
-gem 'rspec_junit_formatter'
-
-gem 'irb', require: false

data/README.markdown

@@ -1,177 +0,0 @@
-# PhraseAppUpdater
-
-[![Build Status](https://travis-ci.org/iknow/phraseapp_updater.svg?branch=master)](https://travis-ci.org/iknow/phraseapp_updater)
-
-**Version** 2.0.0
-
-This is a tool for managing synchronization between locale data in
-[PhraseApp](https://phraseapp.com) and committed in your project. It can perform
-JSON-aware three-way merges with respect to a common ancestor, and maintains a
-record of the common ancestor on PhraseApp using tags.
-
-Our workflow considers localization data stored on PhraseApp to be a working
-copy for a given branch. We expect developers working on the code and
-translators working on PhraseApp to both be able to make changes and have them
-integrated.
-
-PhraseApp provides [APIs](https://phraseapp.com/docs/api/v2/) and a [Ruby
-gem](https://github.com/phrase/phraseapp-ruby) for accessing them, but the API
-only allows either a) completely overwriting PhraseApp's data with local data or
-b) reapplying PhraseApp's data on top of the local data. Neither of these cases
-is appropriate for integrating changes made on both sides.
-
-What we want instead is a three way merge where the committed data wins on
-conflict. Non-conflicting changes on PhraseApp are preserved, while changes to
-the same key on both sides take the committed data. The result of the merge is
-then applied to both sides, keeping them up to date with each other.
-
-This is especially important when removing keys. Imagine we have the
-following, no-longer useful key:
-
-```json
-unused:
-  one: An unused
-```
-
-On PhraseApp, we've added another plural form:
-
-
-```json
-unused:
-  one: An unused
-  zero: No unused's
-```
-
-And in our feature branch, we remove it. The result we want is that the key
-completely disappears, instead of getting a result like either of the above.
-
-## Installation
-
-This gem provides a command line interface for performing the
-merge and uploading the result to PhraseApp. To use it, install the gem:
-
-`gem install phraseapp_updater`
-
-You may also use this gem programatically from your own application.
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'phraseapp_updater'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install phraseapp_updater
-
-## Usage
-
-CLI
----
-
-**Setup**
-
-`phraseapp_updater setup` creates and initializes a PhraseApp project
-corresponding to your branch. It must be provided with the current git revision
-of the branch and the path to the locale files.
-
-```
-phraseapp_updater setup --phraseapp_project_name=<yourbranch> --parent_commit=<yourhash> --phraseapp_api_key=<yourkey> --file-format=json <path_to_locales>
-```
-
-**Synchronize**
-
-`phraseapp_updater synchronize` synchronizes a git remote branch with its
-corresponding PhraseApp project, incorporating changes from each side into the
-other. If both sides were changed, a three-way merge is performed. The result is
-uploaded to PhraseApp and committed and pushed to the git remote as appropriate.
-
-The option `--no_commit` may be provided to restrict changes to the PhraseApp
-side. If specified, then in the case that the branch was modified, the merge
-result will be uploaded to PhraseApp and the common ancestor updated to the
-branch head.
-
-```
-phraseapp_updater synchronize <checkout_path> --prefix=config/locales --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey>  --file-format=json
-```
-
-**Download**
-
-`phraseapp_updater download` downloads and normalizes locale files from
-PhraseApp, saving them to the specified location. The revision of the recorded
-common ancestor is printed to standard out.
-
-```
-phraseapp_updater download --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey> --file-format=json <target_path>
-```
-
-**Upload**
-
-`phraseapp_updater upload` uploads normalized locale files from your branch to
-PhraseApp and resets the recorded common ancestor to the specified revision.
-
-```
-phraseapp_updater upload --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey> --file-format=json <path_to_locales>
-```
-
-**Update Parent Commit**
-`phraseapp_updater update_parent_commit` records a new common ancestor on
-PhraseApp without changing the locales.
-
-```
-phraseapp_updater update_parent_commit --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey> --parent_commit=<yournewhash>
-```
-
-**Merge**
-
-`phraseapp_updater merge` performs a content-aware three-way merge between
-locale files in three directories: `ancestor_path`, `our_path`, and
-`their_path`. In the case of conflicts, the changes from `our_path` are
-accepted. The results are normalized and written to the path specified with
-`to`.
-
-```
-phraseapp_updater merge ancestor_path our_path their_path --to target_path --file-format=json
-```
-
-
-**Diff**
-
-Performs a content-aware diff between locale files in two directories. Returns
-with exit status 1 or 0 to signal differences or no differences respectively
-
-```
-phraseapp_updater diff path1 path2 --file-format=json
-```
-
-## Future Improvements
-
-If you'd like to contribute, these would be very helpful!
-
-* We'd like to use "unverified" translations on PhraseApp as the equivalent of
-  an unstaged working copy. For this to work, we need to be able to recover
-  previous translations at the same key. While PhraseApp doesn't itself keep
-  this history, we could do this by restoring the absent keys from the diff
-  between verified and unverified download from the common ancestor.
-* Expose the changed files on the command line.
-* Checking if PhraseApp files changed during execution before upload, to reduce the race condition window.
-* More specs for the API and shell.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. When everything is working, make a pull request.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/iknow/phraseapp_updater. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,7 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-

data/nix/gem/Gemfile

@@ -1,24 +0,0 @@
-source "https://rubygems.org/"
-
-gem "byebug", "11.0.1"
-gem "coderay", "1.1.2"
-gem "deep_merge", "1.2.1"
-gem "diff-lcs", "1.3"
-gem "hashdiff", "0.4.0"
-gem "io-console", "0.5.4"
-gem "irb", "1.2.1"
-gem "method_source", "0.9.2"
-gem "multi_json", "1.14.1"
-gem "oj", "2.18.5"
-gem "parallel", "1.19.1"
-gem "phraseapp-ruby", "1.6.0"
-gem "pry", "0.12.2"
-gem "rake", "10.5.0"
-gem "reline", "0.1.2"
-gem "rspec", "3.8.0"
-gem "rspec-core", "3.8.0"
-gem "rspec-expectations", "3.8.3"
-gem "rspec-mocks", "3.8.0"
-gem "rspec-support", "3.8.0"
-gem "rspec_junit_formatter", "0.4.1"
-gem "thor", "0.20.3"

data/nix/gem/Gemfile.lock

@@ -1,68 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.0.1)
-    coderay (1.1.2)
-    deep_merge (1.2.1)
-    diff-lcs (1.3)
-    hashdiff (0.4.0)
-    io-console (0.5.4)
-    irb (1.2.1)
-      reline (>= 0.0.1)
-    method_source (0.9.2)
-    multi_json (1.14.1)
-    oj (2.18.5)
-    parallel (1.19.1)
-    phraseapp-ruby (1.6.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    reline (0.1.2)
-      io-console (~> 0.5)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    thor (0.20.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug (= 11.0.1)
-  coderay (= 1.1.2)
-  deep_merge (= 1.2.1)
-  diff-lcs (= 1.3)
-  hashdiff (= 0.4.0)
-  io-console (= 0.5.4)
-  irb (= 1.2.1)
-  method_source (= 0.9.2)
-  multi_json (= 1.14.1)
-  oj (= 2.18.5)
-  parallel (= 1.19.1)
-  phraseapp-ruby (= 1.6.0)
-  pry (= 0.12.2)
-  rake (= 10.5.0)
-  reline (= 0.1.2)
-  rspec (= 3.8.0)
-  rspec-core (= 3.8.0)
-  rspec-expectations (= 3.8.3)
-  rspec-mocks (= 3.8.0)
-  rspec-support (= 3.8.0)
-  rspec_junit_formatter (= 0.4.1)
-  thor (= 0.20.3)
-
-BUNDLED WITH
-   1.17.3

data/nix/gem/gemset.nix

@@ -1,230 +0,0 @@
-{
-  byebug = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1mmkls9n56l4gx2k0dnyianwz36z2zgpxli5bpsbr7jbw7hn2x6j";
-      type = "gem";
-    };
-    version = "11.0.1";
-  };
-  coderay = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "15vav4bhcc2x3jmi3izb11l4d9f3xv8hp2fszb7iqmpsccv1pz4y";
-      type = "gem";
-    };
-    version = "1.1.2";
-  };
-  deep_merge = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1q3picw7zx1xdkybmrnhmk2hycxzaa0jv4gqrby1s90dy5n7fmsb";
-      type = "gem";
-    };
-    version = "1.2.1";
-  };
-  diff-lcs = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "18w22bjz424gzafv6nzv98h0aqkwz3d9xhm7cbr1wfbyas8zayza";
-      type = "gem";
-    };
-    version = "1.3";
-  };
-  hashdiff = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1ncwxv7jbm3jj9phv6dd514463bkjwggxk10n2z100wf4cjcicrk";
-      type = "gem";
-    };
-    version = "0.4.0";
-  };
-  io-console = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "109yzpv9kslwra2mxnjsg3r6mwxkbqmxihj266qdvccapghi05wg";
-      type = "gem";
-    };
-    version = "0.5.4";
-  };
-  irb = {
-    dependencies = ["reline"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1r1y8i46qd5izdszzzn5jxvwvq00m89rk0hm8cs8f21p7nlwmh5w";
-      type = "gem";
-    };
-    version = "1.2.1";
-  };
-  method_source = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1pviwzvdqd90gn6y7illcdd9adapw8fczml933p5vl739dkvl3lq";
-      type = "gem";
-    };
-    version = "0.9.2";
-  };
-  multi_json = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0xy54mjf7xg41l8qrg1bqri75agdqmxap9z466fjismc1rn2jwfr";
-      type = "gem";
-    };
-    version = "1.14.1";
-  };
-  oj = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1jli4mi1xpmm8564pc09bfvv7znzqghidwa3zfw21r365ihmbv2p";
-      type = "gem";
-    };
-    version = "2.18.5";
-  };
-  parallel = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "12jijkap4akzdv11lm08dglsc8jmc87xcgq6947i1s3qb69f4zn2";
-      type = "gem";
-    };
-    version = "1.19.1";
-  };
-  phraseapp-ruby = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "14n2hhwjn32xk0qk6rprs3awnrddhnd4zckyd0a4j8lv8k648pnn";
-      type = "gem";
-    };
-    version = "1.6.0";
-  };
-  pry = {
-    dependencies = ["coderay" "method_source"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "00rm71x0r1jdycwbs83lf9l6p494m99asakbvqxh8rz7zwnlzg69";
-      type = "gem";
-    };
-    version = "0.12.2";
-  };
-  rake = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0jcabbgnjc788chx31sihc5pgbqnlc1c75wakmqlbjdm8jns2m9b";
-      type = "gem";
-    };
-    version = "10.5.0";
-  };
-  reline = {
-    dependencies = ["io-console"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0908ijrngc3wkn5iny7d0kxkp74w6ixk2nwzzngplplfla1vkp8x";
-      type = "gem";
-    };
-    version = "0.1.2";
-  };
-  rspec = {
-    dependencies = ["rspec-core" "rspec-expectations" "rspec-mocks"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "15ppasvb9qrscwlyjz67ppw1lnxiqnkzx5vkx1bd8x5n3dhikxc3";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec-core = {
-    dependencies = ["rspec-support"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1p1s5bnbqp3sxk67y0fh0x884jjym527r0vgmhbm81w7aq6b7l4p";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec-expectations = {
-    dependencies = ["diff-lcs" "rspec-support"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1c4gs5ybf7km0qshdm92p38zvg32n1j2kr5fgs2icacz7xf2y6fy";
-      type = "gem";
-    };
-    version = "3.8.3";
-  };
-  rspec-mocks = {
-    dependencies = ["diff-lcs" "rspec-support"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "06y508cjqycb4yfhxmb3nxn0v9xqf17qbd46l1dh4xhncinr4fyp";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec-support = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0p3m7drixrlhvj2zpc38b11x145bvm311x6f33jjcxmvcm0wq609";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec_junit_formatter = {
-    dependencies = ["rspec-core"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1aynmrgnv26pkprrajvp7advb8nbh0x4pkwk6jwq8qmwzarzk21p";
-      type = "gem";
-    };
-    version = "0.4.1";
-  };
-  thor = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1yhrnp9x8qcy5vc7g438amd5j9sw83ih7c30dr6g6slgw9zj3g29";
-      type = "gem";
-    };
-    version = "0.20.3";
-  };
-}

data/nix/generate.rb

@@ -1,41 +0,0 @@
-#! /usr/bin/env nix-shell
-#! nix-shell -i ruby -p ruby -p bundler -p bundix
-# frozen_string_literal: true
-
-# Bundix doesn't support `gemspec` directive in Gemfiles, as it doesn't copy the
-# gemspec (and its dependencies) into the store.
-# This workaround is from https://github.com/manveru/bundix/issues/10#issuecomment-405879379
-
-require 'shellwords'
-
-def sh(*args)
-  warn args.shelljoin
-  system(*args) || raise
-end
-
-sh 'bundle', 'lock'
-
-require 'fileutils'
-require 'bundler'
-
-lockfile = Bundler::LockfileParser.new(File.read('Gemfile.lock'))
-gems = lockfile.specs.select { |spec| spec.source.is_a?(Bundler::Source::Rubygems) }
-sources = [URI('https://rubygems.org/')] | gems.map(&:source).flat_map(&:remotes)
-
-FileUtils.mkdir_p 'nix/gem'
-Dir.chdir 'nix/gem' do
-  ['Gemfile', 'Gemfile.lock', 'gemset.nix'].each do |f|
-    File.delete(f) if File.exist?(f)
-  end
-
-  File.open('Gemfile', 'w') do |gemfile|
-    sources.each { |source| gemfile.puts "source #{source.to_s.inspect}" }
-    gemfile.puts
-
-    gems.each do |gem|
-      gemfile.puts "gem #{gem.name.inspect}, #{gem.version.to_s.inspect}"
-    end
-  end
-
-  sh 'bundix', '-l'
-end

data/phraseapp_updater.gemspec

@@ -1,35 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'phraseapp_updater/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "phraseapp_updater"
-  spec.version       = PhraseAppUpdater::VERSION
-  spec.authors       = ["Kevin Griffin"]
-  spec.email         = ["kev@bibo.com.ph"]
-
-  spec.summary       = %q{A three-way differ for PhraseApp projects.}
-  spec.description   = %q{A tool for merging data on PhraseApp with local changes (usually two git revisions)}
-  spec.homepage      = "https://app.engoo.com"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "bin"
-  spec.executables   = ["phraseapp_updater"]
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "thor", "~> 0.19"
-  spec.add_dependency "phraseapp-ruby", "~> 1.3"
-  spec.add_dependency "hashdiff", "~> 0.3"
-  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", "~> 2.2"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry", "~> 0.10"
-end
-

data/shell.nix

@@ -1,10 +0,0 @@
-with (import <nixpkgs> {});
-let
-  env = bundlerEnv {
-    name = "bundler-env";
-    gemdir  = ./nix/gem;
-  };
-in stdenv.mkDerivation {
-  name = "shell";
-  buildInputs = [ env ];
-}