ruby-lokalise-api 1.0.1

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

@@ -0,0 +1,91 @@
+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
+      languages = VCR.use_cassette('all_system_languages') do
+        test_client.system_languages
+      end.collection
+
+      expect(languages.count).to eq(100)
+      expect(languages.first.lang_iso).to eq('ab')
+    end
+
+    it 'should support pagination' do
+      languages = VCR.use_cassette('all_system_languages_pagination') do
+        test_client.system_languages limit: 10, page: 3
+      end
+
+      expect(languages.collection.count).to eq(10)
+      expect(languages.total_results).to eq(618)
+      expect(languages.total_pages).to eq(62)
+      expect(languages.results_per_page).to eq(10)
+      expect(languages.current_page).to eq(3)
+    end
+  end
+
+  describe '#project_languages' do
+    it 'should return all project languages' do
+      languages = VCR.use_cassette('all_project_languages') do
+        test_client.project_languages project_id
+      end.collection
+
+      expect(languages.count).to eq(3)
+      expect(languages.first.lang_iso).to eq('en')
+    end
+
+    it 'should support pagination' do
+      languages = VCR.use_cassette('all_project_languages_pagination') do
+        test_client.project_languages project_id, limit: 1, page: 2
+      end
+
+      expect(languages.collection.count).to eq(1)
+      expect(languages.total_results).to eq(3)
+      expect(languages.total_pages).to eq(3)
+      expect(languages.results_per_page).to eq(1)
+      expect(languages.current_page).to eq(2)
+    end
+  end
+
+  specify '#language' do
+    language = VCR.use_cassette('language') do
+      test_client.language project_id, language_id
+    end
+
+    expect(language.lang_id).to eq(language_id)
+    expect(language.lang_iso).to eq('en')
+    expect(language.lang_name).to eq('English')
+    expect(language.is_rtl).to eq(false)
+    expect(language.plural_forms).to eq(%w[one other])
+  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'
+    end.collection.first
+
+    expect(language.lang_name).to eq('rspec lang')
+    expect(language.lang_iso).to eq('ab')
+  end
+
+  specify '#update_language' do
+    language = VCR.use_cassette('update_language') do
+      test_client.update_language project_id, new_language_id, lang_name: 'updated lang',
+                                                               plural_forms: %w[one]
+    end
+
+    expect(language.lang_name).to eq('updated lang')
+    expect(language.lang_iso).to eq('ab')
+    expect(language.plural_forms).to eq(%w[one])
+  end
+
+  specify '#delete_language' do
+    response = VCR.use_cassette('delete_language') do
+      test_client.delete_language project_id, new_language_id
+    end
+    expect(response['project_id']).to eq(project_id)
+    expect(response['language_deleted']).to eq(true)
+  end
+end

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

