crowdin-api 0.6.0 → 1.2.0

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

@@ -0,0 +1,118 @@
+# 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 request proccessing. 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 response proccessing. 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
+        destination = @destination || download.meta['content-disposition']
+                                              .match(/filename=("?)(.+)\1/)[2]
+
+        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/core/utils.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Utils
+    # Method for extract module namespaces from a string
+    def fetch_module_full_name_from_string(string)
+      string.split('::').inject(Module) { |acc, val| acc.const_get(val) }
+    end
+  end
+end

data/lib/crowdin-api.rb

@@ -1,129 +1,42 @@
+# 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,
-        :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.request.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/errors_raisers'
+require 'crowdin-api/core/request'
+require 'crowdin-api/core/utils'
+
+# API modules
+require 'crowdin-api/api-resources/storages'
+require 'crowdin-api/api-resources/languages'
+require 'crowdin-api/api-resources/projects'
+require 'crowdin-api/api-resources/workflows'
+require 'crowdin-api/api-resources/source_files'
+require 'crowdin-api/api-resources/translations'
+require 'crowdin-api/api-resources/source_strings'
+require 'crowdin-api/api-resources/string_translations'
+require 'crowdin-api/api-resources/string_comments'
+require 'crowdin-api/api-resources/screenshots'
+require 'crowdin-api/api-resources/glossaries'
+require 'crowdin-api/api-resources/translation_memory'
+require 'crowdin-api/api-resources/machine_translation_engines'
+require 'crowdin-api/api-resources/reports'
+require 'crowdin-api/api-resources/tasks'
+require 'crowdin-api/api-resources/users'
+require 'crowdin-api/api-resources/teams'
+require 'crowdin-api/api-resources/vendors'
+require 'crowdin-api/api-resources/webhooks'
+require 'crowdin-api/api-resources/dictionaries'
+require 'crowdin-api/api-resources/distributions'
+require 'crowdin-api/api-resources/labels'
+require 'crowdin-api/api-resources/translation_status'
+
+# Client modules
+require 'crowdin-api/client/version'
+require 'crowdin-api/client/configuration'
+require 'crowdin-api/client/client'

data/spec/client/client-instance_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+describe 'Config instance' do
+  before do
+    @crowdin = Crowdin::Client.new do |config|
+      config.api_token  = 'api_token'
+      config.project_id = 1
+    end
+  end
+
+  it 'should have a version' do
+    expect(Crowdin::Client::VERSION).to_not be_nil
+  end
+end

data/spec/client/configuration-instance_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+describe 'Config instance' do
+  before do
+    @crowdin = Crowdin::Client.new do |config|
+      config.api_token  = 'api_token'
+      config.project_id = 1
+    end
+  end
+
+  it 'should have a #project_id' do
+    expect(@crowdin.config.project_id).to_not be_nil
+  end
+
+  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 equal false by default' do
+      expect(@crowdin.config.logger_enabled?).to be_falsey
+    end
+
+    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
+
+  describe '#enterprise_mode?' do
+    it 'should equal false by default' do
+      expect(@crowdin.config.enterprise_mode?).to be_falsey
+    end
+
+    it 'should equal true if user specify organization domain' do
+      @crowdin = Crowdin::Client.new do |config|
+        config.organization_domain = 'organization_domain'
+      end
+
+      expect(@crowdin.config.enterprise_mode?).to be_truthy
+    end
+  end
+
+  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
+
+    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

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

metadata

@@ -1,141 +1,224 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: open-uri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.32
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.32
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
-    - - ">="
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
-    - - ">="
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
-description: Ruby Client for the Crowdin API
+        version: '3.14'
+description: The Crowdin Ruby Client is used to interact with the Crowdin API from
+  Ruby
 email:
-- support@crowdin.net
-executables: []
+- support@crowdin.com
+executables:
+- crowdin-console
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE
+extra_rdoc_files: []
 files:
+- ".github/workflows/build-and-publish.yml"
+- ".github/workflows/test-and-lint.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
+- bin/crowdin-console
+- bin/setup
+- crowdin-api.gemspec
 - lib/crowdin-api.rb
-- lib/crowdin-api/errors.rb
-- lib/crowdin-api/methods.rb
-- lib/crowdin-api/version.rb
-homepage: https://github.com/crowdin/crowdin-api/
+- lib/crowdin-api/api-resources/dictionaries.rb
+- lib/crowdin-api/api-resources/distributions.rb
+- lib/crowdin-api/api-resources/glossaries.rb
+- lib/crowdin-api/api-resources/labels.rb
+- lib/crowdin-api/api-resources/languages.rb
+- lib/crowdin-api/api-resources/machine_translation_engines.rb
+- lib/crowdin-api/api-resources/projects.rb
+- lib/crowdin-api/api-resources/reports.rb
+- lib/crowdin-api/api-resources/screenshots.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/string_comments.rb
+- lib/crowdin-api/api-resources/string_translations.rb
+- lib/crowdin-api/api-resources/tasks.rb
+- lib/crowdin-api/api-resources/teams.rb
+- lib/crowdin-api/api-resources/translation_memory.rb
+- lib/crowdin-api/api-resources/translation_status.rb
+- lib/crowdin-api/api-resources/translations.rb
+- lib/crowdin-api/api-resources/users.rb
+- lib/crowdin-api/api-resources/vendors.rb
+- lib/crowdin-api/api-resources/webhooks.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/errors.rb
+- lib/crowdin-api/core/errors_raisers.rb
+- lib/crowdin-api/core/request.rb
+- lib/crowdin-api/core/utils.rb
+- spec/client/client-instance_spec.rb
+- spec/client/configuration-instance_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/crowdin/crowdin-api-client-ruby
 licenses:
 - MIT
 metadata: {}
@@ -147,15 +230,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+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: []