crowdin-api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f8ac7742b9d609ae45c9f63c6772903990c3a4a853e8a2759e1401d82342cd
-  data.tar.gz: e1e2739d09730e35b083316b891b8e43d8d6a3cb7845e7200a4940d461fb80cd
+  metadata.gz: cc71aeec74dd34cef85bb90b9accdd273d18ce3fd8ba9888eb3ce6a073e6aff0
+  data.tar.gz: 39e8290a34930ad659e1ad5879f4f91283f82f88f2316c7f64f03ef524de35cc
 SHA512:
-  metadata.gz: b204059241859851f34e3cb9a5e04109536aaac231a4b0bb5e08577974832dc29df7eed547844a9ccdf4e668281e97c731c3f913fc4ec3f671a04ef5bd5b770f
-  data.tar.gz: 7acb153132b0634bff479f0e5a038f1ef73281b19bb6700b723788d248f7e48f97e3bf216c6e53b89f788fb20b463982f1edcfc0c34d027d928d69c9f9f38f40
+  metadata.gz: d95cbb784a0148eab14bce79dff1dd70735e60aecad95f3be2402ac525581bae5c42dfce8f888ab7255fa3096f7153201a3256d3a6f41821a35f9eaec215abab
+  data.tar.gz: 4b9604fa346136d64a69beb7643beff66433cbbc9102242f56bac6b3f9ebd23e29cc70339e63b9c1a754ce77cf71a6c624d1b97120a5b7f82fb3dbdcb3b23054

data/.gitignore

@@ -1,9 +1,12 @@
-# Ruby logs
+# Ignore Ruby logs
 .ruby-version
 .idea
 
-# MacOS logs
+# Ignore MacOS logs
 .DS_Store
 
-# Versioning
+# Ignore versioning file
 Gemfile.lock
+
+# Ignore tests coverage folder
+coverage

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-11-29 03:21:36 UTC using RuboCop version 1.23.0.
+# on 2021-12-13 20:26:23 UTC using RuboCop version 1.23.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -21,6 +21,13 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'crowdin-api.gemspec'
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'bin/crowdin-console'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
@@ -29,20 +36,21 @@ Layout/SpaceAroundOperators:
   Exclude:
     - 'crowdin-api.gemspec'
 
-# Offense count: 1
-Lint/MissingSuper:
-  Exclude:
-    - 'lib/crowdin-api/core/errors.rb'
-
 # Offense count: 2
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 20
+  Max: 23
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 54
 
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 14
+  Max: 18
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
@@ -69,6 +77,13 @@ Naming/FileName:
     - 'spec/core/config-instance_spec.rb'
     - 'spec/crowdin-api_spec.rb'
 
+# Offense count: 3
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredName.
@@ -85,13 +100,13 @@ Style/AccessorGrouping:
     - 'lib/crowdin-api/client/client.rb'
     - 'lib/crowdin-api/client/configuration.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
 Style/CollectionCompact:
   Exclude:
-    - 'lib/crowdin-api/core/payload.rb'
+    - 'lib/crowdin-api/core/request.rb'
 
-# Offense count: 11
+# Offense count: 12
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
@@ -100,13 +115,14 @@ Style/Documentation:
     - '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/core/errors.rb'
-    - 'lib/crowdin-api/core/payload.rb'
+    - 'lib/crowdin-api/core/api_errors_raiser.rb'
     - 'lib/crowdin-api/core/request.rb'
 
 # Offense count: 1
@@ -116,3 +132,8 @@ Style/Documentation:
 Style/FrozenStringLiteralComment:
   Exclude:
     - 'bin/crowdin-console'
+
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'bin/crowdin-console'

data/README.md

