ruby-lokalise-api 2.8.0 → 3.1.0

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:branch_id) { 41_302 }
 
   describe '#branches' do
-    it 'should return all branches' do
+    it 'returns all branches' do
       branches = VCR.use_cassette('all_branches') do
         test_client.branches project_id
       end.collection
@@ -11,7 +13,7 @@ RSpec.describe Lokalise::Client do
       expect(branches.count).to eq(1)
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       branches = VCR.use_cassette('all_branches_pagination') do
         test_client.branches project_id, limit: 1, page: 1
       end
@@ -38,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'
@@ -82,8 +96,8 @@ RSpec.describe Lokalise::Client do
     expect(response['branch']['name']).to eq(branch.name)
   end
 
-  context 'branch chained methods' do
-    it 'should support merge' do
+  context 'when branch methods are chained' do
+    it 'supports merge' do
       branch = VCR.use_cassette('create_branch_to_merge2') do
         test_client.create_branch project_id, name: 'merge-me-plz'
       end
@@ -102,7 +116,7 @@ RSpec.describe Lokalise::Client do
       expect(response['branch']['name']).to eq(branch.name)
     end
 
-    it 'should support update and destroy' do
+    it 'supports update and destroy' do
       branch = VCR.use_cassette('create_another_branch') do
         test_client.create_branch project_id, name: 'ruby-second-branch'
       end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:key_id) { 15_305_182 }
   let(:another_key_id) { 15_519_786 }
 
   describe '#comments' do
-    it 'should return all comments' do
+    it 'returns all comments' do
       comments = VCR.use_cassette('all_comments') do
         test_client.comments project_id, key_id
       end.collection
@@ -12,7 +14,7 @@ RSpec.describe Lokalise::Client do
       expect(comments.count).to eq(3)
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       comments = VCR.use_cassette('all_comments_pagination') do
         test_client.comments project_id, key_id, limit: 1, page: 2
       end
@@ -29,7 +31,7 @@ RSpec.describe Lokalise::Client do
       expect(comments.prev_page?).to eq(true)
       expect(comments.first_page?).to eq(false)
 
-      expect(comments.client).to be_an_instance_of(Lokalise::Client)
+      expect(comments.client).to be_an_instance_of(described_class)
     end
   end
 
@@ -47,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, [
@@ -85,8 +99,8 @@ RSpec.describe Lokalise::Client do
     expect(response['comment_deleted']).to eq(true)
   end
 
-  context 'comment chained methods' do
-    it 'should support destroy' do
+  context 'when comment methods are chained' do
+    it 'supports destroy' do
       comment = VCR.use_cassette('create_another_comment') do
         test_client.create_comments project_id, another_key_id, comment: 'chained comment'
       end.collection.first

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:contributor_id) { 25_953 }
 
   describe '#contributors' do
-    it 'should return all contributors' do
+    it 'returns all contributors' do
       contributors = VCR.use_cassette('all_contributors') do
         test_client.contributors project_id
       end.collection
@@ -12,7 +14,7 @@ RSpec.describe Lokalise::Client do
       expect(contributors.first.fullname).to eq('John Doe')
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       contributors = VCR.use_cassette('all_contributors_pagination') do
         test_client.contributors project_id, limit: 1, page: 2
       end
@@ -46,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,
@@ -83,8 +97,8 @@ RSpec.describe Lokalise::Client do
     expect(response['contributor_deleted']).to eq(true)
   end
 
-  context 'contributor chained methods' do
-    it 'should support update and destroy' do
+  context 'when contributor methods are chained' do
+    it 'supports update and destroy' do
       contributor = VCR.use_cassette('create_another_contributor') do
         test_client.create_contributors project_id,
                                         email: 'demo@test.com',

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:status_id) { 128 }
   let(:new_status_id) { 126 }
 
   describe '#translation_statuses' do
-    it 'should return all statuses' do
+    it 'returns all statuses' do
       statuses = VCR.use_cassette('all_translation_statuses') do
         test_client.translation_statuses project_id
       end.collection
@@ -13,7 +15,7 @@ RSpec.describe Lokalise::Client do
       expect(statuses.first.status_id).to eq(status_id)
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       statuses = VCR.use_cassette('all_translation_statuses_pagination') do
         test_client.translation_statuses project_id, limit: 1, page: 2
       end
@@ -41,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'
@@ -85,8 +99,8 @@ RSpec.describe Lokalise::Client do
     expect(response).to include('#f2d600')
   end
 
-  context 'translation status chained methods' do
-    it 'should support update and destroy' do
+  context 'when translation status methods are chained' do
+    it 'supports update and destroy' do
       status = VCR.use_cassette('create_another_translation_status') do
         test_client.create_translation_status project_id,
                                               title: 'rspec',

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
 
   describe '#files' do
-    it 'should return all files' do
+    it 'returns all files' do
       files = VCR.use_cassette('files') do
         test_client.files project_id
       end.collection
@@ -14,7 +16,7 @@ RSpec.describe Lokalise::Client do
       expect(file.key_count).to eq(1)
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       files = VCR.use_cassette('all_files_pagination') do
         test_client.files project_id, limit: 1, page: 1
       end
@@ -33,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)
@@ -42,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

@@ -1,59 +1,79 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:key_id) { 15_305_182 }
   let(:new_key_id) { 15_519_770 }
 
   describe '#keys' do
-    it 'should return all keys' do
+    it 'returns all keys' do
       keys = VCR.use_cassette('all_keys') do
         test_client.keys project_id
       end.collection
 
-      expect(keys.count).to eq(1)
+      expect(keys.count).to eq(8)
     end
 
-    it 'should support pagination' do
+    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
@@ -126,8 +146,8 @@ RSpec.describe Lokalise::Client do
     expect(response['keys_removed']).to eq(true)
   end
 
-  context 'key chained methods' do
-    it 'should support update and destroy' do
+  context 'when key methods are chained' do
+    it 'supports update and destroy' do
       key = VCR.use_cassette('create_another_key') do
         test_client.create_keys project_id, key_name: 'chained_k', platforms: %w[ios]
       end.collection.first
@@ -153,8 +173,8 @@ RSpec.describe Lokalise::Client do
     end
   end
 
-  context 'keys collection chained methods' do
-    it 'should support destroy_all' do
+  context 'when keys collection methods are chained' do
+    it 'supports destroy_all' do
       keys = VCR.use_cassette('create_keys_collection') do
         test_client.create_keys project_id, [
           {

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:language_id) { 640 }
   let(:new_language_id) { 894 }
 
   describe '#system_languages' do
-    it 'should return all system languages' do
+    it 'returns all system languages' do
       languages = VCR.use_cassette('all_system_languages') do
         test_client.system_languages
       end.collection
@@ -13,7 +15,7 @@ RSpec.describe Lokalise::Client do
       expect(languages.first.lang_iso).to eq('ab')
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       languages = VCR.use_cassette('all_system_languages_pagination') do
         test_client.system_languages limit: 10, page: 3
       end
@@ -27,7 +29,7 @@ RSpec.describe Lokalise::Client do
   end
 
   describe '#project_languages' do
-    it 'should return all project languages' do
+    it 'returns all project languages' do
       languages = VCR.use_cassette('all_project_languages') do
         test_client.project_languages project_id
       end.collection
@@ -36,7 +38,7 @@ RSpec.describe Lokalise::Client do
       expect(languages.first.lang_iso).to eq('en')
     end
 
-    it 'should support pagination' do
+    it 'supports pagination' do
       languages = VCR.use_cassette('all_project_languages_pagination') do
         test_client.project_languages project_id, limit: 1, page: 2
       end
@@ -61,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'
@@ -89,8 +103,8 @@ RSpec.describe Lokalise::Client do
     expect(response['language_deleted']).to eq(true)
   end
 
-  context 'project language chained methods' do
-    it 'should support update and destroy' do
+  context 'when project language methods are chained' do
+    it 'supports update and destroy' do
       language = VCR.use_cassette('create_another_language') do
         test_client.create_languages project_id, lang_iso: 'ab', custom_name: 'chained lang'
       end.collection.first