@@ -0,0 +1,79 @@
+RSpec.describe Lokalise::Client do
+  let(:new_project_id) { '572222075c0953fd70d492.30502628' }
+
+  describe '#projects' do
+    it 'should return all projects' do
+      projects = VCR.use_cassette('all_projects') do
+        test_client.projects
+      end.collection
+      project = projects.first
+
+      expect(projects.count).to eq(5)
+      expect(project.name).to eq('demo phoenix')
+    end
+
+    it 'should support pagination' do
+      projects = VCR.use_cassette('all_projects_pagination') do
+        test_client.projects limit: 1, page: 2
+      end
+
+      expect(projects.collection.count).to eq(1)
+      expect(projects.total_results).to eq(5)
+      expect(projects.total_pages).to eq(5)
+      expect(projects.results_per_page).to eq(1)
+      expect(projects.current_page).to eq(2)
+    end
+  end
+
+  specify '#project' do
+    project = VCR.use_cassette('project') do
+      test_client.project '803826145ba90b42d5d860.46800099'
+    end
+
+    expect(project.project_id).to eq('803826145ba90b42d5d860.46800099')
+    expect(project.name).to eq('demo phoenix')
+    expect(project.team_id).to eq(176_692)
+    expect(project.description).to eq('')
+    expect(project.created_at).to eq('2018-09-24 18:05:22 (Etc/UTC)')
+    expect(project.created_by).to eq(20_181)
+    expect(project.created_by_email).to eq('bodrovis@protonmail.com')
+  end
+
+  specify '#create_project' do
+    project = VCR.use_cassette('new_project') do
+      test_client.create_project name: 'rspec proj', description: 'demo project for rspec'
+    end
+
+    expect(project.name).to eq('rspec proj')
+    expect(project.description).to eq('demo project for rspec')
+    expect(project.team_id).to eq(176_692)
+  end
+
+  specify '#update_project' do
+    project = VCR.use_cassette('update_project') do
+      test_client.update_project new_project_id,
+                                 name: 'rspec proj updated', description: 'updated project for rspec'
+    end
+
+    expect(project.name).to eq('rspec proj updated')
+    expect(project.description).to eq('updated project for rspec')
+    expect(project.team_id).to eq(176_692)
+  end
+
+  specify '#empty_project' do
+    response = VCR.use_cassette('empty_project') do
+      test_client.empty_project new_project_id
+    end
+
+    expect(response['project_id']).to eq(new_project_id)
+    expect(response['keys_deleted']).to eq(true)
+  end
+
+  specify '#delete_project' do
+    response = VCR.use_cassette('delete_project') do
+      test_client.delete_project new_project_id
+    end
+    expect(response['project_id']).to eq(new_project_id)
+    expect(response['project_deleted']).to eq(true)
+  end
+end

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

@@ -0,0 +1,76 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:screenshot_id) { 115_185 }
+
+  describe '#screenshots' do
+    it 'should return all screenshots' do
+      screenshots = VCR.use_cassette('all_screenshots') do
+        test_client.screenshots project_id
+      end.collection
+
+      expect(screenshots.count).to eq(1)
+    end
+
+    it 'should support pagination' do
+      screenshots = VCR.use_cassette('all_screenshots_pagination') do
+        test_client.screenshots project_id, limit: 1, page: 1
+      end
+
+      expect(screenshots.collection.count).to eq(1)
+      expect(screenshots.total_results).to eq(1)
+      expect(screenshots.total_pages).to eq(1)
+      expect(screenshots.results_per_page).to eq(1)
+      expect(screenshots.current_page).to eq(1)
+    end
+  end
+
+  specify '#screenshot' do
+    screenshot = VCR.use_cassette('screenshot') do
+      test_client.screenshot project_id, screenshot_id
+    end
+
+    expect(screenshot.screenshot_id).to eq(screenshot_id)
+    expect(screenshot.key_ids).to eq([])
+    expect(screenshot.url).to include('amazonaws.com')
+    expect(screenshot.title).to eq('rspec screen')
+    expect(screenshot.description).to eq('')
+    expect(screenshot.screenshot_tags).to eq([])
+    expect(screenshot.width).to eq(125)
+    expect(screenshot.height).to eq(32)
+  end
+
+  specify '#create_screenshots' do
+    file = File.open File.expand_path('spec/fixtures/screenshot_base64.txt')
+    begin
+      screenshot = VCR.use_cassette('create_screenshots') do
+        test_client.create_screenshots project_id, data: file.read, title: 'rspec screen'
+      end.collection.first
+
+      expect(screenshot.title).to eq('rspec screen')
+      expect(screenshot.url).to include('amazonaws.com')
+    rescue StandardError => e
+      puts e
+    ensure
+      file.close
+    end
+  end
+
+  specify '#update_screenshot' do
+    screenshot = VCR.use_cassette('update_screenshot') do
+      test_client.update_screenshot project_id, screenshot_id, tags: %w[demo rspec],
+                                                               description: 'demo desc'
+    end
+
+    expect(screenshot.screenshot_id).to eq(screenshot_id)
+    expect(screenshot.screenshot_tags).to eq(%w[demo rspec])
+    expect(screenshot.description).to eq('demo desc')
+  end
+
+  specify '#delete_screenshot' do
+    response = VCR.use_cassette('delete_screenshot') do
+      test_client.delete_screenshot project_id, screenshot_id
+    end
+    expect(response['project_id']).to eq(project_id)
+    expect(response['screenshot_deleted']).to eq(true)
+  end
+end

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