@@ -17,11 +17,9 @@ For more about Crowdin API v2 see the documentation:
 [![Gem](https://img.shields.io/gem/dtv/crowdin-api?cacheSeconds=1800)](https://rubygems.org/gems/crowdin-api)
 
 [![Test and Lint](https://github.com/crowdin/crowdin-api-client-ruby/actions/workflows/test-and-lint.yml/badge.svg)](https://github.com/crowdin/crowdin-api-client-ruby/actions/workflows/test-and-lint.yml)
-[![Build and Publish](https://github.com/crowdin/crowdin-api-client-ruby/actions/workflows/build-and-publish.yml/badge.svg)](https://github.com/crowdin/crowdin-api-client-ruby/actions/workflows/build-and-publish.yml)
-[![codecov](https://codecov.io/gh/crowdin/crowdin-api-client-ruby/branch/master/graph/badge.svg?token=OJsyJwQbFM)](https://codecov.io/gh/crowdin/crowdin-api-client-ruby)
-
+[![codecov](https://codecov.io/gh/crowdin/crowdin-api-client-ruby/branch/main/graph/badge.svg?token=OJsyJwQbFM)](https://codecov.io/gh/crowdin/crowdin-api-client-ruby)
 [![GitHub issues](https://img.shields.io/github/issues/crowdin/crowdin-api-client-ruby?cacheSeconds=1800)](https://github.com/crowdin/crowdin-api-client-ruby/issues)
-[![GitHub](https://img.shields.io/github/license/crowdin/crowdin-api-client-ruby?cacheSeconds=18000)](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/LICENSE)
+[![GitHub](https://img.shields.io/github/license/crowdin/crowdin-api-client-ruby?cacheSeconds=1800)](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/LICENSE)
 
 ## Table of Contents
 * [Installation](#installation)
@@ -38,7 +36,7 @@ For more about Crowdin API v2 see the documentation:
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.0.0'
+gem 'crowdin-api', '~> 1.1.0'
 ```
 
 And then execute:
@@ -67,25 +65,31 @@ gem install crowdin-api
 ```ruby
 require 'crowdin-api'
 
-# Create a new Crowdin Client object.
+# Initialize a new Client instance with config options
 crowdin = Crowdin::Client.new do |config|
   config.api_token = 'YourApiToken'
 end
-# or you can create Enterprise instance by specify your organization_domain
+
+# Or you can intialize Enterprise Client instance by specifying your organization_domain in config options
 crowdin = Crowdin::Client.new do |config|
   config.api_token = 'YourEnterpriseApiToken'
   config.organization_domain = 'YourOrganizationDomain'
 end
+# Note: we use full specified organization domain if that includes .com
+# config.organization_domain = your_domain -> https://your_domain.api.crowdin.com
+# config.organization_domain = your_domain.com -> your_domain.com
 
-# Also you can specify project_id to handle it in methods
-
-# All Crowdin Client config options:
+# All supported Crowdin Client config options now:
 crowdin = Crowdin::Client.new do |config|
   config.api_token = 'YourApiToken' # [String] required
   config.organization_domain = 'YourOrganizationDomain' # [String] optional
   config.project_id = 'YourProjectId' # [Integer] nil by default
   config.enable_logger = true # [Boolean] false by default
 end
+# Note: Client will initialize default Logger instance if you have specify enable_logger to true,
+# you can change it by crowdin.logger = YourLogger
+
+# Also you can specify proxy by adding it to ENV['http_proxy'] before Client initialization
 ```
 
 To generate a new token in Crowdin, follow these steps:
@@ -96,25 +100,25 @@ To generate a new token in Crowdin Enterprise, follow these steps:
 - Go to *Account Settings* > *Access tokens* tab and click *New token*.
 - Specify *Token Name*, select *Scopes* and *Projects*, click *Create*.
 
-### How to call methods
+### Usage
 
 ```ruby
 # Create Project
 project = crowdin.add_project(name: your_project_name, sourceLanguageId: your_language_id)
 
 # Get list of Projects
-projects = client.list_projects
-
-# Get specified project
-project = client.get_project(your_project_id)
+projects = crowdin.list_projects
 
 # Get list of Projects with offset and limit
-projects = client.list_projects(offset: 10, limit: 20)
+projects = crowdin.list_projects(offset: 10, limit: 20)
+
+# Get specified project
+project = crowdin.get_project(your_project_id)
 
 # Add Storage
-adding_storage_response = crowdin.add_storage(File.open('YourFilename.extension'))
+storage = crowdin.add_storage(File.open('YourFilename.extension', 'r'))
 # or you can specify only filename
-adding_storage_response = crowdin.add_storage('YourFilename.extension')
+storage = crowdin.add_storage('YourFilename.extension')
 
 # Download file
 filename = crowdin.download_file(your_destination, your_file_id, your_project_id)
@@ -122,8 +126,10 @@ filename = crowdin.download_file(your_destination, your_file_id, your_project_id
 # project_id is optional, as it can be initialized with a Crowdin Client
 
 # File revisions
-file_revisions = crowdin.list_file_revisions(your_file_id, { limit: 10, project_id: your_project_id })
-# project_id is optional, as it can be initialized with a Crowdin Client
+# with initialized project_id in your Client
+file_revisions = crowdin.list_file_revisions(your_file_id, limit: 10)
+# or you can specify your project_id
+file_revisions = crowdin.list_file_revisions(your_file_id, { limit: 10 }, your_project_id)
 ```
 
 ### Command-Line Client
@@ -131,14 +137,15 @@ file_revisions = crowdin.list_file_revisions(your_file_id, { limit: 10, project_
 The Crowdin Ruby client support crowdin-console, where you can test endpoints easier
 
 ```console
-bundle exec crowdin-console --enable-logger --api-token API_TOKEN --project-id PROJECT_ID
+$ bundle exec crowdin-console --enable-logger --api-token API_TOKEN --project-id PROJECT_ID
 ```
 
 Or Crowdin Enterprise
 
 ```console
-bundle exec crowdin-console --enable-logger --enterprise --api-token API_TOKEN --organization-domain YOUR_DOMAIN
+$ bundle exec crowdin-console --enable-logger --enterprise --api-token API_TOKEN --organization-domain YOUR_DOMAIN --project-id PROJECT_ID
 ```
+Note: you can specify full organization domain by adding .com
 
 When execute you'll have IRB console with configured *@crowdin* instance
 

data/bin/crowdin-console

@@ -1,20 +1,23 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
 require 'crowdin-api'
 require 'optparse'
 
-# You can specify your arguments when execute this script
 #
-# Type bundle exec crowdin-console --help for more available arguments
+# You can specify your options while executing this script
+#
+# Type bundle exec crowdin-console --help for more available options
 #
 # Example:
 #
 #  bundle exec crowdin-console --enable-logger --api-token YOUR_API_TOKEN --project-id YOUR_PROJECT_ID
 #
-# or Enterpise API
+# or Enterpise API:
 #
 #  bundle exec crowdin-console --enterprise --api-token YOUR_ENTERPRISE_API_TOKEN --organization-domain YOUR_DOMAIN
+#
+
+include Crowdin::Errors::ApiErrorsRaiser
 
 options = {}
 
@@ -24,14 +27,14 @@ OptionParser.new do |opts|
   opts.on('--enterprise', 'Enterprise API')                      { |v| options[:enterprise] = v }
   opts.on('--api-token TOKEN', 'API Token')                      { |v| options[:api_token] = v }
   opts.on('--organization-domain DOMAIN', 'Organization Domain') { |v| options[:organization_domain] = v }
-  opts.on('--prohject-id ID', 'Project ID')                      { |v| options[:project_id] = v }
+  opts.on('--project-id ID', 'Project ID')                      { |v| options[:project_id] = v }
   opts.on('--enable-logger', 'Enable logger')                    { |v| options[:enable_logger] = v }
 end.parse!
 
-options[:api_token] || raise(ArgumentError, '--api-token argument is required')
+options[:api_token] || raise_api_token_is_required_error
 
 if options[:enterprise]
-  options[:organization_domain] || raise(ArgumentError, '--organization-domain option is required for Enterprise mode')
+  options[:organization_domain] || raise_organization_domain_is_required_error
 
   @crowdin = Crowdin::Client.new do |config|
     config.api_token           = options[:api_token]

data/crowdin-api.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |gem|
   gem.name        = 'crowdin-api'
   gem.version     = Crowdin::Client::VERSION
   gem.authors     = ['Crowdin']
-  gem.email       = ['support@crowdin.net']
-  gem.homepage    = 'https://github.com/crowdin/crowdin-api/'
-  gem.summary     = 'Client library to manage translations on Crowdin'
-  gem.description = 'Ruby Client for the Crowdin API. Documentation - https://support.crowdin.com/api/v2/.'
+  gem.email       = ['support@crowdin.com']
+  gem.homepage    = 'https://github.com/crowdin/crowdin-api-client-ruby'
+  gem.summary     = 'Ruby Client for the Crowdin API'
+  gem.description = 'The Crowdin Ruby Client is used to interact with the Crowdin API from Ruby'
   gem.license     = 'MIT'
 
   gem.files         = `git ls-files`.split("\n")
@@ -18,10 +18,13 @@ Gem::Specification.new do |gem|
   gem.bindir        = 'bin'
   gem.executables   << 'crowdin-console'
 
+  gem.required_ruby_version = '>= 2.4'
+
   gem.add_runtime_dependency 'open-uri', '>= 0.1.0', '< 0.2.0'
   gem.add_runtime_dependency 'rest-client', '>= 2.0.0', '< 2.1.0'
 
   gem.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.32'
+  gem.add_development_dependency 'codecov', '~> 0.6.0'
   gem.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   gem.add_development_dependency 'rspec', '~> 3.10'
   gem.add_development_dependency 'rubocop', '~> 1.23'

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

@@ -41,7 +41,7 @@ module Crowdin
       end
 
       def get_language(language_id = nil)
-        language_id || raise(ArgumentError, ':language_id is required')
+        language_id || raise_parameter_is_required_error(:language_id)
 
         request = Web::Request.new(
           self,
@@ -53,7 +53,7 @@ module Crowdin
       end
 
       def delete_custom_language(language_id = nil)
-        language_id || raise(ArgumentError, ':language_id is required')
+        language_id || raise_parameter_is_required_error(:language_id)
 
         request = Web::Request.new(
           self,
@@ -65,7 +65,7 @@ module Crowdin
       end
 
       def edit_custom_language(language_id = nil)
-        language_id || raise(ArgumentError, ':language_id is required')
+        language_id || raise_parameter_is_required_error(:language_id)
 
         request = Web::Request.new(
           self,

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

@@ -26,7 +26,7 @@ module Crowdin
       end
 
       def get_project(project_id = nil)
-        project_id || raise(ArgumentError, ':project_id is required')
+        project_id || raise_parameter_is_required_error(:project_id)
 
         request = Web::Request.new(
           self,
@@ -38,7 +38,7 @@ module Crowdin
       end
 
       def delete_project(project_id = nil)
-        project_id || raise(ArgumentError, ':project_id is required')
+        project_id || raise_parameter_is_required_error(:project_id)
 
         request = Web::Request.new(
           self,
@@ -50,7 +50,7 @@ module Crowdin
       end
 
       def edit_project(project_id = nil, query = {})
-        project_id || raise(ArgumentError, ':project_id is required')
+        project_id || raise_parameter_is_required_error(:project_id)
 
         request = Web::Request.new(
           self,
@@ -62,9 +62,11 @@ module Crowdin
         request.perform
       end
 
-      # For Enterprise API only
+      # For Enterprise mode only
 
       def list_groups(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
         request = Web::Request.new(
           self,
           :get,
@@ -76,6 +78,8 @@ module Crowdin
       end
 
       def add_group(query = {})
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+
         request = Web::Request.new(
           self,
           :post,
@@ -87,7 +91,8 @@ module Crowdin
       end
 
       def get_group(group_id = nil)
-        group_id || raise(ArgumentError, ':group_id is required')
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id                || raise_parameter_is_required_error(:group_id)
 
         request = Web::Request.new(
           self,
@@ -99,7 +104,8 @@ module Crowdin
       end
 
       def delete_group(group_id = nil)
-        group_id || raise(ArgumentError, ':group_id is required')
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id                || raise_parameter_is_required_error(:group_id)
 
         request = Web::Request.new(
           self,
@@ -111,7 +117,8 @@ module Crowdin
       end
 
       def edit_group(group_id = nil, query = {})
-        group_id || raise(ArgumentError, ':group_id is required')
+        config.enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id                || raise_parameter_is_required_error(:group_id)
 
         request = Web::Request.new(
           self,