crowdin-api 0.4.1 → 1.1.0

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

@@ -0,0 +1,134 @@
+# 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
+
+      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/source_files.rb

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module SourceFiles
+      def list_branches(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/branches",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_branch(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/branches",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_branch(branch_id = nil, project_id = config.project_id)
+        branch_id  || raise_parameter_is_required_error(:branch_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/branches/#{branch_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_branch(branch_id = nil, project_id = config.project_id)
+        branch_id  || raise_parameter_is_required_error(:branch_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/branches/#{branch_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_branch(branch_id = nil, query = {}, project_id = config.project_id)
+        branch_id  || raise_parameter_is_required_error(:branch_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/branches/#{branch_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def list_directories(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/directories",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_directory(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/directories",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_directory(directory_id = nil, project_id = config.project_id)
+        directory_id || raise_parameter_is_required_error(:directory_id)
+        project_id   || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/directories/#{directory_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_directory(directory_id = nil, project_id = config.project_id)
+        directory_id || raise_parameter_is_required_error(:directory_id)
+        project_id   || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/directories/#{directory_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_directory(directory_id = nil, query = {}, project_id = config.project_id)
+        directory_id || raise_parameter_is_required_error(:directory_id)
+        project_id   || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/directories/#{directory_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def list_files(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/files",
+          query
+        )
+
+        request.perform
+      end
+
+      # Add custom language.
+      #
+      # === Parameters
+      #
+      # * +:projectId+ [Integer] - Project Identifier. Get via list_projects. Can be initialized with the Crowdin Client
+      # * +:storageId+ [Integer] - Storage Identifier. Get via list_storages
+      # * +:name+ [String] - File name. Note: Can't contain \ / : * ? " < > | symbols. ZIP files are not allowed.
+      #
+      # === Example
+      #
+      # when you're initialized Crowdin Client with a project_id
+      #
+      #  crowdin.add_file(storage_id: your_storage_id, name: 'your_filename')
+      #
+      # or you can specify project_id
+      #
+      #  crowdin.add_file({ storage_id: your_storage_id, name: 'your_filename' }, your_project_id)
+      #
+      def add_file(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/files",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_file(file_id = nil, project_id = config.project_id)
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/files/#{file_id}"
+        )
+
+        request.perform
+      end
+
+      def update_or_restore_file(file_id = nil, query = {}, project_id = config.project_id)
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :put,
+          "/projects/#{project_id}/files/#{file_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def delete_file(file_id = nil, project_id = config.project_id)
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/files/#{file_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_file(file_id = nil, query = {}, project_id = config.project_id)
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/files/#{file_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def download_file(destination = nil, file_id = 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
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/files/#{file_id}/download",
+          {},
+          {},
+          destination
+        )
+
+        request.perform
+      end
+
+      # List file revisions.
+      #
+      # === Parameters
+      #
+      # * +:projectId+ [Integer] - Project Identifier. Get via list_projects. Can be initialized with the Crowdin Client
+      # * +:fileId+ [Integer] - File Identifier. Get via list_files
+      #
+      # Optional:
+      # * +:limit+ [Integer 1..500] - A maximum number of items to retrieve, default - 25
+      # * +:offset+ [Integer >= 0] - A starting offset in the collection, default - 0
+      #
+      # === Example
+      #
+      # when you're initialized Crowdin Client with a project_id
+      #
+      #  crowdin.list_file_revisions(your_file_id, limit: your_value)
+      #
+      # or you can specify project_id
+      #
+      #  crowdin.list_file_revisions(your_file_id, { limit: your_value }, your_project_id)
+      #
+      def list_file_revisions(file_id = nil, query = {}, project_id = config.project_id)
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/files/#{file_id}/revisions",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_file_revision(file_id = nil, revision_id = nil, project_id = config.project_id)
+        file_id     || raise_parameter_is_required_error(:file_id)
+        revision_id || raise_parameter_is_required_error(:revision_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/files/#{file_id}/revisions/#{revision_id}"
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module SourceStrings
+      def list_strings(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/strings",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_string(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/strings",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_string(string_id = nil, query = {}, project_id = config.project_id)
+        string_id  || raise_parameter_is_required_error(:string_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/strings/#{string_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def delete_string(string_id = nil, project_id = config.project_id)
+        string_id  || raise_parameter_is_required_error(:string_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/strings/#{string_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_string(string_id = nil, query = {}, project_id = config.project_id)
+        string_id  || raise_parameter_is_required_error(:string_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/strings/#{string_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Storages
+      # Get storages list.
+      #
+      # === Parameters
+      #
+      # Optional:
+      # * +:limit+ [Integer 1..500] - A maximum number of items to retrieve, default - 25
+      # * +:offset+ [Integer >= 0] - A starting offset in the collection, default - 0
+      #
+      # === Example
+      #
+      #  crowdin.list_projects(limit: your_value)
+      #
+      def list_storages(query = {})
+        request = Web::Request.new(
+          self,
+          :get,
+          '/storages',
+          query
+        )
+
+        request.perform
+      end
+
+      # Add storage.
+      #
+      # === Parameters
+      #
+      # * +File+ - File class object or path to file
+      #
+      # === Example
+      #
+      #  crowdin.add_storage(File.open('your_filename.extension', 'r'))
+      # or
+      #  crowdin.add_storage('your_filename.extension')
+      #
+      def add_storage(file = nil)
+        file || raise_parameter_is_required_error(:file)
+
+        file = file.is_a?(File) ? file : File.open(file, 'r')
+
+        request = Web::Request.new(
+          self,
+          :post,
+          '/storages',
+          file,
+          { 'Content-Type' => 'application/octet-stream', 'Crowdin-API-FileName' => File.basename(file) }
+        )
+
+        request.perform
+      end
+
+      # Get storage information.
+      #
+      # === Parameters
+      #
+      # * +:storage_id+ [Integer] - Storage Identifier. Get via list_storages
+      #
+      # === Example
+      #
+      #  crowdin.get_storage(your_storage_id)
+      #
+      def get_storage(storage_id = nil)
+        storage_id || raise_parameter_is_required_error(:storage_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/storages/#{storage_id}"
+        )
+
+        request.perform
+      end
+
+      # Delete storage.
+      #
+      # === Parameters
+      #
+      # * +:storage_id+ [Integer] - Storage Identifier. Get via list_storages
+      #
+      # === Example
+      #
+      #  crowdin.delete_storage(your_storage_id)
+      #
+      def delete_storage(storage_id = nil)
+        storage_id || raise_parameter_is_required_error(:storage_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/storages/#{storage_id}"
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module TranslationStatus
+      def get_branch_progress(branch_id = nil, query = {}, project_id = config.project_id)
+        branch_id  || raise_parameter_is_required_error(:branch_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/branches/#{branch_id}/languages/progress",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_directory_progress(directory_id = nil, query = {}, project_id = config.project_id)
+        directory_id || raise_parameter_is_required_error(:directory_id)
+        project_id   || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/directories/#{directory_id}/languages/progress",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_file_progress(file_id = nil, query = {}, project_id = config.project_id)
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/files/#{file_id}/languages/progress",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_language_progress(language_id = nil, query = {}, project_id = config.project_id)
+        language_id || raise_parameter_is_required_error(:language_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/languages/#{language_id}/progress",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_project_progress(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/languages/progress",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_qa_progress(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/qa-checks",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end