txgh 7.0.0 → 7.0.3.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58660adf06989ee42433b8f854a4fc7025e78e605fd622f53b43f1029431017e
-  data.tar.gz: ddbf9fb3ce19ea72dcd88e3536a888dab21d5f2470017b38a87f061191e7c34d
+  metadata.gz: ddb70a73202419003bba2aeda693a5a704be5b88980c29da7a082cb1f3263162
+  data.tar.gz: 302e2a9608de1fb9f09ca065cdf15aa84c49319c6ac0c9660cf05a0491479e85
 SHA512:
-  metadata.gz: 336679c86da9f06925633874c3937a3cc629f752586179bc5807838da453bfe6fb2ddb527fcf9beda5e99c62ea605d24a5fdf540fe1a7a0b66595bc45b1bcaa2
-  data.tar.gz: c97b87817b63ad658bb66b8b47927737dfaa5c61c7bce2c440ce75cbbcf0f78aa3e3a49e76968fa72e3cfa3c8fb93686e9c05bde1399e8ea2ef2230adb3d0ca0
+  metadata.gz: 1d9fd68fe5103f5ff3b6e7754bfd175b593878dfcfe72a785e059bb38a8254bc2402d8f08db6743a7992c06890d55cdcb6f3728d7fbdce3ec4b7ecf9b06d87ce
+  data.tar.gz: f22f1e1c1ec3ce35737f96b17b0b77cf488be246f255c26a6377352e5c8138bcf92cb45d07ceb7d559d0462206ae70a87c0d4203a41b93cd012804ab62e4b479

data/lib/txgh/config/providers/git_provider.rb

@@ -33,14 +33,10 @@ module Txgh
 
         private
 
-        def download
-          raise NotImplementedError
-        end
-
         def ref
           unless @ref
             raise TxghError,
-              "TX_CONFIG specified a file from git but did not provide a ref."
+              'TX_CONFIG specified a file from git but did not provide a ref.'
           end
 
           @ref
@@ -49,7 +45,7 @@ module Txgh
         def git_repo
           unless @git_repo
             raise TxghError,
-              "TX_CONFIG specified a file from git but did not provide a repo."
+              'TX_CONFIG specified a file from git but did not provide a repo.'
           end
 
           @git_repo

data/lib/txgh/config/providers/github_provider.rb

@@ -1,3 +1,5 @@
+require 'octokit'
+
 module Txgh
   module Config
     module Providers

data/lib/txgh/config/providers/gitlab_provider.rb

@@ -1,3 +1,5 @@
+require 'gitlab'
+
 module Txgh
   module Config
     module Providers

data/lib/txgh/git_status.rb

@@ -1,4 +1,4 @@
-require 'celluloid/current'
+require 'celluloid/autostart'
 
 module Txgh
   class GitStatus

data/lib/txgh/gitlab_api.rb

@@ -16,7 +16,7 @@ module Txgh
       content_list.each do |file_params|
         path = file_params.fetch(:path)
         new_contents = file_params.fetch(:contents)
-        branch = Utils.relative_branch(branch)
+        branch = Utils.url_safe_relative_branch(branch)
 
         file_sha = file_params.fetch(:sha) do
           begin
@@ -42,13 +42,13 @@ module Txgh
       # mock github response
       {
         object: {
-          sha: client.commit(repo_name, ref.gsub('heads/', '')).short_id
+          sha: client.commit(repo_name, Utils.url_safe_relative_branch(ref)).short_id
         }
       }
     end
 
     def download(path, branch)
-      file = client.get_file(repo_name, path, branch.gsub('heads/', ''))
+      file = client.get_file(repo_name, path, Utils.url_safe_relative_branch(branch))
 
       # mock github response
       {
@@ -58,7 +58,10 @@ module Txgh
     end
 
     def create_status(sha, state, options = {})
-      client.update_commit_status(repo_name, sha, state, options)
+      client.update_commit_status(repo_name, Utils.url_safe_relative_branch(sha), state, options)
+    rescue ::Gitlab::Error::BadRequest => error
+      # Gitlab pipeline may have several jobs and txgh should not override commit statuses set by others
+      raise error unless error.message.include?('Cannot transition status')
     end
   end
 end

data/lib/txgh/utils.rb

@@ -24,6 +24,10 @@ module Txgh
       branch.strip.sub(/\A(heads|tags)\//, '')
     end
 
+    def url_safe_relative_branch(branch)
+      CGI.escape(relative_branch(branch))
+    end
+
     def branches_equal?(first, second)
       absolute_branch(first) == absolute_branch(second)
     end

data/lib/txgh/version.rb

@@ -1,3 +1,3 @@
 module Txgh
-  VERSION = '7.0.0'
+  VERSION = '7.0.3.beta3'
 end

data/spec/gitlab_api_spec.rb

@@ -5,7 +5,6 @@ describe Txgh::GitlabApi do
   let(:client) { double(:client) }
   let(:api) { described_class.create_from_client(client, repo) }
   let(:repo) { 'my_org/my_repo' }
-  let(:branch) { 'master' }
   let(:sha) { 'abc123' }
   let(:gitlab_response) do
     OpenStruct.new({
@@ -18,23 +17,19 @@ describe Txgh::GitlabApi do
     })
   end
 
-  describe '#update_contents' do
-    let(:path) { 'path/to/file.txt' }
-    let(:old_contents) { 'abc123' }
-    let(:old_sha) { Txgh::Utils.git_hash_blob(old_contents) }
-
+  shared_examples 'an update_contents flow' do
     it 'updates the given file contents' do
       new_contents = 'def456'
 
       expect(client).to(
         receive(:get_file)
-          .with(repo, path, branch)
+          .with(repo, path, url_safe_branch)
           .and_return(double(blob_id: old_sha))
       )
 
       expect(client).to(
         receive(:edit_file)
-          .with(repo, path, branch, new_contents, 'message')
+          .with(repo, path, url_safe_branch, new_contents, 'message')
       )
 
       api.update_contents(branch, [{ path: path, contents: new_contents }], 'message')
@@ -43,7 +38,7 @@ describe Txgh::GitlabApi do
     it "doesn't update the file contents if the file hasn't changed" do
       expect(client).to(
         receive(:get_file)
-          .with(repo, path, branch)
+          .with(repo, path, url_safe_branch)
           .and_return(double(blob_id: old_sha))
       )
 
@@ -58,27 +53,18 @@ describe Txgh::GitlabApi do
 
       expect(client).to(
         receive(:edit_file)
-          .with(repo, path, branch, new_contents, 'message')
+          .with(repo, path, url_safe_branch, new_contents, 'message')
       )
 
       api.update_contents(branch, [{ path: path, contents: new_contents }], 'message')
     end
   end
 
-  describe '#get_ref' do
-    it 'retrieves the given ref (i.e. branch) using the client' do
-      expect(client).to receive(:commit).with(repo, sha) { double(short_id: '0') }
-      api.get_ref(sha)
-    end
-  end
-
-  describe '#download' do
-    let(:path) { 'path/to/file.xyz' }
-
+  shared_examples 'a download flow' do
     it 'downloads the file from the given branch' do
       expect(client).to(
         receive(:get_file)
-          .with(repo, path, branch)
+          .with(repo, path, url_safe_branch)
           .and_return(double(content: 'content', encoding: 'utf-8'))
       )
 
@@ -90,7 +76,7 @@ describe Txgh::GitlabApi do
 
       expect(client).to(
         receive(:get_file)
-          .with(repo, path, branch)
+          .with(repo, path, url_safe_branch)
           .and_return(double(content: content, encoding: 'utf-16'))
       )
 
@@ -102,11 +88,96 @@ describe Txgh::GitlabApi do
     it 'automatically decodes base64-encoded content' do
       expect(client).to(
         receive(:get_file)
-          .with(repo, path, branch)
+          .with(repo, path, url_safe_branch)
           .and_return(double(content: Base64.encode64('content'), encoding: 'base64'))
       )
 
       expect(api.download(path, branch)).to eq({ content: 'content', path: path })
     end
   end
+
+  describe '#update_contents' do
+    let(:path) { 'path/to/file.txt' }
+    let(:old_contents) { 'abc123' }
+    let(:old_sha) { Txgh::Utils.git_hash_blob(old_contents) }
+
+    context 'when master branch' do
+      let(:branch) { 'master' }
+      let(:url_safe_branch) { 'master' }
+
+      it_behaves_like 'an update_contents flow'
+    end
+
+    context 'when feature branch' do
+      let(:branch) { 'feature/foo-ticket' }
+      let(:url_safe_branch) { 'feature%2Ffoo-ticket' }
+
+      it_behaves_like 'an update_contents flow'
+    end
+  end
+
+  describe '#get_ref' do
+    context 'when ref is a sha' do
+      it 'retrieves the given ref (i.e. branch) using the client' do
+        expect(client).to receive(:commit).with(repo, sha) { double(short_id: '0') }
+        api.get_ref(sha)
+      end
+    end
+
+    context 'when ref is a master branch' do
+      let(:sha) { 'master' }
+
+      it 'retrieves the given ref (i.e. branch) using the client' do
+        expect(client).to receive(:commit).with(repo, sha) { double(short_id: '0') }
+        api.get_ref(sha)
+      end
+    end
+
+    context 'when ref is a feature branch' do
+      let(:sha) { 'feature/foo-ticket' }
+      let(:url_safe_sha) { 'feature%2Ffoo-ticket' }
+
+      it 'retrieves the given ref (i.e. branch) using the client' do
+        expect(client).to receive(:commit).with(repo, url_safe_sha) { double(short_id: '0') }
+        api.get_ref(sha)
+      end
+    end
+  end
+
+  describe '#download' do
+    let(:path) { 'path/to/file.xyz' }
+
+    context 'when master branch' do
+      let(:branch) { 'master' }
+      let(:url_safe_branch) { 'master' }
+
+      it_behaves_like 'a download flow'
+    end
+
+    context 'when feature branch' do
+      let(:branch) { 'feature/foo-ticket' }
+      let(:url_safe_branch) { 'feature%2Ffoo-ticket' }
+
+      it_behaves_like 'a download flow'
+    end
+  end
+
+  describe '#create_status' do
+    let(:gitlab_response) do
+      OpenStruct.new({
+        code: 404,
+        request: double(base_uri: 'https://gitlab.com/api/v3', path: '/foo'),
+        parsed_response: Gitlab::ObjectifiedHash.new(
+          error_description: 'Cannot transition status via :enqueue from :pending',
+          error: 'also will not be displayed'
+        )
+      })
+    end
+
+    it 'does not raise error if cannot change status' do
+      expect(client).to receive(:update_commit_status).and_raise(::Gitlab::Error::BadRequest.new(gitlab_response))
+
+      api.create_status('sha', 'state', {})
+    end
+  end
 end

data/spec/utils_spec.rb

@@ -47,6 +47,20 @@ describe Txgh::Utils do
     end
   end
 
+  describe '.url_safe_relative_branch' do
+    it 'removes tags/ if present' do
+      expect(described_class.url_safe_relative_branch('tags/feature/foobar')).to eq('feature%2Ffoobar')
+    end
+
+    it 'removes heads/ if present' do
+      expect(described_class.url_safe_relative_branch('heads/foobar')).to eq('foobar')
+    end
+
+    it 'does nothing if no prefix can be removed' do
+      expect(described_class.url_safe_relative_branch('feature/foo-ticket')).to eq('feature%2Ffoo-ticket')
+    end
+  end
+
   describe '.is_tag?' do
     it 'returns true if given a tag' do
       expect(described_class.is_tag?('tags/foo')).to eq(true)

data/txgh.gemspec

@@ -13,10 +13,10 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.add_dependency 'abroad', '~> 4.6'
-  s.add_dependency 'celluloid'
+  s.add_dependency 'celluloid', '~> 0.18.0'
   s.add_dependency 'faraday', '0.17.3'
   s.add_dependency 'faraday_middleware', '0.14.0'
-  s.add_dependency 'json', '~> 1.8'
+  s.add_dependency 'json', '~> 2.3'
   s.add_dependency 'octokit', '~> 4.2'
   s.add_dependency 'gitlab', '~> 4.14'
   s.add_dependency 'parseconfig', '~> 1.0'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: txgh
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.0.3.beta3
 platform: ruby
 authors:
 - Matthew Jackowski
 - Cameron Dutro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abroad
@@ -29,16 +29,16 @@ dependencies:
   name: celluloid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -213,7 +213,7 @@ files:
 homepage: https://github.com/lumoslabs/txgh
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -224,13 +224,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A library for syncing translation resources between Github and Transifex.
 test_files: []