crowdin-api 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ed7c31fb89ca5299a07d1fe3c828f7686e36d74ad710dc5e1b115598f90fe7
-  data.tar.gz: fd8069c348ff758595bbc18a3f8684f6d220b1a53d00fac2fc0af0751b213087
+  metadata.gz: 9cd5b2539130f20d40ab8eae20e4291675e8b58c27883fd7ce59323492ad4daa
+  data.tar.gz: 699e9cc4411451da663e4bb59abb4a641c8dad98c9bb82dac475e11882facc59
 SHA512:
-  metadata.gz: 6014441ccc9d7c0a1e6a11e20611ee686cff396da2d596c12a1293d701f0395d5ff4adc730098301b4563f3167e5d7af54d15579e401578f822dadeb65066101
-  data.tar.gz: afa63e70a5616430e750429bb5b99e4d30e89ae92bbec440eb3fa2e5b7fbeb1319ff4c4947812ae8878597cd7850725f58018c094aa6d0ea2a02230b0ed8e799
+  metadata.gz: e80a6940f20de8d1e70d4edbec95d468137ae5b9b4979ed005e920c6e5fe2e9d794ed5dfe43120766c0e3d9a2e9e7aaa2d8c1abfbfd1c566c19b688d3a494224
+  data.tar.gz: 62102d71575df111fbeed6f28fba6b7a91d66fc2835174df83ca51138df0fc3b242937363f55f07d8d1b046fb405179bd6c953e3732cdc39f05c4dbfb057e19f

data/.github/workflows/release.yml

@@ -24,6 +24,6 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: peter-evans/repository-dispatch@v2
+      - uses: peter-evans/repository-dispatch@v3
         with:
           event-type: publish

data/.rubocop.yml

@@ -6,3 +6,7 @@ AllCops:
 
 Gemspec/DevelopmentDependencies:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crowdin-api (1.11.0)
