🔖 release/v5.0.0.alpha1

.editorconfig

@@ -0,0 +1,24 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{rb,rake,gemspec,rbs,ru}]
+indent_style = space
+indent_size = 2
+
+[*.{yml,yaml,json}]
+indent_style = space
+indent_size = 2
+
+[*.sh]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab

.github/workflows/_publish-code.yml

@@ -5,18 +5,17 @@ on:
   workflow_dispatch:
 
 jobs:
-  linting:
+  publish:
     name: Publish to Rubygems
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: recursive
-
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.0"
+        ruby-version: "3.2"
         bundler-cache: true
 
     - name: Set credentials
@@ -28,10 +27,13 @@ jobs:
         echo -e "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials
         chmod 600 ~/.gem/credentials
 
-    - name: Build the Gem
+    - name: Build the Gems
       run: |
-        gem build --strict --output mindee.gem
+        gem build mindee.gemspec --strict --output mindee.gem
+        gem build mindee-lite.gemspec --strict --output mindee-lite.gem
 
-    - name: Publish the Gem
+    - name: Publish the Gems
       run: |
+        # Push both generated files to Rubygems
         gem push mindee.gem
+        gem push mindee-lite.gem

.github/workflows/_publish-docs.yml

@@ -12,12 +12,12 @@ jobs:
     name: Publish Documentation
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.1"
+        ruby-version: "3.2"
         bundler-cache: true
 
     - name: Analyse the code with Rubocop

.github/workflows/_static-analysis.yml

@@ -12,16 +12,32 @@ jobs:
     name: Run Static Analysis
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: recursive
 
     - name: set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.0.0"
+        ruby-version: "3.2.0"
         bundler-cache: true
 
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+
+    - name: Install pre-commit
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pre-commit
+
+    - name: Run pre-commit checks (security + hygiene)
+      env:
+        SKIP: rubocop,steep
+      run: |
+        pre-commit run --all-files --show-diff-on-failure
+
     - name: Analyse the code with Rubocop
       run: |
         bundle install

.github/workflows/_test-cli.yml

@@ -0,0 +1,47 @@
+name: CLI Test
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+env:
+  MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
+  MINDEE_V2_API_KEY: ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }}
+  MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
+
+jobs:
+  test:
+    name: Run Tests
+    timeout-minutes: 30
+    strategy:
+      max-parallel: 4
+      matrix:
+        os_config:
+          - os: "ubuntu-24.04"
+            rid: "linux-x64"
+          - os: "macos-latest"
+            rid: "osx-x64"
+          - os: "windows-latest"
+            rid: "win-x64"
+        ruby:
+          - "3.2"
+          - "4.0"
+    runs-on: ${{ matrix.os_config.os }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: recursive
+
+      - name: set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Tests V2 CLI
+        run: |
+          ./spec/test_v2_cli.sh ./spec/data/file_types/pdf/blank_1.pdf ${{ matrix.os_config.rid }}
+
+      - name: Tests V1 CLI
+        run: |
+          ./spec/test_v1_cli.sh ./spec/data/file_types/pdf/blank_1.pdf ${{ matrix.os_config.rid }}

.github/workflows/_test-integration-lite.yml

@@ -0,0 +1,50 @@
+#
+# Run integration tests.
+#
+name: Integration Tests - Minimal Dependencies
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+env:
+  MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
+  WORKFLOW_ID: ${{ secrets.WORKFLOW_ID_SE_TESTS }}
+  MINDEE_V2_API_KEY: ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }}
+  MINDEE_V2_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_BLANK_PDF_URL: ${{ secrets.MINDEE_V2_SE_TESTS_BLANK_PDF_URL }}
+  MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_CROP_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CROP_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_OCR_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_OCR_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID }}
+  MINDEE_LOG_LEVEL: DEBUG
+  MINDEE_GEM_NAME: mindee-lite
+
+jobs:
+  integration-tests:
+    name: Run Integration Tests
+    timeout-minutes: 30
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 3
+      matrix:
+        os:
+          - "ubuntu-24.04"
+          - "macos-latest"
+        ruby:
+          - "4.0"
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: recursive
+
+      - name: set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run Rspec for integration tests
+        run: |
+          bundle exec rake integration

.github/workflows/_test-integrations.yml → .github/workflows/_test-integration.yml

@@ -1,12 +1,25 @@
 #
 # Run integration tests.
 #
-name: Integration Tests
+name: Integration Tests - All Dependencies
 
 on:
   workflow_call:
   workflow_dispatch:
 
