deepl-rb 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f6c08b68a4b9aa8907b543ebbfbab38e9f9f35f7e2dc60decaa4bac57340f5
-  data.tar.gz: 975d1d68cd43fec41b93252b609bc67a619d08d4fd2e6d6bc9b822ca01fd78ac
+  metadata.gz: 55285686ffe869d89ccd6e47ad9f205d7877e70322de92a3a2a1c7abd9ccfd19
+  data.tar.gz: 8db6f78d464b9d5297e1f85003d7922aff67e46514461ede9394dce077972aea
 SHA512:
-  metadata.gz: 749cd28143798f5e08ba848bc4eaa476254ef24656e690fcb3e5ca84314eb54f68ffc7f3675ae74a0cc24c01d194d9dfebcd2d819e0982fad44aba5869e37344
-  data.tar.gz: 4a3b7ca19832725c49b0708f544f9842de7733cc8777b41f66835e4dbead815994ca6dab8b8b3052d172417240dcf5fff5934fc3959ef226001e8ad4e0769735
+  metadata.gz: 78ae4eb854f61524d3b1c88ab057ce0947706c0b88a413605bd5a85cabf923a26c3b08874654fcb165294acf9635b6038228aca355c653be2cf572d70d844670
+  data.tar.gz: d36d518ff006bfd930aee06881768b7d105f5ac55d2c7d43ca1d8d0bd1c9f3044de0d61589e66e7b40baf603a87fdbb7dcba9c46d7b22380e806f402715b0c95

data/.gitlab-ci.yml

@@ -8,14 +8,18 @@ include:
     file:
       - '/templates/.buildkit.yml'
       - '/templates/.secret-detection.yml'
-      - '/templates/.gitlab-release.yml'
 
 # Global --------------------------
 
 workflow:
   rules:
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    # The tag pipeline must run: that is where the registry publish job fires.
     - if: $CI_COMMIT_TAG
+    # The release commit carries only the version and the changelog, both
+    # derived from commits that were already checked on the way in.
+    - if: $CI_COMMIT_MESSAGE =~ /^chore\(release\):/
+      when: never
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
 
 variables:
@@ -25,7 +29,7 @@ stages:
   - install
   - check
   - test
-  - publish # Only for internal tracking
+  - publish
 
 
 before_script:
@@ -115,65 +119,79 @@ semgrep-sast:
 
 # stage: test ----------------------
 
-.test_base:
-    stage: test
-    extends: .test
-    variables:
-        VALIDATE_REQUESTS_FOR_DEEPL_MOCK: '1'
-        VALIDATE_RESPONSES_FOR_DEEPL_MOCK: '1'
-    parallel:
-        matrix:
-          - DOCKER_IMAGE: 'ruby:2.7'
-          - DOCKER_IMAGE: 'ruby:3.2'
-          - DOCKER_IMAGE: 'ruby:3.3'
-          - DOCKER_IMAGE: 'ruby:2.7'
-            USE_MOCK_SERVER: "use mock server"
-          - DOCKER_IMAGE: 'ruby:3.2'
-            USE_MOCK_SERVER: "use mock server"
-          - DOCKER_IMAGE: 'ruby:3.3'
-            USE_MOCK_SERVER: "use mock server"
-    image:
-      name: ${DOCKER_IMAGE}
-      entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
-    script:
-      - >
-        if [[ ! -z "${USE_MOCK_SERVER}" ]]; then
-          echo "Using mock server"
-          export DEEPL_SERVER_URL=http://deepl-mock:3000
-          export DEEPL_MOCK_SERVER_PORT=3000
-          export DEEPL_PROXY_URL=http://deepl-mock:3001
-          export DEEPL_MOCK_PROXY_SERVER_PORT=3001
-        fi
-      - bundle exec rake test
-      - bundle exec rspec --format RspecJunitFormatter --out rspec.xml
-    artifacts:
-        reports:
-            coverage_report:
-                coverage_format: cobertura
-                path: coverage/coverage.xml
-            junit:
-                - rspec.xml
-        when: always
-
-test_scheduled:
-  extends: .test_base
+.test_offline_base:
+  stage: test
+  parallel:
+    matrix:
+      - DOCKER_IMAGE: 'ruby:2.7'
+      - DOCKER_IMAGE: 'ruby:3.2'
+      - DOCKER_IMAGE: 'ruby:3.3'
+  image:
+    name: ${DOCKER_IMAGE}
+    entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
+  script:
+    - bundle exec rspec spec/offline --format progress --format RspecJunitFormatter --out rspec.xml
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/coverage.xml
+      junit:
+        - rspec.xml
+    when: always
+
+test_offline_scheduled:
+  extends: .test_offline_base
   rules:
     - if: $CI_PIPELINE_SOURCE == "schedule"
   retry: 2
 
