crowdin-api 1.1.1 → 1.2.0

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

@@ -14,6 +14,7 @@ module Crowdin
         request.perform
       end
 
+      #
       # Add custom language.
       #
       # === Parameters

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

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

@@ -49,6 +49,20 @@ module Crowdin
         request.perform
       end
 
+      #
+      # Edit project.
+      #
+      # === Parameters
+      #
+      # * +:projectId+ [Integer] - Project Identifier. Get via list_projects. Can be initialized with the Crowdin Client
+      # * +:value+ [String] - String or Array of strings.
+      # * +:op+ [String] - Path operation to perform.
+      # * +:projectId+ [String <json-pointer>] - Enum, for instance '/name'. Full list you can see on the developers site.
+      #
+      # === Example
+      #
+      #  crowdin.edit_project(project_id, [{op: 'replace', path: '/name', value: 'your_new_project_name'}])
+      #
       def edit_project(project_id = nil, query = {})
         project_id || raise_parameter_is_required_error(:project_id)
 
@@ -62,7 +76,7 @@ module Crowdin
         request.perform
       end
 
-      # For Enterprise mode only
+      # -- For Enterprise mode only --
 
       def list_groups(query = {})
         config.enterprise_mode? || raise_only_for_enterprise_mode_error

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

@@ -0,0 +1,138 @@
+# 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(
+          self,
+          :post,
+          "/projects/#{project_id}/reports",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/reports/#{report_id}"
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/reports/#{report_id}/download",
+          {},
+          {},
+          destination
+        )
+
+        request.perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def generate_group_report(group_id = nil, query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id                || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/groups/#{group_id}/reports",
+          query
+        )
+
+        request.perform
+      end
+
+      def check_group_report_generation_status(group_id = nil, report_id = nil)
+        config.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(
+          self,
+          :get,
+          "/groups/#{group_id}/reports/#{report_id}"
+        )
+
+        request.perform
+      end
+
+      def download_group_report(group_id = nil, report_id = nil, destination = nil)
+        config.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(
+          self,
+          :get,
+          "/groups/#{group_id}/reports/#{report_id}/download",
+          {},
+          {},
+          destination
+        )
+
+        request.perform
+      end
+
+      def generate_organization_report(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          '/reports',
+          query
+        )
+
+        request.perform
+      end
+
+      def check_organization_report_generation_status(report_id = nil)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        report_id               || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/reports/#{report_id}"
+        )
+
+        request.perform
+      end
+
+      def download_organization_report(report_id = nil, destination = nil)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        report_id               || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/reports/#{report_id}/download",
+          {},
+          {},
+          destination
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Screenshots
+      def list_screenshots(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/screenshots",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_screenshot(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/screenshots",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_screenshot(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}"
+        )
+
+        request.perform
+      end
+
+      def update_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :put,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def delete_screenshot(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def list_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          query
+        )
+
+        request.perform
+      end
+
+      # Auto tag
+      def replace_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :put,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_tag(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          query
+        )
+
+        request.perform
+      end
+
+      def clear_tags(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}/tags"
+        )
+
+        request.perform
+      end
+
+      def get_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_tag(screenshot_id = nil, tag_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -148,6 +148,7 @@ module Crowdin
         request.perform
       end
 
+      #
       # Add custom language.
       #
       # === Parameters
@@ -234,7 +235,6 @@ module Crowdin
       end
 
       def download_file(file_id = nil, destination = nil, project_id = config.project_id)
-        destination || raise_parameter_is_required_error(:destination)
         file_id     || raise_parameter_is_required_error(:file_id)
         project_id  || raise_project_id_is_required_error
 
@@ -250,6 +250,7 @@ module Crowdin
         request.perform
       end
 
+      #
       # List file revisions.
       #
       # === Parameters

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

@@ -3,6 +3,7 @@
 module Crowdin
   module ApiResources
     module Storages
+      #
       # Get storages list.
       #
       # === Parameters
@@ -26,11 +27,12 @@ module Crowdin
         request.perform
       end
 
+      #
       # Add storage.
       #
       # === Parameters
       #
-      # * +File+ - File class object or path to file
+      # * +File+ - File class object or full path to file
       #
       # === Example
       #
@@ -54,6 +56,7 @@ module Crowdin
         request.perform
       end
 
+      #
       # Get storage information.
       #
       # === Parameters
@@ -76,6 +79,7 @@ module Crowdin
         request.perform
       end
 
+      #
       # Delete storage.
       #
       # === Parameters

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module StringComments
+      def list_string_comments(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/comments",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_string_comment(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/comments",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_string_comment(string_comment_id = nil, project_id = config.project_id)
+        string_comment_id || raise_parameter_is_required_error(:string_comment_id)
+        project_id        || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/comments/#{string_comment_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_string_comment(string_comment_id = nil, project_id = config.project_id)
+        string_comment_id || raise_parameter_is_required_error(:string_comment_id)
+        project_id        || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/comments/#{string_comment_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_string_comment(string_comment_id = nil, query = {}, project_id = config.project_id)
+        string_comment_id || raise_parameter_is_required_error(:string_comment_id)
+        project_id        || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/comments/#{string_comment_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end