crowdin-api 1.1.1 → 1.3.0

data/spec/api_resources/workflows_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Workflows do
+  describe 'Enterprise endpoints' do
+    describe '#list_workflow_steps' do
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/projects/#{project_id}/workflow-steps")
+        list_workflow_steps = @crowdin.list_workflow_steps({}, project_id)
+        expect(list_workflow_steps).to eq(200)
+      end
+    end
+
+    describe '#get_workflow_step' do
+      let(:step_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/projects/#{project_id}/workflow-steps/#{step_id}")
+        get_workflow_step = @crowdin.get_workflow_step(step_id, project_id)
+        expect(get_workflow_step).to eq(200)
+      end
+    end
+
+    describe '#list_workflow_templates' do
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/workflow-templates")
+        list_workflow_templates = @crowdin.list_workflow_templates
+        expect(list_workflow_templates).to eq(200)
+      end
+    end
+
+    describe '#get_workflow_template' do
+      let(:template_id) { 1 }
+
+      it 'when request are valid', :enterprise do
+        stub_request(:get, "https://domain.api.crowdin.com/#{target_api_url}/workflow-templates/#{template_id}")
+        get_workflow_template = @crowdin.get_workflow_template(template_id)
+        expect(get_workflow_template).to eq(200)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,27 @@
 # frozen_string_literal: true
 
 require 'simplecov'
-SimpleCov.start
-
 require 'codecov'
+
+SimpleCov.start
 SimpleCov.formatter = SimpleCov::Formatter::Codecov
 
+require 'webmock/rspec'
 require 'crowdin-api'
+
+RSpec.shared_context 'crowdin_client_options' do
+  let(:api_token) { 'api_token' }
+  let(:project_id) { 1 }
+  let(:organization_domain) { 'domain' }
+  let(:full_organization_domain) { 'domain.com' }
+  let(:target_api_url) { 'api/v2' }
+end
+
+RSpec.configure do |config|
+  config.include_context 'crowdin_client_options'
+
+  config.before(:each) do |spec|
+    @crowdin = Crowdin::Client.new { |cfg| cfg.organization_domain = 'domain' } if spec.metadata[:enterprise]
+    @crowdin = Crowdin::Client.new if spec.metadata[:default]
+  end
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+describe 'Crowdin Client' do
+  it 'should have a list of API Resources' do
+    expect(Crowdin::API_RESOURCES_MODULES).to_not be_nil
+  end
+
+  it 'should have a list of Error Raisers' do
+    expect(Crowdin::ERROR_RAISERS_MODULES).to_not be_nil
+  end
+
+  it 'should have a version' do
+    expect(Crowdin::Client::VERSION).to_not be_nil
+  end
+
+  describe 'Crowdin Client with a default options' do
+    it 'should have a RestClient connection', :default do
+      expect(@crowdin.connection.class).to eq(RestClient::Resource)
+    end
+
+    it 'should have options and headers for RestClient', :default do
+      expect(@crowdin.options.class).to eq(Hash)
+      expect(@crowdin.options).to include(:headers)
+    end
+
+    it 'should have a Config instance', :default do
+      expect(@crowdin.config.class).to eq(Crowdin::Configuration)
+    end
+
+    it 'should have a disabled Logger by default', :default do
+      expect(@crowdin.logger_enabled?).to be_falsey
+      expect(@crowdin.logger).to be_nil
+    end
+
+    it 'should have a disabled Enterprise mode by default', :default do
+      expect(@crowdin.enterprise_mode?).to be_falsey
+    end
+
+    it 'should have a default target api url', :default do
+      expect(@crowdin.config.target_api_url).to eq('/api/v2')
+    end
+    it 'should have a default base url', :default do
+      expect(@crowdin.config.base_url).to eq('https://api.crowdin.com')
+    end
+  end
+
+  describe 'Crowdin Client with enabled Logger' do
+    before do
+      @crowdin = Crowdin::Client.new do |config|
+        config.enable_logger = true
+      end
+    end
+
+    it 'should have a Logger instance' do
+      expect(@crowdin.logger_enabled?).to be_truthy
+      expect(@crowdin.logger.class).to eq(Logger)
+    end
+  end
+
+  describe 'Crowdin Client with enabled Enterprise mode' do
+    before do
+      @crowdin = Crowdin::Client.new do |config|
+        config.organization_domain = organization_domain
+      end
+    end
+
+    it 'should have a generated Enterprise url' do
+      expect(@crowdin.enterprise_mode?).to be_truthy
+      expect(@crowdin.config.base_url).to eq("https://#{organization_domain}.api.crowdin.com")
+    end
+  end
+
+  describe 'Crowdin Client with enabled Enterprise mode and specified full organization domain' do
+    before do
+      @crowdin = Crowdin::Client.new do |config|
+        config.organization_domain = full_organization_domain
+      end
+    end
+
+    it 'should have a generated Enterprise url' do
+      expect(@crowdin.enterprise_mode?).to be_truthy
+      expect(@crowdin.config.base_url).to eq("https://#{full_organization_domain}")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -84,6 +84,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -132,20 +146,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.23'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -182,26 +182,63 @@ files:
 - README.md
 - Rakefile
 - bin/crowdin-console
-- bin/setup
 - crowdin-api.gemspec
 - lib/crowdin-api.rb
-- 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/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/send_request.rb
+- spec/api_resources/dictionaries_spec.rb
+- spec/api_resources/distributions_spec.rb
+- spec/api_resources/glossaries_spec.rb
+- spec/api_resources/labels_spec.rb
+- spec/api_resources/languages_spec.rb
+- spec/api_resources/machine_translation_engines_spec.rb
+- spec/api_resources/projects_spec.rb
+- spec/api_resources/reports_spec.rb
+- spec/api_resources/screenshots_spec.rb
+- spec/api_resources/source_files_spec.rb
+- spec/api_resources/source_strings_spec.rb
+- spec/api_resources/storages_spec.rb
+- spec/api_resources/string_comments_spec.rb
+- spec/api_resources/string_translations_spec.rb
+- spec/api_resources/tasks_spec.rb
+- spec/api_resources/teams_spec.rb
+- spec/api_resources/translation_memory_spec.rb
+- spec/api_resources/translation_status_spec.rb
+- spec/api_resources/translations_spec.rb
+- spec/api_resources/users_spec.rb
+- spec/api_resources/vendors_spec.rb
+- spec/api_resources/webhooks_spec.rb
+- spec/api_resources/workflows_spec.rb
 - spec/spec_helper.rb
+- spec/unit/client_spec.rb
 homepage: https://github.com/crowdin/crowdin-api-client-ruby
 licenses:
 - MIT

data/bin/setup

@@ -1,6 +0,0 @@
-#!/bin/bash
-
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module ApiResources
-    module Languages
-      def list_languages(query = {})
-        request = Web::Request.new(
-          self,
-          :get,
-          '/languages',
-          query
-        )
-
-        request.perform
-      end
-
-      # Add custom language.
-      #
-      # === Parameters
-      #
-      # * +:name+ [String] - Language name
-      # * +:code+ [String] - Custom language code
-      # * +:localeCode+ [String] - Custom language locale code
-      # * +:textDirection+ [String ltr/rtl] - Text direction in custom language
-      # * +:pluralCategoryNames+ [String] - Array with category names
-      # * +:threeLettersCode+ [String] - Custom language 3 letters code. Format: ISO 6393 code
-      #
-      # === Example
-      #
-      #  crowdin.add_custom_language(name: 'your_name', code: 'your_code' ..)
-      #
-      def add_custom_language(query = {})
-        request = Web::Request.new(
-          self,
-          :post,
-          '/languages',
-          query
-        )
-
-        request.perform
-      end
-
-      def get_language(language_id = nil)
-        language_id || raise_parameter_is_required_error(:language_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/languages/#{language_id}"
-        )
-
-        request.perform
-      end
-
-      def delete_custom_language(language_id = nil)
-        language_id || raise_parameter_is_required_error(:language_id)
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/languages/#{language_id}"
-        )
-
-        request.perform
-      end
-
-      def edit_custom_language(language_id = nil)
-        language_id || raise_parameter_is_required_error(:language_id)
-
-        request = Web::Request.new(
-          self,
-          :patch,
-          "/languages/#{language_id}",
-          query
-        )
-
-        request.perform
-      end
-    end
-  end
-end

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

