crowdin-api 1.4.0 → 1.6.0

data/spec/api_resources/glossaries_spec.rb

@@ -1,167 +1,231 @@
 # 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
+describe Crowdin::ApiResources::Glossaries, '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
+  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 }
+  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
+    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 }
+  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
+    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 }
+  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
+    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 }
+  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
+    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 }
+  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
+    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 }
+  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
+    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 }
+  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
+    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 }
+  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
+    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 }
+  describe '#clear_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}/terms")
-        list_terms = @crowdin.list_terms(glossary_id)
-        expect(list_terms).to eq(200)
-      end
+    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 '#search_glossaries_concordance' do
+    let(:project_id) { 1 }
 
-    describe '#add_term' do
-      let(:glossary_id) { 1 }
+    it 'returns 200 when request is valid', :default do
+      query = { source_language_id: 'en', target_language_id: 'ar', expression: 'Hello world!' }
+      stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/glossaries/concordance")
+      search_glossaries_concordance = @crowdin.search_glossaries_concordance(project_id, query)
+      expect(search_glossaries_concordance).to eq(200)
+    end
 
-      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
+    it 'raises ArgumentError when request is missing required query parameter', :default do
+      query = { source_language_id: 'en', target_language_id: 'ar' }
+      stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/glossaries/concordance")
+      expect do
+        @crowdin.search_glossaries_concordance(project_id, query)
+      end.to raise_error(ArgumentError, ':expression is required')
     end
+  end
+end
 
-    describe '#clear_glossary' do
-      let(:glossary_id) { 1 }
+describe Crowdin::ApiResources::Glossaries, 'Concept endpoints' do
+  describe '#list_concepts' 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
+    it 'when request are valid', :default do
+      stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts")
+      concepts = @crowdin.list_concepts(glossary_id)
+      expect(concepts).to eq(200)
     end
+  end
 
-    describe '#get_term' do
-      let(:glossary_id) { 1 }
-      let(:term_id) { 1 }
+  describe '#get_concept' do
+    let(:glossary_id) { 1 }
+    let(:concept_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
+    it 'when request are valid', :default do
+      stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}")
+      concept = @crowdin.get_concept(glossary_id, concept_id)
+      expect(concept).to eq(200)
     end
+  end
 
-    describe '#delete_term' do
-      let(:glossary_id) { 1 }
-      let(:term_id) { 1 }
+  describe '#update_concept' do
+    let(:glossary_id) { 1 }
+    let(:concept_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
+    it 'when request are valid', :default do
+      stub_request(:put, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}")
+      concept = @crowdin.update_concept(glossary_id, concept_id)
+      expect(concept).to eq(200)
     end
+  end
+
+  describe '#update_concept' do
+    let(:glossary_id) { 1 }
+    let(:concept_id) { 1 }
+
+    it 'when request are valid', :default do
+      stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}")
+      concept = @crowdin.delete_concept(glossary_id, concept_id)
+      expect(concept).to eq(200)
+    end
+  end
+end
+
+describe Crowdin::ApiResources::Glossaries, 'Term endpoints' do
+  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 '#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 }
+  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
+    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

data/spec/api_resources/reports_spec.rb

@@ -92,4 +92,54 @@ describe Crowdin::ApiResources::Reports do
       end
     end
   end
+
+  describe 'Setting Templates endpoints' do
+    describe 'List Report Settings templates' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates")
+        settings_templates = @crowdin.list_report_settings_templates({}, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Add Report Settings template' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates")
+        settings_templates = @crowdin.add_report_settings_template(
+          { name: '', currency: '', unit: '', mode: '', config: '' }, project_id
+        )
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Get Report Settings template' do
+      let(:template_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}")
+        settings_templates = @crowdin.get_report_settings_template(template_id, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Get Report Settings template' do
+      let(:template_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}")
+        settings_templates = @crowdin.edit_report_settings_template({}, template_id, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Get Report Settings template' do
+      let(:template_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}")
+        settings_templates = @crowdin.delete_report_settings_template(template_id, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+  end
 end

data/spec/api_resources/string_translations_spec.rb

@@ -137,5 +137,24 @@ describe Crowdin::ApiResources::StringTranslations do
         expect(cancel_vote).to eq(200)
       end
     end
+
+    describe '#add_translation_alignment' do
+      let(:project_id) { 1 }
+
+      it 'returns 200 when request is valid', :default do
+        query = { source_language_id: 'en', target_language_id: 'ar', text: 'Hello world!' }
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/alignment")
+        add_translation_alignment = @crowdin.add_translation_alignment(project_id, query)
+        expect(add_translation_alignment).to eq(200)
+      end
+
+      it 'raises ArgumentError when request is missing required query parameter', :default do
+        query = { source_language_id: 'en', target_language_id: 'ar' }
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/translations/alignment")
+        expect do
+          @crowdin.add_translation_alignment(project_id, query)
+        end.to raise_error(ArgumentError, ':text is required')
+      end
+    end
   end
 end

data/spec/api_resources/translation_memory_spec.rb

@@ -110,5 +110,26 @@ describe Crowdin::ApiResources::TranslationMemory do
         expect(check_tm_import_status).to eq(200)
       end
     end
+
+    describe '#search_tms_concordance' do
+      let(:project_id) { 1 }
+
+      it 'returns 200 when request is valid', :default do
+        query = { source_language_id: 'en', target_language_id: 'ar', expression: 'Hello world!',
+                  auto_substitution: true, min_relevant: 60 }
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tms/concordance")
+        search_tms_concordance = @crowdin.search_tms_concordance(project_id, query)
+        expect(search_tms_concordance).to eq(200)
+      end
+
+      it 'raises ArgumentError when request is missing required query parameter', :default do
+        query = { source_language_id: 'en', target_language_id: 'ar', expression: 'Hello world!',
+                  auto_substitution: true }
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tms/concordance")
+        expect do
+          @crowdin.search_tms_concordance(project_id, query)
+        end.to raise_error(ArgumentError, ':min_relevant is required')
+      end
+    end
   end
 end

data/spec/unit/client_spec.rb

@@ -82,4 +82,16 @@ describe 'Crowdin Client' do
       expect(@crowdin.config.base_url).to eq("https://#{full_organization_domain}")
     end
   end
+
+  describe 'Crowdin Client fetch_all' do
+    it 'should raise error if fetch_all is called for unsupported methods' do
+      expect { @crowdin.fetch_all(:add_bundle).to raise_error(Crowdin::Errors::FetchAllProcessingError) }
+    end
+  end
+
+  describe 'Crowdin Client fetch_all' do
+    it 'should raise error if fetch_all is called for unsupported methods' do
+      expect { @crowdin.fetch_all(:export_bundle).to raise_error(Crowdin::Errors::FetchAllProcessingError) }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -170,6 +170,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build-and-publish.yml"
+- ".github/workflows/docs.yml"
+- ".github/workflows/lint-pr-title.yml"
 - ".github/workflows/test-and-lint.yml"
 - ".gitignore"
 - ".rspec"