+env:
+  MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
+  WORKFLOW_ID: ${{ secrets.WORKFLOW_ID_SE_TESTS }}
+  MINDEE_V2_API_KEY: ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }}
+  MINDEE_V2_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_BLANK_PDF_URL: ${{ secrets.MINDEE_V2_SE_TESTS_BLANK_PDF_URL }}
+  MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_CROP_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CROP_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_OCR_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_OCR_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID }}
+  MINDEE_LOG_LEVEL: DEBUG
+
 jobs:
   integration-tests:
     name: Run Integration Tests
@@ -19,10 +32,10 @@ jobs:
           - "ubuntu-24.04"
           - "macos-latest"
         ruby:
-          - "3.0"
+          - "3.2"
           - "4.0"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: recursive
 
@@ -32,11 +45,11 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Install Ghostscript on Ubuntu
+      - name: Install Ghostscript and ImageMagick on Ubuntu
         if: runner.os == 'Linux'
         run: |
           sudo apt update
-          sudo apt-get install -y ghostscript
+          sudo apt-get install -y ghostscript imagemagick
 
       - name: Install Ghostscript and ImageMagick on macOS
         if: runner.os == 'macOS'
@@ -50,17 +63,6 @@ jobs:
           sudo sed -i "s/$SRC/$RPL/" /etc/ImageMagick-6/policy.xml
 
       - name: Run Rspec for integration tests
-        env:
-          MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
-          WORKFLOW_ID: ${{ secrets.WORKFLOW_ID_SE_TESTS }}
-          MINDEE_V2_API_KEY: ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }}
-          MINDEE_V2_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
-          MINDEE_V2_SE_TESTS_BLANK_PDF_URL: ${{ secrets.MINDEE_V2_SE_TESTS_BLANK_PDF_URL }}
-          MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID }}
-          MINDEE_V2_SE_TESTS_CROP_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CROP_MODEL_ID }}
-          MINDEE_V2_SE_TESTS_OCR_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_OCR_MODEL_ID }}
-          MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID }}
-          MINDEE_LOG_LEVEL: DEBUG
         run: |
           bundle exec rake integration
 

.github/workflows/_test-code-samples.yml → .github/workflows/_test-smoke.yml

@@ -1,4 +1,4 @@
-name: Test Code Samples
+name: Smoke Test
 
 on:
   workflow_call:
@@ -9,12 +9,13 @@ env:
   MINDEE_ACCOUNT_SE_TESTS: ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }}
   MINDEE_API_KEY_SE_TESTS: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
   MINDEE_V2_API_KEY: ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }}
-  MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
-  MINDEE_V2_SE_TESTS_FAILURE_WEBHOOK_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FAILURE_WEBHOOK_ID }}
-  MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID }}
-  MINDEE_V2_SE_TESTS_CROP_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CROP_MODEL_ID }}
-  MINDEE_V2_SE_TESTS_OCR_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_OCR_MODEL_ID }}
-  MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID }}
+  MINDEE_V2_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
+  MINDEE_V2_SE_TESTS_BLANK_PDF_URL: ${{ secrets.MINDEE_V2_SE_TESTS_BLANK_PDF_URL }}
+  MINDEE_V2_CLASSIFICATION_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CLASSIFICATION_MODEL_ID }}
+  MINDEE_V2_CROP_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_CROP_MODEL_ID }}
+  MINDEE_V2_FAILURE_WEBHOOK_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FAILURE_WEBHOOK_ID }}
+  MINDEE_V2_OCR_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_OCR_MODEL_ID }}
+  MINDEE_V2_SPLIT_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_SPLIT_MODEL_ID }}
 
 jobs:
   test:
@@ -23,14 +24,13 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - "3.0"
-          - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
+          - "4.0"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: recursive
 
@@ -40,14 +40,14 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Tests V1 code samples
+      - name: Tests V2 code samples
         env:
           MINDEE_LOG_LEVEL: DEBUG
         run: |
-          ./spec/test_code_samples_v1.sh
+          ./spec/test_v2_code_samples.sh
 
-      - name: Tests V2 code samples
+      - name: Tests V1 code samples
         env:
           MINDEE_LOG_LEVEL: DEBUG
         run: |
-          ./spec/test_code_samples_v2.sh
+          ./spec/test_v1_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }}

.github/workflows/_test-units-lite.yml

@@ -0,0 +1,40 @@
+#
+# Run lite unit tests.
+#
+name: Unit Tests - Minimal Dependencies
+
+on:
+  workflow_call:
+
+env:
+  MINDEE_GEM_NAME: mindee-lite
+
+jobs:
+  tests:
+    name: Run Unit Tests
+    timeout-minutes: 30
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - "ubuntu-24.04"
+          - "macos-latest"
+        ruby:
+          - "3.2"
+          - "4.0"
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        submodules: recursive
+
+    - name: set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run Rspec
+      env:
+        MINDEE_LOG_LEVEL: DEBUG
+      run: |
+        bundle exec rake spec