crowdin-api 0.6.0 → 1.2.0

data/lib/crowdin-api/api-resources/distributions.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Distributions
+      def list_distributions(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/distributions",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_distribution(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/distributions",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_distribution(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/distributions/#{hash}"
+        )
+
+        request.perform
+      end
+
+      def delete_distribution(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/distributions/#{hash}"
+        )
+
+        request.perform
+      end
+
+      def edit_distribution(hash = nil, query = {}, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/distributions/#{hash}",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_destribution_release(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/distributions/#{hash}/release"
+        )
+
+        request.perform
+      end
+
+      def release_distribution(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/distributions/#{hash}/release"
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Glossaries
+      def list_glossaries(query = {})
+        request = Web::Request.new(
+          self,
+          :get,
+          '/glossaries',
+          query
+        )
+
+        request.perform
+      end
+
+      def add_glossary(query = {})
+        request = Web::Request.new(
+          self,
+          :post,
+          '/glossaries',
+          query
+        )
+
+        request.perform
+      end
+
+      def get_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/glossaries/#{glossary_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def delete_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/glossaries/#{glossary_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def edit_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/glossaries/#{glossary_id}",
+          query
+        )
+
+        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(
+          self,
+          :post,
+          "/glossaries/#{glossary_id}/exports",
+          query,
+          {},
+          destination
+        )
+
+        request.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(
+          self,
+          :get,
+          "/glossaries/#{glossary_id}/exports/#{export_id}"
+        )
+
+        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(
+          self,
+          :get,
+          "/glossaries/#{glossary_id}/exports/#{export_id}/download",
+          {},
+          {},
+          destination
+        )
+
+        request.perform
+      end
+
+      def import_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/glossaries/#{glossary_id}/imports",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/glossaries/#{glossary_id}/imports/#{import_id}"
+        )
+
+        request.perform
+      end
+
+      def list_terms(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/glossaries/#{glossary_id}/terms",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_term(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/glossaries/#{glossary_id}/terms",
+          query
+        )
+
+        request.perform
+      end
+
+      def clear_glossary(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/glossaries/#{glossary_id}/terms",
+          query
+        )
+
+        request.perform
+      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(
+          self,
+          :get,
+          "/glossaries/#{glossary_id}/terms/#{term_id}"
+        )
+
+        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(
+          self,
+          :delete,
+          "/glossaries/#{glossary_id}/terms/#{term_id}"
+        )
+
+        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(
+          self,
+          :patch,
+          "/glossaries/#{glossary_id}/terms/#{term_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Labels
+      def list_lables(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/labels",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_label(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/labels",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/labels/#{label_id}"
+        )
+
+        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(
+          self,
+          :delete,
+          "/projects/#{project_id}/labels/#{label_id}"
+        )
+
+        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(
+          self,
+          :patch,
+          "/projects/#{project_id}/labels/#{label_id}",
+          query
+        )
+
+        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(
+          self,
+          :post,
+          "/projects/#{project_id}/labels/#{label_id}/strings",
+          query
+        )
+
+        request.perform
+      end
+
+      # For now Rest Client Resource aren't support payload for DELETE requests.
+      # So we have workaround through Rest Client Execute for this case
+      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
+        #
+        # request = Web::Request.new(
+        #   self,
+        #   :delete,
+        #   "/projects/#{project_id}/labels/#{label_id}",
+        #   query
+        # )
+        #
+        # request.perform
+
+        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)
+        )
+
+        begin
+          JSON.parse(response)
+        rescue
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Languages
+      def list_languages(query = {})
+        request = Web::Request.new(
+          self,
+          :get,
+          '/languages',
+          query
+        )
+
+        request.perform
+      end
+
+      #
+      # Add custom language.
+      #
+      # === Parameters
+      #
+      # * +:name+ [String] - Language name
+      # * +:code+ [String] - Custom language code
+      # * +:localeCode+ [String] - Custom language locale code
+      # * +:textDirection+ [String ltr/rtl] - Text direction in custom language
+      # * +:pluralCategoryNames+ [String] - Array with category names
+      # * +:threeLettersCode+ [String] - Custom language 3 letters code. Format: ISO 6393 code
+      #
+      # === Example
+      #
+      #  crowdin.add_custom_language(name: 'your_name', code: 'your_code' ..)
+      #
+      def add_custom_language(query = {})
+        request = Web::Request.new(
+          self,
+          :post,
+          '/languages',
+          query
+        )
+
+        request.perform
+      end
+
+      def get_language(language_id = nil)
+        language_id || raise_parameter_is_required_error(:language_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/languages/#{language_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_custom_language(language_id = nil)
+        language_id || raise_parameter_is_required_error(:language_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/languages/#{language_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_custom_language(language_id = nil)
+        language_id || raise_parameter_is_required_error(:language_id)
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/languages/#{language_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

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