@@ -0,0 +1,61 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:snapshot_id) { 27_881 }
+
+  describe '#snapshots' do
+    it 'should return all snapshots' do
+      snapshots = VCR.use_cassette('all_snapshots') do
+        test_client.snapshots project_id
+      end.collection
+
+      snapshot = snapshots.first
+
+      expect(snapshots.count).to eq(2)
+      expect(snapshot.title).to eq('test')
+      expect(snapshot.snapshot_id).to eq(snapshot_id)
+      expect(snapshot.created_at).to eq('2018-12-10 17:01:48 (Etc/UTC)')
+      expect(snapshot.created_by).to eq(20_181)
+      expect(snapshot.created_by_email).to eq('bodrovis@protonmail.com')
+    end
+
+    it 'should support pagination' do
+      snapshots = VCR.use_cassette('all_snapshots_pagination') do
+        test_client.snapshots project_id, limit: 1, page: 2
+      end
+
+      expect(snapshots.collection.count).to eq(1)
+      expect(snapshots.total_results).to eq(2)
+      expect(snapshots.total_pages).to eq(2)
+      expect(snapshots.results_per_page).to eq(1)
+      expect(snapshots.current_page).to eq(2)
+    end
+  end
+
+  specify '#create_snapshot' do
+    snapshot = VCR.use_cassette('create_snapshot') do
+      test_client.create_snapshot project_id, title: 'test rspec'
+    end
+
+    expect(snapshot.title).to eq('test rspec')
+  end
+
+  specify '#restore_snapshot' do
+    project = VCR.use_cassette('restore_snapshot') do
+      test_client.restore_snapshot project_id, snapshot_id
+    end
+
+    expect(project.name).to eq('demo phoenix copy')
+    expect(project.created_by_email).to eq('bodrovis@protonmail.com')
+    # Restore creates a new copy of the project!
+    expect(project.project_id).not_to eq(project_id)
+  end
+
+  specify '#delete_snapshot' do
+    response = VCR.use_cassette('delete_snapshot') do
+      test_client.delete_snapshot project_id, snapshot_id
+    end
+
+    expect(response['project_id']).to eq(project_id)
+    expect(response['snapshot_deleted']).to eq(true)
+  end
+end

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

