crowdin-api 1.9.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb6299e8ac24c4e3bf9e7bbcf3d9741ded36842d56a7e294f9f534f4c05535a5
-  data.tar.gz: 04a58a1803638e00dd1c8b6a833fed4b8e01f56d19201a272ecbdeca4e0fd515
+  metadata.gz: 22ed7c31fb89ca5299a07d1fe3c828f7686e36d74ad710dc5e1b115598f90fe7
+  data.tar.gz: fd8069c348ff758595bbc18a3f8684f6d220b1a53d00fac2fc0af0751b213087
 SHA512:
-  metadata.gz: bb87a4d984c5f9955ac03908ba2d57eaa4ad5a06723de4683f513e3cf696a6b1013bcc1d2473a2aa231eea207afb8688a0baff61d9acc67fa53351a5284eaddd
-  data.tar.gz: d11b9902322de9ff89c6575e0b7915968d5627d887c144bcbe196021056399d80ded2f0ccae66e4a1b88eb8124b080f28cc30b552ca4df25d64b829bc4071ec6
+  metadata.gz: 6014441ccc9d7c0a1e6a11e20611ee686cff396da2d596c12a1293d701f0395d5ff4adc730098301b4563f3167e5d7af54d15579e401578f822dadeb65066101
+  data.tar.gz: afa63e70a5616430e750429bb5b99e4d30e89ae92bbec440eb3fa2e5b7fbeb1319ff4c4947812ae8878597cd7850725f58018c094aa6d0ea2a02230b0ed8e799

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crowdin-api (1.9.0)
+    crowdin-api (1.11.0)
       open-uri (>= 0.1.0, < 0.2.0)
       rest-client (>= 2.0.0, < 2.2.0)
 
@@ -39,7 +39,7 @@ GEM
     public_suffix (5.0.4)
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     regexp_parser (2.8.3)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 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.9.0'
+gem 'crowdin-api', '~> 1.11.0'
 ```
 
 And then execute:
@@ -78,6 +78,7 @@ crowdin = Crowdin::Client.new do |config|
   config.organization_domain = 'YourOrganizationDomain' # [String] optional
   config.project_id = 'YourProjectId' # [Integer] nil by default
   config.enable_logger = true # [Boolean] false by default
+  config.request_timeout = 60 # [nil, Integer] disabled by default
 end
 # Note: Client will initialize default Logger instance if you have specify
 # enable_logger to true, you can change it by crowdin.logger = YourLogger

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

@@ -84,7 +84,37 @@ module Crowdin
         response = ::RestClient::Request.execute(
           {
             method: :delete,
-            url: config.base_url + config.target_api_url + "/projects/#{project_id}/labels/#{label_id}",
+            url: config.base_url + config.target_api_url + "/projects/#{project_id}/labels/#{label_id}/strings",
+            payload: query.to_json
+          }.merge(@options)
+        )
+
+        response.body.empty? ? response.code : JSON.parse(response.body)
+      rescue StandardError => e
+        e.message
+      end
+
+      def assign_label_to_screenshots(label_id = nil, query = {}, project_id = config.project_id)
+        label_id   || raise_parameter_is_required_error(:label_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/labels/#{label_id}/screenshots",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def unassign_label_from_screenshots(label_id = nil, query = {}, project_id = config.project_id)
+        label_id   || raise_parameter_is_required_error(:label_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}/labels/#{label_id}/screenshots",
             payload: query.to_json
           }.merge(@options)
         )

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

@@ -64,6 +64,18 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      def string_batch_operations(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/strings",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

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

@@ -5,6 +5,7 @@ module Crowdin
     attr_accessor :api_token
     attr_accessor :project_id
     attr_accessor :organization_domain
+    attr_accessor :request_timeout
 
     attr_accessor :enable_logger
     alias logger_enabled? enable_logger
@@ -18,7 +19,7 @@ module Crowdin
     def options
       {
         headers: {},
-        timeout: nil,
+        timeout: request_timeout,
         json:    true
       }
     end

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

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

data/spec/api_resources/labels_spec.rb

@@ -3,7 +3,7 @@
 describe Crowdin::ApiResources::Labels do
   describe 'Default endpoints' do
     describe '#list_labels' do
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels")
         list_labels = @crowdin.list_labels({}, project_id)
         expect(list_labels).to eq(200)
@@ -11,7 +11,7 @@ describe Crowdin::ApiResources::Labels do
     end
 
     describe '#add_label' do
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels")
         add_label = @crowdin.add_label({}, project_id)
         expect(add_label).to eq(200)
@@ -21,7 +21,7 @@ describe Crowdin::ApiResources::Labels do
     describe '#get_label' do
       let(:label_id) { 1 }
 
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
         get_label = @crowdin.get_label(label_id, project_id)
         expect(get_label).to eq(200)
@@ -31,7 +31,7 @@ describe Crowdin::ApiResources::Labels do
     describe '#delete_label' do
       let(:label_id) { 1 }
 
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
         delete_label = @crowdin.delete_label(label_id, project_id)
         expect(delete_label).to eq(200)
@@ -41,7 +41,7 @@ describe Crowdin::ApiResources::Labels do
     describe '#edit_label' do
       let(:label_id) { 1 }
 
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
         edit_label = @crowdin.edit_label(label_id, {}, project_id)
         expect(edit_label).to eq(200)
@@ -51,7 +51,7 @@ describe Crowdin::ApiResources::Labels do
     describe '#assign_label_to_strings' do
       let(:label_id) { 1 }
 
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}/strings")
         assign_label_to_strings = @crowdin.assign_label_to_strings(label_id, {}, project_id)
         expect(assign_label_to_strings).to eq(200)
@@ -61,11 +61,43 @@ describe Crowdin::ApiResources::Labels do
     describe '#unassign_label_from_strings' do
       let(:label_id) { 1 }
 
-      it 'when request are valid', :default do
-        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
+      it 'returns 200 when request is valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}/strings")
         unassign_label_from_strings = @crowdin.unassign_label_from_strings(label_id, {}, project_id)
         expect(unassign_label_from_strings).to eq(200)
       end
+
+      it 'returns error message when request was processed with an error' do
+        allow(RestClient::Request).to receive(:execute).and_raise('Error')
+        unassign_label_from_strings = @crowdin.unassign_label_from_strings(label_id, {}, project_id)
+        expect(unassign_label_from_strings).to eq('Error')
+      end
+    end
+
+    describe '#assign_label_to_screenshots' do
+      let(:label_id) { 1 }
+
+      it 'returns 200 when request is valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}/screenshots")
+        assign_label_to_screenshots = @crowdin.assign_label_to_screenshots(label_id, {}, project_id)
+        expect(assign_label_to_screenshots).to eq(200)
+      end
+    end
+
+    describe '#unassign_label_from_screenshots' do
+      let(:label_id) { 1 }
+
+      it 'returns 200 when request is valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}/screenshots")
+        unassign_label_from_screenshots = @crowdin.unassign_label_from_screenshots(label_id, {}, project_id)
+        expect(unassign_label_from_screenshots).to eq(200)
+      end
+
+      it 'returns error message when request was processed with an error' do
+        allow(RestClient::Request).to receive(:execute).and_raise('Error')
+        unassign_label_from_screenshots = @crowdin.unassign_label_from_screenshots(label_id, {}, project_id)
+        expect(unassign_label_from_screenshots).to eq('Error')
+      end
     end
   end
 end

data/spec/api_resources/source_strings_spec.rb

@@ -3,7 +3,7 @@
 describe Crowdin::ApiResources::SourceStrings do
   describe 'Default endpoints' do
     describe '#list_strings' do
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings")
         list_strings = @crowdin.list_strings({}, project_id)
         expect(list_strings).to eq(200)
@@ -11,7 +11,7 @@ describe Crowdin::ApiResources::SourceStrings do
     end
 
     describe '#add_string' do
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings")
         add_string = @crowdin.add_string({}, project_id)
         expect(add_string).to eq(200)
@@ -21,7 +21,7 @@ describe Crowdin::ApiResources::SourceStrings do
     describe '#get_string' do
       let(:string_id) { 1 }
 
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings/#{string_id}")
         get_string = @crowdin.get_string(string_id, {}, project_id)
         expect(get_string).to eq(200)
@@ -31,7 +31,7 @@ describe Crowdin::ApiResources::SourceStrings do
     describe '#delete_string' do
       let(:string_id) { 1 }
 
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings/#{string_id}")
         delete_string = @crowdin.delete_string(string_id, project_id)
         expect(delete_string).to eq(200)
@@ -41,11 +41,19 @@ describe Crowdin::ApiResources::SourceStrings do
     describe '#edit_string' do
       let(:string_id) { 1 }
 
-      it 'when request are valid', :default do
+      it 'returns 200 when request is valid', :default do
         stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings/#{string_id}")
         edit_string = @crowdin.edit_string(string_id, {}, project_id)
         expect(edit_string).to eq(200)
       end
     end
+
+    describe '#string_batch_operations' do
+      it 'returns 200 when request is valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings")
+        string_batch_operations = @crowdin.string_batch_operations({}, project_id)
+        expect(string_batch_operations).to eq(200)
+      end
+    end
   end
 end

data/spec/unit/client_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 describe 'Crowdin Client' do
+  let(:crowdin_client) { Crowdin::Client.new }
+
   it 'should have a list of API Resources' do
     expect(Crowdin::API_RESOURCES_MODULES).to_not be_nil
   end
@@ -21,6 +23,7 @@ describe 'Crowdin Client' do
     it 'should have options and headers for RestClient', :default do
       expect(@crowdin.options.class).to eq(Hash)
       expect(@crowdin.options).to include(:headers)
+      expect(@crowdin.options).to include(timeout: nil)
     end
 
     it 'should have a Config instance', :default do
@@ -94,4 +97,26 @@ describe 'Crowdin Client' do
       expect { @crowdin.fetch_all(:export_bundle).to raise_error(Crowdin::Errors::FetchAllProcessingError) }
     end
   end
+
+  describe 'connection' do
+    subject(:connection) { crowdin_client.connection }
+
+    it 'timeout is disabled by default' do
+      is_expected.to have_attributes(options: include(timeout: be_nil))
+    end
+
+    context 'when new request timeout config is set' do
+      let(:new_request_timeout) { 60 }
+
+      let(:crowdin_client) do
+        Crowdin::Client.new do |config|
+          config.request_timeout = new_request_timeout
+        end
+      end
+
+      it 'timeout option is changed to new value' do
+        is_expected.to have_attributes(options: include(timeout: new_request_timeout))
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-05-10 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.3
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Ruby Client for the Crowdin API