crowdin-api 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ec79bf0a2483fca9502087888c52323ebe12c0c755897f0c71759722f74fd89
-  data.tar.gz: b38ea8b69348734224f7631403f2ac0c6b33496c9098556688c4e648c85cbb6c
+  metadata.gz: 61895ba4796676e716e2a62d4255f518cfcf3b2c138912f201cddce16250a474
+  data.tar.gz: 6cd484b5d394e9b0c2ed2597003d1a64db1d656242d241728c3d4d9f650df87d
 SHA512:
-  metadata.gz: aea9c98831b8abfacb4fe670d4d9025cee21cf33334083645ad9f4767f5d375249a9d2fde8ab7739fec3ca61f1ade03496f23b12377414ce18f62eea2819f453
-  data.tar.gz: 5e69bf63d256bb96faaa11d749635253ad4625b6741d3d312cd7b61af127bd09d494ee87350b7b589e9c8c78de807bccba25286480627aa0e80153554e81fd1f
+  metadata.gz: 14a37cc1eba04d6170dfe082d50ff3ddc033997c1f4f3eab26ab3f9c04b7b35a419c5642cda28b0fbfb258588b234d24dbb685a004cf14841d85bf7f3b12a790
+  data.tar.gz: 4c60ed5dbb6dbe6ab2dfd64f92d508be2f13ac2223a6a34292fb09c1fa1ebcb320ce3ee0ee2c56ba04fc15bc5d598d569528212bc505076d23c7c5ace0515f72

data/.github/workflows/test-and-lint.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: [ '2.6', '2.7', '3.0' ]
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

data/.gitignore

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

data/.rubocop_todo.yml

@@ -1,13 +1,13 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-12-13 20:26:23 UTC using RuboCop version 1.23.0.
+# on 2022-05-09 23:17:26 UTC using RuboCop version 1.26.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
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: Include.
 # Include: **/*.gemspec
 Gemspec/RequireMFA:
@@ -21,112 +21,153 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'crowdin-api.gemspec'
 
-# Offense count: 2
-# Cop supports --auto-correct.
+# Offense count: 18
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
 Layout/ExtraSpacing:
   Exclude:
-    - 'bin/crowdin-console'
+    - 'lib/crowdin-api/api_resources/machine_translation_engines.rb'
+    - 'lib/crowdin-api/api_resources/reports.rb'
+    - 'lib/crowdin-api/api_resources/teams.rb'
+    - 'lib/crowdin-api/api_resources/users.rb'
+    - 'lib/crowdin-api/api_resources/workflows.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
+# Offense count: 4
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/crowdin-api/client/configuration.rb'
+
+# Offense count: 13
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, indented_internal_methods
+Layout/IndentationConsistency:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/core/send_request.rb'
+
+# Offense count: 13
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/core/send_request.rb'
+
+# Offense count: 22
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
 # SupportedStylesForExponentOperator: space, no_space
 Layout/SpaceAroundOperators:
   Exclude:
     - 'crowdin-api.gemspec'
+    - 'lib/crowdin-api/api_resources/machine_translation_engines.rb'
+    - 'lib/crowdin-api/api_resources/reports.rb'
+    - 'lib/crowdin-api/api_resources/teams.rb'
+    - 'lib/crowdin-api/api_resources/users.rb'
+    - 'lib/crowdin-api/api_resources/workflows.rb'
+    - 'spec/api_resources/projects_spec.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/crowdin-api/core/send_request.rb'
 
 # Offense count: 2
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 23
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 54
+  Max: 171
 
-# Offense count: 4
+# Offense count: 13
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 18
 
-# Offense count: 2
+# Offense count: 9
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 205
+  Max: 199
 
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+# Offense count: 3
+# Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
+  MaxOptionalParameters: 4
   Max: 6
 
-# Offense count: 1
+# Offense count: 2
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/api_resources/users.rb'
+    - 'lib/crowdin-api/core/send_request.rb'
 
