crowdin-api 0.4.1 → 1.1.0

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

@@ -0,0 +1,160 @@
+# 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(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,
+          :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 = {}, 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
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+#
+# The Crowdin::Client library is used for interactions with a crowdin.com website.
+#
+# == Example
+#
+#  require 'crowdin-api'
+#
+#  crowdin = Crowdin::Client.new do |config|
+#    config.api_token = 'YOUR_API_TOKEN'
+#  end
+#
+#  crowdin.list_projects
+#
+module Crowdin
+  class Client
+    # 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/
+    #
+    include ApiResources::Languages
+    include ApiResources::Projects
+    include ApiResources::SourceFiles
+    include ApiResources::Storages
+    include ApiResources::TranslationStatus
+    include ApiResources::Translations
+    include ApiResources::Workflows
+    include ApiResources::SourceStrings
+
+    include Errors::ApiErrorsRaiser
+
+    attr_accessor :logger
+
+    attr_reader :config
+    attr_reader :connection
+    attr_reader :options
+
+    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
+
+    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,44 @@
+# 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
+    alias enterprise_mode? organization_domain
+
+    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
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Errors
+    module ApiErrorsRaiser
+      def raise_only_for_enterprise_mode_error
+        raise(OnlyForEnterpriseMode, '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
+
+      # crowdin-console errors
+
+      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
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Errors
+    class OnlyForEnterpriseMode < StandardError; end
+  end
+end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Web
+    class Request
+      attr_reader :client
+
+      def initialize(client, method, path, query = {}, headers = {}, destination = nil)
+        @client      = client
+        @method      = method
+        @full_path   = client.config.target_api_url + path
+        @payload     = perform_payload(query)
+        @headers     = headers
+        @destination = destination
+        @errors      = []
+      end
+
+      def perform
+        process_request!
+        process_response!
+      end
+
+      private
+
+      def process_request!
+        return @response = client.connection[@full_path].delete        if delete_request?
+        return @response = client.connection[@full_path].get(@payload) if get_request?
+
+        client.connection[@full_path].send(@method, @payload, @headers) { |response, _, _| @response = response }
+      rescue StandardError => error
+        client.log! error
+
+        @errors << "Something went wrong while proccessing request. Details - #{error.class}"
+      end
+
+      def process_response!
+        return fetch_errors if @errors.any?
+
+        begin
+          if @response
+            client.log! "args: #{@response.request.args}"
+
+            if @response.body.empty?
+              @response.code
+            else
+              doc = JSON.parse(@response.body)
+
+              client.log! "body: #{doc}"
+
+              data = fetch_response_data(doc)
+
+              @errors.any? ? fetch_errors : data
+            end
+          end
+        rescue StandardError => error
+          client.log! error
+
+          @errors << "Something went wrong while proccessing response. Details - #{error.class}"
+
+          fetch_errors
+        end
+      end
+
+      def perform_payload(query)
+        return query if query.is_a?(File)
+
+        get_request? ? { params: fetch_cleared_query(query) } : fetch_cleared_query(query).to_json
+      end
+
+      def download_file(url)
+        download = URI.parse(url).open
+        IO.copy_stream(download, @destination)
+
+        @destination
+      rescue StandardError => error
+        client.log! error
+
+        @errors << "Something went wrong while downloading file. Details - #{error.class}"
+      end
+
+      def fetch_errors
+        @errors.join(';')
+      end
+
+      def fetch_response_data(doc)
+        if doc['data'].is_a?(Hash) && doc['data']['url'] && doc['data']['url'].include?('response-content-disposition')
+          download_file(doc['data']['url'])
+        else
+          doc
+        end
+      end
+
+      def fetch_cleared_query(query)
+        case query
+        when Array
+          query.map do |el|
+            el.reject { |_, value| value.nil? }
+          end.reject(&:empty?)
+        when Hash
+          query.reject { |_, value| value.nil? }
+        else
+          query
+        end
+      end
+
+      def get_request?
+        @method.eql?(:get)
+      end
+
+      def delete_request?
+        @method.eql?(:delete)
+      end
+    end
+  end
+end

data/lib/crowdin-api.rb

@@ -1,130 +1,26 @@
+# frozen_string_literal: true
+
+# Libs
 require 'json'
+require 'open-uri'
 require 'rest-client'
-# require 'byebug'
-
-require "crowdin-api/errors"
-require "crowdin-api/methods"
-require "crowdin-api/version"
-
-
-# The Crowdin::API library is used for interactions with a crowdin.com website.
-#
-# == Example
-#
-#   require 'crowdin-api'
-#   require 'logger'
-#
-#   crowdin = Crowdin::API.new(:api_key => API_KEY, :project_id => PROJECT_ID)
-#   crowdin.log = Logger.new($stderr)
-#
-module Crowdin
-  class API
-
-    class << self
-      # Default logger for all Crowdin::API instances
-      #
-      #   Crowdin::API.log = Logger.new($stderr)
-      #
-      attr_accessor :log
-    end
-
-    # Create a new API object using the given parameters.
-    #
-    # @param [String] api_key the authentication API key can be found on the project settings page
-    # @param [String] project_id the project identifier.
-    # @param [String] account_key the account API Key
-    # @param [String] base_url the url of the Crowdin API
-    #
-    def initialize(options = {})
-      @api_key     = options.delete(:api_key)
-      @project_id  = options.delete(:project_id)
-      @account_key = options.delete(:account_key)
-      @base_url    = options.delete(:base_url) || 'https://api.crowdin.com'
-
-      @log = nil
-
-      options = {
-        :headers                => {},
-        :params                 => {},
-        :timeout                => nil,
-        :open_timeout           => nil,
-        :key                    => @api_key,
-        :'account-key'          => @account_key,
-        :json                   => true
-      }.merge(options)
-
-      options[:headers] = {
-        'Accept'                => 'application/json',
-        'User-Agent'            => "crowdin-rb/#{Crowdin::API::VERSION}",
-        'X-Ruby-Version'        => RUBY_VERSION,
-        'X-Ruby-Platform'       => RUBY_PLATFORM
-      }.merge(options[:headers])
-
-      options[:params] = {
-        :key                    => @api_key,
-        :'account-key'          => @account_key,
-        :json                   => true
-      }.merge(options[:params])
-
-      RestClient.proxy = ENV['http_proxy'] if ENV['http_proxy']
-      @connection = RestClient::Resource.new(@base_url, options)
-    end
-
-    def request(params, &block)
-      # Returns a query hash with non nil values.
-      params[:query].reject! { |_, value| value.nil? } if params[:query]
-
-      case params[:method]
-      when :post
-        query = @connection.options.merge(params[:query] || {})
-        @connection[params[:path]].post(query) { |response, _, _|
-          @response = response
-        }
-      when :get
-        query = @connection.options[:params].merge(params[:query] || {})
-        @connection[params[:path]].get(:params => query) { |response, _, _|
-          @response = response
-        }
-      end
-
-      log.debug("args: #{@response.args}") if log
-
-      if @response.headers[:content_disposition]
-        filename = params[:output] || @response.headers[:content_disposition][/attachment; filename="(.+?)"/, 1]
-        body = @response.body
-        file = open(filename, 'wb')
-        file.write(body)
-        file.close
-        return true
-      else
-        doc = JSON.load(@response.body)
-        log.debug("body: #{doc}") if log
-
-        if doc.kind_of?(Hash) && doc['success'] == false
-          code    = doc['error']['code']
-          message = doc['error']['message']
-          error   = Crowdin::API::Errors::Error.new(code, message)
-          raise(error)
-        else
-          return doc
-        end
-      end
-
-    end
-
-    # The current logger. If no logger has been set Crowdin::API.log is used.
-    #
-    def log
-      @log || Crowdin::API.log
-    end
-
-    # Sets the +logger+ used by this instance of Crowdin::API
-    #
-    def log= logger
-      @log = logger
-    end
-
-    private
 
-  end
-end
+# Core modules
+require 'crowdin-api/core/errors'
+require 'crowdin-api/core/api_errors_raiser'
+require 'crowdin-api/core/request'
+
+# Api modules
+require 'crowdin-api/api-resources/languages'
+require 'crowdin-api/api-resources/projects'
+require 'crowdin-api/api-resources/source_files'
+require 'crowdin-api/api-resources/storages'
+require 'crowdin-api/api-resources/translation_status'
+require 'crowdin-api/api-resources/translations'
+require 'crowdin-api/api-resources/workflows'
+require 'crowdin-api/api-resources/source_strings'
+
+# Client
+require 'crowdin-api/client/version'
+require 'crowdin-api/client/configuration'
+require 'crowdin-api/client/client'