crowdin-api 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bec711e702205bef5cf0bd74dc1a99c6f770225ee0fb37afa702cc8fb3712cab
-  data.tar.gz: '09425dd51fe242b61eb7a3fe12331f5a6827504d5cd5b5157ff6824c56069a39'
+  metadata.gz: 283ff1afb3a211be3a2c06c0417decc9b6ff3fcca1e8c61c78523708c428d286
+  data.tar.gz: e6f02c86c39702e00eacc0908c6dec0a93783a7a4038e2eddbc634ca2d4887d3
 SHA512:
-  metadata.gz: 8e7b0806bbc5a1caf4c963df4f7120cdff2dfd4f0df068f7a308ade71c6b45c9373f157338065e9a116a0dc081ceeea07a593d8933701f2c2d43a5640810a901
-  data.tar.gz: f5d06bfce2e0257c4249a856923eb3ea8afd1f424efe26ee212193c647cbc2cb3ad4caa42bed305e9874198e433b4ac8b50e87d5dcfb244d3689febef5a67d41
+  metadata.gz: ca47c68a8c81d3de24a5ae913155ece611ae9400fdbea47933355d6043036c269d15ab067df037afcdc4aae1fa982991f49bee4603fb5f6816a783dd6d7c30b1
+  data.tar.gz: dcf04302fb3c882a81f630476b4e7dce4cf1e98320da04615d3d393fb4bdfadb9bc67aec732bee227321cd3af7cbc095363f0f0c22a903a5f954acb6101a243a

data/.rubocop_todo.yml

@@ -1,13 +1,13 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-02-14 06:05:44 UTC using RuboCop version 1.23.0.
+# on 2022-08-12 15:14:54 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,8 +21,24 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'crowdin-api.gemspec'
 
+# Offense count: 2
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle, IndentOneStep, IndentationWidth.
+# SupportedStyles: case, end
+Layout/CaseIndentation:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+
 # Offense count: 4
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
 # SupportedHashRocketStyles: key, separator, table
 # SupportedColonStyles: key, separator, table
@@ -31,115 +47,158 @@ Layout/HashAlignment:
   Exclude:
     - 'lib/crowdin-api/client/configuration.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
+# Offense count: 14
+# 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: 14
+# 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: 4
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
 # SupportedStylesForExponentOperator: space, no_space
 Layout/SpaceAroundOperators:
   Exclude:
     - 'crowdin-api.gemspec'
+    - 'spec/api_resources/projects_spec.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 23
+  Max: 42
 
-# Offense count: 1
+# Offense count: 46
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 54
+  Max: 171
 
-# Offense count: 12
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 101
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 18
+
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 18
+  Max: 41
 
 # Offense count: 8
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 199
+  Max: 196
 
 # Offense count: 2
-# Configuration parameters: CountKeywordArgs.
+# Configuration parameters: Max, CountKeywordArgs.
 Metrics/ParameterLists:
   MaxOptionalParameters: 4
-  Max: 6
 
-# Offense count: 2
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 19
+
+# Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/crowdin-api/api-resources/users.rb'
-    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/api_resources/users.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/client/client-instance_spec.rb'
-    - 'spec/client/configuration-instance_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.
-# Configuration parameters: PreferredName.
-Naming/RescuedExceptionsVariableName:
-  Exclude:
-    - 'lib/crowdin-api/core/request.rb'
-
-# Offense count: 8
-# Cop supports --auto-correct.
+# Offense count: 7
+# 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.
+# This cop supports unsafe auto-correction (--auto-correct-all).
 Style/CollectionCompact:
   Exclude:
     - 'lib/crowdin-api/core/request.rb'
 
-# Offense count: 22
+# Offense count: 27
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: allowed_in_returns, forbidden
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/crowdin-api/client/configuration.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
   Exclude:
     - 'bin/crowdin-console'
 
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+
 # Offense count: 1
 Style/MixinUsage:
   Exclude:
     - 'bin/crowdin-console'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+Style/RedundantFreeze:
   Exclude:
-    - 'lib/crowdin-api/api-resources/labels.rb'
-    - 'lib/crowdin-api/api-resources/string_translations.rb'
+    - 'lib/crowdin-api/core/fetch_all_extensions.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
+# 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: 2
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:

data/README.md