-# Offense count: 3
+# Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # CheckDefinitionPathHierarchyRoots: lib, spec, test, src
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
     - 'lib/crowdin-api.rb'
-    - 'spec/core/config-instance_spec.rb'
-    - 'spec/crowdin-api_spec.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
   Exclude:
     - 'lib/crowdin-api/client/client.rb'
 
-# Offense count: 3
-# Cop supports --auto-correct.
+# Offense count: 6
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: PreferredName.
 Naming/RescuedExceptionsVariableName:
   Exclude:
-    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/core/send_request.rb'
 
 # Offense count: 7
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: separated, grouped
 Style/AccessorGrouping:
   Exclude:
-    - 'lib/crowdin-api/client/client.rb'
     - 'lib/crowdin-api/client/configuration.rb'
+    - 'lib/crowdin-api/core/request.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
+# Offense count: 4
+# This cop supports unsafe auto-correction (--auto-correct-all).
 Style/CollectionCompact:
   Exclude:
     - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/core/send_request.rb'
 
-# Offense count: 12
+# Offense count: 24
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: allowed_in_returns, forbidden
+Style/DoubleNegation:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - '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/api_errors_raiser.rb'
-    - 'lib/crowdin-api/core/request.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
@@ -137,3 +178,34 @@ Style/FrozenStringLiteralComment:
 Style/MixinUsage:
   Exclude:
     - 'bin/crowdin-console'
+
+# Offense count: 2
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, explicit
+Style/RescueStandardError:
+  Exclude:
+    - 'lib/crowdin-api/api_resources/labels.rb'
+    - 'lib/crowdin-api/api_resources/string_translations.rb'
+
+# Offense count: 1
+# This cop supports unsafe auto-correction (--auto-correct-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/crowdin-api/api_resources/projects.rb'
+
+# Offense count: 8
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'spec/api_resources/projects_spec.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 121

data/README.md