-test_manual:
+test_offline_manual:
+  extends: .test_offline_base
+  rules:
+    - if: $CI_PIPELINE_SOURCE != "schedule"
+
+# Every endpoint once against the real API; no retry, as a retry repeats every request.
+.test_real_api_base:
   stage: test
-  extends: .test_base
+  extends: .test
+  image:
+    name: ruby:3.3
+    entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
+  script:
+    - bundle exec rspec spec/real_api --format progress --format RspecJunitFormatter --out rspec.xml
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/coverage.xml
+      junit:
+        - rspec.xml
+    when: always
+
+test_real_api_scheduled:
+  extends: .test_real_api_base
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule"
+
+test_real_api_manual:
+  extends: .test_real_api_base
   rules:
     - if: $CI_PIPELINE_SOURCE != "schedule"
 
 # stage: publish ----------------------
 
-gitlab release:
+gem push:
+  extends: .publish
   stage: publish
-  image: registry.gitlab.com/gitlab-org/release-cli:latest
-  extends: .create_gitlab_release
-  before_script:
-    - echo "overriding default before_script..."
+  image:
+    name: ruby:3.3
+    entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
   rules:
     - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
+  script:
+    # The committed gemspec keeps a hardcoded s.files list. Regenerate it from
+    # git ls-files; the version comes from lib/version.rb, written at release.
+    - bundle exec rake gemspec
+    - gem build deepl-rb.gemspec
+    - GEM_HOST_API_KEY="$RUBYGEM_PUBLISH_API_KEY" gem push "deepl-rb-${CI_COMMIT_TAG#v}.gem"

data/.rubocop.yml

@@ -21,15 +21,35 @@ Metrics/ParameterLists:
 Layout/LineLength:
   Max: 100
 
+# A real-API example is one flow per resource: each step is one real request.
 RSpec/ExampleLength:
   Max: 10
   CountAsOne: ['heredoc']
+  Exclude:
+    - 'spec/real_api/**/*'
+
+# The suites are named after the SDK resource or operation, not after one class.
+RSpec/DescribeClass:
+  inherit_mode:
+    merge:
+      - Exclude
+  Exclude:
+    - 'spec/offline/**/*'
+    - 'spec/real_api/**/*'
+
+# The expectation of an offline example is the declared request: offline_helper.rb fails every
+# example whose declared request the SDK did not send.
+RSpec/NoExpectationExample:
+  Exclude:
+    - 'spec/offline/**/*'
 
 RSpec/MessageSpies:
   EnforcedStyle: 'receive'
 
 RSpec/MultipleExpectations:
   Max: 8
+  Exclude:
+    - 'spec/real_api/**/*'
 
 RSpec/MultipleMemoizedHelpers:
   Max: 7
@@ -41,8 +61,14 @@ RSpec/SpecFilePathSuffix:
   Enabled: false
 
 RSpec/SpecFilePathFormat:
+  inherit_mode:
+    merge:
+      - Exclude
   CustomTransform:
     DeepL: ''
+  Exclude:
+    - 'spec/offline/**/*'
+    - 'spec/real_api/**/*'
 
 Style/Documentation:
   Enabled: false