crowdin-api 1.0.0 → 1.1.0

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

@@ -4,7 +4,7 @@ module Crowdin
   module ApiResources
     module SourceFiles
       def list_branches(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -17,7 +17,7 @@ module Crowdin
       end
 
       def add_branch(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -30,8 +30,8 @@ module Crowdin
       end
 
       def get_branch(branch_id = nil, project_id = config.project_id)
-        branch_id  || raise(ArgumentError, ':branch_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        branch_id  || raise_parameter_is_required_error(:branch_id)
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -43,8 +43,8 @@ module Crowdin
       end
 
       def delete_branch(branch_id = nil, project_id = config.project_id)
-        branch_id  || raise(ArgumentError, ':branch_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        branch_id  || raise_parameter_is_required_error(:branch_id)
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -55,11 +55,9 @@ module Crowdin
         request.perform
       end
 
-      def edit_branch(branch_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        branch_id  || raise(ArgumentError, ':branch_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -72,7 +70,7 @@ module Crowdin
       end
 
       def list_directories(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -85,7 +83,7 @@ module Crowdin
       end
 
       def add_directory(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -98,8 +96,8 @@ module Crowdin
       end
 
       def get_directory(directory_id = nil, project_id = config.project_id)
-        directory_id || raise(ArgumentError, ':directory_id is required')
-        project_id   || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        directory_id || raise_parameter_is_required_error(:directory_id)
+        project_id   || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -111,8 +109,8 @@ module Crowdin
       end
 
       def delete_directory(directory_id = nil, project_id = config.project_id)
-        directory_id || raise(ArgumentError, ':directory_id is required')
-        project_id   || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        directory_id || raise_parameter_is_required_error(:directory_id)
+        project_id   || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -123,11 +121,9 @@ module Crowdin
         request.perform
       end
 
-      def edit_directory(directory_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        directory_id || raise(ArgumentError, ':directory_id is required')
-        project_id   || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -140,7 +136,7 @@ module Crowdin
       end
 
       def list_files(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -166,12 +162,12 @@ module Crowdin
       #
       #  crowdin.add_file(storage_id: your_storage_id, name: 'your_filename')
       #
-      # or you can use the specified project_id
+      # or you can specify project_id
       #
-      #  crowdin.add_file({}, your_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(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -184,8 +180,8 @@ module Crowdin
       end
 
       def get_file(file_id = nil, project_id = config.project_id)
-        file_id    || raise(ArgumentError, ':file_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -196,11 +192,9 @@ module Crowdin
         request.perform
       end
 
-      def update_or_restore_file(file_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        file_id    || raise(ArgumentError, ':file_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -213,8 +207,8 @@ module Crowdin
       end
 
       def delete_file(file_id = nil, project_id = config.project_id)
-        file_id    || raise(ArgumentError, ':file_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        file_id    || raise_parameter_is_required_error(:file_id)
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -225,11 +219,9 @@ module Crowdin
         request.perform
       end
 
-      def edit_file(file_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        file_id    || raise(ArgumentError, ':file_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -242,9 +234,9 @@ module Crowdin
       end
 
       def download_file(destination = nil, file_id = nil, project_id = config.project_id)
-        destination || raise(ArgumentError, ':destination is required for downlaods')
-        file_id     || raise(ArgumentError, ':file_id is required')
-        project_id  || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        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,
@@ -273,17 +265,15 @@ module Crowdin
       #
       # when you're initialized Crowdin Client with a project_id
       #
-      #  crowdin.list_file_revisions(your_file_id, { limit: your_value })
+      #  crowdin.list_file_revisions(your_file_id, limit: your_value)
       #
-      # or you can use the specified project_id
+      # or you can specify project_id
       #
-      #  crowdin.list_file_revisions(your_file_id, { project_id: your_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 = query[:project_id] || config.project_id
-
-        file_id    || raise(ArgumentError, ':file_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -296,9 +286,9 @@ module Crowdin
       end
 
       def get_file_revision(file_id = nil, revision_id = nil, project_id = config.project_id)
-        file_id     || raise(ArgumentError, ':file_id is required')
-        revision_id || raise(ArgumentError, ':revision_id is required')
-        project_id  || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        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,

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

@@ -34,14 +34,14 @@ module Crowdin
       #
       # === Example
       #
-      #  crowdin.add_storage(File.open('your_filename.extension'))
+      #  crowdin.add_storage(File.open('your_filename.extension', 'r'))
       # or
       #  crowdin.add_storage('your_filename.extension')
       #
       def add_storage(file = nil)
-        file || raise(ArgumentError, ':file is required')
+        file || raise_parameter_is_required_error(:file)
 
-        file = file.is_a?(File) ? file : File.open(file)
+        file = file.is_a?(File) ? file : File.open(file, 'r')
 
         request = Web::Request.new(
           self,
@@ -65,7 +65,7 @@ module Crowdin
       #  crowdin.get_storage(your_storage_id)
       #
       def get_storage(storage_id = nil)
-        storage_id || raise(ArgumentError, ':storage_id is required')
+        storage_id || raise_parameter_is_required_error(:storage_id)
 
         request = Web::Request.new(
           self,
@@ -87,7 +87,7 @@ module Crowdin
       #  crowdin.delete_storage(your_storage_id)
       #
       def delete_storage(storage_id = nil)
-        storage_id || raise(ArgumentError, ':storage_id is required')
+        storage_id || raise_parameter_is_required_error(:storage_id)
 
         request = Web::Request.new(
           self,

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

@@ -3,11 +3,9 @@
 module Crowdin
   module ApiResources
     module TranslationStatus
-      def get_branch_progress(branch_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        branch_id   || raise(ArgumentError, ':file_id is required')
-        project_id  || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -19,11 +17,9 @@ module Crowdin
         request.perform
       end
 
-      def get_directory_progress(directory_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        directory_id || raise(ArgumentError, ':directory_id is required')
-        project_id   || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -35,11 +31,9 @@ module Crowdin
         request.perform
       end
 
-      def get_file_progress(file_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        file_id    || raise(ArgumentError, ':file_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -51,11 +45,9 @@ module Crowdin
         request.perform
       end
 
-      def get_language_progress(language_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        language_id || raise(ArgumentError, ':language_id is required')
-        project_id  || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      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,
@@ -68,7 +60,7 @@ module Crowdin
       end
 
       def get_project_progress(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -81,7 +73,7 @@ module Crowdin
       end
 
       def get_qa_progress(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,

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

@@ -4,8 +4,8 @@ module Crowdin
   module ApiResources
     module Translations
       def pre_translation_status(pre_translation_id = nil, project_id = config.project_id)
-        pre_translation_id || raise(ArgumentError, ':pre_translation_id is required')
-        project_id         || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
+        project_id         || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -17,7 +17,7 @@ module Crowdin
       end
 
       def apply_pre_translation(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -29,11 +29,9 @@ module Crowdin
         request.perform
       end
 
-      def build_project_directory_translation(directory_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        directory_id || raise(ArgumentError, ':directory_id is required')
-        project_id   || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      def build_project_directory_translation(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,
@@ -45,11 +43,9 @@ module Crowdin
         request.perform
       end
 
-      def build_project_file_translation(file_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        file_id    || raise(ArgumentError, ':file_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      def build_project_file_translation(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
 
         headers = query[:eTag] ? { 'If-None-Match' => query[:eTag] } : {}
 
@@ -65,7 +61,7 @@ module Crowdin
       end
 
       def list_project_builds(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -78,7 +74,7 @@ module Crowdin
       end
 
       def build_project_translation(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -90,11 +86,9 @@ module Crowdin
         request.perform
       end
 
-      def upload_translations(language_id = nil, query = {})
-        project_id = query[:project_id] || config.project_id
-
-        language_id || raise(ArgumentError, ':language_id is required')
-        project_id  || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      def upload_translations(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,
@@ -106,10 +100,10 @@ module Crowdin
         request.perform
       end
 
-      def download_project_translations(destinaton = nil, build_id = nil, project_id = config.project_id)
-        destinaton || raise(ArgumentError, ':destination is required for downlaods')
-        build_id   || raise(ArgumentError, ':build_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+      def download_project_translations(destination = nil, build_id = nil, project_id = config.project_id)
+        destination || raise_parameter_is_required_error(:destination)
+        build_id    || raise_parameter_is_required_error(:build_id)
+        project_id  || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -117,15 +111,15 @@ module Crowdin
           "/projects/#{project_id}/translations/builds/#{build_id}/download",
           {},
           {},
-          destinaton
+          destination
         )
 
         request.perform
       end
 
       def check_project_build_status(build_id = nil, project_id = config.project_id)
-        build_id   || raise(ArgumentError, ':build_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        build_id   || raise_parameter_is_required_error(:build_id)
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -137,8 +131,8 @@ module Crowdin
       end
 
       def cancel_build(build_id = nil, project_id = config.project_id)
-        build_id   || raise(ArgumentError, ':build_id is required')
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        build_id   || raise_parameter_is_required_error(:build_id)
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
@@ -150,7 +144,7 @@ module Crowdin
       end
 
       def export_project_translation(query = {}, project_id = config.project_id)
-        project_id || raise(ArgumentError, ':project_id is required in parameters or when initialize Client')
+        project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Workflows
+      def list_workflow_steps(query = {}, project_id = config.project_id)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        project_id              || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/workflow-steps",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_workflow_step(step_id = nil, project_id = config.project_id)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        step_id                 || raise_parameter_is_required_error(:step_id)
+        project_id              || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/workflow-steps/#{step_id}"
+        )
+
+        request.perform
+      end
+
+      def list_workflow_templates(query = {})
+        request = Web::Request.new(
+          self,
+          :get,
+          '/workflow-templates',
+          query
+        )
+
+        request.perform
+      end
+
+      def get_workflow_template(template_id = nil)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        template_id             || raise_parameter_is_required_error(:template_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/workflow-templates/#{template_id}"
+        )
+
+        request.perform
+      end
+    end
+  end
+end