crowdin-api 1.2.1 → 1.3.0

data/lib/crowdin-api/{api-resources → api_resources}/translation_memory.rb

@@ -5,85 +5,78 @@ module Crowdin
     module TranslationMemory
       def list_tms(query = {})
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          '/tms',
-          query
+          "#{config.target_api_url}/tms",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def add_tm(query = {})
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          '/tms',
-          query
+          "#{config.target_api_url}/tms",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_tm(tm_id = nil)
         tm_id || raise_parameter_is_required_error(:tm_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/tms/#{tm_id}"
+          "#{config.target_api_url}/tms/#{tm_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def delete_tm(tm_id = nil)
         tm_id || raise_parameter_is_required_error(:tm_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/tms/#{tm_id}"
+          "#{config.target_api_url}/tms/#{tm_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def edit_tm(tm_id = nil, query = {})
         tm_id || raise_parameter_is_required_error(:tm_id)
 
         request = Web::Request.new(
-          self,
-          :delete,
-          "/tms/#{tm_id}",
-          query
+          connection,
+          :patch,
+          "#{config.target_api_url}/tms/#{tm_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def clear_tm(tm_id = nil)
         tm_id || raise_parameter_is_required_error(:tm_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/tms/#{tm_id}/segments"
+          "#{config.target_api_url}/tms/#{tm_id}/segments"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def export_tm(tm_id = nil)
         tm_id || raise_parameter_is_required_error(:tm_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/tms/#{tm_id}/exports"
+          "#{config.target_api_url}/tms/#{tm_id}/exports"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def check_tm_export_status(tm_id = nil, export_id = nil)
@@ -91,12 +84,11 @@ module Crowdin
         export_id || raise_parameter_is_required_error(:export_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/tms/#{tm_id}/exports/#{export_id}"
+          "#{config.target_api_url}/tms/#{tm_id}/exports/#{export_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def download_tm(tm_id = nil, export_id = nil, destination = nil)
@@ -104,28 +96,23 @@ module Crowdin
         export_id || raise_parameter_is_required_error(:export_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/tms/#{tm_id}/exports/#{export_id}/download",
-          {},
-          {},
-          destination
+          "#{config.target_api_url}/tms/#{tm_id}/exports/#{export_id}/download"
         )
-
-        request.perform
+        Web::SendRequest.new(request, destination).perform
       end
 
       def import_tm(tm_id = nil, query = {})
         tm_id || raise_parameter_is_required_error(:tm_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/tms/#{tm_id}/imports",
-          query
+          "#{config.target_api_url}/tms/#{tm_id}/imports",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def check_tm_import_status(tm_id = nil, import_id = nil)
@@ -133,12 +120,11 @@ module Crowdin
         import_id || raise_parameter_is_required_error(:import_id)
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/tms/#{tm_id}/imports/#{import_id}"
+          "#{config.target_api_url}/tms/#{tm_id}/imports/#{import_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
     end
   end

data/lib/crowdin-api/{api-resources → api_resources}/translation_status.rb

@@ -8,13 +8,12 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/branches/#{branch_id}/languages/progress",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/branches/#{branch_id}/languages/progress",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_directory_progress(directory_id = nil, query = {}, project_id = config.project_id)
@@ -22,13 +21,12 @@ module Crowdin
         project_id   || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/directories/#{directory_id}/languages/progress",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/directories/#{directory_id}/languages/progress",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_file_progress(file_id = nil, query = {}, project_id = config.project_id)
@@ -36,13 +34,12 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/files/#{file_id}/languages/progress",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/languages/progress",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_language_progress(language_id = nil, query = {}, project_id = config.project_id)
@@ -50,39 +47,36 @@ module Crowdin
         project_id  || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/languages/#{language_id}/progress",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/languages/#{language_id}/progress",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(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,
+          connection,
           :get,
-          "/projects/#{project_id}/languages/progress",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/languages/progress",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(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,
+          connection,
           :get,
-          "/projects/#{project_id}/qa-checks",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/qa-checks",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
     end
   end

data/lib/crowdin-api/{api-resources → api_resources}/translations.rb

@@ -8,25 +8,23 @@ module Crowdin
         project_id         || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/pre-translations/#{pre_translation_id}"
+          "#{config.target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def apply_pre_translation(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/pre-translations",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/pre-translations",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def build_project_directory_translation(directory_id = nil, query = {}, project_id = config.project_id)
@@ -34,13 +32,12 @@ module Crowdin
         project_id   || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/translations/builds/directories/#{directory_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/translations/builds/directories/#{directory_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def build_project_file_translation(file_id = nil, query = {}, destination = nil, project_id = config.project_id)
@@ -50,41 +47,36 @@ module Crowdin
         headers = query[:eTag] ? { 'If-None-Match' => query[:eTag] } : {}
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/translations/builds/files/#{file_id}",
-          query,
-          headers,
-          destination
+          "#{config.target_api_url}/projects/#{project_id}/translations/builds/files/#{file_id}",
+          { params: query, headers: headers }
         )
-
-        request.perform
+        Web::SendRequest.new(request, destination).perform
       end
 
       def list_project_builds(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/translations/builds",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/translations/builds",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def build_project_translation(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/translations/builds",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/translations/builds",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def upload_translations(language_id = nil, query = {}, project_id = config.project_id)
@@ -92,13 +84,12 @@ module Crowdin
         project_id  || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/translations/#{language_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/translations/#{language_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def download_project_translations(build_id = nil, destination = nil, project_id = config.project_id)
@@ -106,15 +97,11 @@ module Crowdin
         project_id  || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/translations/builds/#{build_id}/download",
-          {},
-          {},
-          destination
+          "#{config.target_api_url}/projects/#{project_id}/translations/builds/#{build_id}/download"
         )
-
-        request.perform
+        Web::SendRequest.new(request, destination).perform
       end
 
       def check_project_build_status(build_id = nil, project_id = config.project_id)
@@ -122,12 +109,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/translations/builds/#{build_id}"
+          "#{config.target_api_url}/projects/#{project_id}/translations/builds/#{build_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def cancel_build(build_id = nil, project_id = config.project_id)
@@ -135,27 +121,23 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/projects/#{project_id}/translations/builds/#{build_id}"
+          "#{config.target_api_url}/projects/#{project_id}/translations/builds/#{build_id}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def export_project_translation(query = {}, destination = nil, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/translations/exports",
-          query,
-          {},
-          destination
+          "#{config.target_api_url}/projects/#{project_id}/translations/exports",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request, destination).perform
       end
     end
   end

data/lib/crowdin-api/api_resources/users.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Users
+      def get_authenticated_user
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/user"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_project_members(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/members",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_member_info(member_id = nil, project_id = config.project_id)
+        member_id  || raise_parameter_is_required_error(:member_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/members/#{member_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def add_project_member(query = {}, project_id = config.project_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        project_id       || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/members",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_project_member_permissions(member_id = nil, project_id = config.project_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        member_id        || raise_parameter_is_required_error(:member_id)
+        project_id       || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/members/#{member_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def replace_project_permissions(member_id = nil, query = {}, project_id = config.project_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        member_id        || raise_parameter_is_required_error(:member_id)
+        project_id       || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/projects/#{project_id}/members/#{member_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_member_from_project(member_id = nil, query = {}, project_id = config.project_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        member_id        || raise_parameter_is_required_error(:member_id)
+        project_id       || raise_project_id_is_required_error
+
+        response = ::RestClient::Request.execute(
+          {
+            method: :delete,
+            url: config.base_url + config.target_api_url + "/projects/#{project_id}/members/#{member_id}",
+            payload: query.to_json
+          }.merge(@options)
+        )
+
+        response.body.empty? ? response.code : JSON.parse(response.body)
+      rescue StandardError => e
+        e.message
+      end
+
+      def list_users(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/users",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def invite_user(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/users",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_user(user_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        user_id          || raise_parameter_is_required_error(:user_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/users/#{user_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_user(user_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        user_id          || raise_parameter_is_required_error(:user_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/users/#{user_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_user(user_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        user_id          || raise_parameter_is_required_error(:user_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/users/#{user_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api_resources/vendors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Vendors
+      # -- For Enterprise mode only --
+
+      def list_vendors(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/vendors",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end