crowdin-api 1.1.1 → 1.3.0

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

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Glossaries
+      def list_glossaries(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_glossary(query = {})
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/glossaries",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_glossary(glossary_id = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/glossaries/#{glossary_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/glossaries/#{glossary_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def export_glossary(query = {}, glossary_id = nil, destination = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/exports",
+          { params: query }
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      def check_glossary_export_status(glossary_id = nil, export_id = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        export_id   || raise_parameter_is_required_error(:export_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/exports/#{export_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_glossary(glossary_id = nil, export_id = nil, destination = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        export_id   || raise_parameter_is_required_error(:export_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/exports/#{export_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      def import_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/imports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_glossary_import_status(glossary_id = nil, import_id = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        import_id   || raise_parameter_is_required_error(:import_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/imports/#{import_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_terms(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/terms",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_term(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/terms",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def clear_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        response = ::RestClient::Request.execute(
+          {
+            method: :delete,
+            url: config.base_url + config.target_api_url + "/glossaries/#{glossary_id}/terms",
+            payload: query.to_json
+          }.merge(@options)
+        )
+
+        response.body.empty? ? response.code : JSON.parse(response.body)
+      rescue StandardError => e
+        e.message
+      end
+
+      def get_term(glossary_id = nil, term_id = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        term_id     || raise_parameter_is_required_error(:term_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_term(glossary_id = nil, term_id = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        term_id     || raise_parameter_is_required_error(:term_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_term(glossary_id = nil, term_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        term_id     || raise_parameter_is_required_error(:term_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Labels
+      def list_labels(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/labels",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_label(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/labels",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_label(label_id = nil, project_id = config.project_id)
+        label_id   || raise_parameter_is_required_error(:label_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/labels/#{label_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_label(label_id = nil, project_id = config.project_id)
+        label_id   || raise_parameter_is_required_error(:label_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/labels/#{label_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_label(label_id = nil, query = {}, project_id = config.project_id)
+        label_id   || raise_parameter_is_required_error(:label_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/labels/#{label_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def assign_label_to_strings(label_id = nil, query = {}, project_id = config.project_id)
+        label_id   || raise_parameter_is_required_error(:label_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/labels/#{label_id}/strings",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def unassign_label_from_strings(label_id = nil, query = {}, project_id = config.project_id)
+        label_id   || raise_parameter_is_required_error(:label_id)
+        project_id || raise_project_id_is_required_error
+
+        response = ::RestClient::Request.execute(
+          {
+            method: :delete,
+            url: config.base_url + config.target_api_url + "/projects/#{project_id}/labels/#{label_id}",
+            payload: query.to_json
+          }.merge(@options)
+        )
+
+        response.body.empty? ? response.code : JSON.parse(response.body)
+      rescue StandardError => e
+        e.message
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Languages
+      def list_languages(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/languages",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_custom_language(query = {})
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/languages",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_language(language_id = nil)
+        language_id || raise_parameter_is_required_error(:language_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/languages/#{language_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_custom_language(language_id = nil)
+        language_id || raise_parameter_is_required_error(:language_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/languages/#{language_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_custom_language(language_id = nil, query = {})
+        language_id || raise_parameter_is_required_error(:language_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/languages/#{language_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module MachineTranslationEngines
+      def list_mts(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/mts",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_mt(mt_id = nil)
+        mt_id || raise_parameter_is_required_error(:mt_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/mts/#{mt_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def translate_via_mt(mt_id = nil, query = {})
+        mt_id || raise_parameter_is_required_error(:mt_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/mts/#{mt_id}/translations",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def edit_mt(mt_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        mt_id            || raise_parameter_is_required_error(:mt_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/mts/#{mt_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_mt(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/mts",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_mt(mt_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        mt_id            || raise_parameter_is_required_error(:mt_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/mts/#{mt_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Projects
+      def list_projects(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_project(query = {})
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_project(project_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_project(project_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_project(project_id = nil, query = {})
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def list_groups(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_group(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/groups",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_group(group_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups/#{group_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_group(group_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/groups/#{group_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_group(group_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/groups/#{group_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Reports
+      def generate_report(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/reports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_report_generation_status(report_id = nil, project_id = config.project_id)
+        report_id  || raise_parameter_is_required_error(:report_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/reports/#{report_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_report(report_id = nil, destination = nil, project_id = config.project_id)
+        report_id  || raise_parameter_is_required_error(:report_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/reports/#{report_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def generate_group_report(group_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/groups/#{group_id}/reports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_group_report_generation_status(group_id = nil, report_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_group_report(group_id = nil, report_id = nil, destination = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      def generate_organization_report(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/reports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_organization_report_generation_status(report_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/reports/#{report_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_organization_report(report_id = nil, destination = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/reports/#{report_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+    end
+  end
+end