lokalise_rails 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87524123a10425d69c33950f4b2c16366146f5c1ab14c19dbc7185de61fb726a
-  data.tar.gz: 39ba0b0a91f443ea162d7804c89906f4523f7c13411fbd541624bafb9197a569
+  metadata.gz: 2e85d26a390d153b8deabe38694c1b7313fca351232066d58918828388dcc7fc
+  data.tar.gz: 0ee837ad7426ed5570badcec88245de2f4d35ea27b3c821f3facb5922083b2b2
 SHA512:
-  metadata.gz: 4e36f385c123ab80402aaa428973c2c0706b2cbceabade8bcf12689fe0955bdc927a223c27a9114c102d83af6a709b061e1c10d2e189ca832b5b56a0a6b043f8
-  data.tar.gz: bbbe1857d99cdc7c3595f611d664c555981fbdf5f1d37c30a52cb179d641902f879b1492996dc7c1c1cb6dacdfbd7c2a3ca226f31a687879fddf59b1e8f9fe7a
+  metadata.gz: 4af0fd091968510911787fcdc7bd7ffdefada590fb48c4137106de5d3d34296890a868b65debbf2262fc0d82901eb77a35407e3d6a7c5f958babbb2b548b14cd
+  data.tar.gz: ff6948bb092ab43e837b54de2d593d8e5db319ac872390aa335cb67802d198f11a30d58993d3d5e561a1f3ad823fe52ac7f55b1bcbe3de9a2ba09dfb0d41d99f

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 1.3.1 (01-Apr-21)
+
+* A bit better exception handling
+* Update dependencies
+
+## 1.3.0 (02-Feb-21)
+
+* Use ruby-lokalise-api v3
+
+## 1.2.0 (11-Nov-20)
+
+* New option `translations_loader`
+* New option `translations_converter`
+* New option `lang_iso_inferer`
+
+## 1.1.0 (23-Oct-20)
+
+* New option `branch`
+* New option `timeouts`
+* New method `.reset_api_client!` for the task definitions
+
+## 1.0.1 (14-Oct-20)
+
+* Minor bug fixes and spec updates
+
 ## 1.0.0 (01-Oct-20)
 
 * Added export feature

data/README.md

@@ -1,11 +1,13 @@
 # LokaliseRails
 