@@ -1,134 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module ApiResources
-    module Projects
-      def list_projects(query = {})
-        request = Web::Request.new(
-          self,
-          :get,
-          '/projects',
-          query
-        )
-
-        request.perform
-      end
-
-      def add_project(query = {})
-        request = Web::Request.new(
-          self,
-          :post,
-          '/projects',
-          query
-        )
-
-        request.perform
-      end
-
-      def get_project(project_id = nil)
-        project_id || raise_parameter_is_required_error(:project_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/projects/#{project_id}"
-        )
-
-        request.perform
-      end
-
-      def delete_project(project_id = nil)
-        project_id || raise_parameter_is_required_error(:project_id)
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/projects/#{project_id}"
-        )
-
-        request.perform
-      end
-
-      def edit_project(project_id = nil, query = {})
-        project_id || raise_parameter_is_required_error(:project_id)
-
-        request = Web::Request.new(
-          self,
-          :patch,
-          "/projects/#{project_id}",
-          query
-        )
-
-        request.perform
-      end
-
-      # For Enterprise mode only
-
-      def list_groups(query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-
-        request = Web::Request.new(
-          self,
-          :get,
-          '/groups',
-          query
-        )
-
-        request.perform
-      end
-
-      def add_group(query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-
-        request = Web::Request.new(
-          self,
-          :post,
-          '/groups',
-          query
-        )
-
-        request.perform
-      end
-
-      def get_group(group_id = nil)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        group_id                || raise_parameter_is_required_error(:group_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/groups/#{group_id}"
-        )
-
-        request.perform
-      end
-
-      def delete_group(group_id = nil)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        group_id                || raise_parameter_is_required_error(:group_id)
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/groups/#{group_id}"
-        )
-
-        request.perform
-      end
-
-      def edit_group(group_id = nil, query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        group_id                || raise_parameter_is_required_error(:group_id)
-
-        request = Web::Request.new(
-          self,
-          :patch,
-          "/groups/#{group_id}",
-          query
-        )
-
-        request.perform
-      end
-    end
-  end
-end

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

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module ApiResources
-    module Storages
-      # Get storages list.
-      #
-      # === Parameters
-      #
-      # Optional:
-      # * +:limit+ [Integer 1..500] - A maximum number of items to retrieve, default - 25
-      # * +:offset+ [Integer >= 0] - A starting offset in the collection, default - 0
-      #
-      # === Example
-      #
-      #  crowdin.list_projects(limit: your_value)
-      #
-      def list_storages(query = {})
-        request = Web::Request.new(
-          self,
-          :get,
-          '/storages',
-          query
-        )
-
-        request.perform
-      end
-
-      # Add storage.
-      #
-      # === Parameters
-      #
-      # * +File+ - File class object or path to file
-      #
-      # === Example
-      #
-      #  crowdin.add_storage(File.open('your_filename.extension', 'r'))
-      # or
-      #  crowdin.add_storage('your_filename.extension')
-      #
-      def add_storage(file = nil)
-        file || raise_parameter_is_required_error(:file)
-
-        file = file.is_a?(File) ? file : File.open(file, 'r')
-
-        request = Web::Request.new(
-          self,
-          :post,
-          '/storages',
-          file,
-          { 'Content-Type' => 'application/octet-stream', 'Crowdin-API-FileName' => File.basename(file) }
-        )
-
-        request.perform
-      end
-
-      # Get storage information.
-      #
-      # === Parameters
-      #
-      # * +:storage_id+ [Integer] - Storage Identifier. Get via list_storages
-      #
-      # === Example
-      #
-      #  crowdin.get_storage(your_storage_id)
-      #
-      def get_storage(storage_id = nil)
-        storage_id || raise_parameter_is_required_error(:storage_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/storages/#{storage_id}"
-        )
-
-        request.perform
-      end
-
-      # Delete storage.
-      #
-      # === Parameters
-      #
-      # * +:storage_id+ [Integer] - Storage Identifier. Get via list_storages
-      #
-      # === Example
-      #
-      #  crowdin.delete_storage(your_storage_id)
-      #
-      def delete_storage(storage_id = nil)
-        storage_id || raise_parameter_is_required_error(:storage_id)
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/storages/#{storage_id}"
-        )
-
-        request.perform
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-# 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