crowdin-api 1.14.0 → 1.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a60b3487c1824a37ef3519089f1e48e7de773f35734a54a981365707bbd80a
-  data.tar.gz: 0e5642b1b3446d55602f34ec4820b82e5d686e4002df0158371031141480bde1
+  metadata.gz: 21f8a0a899fd0d59b872935a464f73a5f0026da44f78e7b62fbc5abb5523b49f
+  data.tar.gz: 75f680385d8530a0f9e62f1fd7c8281a7f6e30746cf6ce04338b15cd3278f553
 SHA512:
-  metadata.gz: a6ee9691d7ce60578c6438bf58874262edaa4dc8100723a2c9ad56b70828c97367a332401a47b9f098408d48dec4324714d83e5a1f73f3a2d683c829f3dc792f
-  data.tar.gz: cc3e2fbdc50836e014496c9990be79492817c878a8758b35044e5cecedf670eeed33390fb42ab1d32e5d52b9873344ee88a3fc11942e4a7513a1e3adf66269d5
+  metadata.gz: 2a2c397685ef9171d27a06f5dd616b1acce0338d9bc1c216e0bc4b20cfd966a3e431167000f6c3305b613299ad219ae65942f3d672c85c705f8340cbffc74ee7
+  data.tar.gz: a918231fc47c1bee0849b9c270c2e27bbf1f0bc72adf10aec3ae3238bd6fb5e17d0b2819868a281cf266a8787cbf33de420268a221f2f90cc561daa2ec1aa828

data/.github/workflows/docs.yml

@@ -21,6 +21,7 @@ jobs:
 
       - name: Cleanup the Readme
         run: |
+          sed -i '/<p align="center">/,/<\/p>/d' README.md
           sed -i /\<div/d README.md
           sed -i /\<\\/div/d README.md
 

data/.rubocop.yml

@@ -10,3 +10,7 @@ Gemspec/DevelopmentDependencies:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/crowdin-api/api_resources/**/*'

data/.rubocop_todo.yml

@@ -119,6 +119,7 @@ Metrics/PerceivedComplexity:
 # Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
+    - 'lib/crowdin-api/api_resources/organization.rb'
     - 'lib/crowdin-api/api_resources/users.rb'
 
 # Offense count: 1

data/AGENTS.md

@@ -0,0 +1,63 @@
+# AGENTS.md
+
+Ruby client for the Crowdin API v2 and Crowdin Enterprise API v2 (gem: `crowdin-api`, namespace `Crowdin`).
+
+The gemspec requires Ruby >= 2.4 while CI tests 3.0–3.3 — stay conservative with syntax (no pattern matching, no endless methods).
+
+## Layout
+
+- `lib/crowdin-api.rb` — entry point; the `API_RESOURCES_MODULES` array plus requires
+- `lib/crowdin-api/client/client.rb` — `Crowdin::Client`; mixes every resource module in
+- `lib/crowdin-api/api_resources/<name>.rb` — one module per API resource, plain instance methods
+- `lib/crowdin-api/core/` — request/response plumbing, errors, `fetch_all`, GraphQL
+- `spec/api_resources/<name>_spec.rb` — 1:1 with resources; WebMock, no fixtures directory
+
+## Commands
+
+- Install: `bundle install`
+- Test (all): `bundle exec rspec` (or `bundle exec rake`)
+- Test (one file): `bundle exec rspec spec/api_resources/<name>_spec.rb`
+- Lint (CI runs this before the specs): `bundle exec rubocop`
+- Lint autofix: `bundle exec rubocop -a`
+
+## Adding or changing an endpoint
+
+Fetch the endpoint spec first (see Crowdin API reference below). Then:
+
+1. Implement the method in `lib/crowdin-api/api_resources/<snake_case>.rb` (`# frozen_string_literal: true`, then `module Crowdin` > `module ApiResources` > `module <CamelCase>`):
+   - Argument order: required path ids, then the `query`/`body` hash, then optional `destination` (file downloads), then `project_id = config.project_id` last. RuboCop caps optional parameters at 4 and this pattern already uses them all.
+   - Guards: `project_id || raise_project_id_is_required_error`; Enterprise-only methods start with `enterprise_mode? || raise_only_for_enterprise_mode_error` and sit under a `# -- For Enterprise mode only --` comment.
+   - Body: build `Web::Request.new(connection, :get, "#{config.target_api_url}/projects/#{project_id}/...", { params: query })` and return `Web::SendRequest.new(request).perform` (pass `destination` as the second argument to `SendRequest` for downloads).
+   - Name list endpoints `list_*` — `fetch_all` refuses anything else (and hard-codes extra args for `list_terms` and `list_file_revisions` in `client.rb`).
+   - Doc comment: two `{https://support.crowdin.com/developer/... API Documentation}` links (base and enterprise) plus YARD `@param` lines.
+2. For a new resource, append the CamelCase symbol to `Crowdin::API_RESOURCES_MODULES` in `lib/crowdin-api.rb`. The file name must be the exact snake_case of that symbol: the require loop swallows `LoadError` silently and a mismatch surfaces later as an unrelated `NameError` from `const_get`. `client.rb` needs no edit — the include loop picks the module up.
+3. Spec in `spec/api_resources/<snake_case>_spec.rb`: tag examples `:default` or `:enterprise` — `spec_helper.rb` prebuilds `@crowdin` and sets the WebMock host (`https://api.crowdin.com` vs `https://domain.api.crowdin.com`) from the tag. House idiom: `stub_request(...)` with no `.to_return`, then `expect(result).to eq(200)` — `perform` returns the HTTP status for an empty body, a parsed Hash otherwise, and an error String on failure (HTTP errors are returned, not raised).
+
+A complete new resource touches exactly 3 files: the resource module, `lib/crowdin-api.rb`, and the spec.
+
+## Crowdin API reference
+
+Before implementing or changing any endpoint, fetch its spec from the llms.txt indexes (pick by environment, then project type):
+
+- https://support.crowdin.com/_llms-txt/api/crowdin/file-based.txt — Crowdin API, file-based projects (start here)
+- https://support.crowdin.com/_llms-txt/api/crowdin/string-based.txt — Crowdin API, string-based projects
+- https://support.crowdin.com/_llms-txt/api/enterprise/file-based.txt — Crowdin Enterprise API, file-based projects
+- https://support.crowdin.com/_llms-txt/api/enterprise/string-based.txt — Crowdin Enterprise API, string-based projects
+
+Each index links one spec file per route (e.g. `.../api.projects.strings.get.txt`) with the exact request and response shapes.
+
+## Conventions
+
+- Conventional Commits for commit messages and PR titles; CI lints PR titles.
+- PRs target `main`. CI runs RuboCop before the specs, so a lint failure blocks the test result.
+- Keep the public API backward compatible.
+- Never bump the version by hand — the Release workflow rewrites `lib/crowdin-api/client/version.rb`, the README install line, and `Gemfile.lock` together.
+
+## PR checklist
+
+A change is ready when:
+
+1. `bundle exec rubocop` is clean,
+2. `bundle exec rspec` passes,
+3. every new or changed endpoint method has a spec (tagged `:default`, plus `:enterprise` where the API differs), and
+4. every new or changed public method carries the two API documentation links.