@@ -10,7 +10,7 @@ For more about Crowdin API v2 see the documentation:
 - [Crowdin](https://support.crowdin.com/api/v2/)
 - [Crowdin Enterprise](https://support.crowdin.com/enterprise/api/)
 
-### Status
+## Status
 
 [![Gem](https://img.shields.io/gem/v/crowdin-api?logo=ruby&cacheSeconds=1800)](https://rubygems.org/gems/crowdin-api)
 [![Gem](https://img.shields.io/gem/dt/crowdin-api?cacheSeconds=1800)](https://rubygems.org/gems/crowdin-api)
@@ -22,21 +22,25 @@ For more about Crowdin API v2 see the documentation:
 [![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
+* [Requirements](#requirements)
 * [Installation](#installation)
 * [Quick Start](#quick-start)
   * [Initialization](#initialization)
-  * [How to call methods](#how-to-call-methods)
+  * [Usage](#usage)
   * [Command-Line Client](#command-line-client)
 * [Seeking Assistance](#seeking-assistance)
 * [Contributing](#contributing)
 * [License](#license)
 
+## Requirements
+* Ruby >= 2.4
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.1.0'
+gem 'crowdin-api', '~> 1.3.0'
 ```
 
 And then execute:
@@ -70,14 +74,15 @@ crowdin = Crowdin::Client.new do |config|
   config.api_token = 'YourApiToken'
 end
 
-# Or you can intialize Enterprise Client instance by specifying your organization_domain in config options
+# Or you can initialize 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
+# 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
+# config.organization_domain = your_domain.com -> https://your_domain.com
 
 # All supported Crowdin Client config options now:
 crowdin = Crowdin::Client.new do |config|
@@ -86,8 +91,8 @@ crowdin = Crowdin::Client.new do |config|
   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
+# 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
 ```
@@ -115,14 +120,20 @@ projects = crowdin.list_projects(offset: 10, limit: 20)
 # Get specified project
 project = crowdin.get_project(your_project_id)
 
+# Edit project
+project = crowdin.edit_project(project_id, [{ op: 'replace',
+                                              path: '/name',
+                                              value: 'your_new_project_name' }])
+
 # Add Storage
 storage = crowdin.add_storage(File.open('YourFilename.extension', 'r'))
-# or you can specify only filename
+# or you can specify only absolute path to file
 storage = crowdin.add_storage('YourFilename.extension')
 
 # Download file
-filename = crowdin.download_file(your_file_id, your_destination, your_project_id)
-# your_destination - filename or full path to file, default - saving to currect directory with default filename
+file = crowdin.download_file(your_file_id, your_destination, your_project_id)
+# your_destination - filename or absolute path to file, optional
+# Without destination option file will be saved to the current directory with a default filename
 # project_id is optional, as it can be initialized with a Crowdin Client
 
 # File revisions
@@ -130,6 +141,8 @@ filename = crowdin.download_file(your_file_id, your_destination, your_project_id
 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)
+
+# Note: more examples you can find in spec folder
 ```
 
 ### Command-Line Client
@@ -143,9 +156,9 @@ $ bundle exec crowdin-console --enable-logger --api-token API_TOKEN --project-id
 Or Crowdin Enterprise
 
 ```console
-$ bundle exec crowdin-console --enable-logger --enterprise --api-token API_TOKEN --organization-domain YOUR_DOMAIN --project-id PROJECT_ID
+$ bundle exec crowdin-console --enable-logger --enterprise --api-token API_TOKEN --organization-domain DOMAIN --project-id PROJECT_ID
 ```
-Note: you can specify full organization domain by adding .com
+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

@@ -12,12 +12,12 @@ require 'optparse'
 #
 #  bundle exec crowdin-console --enable-logger --api-token YOUR_API_TOKEN --project-id YOUR_PROJECT_ID
 #
-# or Enterpise API:
+# or Enterprise API:
 #
 #  bundle exec crowdin-console --enterprise --api-token YOUR_ENTERPRISE_API_TOKEN --organization-domain YOUR_DOMAIN
 #
 
-include Crowdin::Errors::ApiErrorsRaiser
+include Crowdin::Errors::ClcErrorsRaiser
 
 options = {}
 
@@ -27,7 +27,7 @@ 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('--project-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!
 
@@ -39,8 +39,8 @@ if options[:enterprise]
   @crowdin = Crowdin::Client.new do |config|
     config.api_token           = options[:api_token]
     config.organization_domain = options[:organization_domain]
-    config.enable_logger       = options[:enable_logger]       || false
-    config.project_id          = options[:project_id]          || nil
+    config.enable_logger       = options[:enable_logger] || false
+    config.project_id          = options[:project_id]    || nil
   end
 else
   @crowdin = Crowdin::Client.new do |config|

data/crowdin-api.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |gem|
   gem.license     = 'MIT'
 
   gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ['lib']
   gem.bindir        = 'bin'
   gem.executables   << 'crowdin-console'
@@ -25,9 +24,9 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.32'
   gem.add_development_dependency 'codecov', '~> 0.6.0'
+  gem.add_development_dependency 'pry', '~> 0.14.1'
   gem.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   gem.add_development_dependency 'rspec', '~> 3.10'
   gem.add_development_dependency 'rubocop', '~> 1.23'
-  gem.add_development_dependency 'sinatra', '~> 2.1'
   gem.add_development_dependency 'webmock', '~> 3.14'
 end

data/lib/crowdin-api/api_resources/dictionaries.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Dictionaries
+      def list_dictionaries(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/dictionaries",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_dictionary(language_id = nil, query = {}, project_id = config.project_id)
+        language_id || raise_parameter_is_required_error(:language_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/dictionaries/#{language_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api_resources/distributions.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Distributions
+      def list_distributions(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/distributions",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_distribution(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/distributions",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_distribution(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_distribution(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_distribution(hash = nil, query = {}, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_distribution_release(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}/release"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def release_distribution(hash = nil, project_id = config.project_id)
+        hash       || raise_parameter_is_required_error(:hash)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}/release"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end