lokalise_manager 1.0.0

data/spec/lib/lokalise_manager/task_definitions/importer_spec.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+describe LokaliseManager::TaskDefinitions::Importer do
+  let(:described_object) do
+    described_class.new project_id: project_id,
+                        api_token: ENV['LOKALISE_API_TOKEN'],
+                        max_retries_import: 2
+  end
+  let(:loc_path) { described_object.config.locales_path }
+  let(:project_id) { ENV['LOKALISE_PROJECT_ID'] }
+  let(:local_trans) { "#{Dir.getwd}/spec/fixtures/trans.zip" }
+  let(:faulty_trans) { "#{Dir.getwd}/spec/fixtures/faulty_trans.zip" }
+
+  describe '.open_and_process_zip' do
+    it 're-raises errors during file processing' do
+      expect(-> { described_object.send(:open_and_process_zip, faulty_trans) }).
+        to raise_error(Psych::DisallowedClass, /Error when trying to process fail\.yml/)
+    end
+
+    it 're-raises errors during file opening' do
+      expect(-> { described_object.send(: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
+      response = VCR.use_cassette('download_files') do
+        described_object.send :download_files
+      end
+
+      expect(response['project_id']).to eq('672198945b7d72fc048021.15940510')
+      expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
+      expect(described_object.api_client.enable_compression).to eq(true)
+    end
+
+    it 're-raises errors during file download' do
+      allow_project_id described_object, 'invalid'
+
+      VCR.use_cassette('download_files_error') do
+        expect(-> { described_object.send :download_files }).
+          to raise_error(Lokalise::Error::BadRequest, /Invalid `project_id` parameter/)
+      end
+    end
+  end
+
+  describe '.import!' do
+    context 'with errors' do
+      it 'handles too many requests' do
+        allow(described_object).to receive(:sleep).and_return(0)
+
+        fake_client = instance_double('Lokalise::Client')
+        allow(fake_client).to receive(:download_files).and_raise(Lokalise::Error::TooManyRequests)
+        allow(described_object).to receive(:api_client).and_return(fake_client)
+
+        expect(-> { described_object.import! }).to raise_error(Lokalise::Error::TooManyRequests, /Gave up after 2 retries/i)
+
+        expect(described_object).to have_received(:sleep).exactly(2).times
+        expect(described_object).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(described_object.config).to receive(:api_token).and_return(nil)
+        expect(-> { described_object.import! }).to raise_error(LokaliseManager::Error, /API token is not set/i)
+        expect(described_object.config).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 described_object, nil do
+          expect(-> { described_object.import! }).to raise_error(LokaliseManager::Error, /ID is not set/i)
+          expect(count_translations).to eq(0)
+        end
+      end
+    end
+
+    context 'when directory is empty' do
+      before do
+        mkdir_locales
+        rm_translation_files
+      end
+
+      after :all do
+        rm_translation_files
+      end
+
+      it 'runs import successfully for local files' do
+        allow(described_object).to receive(:download_files).and_return(
+          {
+            'project_id' => '123.abc',
+            'bundle_url' => local_trans
+          }
+        )
+
+        expect(described_object.import!).to be true
+
+        expect(count_translations).to eq(4)
+        expect(described_object).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 'runs import successfully' do
+        result = VCR.use_cassette('import') do
+          described_object.import!
+        end
+
+        expect(result).to be true
+
+        expect(count_translations).to eq(8)
+        expect_file_exist loc_path, 'en.yml'
+        expect_file_exist loc_path, 'ru.yml'
+      end
+    end
+
+    context 'when directory is not empty and safe mode enabled' do
+      let(:safe_mode_obj) do
+        described_class.new project_id: project_id,
+                            api_token: ENV['LOKALISE_API_TOKEN'],
+                            import_safe_mode: true
+      end
+
+      before :all do
+        mkdir_locales
+      end
+
+      before do
+        rm_translation_files
+        add_translation_files!
+      end
+
+      after :all do
+        rm_translation_files
+      end
+
+      it 'import proceeds when the user agrees' do
+        allow(safe_mode_obj).to receive(:download_files).and_return(
+          {
+            'project_id' => '123.abc',
+            'bundle_url' => local_trans
+          }
+        )
+
+        allow($stdin).to receive(:gets).and_return('Y')
+        expect(-> { safe_mode_obj.import! }).to output(/is not empty/).to_stdout
+
+        expect(count_translations).to eq(5)
+        expect($stdin).to have_received(:gets)
+        expect(safe_mode_obj).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
+        allow(safe_mode_obj).to receive(:download_files).at_most(0).times
+        allow($stdin).to receive(:gets).and_return('N')
+        expect(-> { safe_mode_obj.import! }).to output(/is not empty/).to_stdout
+
+        expect(safe_mode_obj).not_to have_received(:download_files)
+        expect($stdin).to have_received(:gets)
+        expect(count_translations).to eq(1)
+      end
+    end
+  end
+end

data/spec/lib/lokalise_manager_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+describe LokaliseManager do
+  it 'returns a proper version' do
+    expect(described_class::VERSION).to be_a(String)
+  end
+
+  specify '.importer' do
+    expect(described_class.importer).to be_a(LokaliseManager::TaskDefinitions::Importer)
+  end
+
+  specify '.exporter' do
+    expect(described_class.exporter).to be_a(LokaliseManager::TaskDefinitions::Exporter)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec/'
+  add_filter '.github/'
+end
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+require 'lokalise_manager'
+
+# Support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.include FileManager
+  config.include SpecAddons
+end

data/spec/support/file_manager.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module FileManager
+  def mkdir_locales
+    FileUtils.mkdir_p(LokaliseManager::GlobalConfig.locales_path) unless File.directory?(LokaliseManager::GlobalConfig.locales_path)
+  end
+
+  def rm_translation_files
+    FileUtils.rm_rf locales_dir
+  end
+
+  def locales_dir
+    Dir["#{LokaliseManager::GlobalConfig.locales_path}/**/*"]
+  end
+
+  def count_translations
+    locales_dir.count { |file| File.file?(file) }
+  end
+
+  def add_translation_files!(with_ru: false, additional: nil)
+    FileUtils.mkdir_p "#{Dir.getwd}/locales/nested"
+    open_and_write('locales/nested/en.yml') { |f| f.write en_data }
+
+    return unless with_ru
+
+    open_and_write('locales/ru.yml') { |f| f.write ru_data }
+
+    return unless additional
+
+    additional.times do |i|
+      data = {'en' => {"key_#{i}" => "value #{i}"}}
+
+      open_and_write("locales/en_#{i}.yml") { |f| f.write data.to_yaml }
+    end
+  end
+
+  def open_and_write(rel_path, &block)
+    return unless block
+
+    File.open("#{Dir.getwd}/#{rel_path}", 'w+:UTF-8', &block)
+  end
+
+  private
+
+  def en_data
+    <<~DATA
+      en:
+        my_key: "My value"
+        nested:
+          key: "Value 2"
+    DATA
+  end
+
+  def ru_data
+    <<~DATA
+      ru_RU:
+        my_key: "Моё значение"
+        nested:
+          key: "Значение 2"
+    DATA
+  end
+end

data/spec/support/spec_addons.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SpecAddons
+  def allow_project_id(obj, value)
+    allow(obj.config).to receive(:project_id).and_return(value)
+    return unless block_given?
+
+    yield
+    expect(obj.config).to have_received(:project_id)
+  end
+
+  def expect_file_exist(path, file)
+    file_path = File.join path, file
+    expect(File.file?(file_path)).to be true
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.ignore_hosts 'codeclimate.com'
+  c.hook_into :faraday
+  c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'vcr_cassettes')
+  c.filter_sensitive_data('<LOKALISE_TOKEN>') { ENV.fetch('LOKALISE_API_TOKEN') }
+  c.configure_rspec_metadata!
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: lokalise_manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ilya Bodrov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lokalise-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: This gem contains a collection of some common tasks for Lokalise. Specifically,
+  it allows to import/export translation files from/to Lokalise TMS.
+email:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lokalise_manager.rb
+- lib/lokalise_manager/error.rb
+- lib/lokalise_manager/global_config.rb
+- lib/lokalise_manager/task_definitions/base.rb
+- lib/lokalise_manager/task_definitions/exporter.rb
+- lib/lokalise_manager/task_definitions/importer.rb
+- lib/lokalise_manager/version.rb
+- lokalise_manager.gemspec
+- spec/lib/lokalise_manager/global_config_spec.rb
+- spec/lib/lokalise_manager/task_definitions/base_spec.rb
+- spec/lib/lokalise_manager/task_definitions/exporter_spec.rb
+- spec/lib/lokalise_manager/task_definitions/importer_spec.rb
+- spec/lib/lokalise_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_manager.rb
+- spec/support/spec_addons.rb
+- spec/support/vcr.rb
+homepage: https://github.com/bodrovis/lokalise_manager
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.26
+signing_key:
+specification_version: 4
+summary: Lokalise integration for Ruby
+test_files:
+- spec/lib/lokalise_manager/global_config_spec.rb
+- spec/lib/lokalise_manager/task_definitions/base_spec.rb
+- spec/lib/lokalise_manager/task_definitions/exporter_spec.rb
+- spec/lib/lokalise_manager/task_definitions/importer_spec.rb
+- spec/lib/lokalise_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_manager.rb
+- spec/support/spec_addons.rb
+- spec/support/vcr.rb