crowdin-api 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48386263c0d9c28eb7d659a8a35ee2b634991556f6d90794fe02edad4f76bb9
-  data.tar.gz: dcdcfd4f4a1f9d0415d7eb8ec6e0db54adbf2e77db9da9dad40b3568aee3938e
+  metadata.gz: eb6299e8ac24c4e3bf9e7bbcf3d9741ded36842d56a7e294f9f534f4c05535a5
+  data.tar.gz: 04a58a1803638e00dd1c8b6a833fed4b8e01f56d19201a272ecbdeca4e0fd515
 SHA512:
-  metadata.gz: 2702291c599443bbc8b8454bbe0755eaeaf08de6433fdf6f516014332fd262e6daa26f3944888ff42d4cf03647f840371f78cfbd5a7ada30264d30cfbb5ad214
-  data.tar.gz: 160bada2b69cc096bca583296d8ee2d5bc390a72d0d62e633bd4f4ae7bde56ef169bf324f5b19d1d3d16ee18b906231d999198abb8cce2d6b3e99f51e3a524e5
+  metadata.gz: bb87a4d984c5f9955ac03908ba2d57eaa4ad5a06723de4683f513e3cf696a6b1013bcc1d2473a2aa231eea207afb8688a0baff61d9acc67fa53351a5284eaddd
+  data.tar.gz: d11b9902322de9ff89c6575e0b7915968d5627d887c144bcbe196021056399d80ded2f0ccae66e4a1b88eb8124b080f28cc30b552ca4df25d64b829bc4071ec6

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

@@ -29,7 +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/Gemfile

@@ -3,6 +3,6 @@
 source 'https://rubygems.org'
 
 # For Documentation
-gem 'yard', '~> 0.9.28'
+gem 'yard', '~> 0.9.36'
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crowdin-api (1.8.0)
+    crowdin-api (1.9.0)
       open-uri (>= 0.1.0, < 0.2.0)
       rest-client (>= 2.0.0, < 2.2.0)
 
@@ -14,7 +14,7 @@ GEM
     coderay (1.1.3)
     crack (0.4.5)
       rexml
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
@@ -47,19 +47,19 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -90,7 +90,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.34)
+    yard (0.9.36)
 
 PLATFORMS
   arm64-darwin-23
@@ -106,7 +106,7 @@ DEPENDENCIES
   simplecov (~> 0.22)
   simplecov-cobertura (~> 2.1)
   webmock (~> 3.14)
-  yard (~> 0.9.28)
+  yard (~> 0.9.36)
 
 BUNDLED WITH
    2.4.22

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.8.0'
+gem 'crowdin-api', '~> 1.9.0'
 ```
 
 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/lib/crowdin-api/api_resources/bundles.rb

@@ -70,9 +70,10 @@ module Crowdin
 
       # @param bundle_id [Integer] Bundle ID
       # @param export_id [String] Export ID
+      # @param destination [String] Destination of File
       # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.exports.download.get  API Documentation}
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.exports.download.get  Enterprise API Documentation}
-      def download_bundle(bundle_id, export_id, project_id = config.project_id)
+      def download_bundle(bundle_id, export_id, destination = nil, project_id = config.project_id)
         bundle_id  || raise_parameter_is_required_error(:bundle_id)
         export_id  || raise_parameter_is_required_error(:export_id)
         project_id || raise_project_id_is_required_error
@@ -82,7 +83,7 @@ module Crowdin
           :get,
           "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports/#{export_id}/download"
         )
-        Web::SendRequest.new(request).perform
+        Web::SendRequest.new(request, destination).perform
       end
 
       # @param bundle_id [Integer] Bundle ID

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.8.0'
+    VERSION = '1.9.0'
   end
 end

data/spec/api_resources/bundles_spec.rb

@@ -44,7 +44,7 @@ describe Crowdin::ApiResources::Bundles do
 
       it 'when request are valid', :default do
         stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports/#{export_id}/download")
-        download_bundle = @crowdin.download_bundle(bundle_id, export_id, project_id)
+        download_bundle = @crowdin.download_bundle(bundle_id, export_id, nil, project_id)
         expect(download_bundle).to eq(200)
       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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri