lokalise_rails 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7c3c99beec724dff9ae92477d8e710119f0b7b2e7f4cbaa19487687eab39328
-  data.tar.gz: 74e0368d48cd5dfed11d1b442bbea1d03748808fcb827b52bdaef7c0ae6e6fca
+  metadata.gz: 9ac898ae13038db9d3426f367e3cba3b54c41e35797dfb56dd5da5595959e728
+  data.tar.gz: 2bf9f24929b226b8994b3f4648f67b5da59aa0b68687cb7f597f531ac2d7bb99
 SHA512:
-  metadata.gz: 1c95761a6a14d37a19d42a97f9526f42d54738cdd3cdf3e8a8e79e04dace1bbbe705723f5a23ecd3476d7c202252d7910d7e1a633116f9fc0b70082f56814aaf
-  data.tar.gz: 937ae8358ce78c48ca50e189f38bf92369e669a94aed55e9c57d7633b7a32900452b26ebee13c142873186f0644a288307de29375894c3745f75abad1ab07f3d
+  metadata.gz: 93be5d1f8379908fbf6e3ac7a1f44534373779d8aa3e375f456ef7a83454a07babe3971aa364afe374759e54571d036c60c68e16f14c81397128770573058a9a
+  data.tar.gz: 84c42e122da897f7103a16d11e9a5e066cee28c2b6413c44ec3e459868dfe89d8c5005f3fa644024bea7dfd7c49233de5fecc67746016485f467febe91b3fa52

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 2.0.0 (19-Aug-21)
+
+* Add exponential backoff mechanism for file imports to comply with the upcoming API changes ("rate limiting"), see below for more details.
+* Add `max_retries_import` option with a default value of `5`.
+
+## 2.0.0.rc1 (12-Aug-21)
+
+* **Lokalise is introducing API rate limiting.** Access to all endpoints will be limited to 6 requests per second from 14 September, 2021. This limit is applied per API token and per IP address. If you exceed the limit, a 429 HTTP status code will be returned and a `Lokalise::Error::TooManyRequests` exception will be raised. Therefore, to overcome this issue LokaliseRails is introducing an exponential backoff mechanism for file exports. Why? Because if you have, say, 10 translation files, we'll have to send 10 separate API requests which will probably mean exceeding the limit (this is not the case with importing as we're always receiving a single archive). Thus, if the HTTP status code 429 was received, we'll do the following:
+
+```ruby
+sleep 2 ** retries
+retries += 1
+```
+
+* If the maximum number of retries has been reached LokaliseRails will re-raise the `Lokalise::Error::TooManyRequests` error and give up. By default, the maximum number of retries is set to `5` but you can control it using the `max_retries_export` option.
+* Enabled compression for the API client.
+
+## 1.4.0 (29-Jun-21)
+
+* Re-worked exception handling. Now when something goes wrong during the import or export process, this gem will re-raise all such errors (previously it just printed out some errors to the `$stdout`). If you run a Rake task, it will exit with a status code `1` and the actual error message. If you run a task programattically, you'll get an exception.
+* Dropped support for Ruby 2.5
+* Test against Ruby 3
+
+## 1.3.1 (01-Apr-21)
+
+* A bit better exception handling
+* Update dependencies
+
 ## 1.3.0 (02-Feb-21)
 
 * Use ruby-lokalise-api v3

data/README.md

@@ -3,6 +3,7 @@
 ![Gem](https://img.shields.io/gem/v/lokalise_rails)
 [![Build Status](https://travis-ci.com/bodrovis/lokalise_rails.svg?branch=master)](https://travis-ci.com/github/bodrovis/lokalise_rails)
 [![Test Coverage](https://codecov.io/gh/bodrovis/lokalise_rails/graph/badge.svg)](https://codecov.io/gh/bodrovis/lokalise_rails)
+![Downloads total](https://img.shields.io/gem/dt/lokalise_rails)
 
 This gem provides [Lokalise](http://lokalise.com) integration for Ruby on Rails and allows to exchange translation files easily. It relies on [ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api) to send APIv2 requests.
 
@@ -112,6 +113,7 @@ Options are specified in the `config/lokalise_rails.rb` file.
 
 Full list of available import options [can be found in the official API documentation](https://app.lokalise.com/api2docs/curl/#transition-download-files-post).
 * `import_safe_mode` (`boolean`) - default to `false`. When this option is enabled, the import task will check whether the directory set with `locales_path` is empty or not. If it is not empty, you will be prompted to continue.
+* `max_retries_import` (`integer`) - this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, LokaliseRails will apply an exponential backoff mechanism with a very simple formula: `2 ** retries`. If the maximum number of retries has been reached, a `Lokalise::Error::TooManyRequests` exception will be raised and the export operation will be halted.
 
 ### Export settings
 
@@ -133,6 +135,8 @@ en_US:
 c.skip_file_export = ->(file) { f.split[1].to_s.include?('fr') }
 ```
 
+* `max_retries_export` (`integer`) - this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, LokaliseRails will apply an exponential backoff mechanism with a very simple formula: `2 ** retries` (initially `retries` is `0`). If the maximum number of retries has been reached, a `Lokalise::Error::TooManyRequests` exception will be raised and the export operation will be halted. By default, LokaliseRails will make up to `5` retries which potentially means `1 + 2 + 4 + 8 + 16 + 32 = 63` seconds of waiting time. If the `max_retries_export` is less than `1`, LokaliseRails will not perform any retries and give up immediately after receiving error 429.
+
 ### Settings to work with formats other than YAML
 
 If your translation files are not in YAML format, you will need to adjust the following options:

data/lib/generators/templates/lokalise_rails_config.rb

@@ -16,6 +16,12 @@ LokaliseRails.config do |c|
   # Provide request timeouts for the Lokalise API client:
   # c.timeouts = {open_timeout: nil, timeout: nil}
 
+  # Provide maximum number of retries for file exporting:
+  # c.max_retries_export = 5
+
+  # Provide maximum number of retries for file importing:
+  # c.max_retries_import = 5
+
   # Import options have the following defaults:
   # c.import_opts = {
   #   format: 'yaml',

data/lib/lokalise_rails.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'lokalise_rails/error'
 require 'lokalise_rails/task_definition/base'
 require 'lokalise_rails/task_definition/importer'
 require 'lokalise_rails/task_definition/exporter'
@@ -9,7 +10,8 @@ module LokaliseRails
     attr_accessor :api_token, :project_id
     attr_writer :import_opts, :import_safe_mode, :export_opts, :locales_path,
                 :file_ext_regexp, :skip_file_export, :branch, :timeouts,
-                :translations_loader, :translations_converter, :lang_iso_inferer
+                :translations_loader, :translations_converter, :lang_iso_inferer,
+                :max_retries_export, :max_retries_import
 
     # Main interface to provide configuration options for rake tasks
     def config
@@ -31,6 +33,16 @@ module LokaliseRails
       @timeouts || {}
     end
 
+    # Maximum number of retries for file exporting
+    def max_retries_export
+      @max_retries_export || 5
+    end
+
+    # Maximum number of retries for file importing
+    def max_retries_import
+      @max_retries_import || 5
+    end
+
     # Regular expression used to select translation files with proper extensions
     def file_ext_regexp
       @file_ext_regexp || /\.ya?ml\z/i

data/lib/lokalise_rails/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LokaliseRails
+  class Error < StandardError
+    # Initializes a new Error object
+    def initialize(message = '')
+      super(message)
+    end
+  end
+end

data/lib/lokalise_rails/task_definition/base.rb

@@ -13,7 +13,7 @@ module LokaliseRails
         #
         # @return [Lokalise::Client]
         def api_client
-          @api_client ||= ::Lokalise.client LokaliseRails.api_token, LokaliseRails.timeouts
+          @api_client ||= ::Lokalise.client LokaliseRails.api_token, {enable_compression: true}.merge(LokaliseRails.timeouts)
         end
 
         # Resets API client
@@ -25,11 +25,12 @@ module LokaliseRails
         # Checks task options
         #
         # @return Array
-        def opt_errors
+        def check_options_errors!
           errors = []
-          errors << 'Project ID is not set! Aborting...' if LokaliseRails.project_id.nil? || LokaliseRails.project_id.empty?
-          errors << 'Lokalise API token is not set! Aborting...' if LokaliseRails.api_token.nil? || LokaliseRails.api_token.empty?
-          errors
+          errors << 'Project ID is not set!' if LokaliseRails.project_id.nil? || LokaliseRails.project_id.empty?
+          errors << 'Lokalise API token is not set!' if LokaliseRails.api_token.nil? || LokaliseRails.api_token.empty?
+
+          raise(LokaliseRails::Error, errors.join(' ')) if errors.any?
         end
 
         private
@@ -57,6 +58,22 @@ module LokaliseRails
         def project_id_with_branch
           "#{LokaliseRails.project_id}:#{LokaliseRails.branch}"
         end
+
+        # Sends request with exponential backoff mechanism
+        def with_exp_backoff(max_retries)
+          return unless block_given?
+
+          retries = 0
+          begin
+            yield
+          rescue Lokalise::Error::TooManyRequests => e
+            raise(e.class, "Gave up after #{retries} retries") if retries >= max_retries
+
+            sleep 2**retries
+            retries += 1
+            retry
+          end
+        end
       end
     end
   end

data/lib/lokalise_rails/task_definition/exporter.rb

@@ -10,20 +10,13 @@ module LokaliseRails
         #
         # @return [Array]
         def export!
-          errors = opt_errors
-
-          if errors.any?
-            errors.each { |e| $stdout.puts e }
-            return errors
-          end
+          check_options_errors!
 
           queued_processes = []
           each_file do |full_path, relative_path|
-            queued_processes << api_client.upload_file(
-              project_id_with_branch, opts(full_path, relative_path)
-            )
+            queued_processes << do_upload(full_path, relative_path)
           rescue StandardError => e
-            $stdout.puts "Error while trying to upload #{full_path}: #{e.inspect}"
+            raise e.class, "Error while trying to upload #{full_path}: #{e.message}"
           end
 
           $stdout.print 'Task complete!'
@@ -31,6 +24,14 @@ module LokaliseRails
           queued_processes
         end
 
+        # Performs the actual file uploading to Lokalise. If the API rate limit is exceeed,
+        # applies exponential backoff
+        def do_upload(f_path, r_path)
+          with_exp_backoff(LokaliseRails.max_retries_export) do
+            api_client.upload_file project_id_with_branch, opts(f_path, r_path)
+          end
+        end
+
         # Processes each translation file in the specified directory
         def each_file
           return unless block_given?

data/lib/lokalise_rails/task_definition/importer.rb

@@ -13,12 +13,7 @@ module LokaliseRails
         #
         # @return [Boolean]
         def import!
-          errors = opt_errors
-
-          if errors.any?
-            errors.each { |e| $stdout.puts e }
-            return false
-          end
+          check_options_errors!
 
           unless proceed_when_safe_mode?
             $stdout.print 'Task cancelled!'
@@ -31,15 +26,16 @@ module LokaliseRails
           true
         end
 
-        # Downloads files from Lokalise using the specified options
+        # Downloads files from Lokalise using the specified options.
+        # Utilizes exponential backoff if "too many requests" error is received
         #
         # @return [Hash]
         def download_files
-          opts = LokaliseRails.import_opts
-
-          api_client.download_files project_id_with_branch, opts
+          with_exp_backoff(LokaliseRails.max_retries_import) do
+            api_client.download_files project_id_with_branch, LokaliseRails.import_opts
+          end
         rescue StandardError => e
-          $stdout.puts "There was an error when trying to download files: #{e.inspect}"
+          raise e.class, "There was an error when trying to download files: #{e.message}"
         end
 
         # Opens ZIP archive (local or remote) with translations and processes its entries
@@ -49,6 +45,8 @@ module LokaliseRails
           Zip::File.open_buffer(open_file_or_remote(path)) do |zip|
             fetch_zip_entries(zip) { |entry| process!(entry) }
           end
+        rescue StandardError => e
+          raise e.class, "There was an error when trying to process the downloaded files: #{e.message}"
         end
 
         # Iterates over ZIP entries. Each entry may be a file or folder.
@@ -73,7 +71,7 @@ module LokaliseRails
             f.write LokaliseRails.translations_converter.call(data)
           end
         rescue StandardError => e
-          $stdout.puts "Error when trying to process #{zip_entry&.name}: #{e.inspect}"
+          raise e.class, "Error when trying to process #{zip_entry&.name}: #{e.message}"
         end
 
         # Checks whether the user wishes to proceed when safe mode is enabled and the target directory is not empty

data/lib/lokalise_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseRails
-  VERSION = '1.3.0'
+  VERSION = '2.0.0'
 end

data/lib/tasks/lokalise_rails_tasks.rake

@@ -6,9 +6,13 @@ require "#{Rails.root}/config/lokalise_rails"
 namespace :lokalise_rails do
   task :import do
     LokaliseRails::TaskDefinition::Importer.import!
+  rescue StandardError => e
+    abort e.inspect
   end
 
   task :export do
     LokaliseRails::TaskDefinition::Exporter.export!
+  rescue StandardError => e
+    abort e.inspect
   end
 end

data/lokalise_rails.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.1.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.4.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 6.0'
 end

data/spec/lib/lokalise_rails/task_definition/base_spec.rb

@@ -34,22 +34,18 @@ describe LokaliseRails::TaskDefinition::Base do
     end
   end
 
-  describe '.opt_errors' do
-    it 'returns an error when the API key is not set' do
+  describe '.check_options_errors!' do
+    it 'raises an error when the API key is not set' do
       allow(LokaliseRails).to receive(:api_token).and_return(nil)
-      errors = described_class.opt_errors
+
+      expect(-> { described_class.check_options_errors! }).to raise_error(LokaliseRails::Error, /API token is not set/i)
 
       expect(LokaliseRails).to have_received(:api_token)
-      expect(errors.length).to eq(1)
-      expect(errors.first).to include('API token is not set')
     end
 
     it 'returns an error when the project_id is not set' do
       allow_project_id nil do
-        errors = described_class.opt_errors
-
-        expect(errors.length).to eq(1)
-        expect(errors.first).to include('Project ID is not set')
+        expect(-> { described_class.check_options_errors! }).to raise_error(LokaliseRails::Error, /ID is not set/i)
       end
     end
   end

data/spec/lib/lokalise_rails/task_definition/exporter_spec.rb

@@ -7,6 +7,45 @@ describe LokaliseRails::TaskDefinition::Exporter do
   let(:path) { "#{Rails.root}/config/locales/nested/#{filename}" }
   let(:relative_name) { "nested/#{filename}" }
 
+  context 'with many translation files' do
+    let(:fake_class) { described_class }
+
+    before :all do
+      add_translation_files! with_ru: true, additional: 5
+    end
+
+    after :all do
+      rm_translation_files
+    end
+
+    describe '.export!' do
+      it 'sends a proper API request and handles rate limiting' do
+        allow_project_id '672198945b7d72fc048021.15940510'
+
+        process = VCR.use_cassette('upload_files_multiple') do
+          described_class.export!
+        end.first
+
+        expect(process.project_id).to eq(LokaliseRails.project_id)
+        expect(process.status).to eq('queued')
+      end
+
+      it 'handles too many requests' do
+        allow_project_id '672198945b7d72fc048021.15940510'
+        allow(LokaliseRails).to receive(:max_retries_export).and_return(2)
+
+        fake_client = double
+        allow(fake_client).to receive(:upload_file).and_raise(Lokalise::Error::TooManyRequests)
+        allow(fake_class).to receive(:api_client).and_return(fake_client)
+
+        expect(-> { fake_class.export! }).to raise_error(Lokalise::Error::TooManyRequests, /Gave up after 2 retries/i)
+        expect(LokaliseRails).to have_received(:max_retries_export).exactly(1).times
+        expect(fake_class).to have_received(:api_client).exactly(3).times
+        expect(fake_client).to have_received(:upload_file).exactly(3).times
+      end
+    end
+  end
+
   context 'with one translation file' do
     before :all do
       add_translation_files!
@@ -26,6 +65,7 @@ describe LokaliseRails::TaskDefinition::Exporter do
 
         expect(process.project_id).to eq(LokaliseRails.project_id)
         expect(process.status).to eq('queued')
+        expect(LokaliseRails.max_retries_export).to eq(5)
       end
 
       it 'sends a proper API request when a different branch is provided' do
@@ -44,13 +84,13 @@ describe LokaliseRails::TaskDefinition::Exporter do
       it 'halts when the API key is not set' do
         allow(LokaliseRails).to receive(:api_token).and_return(nil)
 
-        expect(-> { described_class.export! }).to output(/API token is not set/).to_stdout
+        expect(-> { described_class.export! }).to raise_error(LokaliseRails::Error, /API token is not set/i)
         expect(LokaliseRails).to have_received(:api_token)
       end
 
       it 'halts when the project_id is not set' do
         allow_project_id nil do
-          expect(-> { described_class.export! }).to output(/Project ID is not set/).to_stdout
+          expect(-> { described_class.export! }).to raise_error(LokaliseRails::Error, /ID is not set/i)
         end
       end
     end
@@ -107,17 +147,12 @@ describe LokaliseRails::TaskDefinition::Exporter do
     end
 
     describe '.export!' do
-      it 'rescues from export errors' do
+      it 're-raises export errors' do
         allow_project_id
 
-        processes = VCR.use_cassette('upload_files_error') do
-          described_class.export!
+        VCR.use_cassette('upload_files_error') do
+          expect { described_class.export! }.to raise_error(Lokalise::Error::BadRequest, /Unknown `lang_iso`/)
         end
-
-        expect(processes.length).to eq(1)
-        process = processes.first
-        expect(process.project_id).to eq(LokaliseRails.project_id)
-        expect(process.status).to eq('queued')
       end
     end
 

data/spec/lib/lokalise_rails/task_definition/importer_spec.rb

@@ -4,44 +4,67 @@ describe LokaliseRails::TaskDefinition::Importer do
   describe '.open_and_process_zip' do
     let(:faulty_trans) { "#{Rails.root}/public/faulty_trans.zip" }
 
-    it 'rescues from errors during file processing' do
+    it 're-raises errors during file processing' do
       expect(-> { described_class.open_and_process_zip(faulty_trans) }).
-        to output(/Psych::DisallowedClass/).to_stdout
+        to raise_error(Psych::DisallowedClass, /Error when trying to process fail\.yml/)
+    end
+
+    it 're-raises errors during file opening' do
+      expect(-> { described_class.open_and_process_zip('http://fake.url/wrong/path.zip') }).
+        to raise_error(SocketError, /Failed to open TCP connection/)
     end
   end
 
   describe '.download_files' do
     it 'returns a proper download URL' do
-      allow_project_id '189934715f57a162257d74.88352370' do
+      allow_project_id '672198945b7d72fc048021.15940510' do
         response = VCR.use_cassette('download_files') do
           described_class.download_files
         end
 
-        expect(response['project_id']).to eq('189934715f57a162257d74.88352370')
+        expect(response['project_id']).to eq('672198945b7d72fc048021.15940510')
         expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
+        expect(described_class.api_client.enable_compression).to eq(true)
+        expect(LokaliseRails.max_retries_import).to eq(5)
       end
     end
 
-    it 'rescues from errors during file download' do
+    it 're-raises errors during file download' do
       allow_project_id 'invalid'
       VCR.use_cassette('download_files_error') do
         expect(-> { described_class.download_files }).
-          to output(/Lokalise::Error::BadRequest/).to_stdout
+          to raise_error(Lokalise::Error::BadRequest, /Invalid `project_id` parameter/)
       end
     end
   end
 
   describe '.import!' do
+    let(:fake_class) { described_class }
+
+    it 'handles too many requests' do
+      allow_project_id '672198945b7d72fc048021.15940510'
+      allow(LokaliseRails).to receive(:max_retries_import).and_return(2)
+
+      fake_client = double
+      allow(fake_client).to receive(:download_files).and_raise(Lokalise::Error::TooManyRequests)
+      allow(fake_class).to receive(:api_client).and_return(fake_client)
+
+      expect(-> { fake_class.import! }).to raise_error(Lokalise::Error::TooManyRequests, /Gave up after 2 retries/i)
+      expect(LokaliseRails).to have_received(:max_retries_import).exactly(1).times
+      expect(fake_class).to have_received(:api_client).exactly(3).times
+      expect(fake_client).to have_received(:download_files).exactly(3).times
+    end
+
     it 'halts when the API key is not set' do
       allow(LokaliseRails).to receive(:api_token).and_return(nil)
-      expect(-> { described_class.import! }).to output(/API token is not set/).to_stdout
+      expect(-> { described_class.import! }).to raise_error(LokaliseRails::Error, /API token is not set/i)
       expect(LokaliseRails).to have_received(:api_token)
       expect(count_translations).to eq(0)
     end
 
     it 'halts when the project_id is not set' do
       allow_project_id nil do
-        expect(-> { described_class.import! }).to output(/Project ID is not set/).to_stdout
+        expect(-> { described_class.import! }).to raise_error(LokaliseRails::Error, /ID is not set/i)
         expect(count_translations).to eq(0)
       end
     end

data/spec/lib/lokalise_rails_spec.rb

@@ -58,6 +58,16 @@ describe LokaliseRails do
       fake_class.import_safe_mode = true
     end
 
+    it 'is possible to set max_retries_export' do
+      allow(fake_class).to receive(:max_retries_export=).with(10)
+      fake_class.max_retries_export = 10
+    end
+
+    it 'is possible to set max_retries_import' do
+      allow(fake_class).to receive(:max_retries_import=).with(10)
+      fake_class.max_retries_import = 10
+    end
+
     it 'is possible to set api_token' do
       allow(fake_class).to receive(:api_token=).with('abc')
       fake_class.api_token = 'abc'

data/spec/lib/tasks/export_task_spec.rb

@@ -1,7 +1,44 @@
 # frozen_string_literal: true
 
 RSpec.describe LokaliseRails do
+  it 'halts when the API key is not set' do
+    allow(described_class).to receive(:api_token).and_return(nil)
+
+    expect(export_executor).to raise_error(SystemExit, /API token is not set/i)
+    expect(described_class).to have_received(:api_token)
+  end
+
+  it 'halts when the project ID is not set' do
+    allow_project_id nil do
+      expect(export_executor).to raise_error(SystemExit, /ID is not set/i)
+    end
+  end
+
   it 'runs export rake task properly' do
     expect(export_executor).to output(/complete!/).to_stdout
   end
+
+  context 'with two translation files' do
+    let(:filename_ru) { 'ru.yml' }
+    let(:path_ru) { "#{Rails.root}/config/locales/#{filename_ru}" }
+    let(:relative_name_ru) { filename_ru }
+
+    before :all do
+      add_translation_files! with_ru: true
+    end
+
+    after :all do
+      rm_translation_files
+    end
+
+    describe '.export!' do
+      it 're-raises export errors' do
+        allow_project_id
+
+        VCR.use_cassette('upload_files_error') do
+          expect(export_executor).to raise_error(SystemExit, /Unknown `lang_iso`/)
+        end
+      end
+    end
+  end
 end

data/spec/lib/tasks/import_task_spec.rb

@@ -7,6 +7,19 @@ RSpec.describe LokaliseRails do
   let(:local_trans) { "#{Rails.root}/public/trans.zip" }
   let(:remote_trans) { 'https://github.com/bodrovis/lokalise_rails/blob/master/spec/dummy/public/trans.zip?raw=true' }
 
+  it 'halts when the API key is not set' do
+    allow(described_class).to receive(:api_token).and_return(nil)
+
+    expect(import_executor).to raise_error(SystemExit, /API token is not set/i)
+    expect(described_class).to have_received(:api_token)
+  end
+
+  it 'halts when the project ID is not set' do
+    allow_project_id nil do
+      expect(import_executor).to raise_error(SystemExit, /ID is not set/i)
+    end
+  end
+
   context 'when directory is empty' do
     before do
       mkdir_locales

data/spec/support/file_manager.rb

@@ -24,16 +24,20 @@ module FileManager
     locales_dir.count { |file| File.file?(file) }
   end
 
-  def add_translation_files!(with_ru: false)
+  def add_translation_files!(with_ru: false, additional: nil)
     FileUtils.mkdir_p "#{Rails.root}/config/locales/nested"
-    File.open("#{Rails.root}/config/locales/nested/en.yml", 'w+:UTF-8') do |f|
-      f.write en_data
-    end
+    open_and_write('config/locales/nested/en.yml') { |f| f.write en_data }
 
     return unless with_ru
 
-    File.open("#{Rails.root}/config/locales/ru.yml", 'w+:UTF-8') do |f|
-      f.write ru_data
+    open_and_write('config/locales/ru.yml') { |f| f.write ru_data }
+
+    return unless additional
+
+    additional.times do |i|
+      data = {'en' => {"key_#{i}" => "value #{i}"}}
+
+      open_and_write("config/locales/en_#{i}.yml") { |f| f.write data.to_yaml }
     end
   end
 
@@ -46,9 +50,13 @@ module FileManager
       end
     DATA
 
-    File.open("#{Rails.root}/config/lokalise_rails.rb", 'w+:UTF-8') do |f|
-      f.write data
-    end
+    open_and_write('config/lokalise_rails.rb') { |f| f.write data }
+  end
+
+  def open_and_write(rel_path, &block)
+    return unless block
+
+    File.open("#{Rails.root}/#{rel_path}", 'w+:UTF-8', &block)
   end
 
   def remove_config

data/spec/support/spec_addons.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SpecAddons
-  def allow_project_id(value = ENV['LOKALISE_PROJECT_ID'])
+  def allow_project_id(value = '189934715f57a162257d74.88352370')
     allow(LokaliseRails).to receive(:project_id).and_return(value)
     return unless block_given?
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +198,7 @@ files:
 - lib/generators/lokalise_rails/install_generator.rb
 - lib/generators/templates/lokalise_rails_config.rb
 - lib/lokalise_rails.rb
+- lib/lokalise_rails/error.rb
 - lib/lokalise_rails/railtie.rb
 - lib/lokalise_rails/task_definition/base.rb
 - lib/lokalise_rails/task_definition/exporter.rb
@@ -258,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.25
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails