ruby-lokalise-api 2.10.0 → 3.0.0

data/lib/ruby-lokalise-api/rest/teams.rb

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all teams available to the user
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-teams-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-teams-get
     # @return [Lokalise::Collection::Team<Lokalise::Resources::Team>]
     # @param params [Hash]
     def teams(params = {})

data/lib/ruby-lokalise-api/rest/translation_providers.rb

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all translation providers for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-providers-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-providers-get
     # @return [Lokalise::Collection::TranslationProvider<Lokalise::Resources::TranslationProvider>]
     # @param team_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns a single translation provider for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-provider-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-provider-get
     # @return [Lokalise::Resources::TranslationProvider]
     # @param team_id [String]
     # @param provider_id [String, Integer]

data/lib/ruby-lokalise-api/rest/translations.rb

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all translations for the given project (ungrouped)
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-translations-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-translations-get
     # @return [Lokalise::Collection::Translation<Lokalise::Resources::Translation>]
     # @param project_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns translation of the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-translation-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-translation-get
     # @return [Lokalise::Resources::Translation]
     # @param project_id [String]
     # @param translation_id [String, Integer]
@@ -25,7 +25,7 @@ module Lokalise
 
     # Updates translation of the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-translation-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-translation-put
     # @return [Lokalise::Resources::Translation]
     # @param project_id [String]
     # @param translation_id [String, Integer]

data/lib/ruby-lokalise-api/rest/webhooks.rb

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all webhooks for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-webhooks-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-webhooks-get
     # @return [Lokalise::Collection::Webhook<Lokalise::Resources::Webhook>]
     # @param project_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns a single webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-webhook-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-webhook-get
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
@@ -24,7 +24,7 @@ module Lokalise
 
     # Creates webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-webhook-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-webhook-post
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param params [Hash]
@@ -34,7 +34,7 @@ module Lokalise
 
     # Updates webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-webhook-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-webhook-put
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
@@ -45,7 +45,7 @@ module Lokalise
 
     # Deletes webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-webhook-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-webhook-delete
     # @return [Hash]
     # @param project_id [String]
     # @param webhook_id [String, Integer]

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

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

data/ruby-lokalise-api.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |spec|
   spec.homepage              = 'https://github.com/lokalise/ruby-lokalise-api'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.4.0'
 
   spec.files = Dir['README.md', 'LICENSE',
                    'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby-lokalise-api/data/attributes.json',
@@ -28,7 +27,7 @@ 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'

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('ff1876382b7ba81f2bb465da8f030196ec401fa6')
+    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

@@ -58,6 +58,18 @@ RSpec.describe Lokalise::Client do
     expect(key.base_words).to eq(1)
   end
 
+  specify '#reload_data' do
+    key = VCR.use_cassette('key') do
+      test_client.key project_id, key_id, 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
     keys = VCR.use_cassette('create_keys') do
       test_client.create_keys project_id, key_name: 'rspec_k', platforms: %w[ios]

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

@@ -54,6 +54,18 @@ RSpec.describe Lokalise::Client do
     expect(order.total).to eq(0.07)
   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
     order = VCR.use_cassette('create_order') do
       test_client.create_order team_id,

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

@@ -55,6 +55,18 @@ RSpec.describe Lokalise::Client do
     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

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

@@ -51,6 +51,18 @@ RSpec.describe Lokalise::Client do
     expect(project.statistics['progress_total']).to eq(18)
   end
 
+  specify '#reload_data' do
+    project = VCR.use_cassette('project') do
+      test_client.project '803826145ba90b42d5d860.46800099'
+    end
+
+    reloaded_project = VCR.use_cassette('project') do
+      project.reload_data
+    end
+
+    expect(reloaded_project.project_id).to eq(project.project_id)
+  end
+
   specify '#create_project' do
     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/rest/queued_processes_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:process_id) { '3b943469e6b3e324b5bdad639b122a623e6e7a1a' }
+  let(:queued_process_id) { 'ff1876382b7ba81f2bb465da8f030196ec401fa6' }
+
+  describe '#queued_processes' do
+    it 'returns all queued processes' do
+      processes = VCR.use_cassette('all_queued_processes') do
+        test_client.queued_processes project_id
+      end
+
+      expect(processes.branch).to eq('master')
+      processes = processes.collection
+      puts processes.count
+      expect(processes.count).to eq(8)
+      expect(processes.first.process_id).to eq(process_id)
+    end
+  end
+
+  specify '#queued_process' do
+    process = VCR.use_cassette('queued_process') do
+      test_client.queued_process project_id, process_id
+    end
+
+    expect(process.branch).to eq('master')
+    expect(process.process_id).to eq(process_id)
+    expect(process.type).to eq('file-import')
+    expect(process.status).to eq('finished')
+    expect(process.message).to eq('')
+    expect(process.created_by).to eq(20_181)
+    expect(process.created_by_email).to eq('bodrovis@protonmail.com')
+    expect(process.created_at).to eq('2020-05-13 11:24:37 (Etc/UTC)')
+    expect(process.created_at_timestamp).to eq(1_589_369_077)
+    files = process.details['files']
+    expect(files.count).to eq(1)
+    expect(files[0]['status']).to eq('finished')
+    expect(files[0]['name_original']).to eq('test_async.json')
+  end
+
+  describe 'process status check' do
+    specify '#reload_data' do
+      queued_process = VCR.use_cassette('upload_file_status') do
+        test_client.queued_process project_id, queued_process_id
+      end
+
+      expect(queued_process.status).to eq('queued')
+
+      reloaded_process = VCR.use_cassette('upload_file_queued_reload') do
+        queued_process.reload_data
+      end
+
+      expect(reloaded_process.process_id).to eq(queued_process.process_id)
+      expect(reloaded_process.status).to eq('finished')
+    end
+  end
+end

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

@@ -41,6 +41,18 @@ RSpec.describe Lokalise::Client do
     expect(screenshot.height).to eq(32)
   end
 
+  specify '#reload_data' do
+    screenshot = VCR.use_cassette('screenshot') do
+      test_client.screenshot project_id, screenshot_id
+    end
+
+    reloaded_screenshot = VCR.use_cassette('screenshot') do
+      screenshot.reload_data
+    end
+
+    expect(reloaded_screenshot.screenshot_id).to eq(screenshot.screenshot_id)
+  end
+
   specify '#create_screenshots' do
     screenshot_from_file do |file|
       screenshot = VCR.use_cassette('create_screenshots') do

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

@@ -68,6 +68,31 @@ RSpec.describe Lokalise::Client do
   end
 
   context 'when snapshot methods are chained' do
+    it 'allows restored project to receive chained methods' do
+      snapshot = VCR.use_cassette('create_snapshot_for_chained') do
+        test_client.create_snapshot project_id, title: 'chained rspec snap'
+      end
+
+      new_project = VCR.use_cassette('restore_snapshot_for_chained') do
+        snapshot.restore
+      end
+
+      updated_project = VCR.use_cassette('restored_updated_project') do
+        new_project.update name: 'Restored and updated'
+      end
+
+      expect(updated_project.client).to eq(test_client)
+      expect(updated_project.name).to eq('Restored and updated')
+      expect(updated_project.project_id).to eq(new_project.project_id)
+
+      response = VCR.use_cassette('delete_restored_project') do
+        updated_project.destroy
+      end
+
+      expect(response['project_id']).to eq(updated_project.project_id)
+      expect(response['project_deleted']).to eq(true)
+    end
+
     it 'supports destroy and restore' do
       snapshot = VCR.use_cassette('create_another_snapshot') do
         test_client.create_snapshot project_id, title: 'chained'