crowdin-api 1.2.1 → 1.3.0

data/spec/api_resources/distributions_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Distributions do
+  describe 'Default endpoints' do
+    describe '#list_distributions' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/distributions")
+        list_distributions = @crowdin.list_distributions({}, project_id)
+        expect(list_distributions).to eq(200)
+      end
+    end
+
+    describe '#add_distribution' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/distributions")
+        add_distribution = @crowdin.add_distribution({}, project_id)
+        expect(add_distribution).to eq(200)
+      end
+    end
+
+    describe '#get_distribution' do
+      let(:hash) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/distributions/#{hash}")
+        get_distribution = @crowdin.get_distribution(hash, project_id)
+        expect(get_distribution).to eq(200)
+      end
+    end
+
+    describe '#delete_distribution' do
+      let(:hash) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/distributions/#{hash}")
+        delete_distribution = @crowdin.delete_distribution(hash, project_id)
+        expect(delete_distribution).to eq(200)
+      end
+    end
+
+    describe '#edit_distribution' do
+      let(:hash) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/distributions/#{hash}")
+        edit_distribution = @crowdin.edit_distribution(hash, {}, project_id)
+        expect(edit_distribution).to eq(200)
+      end
+    end
+
+    describe '#get_distribution_release' do
+      let(:hash) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/distributions/#{hash}/release")
+        get_distribution_release = @crowdin.get_distribution_release(hash, project_id)
+        expect(get_distribution_release).to eq(200)
+      end
+    end
+
+    describe '#release_distribution' do
+      let(:hash) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/distributions/#{hash}/release")
+        release_distribution = @crowdin.release_distribution(hash, project_id)
+        expect(release_distribution).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/glossaries_spec.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Glossaries do
+  describe 'Default endpoints' do
+    describe '#list_glossaries' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries")
+        list_glossaries = @crowdin.list_glossaries
+        expect(list_glossaries).to eq(200)
+      end
+    end
+
+    describe '#add_glossary' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/glossaries")
+        add_glossary = @crowdin.add_glossary
+        expect(add_glossary).to eq(200)
+      end
+    end
+
+    describe '#get_glossary' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}")
+        get_glossary = @crowdin.get_glossary(glossary_id)
+        expect(get_glossary).to eq(200)
+      end
+    end
+
+    describe '#delete_glossary' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}")
+        delete_glossary = @crowdin.delete_glossary(glossary_id)
+        expect(delete_glossary).to eq(200)
+      end
+    end
+
+    describe '#edit_glossary' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}")
+        edit_glossary = @crowdin.edit_glossary(glossary_id)
+        expect(edit_glossary).to eq(200)
+      end
+    end
+
+    describe '#export_glossary' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/exports")
+        export_glossary = @crowdin.export_glossary({}, glossary_id)
+        expect(export_glossary).to eq(200)
+      end
+    end
+
+    describe '#check_glossary_export_status' do
+      let(:glossary_id) { 1 }
+      let(:export_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/exports/#{export_id}")
+        check_glossary_export_status = @crowdin.check_glossary_export_status(glossary_id, export_id)
+        expect(check_glossary_export_status).to eq(200)
+      end
+    end
+
+    describe '#download_glossary' do
+      let(:glossary_id) { 1 }
+      let(:export_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/exports/#{export_id}/download")
+        download_glossary = @crowdin.download_glossary(glossary_id, export_id)
+        expect(download_glossary).to eq(200)
+      end
+    end
+
+    describe '#import_glossary' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/imports")
+        import_glossary = @crowdin.import_glossary(glossary_id)
+        expect(import_glossary).to eq(200)
+      end
+    end
+
+    describe '#check_glossary_import_status' do
+      let(:glossary_id) { 1 }
+      let(:import_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/imports/#{import_id}")
+        check_glossary_import_status = @crowdin.check_glossary_import_status(glossary_id, import_id)
+        expect(check_glossary_import_status).to eq(200)
+      end
+    end
+
+    describe '#list_terms' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/terms")
+        list_terms = @crowdin.list_terms(glossary_id)
+        expect(list_terms).to eq(200)
+      end
+    end
+
+    describe '#add_term' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/terms")
+        add_term = @crowdin.add_term(glossary_id)
+        expect(add_term).to eq(200)
+      end
+    end
+
+    describe '#clear_glossary' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/terms")
+        clear_glossary = @crowdin.clear_glossary(glossary_id)
+        expect(clear_glossary).to eq(200)
+      end
+    end
+
+    describe '#get_term' do
+      let(:glossary_id) { 1 }
+      let(:term_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}")
+        get_term = @crowdin.get_term(glossary_id, term_id)
+        expect(get_term).to eq(200)
+      end
+    end
+
+    describe '#delete_term' do
+      let(:glossary_id) { 1 }
+      let(:term_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}")
+        delete_term = @crowdin.delete_term(glossary_id, term_id)
+        expect(delete_term).to eq(200)
+      end
+    end
+
+    describe '#edit_term' do
+      let(:glossary_id) { 1 }
+      let(:term_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}")
+        edit_term = @crowdin.edit_term(glossary_id, term_id)
+        expect(edit_term).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/labels_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Labels do
+  describe 'Default endpoints' do
+    describe '#list_labels' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels")
+        list_labels = @crowdin.list_labels({}, project_id)
+        expect(list_labels).to eq(200)
+      end
+    end
+
+    describe '#add_label' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels")
+        add_label = @crowdin.add_label({}, project_id)
+        expect(add_label).to eq(200)
+      end
+    end
+
+    describe '#get_label' do
+      let(:label_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
+        get_label = @crowdin.get_label(label_id, project_id)
+        expect(get_label).to eq(200)
+      end
+    end
+
+    describe '#delete_label' do
+      let(:label_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
+        delete_label = @crowdin.delete_label(label_id, project_id)
+        expect(delete_label).to eq(200)
+      end
+    end
+
+    describe '#edit_label' do
+      let(:label_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
+        edit_label = @crowdin.edit_label(label_id, {}, project_id)
+        expect(edit_label).to eq(200)
+      end
+    end
+
+    describe '#assign_label_to_strings' do
+      let(:label_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}/strings")
+        assign_label_to_strings = @crowdin.assign_label_to_strings(label_id, {}, project_id)
+        expect(assign_label_to_strings).to eq(200)
+      end
+    end
+
+    describe '#unassign_label_from_strings' do
+      let(:label_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/labels/#{label_id}")
+        unassign_label_from_strings = @crowdin.unassign_label_from_strings(label_id, {}, project_id)
+        expect(unassign_label_from_strings).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/languages_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Languages do
+  describe 'Default endpoints' do
+    describe '#list_languages' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/languages")
+        list_languages = @crowdin.list_languages
+        expect(list_languages).to eq(200)
+      end
+    end
+
+    describe '#add_custom_language' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/languages")
+        add_custom_language = @crowdin.add_custom_language
+        expect(add_custom_language).to eq(200)
+      end
+    end
+
+    describe '#get_language' do
+      let(:language_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/languages/#{language_id}")
+        get_language = @crowdin.get_language(language_id)
+        expect(get_language).to eq(200)
+      end
+    end
+
+    describe '#delete_custom_language' do
+      let(:language_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/languages/#{language_id}")
+        delete_custom_language = @crowdin.delete_custom_language(language_id)
+        expect(delete_custom_language).to eq(200)
+      end
+    end
+
+    describe '#edit_custom_language' do
+      let(:language_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/languages/#{language_id}")
+        edit_custom_language = @crowdin.edit_custom_language(language_id)
+        expect(edit_custom_language).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/machine_translation_engines_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::MachineTranslationEngines do
+  describe 'Default endpoints' do
+    describe '#list_mts' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/mts")
+        list_mts = @crowdin.list_mts
+        expect(list_mts).to eq(200)
+      end
+    end
+
+    describe '#get_mt' do
+      let(:mt_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/mts/#{mt_id}")
+        get_mt = @crowdin.get_mt(mt_id)
+        expect(get_mt).to eq(200)
+      end
+    end
+
+    describe '#translate_via_mt' do
+      let(:mt_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/mts/#{mt_id}/translations")
+        translate_via_mt = @crowdin.translate_via_mt(mt_id)
+        expect(translate_via_mt).to eq(200)
+      end
+    end
+  end
+
+  describe 'Enterprise endpoints' do
+    describe '#edit_mt' do
+      let(:mt_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:patch, "https://domain.api.crowdin.com/#{target_api_url}/mts/#{mt_id}")
+        edit_mt = @crowdin.edit_mt(mt_id)
+        expect(edit_mt).to eq(200)
+      end
+    end
+
+    describe '#add_mt' do
+      it 'when request are valid', :enterprise do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/mts")
+        add_mt = @crowdin.add_mt
+        expect(add_mt).to eq(200)
+      end
+    end
+
+    describe '#delete_mt' do
+      let(:mt_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:delete, "https://domain.api.crowdin.com/#{target_api_url}/mts/#{mt_id}")
+        delete_mt = @crowdin.delete_mt(mt_id)
+        expect(delete_mt).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/projects_spec.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Projects do
+  describe 'Default endpoints' do
+    describe '#list_projects' do
+      let(:limit) { 1 }
+      let(:offset) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects")
+        list_projects = @crowdin.list_projects
+        expect(list_projects).to eq(200)
+      end
+
+      it 'when request are valid and includes query parameters', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects")
+          .with(query: { limit: limit, offset: offset })
+        list_projects = @crowdin.list_projects({ limit: limit, offset: offset })
+        expect(list_projects).to eq(200)
+      end
+    end
+
+    describe '#add_project' do
+      let(:project_name) { 'test_project' }
+      let(:source_language_id) { 'en' }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects")
+          .with(body: { name: project_name, sourceLanguageId: source_language_id })
+        add_project = @crowdin.add_project(name: project_name, sourceLanguageId: source_language_id)
+        expect(add_project).to eq(200)
+      end
+
+      let(:body) do
+        { "data" => { "id" => 1, "name" => "test_project" } }
+      end
+
+      it 'when request are valid and returns body', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects")
+          .with(body: { name: project_name, sourceLanguageId: source_language_id })
+          .to_return(body: body.to_json)
+        add_project = @crowdin.add_project(name: project_name, sourceLanguageId: source_language_id)
+        expect(add_project).to eq(body)
+      end
+    end
+
+    describe '#get_project' do
+      before do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}")
+      end
+
+      let(:project_id) { 1 }
+
+      it 'when request are valid', :default do
+        get_project = @crowdin.get_project(project_id)
+        expect(get_project).to eq(200)
+      end
+
+      it 'when request are invalid', :default do
+        expect { @crowdin.get_project }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#delete_project' do
+      before do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}")
+      end
+
+      let(:project_id) { 1 }
+
+      it 'when request are valid', :default do
+        delete_project = @crowdin.delete_project(project_id)
+        expect(delete_project).to eq(200)
+      end
+
+      it 'when request are invalid', :default do
+        expect { @crowdin.delete_project }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#edit_project' do
+      let(:project_id) { 1 }
+      let(:body) { [{ op: 'replace', path: '/name', value: 'project_name' }] }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}")
+          .with(body: body.to_json)
+        edit_project = @crowdin.edit_project(project_id, body)
+        expect(edit_project).to eq(200)
+      end
+
+      it 'when request are invalid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}")
+        expect { @crowdin.edit_project }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe 'Enterprise endpoints' do
+    describe '#list_groups' do
+      let(:limit) { 1 }
+      let(:offset) { 1 }
+
+      it 'when Enterprise mode is not enabled', :default do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/groups")
+        expect { @crowdin.list_groups }.to raise_error(Crowdin::Errors::OnlyForEnterpriseModeError)
+      end
+
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/groups")
+        list_groups = @crowdin.list_groups
+        expect(list_groups).to eq(200)
+      end
+
+      it 'when request are valid and includes query parameters', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/groups")
+          .with(query: { limit: limit, offset: offset })
+        list_groups = @crowdin.list_groups({ limit: limit, offset: offset })
+        expect(list_groups).to eq(200)
+      end
+    end
+
+    describe '#add_group' do
+      let(:group_name) { 'test_group' }
+
+      it 'when Enterprise mode is not enabled', :default do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/groups")
+        expect { @crowdin.add_group(name: group_name) }.to raise_error(Crowdin::Errors::OnlyForEnterpriseModeError)
+      end
+
+      it 'when request are valid', :enterprise do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/groups")
+          .with(body: { name: group_name })
+        add_group = @crowdin.add_group(name: group_name)
+        expect(add_group).to eq(200)
+      end
+
+      let(:body) do
+        { "data"=> { "id"=>1, "name"=>"test_group" } }
+      end
+
+      it 'when request are valid and returns body', :enterprise do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/groups")
+          .with(body: { name: group_name })
+          .to_return(body: body.to_json)
+        add_group = @crowdin.add_group(name: group_name)
+        expect(add_group).to eq(body)
+      end
+    end
+
+    describe '#get_group' do
+      before do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/groups/#{group_id}")
+      end
+
+      let(:group_id) { 1 }
+
+      it 'when Enterprise mode is not enabled', :default do
+        expect { @crowdin.get_group(group_id) }.to raise_error(Crowdin::Errors::OnlyForEnterpriseModeError)
+      end
+
+      it 'when request are valid', :enterprise do
+        get_group = @crowdin.get_group(group_id)
+        expect(get_group).to eq(200)
+      end
+
+      it 'when request are invalid', :enterprise do
+        expect { @crowdin.get_group }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#delete_group' do
+      before do
+        stub_request(:delete, "https://domain.api.crowdin.com/#{target_api_url}/groups/#{group_id}")
+      end
+
+      let(:group_id) { 1 }
+
+      it 'when Enterprise mode is not enabled', :default do
+        expect { @crowdin.delete_group(group_id) }.to raise_error(Crowdin::Errors::OnlyForEnterpriseModeError)
+      end
+
+      it 'when request are valid', :enterprise do
+        delete_group = @crowdin.delete_group(group_id)
+        expect(delete_group).to eq(200)
+      end
+
+      it 'when request are invalid', :enterprise do
+        expect { @crowdin.delete_group }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe '#edit_group' do
+      let(:group_id) { 1 }
+      let(:body) { [{ op: 'replace', path: '/name', value: 'group_name' }] }
+
+      it 'when Enterprise mode is not enabled', :default do
+        stub_request(:patch, "https://domain.api.crowdin.com/#{target_api_url}/groups/#{group_id}")
+        expect { @crowdin.edit_group(group_id, body) }.to raise_error(Crowdin::Errors::OnlyForEnterpriseModeError)
+      end
+
+      it 'when request are valid', :enterprise do
+        stub_request(:patch, "https://domain.api.crowdin.com/#{target_api_url}/groups/#{group_id}")
+          .with(body: body.to_json)
+        edit_group = @crowdin.edit_group(group_id, body)
+        expect(edit_group).to eq(200)
+      end
+
+      it 'when request are invalid', :enterprise do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/groups/#{group_id}")
+        expect { @crowdin.edit_group }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end