@@ -27,6 +27,7 @@ For more about Crowdin API v2 see the documentation:
 * [Quick Start](#quick-start)
   * [Initialization](#initialization)
   * [Usage](#usage)
+  * [Fetch all records](#fetch-all-records)
   * [Command-Line Client](#command-line-client)
 * [Seeking Assistance](#seeking-assistance)
 * [Contributing](#contributing)
@@ -40,7 +41,7 @@ For more about Crowdin API v2 see the documentation:
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.2.0'
+gem 'crowdin-api', '~> 1.4.0'
 ```
 
 And then execute:
@@ -66,6 +67,7 @@ gem install crowdin-api
 ## Quick start
 
 ### Initialization
+
 ```ruby
 require 'crowdin-api'
 
@@ -74,7 +76,7 @@ crowdin = Crowdin::Client.new do |config|
   config.api_token = 'YourApiToken'
 end
 
-# Or you can intialize Enterprise Client instance by specifying your
+# 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'
@@ -82,7 +84,7 @@ crowdin = Crowdin::Client.new do |config|
 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
+# config.organization_domain = your_domain.com -> https://your_domain.com
 
 # All supported Crowdin Client config options now:
 crowdin = Crowdin::Client.new do |config|
@@ -121,9 +123,9 @@ projects = crowdin.list_projects(offset: 10, limit: 20)
 project = crowdin.get_project(your_project_id)
 
 # Edit project
-project = crowdin.edit_project(project_id, [{op: 'replace',
-                                             path: '/name',
-                                             value: 'your_new_project_name'}])
+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'))
@@ -141,6 +143,35 @@ file = 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
+```
+
+### Fetch all records
+
+There is a possibility to fetch all records from paginatable methods using `fetch_all` method.
+
+```ruby
+# FetchAll options:
+# * limit, Integer, default: 500 | How many records need to load per one request
+# * offset, Integer, default: 0
+# * request_delay, Integer (seconds), default: 0 | Delay between requests. To specify a delay in milliseconds use float values like 0.100
+
+# Examples:
+
+@crowdin.fetch_all(:list_projects)
+
+# with options
+@crowdin.fetch_all(:list_projects, { limit: 10, request_delay: 1 })
+
+# playing with response per fetch
+# Note: the block actually don't make any effect to finite result
+@crowdin.fetch_all(:list_projects, { limit: 10, request_delay: 1 }) { |response| puts response['data'] }
+
+# also, you could specify a retry configuration to handle some exceptions
+# fetch all execution will be terminated if response status code is the same as one of the error_messages array value
+# otherwise, the request will be retried so many times, as indicated at retries_count
+@crowdin.fetch_all(:list_projects, {}, { request_delay: 2, retries_count: 3, error_messages: ['401'] })
 ```
 
 ### Command-Line Client

data/bin/crowdin-console

@@ -12,7 +12,7 @@ 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
 #

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/bundles.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Bundles
+      def list_bundles(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}/bundles",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_bundle(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}/bundles",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_bundle(bundle_id, project_id = config.project_id)
+        bundle_id  || raise_parameter_is_required_error(:bundle_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_bundle(bundle_id, project_id = config.project_id)
+        bundle_id  || raise_parameter_is_required_error(:bundle_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_bundle(bundle_id, query = {}, project_id = config.project_id)
+        bundle_id  || raise_parameter_is_required_error(:bundle_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def bundle_list_files(bundle_id, query = {}, project_id = config.project_id)
+        bundle_id  || raise_parameter_is_required_error(:bundle_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/files",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/{api-resources → api_resources}/dictionaries.rb

@@ -7,13 +7,12 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/dictionaries",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/dictionaries",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def edit_dictionary(language_id = nil, query = {}, project_id = config.project_id)
@@ -21,13 +20,12 @@ module Crowdin
         project_id  || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :patch,
-          "/projects/#{project_id}/dictionaries/#{language_id}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/dictionaries/#{language_id}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
     end
   end

data/lib/crowdin-api/{api-resources → api_resources}/distributions.rb

@@ -7,26 +7,24 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/distributions",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/distributions",
+          { params: query }
         )
-
-        request.perform
+        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(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/distributions",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/distributions",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def get_distribution(hash = nil, project_id = config.project_id)
@@ -34,12 +32,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/distributions/#{hash}"
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def delete_distribution(hash = nil, project_id = config.project_id)
@@ -47,12 +44,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :delete,
-          "/projects/#{project_id}/distributions/#{hash}"
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def edit_distribution(hash = nil, query = {}, project_id = config.project_id)
@@ -60,26 +56,24 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :patch,
-          "/projects/#{project_id}/distributions/#{hash}",
-          query
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}",
+          { params: query }
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
-      def get_destribution_release(hash = nil, project_id = config.project_id)
+      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(
-          self,
+          connection,
           :get,
-          "/projects/#{project_id}/distributions/#{hash}/release"
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}/release"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
 
       def release_distribution(hash = nil, project_id = config.project_id)
@@ -87,12 +81,11 @@ module Crowdin
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
-          self,
+          connection,
           :post,
-          "/projects/#{project_id}/distributions/#{hash}/release"
+          "#{config.target_api_url}/projects/#{project_id}/distributions/#{hash}/release"
         )
-
-        request.perform
+        Web::SendRequest.new(request).perform
       end
     end
   end