-[![Gem Version](https://badge.fury.io/rb/lokalise_rails.svg)](https://badge.fury.io/rb/lokalise_rails)
-[![Build Status](https://travis-ci.org/bodrovis/lokalise_rails.svg?branch=master)](https://travis-ci.org/bodrovis/lokalise_rails)
+![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)
 
 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.
 
+*If you would like to know how this gem was built, check out the ["How to create a Ruby gem" series at Lokalise blog](https://lokalise.com/blog/create-a-ruby-gem-basics/).*
+
 ## Getting started
 
 ### Requirements
@@ -62,6 +64,25 @@ To export translations from your Rails app to the specified Lokalise project, ru
 rails lokalise_rails:export
 ```
 
+## Running tasks programmatically
+
+You can also run the import and export tasks from the Rails app:
+
+```ruby
+require "#{Rails.root}/config/lokalise_rails.rb"
+
+# Import the files:
+result = LokaliseRails::TaskDefinition::Importer.import!
+```
+`result` contains a boolean value with the result of the operation
+
+```ruby
+# Export the files:
+processes = LokaliseRails::TaskDefinition::Exporter.export!
+```
+
+`processes` contains a list of [queued background processes](https://lokalise.github.io/ruby-lokalise-api/api/queued-processes).
+
 ## Configuration
 
 Options are specified in the `config/lokalise_rails.rb` file.
@@ -71,7 +92,8 @@ Options are specified in the `config/lokalise_rails.rb` file.
 * `api_token` (`string`, required) - Lokalise API token with read/write permissions.
 * `project_id` (`string`, required) - Lokalise project ID. You must have import/export permissions in the specified project.
 * `locales_path` (`string`) - path to the directory with your translation files. Defaults to `"#{Rails.root}/config/locales"`.
-* `file_ext_regexp` (`regexp`) - regular expression applied to file extensions to determine which files should be imported and exported. Defaults to `/\.ya?ml\z/i` (YAML files).
+* `branch` (`string`) - Lokalise project branch to use. Defaults to `"master"`.
+* `timeouts` (`hash`) - set [request timeouts for the Lokalise API client](https://lokalise.github.io/ruby-lokalise-api/additional_info/customization#setting-timeouts). By default, requests have no timeouts: `{open_timeout: nil, timeout: nil}`. Both values are in seconds.
 
 ### Import settings
 
@@ -111,6 +133,20 @@ en_US:
 c.skip_file_export = ->(file) { f.split[1].to_s.include?('fr') }
 ```
 
+### 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:
+
+* `file_ext_regexp` (`regexp`) - regular expression applied to file extensions to determine which files should be imported and exported. Defaults to `/\.ya?ml\z/i` (YAML files).
+* `translations_loader` (`lambda` or `proc`) - loads translations data and makes sure they are valid before saving them to a translation file. Defaults to `->(raw_data) { YAML.safe_load raw_data }`. In the simplest case you may just return the data back, for example `-> (raw_data) { raw_data }`.
+* `translations_converter` (`lambda` or `proc`) - converts translations data to a proper format before saving them to a translation file. Defaults to `->(raw_data) { raw_data.to_yaml }`. In the simplest case you may just return the data back, for example `-> (raw_data) { raw_data }`.
+* `lang_iso_inferer` (`lambda` or `proc`) - infers language ISO code based on the translation file data before uploading it to Lokalise. Defaults to `->(data) { YAML.safe_load(data)&.keys&.first }`.
+
+## Running tests
+
+1. Copypaste `.env.example` file as `.env`. Put your Lokalise API token and project ID inside. The `.env` file is excluded from version control so your data is safe. All in all, we use pre-recorded VCR cassettes, so the actual API requests won’t be sent. However, providing at least some values is required.
+2. Run `rspec .`. Observe test results and code coverage.
+
 ## License
 
-Copyright (c) [Lokalise team](http://lokalise.com), [Ilya Bodrov](http://bodrovis.tech)
+Copyright (c) [Lokalise team](http://lokalise.com), [Ilya Bodrov](http://bodrovis.tech). License type is [MIT](https://github.com/bodrovis/lokalise_rails/blob/master/LICENSE).

data/lib/generators/templates/lokalise_rails_config.rb

@@ -10,6 +10,12 @@ LokaliseRails.config do |c|
   # Provide a custom path to the directory with your translation files:
   # c.locales_path = "#{Rails.root}/config/locales"
 
+  # Provide a Lokalise project branch to use:
+  # c.branch = 'master'
+
+  # Provide request timeouts for the Lokalise API client:
+  # c.timeouts = {open_timeout: nil, timeout: nil}
+
   # Import options have the following defaults:
   # c.import_opts = {
   #   format: 'yaml',
@@ -29,6 +35,16 @@ LokaliseRails.config do |c|
   # Provide additional file exclusion criteria for exports (by default, any file with the proper extension will be exported)
   # c.skip_file_export = ->(file) { file.split[1].to_s.include?('fr') }
 
-  # Regular expression to use when choosing the files to extract from the downloaded archive and upload to Lokalise
-  # c.file_ext_regexp = /\.ya?ml\z/i
+  # Set the options below if you would like to work with format other than YAML
+  ## Regular expression to use when choosing the files to extract from the downloaded archive and upload to Lokalise
+  ## c.file_ext_regexp = /\.ya?ml\z/i
+
+  ## Load translations data and make sure they are valid:
+  ## c.translations_loader = ->(raw_data) { YAML.safe_load raw_data }
+
+  ## Convert translations data to a proper format:
+  ## c.translations_converter = ->(raw_data) { raw_data.to_yaml }
+
+  ## Infer language ISO code for the translation file:
+  ## c.lang_iso_inferer = ->(data) { YAML.safe_load(data)&.keys&.first }
 end

data/lib/lokalise_rails.rb

@@ -8,7 +8,8 @@ module LokaliseRails
   class << self
     attr_accessor :api_token, :project_id
     attr_writer :import_opts, :import_safe_mode, :export_opts, :locales_path,
-                :file_ext_regexp, :skip_file_export
+                :file_ext_regexp, :skip_file_export, :branch, :timeouts,
+                :translations_loader, :translations_converter, :lang_iso_inferer
 
     # Main interface to provide configuration options for rake tasks
     def config
@@ -20,6 +21,16 @@ module LokaliseRails
       @locales_path || "#{Rails.root}/config/locales"
     end
 
+    # Project branch to use
+    def branch
+      @branch || 'master'
+    end
+
+    # Set request timeouts for the Lokalise API client
+    def timeouts
+      @timeouts || {}
+    end
+
     # Regular expression used to select translation files with proper extensions
     def file_ext_regexp
       @file_ext_regexp || /\.ya?ml\z/i
@@ -51,6 +62,20 @@ module LokaliseRails
     def skip_file_export
       @skip_file_export || ->(_) { false }
     end
+
+    def translations_loader
+      @translations_loader || ->(raw_data) { YAML.safe_load raw_data }
+    end
+
+    # Converts translations data to the proper format
+    def translations_converter
+      @translations_converter || ->(raw_data) { raw_data.to_yaml }
+    end
+
+    # Infers lang ISO for the given translation file
+    def lang_iso_inferer
+      @lang_iso_inferer || ->(data) { YAML.safe_load(data)&.keys&.first }
+    end
   end
 end
 

data/lib/lokalise_rails/railtie.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rake'
-
 module LokaliseRails
   class Railtie < Rails::Railtie
     rake_tasks do

data/lib/lokalise_rails/task_definition/base.rb

@@ -13,7 +13,13 @@ module LokaliseRails
         #
         # @return [Lokalise::Client]
         def api_client
-          @api_client ||= ::Lokalise.client LokaliseRails.api_token
+          @api_client ||= ::Lokalise.client LokaliseRails.api_token, LokaliseRails.timeouts
+        end
+
+        # Resets API client
+        def reset_api_client!
+          Lokalise.reset_client!
+          @api_client = nil
         end
 
         # Checks task options
@@ -44,6 +50,13 @@ module LokaliseRails
         def subdir_and_filename_for(entry)
           Pathname.new(entry).split
         end
+
+        # Returns Lokalise project ID and branch, semicolumn separated
+        #
+        # @return [String]
+        def project_id_with_branch
+          "#{LokaliseRails.project_id}:#{LokaliseRails.branch}"
+        end
       end
     end
   end

data/lib/lokalise_rails/task_definition/exporter.rb

@@ -14,13 +14,13 @@ module LokaliseRails
 
           if errors.any?
             errors.each { |e| $stdout.puts e }
-            return false
+            return errors
           end
 
           queued_processes = []
           each_file do |full_path, relative_path|
             queued_processes << api_client.upload_file(
-              LokaliseRails.project_id, opts(full_path, relative_path)
+              project_id_with_branch, opts(full_path, relative_path)
             )
           rescue StandardError => e
             $stdout.puts "Error while trying to upload #{full_path}: #{e.inspect}"
@@ -55,12 +55,10 @@ module LokaliseRails
         def opts(full_p, relative_p)
           content = File.read full_p
 
-          lang_iso = YAML.safe_load(content)&.keys&.first
-
           initial_opts = {
             data: Base64.strict_encode64(content.strip),
             filename: relative_p,
-            lang_iso: lang_iso
+            lang_iso: LokaliseRails.lang_iso_inferer.call(content)
           }
 
           initial_opts.merge LokaliseRails.export_opts

data/lib/lokalise_rails/task_definition/importer.rb

@@ -37,7 +37,7 @@ module LokaliseRails
         def download_files
           opts = LokaliseRails.import_opts
 
-          api_client.download_files LokaliseRails.project_id, opts
+          api_client.download_files project_id_with_branch, opts
         rescue StandardError => e
           $stdout.puts "There was an error when trying to download files: #{e.inspect}"
         end
@@ -46,9 +46,11 @@ module LokaliseRails
         #
         # @param path [String]
         def open_and_process_zip(path)
-          Zip::File.open_buffer(URI.open(path)) do |zip|
+          Zip::File.open_buffer(open_file_or_remote(path)) do |zip|
             fetch_zip_entries(zip) { |entry| process!(entry) }
           end
+        rescue StandardError => e
+          $stdout.puts "There was an error when trying to process the downloaded files: #{e.inspect}"
         end
 
         # Iterates over ZIP entries. Each entry may be a file or folder.
@@ -64,13 +66,13 @@ module LokaliseRails
 
         # Processes ZIP entry by reading its contents and creating the corresponding translation file
         def process!(zip_entry)
-          data = YAML.safe_load zip_entry.get_input_stream.read
+          data = data_from zip_entry
           subdir, filename = subdir_and_filename_for zip_entry.name
           full_path = "#{LokaliseRails.locales_path}/#{subdir}"
           FileUtils.mkdir_p full_path
 
           File.open(File.join(full_path, filename), 'w+:UTF-8') do |f|
-            f.write data.to_yaml
+            f.write LokaliseRails.translations_converter.call(data)
           end
         rescue StandardError => e
           $stdout.puts "Error when trying to process #{zip_entry&.name}: #{e.inspect}"
@@ -87,6 +89,24 @@ module LokaliseRails
           answer = $stdin.gets
           answer.to_s.strip == 'Y'
         end
+
+        # Opens a local file or a remote URL using the provided patf
+        #
+        # @return [String]
+        def open_file_or_remote(path)
+          parsed_path = URI.parse(path)
+          if parsed_path&.scheme&.include?('http')
+            parsed_path.open
+          else
+            File.open path
+          end
+        end
+
+        private
+
+        def data_from(zip_entry)
+          LokaliseRails.translations_loader.call zip_entry.get_input_stream.read
+        end
       end
     end
   end

data/lib/lokalise_rails/version.rb

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

data/lokalise_rails.gemspec

@@ -23,22 +23,21 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'ruby-lokalise-api', '~> 3.1'
+  spec.add_dependency 'ruby-lokalise-api', '~> 4.0'
   spec.add_dependency 'rubyzip', '~> 2.3'
 
-  spec.add_development_dependency 'codecov', '~> 0.1'
+  spec.add_development_dependency 'codecov', '~> 0.2'
   spec.add_development_dependency 'dotenv', '~> 2.5'
   if ENV['TEST_RAILS_VERSION'].nil?
-    spec.add_development_dependency 'rails', '~> 6.0.3'
+    spec.add_development_dependency 'rails', '~> 6.1.0'
   else
     spec.add_development_dependency 'rails', ENV['TEST_RAILS_VERSION'].to_s
   end
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'rspec-rails', '~> 4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.60'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 6.0'
 end

data/spec/dummy/config/environments/test.rb

@@ -17,9 +17,7 @@ Rails.application.configure do
 
   # Configure public file server for tests with Cache-Control for performance.
   config.public_file_server.enabled = true
-  config.public_file_server.headers = {
-    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
-  }
+  config.public_file_server.headers = {'Cache-Control' => 'public, max-age=3600'}
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+describe LokaliseRails::TaskDefinition::Base do
+  specify '.reset_client!' do
+    expect(described_class.api_client).to be_an_instance_of(Lokalise::Client)
+    described_class.reset_api_client!
+    current_client = described_class.instance_variable_get '@api_client'
+    expect(current_client).to be_nil
+  end
+
+  specify '.project_id_with_branch!' do
+    result = described_class.send :project_id_with_branch
+    expect(result).to be_an_instance_of(String)
+    expect(result).to include(':master')
+  end
+
+  describe '.subdir_and_filename_for' do
+    it 'works properly for longer paths' do
+      path = 'my_path/is/here/file.yml'
+      result = described_class.send(:subdir_and_filename_for, path)
+      expect(result.length).to eq(2)
+      expect(result[0]).to be_an_instance_of(Pathname)
+      expect(result[0].to_s).to eq('my_path/is/here')
+      expect(result[1].to_s).to eq('file.yml')
+    end
+
+    it 'works properly for shorter paths' do
+      path = 'file.yml'
+      result = described_class.send(:subdir_and_filename_for, path)
+      expect(result.length).to eq(2)
+      expect(result[1]).to be_an_instance_of(Pathname)
+      expect(result[0].to_s).to eq('.')
+      expect(result[1].to_s).to eq('file.yml')
+    end
+  end
+
+  describe '.opt_errors' do
+    it 'returns 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(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')
+      end
+    end
+  end
+
+  describe '.proper_ext?' do
+    it 'works properly with path represented as a string' do
+      path = 'my_path/here/file.yml'
+      expect(described_class.send(:proper_ext?, path)).to be true
+    end
+
+    it 'works properly with path represented as a pathname' do
+      path = Pathname.new 'my_path/here/file.json'
+      expect(described_class.send(:proper_ext?, path)).to be false
+    end
+  end
+
+  describe '.api_client' do
+    before(:all) { described_class.reset_api_client! }
+
+    after(:all) { described_class.reset_api_client! }
+
+    it 'is possible to set timeouts' do
+      allow(LokaliseRails).to receive(:timeouts).and_return({
+                                                              open_timeout: 100,
+                                                              timeout: 500
+                                                            })
+
+      expect(described_class.api_client).to be_an_instance_of(Lokalise::Client)
+      expect(described_class.api_client.open_timeout).to eq(100)
+      expect(described_class.api_client.timeout).to eq(500)
+    end
+  end
+end

data/spec/lib/lokalise_rails/{exporter_spec.rb → task_definition/exporter_spec.rb}

@@ -18,6 +18,8 @@ describe LokaliseRails::TaskDefinition::Exporter do
 
     describe '.export!' do
       it 'sends a proper API request' do
+        allow_project_id
+
         process = VCR.use_cassette('upload_files') do
           described_class.export!
         end.first
@@ -26,16 +28,30 @@ describe LokaliseRails::TaskDefinition::Exporter do
         expect(process.status).to eq('queued')
       end
 
+      it 'sends a proper API request when a different branch is provided' do
+        allow_project_id
+        allow(LokaliseRails).to receive(:branch).and_return('develop')
+
+        process = VCR.use_cassette('upload_files_branch') do
+          described_class.export!
+        end.first
+
+        expect(LokaliseRails).to have_received(:branch)
+        expect(process.project_id).to eq(LokaliseRails.project_id)
+        expect(process.status).to eq('queued')
+      end
+
       it 'halts when the API key is not set' do
-        expect(LokaliseRails).to receive(:api_token).and_return(nil)
-        expect(described_class).not_to receive(:each_file)
+        allow(LokaliseRails).to receive(:api_token).and_return(nil)
+
         expect(-> { described_class.export! }).to output(/API token is not set/).to_stdout
+        expect(LokaliseRails).to have_received(:api_token)
       end
 
       it 'halts when the project_id is not set' do
-        expect(LokaliseRails).to receive(:project_id).and_return(nil)
-        expect(described_class).not_to receive(:each_file)
-        expect(-> { described_class.export! }).to output(/Project ID is not set/).to_stdout
+        allow_project_id nil do
+          expect(-> { described_class.export! }).to output(/Project ID is not set/).to_stdout
+        end
       end
     end
 
@@ -60,13 +76,14 @@ describe LokaliseRails::TaskDefinition::Exporter do
       end
 
       it 'allows to redefine options' do
-        expect(LokaliseRails).to receive(:export_opts).and_return({
-                                                                    detect_icu_plurals: true,
-                                                                    convert_placeholders: true
-                                                                  })
+        allow(LokaliseRails).to receive(:export_opts).and_return({
+                                                                   detect_icu_plurals: true,
+                                                                   convert_placeholders: true
+                                                                 })
 
         resulting_opts = described_class.opts(path, relative_name)
 
+        expect(LokaliseRails).to have_received(:export_opts)
         expect(resulting_opts[:data]).to eq(base64content)
         expect(resulting_opts[:filename]).to eq(relative_name)
         expect(resulting_opts[:lang_iso]).to eq('en')
@@ -91,6 +108,8 @@ describe LokaliseRails::TaskDefinition::Exporter do
 
     describe '.export!' do
       it 'rescues from export errors' do
+        allow_project_id
+
         processes = VCR.use_cassette('upload_files_error') do
           described_class.export!
         end
@@ -129,7 +148,7 @@ describe LokaliseRails::TaskDefinition::Exporter do
       end
 
       it 'does not yield files that have to be skipped' do
-        expect(LokaliseRails).to receive(:skip_file_export).twice.and_return(
+        allow(LokaliseRails).to receive(:skip_file_export).twice.and_return(
           ->(f) { f.split[1].to_s.include?('ru') }
         )
         expect { |b| described_class.each_file(&b) }.to yield_successive_args(
@@ -138,6 +157,8 @@ describe LokaliseRails::TaskDefinition::Exporter do
             Pathname.new(relative_name)
           ]
         )
+
+        expect(LokaliseRails).to have_received(:skip_file_export).twice
       end
     end
   end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+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
+      expect(-> { described_class.open_and_process_zip(faulty_trans) }).
+        to output(/Psych::DisallowedClass/).to_stdout
+    end
+
+    it 'rescues from errors during file opening' do
+      expect(-> { described_class.open_and_process_zip('http://fake.url/wrong/path.zip') }).
+        to output(/SocketError/).to_stdout
+    end
+  end
+
+  describe '.download_files' do
+    it 'returns a proper download URL' do
+      allow_project_id '189934715f57a162257d74.88352370' do
+        response = VCR.use_cassette('download_files') do
+          described_class.download_files
+        end
+
+        expect(response['project_id']).to eq('189934715f57a162257d74.88352370')
+        expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
+      end
+    end
+
+    it 'rescues from 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
+      end
+    end
+  end
+
+  describe '.import!' do
+    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(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(count_translations).to eq(0)
+      end
+    end
+  end
+end

data/spec/lib/lokalise_rails_spec.rb

@@ -15,17 +15,17 @@ describe LokaliseRails do
     let(:fake_class) { class_double('LokaliseRails') }
 
     it 'is possible to set project_id' do
-      expect(fake_class).to receive(:project_id=).with('123.abc')
+      allow(fake_class).to receive(:project_id=).with('123.abc')
       fake_class.project_id = '123.abc'
     end
 
     it 'is possible to set file_ext_regexp' do
-      expect(fake_class).to receive(:file_ext_regexp=).with(Regexp.new('.*'))
+      allow(fake_class).to receive(:file_ext_regexp=).with(Regexp.new('.*'))
       fake_class.file_ext_regexp = Regexp.new('.*')
     end
 
     it 'is possible to set import_opts' do
-      expect(fake_class).to receive(:import_opts=).with(duck_type(:each))
+      allow(fake_class).to receive(:import_opts=).with(duck_type(:each))
       fake_class.import_opts = {
         format: 'json',
         indentation: '8sp'
@@ -33,32 +33,63 @@ describe LokaliseRails do
     end
 
     it 'is possible to set export_opts' do
-      expect(fake_class).to receive(:export_opts=).with(duck_type(:each))
+      allow(fake_class).to receive(:export_opts=).with(duck_type(:each))
       fake_class.export_opts = {
         convert_placeholders: true,
         detect_icu_plurals: true
       }
     end
 
+    it 'is possible to set branch' do
+      allow(fake_class).to receive(:branch=).with('custom')
+      fake_class.branch = 'custom'
+    end
+
+    it 'is possible to set timeouts' do
+      allow(fake_class).to receive(:timeouts=).with(duck_type(:each))
+      fake_class.timeouts = {
+        open_timeout: 100,
+        timeout: 500
+      }
+    end
+
     it 'is possible to set import_safe_mode' do
-      expect(fake_class).to receive(:import_safe_mode=).with(true)
+      allow(fake_class).to receive(:import_safe_mode=).with(true)
       fake_class.import_safe_mode = true
     end
 
     it 'is possible to set api_token' do
-      expect(fake_class).to receive(:api_token=).with('abc')
+      allow(fake_class).to receive(:api_token=).with('abc')
       fake_class.api_token = 'abc'
     end
 
     it 'is possible to override locales_path' do
-      expect(fake_class).to receive(:locales_path=).with('/demo/path')
+      allow(fake_class).to receive(:locales_path=).with('/demo/path')
       fake_class.locales_path = '/demo/path'
     end
 
     it 'is possible to set skip_file_export' do
       cond = ->(f) { f.nil? }
-      expect(fake_class).to receive(:skip_file_export=).with(cond)
+      allow(fake_class).to receive(:skip_file_export=).with(cond)
       fake_class.skip_file_export = cond
     end
+
+    it 'is possible to set translations_loader' do
+      runner = ->(f) { f.to_json }
+      allow(fake_class).to receive(:translations_loader=).with(runner)
+      fake_class.translations_loader = runner
+    end
+
+    it 'is possible to set translations_converter' do
+      runner = ->(f) { f.to_json }
+      allow(fake_class).to receive(:translations_converter=).with(runner)
+      fake_class.translations_converter = runner
+    end
+
+    it 'is possible to set lang_iso_inferer' do
+      runner = ->(f) { f.to_json }
+      allow(fake_class).to receive(:lang_iso_inferer=).with(runner)
+      fake_class.lang_iso_inferer = runner
+    end
   end
 end

data/spec/lib/tasks/import_task_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe LokaliseRails do
     end
 
     it 'import rake task is callable' do
-      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+      allow(LokaliseRails::TaskDefinition::Importer).to receive(
         :download_files
       ).and_return(
         {
@@ -30,14 +30,14 @@ RSpec.describe LokaliseRails do
       expect(import_executor).to output(/complete!/).to_stdout
 
       expect(count_translations).to eq(4)
-
+      expect(LokaliseRails::TaskDefinition::Importer).to have_received(:download_files)
       expect_file_exist loc_path, 'en/nested/main_en.yml'
       expect_file_exist loc_path, 'en/nested/deep/secondary_en.yml'
       expect_file_exist loc_path, 'ru/main_ru.yml'
     end
 
     it 'import rake task downloads ZIP archive properly' do
-      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+      allow(LokaliseRails::TaskDefinition::Importer).to receive(
         :download_files
       ).and_return(
         {
@@ -48,8 +48,8 @@ RSpec.describe LokaliseRails do
 
       expect(import_executor).to output(/complete!/).to_stdout
 
+      expect(LokaliseRails::TaskDefinition::Importer).to have_received(:download_files)
       expect(count_translations).to eq(4)
-
       expect_file_exist loc_path, 'en/nested/main_en.yml'
       expect_file_exist loc_path, 'en/nested/deep/secondary_en.yml'
       expect_file_exist loc_path, 'ru/main_ru.yml'
@@ -73,7 +73,7 @@ RSpec.describe LokaliseRails do
     end
 
     it 'import proceeds when the user agrees' do
-      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+      allow(LokaliseRails::TaskDefinition::Importer).to receive(
         :download_files
       ).and_return(
         {
@@ -81,21 +81,27 @@ RSpec.describe LokaliseRails do
           'bundle_url' => local_trans
         }
       )
-      expect($stdin).to receive(:gets).and_return('Y')
+
+      allow($stdin).to receive(:gets).and_return('Y')
       expect(import_executor).to output(/is not empty/).to_stdout
 
       expect(count_translations).to eq(5)
-
+      expect($stdin).to have_received(:gets)
+      expect(LokaliseRails::TaskDefinition::Importer).to have_received(:download_files)
       expect_file_exist loc_path, 'en/nested/main_en.yml'
       expect_file_exist loc_path, 'en/nested/deep/secondary_en.yml'
       expect_file_exist loc_path, 'ru/main_ru.yml'
     end
 
     it 'import halts when a user chooses not to proceed' do
-      expect(LokaliseRails::TaskDefinition::Importer).not_to receive(:download_files)
-      expect($stdin).to receive(:gets).and_return('N')
+      allow(LokaliseRails::TaskDefinition::Importer).to receive(
+        :download_files
+      ).at_most(0).times
+      allow($stdin).to receive(:gets).and_return('N')
       expect(import_executor).to output(/is not empty/).to_stdout
 
+      expect(LokaliseRails::TaskDefinition::Importer).not_to have_received(:download_files)
+      expect($stdin).to have_received(:gets)
       expect(count_translations).to eq(1)
     end
   end

data/spec/spec_helper.rb

@@ -20,16 +20,13 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 
 # Configure Rails Environment
 ENV['RAILS_ENV'] = 'test'
-
 require_relative '../spec/dummy/config/environment'
-# ActiveRecord::Migrator.migrations_paths = [File.expand_path('../spec/dummy/db/migrate', __dir__)]
 ENV['RAILS_ROOT'] ||= "#{File.dirname(__FILE__)}../../../spec/dummy"
 
-require 'rspec/rails'
-
 RSpec.configure do |config|
   config.include FileManager
   config.include RakeUtils
+  config.include SpecAddons
 end
 
 # rubocop:disable Style/MixinUsage

data/spec/support/spec_addons.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SpecAddons
+  def allow_project_id(value = ENV['LOKALISE_PROJECT_ID'])
+    allow(LokaliseRails).to receive(:project_id).and_return(value)
+    return unless block_given?
+
+    yield
+    expect(LokaliseRails).to have_received(:project_id)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Ilya Bodrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,34 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -242,20 +228,22 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/seeds.rb
 - spec/lib/generators/lokalise_rails/install_generator_spec.rb
-- spec/lib/lokalise_rails/exporter_spec.rb
-- spec/lib/lokalise_rails/importer_spec.rb
+- spec/lib/lokalise_rails/task_definition/base_spec.rb
+- spec/lib/lokalise_rails/task_definition/exporter_spec.rb
+- spec/lib/lokalise_rails/task_definition/importer_spec.rb
 - spec/lib/lokalise_rails_spec.rb
 - spec/lib/tasks/export_task_spec.rb
 - spec/lib/tasks/import_task_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/rake_utils.rb
+- spec/support/spec_addons.rb
 - spec/support/vcr.rb
 homepage: https://github.com/bodrovis/lokalise_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,8 +258,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails
 test_files:
@@ -298,12 +286,14 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/seeds.rb
 - spec/lib/generators/lokalise_rails/install_generator_spec.rb
-- spec/lib/lokalise_rails/exporter_spec.rb
-- spec/lib/lokalise_rails/importer_spec.rb
+- spec/lib/lokalise_rails/task_definition/base_spec.rb
+- spec/lib/lokalise_rails/task_definition/exporter_spec.rb
+- spec/lib/lokalise_rails/task_definition/importer_spec.rb
 - spec/lib/lokalise_rails_spec.rb
 - spec/lib/tasks/export_task_spec.rb
 - spec/lib/tasks/import_task_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/rake_utils.rb
+- spec/support/spec_addons.rb
 - spec/support/vcr.rb

data/spec/lib/lokalise_rails/importer_spec.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-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
-      expect(-> { described_class.open_and_process_zip(faulty_trans) }).
-        to output(/Psych::DisallowedClass/).to_stdout
-    end
-  end
-
-  describe '.download_files' do
-    it 'returns a proper download URL' do
-      expect(LokaliseRails).to receive(:project_id).and_return('189934715f57a162257d74.88352370')
-      response = VCR.use_cassette('download_files') do
-        described_class.download_files
-      end
-
-      expect(response['project_id']).to eq('189934715f57a162257d74.88352370')
-      expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
-    end
-
-    it 'rescues from errors during file download' do
-      allow(LokaliseRails).to receive(:api_token).and_return('incorrect')
-
-      VCR.use_cassette('download_files_error') do
-        expect(-> { described_class.download_files }).
-          to output(/Lokalise::Error::BadRequest/).to_stdout
-      end
-    end
-  end
-
-  describe '.import!' do
-    it 'halts when the API key is not set' do
-      expect(LokaliseRails).to receive(:api_token).and_return(nil)
-      expect(-> {described_class.import!}).to output(/API token is not set/).to_stdout
-      expect(count_translations).to eq(0)
-    end
-
-    it 'halts when the project_id is not set' do
-      expect(LokaliseRails).to receive(:project_id).and_return(nil)
-      expect(-> {described_class.import!}).to output(/Project ID is not set/).to_stdout
-      expect(count_translations).to eq(0)
-    end
-  end
-end