crowdin-api 1.8.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff9548440dd2a2a312ae867def3cdcfd0fccd70c2bb1341380483a94776a09f1
-  data.tar.gz: 67f2e731d323f60d9af9cd917b535fece3524e3467802be69ecaad1a377fae7d
+  metadata.gz: d44d26d0f12ba278e3199deda37ad21b26e1d977f36bb050e0b42bc98ded84bc
+  data.tar.gz: e86837279bc7aa8a6cfdd7a87c0e09c7764c63a0b6ac072bb1ba72c820ab5970
 SHA512:
-  metadata.gz: 6bd609157edfa0b5368266142ba8b905d1ff032f237fc73227fd4d25d0ff34098190957bea2840f3278570cf5d8010f5b34e2623d98dce3a2abf49127bf9b79a
-  data.tar.gz: 73dc2a5962b51193fc9376d0644ee3daef308a0f2bfc797e3fcbb6a28ca8c3e26ce40107863ff4b3dda8598e715eb5405467640bcbdf6b2b2cf133053ad9b435
+  metadata.gz: 6798c53e8405fbc05faa84d21aaac11a780e8d945b2ebde85872b18b706c320d83ec797ba762cca02f96b568fdc460361f469cdb00440bb8aa6db7a3768cbeb4
+  data.tar.gz: 8c211132ea5389f49cb800d78a7cc5405663ee0cd1c12dda5a0bb687f7feb18fd34c29937f5de289c17d3f2cf5a72e86c2197c2b06c69c7fc1c7c0f1fc65279a

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.1)
+    crowdin-api (1.10.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.1'
+gem 'crowdin-api', '~> 1.10.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/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/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.8.1'
+    VERSION = '1.10.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/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.8.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri