crowdin-api 1.2.0 → 1.4.0

data/lib/crowdin-api.rb

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 
+module Crowdin
+  # API Resources modules
+  API_RESOURCES_MODULES = %i[Storages Languages Projects Workflows SourceFiles Translations SourceStrings
+                             StringTranslations StringComments Screenshots Glossaries TranslationMemory
+                             MachineTranslationEngines Reports Tasks Users Teams Vendors Webhooks
+                             Dictionaries Distributions Labels TranslationStatus Bundles].freeze
+
+  # Error Raisers modules
+  ERROR_RAISERS_MODULES = %i[ApiErrorsRaiser ClientErrorsRaiser].freeze
+end
+
 # Libs
 require 'json'
 require 'open-uri'
@@ -9,32 +20,15 @@ require 'rest-client'
 require 'crowdin-api/core/errors'
 require 'crowdin-api/core/errors_raisers'
 require 'crowdin-api/core/request'
-require 'crowdin-api/core/utils'
+require 'crowdin-api/core/send_request'
+require 'crowdin-api/core/fetch_all_extensions'
 
 # API modules
-require 'crowdin-api/api-resources/storages'
-require 'crowdin-api/api-resources/languages'
-require 'crowdin-api/api-resources/projects'
-require 'crowdin-api/api-resources/workflows'
-require 'crowdin-api/api-resources/source_files'
-require 'crowdin-api/api-resources/translations'
-require 'crowdin-api/api-resources/source_strings'
-require 'crowdin-api/api-resources/string_translations'
-require 'crowdin-api/api-resources/string_comments'
-require 'crowdin-api/api-resources/screenshots'
-require 'crowdin-api/api-resources/glossaries'
-require 'crowdin-api/api-resources/translation_memory'
-require 'crowdin-api/api-resources/machine_translation_engines'
-require 'crowdin-api/api-resources/reports'
-require 'crowdin-api/api-resources/tasks'
-require 'crowdin-api/api-resources/users'
-require 'crowdin-api/api-resources/teams'
-require 'crowdin-api/api-resources/vendors'
-require 'crowdin-api/api-resources/webhooks'
-require 'crowdin-api/api-resources/dictionaries'
-require 'crowdin-api/api-resources/distributions'
-require 'crowdin-api/api-resources/labels'
-require 'crowdin-api/api-resources/translation_status'
+Crowdin::API_RESOURCES_MODULES.each do |api_resource|
+  require "crowdin-api/api_resources/#{api_resource.to_s.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase}"
+rescue LoadError
+  # Ignored
+end
 
 # Client modules
 require 'crowdin-api/client/version'

data/spec/api_resources/bundles_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Bundles do
+  describe 'Default endpoints' do
+    describe '#list_bundles' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles")
+        list_bundles = @crowdin.list_bundles({}, project_id)
+        expect(list_bundles).to eq(200)
+      end
+    end
+
+    describe '#add_bundle' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles")
+        add_bundle = @crowdin.add_bundle({}, project_id)
+        expect(add_bundle).to eq(200)
+      end
+    end
+
+    describe '#get_bundle' do
+      let(:bundle_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}")
+        get_bundle = @crowdin.get_bundle(bundle_id, project_id)
+        expect(get_bundle).to eq(200)
+      end
+    end
+
+    describe '#delete_bundle' do
+      let(:bundle_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}")
+        delete_bundle = @crowdin.delete_bundle(bundle_id, project_id)
+        expect(delete_bundle).to eq(200)
+      end
+    end
+
+    describe '#edit_bundle' do
+      let(:bundle_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}")
+        edit_bundle = @crowdin.edit_bundle(bundle_id, {}, project_id)
+        expect(edit_bundle).to eq(200)
+      end
+    end
+
+    describe '#bundle_list_files' do
+      let(:bundle_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/files")
+        bundle_list_files = @crowdin.bundle_list_files(bundle_id, {}, project_id)
+        expect(bundle_list_files).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/dictionaries_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Dictionaries do
+  describe 'Default endpoints' do
+    describe '#list_dictionaries' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/dictionaries")
+        list_dictionaries = @crowdin.list_dictionaries({}, project_id)
+        expect(list_dictionaries).to eq(200)
+      end
+    end
+
+    describe '#edit_dictionary' do
+      let(:language_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/dictionaries/#{language_id}")
+        edit_dictionary = @crowdin.edit_dictionary(language_id, {}, project_id)
+        expect(edit_dictionary).to eq(200)
+      end
+    end
+  end
+end

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