crowdin-api 1.0.0 → 1.1.0

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

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
+#
 # The Crowdin::Client library is used for interactions with a crowdin.com website.
 #
 # == Example
 #
-#   require 'crowdin-api'
+#  require 'crowdin-api'
+#
+#  crowdin = Crowdin::Client.new do |config|
+#    config.api_token = 'YOUR_API_TOKEN'
+#  end
 #
-#   crowdin = Crowdin::Client.new do |config|
-#     config.api_token = 'YOUR_API_TOKEN'
-#   end
+#  crowdin.list_projects
 #
 module Crowdin
   class Client
@@ -24,59 +27,56 @@ module Crowdin
     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 :options
     attr_reader :connection
+    attr_reader :options
 
-    def initialize
-      raise ArgumentError, 'block with configurations not given' unless block_given?
-
-      @config = Crowdin::Configuration.new
-      yield config
+    def initialize(&block)
+      build_configuration(&block)
 
       check_logger
+      check_rest_client_proxy
 
-      set_rest_client_proxy!
-
-      build_options
       build_connection
     end
 
     def log!(message)
-      return true unless config.logger_enabled?
-
-      logger.debug(message)
+      !config.logger_enabled? || logger.debug(message)
     end
 
-    def logger=(logger)
-      @logger = logger
-      config.enable_logger = true
+    private
+
+    def build_configuration
+      @config = Crowdin::Configuration.new
+      yield config if block_given?
     end
 
-    protected
+    def build_connection
+      @connection ||= ::RestClient::Resource.new(config.base_url, build_options)
+    end
 
     def build_options
-      @options = config.options
-      options[:headers] = config.headers
+      @options ||= config.options.merge(headers: config.headers)
     end
 
-    def build_connection
-      @connection = ::RestClient::Resource.new(config.base_url, options)
+    def set_default_logger
+      require 'logger'
+      @logger ||= Logger.new($stderr)
     end
 
-    private
-
-    def set_rest_client_proxy!
+    def check_rest_client_proxy
       ENV['http_proxy'] ? ::RestClient.proxy = ENV['http_proxy'] : false
     end
 
     def check_logger
-      config.enable_logger ||= false
-    end
-
-    def logger
-      @logger ||= Logger.new($stderr)
+      config.logger_enabled? ? set_default_logger : config.enable_logger = false
     end
   end
 end

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

@@ -9,6 +9,9 @@ module Crowdin
 
     attr_reader :target_api_url
 
+    alias logger_enabled?  enable_logger
+    alias enterprise_mode? organization_domain
+
     def initialize
       @target_api_url = '/api/v2'
     end
@@ -31,11 +34,11 @@ module Crowdin
     end
 
     def base_url
-      organization_domain ? "https://#{organization_domain}.api.crowdin.com" : 'https://api.crowdin.com'
-    end
-
-    def logger_enabled?
-      enable_logger
+      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

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.0.0'
+    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

@@ -2,19 +2,6 @@
 
 module Crowdin
   module Errors
-    class Error < StandardError
-      attr_reader :key, :error_code, :error_message
-
-      def initialize(key, error_code, error_message)
-        @key           = key
-        @error_code    = error_code.to_i
-        @error_message = error_message
-        @message       = "#{key} => #{error_code}: #{error_message}"
-      end
-
-      def to_s
-        @message
-      end
-    end
+    class OnlyForEnterpriseMode < StandardError; end
   end
 end

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

@@ -9,7 +9,7 @@ module Crowdin
         @client      = client
         @method      = method
         @full_path   = client.config.target_api_url + path
-        @payload     = Payload.new(method, query).perform
+        @payload     = perform_payload(query)
         @headers     = headers
         @destination = destination
         @errors      = []
@@ -20,13 +20,15 @@ module Crowdin
         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.class
+        client.log! error
 
         @errors << "Something went wrong while proccessing request. Details - #{error.class}"
       end
@@ -36,14 +38,19 @@ module Crowdin
 
         begin
           if @response
-            doc = JSON.parse(@response.body)
-
             client.log! "args: #{@response.request.args}"
-            client.log! "body: #{doc}"
 
-            data = fetch_response_data(doc)
+            if @response.body.empty?
+              @response.code
+            else
+              doc = JSON.parse(@response.body)
+
+              client.log! "body: #{doc}"
 
-            @errors.any? ? fetch_errors : data
+              data = fetch_response_data(doc)
+
+              @errors.any? ? fetch_errors : data
+            end
           end
         rescue StandardError => error
           client.log! error
@@ -54,10 +61,10 @@ module Crowdin
         end
       end
 
-      private
+      def perform_payload(query)
+        return query if query.is_a?(File)
 
-      def fetch_errors
-        @errors.join(';')
+        get_request? ? { params: fetch_cleared_query(query) } : fetch_cleared_query(query).to_json
       end
 
       def download_file(url)
@@ -71,14 +78,31 @@ module Crowdin
         @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'].scan(/response-content-disposition/)
+        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

data/lib/crowdin-api.rb

@@ -2,14 +2,13 @@
 
 # Libs
 require 'json'
-require 'logger'
 require 'open-uri'
 require 'rest-client'
 
 # Core modules
-require 'crowdin-api/core/payload'
-require 'crowdin-api/core/request'
 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'