+    crowdin-api (1.12.0)
       open-uri (>= 0.1.0, < 0.2.0)
       rest-client (>= 2.0.0, < 2.2.0)
 

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.11.0'
+gem 'crowdin-api', '~> 1.12.0'
 ```
 
 And then execute:

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

@@ -73,6 +73,89 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param project_id [Integer] Project ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.strings-exporter-settings.getMany  Enterprise API Documentation}
+      def list_project_strings_exporter_settings(project_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/strings-exporter-settings"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_id [Integer] Project ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.strings-exporter-settings.post  Enterprise API Documentation}
+      def add_project_strings_exporter_settings(project_id = nil, query = {})
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/strings-exporter-settings",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_id [Integer] Project ID
+      # @param system_strings_exporter_settings_id [Integer] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.strings-exporter-settings.get  Enterprise API Documentation}
+      def get_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+        system_strings_exporter_settings_id || raise_parameter_is_required_error(:system_strings_exporter_settings_id)
+
+        path = "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}"
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/#{path}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_id [Integer] Project ID
+      # @param system_strings_exporter_settings_id [Integer] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.strings-exporter-settings.delete  Enterprise API Documentation}
+      def delete_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+        system_strings_exporter_settings_id || raise_parameter_is_required_error(:system_strings_exporter_settings_id)
+
+        path = "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}"
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/#{path}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_id [Integer] Project ID
+      # @param system_strings_exporter_settings_id [Integer] Request Body
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.strings-exporter-settings.patch  Enterprise API Documentation}
+      def edit_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil, query = {})
+        project_id || raise_parameter_is_required_error(:project_id)
+        system_strings_exporter_settings_id || raise_parameter_is_required_error(:system_strings_exporter_settings_id)
+
+        path = "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}"
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/#{path}",
+          params: query
+        )
+        Web::SendRequest.new(request).perform
+      end
+
       # -- For Enterprise mode only --
 
       # @param query [Hash] Request Body

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

@@ -267,6 +267,22 @@ module Crowdin
         Web::SendRequest.new(request, destination).perform
       end
 
+      # @param file_id [Integer] File ID
+      # @param destination [String] Destination of File
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.preview.get API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.preview.get Enterprise API Documentation}
+      def download_file_preview(file_id = nil, destination = nil, project_id = config.project_id)
+        file_id     || raise_parameter_is_required_error(:file_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/preview"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
       # @param query [Hash] Request Body
       # @param file_id [Integer] File ID
       # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany API Documentation}

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

@@ -51,6 +51,18 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      def remove_string_approvals(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/approvals",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
       def list_language_translations(language_id = nil, query = {}, project_id = config.project_id)
         language_id || raise_parameter_is_required_error(:language_id)
         project_id  || raise_project_id_is_required_error
@@ -91,17 +103,13 @@ module Crowdin
       def delete_string_translations(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
-        response = ::RestClient::Request.execute(
-          {
-            method: :delete,
-            url: config.base_url + config.target_api_url + "/projects/#{project_id}/translations",
-            payload: query.to_json
-          }.merge(@options)
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/translations",
+          { params: query }
         )
-
-        response.body.empty? ? response.code : JSON.parse(response.body)
-      rescue StandardError => e
-        e.message
+        Web::SendRequest.new(request).perform
       end
 
       def get_translation(translation_id = nil, query = {}, project_id = config.project_id)

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

@@ -27,6 +27,31 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      def list_pre_translations(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/pre-translations",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_pre_translations(pre_translation_id = nil, query = {}, project_id = config.project_id)
+        pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
+        project_id         || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
       def build_project_directory_translation(directory_id = nil, query = {}, project_id = config.project_id)
         directory_id || raise_parameter_is_required_error(:directory_id)
         project_id   || raise_project_id_is_required_error

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

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.11.0'
+    VERSION = '1.12.0'
   end
 end

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

@@ -26,7 +26,7 @@ module Crowdin
       end
 
       def delete
-        connection.delete
+        connection.delete(prepare_payload(payload[:params]))
       end
 
       def process_with_body
@@ -60,7 +60,7 @@ module Crowdin
         def prepare_payload(params)
           return params if params.is_a?(File)
 
-          get? ? { params: fetch_cleared_params(params) } : fetch_cleared_params(params).to_json
+          get? || delete? ? { params: fetch_cleared_params(params) } : fetch_cleared_params(params).to_json
         end
 
         def fetch_cleared_params(params)

data/spec/api_resources/projects_spec.rb

@@ -94,6 +94,117 @@ describe Crowdin::ApiResources::Projects do
         expect { @crowdin.edit_project }.to raise_error(ArgumentError)
       end
     end
+
+    describe '#list_project_strings_exporter_settings' do
+      let(:project_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings-exporter-settings")
+        list_project_strings_exporter_settings = @crowdin.list_project_strings_exporter_settings(project_id)
+        expect(list_project_strings_exporter_settings).to eq(200)
+      end
+
+      it 'when the request is invalid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings-exporter-settings")
+        expect { @crowdin.list_project_strings_exporter_settings }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#add_project_strings_exporter_settings' do
+      let(:project_id) { 1 }
+      let(:body) do
+        {
+          format: 'json',
+          settings: {
+            convertPlaceholders: true,
+            convertLineBreaks: true
+          }
+        }
+      end
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings-exporter-settings")
+          .with(body: body.to_json)
+        add_project_strings_exporter_settings = @crowdin.add_project_strings_exporter_settings(project_id, body)
+        expect(add_project_strings_exporter_settings).to eq(200)
+      end
+
+      it 'when the request is invalid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings-exporter-settings")
+        expect { @crowdin.add_project_strings_exporter_settings }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#get_project_strings_exporter_settings' do
+      let(:project_id) { 1 }
+      let(:system_strings_exporter_settings_id) { 1 }
+      let(:path) { "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}" }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/#{path}")
+        get_project_strings_exporter_settings = @crowdin.get_project_strings_exporter_settings(
+          project_id,
+          system_strings_exporter_settings_id
+        )
+        expect(get_project_strings_exporter_settings).to eq(200)
+      end
+
+      it 'when the request is invalid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/#{path}")
+        expect { @crowdin.get_project_strings_exporter_settings }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#delete_project_strings_exporter_settings' do
+      let(:project_id) { 1 }
+      let(:system_strings_exporter_settings_id) { 1 }
+      let(:path) { "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}" }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/#{path}")
+        delete_project_strings_exporter_settings = @crowdin.delete_project_strings_exporter_settings(
+          project_id,
+          system_strings_exporter_settings_id
+        )
+        expect(delete_project_strings_exporter_settings).to eq(200)
+      end
+
+      it 'when the request is invalid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/#{path}")
+        expect { @crowdin.delete_project_strings_exporter_settings }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#edit_project_strings_exporter_settings' do
+      let(:project_id) { 1 }
+      let(:system_strings_exporter_settings_id) { 1 }
+      let(:body) do
+        {
+          format: 'json',
+          settings: {
+            convertPlaceholders: true,
+            convertLineBreaks: true
+          }
+        }
+      end
+      let(:path) { "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}" }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/#{path}")
+          .with(body: body.to_json)
+        edit_project_strings_exporter_settings = @crowdin.edit_project_strings_exporter_settings(
+          project_id,
+          system_strings_exporter_settings_id,
+          body
+        )
+        expect(edit_project_strings_exporter_settings).to eq(200)
+      end
+
+      it 'when the request is invalid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/#{path}")
+        expect { @crowdin.edit_project_strings_exporter_settings }.to raise_error(ArgumentError)
+      end
+    end
   end
 
   describe 'Enterprise endpoints' do

data/spec/api_resources/source_files_spec.rb

@@ -160,6 +160,16 @@ describe Crowdin::ApiResources::SourceFiles do
       end
     end
 
+    describe '#download_file_preview' do
+      let(:file_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/files/#{file_id}/preview")
+        download_file_preview = @crowdin.download_file_preview(file_id, nil, project_id)
+        expect(download_file_preview).to eq(200)
+      end
+    end
+
     describe '#list_file_revisions' do
       let(:file_id) { 1 }
 

data/spec/api_resources/string_translations_spec.rb

@@ -38,6 +38,14 @@ describe Crowdin::ApiResources::StringTranslations do
       end
     end
 
+    describe '#remove_string_approvals' do
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/approvals")
+        remove_string_approvals = @crowdin.remove_string_approvals({}, project_id)
+        expect(remove_string_approvals).to eq(200)
+      end
+    end
+
     describe '#list_language_translations' do
       let(:language_id) { 1 }
 

data/spec/api_resources/translations_spec.rb

@@ -20,6 +20,24 @@ describe Crowdin::ApiResources::Translations do
       end
     end
 
+    describe '#list_pre_translations' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/pre-translations")
+        list_pre_translations = @crowdin.list_pre_translations({}, project_id)
+        expect(list_pre_translations).to eq(200)
+      end
+    end
+
+    describe '#edit_pre_translations' do
+      let(:pre_translation_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}")
+        edit_pre_translations = @crowdin.edit_pre_translations(pre_translation_id, {}, project_id)
+        expect(edit_pre_translations).to eq(200)
+      end
+    end
+
     describe '#build_project_directory_translation' do
       let(:directory_id) { 1 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -286,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Ruby Client for the Crowdin API