crowdin-api 0.6.0 → 1.2.0

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

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Translations
+      def pre_translation_status(pre_translation_id = nil, project_id = config.project_id)
+        pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
+        project_id         || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/pre-translations/#{pre_translation_id}"
+        )
+
+        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,
+          :post,
+          "/projects/#{project_id}/pre-translations",
+          query
+        )
+
+        request.perform
+      end
+
+      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,
+          :post,
+          "/projects/#{project_id}/translations/builds/directories/#{directory_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      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] } : {}
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/translations/builds/files/#{file_id}",
+          query,
+          headers
+        )
+
+        request.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,
+          :get,
+          "/projects/#{project_id}/translations/builds",
+          query
+        )
+
+        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,
+          :post,
+          "/projects/#{project_id}/translations/builds",
+          query
+        )
+
+        request.perform
+      end
+
+      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,
+          :post,
+          "/projects/#{project_id}/translations/#{language_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def download_project_translations(build_id = nil, destination = nil, project_id = config.project_id)
+        build_id    || raise_parameter_is_required_error(:build_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/translations/builds/#{build_id}/download",
+          {},
+          {},
+          destination
+        )
+
+        request.perform
+      end
+
+      def check_project_build_status(build_id = nil, project_id = config.project_id)
+        build_id   || raise_parameter_is_required_error(:build_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/translations/builds/#{build_id}"
+        )
+
+        request.perform
+      end
+
+      def cancel_build(build_id = nil, project_id = config.project_id)
+        build_id   || raise_parameter_is_required_error(:build_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/translations/builds/#{build_id}"
+        )
+
+        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,
+          :post,
+          "/projects/#{project_id}/translations/exports",
+          query,
+          {},
+          destination
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Users
+      def get_authenticated_user
+        request = Web::Request.new(
+          self,
+          :get,
+          '/user'
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/members",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/members/#{member_id}"
+        )
+
+        request.perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def add_project_member(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,
+          :post,
+          "/projects/#{project_id}/members",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_project_member_permissions(member_id = nil, project_id = config.project_id)
+        config.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(
+          self,
+          :get,
+          "/projects/#{project_id}/members/#{member_id}"
+        )
+
+        request.perform
+      end
+
+      def replace_project_permissions(member_id = nil, query = {}, project_id = config.project_id)
+        config.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(
+          self,
+          :put,
+          "/projects/#{project_id}/members/#{member_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def delete_member_from_project(member_id = nil, query = {}, project_id = config.project_id)
+        config.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(
+          self,
+          :delete,
+          "/projects/#{project_id}/members/#{member_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def list_users(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          '/users',
+          query
+        )
+
+        request.perform
+      end
+
+      def get_user(user_id = nil)
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        user_id                 || raise_parameter_is_required_error(:user_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/users/#{user_id}"
+        )
+
+        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
+    # -- For Enterprise mode only --
+    module Vendors
+      def list_vendors(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          '/vendors',
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Webhooks
+      def list_webhooks(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/webhooks",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_webhook(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/webhooks",
+          query
+        )
+
+        request.perform
+      end
+
+      def get_webhook(webhook_id = nil, project_id = config.project_id)
+        webhook_id || raise_parameter_is_required_error(:webhook_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/webhooks/#{webhook_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_webhook(webhook_id = nil, project_id = config.project_id)
+        webhook_id || raise_parameter_is_required_error(:webhook_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/webhooks/#{webhook_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_screenshot(webhook_id = nil, query = {}, project_id = config.project_id)
+        webhook_id || raise_parameter_is_required_error(:webhook_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :patch,
+          "/projects/#{project_id}/webhooks/#{webhook_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    # -- For Enterprise mode only --
+    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 = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        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

data/lib/crowdin-api/client/client.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+#
+# A wrapper and interface to the Crowdin API. Please visit the Crowdin developers site
+# for a full explanation of what each of the Crowdin api methods expect and perform.
+#
+# https://support.crowdin.com/api/v2/
+# https://support.crowdin.com/enterprise/api/
+#
+module Crowdin
+  #
+  # === Example
+  #
+  #  require 'crowdin-api'
+  #
+  #  crowdin = Crowdin::Client.new do |config|
+  #    config.api_token = 'YOUR_API_TOKEN'
+  #  end
+  #
+  #  crowdin.list_projects
+  #
+  class Client
+    extend Utils
+
+    # API Resources modules
+    API_RESOURCES_MODULES = %i[Storages Languages Projects Workflows SourceFiles Translations SourceStrings
+                               StringTranslations StringComments Screenshots Glossaries TranslationMemory
+                               MachineTranslationEngines Reports Tasks Users Teams Vendors Webhooks
+                               Dictionaries Distributions Labels TranslationStatus].freeze
+
+    # Error Raisers modules
+    ERROR_RAISERS_MODULES = %i[ApiErrorsRaiser ClientErrorsRaiser].freeze
+
+    # Processing all API Resources modules to include them to the Client
+    API_RESOURCES_MODULES.each do |module_name|
+      Client.send(:include, fetch_module_full_name_from_string("Crowdin::ApiResources::#{module_name}"))
+    end
+
+    # Processing all Error Raisers modules to include them to the Client
+    ERROR_RAISERS_MODULES.each do |module_name|
+      Client.send(:include, fetch_module_full_name_from_string("Crowdin::Errors::#{module_name}"))
+    end
+
+    attr_reader :config
+    attr_reader :connection
+    attr_reader :options
+    attr_reader :logger
+
+    def initialize(&block)
+      build_configuration(&block)
+
+      check_logger
+      check_rest_client_proxy
+
+      build_connection
+    end
+
+    def log!(message)
+      !config.logger_enabled? || logger.debug(message)
+    end
+
+    def logger=(logger)
+      raise_logger_are_not_enabled_error unless config.logger_enabled?
+      @logger = logger
+    end
+
+    private
+
+    def build_configuration
+      @config = Crowdin::Configuration.new
+      yield config if block_given?
+    end
+
+    def build_connection
+      @connection ||= ::RestClient::Resource.new(config.base_url, build_options)
+    end
+
+    def build_options
+      @options ||= config.options.merge(headers: config.headers)
+    end
+
+    def set_default_logger
+      require 'logger'
+      @logger ||= Logger.new($stderr)
+    end
+
+    def check_rest_client_proxy
+      ENV['http_proxy'] ? ::RestClient.proxy = ENV['http_proxy'] : false
+    end
+
+    def check_logger
+      config.logger_enabled? ? set_default_logger : config.enable_logger = false
+    end
+  end
+end

data/lib/crowdin-api/client/configuration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Crowdin
+  class Configuration
+    attr_accessor :api_token
+    attr_accessor :project_id
+    attr_accessor :organization_domain
+    attr_accessor :enable_logger
+
+    attr_reader :target_api_url
+
+    alias logger_enabled? enable_logger
+
+    def initialize
+      @target_api_url = '/api/v2'
+    end
+
+    def options
+      {
+        headers: {},
+        timeout: nil,
+        json:    true
+      }
+    end
+
+    def headers
+      {
+        'Accept'        => 'application/json',
+        'Authorization' => "Bearer #{api_token}",
+        'Content-Type'  => 'application/json',
+        'User-Agent'    => "crowdin-rb/#{Crowdin::Client::VERSION}/#{RUBY_VERSION}/#{RUBY_PLATFORM}"
+      }
+    end
+
+    def base_url
+      if enterprise_mode?
+        organization_domain.include?('.com') ? organization_domain : "https://#{organization_domain}.api.crowdin.com"
+      else
+        'https://api.crowdin.com'
+      end
+    end
+
+    def organization_domain?
+      !!organization_domain
+    end
+    alias enterprise_mode? organization_domain?
+  end
+end

data/lib/crowdin-api/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Crowdin
+  class Client
+    VERSION = '1.2.0'
+  end
+end

data/lib/crowdin-api/core/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Errors
+    class OnlyForEnterpriseModeError < StandardError; end
+    class LoggerAreNotEnabledError   < StandardError; end
+  end
+end

data/lib/crowdin-api/core/errors_raisers.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Errors
+    # Client errors raiser
+    module ClientErrorsRaiser
+      def raise_logger_are_not_enabled_error
+        raise(LoggerAreNotEnabledError, 'Logger are not enabled in your Client configuration, enable it ' \
+                                        'before setting your own logger')
+      end
+    end
+
+    # Command-Line Client errors raiser
+    module ClcErrorsRaiser
+      def raise_api_token_is_required_error
+        raise(ArgumentError, '--api-token option is required')
+      end
+
+      def raise_organization_domain_is_required_error
+        raise(ArgumentError, '--organization-domain option is required for Enterprise mode')
+      end
+    end
+
+    # API errors raiser
+    module ApiErrorsRaiser
+      def raise_only_for_enterprise_mode_error
+        raise(OnlyForEnterpriseModeError, 'This method can be called only for Enterprise mode')
+      end
+
+      def raise_project_id_is_required_error
+        raise(ArgumentError, ':project_id is required in parameters or while Client initialization')
+      end
+
+      def raise_parameter_is_required_error(parameter)
+        raise(ArgumentError, ":#{parameter} is required")
+      end
+    end
+  end
+end