crowdin-api 1.1.1 → 1.2.0

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

@@ -2,6 +2,7 @@
 
 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
@@ -32,6 +33,8 @@ module Crowdin
       end
 
       def list_workflow_templates(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
         request = Web::Request.new(
           self,
           :get,

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

@@ -1,42 +1,50 @@
 # frozen_string_literal: true
 
 #
-# The Crowdin::Client library is used for interactions with a crowdin.com website.
+# 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.
 #
-# == Example
-#
-#  require 'crowdin-api'
-#
-#  crowdin = Crowdin::Client.new do |config|
-#    config.api_token = 'YOUR_API_TOKEN'
-#  end
-#
-#  crowdin.list_projects
+# 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
-    # 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
+    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)
@@ -51,6 +59,11 @@ module Crowdin
       !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

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

@@ -9,8 +9,7 @@ module Crowdin
 
     attr_reader :target_api_url
 
-    alias logger_enabled?  enable_logger
-    alias enterprise_mode? organization_domain
+    alias logger_enabled? enable_logger
 
     def initialize
       @target_api_url = '/api/v2'
@@ -20,16 +19,16 @@ module Crowdin
       {
         headers: {},
         timeout: nil,
-        json: true
+        json:    true
       }
     end
 
     def headers
       {
-        'Accept' => 'application/json',
+        'Accept'        => 'application/json',
         'Authorization' => "Bearer #{api_token}",
-        'Content-Type' => 'application/json',
-        'User-Agent' => "crowdin-rb/#{Crowdin::Client::VERSION}/#{RUBY_VERSION}/#{RUBY_PLATFORM}"
+        'Content-Type'  => 'application/json',
+        'User-Agent'    => "crowdin-rb/#{Crowdin::Client::VERSION}/#{RUBY_VERSION}/#{RUBY_PLATFORM}"
       }
     end
 
@@ -40,5 +39,10 @@ module Crowdin
         '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

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.1.1'
+    VERSION = '1.2.0'
   end
 end

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

@@ -2,6 +2,7 @@
 
 module Crowdin
   module Errors
-    class OnlyForEnterpriseMode < StandardError; end
+    class OnlyForEnterpriseModeError < StandardError; end
+    class LoggerAreNotEnabledError   < StandardError; end
   end
 end

data/lib/crowdin-api/core/{api_errors_raiser.rb → errors_raisers.rb}

@@ -2,9 +2,29 @@
 
 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(OnlyForEnterpriseMode, 'This method can be called only for Enterprise mode')
+        raise(OnlyForEnterpriseModeError, 'This method can be called only for Enterprise mode')
       end
 
       def raise_project_id_is_required_error
@@ -14,16 +34,6 @@ module Crowdin
       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/request.rb

@@ -30,7 +30,7 @@ module Crowdin
       rescue StandardError => error
         client.log! error
 
-        @errors << "Something went wrong while proccessing request. Details - #{error.class}"
+        @errors << "Something went wrong while request proccessing. Details - #{error.class}"
       end
 
       def process_response!
@@ -55,7 +55,7 @@ module Crowdin
         rescue StandardError => error
           client.log! error
 
-          @errors << "Something went wrong while proccessing response. Details - #{error.class}"
+          @errors << "Something went wrong while response proccessing. Details - #{error.class}"
 
           fetch_errors
         end
@@ -68,7 +68,7 @@ module Crowdin
       end
 
       def download_file(url)
-        download = URI.parse(url).open
+        download    = URI.parse(url).open
         destination = @destination || download.meta['content-disposition']
                                               .match(/filename=("?)(.+)\1/)[2]
 

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

@@ -7,20 +7,36 @@ require 'rest-client'
 
 # Core modules
 require 'crowdin-api/core/errors'
-require 'crowdin-api/core/api_errors_raiser'
+require 'crowdin-api/core/errors_raisers'
 require 'crowdin-api/core/request'
+require 'crowdin-api/core/utils'
 
-# Api modules
+# 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/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'
+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
+# 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/{core/config-instance_spec.rb → client/configuration-instance_spec.rb}

@@ -8,7 +8,7 @@ describe 'Config instance' do
     end
   end
 
-  it 'show have a #project_id' do
+  it 'should have a #project_id' do
     expect(@crowdin.config.project_id).to_not be_nil
   end
 
@@ -16,12 +16,12 @@ describe 'Config instance' do
     expect(@crowdin.config.api_token).to_not be_nil
   end
 
-  it '#target_api_url should equal /api/v2 by default' do
+  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
+    it 'should equal false by default' do
       expect(@crowdin.config.logger_enabled?).to be_falsey
     end
 
@@ -35,11 +35,11 @@ describe 'Config instance' do
   end
 
   describe '#enterprise_mode?' do
-    it 'should be false by default' do
+    it 'should equal false by default' do
       expect(@crowdin.config.enterprise_mode?).to be_falsey
     end
 
-    it 'should equal specified arguments' do
+    it 'should equal true if user specify organization domain' do
       @crowdin = Crowdin::Client.new do |config|
         config.organization_domain = 'organization_domain'
       end
@@ -49,7 +49,7 @@ describe 'Config instance' do
   end
 
   describe '#base_url' do
-    it 'should equal https://api.crowdin.com by default' do
+    it 'should equal \'https://api.crowdin.com\' by default' do
       expect(@crowdin.config.base_url).to eq('https://api.crowdin.com')
     end
 
@@ -61,7 +61,7 @@ describe 'Config instance' do
       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
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -185,22 +185,38 @@ files:
 - bin/setup
 - crowdin-api.gemspec
 - lib/crowdin-api.rb
+- 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/api_errors_raiser.rb
 - lib/crowdin-api/core/errors.rb
+- lib/crowdin-api/core/errors_raisers.rb
 - lib/crowdin-api/core/request.rb
-- spec/core/config-instance_spec.rb
-- spec/crowdin-api_spec.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:

data/spec/crowdin-api_spec.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-describe Crowdin::Client do
-  it 'should have a version' do
-    expect(Crowdin::Client::VERSION).to_not be_nil
-  end
-end