crowdin-api 1.7.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48893708d5c6c19787dec33d3e7f19c87809e6ab33e17d6b54821483cae925d0
-  data.tar.gz: 4b43a6b919c72b31da170f6d30e771faa07e85e7ebc7845d732a528262e8271d
+  metadata.gz: ff9548440dd2a2a312ae867def3cdcfd0fccd70c2bb1341380483a94776a09f1
+  data.tar.gz: 67f2e731d323f60d9af9cd917b535fece3524e3467802be69ecaad1a377fae7d
 SHA512:
-  metadata.gz: b99fa959c8338fb9c5557eab55e1dd76964d139eb5e4e411fee8d7cb2b352b559beec71974202c76b0e84995042152fbfe244ef1c56a4618081faa4e03c20c4f
-  data.tar.gz: 90f971f1453892aa47fb7a1ac25bcd8a91a92273b32022b41b647a54a762f180f68d45562f8d009a8a6cd512f217cb25ebedd98927c9f714501c8a229ff1c870
+  metadata.gz: 6bd609157edfa0b5368266142ba8b905d1ff032f237fc73227fd4d25d0ff34098190957bea2840f3278570cf5d8010f5b34e2623d98dce3a2abf49127bf9b79a
+  data.tar.gz: 73dc2a5962b51193fc9376d0644ee3daef308a0f2bfc797e3fcbb6a28ca8c3e26ce40107863ff4b3dda8598e715eb5405467640bcbdf6b2b2cf133053ad9b435

data/.github/workflows/test-and-lint.yml

@@ -29,6 +29,7 @@ jobs:
           bundle exec rake
 
       - name: Publish code coverage report
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
+        if: matrix.ruby-version == '3.0'
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

data/.release-it.json

@@ -24,6 +24,11 @@
           "file": "lib/crowdin-api/client/version.rb",
           "search": "VERSION = '\\d+\\.\\d+\\.\\d+'",
           "replace": "VERSION = '{{versionWithoutPrerelease}}'"
+        },
+        {
+          "file": "Gemfile.lock",
+          "search": "crowdin-api \\(\\d+\\.\\d+\\.\\d+\\)",
+          "replace": "crowdin-api ({{versionWithoutPrerelease}})"
         }
       ]
     }

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crowdin-api (1.7.0)
+    crowdin-api (1.8.1)
       open-uri (>= 0.1.0, < 0.2.0)
       rest-client (>= 2.0.0, < 2.2.0)
 
@@ -11,8 +11,6 @@ GEM
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    codecov (0.6.0)
-      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
     crack (0.4.5)
       rexml
@@ -75,10 +73,13 @@ GEM
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     unf (0.1.4)
@@ -92,16 +93,18 @@ GEM
     yard (0.9.34)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.2, >= 2.2.32)
-  codecov (~> 0.6.0)
   crowdin-api!
   pry (~> 0.14.1)
   rake (~> 13.0, >= 13.0.6)
   rspec (~> 3.10)
   rubocop (~> 1.23)
+  simplecov (~> 0.22)
+  simplecov-cobertura (~> 2.1)
   webmock (~> 3.14)
   yard (~> 0.9.28)
 

data/README.md

