txgh 7.0.0.beta4 → 7.0.3.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 115f8465e3521a85f6ebb9fb137410cdef753203d30dca1343bc00261d832db9
-  data.tar.gz: d3b5774e8a1d1699e7dd47b5537d74075004b3b2def59f8457c259ad518d8c7a
+  metadata.gz: c3a11b6e9eb48bcfe3241f743860dbb03ca79feabcc1fdd71003b0d63c5422e3
+  data.tar.gz: e242240afb44fcfaf2e02126a49e1289375ad70a2c86bdc3a90a4a1863c3e318
 SHA512:
-  metadata.gz: 566fe97c0391c74fc21924b101f34727956bd3cc1a49c31f47b8a8c30d2a86876c9f3997ce8e8daa89584e2971bed0211843c3120e5f783293996cedaae3add9
-  data.tar.gz: 9986dfc7e5875e0c1b0ae8534d71ba02d86f2c2b2ad995930ebb52fe92bfe723a2e0a99ea9a61b7b813dca627e94ce4002e85940b2e97065bbf917bc477b9f16
+  metadata.gz: bfb8768d65b42a633ae33941535267b6efac5efad04088768d53202ffb1b6d8cce2d00a5652639073e07a3768e30a85c96fb4aa4e3ee1db1a0205bc429f1919d
+  data.tar.gz: 1894bfaab37dea410cc31b6994e8d1a5ebeb1f0a1944db50d1990fe54d0fa8bd9c32cffe3470983912d3572bae0ca8bbb09f96f4a416b8128987842102819b7c

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_api.rb

@@ -14,72 +14,5 @@ module Txgh
       @client = client
       @repo_name = repo_name
     end
-
-    def tree(sha)
-      client.tree(repo_name, sha, recursive: 1)
-    end
-
-    def blob(sha)
-      client.blob(repo_name, sha)
-    end
-
-    def create_ref(branch, sha)
-      client.create_ref(repo_name, branch, sha) rescue false
-    end
-
-    def update_contents(branch, content_list, message)
-      content_list.each do |file_params|
-        path = file_params.fetch(:path)
-        new_contents = file_params.fetch(:contents)
-        branch = Utils.relative_branch(branch)
-
-        file_sha = file_params.fetch(:sha) do
-          begin
-            client.contents(repo_name, { path: path, ref: branch })[:sha]
-          rescue Octokit::NotFound
-            nil
-          end
-        end
-
-        # If the file doesnt exist, then it isn't tracked by git and file_sha
-        # will be nil. In git land, a SHA of all zeroes means create a new file
-        # instead of updating an existing one.
-        current_sha = file_sha || '0' * 40
-        new_sha = Utils.git_hash_blob(new_contents)
-        options = { branch: branch }
-
-        if current_sha != new_sha
-          client.update_contents(
-            repo_name, path, message, current_sha, new_contents, options
-          )
-        end
-      end
-    end
-
-    def get_commit(sha)
-      client.commit(repo_name, sha)
-    end
-
-    def get_ref(ref)
-      client.ref(repo_name, ref)
-    end
-
-    def download(path, branch)
-      file = client.contents(repo_name, { path: path, ref: branch }).to_h
-
-      file[:content] = case file[:encoding]
-        when 'base64'
-          Base64.decode64(file[:content])
-        else
-          file[:content].force_encoding(file[:encoding])
-      end
-
-      file.delete(:encoding)
-      file
-    end
-
-    def create_status(sha, state, options = {})
-      client.create_status(repo_name, sha, state, options)
-    end
   end
 end

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,11 +16,11 @@ 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
-            client.get_file(repo_name, path, branch).content_sha256
+            client.get_file(repo_name, path, branch).blob_id
           rescue ::Gitlab::Error::NotFound
             nil
           end
@@ -42,22 +42,26 @@ 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
       {
-        content: file.encoding == 'base64' ? Base64.decode64(file.content) : file.content.force_encoding(file.encoding)
+        content: file.encoding == 'base64' ? Base64.decode64(file.content) : file.content.force_encoding(file.encoding),
+        path: path
       }
     end
 
     def create_status(sha, state, options = {})
       client.update_commit_status(repo_name, 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.beta4'
+  VERSION = '7.0.3.beta1'
 end

data/spec/github_api_spec.rb

@@ -37,7 +37,7 @@ describe Txgh::GithubApi do
   describe '#update_contents' do
     let(:path) { 'path/to/file.txt' }
     let(:old_contents) { 'abc123' }
-    let(:old_sha) { Utils.git_hash_blob(old_contents) }
+    let(:old_sha) { Txgh::Utils.git_hash_blob(old_contents) }
 
     it 'updates the given file contents' do
       new_contents = 'def456'

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) { 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)
-          .and_return(double(content_sha256: old_sha))
+          .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,8 +38,8 @@ 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)
-          .and_return(double(content_sha256: old_sha))
+          .with(repo, path, url_safe_branch)
+          .and_return(double(blob_id: old_sha))
       )
 
       expect(client).to_not receive(:edit_file)
@@ -58,31 +53,22 @@ 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'))
       )
 
-      expect(api.download(path, branch)).to eq({ content: 'content' })
+      expect(api.download(path, branch)).to eq({ content: 'content', path: path })
     end
 
     it 'encodes the string using the encoding specified in the response' do
@@ -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' })
+      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,7 +13,7 @@ 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'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: txgh
 version: !ruby/object:Gem::Version
-  version: 7.0.0.beta4
+  version: 7.0.3.beta1
 platform: ruby
 authors:
 - Matthew Jackowski
 - Cameron Dutro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-12-08 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
@@ -213,7 +213,7 @@ files:
 homepage: https://github.com/lumoslabs/txgh
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -228,8 +228,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: A library for syncing translation resources between Github and Transifex.
 test_files: []