crowdin-api 1.5.0 → 1.7.0

data/spec/api_resources/notifications_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Notifications do
+  describe 'Default endpoints' do
+    describe '#send_notification_to_authenticated_user' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/notify")
+          .with(body: { 'message' => 'New notification message' })
+        query = { message: 'New notification message' }
+        response = @crowdin.send_notification_to_authenticated_user(query)
+        expect(response).to eq(200)
+      end
+
+      it 'raises ArgumentError when request is missing required query parameter', :default do
+        expect do
+          @crowdin.send_notification_to_authenticated_user({})
+        end.to raise_error(ArgumentError, ':message is required')
+      end
+    end
+
+    describe '#send_notifications_to_project_members' do
+      let(:project_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/notify")
+          .with(body: { 'message' => 'New notification message' })
+        query = { message: 'New notification message' }
+        response = @crowdin.send_notifications_to_project_members(query, project_id)
+        expect(response).to eq(200)
+      end
+
+      it 'raises ArgumentError when request is missing required query parameter', :default do
+        expect do
+          @crowdin.send_notifications_to_project_members({}, project_id)
+        end.to raise_error(ArgumentError, ':message is required')
+      end
+
+      it 'raises ArgumentError when request is missing project_id parameter', :default do
+        query =  { message: 'New notification message' }
+        expect do
+          @crowdin.send_notifications_to_project_members(query, nil)
+        end.to raise_error(ArgumentError, ':project_id is required in parameters or while Client initialization')
+      end
+    end
+  end
+
+  describe 'Enterprise endpoints' do
+    describe '#send_notification_to_organization_members' do
+      it 'when request are valid', :enterprise do
+        stub_request(:post, "https://domain.api.crowdin.com/#{target_api_url}/notify")
+          .with(body: { 'message' => 'New notification message' })
+        query = { message: 'New notification message' }
+        response = @crowdin.send_notification_to_organization_members(query)
+        expect(response).to eq(200)
+      end
+
+      it 'raises ArgumentError when request is missing required query parameter', :enterprise do
+        expect do
+          @crowdin.send_notification_to_organization_members({})
+        end.to raise_error(ArgumentError, ':message is required')
+      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

@@ -88,4 +88,10 @@ describe 'Crowdin Client' 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.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -39,7 +39,7 @@ dependencies:
         version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -169,22 +169,29 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/build-and-publish.yml"
+- ".github/workflows/dependency-analysis.yml"
 - ".github/workflows/docs.yml"
+- ".github/workflows/lint-pr-title.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test-and-lint.yml"
 - ".gitignore"
+- ".release-it.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/crowdin-console
 - crowdin-api.gemspec
 - lib/crowdin-api.rb
+- lib/crowdin-api/api_resources/applications.rb
 - lib/crowdin-api/api_resources/bundles.rb
 - lib/crowdin-api/api_resources/dictionaries.rb
 - lib/crowdin-api/api_resources/distributions.rb
@@ -192,6 +199,7 @@ files:
 - lib/crowdin-api/api_resources/labels.rb
 - lib/crowdin-api/api_resources/languages.rb
 - lib/crowdin-api/api_resources/machine_translation_engines.rb
+- lib/crowdin-api/api_resources/notifications.rb
 - lib/crowdin-api/api_resources/projects.rb
 - lib/crowdin-api/api_resources/reports.rb
 - lib/crowdin-api/api_resources/screenshots.rb
@@ -217,6 +225,7 @@ files:
 - lib/crowdin-api/core/fetch_all_extensions.rb
 - lib/crowdin-api/core/request.rb
 - lib/crowdin-api/core/send_request.rb
+- spec/api_resources/applications_spec.rb
 - spec/api_resources/bundles_spec.rb
 - spec/api_resources/dictionaries_spec.rb
 - spec/api_resources/distributions_spec.rb
@@ -224,6 +233,7 @@ files:
 - spec/api_resources/labels_spec.rb
 - spec/api_resources/languages_spec.rb
 - spec/api_resources/machine_translation_engines_spec.rb
+- spec/api_resources/notifications_spec.rb
 - spec/api_resources/projects_spec.rb
 - spec/api_resources/reports_spec.rb
 - spec/api_resources/screenshots_spec.rb
@@ -262,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Ruby Client for the Crowdin API