crowdin-api 0.6.0 → 1.2.0

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

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Projects
+      def list_projects(query = {})
+        request = Web::Request.new(
+          self,
+          :get,
+          '/projects',
+          query
+        )
+
+        request.perform
+      end
+
+      def add_project(query = {})
+        request = Web::Request.new(
+          self,
+          :post,
+          '/projects',
+          query
+        )
+
+        request.perform
+      end
+
+      def get_project(project_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_project(project_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}"
+        )
+
+        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)
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def list_groups(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          '/groups',
+          query
+        )
+
+        request.perform
+      end
+
+      def add_group(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          '/groups',
+          query
+        )
+
+        request.perform
+      end
+
+      def get_group(group_id = nil)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id                || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/groups/#{group_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_group(group_id = nil)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id                || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/groups/#{group_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_group(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,
+          :patch,
+          "/groups/#{group_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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