crowdin-api 1.2.1 → 1.3.0

data/spec/api_resources/reports_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Reports do
+  describe 'Default endpoints' do
+    describe '#generate_report' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports")
+        generate_report = @crowdin.generate_report({}, project_id)
+        expect(generate_report).to eq(200)
+      end
+    end
+
+    describe '#check_report_generation_status' do
+      let(:report_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/#{report_id}")
+        check_report_generation_status = @crowdin.check_report_generation_status(report_id, project_id)
+        expect(check_report_generation_status).to eq(200)
+      end
+    end
+
+    describe '#download_report' do
+      let(:report_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/#{report_id}/download")
+        download_report = @crowdin.download_report(report_id, nil, project_id)
+        expect(download_report).to eq(200)
+      end
+    end
+  end
+
+  describe 'Enterprise endpoints' do
+    describe '#generate_group_report' do
+      let(:group_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/groups/#{group_id}/reports")
+        generate_group_report = @crowdin.generate_group_report(group_id, project_id)
+        expect(generate_group_report).to eq(200)
+      end
+    end
+
+    describe '#check_group_report_generation_status' do
+      let(:group_id) { 1 }
+      let(:report_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/groups/#{group_id}/reports/#{report_id}")
+        check_group_report_generation_status = @crowdin.check_group_report_generation_status(group_id, report_id)
+        expect(check_group_report_generation_status).to eq(200)
+      end
+    end
+
+    describe '#download_group_report' do
+      let(:group_id) { 1 }
+      let(:report_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/groups/#{group_id}/reports/#{report_id}/download")
+        download_group_report = @crowdin.download_group_report(group_id, project_id)
+        expect(download_group_report).to eq(200)
+      end
+    end
+
+    describe '#generate_organization_report' do
+      it 'when request are valid', :enterprise do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/reports")
+        generate_organization_report = @crowdin.generate_organization_report
+        expect(generate_organization_report).to eq(200)
+      end
+    end
+
+    describe '#check_organization_report_generation_status' do
+      let(:report_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/reports/#{report_id}")
+        check_organization_report_generation_status = @crowdin.check_organization_report_generation_status(report_id)
+        expect(check_organization_report_generation_status).to eq(200)
+      end
+    end
+
+    describe '#download_organization_report' do
+      let(:report_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/reports/#{report_id}/download")
+        download_organization_report = @crowdin.download_organization_report(report_id)
+        expect(download_organization_report).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/screenshots_spec.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Screenshots do
+  describe 'Default endpoints' do
+    describe '#list_screenshots' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots")
+        list_screenshots = @crowdin.list_screenshots({}, project_id)
+        expect(list_screenshots).to eq(200)
+      end
+    end
+
+    describe '#add_screenshot' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots")
+        add_screenshot = @crowdin.add_screenshot({}, project_id)
+        expect(add_screenshot).to eq(200)
+      end
+    end
+
+    describe '#get_screenshot' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}")
+        get_screenshot = @crowdin.get_screenshot(screenshot_id, project_id)
+        expect(get_screenshot).to eq(200)
+      end
+    end
+
+    describe '#update_screenshot' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:put, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}")
+        update_screenshot = @crowdin.update_screenshot(screenshot_id, {}, project_id)
+        expect(update_screenshot).to eq(200)
+      end
+    end
+
+    describe '#delete_screenshot' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}")
+        delete_screenshot = @crowdin.delete_screenshot(screenshot_id, project_id)
+        expect(delete_screenshot).to eq(200)
+      end
+    end
+
+    describe '#edit_screenshot' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}")
+        edit_screenshot = @crowdin.edit_screenshot(screenshot_id, {}, project_id)
+        expect(edit_screenshot).to eq(200)
+      end
+    end
+
+    describe '#list_tags' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags")
+        list_tags = @crowdin.list_tags(screenshot_id, {}, project_id)
+        expect(list_tags).to eq(200)
+      end
+    end
+
+    describe '#replace_tags' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:put, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags")
+        replace_tags = @crowdin.replace_tags(screenshot_id, {}, project_id)
+        expect(replace_tags).to eq(200)
+      end
+    end
+
+    describe '#add_tag' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags")
+        add_tag = @crowdin.add_tag(screenshot_id, {}, project_id)
+        expect(add_tag).to eq(200)
+      end
+    end
+
+    describe '#clear_tags' do
+      let(:screenshot_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags")
+        clear_tags = @crowdin.clear_tags(screenshot_id, project_id)
+        expect(clear_tags).to eq(200)
+      end
+    end
+
+    describe '#get_tag' do
+      let(:screenshot_id) { 1 }
+      let(:tag_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}")
+        get_tag = @crowdin.get_tag(screenshot_id, tag_id, project_id)
+        expect(get_tag).to eq(200)
+      end
+    end
+
+    describe '#delete_tag' do
+      let(:screenshot_id) { 1 }
+      let(:tag_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}")
+        delete_tag = @crowdin.delete_tag(screenshot_id, tag_id, project_id)
+        expect(delete_tag).to eq(200)
+      end
+    end
+
+    describe '#edit_tag' do
+      let(:screenshot_id) { 1 }
+      let(:tag_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}")
+        edit_tag = @crowdin.edit_tag(screenshot_id, tag_id, {}, project_id)
+        expect(edit_tag).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/source_files_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::SourceFiles do
+  describe 'Default endpoints' do
+    describe '#list_branches' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/branches")
+        list_branches = @crowdin.list_branches({}, project_id)
+        expect(list_branches).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/source_strings_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::SourceStrings do
+  describe 'Default endpoints' do
+    describe '#list_strings' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings")
+        list_strings = @crowdin.list_strings({}, project_id)
+        expect(list_strings).to eq(200)
+      end
+    end
+
+    describe '#add_string' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings")
+        add_string = @crowdin.add_string({}, project_id)
+        expect(add_string).to eq(200)
+      end
+    end
+
+    describe '#get_string' do
+      let(:string_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings/#{string_id}")
+        get_string = @crowdin.get_string(string_id, {}, project_id)
+        expect(get_string).to eq(200)
+      end
+    end
+
+    describe '#delete_string' do
+      let(:string_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings/#{string_id}")
+        delete_string = @crowdin.delete_string(string_id, project_id)
+        expect(delete_string).to eq(200)
+      end
+    end
+
+    describe '#edit_string' do
+      let(:string_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/strings/#{string_id}")
+        edit_string = @crowdin.edit_string(string_id, {}, project_id)
+        expect(edit_string).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/storages_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Storages do
+  describe 'Default endpoints' do
+    describe '#list_storages' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/storages")
+        list_storages = @crowdin.list_storages
+        expect(list_storages).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/string_comments_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::StringComments do
+  describe 'Default endpoints' do
+    describe '#list_string_comments' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/comments")
+        list_string_comments = @crowdin.list_string_comments({}, project_id)
+        expect(list_string_comments).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/string_translations_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::StringTranslations do
+  describe 'Default endpoints' do
+    describe '#list_translation_approvals' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/approvals")
+        list_translation_approvals = @crowdin.list_translation_approvals({}, project_id)
+        expect(list_translation_approvals).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/tasks_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Tasks do
+  describe 'Default endpoints' do
+    describe '#list_tasks' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks")
+        list_tasks = @crowdin.list_tasks({}, project_id)
+        expect(list_tasks).to eq(200)
+      end
+    end
+
+    describe '#add_task' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks")
+        add_task = @crowdin.add_task({}, project_id)
+        expect(add_task).to eq(200)
+      end
+    end
+
+    describe '#export_task_strings' do
+      let(:task_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}/exports")
+        export_task_strings = @crowdin.export_task_strings(task_id, nil, project_id)
+        expect(export_task_strings).to eq(200)
+      end
+    end
+
+    describe '#get_task' do
+      let(:task_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}")
+        get_task = @crowdin.get_task(task_id, project_id)
+        expect(get_task).to eq(200)
+      end
+    end
+
+    describe '#delete_task' do
+      let(:task_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}")
+        delete_task = @crowdin.delete_task(task_id, project_id)
+        expect(delete_task).to eq(200)
+      end
+    end
+
+    describe '#edit_task' do
+      let(:task_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}")
+        edit_task = @crowdin.edit_task(task_id, {}, project_id)
+        expect(edit_task).to eq(200)
+      end
+    end
+
+    describe '#list_user_tasks' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/user/tasks")
+        list_user_tasks = @crowdin.list_user_tasks({})
+        expect(list_user_tasks).to eq(200)
+      end
+    end
+
+    describe '#edit_task_archived_status' do
+      let(:task_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/user/tasks/#{task_id}")
+        edit_task_archived_status = @crowdin.edit_task_archived_status(task_id, {})
+        expect(edit_task_archived_status).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/teams_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Teams do
+  describe 'Enterprise endpoints' do
+    describe '#add_team_to_project' do
+      it 'when request are valid', :enterprise do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/projects/#{project_id}/teams")
+        add_team_to_project = @crowdin.add_team_to_project({}, project_id)
+        expect(add_team_to_project).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/translation_memory_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::TranslationMemory do
+  describe 'Default endpoints' do
+    describe '#list_tms' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/tms")
+        list_tms = @crowdin.list_tms
+        expect(list_tms).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/translation_status_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::TranslationStatus do
+  describe 'Default endpoints' do
+    describe '#get_branch_progress' do
+      let(:branch_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/branches/#{branch_id}/languages/progress")
+        get_branch_progress = @crowdin.get_branch_progress(branch_id, {}, project_id)
+        expect(get_branch_progress).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/translations_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Translations do
+  describe 'Default endpoints' do
+    describe '#pre_translation_status' do
+      let(:pre_translation_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}")
+        pre_translation_status = @crowdin.pre_translation_status(pre_translation_id, project_id)
+        expect(pre_translation_status).to eq(200)
+      end
+    end
+
+    describe '#apply_pre_translation' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/pre-translations")
+        apply_pre_translation = @crowdin.apply_pre_translation({}, project_id)
+        expect(apply_pre_translation).to eq(200)
+      end
+    end
+
+    describe '#build_project_directory_translation' do
+      let(:directory_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds/directories/#{directory_id}")
+        build_project_directory_translation = @crowdin.build_project_directory_translation(directory_id, {}, project_id)
+        expect(build_project_directory_translation).to eq(200)
+      end
+    end
+
+    describe '#build_project_file_translation' do
+      let(:file_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds/files/#{file_id}")
+        build_project_file_translation = @crowdin.build_project_file_translation(file_id, {}, nil, project_id)
+        expect(build_project_file_translation).to eq(200)
+      end
+    end
+
+    describe '#list_project_builds' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds")
+        list_project_builds = @crowdin.list_project_builds({}, project_id)
+        expect(list_project_builds).to eq(200)
+      end
+    end
+
+    describe '#build_project_translation' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds")
+        build_project_translation = @crowdin.build_project_translation({}, project_id)
+        expect(build_project_translation).to eq(200)
+      end
+    end
+
+    describe '#upload_translations' do
+      let(:language_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/#{language_id}")
+        upload_translations = @crowdin.upload_translations(language_id, {}, project_id)
+        expect(upload_translations).to eq(200)
+      end
+    end
+
+    describe '#download_project_translations' do
+      let(:build_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds/#{build_id}/download")
+        download_project_translations = @crowdin.download_project_translations(build_id, nil, project_id)
+        expect(download_project_translations).to eq(200)
+      end
+    end
+
+    describe '#check_project_build_status' do
+      let(:build_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds/#{build_id}")
+        check_project_build_status = @crowdin.check_project_build_status(build_id, project_id)
+        expect(check_project_build_status).to eq(200)
+      end
+    end
+
+    describe '#cancel_build' do
+      let(:build_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/builds/#{build_id}")
+        cancel_build = @crowdin.cancel_build(build_id, project_id)
+        expect(cancel_build).to eq(200)
+      end
+    end
+
+    describe '#export_project_translation' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/exports")
+        export_project_translation = @crowdin.export_project_translation({}, nil, project_id)
+        expect(export_project_translation).to eq(200)
+      end
+    end
+  end
+end