data/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    crowdin-api (1.14.0)
+    crowdin-api (1.15.1)
       open-uri (>= 0.1.0, < 0.2.0)
       rest-client (>= 2.0.0, < 2.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.2)
     coderay (1.1.3)
     crack (0.4.5)
@@ -46,7 +46,7 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rexml (3.2.6)
+    rexml (3.4.4)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -77,7 +77,7 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
+    simplecov-cobertura (3.2.0)
       rexml
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
@@ -90,7 +90,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.36)
+    yard (0.9.45)
 
 PLATFORMS
   arm64-darwin-23
@@ -104,7 +104,7 @@ DEPENDENCIES
   rspec (~> 3.10)
   rubocop (~> 1.23)
   simplecov (~> 0.22)
-  simplecov-cobertura (~> 2.1)
+  simplecov-cobertura (~> 3.1)
   webmock (~> 3.14)
   yard (~> 0.9.36)
 

data/README.md

@@ -35,7 +35,7 @@ Crowdin API is a full-featured RESTful API that helps you to integrate localizat
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.14.0'
+gem 'crowdin-api', '~> 1.15.1'
 ```
 
 And then execute:

data/crowdin-api.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec', '~> 3.10'
   gem.add_development_dependency 'rubocop', '~> 1.23'
   gem.add_development_dependency 'simplecov', '~> 0.22'
-  gem.add_development_dependency 'simplecov-cobertura', '~> 2.1'
+  gem.add_development_dependency 'simplecov-cobertura', '~> 3.1'
   gem.add_development_dependency 'webmock', '~> 3.14'
 end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Advisor
+      # @param body [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.checks.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.checks.post  Enterprise API Documentation}
+      def create_advisor_check(body = {}, 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}/advisors/checks",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param check_id [String] Advisor Check Identifier, consists of 36 characters
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.checks.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.checks.get  Enterprise API Documentation}
+      def get_advisor_check_status(check_id, 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}/advisors/checks/#{check_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.insights.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.insights.getMany  Enterprise API Documentation}
+      def list_advisor_insights(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}/advisors/insights",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param insight_id [Integer] Insight Identifier
+      # @param body [Array] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.insights.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.insights.patch  Enterprise API Documentation}
+      def edit_advisor_insight(insight_id, body = [], project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/advisors/insights/#{insight_id}",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param application_identifier [String] applicationIdentifier
+      # @param module_key [String] moduleKey
+      # @param body [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.applications.modules.advisors.insights.put  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.applications.modules.advisors.insights.put  Enterprise API Documentation}
+      def create_or_update_application_advisor_insight(application_identifier, module_key, body = {},
+                                                       project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        endpoint = "projects/#{project_id}/applications/#{application_identifier}/modules/#{module_key}/advisors/insights"
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/#{endpoint}",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end