@@ -0,0 +1,89 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:key_id) { 15_571_976 }
+  let(:task_id) { 4387 }
+
+  describe '#tasks' do
+    it 'should return all tasks' do
+      tasks = VCR.use_cassette('all_tasks') do
+        test_client.tasks project_id
+      end.collection
+
+      expect(tasks.count).to eq(3)
+    end
+
+    it 'should support pagination' do
+      tasks = VCR.use_cassette('all_tasks_pagination') do
+        test_client.tasks project_id, limit: 2, page: 2
+      end
+
+      expect(tasks.collection.count).to eq(1)
+      expect(tasks.total_results).to eq(3)
+      expect(tasks.total_pages).to eq(2)
+      expect(tasks.results_per_page).to eq(2)
+      expect(tasks.current_page).to eq(2)
+    end
+  end
+
+  specify '#task' do
+    task = VCR.use_cassette('task') do
+      test_client.task project_id, task_id
+    end
+
+    expect(task.task_id).to eq(task_id)
+    expect(task.title).to eq('another rspec key')
+    expect(task.description).to eq('desc here')
+    expect(task.status).to eq('created')
+    expect(task.progress).to eq(0)
+    expect(task.due_date).to eq(nil)
+    expect(task.keys_count).to eq(1)
+    expect(task.words_count).to eq(0)
+    expect(task.created_at).to eq('2018-12-10 18:37:02 (Etc/UTC)')
+    expect(task.created_by).to eq(20_181)
+    expect(task.created_by_email).to eq('bodrovis@protonmail.com')
+    expect(task.can_be_parent).to eq(true)
+    expect(task.task_type).to eq('translation')
+    expect(task.parent_task_id).to eq(nil)
+    expect(task.closing_tags).to eq([])
+    expect(task.languages.first['language_iso']).to eq('ru')
+    expect(task.auto_close_languages).to eq(true)
+    expect(task.auto_close_task).to eq(true)
+    expect(task.completed_by).to eq(nil)
+    expect(task.completed_by_email).to eq(nil)
+    expect(task.completed_at).to eq(nil)
+  end
+
+  specify '#create_task' do
+    task = VCR.use_cassette('create_task') do
+      test_client.create_task project_id, title: 'another rspec key',
+                                          keys: [key_id],
+                                          languages: [
+                                            {
+                                              language_iso: 'ru',
+                                              users: ['20181']
+                                            }
+                                          ]
+    end
+
+    expect(task.title).to eq('another rspec key')
+    expect(task.languages.first['language_iso']).to eq('ru')
+  end
+
+  specify '#update_task' do
+    task = VCR.use_cassette('update_task') do
+      test_client.update_task project_id, task_id, description: 'desc here', auto_close_task: true
+    end
+
+    expect(task.task_id).to eq(task_id)
+    expect(task.description).to eq('desc here')
+    expect(task.auto_close_task).to eq(true)
+  end
+
+  specify '#delete_task' do
+    response = VCR.use_cassette('delete_task') do
+      test_client.delete_task project_id, task_id
+    end
+    expect(response['project_id']).to eq(project_id)
+    expect(response['task_deleted']).to eq(true)
+  end
+end

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

@@ -0,0 +1,56 @@
+RSpec.describe Lokalise::Client do
+  let(:team_id) { 176_692 }
+  let(:team_user_id) { 25_953 }
+
+  describe '#team_users' do
+    it 'should return all team_users' do
+      team_users = VCR.use_cassette('team_users') do
+        test_client.team_users team_id
+      end
+
+      expect(team_users.collection.count).to eq(4)
+      expect(team_users.team_id).to eq(team_id)
+    end
+
+    it 'should support pagination' do
+      team_users = VCR.use_cassette('all_team_users_pagination') do
+        test_client.team_users team_id, limit: 1, page: 3
+      end
+
+      expect(team_users.collection.count).to eq(1)
+      expect(team_users.total_results).to eq(4)
+      expect(team_users.total_pages).to eq(4)
+      expect(team_users.results_per_page).to eq(1)
+      expect(team_users.current_page).to eq(3)
+    end
+  end
+
+  specify '#team_user' do
+    team_user = VCR.use_cassette('team_user') do
+      test_client.team_user team_id, team_user_id
+    end
+
+    expect(team_user.user_id).to eq(team_user_id)
+    expect(team_user.email).to eq('rspec@test.com')
+    expect(team_user.fullname).to eq('Rspec test')
+    expect(team_user.created_at).to eq('2018-12-07 18:21:24 (Etc/UTC)')
+    expect(team_user.role).to eq('member')
+  end
+
+  specify '#update_team_user' do
+    team_user = VCR.use_cassette('update_team_user') do
+      test_client.update_team_user team_id, team_user_id, role: 'admin'
+    end
+
+    expect(team_user.user_id).to eq(team_user_id)
+    expect(team_user.role).to eq('admin')
+  end
+
+  specify '#delete_team_user' do
+    response = VCR.use_cassette('delete_team_user') do
+      test_client.delete_team_user team_id, team_user_id
+    end
+    expect(response['team_id']).to eq(team_id)
+    expect(response['team_user_deleted']).to eq(true)
+  end
+end