@@ -18,6 +17,8 @@ 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'

data/spec/core/config-instance_spec.rb

@@ -1,35 +1,72 @@
 # frozen_string_literal: true
 
 describe 'Config instance' do
-  it 'should have a project_id' do
+  before do
     @crowdin = Crowdin::Client.new do |config|
+      config.api_token  = 'api_token'
       config.project_id = 1
     end
+  end
 
+  it 'show have a #project_id' do
     expect(@crowdin.config.project_id).to_not be_nil
   end
 
-  it 'should have a api_token' do
-    @crowdin = Crowdin::Client.new do |config|
-      config.api_token = 'api_token'
+  it 'should have a #api_token' do
+    expect(@crowdin.config.api_token).to_not be_nil
+  end
+
+  it '#target_api_url should equal /api/v2 by default' do
+    expect(@crowdin.config.target_api_url).to eq('/api/v2')
+  end
+
+  describe '#logger_enabled?' do
+    it 'should be false by default' do
+      expect(@crowdin.config.logger_enabled?).to be_falsey
     end
 
-    expect(@crowdin.config.api_token).to_not be_nil
+    it 'should equal specified argument' do
+      @crowdin = Crowdin::Client.new do |config|
+        config.enable_logger = true
+      end
+
+      expect(@crowdin.config.logger_enabled?).to be_truthy
+    end
   end
 
-  it 'should have a base_url' do
-    @crowdin = Crowdin::Client.new do |config|
-      config.api_token = 'api_token'
+  describe '#enterprise_mode?' do
+    it 'should be false by default' do
+      expect(@crowdin.config.enterprise_mode?).to be_falsey
     end
 
-    expect(@crowdin.config.base_url).to_not be_nil
+    it 'should equal specified arguments' do
+      @crowdin = Crowdin::Client.new do |config|
+        config.organization_domain = 'organization_domain'
+      end
+
+      expect(@crowdin.config.enterprise_mode?).to be_truthy
+    end
   end
 
-  it 'should have a enable_logger set to false by default' do
-    @crowdin = Crowdin::Client.new do |config|
-      config.api_token = 'api_token'
+  describe '#base_url' do
+    it 'should equal https://api.crowdin.com by default' do
+      expect(@crowdin.config.base_url).to eq('https://api.crowdin.com')
     end
 
-    expect(@crowdin.config.enable_logger).eql? false
+    it 'should equal specified organization domain' do
+      @crowdin = Crowdin::Client.new do |config|
+        config.organization_domain = 'organization_domain'
+      end
+
+      expect(@crowdin.config.base_url).to eq('https://organization_domain.api.crowdin.com')
+    end
+
+    it 'should equal full specified organization domain when user specify full url (with .com)' do
+      @crowdin = Crowdin::Client.new do |config|
+        config.organization_domain = 'organization_domain.com'
+      end
+
+      expect(@crowdin.config.base_url).to eq('organization_domain.com')
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
 # frozen_string_literal: true
 
+require 'simplecov'
+SimpleCov.start
+
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov
+
 require 'crowdin-api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -70,6 +70,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.32
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -146,9 +160,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.14'
-description: Ruby Client for the Crowdin API. Documentation - https://support.crowdin.com/api/v2/.
+description: The Crowdin Ruby Client is used to interact with the Crowdin API from
+  Ruby
 email:
-- support@crowdin.net
+- support@crowdin.com
 executables:
 - crowdin-console
 extensions: []
@@ -173,19 +188,21 @@ files:
 - lib/crowdin-api/api-resources/languages.rb
 - lib/crowdin-api/api-resources/projects.rb
 - lib/crowdin-api/api-resources/source_files.rb
+- lib/crowdin-api/api-resources/source_strings.rb
 - lib/crowdin-api/api-resources/storages.rb
 - lib/crowdin-api/api-resources/translation_status.rb
 - lib/crowdin-api/api-resources/translations.rb
+- lib/crowdin-api/api-resources/workflows.rb
 - lib/crowdin-api/client/client.rb
 - lib/crowdin-api/client/configuration.rb
 - lib/crowdin-api/client/version.rb
+- lib/crowdin-api/core/api_errors_raiser.rb
 - lib/crowdin-api/core/errors.rb
-- lib/crowdin-api/core/payload.rb
 - lib/crowdin-api/core/request.rb
 - spec/core/config-instance_spec.rb
 - spec/crowdin-api_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/crowdin/crowdin-api/
+homepage: https://github.com/crowdin/crowdin-api-client-ruby
 licenses:
 - MIT
 metadata: {}
@@ -197,7 +214,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -207,5 +224,5 @@ requirements: []
 rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: Client library to manage translations on Crowdin
+summary: Ruby Client for the Crowdin API
 test_files: []

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module Web
-    class Payload
-      attr_reader :method, :query
-
-      def initialize(method, query)
-        @method = method
-        @query  = query
-      end
-
-      def perform
-        return @query if @query.is_a?(File)
-
-        @method.eql?(:get) ? { params: fetch_cleared_query } : fetch_cleared_query.to_json
-      end
-
-      private
-
-      def fetch_cleared_query
-        @query.reject { |_, value| value.nil? }
-      end
-    end
-  end
-end