ruby-lokalise-api 2.9.0.1 → 4.1.0

data/lib/ruby-lokalise-api/utils/attribute_helpers.rb

@@ -16,16 +16,21 @@ module Lokalise
       # @return [String]
       # @param model_class [String]
       # @param plural [Boolean] Should the returned value be pluralized?
-      def data_key_for(model_class, plural = false, collection = false)
-        data_key_plural = get_key('DATA_KEY_PLURAL', model_class, true, true)
+      def data_key_for(model_class:, plural: false, collection: false)
+        data_key_plural = get_key(
+          name: 'DATA_KEY_PLURAL',
+          model_class: model_class,
+          collection: true,
+          strict: true
+        )
 
         return data_key_plural if collection && data_key_plural
 
-        data_key = get_key 'DATA_KEY', model_class, collection
+        data_key = get_key name: 'DATA_KEY', model_class: model_class, collection: collection
 
         return data_key unless plural
 
-        data_key + 's'
+        "#{data_key}s"
       end
 
       # Returns key used to determine resource id (for example `user_id` or `project_id`).
@@ -35,7 +40,7 @@ module Lokalise
       # @return [String]
       # @param model_class [String]
       def id_key_for(model_class)
-        get_key('ID_KEY', model_class) + '_id'
+        "#{get_key(name: 'ID_KEY', model_class: model_class)}_id"
       end
 
       # Loads attributes for the given resource based on its name
@@ -52,7 +57,7 @@ module Lokalise
 
       private
 
-      def get_key(name, model_class, collection = false, strict = false)
+      def get_key(name:, model_class:, collection: false, strict: false)
         key = if collection && Module.const_defined?("Lokalise::Collections::#{model_class}::#{name}")
                 Module.const_get "Lokalise::Collections::#{model_class}::#{name}"
               elsif Module.const_defined? "Lokalise::Resources::#{model_class}::#{name}"

data/lib/ruby-lokalise-api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lokalise
-  VERSION = '2.9.0.1'
+  VERSION = '4.1.0'
 end

data/ruby-lokalise-api.gemspec

@@ -10,9 +10,9 @@ Gem::Specification.new do |spec|
   spec.summary               = 'Ruby interface to the Lokalise API'
   spec.description           = 'Opinionated Ruby client for the Lokalise platform API allowing to work with translations, projects, users and other resources as with Ruby objects.'
   spec.homepage              = 'https://github.com/lokalise/ruby-lokalise-api'
-  spec.license               = 'MIT'
+  spec.license               = 'BSD-3-Clause'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files = Dir['README.md', 'LICENSE',
                    'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby-lokalise-api/data/attributes.json',
@@ -28,12 +28,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'codecov',                   '~> 0.1'
   spec.add_development_dependency 'dotenv',                    '~> 2.5'
-  spec.add_development_dependency 'oj',                        '~> 3.8'
+  spec.add_development_dependency 'oj',                        '~> 3.10'
   spec.add_development_dependency 'rake',                      '~> 13.0'
   spec.add_development_dependency 'rspec',                     '~> 3.6'
-  spec.add_development_dependency 'rubocop',                   '~> 0.60'
+  spec.add_development_dependency 'rubocop',                   '~> 1.6'
   spec.add_development_dependency 'rubocop-performance',       '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec',             '~> 1.37'
+  spec.add_development_dependency 'rubocop-rspec',             '~> 2.0'
   spec.add_development_dependency 'simplecov',                 '~> 0.16'
-  spec.add_development_dependency 'vcr',                       '~> 5.0'
+  spec.add_development_dependency 'vcr',                       '~> 6.0'
 end

data/spec/lib/ruby-lokalise-api/custom_json_parser_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe Lokalise::JsonHandler do
     '{":name":"rspec proj",":description":"demo project for rspec"}'
   end
 
-  # rubocop:disable RSpec/LeakyConstantDeclaration
+  # rubocop:disable RSpec/LeakyConstantDeclaration, Lint/ConstantDefinitionInBlock
   before do
     module Lokalise
       module JsonHandler
@@ -55,10 +55,10 @@ RSpec.describe Lokalise::JsonHandler do
       end
     end
   end
-  # rubocop:enable RSpec/LeakyConstantDeclaration
+  # rubocop:enable RSpec/LeakyConstantDeclaration, Lint/ConstantDefinitionInBlock
 
   it 'allows to customize #load' do
-    expect(Oj).to receive(:load).and_return(loaded_json)
+    allow(Oj).to receive(:load).and_return(loaded_json)
     expect(JSON).not_to receive(:parse)
     projects = VCR.use_cassette('all_projects_pagination') do
       test_client.projects limit: 1, page: 2
@@ -70,7 +70,7 @@ RSpec.describe Lokalise::JsonHandler do
   end
 
   it 'allows to customize #dump' do
-    expect(Oj).to receive(:dump).and_return(dumped_json)
+    allow(Oj).to receive(:dump).and_return(dumped_json)
     expect(JSON).not_to receive(:dump)
     project = VCR.use_cassette('new_project') do
       test_client.create_project name: 'rspec proj', description: 'demo project for rspec'

data/spec/lib/ruby-lokalise-api/error_spec.rb

@@ -7,6 +7,14 @@ RSpec.describe Lokalise::Error do
 
   after { Lokalise.reset_client! }
 
+  it 'raises a generic error when the code is unknown' do
+    expect do
+      VCR.use_cassette('error_unknown_code') do
+        get 'projects', Lokalise.client('invalid')
+      end
+    end.to raise_error(described_class)
+  end
+
   it 'raises BadRequest when API token is invalid' do
     expect do
       VCR.use_cassette('error_invalid_token') do

data/spec/lib/ruby-lokalise-api/rest/branches_spec.rb

@@ -40,6 +40,18 @@ RSpec.describe Lokalise::Client do
     expect(branch.created_by_email).to eq('bodrovis@protonmail.com')
   end
 
+  specify '#reload_data' do
+    branch = VCR.use_cassette('branch') do
+      test_client.branch project_id, branch_id
+    end
+
+    reloaded_branch = VCR.use_cassette('branch') do
+      branch.reload_data
+    end
+
+    expect(reloaded_branch.branch_id).to eq(branch.branch_id)
+  end
+
   specify '#create_branch' do
     branch = VCR.use_cassette('create_branch') do
       test_client.create_branch project_id, name: 'ruby-branch'

data/spec/lib/ruby-lokalise-api/rest/comments_spec.rb

@@ -49,6 +49,18 @@ RSpec.describe Lokalise::Client do
     expect(comment.added_at_timestamp).to eq(1_544_380_904)
   end
 
+  specify '#reload_data' do
+    comment = VCR.use_cassette('comment') do
+      test_client.comment project_id, another_key_id, '800746'
+    end
+
+    reloaded_comment = VCR.use_cassette('comment') do
+      comment.reload_data
+    end
+
+    expect(reloaded_comment.key_id).to eq(comment.key_id)
+  end
+
   specify '#create_comments' do
     comments = VCR.use_cassette('create_comments') do
       test_client.create_comments project_id, key_id, [

data/spec/lib/ruby-lokalise-api/rest/contributors_spec.rb

@@ -48,6 +48,18 @@ RSpec.describe Lokalise::Client do
     expect(contributor.created_at_timestamp).to eq(1_534_865_725)
   end
 
+  specify '#reload_data' do
+    contributor = VCR.use_cassette('contributor') do
+      test_client.contributor project_id, '20181'
+    end
+
+    reloaded_contributor = VCR.use_cassette('contributor') do
+      contributor.reload_data
+    end
+
+    expect(reloaded_contributor.user_id).to eq(contributor.user_id)
+  end
+
   specify '#create_contributors' do
     contributor = VCR.use_cassette('create_contributors') do
       test_client.create_contributors project_id,

data/spec/lib/ruby-lokalise-api/rest/custom_translation_statuses_spec.rb

@@ -43,6 +43,18 @@ RSpec.describe Lokalise::Client do
     expect(status.color).to eq('#0079bf')
   end
 
+  specify '#reload_data' do
+    status = VCR.use_cassette('translation_status') do
+      test_client.translation_status project_id, status_id
+    end
+
+    reloaded_status = VCR.use_cassette('translation_status') do
+      status.reload_data
+    end
+
+    expect(reloaded_status.status_id).to eq(status.status_id)
+  end
+
   specify '#create_translation_status' do
     title = 'Reviewed by doctors'
     color = '#f2d600'

data/spec/lib/ruby-lokalise-api/rest/files_spec.rb

@@ -35,8 +35,8 @@ RSpec.describe Lokalise::Client do
   specify '#download_files' do
     response = VCR.use_cassette('download_files') do
       test_client.download_files project_id,
-                                 "format": 'po',
-                                 "original_filenames": true
+                                 format: 'po',
+                                 original_filenames: true
     end
 
     expect(response['project_id']).to eq(project_id)
@@ -44,15 +44,23 @@ RSpec.describe Lokalise::Client do
   end
 
   specify '#upload_file' do
-    response = VCR.use_cassette('upload_file') do
+    process = VCR.use_cassette('upload_file') do
       test_client.upload_file project_id,
-                              "data": 'ZnI6DQogIHRlc3Q6IHRyYW5zbGF0aW9u',
-                              "filename": 'rspec.yml',
-                              'lang_iso': 'ru'
+                              data: 'ZnI6DQogIHRlc3Q6IHRyYW5zbGF0aW9u',
+                              filename: 'rspec_async.yml',
+                              lang_iso: 'ru'
     end
 
-    expect(response['project_id']).to eq(project_id)
-    expect(response['file']).to eq('rspec.yml')
-    expect(response['result']['skipped']).to eq(1)
+    expect(process).to be_an_instance_of(Lokalise::Resources::QueuedProcess)
+    expect(process.process_id).to eq('85c42bf5eff44648ca2f01f9db67b7d306a2f282')
+    expect(process.status).to eq('queued')
+
+    reloaded_process = VCR.use_cassette('upload_file_queued_reload') do
+      process.reload_data
+    end
+
+    expect(reloaded_process.process_id).to eq(process.process_id)
+    expect(reloaded_process.status).to eq('finished')
+    expect(reloaded_process.details['files'][0]['status']).to eq('finished')
   end
 end

data/spec/lib/ruby-lokalise-api/rest/keys_spec.rb

@@ -11,51 +11,69 @@ RSpec.describe Lokalise::Client do
         test_client.keys project_id
       end.collection
 
-      expect(keys.count).to eq(1)
+      expect(keys.count).to eq(8)
     end
 
     it 'supports pagination' do
       keys = VCR.use_cassette('all_keys_pagination') do
-        test_client.keys project_id, limit: 1, page: 1
+        test_client.keys project_id, limit: 2, page: 3
       end
 
-      expect(keys.collection.count).to eq(1)
-      expect(keys.total_results).to eq(1)
-      expect(keys.total_pages).to eq(1)
-      expect(keys.results_per_page).to eq(1)
-      expect(keys.current_page).to eq(1)
+      expect(keys.collection.count).to eq(2)
+      expect(keys.total_results).to eq(8)
+      expect(keys.total_pages).to eq(4)
+      expect(keys.results_per_page).to eq(2)
+      expect(keys.current_page).to eq(3)
 
-      expect(keys.next_page?).to eq(false)
-      expect(keys.last_page?).to eq(true)
-      expect(keys.prev_page?).to eq(false)
-      expect(keys.first_page?).to eq(true)
+      expect(keys.next_page?).to eq(true)
+      expect(keys.last_page?).to eq(false)
+      expect(keys.prev_page?).to eq(true)
+      expect(keys.first_page?).to eq(false)
     end
   end
 
   specify '#key' do
     key = VCR.use_cassette('key') do
-      test_client.key project_id, key_id, disable_references: 0
+      test_client.key project_id, 44_596_066, disable_references: 0
     end
 
-    expect(key.key_id).to eq(key_id)
-    expect(key.created_at).to eq('2018-12-03 19:11:30 (Etc/UTC)')
-    expect(key.key_name['ios']).to eq('test')
-    expect(key.filenames['web']).to eq('rspec.yml')
+    expect(key.key_id).to eq(44_596_066)
+    expect(key.project_id).to eq(project_id)
+    expect(key.branch).to eq('master')
+    expect(key.created_at).to eq('2020-05-11 11:20:33 (Etc/UTC)')
+    expect(key.created_at_timestamp).to eq(1_589_196_033)
+    expect(key.key_name['ios']).to eq('static_pages:index:welcome')
+    expect(key.filenames['web']).to eq('%LANG_ISO%.yml')
     expect(key.description).to eq('')
     expect(key.platforms).to eq(%w[web])
     expect(key.tags).to eq([])
-    expect(key.comments.first['comment']).to eq('demo comment')
-    expect(key.comments[1]['comment_id']).to eq(800_632)
+    expect(key.comments).to eq([])
     expect(key.screenshots).to eq([])
     expect(key.translations.first['modified_by_email']).to eq('bodrovis@protonmail.com')
     expect(key.is_plural).to eq(false)
     expect(key.plural_name).to eq('')
-    expect(key.is_hidden).to eq(false)
+    expect(key.is_hidden).to eq(true)
     expect(key.is_archived).to eq(false)
     expect(key.context).to eq('')
+    expect(key.base_words).to eq(1)
     expect(key.char_limit).to eq(0)
     expect(key.custom_attributes).to eq('')
-    expect(key.base_words).to eq(1)
+    expect(key.modified_at).to eq('2020-05-11 11:20:33 (Etc/UTC)')
+    expect(key.modified_at_timestamp).to eq(1_589_196_033)
+    expect(key.translations_modified_at).to eq('2020-05-15 10:44:42 (Etc/UTC)')
+    expect(key.translations_modified_at_timestamp).to eq(1_589_539_482)
+  end
+
+  specify '#reload_data' do
+    key = VCR.use_cassette('key') do
+      test_client.key project_id, 44_596_066, disable_references: 0
+    end
+
+    reloaded_key = VCR.use_cassette('key') do
+      key.reload_data disable_references: 0
+    end
+
+    expect(reloaded_key.key_id).to eq(key.key_id)
   end
 
   specify '#create_keys' do

data/spec/lib/ruby-lokalise-api/rest/languages_spec.rb

@@ -63,6 +63,18 @@ RSpec.describe Lokalise::Client do
     expect(language.plural_forms).to eq(%w[one other])
   end
 
+  specify '#reload_data' do
+    language = VCR.use_cassette('language') do
+      test_client.language project_id, language_id
+    end
+
+    reloaded_language = VCR.use_cassette('language') do
+      language.reload_data
+    end
+
+    expect(reloaded_language.lang_id).to eq(language.lang_id)
+  end
+
   specify '#create_languages' do
     language = VCR.use_cassette('create_languages') do
       test_client.create_languages project_id, lang_iso: 'ab', custom_name: 'rspec lang'

data/spec/lib/ruby-lokalise-api/rest/orders_spec.rb

@@ -37,8 +37,8 @@ RSpec.describe Lokalise::Client do
 
     expect(order.order_id).to eq(order_id)
     expect(order.project_id).to eq(project_id)
-    expect(order.card_id).to eq(card_id.to_s)
-    expect(order.status).to eq('in progress')
+    expect(order.card_id).to eq(card_id)
+    expect(order.status).to eq('completed')
     expect(order.created_at).to eq('2019-03-19 18:18:21 (Etc/UTC)')
     expect(order.created_by).to eq(20_181)
     expect(order.created_by_email).to eq('bodrovis@protonmail.com')
@@ -52,6 +52,19 @@ RSpec.describe Lokalise::Client do
     expect(order.translation_tier_name).to eq('Professional translator')
     expect(order.briefing).to eq('Some briefing')
     expect(order.total).to eq(0.07)
+    expect(order.payment_method).to be_nil
+  end
+
+  specify '#reload_data' do
+    order = VCR.use_cassette('order') do
+      test_client.order team_id, order_id
+    end
+
+    reloaded_order = VCR.use_cassette('order') do
+      order.reload_data
+    end
+
+    expect(reloaded_order.order_id).to eq(order.order_id)
   end
 
   specify '#create_order' do
@@ -74,4 +87,27 @@ RSpec.describe Lokalise::Client do
     expect(order.order_id).to eq(order_id)
     expect(order.status).to eq('in progress')
   end
+
+  it 'creates an order with dry run' do
+    order = VCR.use_cassette('create_order_dry_run') do
+      test_client.create_order team_id,
+                               project_id: project_id,
+                               card_id: card_id,
+                               briefing: 'Some briefing',
+                               source_language_iso: 'en',
+                               target_language_isos: [
+                                 'ru'
+                               ],
+                               keys: [
+                                 74_189_435
+                               ],
+                               provider_slug: 'gengo',
+                               translation_tier: '1',
+                               dry_run: true
+    end
+
+    expect(order.order_id).to be_nil
+    expect(order.status).to eq('draft')
+    expect(order.dry_run).to be true
+  end
 end

data/spec/lib/ruby-lokalise-api/rest/payment_cards_spec.rb

@@ -7,9 +7,10 @@ RSpec.describe Lokalise::Client do
     it 'returns all payment cards' do
       cards = VCR.use_cassette('all_payment_cards') do
         test_client.payment_cards
-      end.collection
+      end
 
-      card = cards.first
+      expect(cards.user_id).to eq(20_181)
+      card = cards.collection.first
       expect(card.card_id).to eq(1774)
       expect(card.last4).to eq('0358')
     end
@@ -35,9 +36,9 @@ RSpec.describe Lokalise::Client do
   specify '#create_payment_card' do
     card = VCR.use_cassette('new_payment_card') do
       test_client.create_payment_card number: '4242424242424242',
-                                      "cvc": '123',
-                                      "exp_month": 1,
-                                      "exp_year": 2030
+                                      cvc: '123',
+                                      exp_month: 1,
+                                      exp_year: 2030
     end
 
     expect(card.card_id).to eq(card_id)
@@ -49,12 +50,25 @@ RSpec.describe Lokalise::Client do
       test_client.payment_card card_id
     end
 
+    expect(card.user_id).to eq(20_181)
     expect(card.card_id).to eq(card_id)
     expect(card.brand).to eq('Visa')
     expect(card.last4).to eq('4242')
     expect(card.created_at).to eq('2019-03-19 17:01:22 (Etc/UTC)')
   end
 
+  specify '#reload_data' do
+    card = VCR.use_cassette('payment_card') do
+      test_client.payment_card card_id
+    end
+
+    reloaded_card = VCR.use_cassette('payment_card') do
+      card.reload_data
+    end
+
+    expect(reloaded_card.card_id).to eq(card.card_id)
+  end
+
   specify '#destroy_payment_card' do
     result = VCR.use_cassette('destroy_payment_card') do
       test_client.destroy_payment_card card_id