crowdin-api 1.5.0 → 1.7.0

data/lib/crowdin-api/api_resources/notifications.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Notifications
+      def send_notification_to_authenticated_user(query = {})
+        %i[message].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/notify",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def send_notification_to_organization_members(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        %i[message].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/notify",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def send_notifications_to_project_members(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        %i[message].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/notify",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api_resources/storages.rb

@@ -22,7 +22,7 @@ module Crowdin
       def add_storage(file = nil)
         file || raise_parameter_is_required_error(:file)
 
-        file    = file.is_a?(File) ? file : File.open(file, 'r')
+        file ||= File.open(file, 'r')
         headers = { 'Content-Type' => 'application/octet-stream', 'Crowdin-API-FileName' => File.basename(file) }
 
         request = Web::Request.new(

data/lib/crowdin-api/api_resources/string_translations.rb

@@ -188,6 +188,22 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      def add_translation_alignment(project_id = nil, query = {})
+        project_id || raise_project_id_is_required_error
+
+        %i[source_language_id target_language_id text].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/translations/alignment",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

data/lib/crowdin-api/api_resources/translation_memory.rb

@@ -126,6 +126,22 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      def search_tms_concordance(project_id = nil, query = {})
+        project_id || raise_project_id_is_required_error
+
+        %i[source_language_id target_language_id expression auto_substitution min_relevant].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/tms/concordance",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

data/lib/crowdin-api/client/version.rb

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.5.0'
+    VERSION = '1.7.0'
   end
 end

data/lib/crowdin-api.rb

@@ -5,7 +5,8 @@ module Crowdin
   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
+                             Dictionaries Distributions Labels TranslationStatus Bundles Notifications
+                             Applications].freeze
 
   # Error Raisers modules
   ERROR_RAISERS_MODULES = %i[ApiErrorsRaiser ClientErrorsRaiser].freeze

data/spec/api_resources/applications_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Applications do
+  let(:application_identifier) { 'identifier' }
+  let(:path) { 'application_path' }
+  describe 'Default endpoints' do
+    describe '#get_application_data' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/applications/#{application_identifier}/api/#{path}")
+        get_application_data = @crowdin.get_application_data(application_identifier, path)
+        expect(get_application_data).to eq(200)
+      end
+    end
+
+    describe '#update_or_restore_application_data' do
+      it 'when request are valid', :default do
+        stub_request(:put, "https://api.crowdin.com/#{target_api_url}/applications/#{application_identifier}/api/#{path}")
+        get_application_data = @crowdin.update_or_restore_application_data({}, application_identifier, path)
+        expect(get_application_data).to eq(200)
+      end
+    end
+
+    describe '#add_application_data' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/applications/#{application_identifier}/api/#{path}")
+        get_application_data = @crowdin.add_application_data({}, application_identifier, path)
+        expect(get_application_data).to eq(200)
+      end
+    end
+
+    describe '#delete_application_data' do
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/applications/#{application_identifier}/api/#{path}")
+        get_application_data = @crowdin.delete_application_data({}, application_identifier, path)
+        expect(get_application_data).to eq(200)
+      end
+    end
+
+    describe '#edit_application_data' do
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/applications/#{application_identifier}/api/#{path}")
+        get_application_data = @crowdin.edit_application_data({}, application_identifier, path)
+        expect(get_application_data).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/bundles_spec.rb

@@ -18,6 +18,37 @@ describe Crowdin::ApiResources::Bundles do
       end
     end
 
+    describe '#export_bundle' do
+      let(:bundle_id) { 1 }
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports")
+        export_bundle = @crowdin.export_bundle(bundle_id, project_id)
+        expect(export_bundle).to eq(200)
+      end
+    end
+
+    describe '#check_bundle_export_status' do
+      let(:bundle_id) { 1 }
+      let(:export_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}/exports/#{export_id}")
+        check_bundle_export_status = @crowdin.check_bundle_export_status(bundle_id, export_id, project_id)
+        expect(check_bundle_export_status).to eq(200)
+      end
+    end
+
+    describe '#download_bundle' do
+      let(:bundle_id) { 1 }
+      let(:export_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}/exports/#{export_id}/download")
+        download_bundle = @crowdin.download_bundle(bundle_id, export_id, project_id)
+        expect(download_bundle).to eq(200)
+      end
+    end
+
     describe '#get_bundle' do
       let(:bundle_id) { 1 }
 

data/spec/api_resources/glossaries_spec.rb

@@ -1,210 +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 '#add_term' do
-      let(:glossary_id) { 1 }
+  describe '#search_glossaries_concordance' do
+    let(:project_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
+    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
 
-    describe '#clear_glossary' do
-      let(:glossary_id) { 1 }
+    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
 
-      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
+describe Crowdin::ApiResources::Glossaries, 'Concept endpoints' do
+  describe '#list_concepts' 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}/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 '#edit_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(: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(: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 '#list_concepts' do
-      let(:glossary_id) { 1 }
+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}/concepts")
-        concepts = @crowdin.list_concepts(glossary_id)
-        expect(concepts).to eq(200)
-      end
+    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 '#get_concept' do
-      let(:glossary_id) { 1 }
-      let(:concept_id) { 1 }
+  describe '#add_term' 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}/concepts/#{concept_id}")
-        concept = @crowdin.get_concept(glossary_id, concept_id)
-        expect(concept).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
+  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 '#update_concept' do
-      let(:glossary_id) { 1 }
-      let(:concept_id) { 1 }
+  describe '#delete_term' do
+    let(:glossary_id) { 1 }
+    let(:term_id) { 1 }
 
-      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
+    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 '#update_concept' do
-      let(:glossary_id) { 1 }
-      let(:concept_id) { 1 }
+  describe '#edit_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}/concepts/#{concept_id}")
-        concept = @crowdin.delete_concept(glossary_id, concept_id)
-        expect(concept).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