@@ -35,7 +35,7 @@ Crowdin API is a full-featured RESTful API that helps you to integrate localizat
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.7.0'
+gem 'crowdin-api', '~> 1.8.1'
 ```
 
 And then execute:
@@ -120,8 +120,8 @@ storage = crowdin.add_storage('YourFilename.extension')
 
 # Download file
 file = crowdin.download_file(your_file_id, your_destination, your_project_id)
-# your_destination - filename or absolute path to file, optional
-# Without destination option file will be saved to the current directory with a default filename
+# your_destination - filename or absolute path to the file, optional
+# Without a destination option, the file will not be saved automatically
 # project_id is optional, as it can be initialized with a Crowdin Client
 
 # File revisions

data/crowdin-api.gemspec

@@ -23,10 +23,11 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rest-client', '>= 2.0.0', '< 2.2.0'
 
   gem.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.32'
-  gem.add_development_dependency 'codecov', '~> 0.6.0'
   gem.add_development_dependency 'pry', '~> 0.14.1'
   gem.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   gem.add_development_dependency 'rspec', '~> 3.10'
   gem.add_development_dependency 'rubocop', '~> 1.23'
+  gem.add_development_dependency 'simplecov', '~> 0.22'
+  gem.add_development_dependency 'simplecov-cobertura', '~> 2.1'
   gem.add_development_dependency 'webmock', '~> 3.14'
 end

data/lib/crowdin-api/api_resources/storages.rb

@@ -22,7 +22,7 @@ module Crowdin
       def add_storage(file = nil)
         file || raise_parameter_is_required_error(:file)
 
-        file ||= File.open(file, 'r')
+        file = File.open(file, 'r')
         headers = { 'Content-Type' => 'application/octet-stream', 'Crowdin-API-FileName' => File.basename(file) }
 
         request = Web::Request.new(

data/lib/crowdin-api/api_resources/translations.rb

@@ -44,7 +44,8 @@ module Crowdin
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
 
-        headers = query[:eTag] ? { 'If-None-Match' => query[:eTag] } : {}
+        etag = query.delete(:eTag)
+        headers = etag ? { 'If-None-Match' => etag } : {}
 
         request = Web::Request.new(
           connection,

data/lib/crowdin-api/client/version.rb

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.7.0'
+    VERSION = '1.8.1'
   end
 end

data/lib/crowdin-api/core/send_request.rb

@@ -44,7 +44,7 @@ module Crowdin
         end
 
         def fetch_response_data(doc)
-          if doc['data'].is_a?(Hash) && doc['data']['url'] && doc['data']['url'].include?('response-content-disposition')
+          if @file_destination && doc['data'].is_a?(Hash) && doc['data']['url']
             download_file(doc['data']['url'])
           else
             doc
@@ -53,8 +53,7 @@ module Crowdin
 
         def download_file(url)
           download    = URI.parse(url).open
-          destination = @file_destination || download.meta['content-disposition']
-                                                     .match(/filename=("?)(.+)\1/)[2]
+          destination = @file_destination
 
           IO.copy_stream(download, destination)
 

data/spec/api_resources/storages_spec.rb

@@ -11,10 +11,26 @@ describe Crowdin::ApiResources::Storages do
     end
 
     describe '#add_storage' do
-      it 'when request are valid', :default do
+      subject(:add_storage) { @crowdin.add_storage(file) }
+
+      let(:file) { 'README.md' }
+
+      it 'uploads the file to the storage', :default do
+        expected_response = 'expected_response'
+
         stub_request(:post, "https://api.crowdin.com/#{target_api_url}/storages")
-        add_storage = @crowdin.add_storage('README.md')
-        expect(add_storage).to eq(200)
+          .with(
+            body: File.read(file),
+            headers: {
+              'Content-Type' => 'application/octet-stream',
+              'Crowdin-API-FileName' => File.basename(file)
+            }
+          )
+          .to_return(
+            body: JSON.dump(expected_response)
+          )
+
+        is_expected.to eq(expected_response)
       end
     end
 

data/spec/api_resources/translations_spec.rb

@@ -31,12 +31,49 @@ describe Crowdin::ApiResources::Translations do
     end
 
     describe '#build_project_file_translation' do
+      subject(:build_project_file_translation) do
+        @crowdin.build_project_file_translation(file_id, query, destination, project_id)
+      end
+
       let(:file_id) { 1 }
+      let(:query) { { targetLanguageId: target_language_id } }
+      let(:destination) { nil }
+
+      let(:target_language_id) { 'expected_language_id' }
+
+      it 'builds project file translation', :default do
+        expected_response = 'expected_response'
 
-      it 'when request are valid', :default do
         stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds/files/#{file_id}")
-        build_project_file_translation = @crowdin.build_project_file_translation(file_id, {}, nil, project_id)
-        expect(build_project_file_translation).to eq(200)
+          .with(
+            body: JSON.dump(query)
+          )
+          .to_return(
+            body: JSON.dump(expected_response)
+          )
+
+        is_expected.to eq(expected_response)
+      end
+
+      context 'when the `eTag` query param is passed' do
+        let(:query) { { targetLanguageId: 'expected_language_id', eTag: etag } }
+
+        let(:etag) { 'expected_etag' }
+
+        it 'builds project file translation for new changes after the passed `eTag`', :default do
+          expected_response = 'expected_response'
+
+          stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds/files/#{file_id}")
+            .with(
+              body: JSON.dump({ targetLanguageId: target_language_id }),
+              headers: { 'If-None-Match' => etag }
+            )
+            .to_return(
+              body: JSON.dump(expected_response)
+            )
+
+          is_expected.to eq(expected_response)
+        end
       end
     end
 

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'simplecov'
-require 'codecov'
+require 'simplecov-cobertura'
 
 SimpleCov.start
-SimpleCov.formatter = SimpleCov::Formatter::Codecov
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 
 require 'webmock/rspec'
 require 'crowdin-api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -70,20 +70,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.32
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +132,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement