♻️ change Ocr to OCR to keep consistency

sebastianMindee · sebastianMindee · commit 94a74d2edbc5 · 2026-04-02T12:06:54.000+02:00
diff --git a/.github/workflows/_publish-code.yml b/.github/workflows/_publish-code.yml
@@ -16,7 +16,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.0"
+        ruby-version: "3.2"
         bundler-cache: true
 
     - name: Set credentials
diff --git a/.github/workflows/_publish-docs.yml b/.github/workflows/_publish-docs.yml
@@ -17,7 +17,7 @@ jobs:
     - 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
diff --git a/.github/workflows/_static-analysis.yml b/.github/workflows/_static-analysis.yml
@@ -19,7 +19,7 @@ jobs:
     - 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
diff --git a/.github/workflows/_test-integrations.yml b/.github/workflows/_test-integrations.yml
@@ -32,7 +32,7 @@ jobs:
           - "ubuntu-24.04"
           - "macos-latest"
         ruby:
-          - "3.0"
+          - "3.2"
           - "4.0"
     steps:
       - uses: actions/checkout@v5
diff --git a/.github/workflows/_test-smoke.yml b/.github/workflows/_test-smoke.yml
@@ -24,11 +24,10 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - "3.0"
-          - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
+          - "4.0"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
diff --git a/.github/workflows/_test-units.yml b/.github/workflows/_test-units.yml
@@ -18,8 +18,6 @@ jobs:
           - "ubuntu-22.04"
           - "macos-latest"
         ruby:
-          - "3.0"
-          - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
diff --git a/bin/v2/products.rb b/bin/v2/products.rb
@@ -25,7 +25,7 @@
   },
   'ocr' => {
     description: 'OCR Utility',
-    response_class: Mindee::V2::Product::Ocr::Ocr,
+    response_class: Mindee::V2::Product::OCR::OCR,
   },
   'split' => {
     description: 'Split Utility',
diff --git a/docs/code_samples/v2_ocr.txt b/docs/code_samples/v2_ocr.txt
@@ -21,7 +21,7 @@ input_source = Mindee::Input::Source::PathInputSource.new(input_path)
 
 # Send for processing
 response = mindee_client.enqueue_and_get_result(
-    Mindee::V2::Product::Ocr::Ocr,
+    Mindee::V2::Product::OCR::Ocr,
     input_source,
     ocr_params
 )
diff --git a/lib/mindee.rb b/lib/mindee.rb
@@ -86,6 +86,13 @@ module Standard
       module Universal
       end
     end
+
+    # V1-specific products.
+    module Product
+      # French products.
+      module FR
+      end
+    end
   end
 
   # V2-specific module.
@@ -94,6 +101,7 @@ module V2
     module HTTP
     end
 
+    # File operations.
     module FileOperation
       # Crop operations.
       module Crop
diff --git a/lib/mindee/input/base_parameters.rb b/lib/mindee/input/base_parameters.rb
@@ -54,6 +54,9 @@ def slug
         self.class.slug
       end
 
+      # Load from a hash
+      # @param [Hash] params Parameters to provide as a hash.
+      # @return [BaseParameters]
       def self.from_hash(params: {})
         load_from_hash(params: params)
         new(
diff --git a/lib/mindee/v1/parsing/common/ocr/ocr.rb b/lib/mindee/v1/parsing/common/ocr/ocr.rb
@@ -6,7 +6,7 @@ module Mindee
   module V1
     module Parsing
       module Common
-        # Ocr-specific parsing fields and options
+        # OCR-specific parsing fields and options
         module OCR
           # A single word.
           class OCRWord
diff --git a/lib/mindee/v2/parsing/raw_text.rb b/lib/mindee/v2/parsing/raw_text.rb
@@ -16,6 +16,8 @@ def initialize(server_response)
           end
         end
 
+        # String representation.
+        # @return [String]
         def to_s
           "#{@pages.join("\n\n")}\n"
         end
diff --git a/lib/mindee/v2/parsing/raw_text_page.rb b/lib/mindee/v2/parsing/raw_text_page.rb
@@ -13,6 +13,8 @@ def initialize(server_response)
           @content = server_response['content']
         end
 
+        # String representation.
+        # @return [String]
         def to_s
           @content
         end
diff --git a/lib/mindee/v2/parsing/search/search_response.rb b/lib/mindee/v2/parsing/search/search_response.rb
@@ -18,6 +18,8 @@ def initialize(server_response)
             @pagination_metadata = PaginationMetadata.new(server_response['pagination'])
           end
 
+          # String representation.
+          # @return [String]
           def to_s
             [
               'Models',
diff --git a/lib/mindee/v2/product/classification/classification.rb b/lib/mindee/v2/product/classification/classification.rb
@@ -6,6 +6,7 @@
 module Mindee
   module V2
     module Product
+      # Classification module.
       module Classification
         # Classification product.
         class Classification < BaseProduct
diff --git a/lib/mindee/v2/product/classification/params/classification_parameters.rb b/lib/mindee/v2/product/classification/params/classification_parameters.rb
@@ -4,6 +4,7 @@ module Mindee
   module V2
     module Product
       module Classification
+        # Classification parameters.
         module Params
           # Parameters accepted by the classification utility v2 endpoint.
           class ClassificationParameters < Mindee::Input::BaseParameters
diff --git a/lib/mindee/v2/product/crop/crop.rb b/lib/mindee/v2/product/crop/crop.rb
@@ -6,6 +6,7 @@
 module Mindee
   module V2
     module Product
+      # Crop module.
       module Crop
         # Crop product.
         class Crop < BaseProduct
diff --git a/lib/mindee/v2/product/crop/params/crop_parameters.rb b/lib/mindee/v2/product/crop/params/crop_parameters.rb
@@ -4,6 +4,7 @@ module Mindee
   module V2
     module Product
       module Crop
+        # Crop parameters.
         module Params
           # Parameters accepted by the crop utility v2 endpoint.
           class CropParameters < Mindee::Input::BaseParameters
diff --git a/lib/mindee/v2/product/extraction/extraction.rb b/lib/mindee/v2/product/extraction/extraction.rb
@@ -6,6 +6,7 @@
 module Mindee
   module V2
     module Product
+      # Extraction module.
       module Extraction
         # Extraction product.
         # Note: currently a placeholder for the `Inference` class.
diff --git a/lib/mindee/v2/product/extraction/params/data_schema.rb b/lib/mindee/v2/product/extraction/params/data_schema.rb
@@ -6,6 +6,7 @@ module Mindee
   module V2
     module Product
       module Extraction
+        # Extraction parameters.
         module Params
           # Modify the Data Schema.
           class DataSchema
diff --git a/lib/mindee/v2/product/ocr/ocr.rb b/lib/mindee/v2/product/ocr/ocr.rb
@@ -6,12 +6,13 @@
 module Mindee
   module V2
     module Product
-      module Ocr
-        # Ocr product.
-        class Ocr < BaseProduct
+      # OCR module.
+      module OCR
+        # OCR product.
+        class OCR < BaseProduct
           @slug = 'ocr'
-          @params_type = Mindee::V2::Product::Ocr::Params::OcrParameters
-          @response_type = Mindee::V2::Product::Ocr::OcrResponse
+          @params_type = Mindee::V2::Product::OCR::Params::OCRParameters
+          @response_type = Mindee::V2::Product::OCR::OCRResponse
         end
       end
     end
diff --git a/lib/mindee/v2/product/ocr/ocr_inference.rb b/lib/mindee/v2/product/ocr/ocr_inference.rb
@@ -5,17 +5,17 @@
 module Mindee
   module V2
     module Product
-      module Ocr
+      module OCR
         # The inference result for an OCR utility request.
-        class OcrInference < Mindee::V2::Parsing::BaseInference
-          # @return [OcrResult] Parsed inference payload.
+        class OCRInference < Mindee::V2::Parsing::BaseInference
+          # @return [OCRResult] Parsed inference payload.
           attr_reader :result
 
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
             super
 
-            @result = OcrResult.new(server_response['result'])
+            @result = OCRResult.new(server_response['result'])
           end
 
           # String representation.
diff --git a/lib/mindee/v2/product/ocr/ocr_page.rb b/lib/mindee/v2/product/ocr/ocr_page.rb
@@ -5,17 +5,17 @@
 module Mindee
   module V2
     module Product
-      module Ocr
+      module OCR
         # OCR result for a single page.
-        class OcrPage
-          # @return [Array<OcrWord>] List of words extracted from the document page.
+        class OCRPage
+          # @return [Array<OCRWord>] List of words extracted from the document page.
           attr_reader :words
           # @return [String] Full text content extracted from the document page.
           attr_reader :content
 
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
-            @words = server_response['words'].map { |word| OcrWord.new(word) }
+            @words = server_response['words'].map { |word| OCRWord.new(word) }
             @content = server_response['content']
           end
 
diff --git a/lib/mindee/v2/product/ocr/ocr_response.rb b/lib/mindee/v2/product/ocr/ocr_response.rb
@@ -7,17 +7,17 @@
 module Mindee
   module V2
     module Product
-      module Ocr
+      module OCR
         # HTTP response wrapper that embeds a V2 Inference.
-        class OcrResponse < Mindee::V2::Parsing::BaseResponse
-          # @return [OcrInference] Parsed inference payload.
+        class OCRResponse < Mindee::V2::Parsing::BaseResponse
+          # @return [OCRInference] Parsed inference payload.
           attr_reader :inference
 
           # @param server_response [Hash] Hash parsed from the API JSON response.
           def initialize(server_response)
             super
 
-            @inference = OcrInference.new(server_response['inference'])
+            @inference = OCRInference.new(server_response['inference'])
           end
 
           # String representation.
diff --git a/lib/mindee/v2/product/ocr/ocr_result.rb b/lib/mindee/v2/product/ocr/ocr_result.rb
@@ -5,17 +5,17 @@
 module Mindee
   module V2
     module Product
-      module Ocr
+      module OCR
         # Result of a ocr utility inference.
-        class OcrResult
-          # @return [Array<OcrPage>] List of OCR results for each page in the document.
+        class OCRResult
+          # @return [Array<OCRPage>] List of OCR results for each page in the document.
           attr_reader :pages
 
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
             @pages = if server_response.key?('pages')
                        server_response['pages'].map do |pages|
-                         OcrPage.new(pages)
+                         OCRPage.new(pages)
                        end
                      end
           end
diff --git a/lib/mindee/v2/product/ocr/ocr_word.rb b/lib/mindee/v2/product/ocr/ocr_word.rb
@@ -3,9 +3,9 @@
 module Mindee
   module V2
     module Product
-      module Ocr
+      module OCR
         # OCR result for a single word extracted from the document page.
-        class OcrWord
+        class OCRWord
           # @return [String] Text content of the word.
           attr_reader :content
           # @return [Mindee::Geometry::Polygon] Position information as a list of points in clockwise order.
diff --git a/lib/mindee/v2/product/ocr/params/ocr_parameters.rb b/lib/mindee/v2/product/ocr/params/ocr_parameters.rb
@@ -3,10 +3,11 @@
 module Mindee
   module V2
     module Product
-      module Ocr
+      module OCR
+        # OCR Parameters.
         module Params
           # Parameters accepted by the ocr utility v2 endpoint.
-          class OcrParameters < Mindee::Input::BaseParameters
+          class OCRParameters < Mindee::Input::BaseParameters
             # @return [String] Slug for the endpoint.
             def self.slug
               'ocr'
@@ -29,9 +30,9 @@ def initialize(
 
             # Loads the parameters from a Hash.
             # @param [Hash] params Parameters to provide as a hash.
-            # @return [OcrParameters]
+            # @return [OCRParameters]
             def self.from_hash(params: {})
-              OcrParameters.new(
+              OCRParameters.new(
                 params.fetch(:model_id),
                 file_alias: params.fetch(:file_alias, nil),
                 webhook_ids: params.fetch(:webhook_ids, nil),
diff --git a/lib/mindee/v2/product/split/params/split_parameters.rb b/lib/mindee/v2/product/split/params/split_parameters.rb
@@ -3,7 +3,9 @@
 module Mindee
   module V2
     module Product
+      # Split module.
       module Split
+        # Split parameters.
         module Params
           # Parameters accepted by the split utility v2 endpoint.
           class SplitParameters < Mindee::Input::BaseParameters
diff --git a/sig/mindee/v2/product/ocr/ocr.rbs b/sig/mindee/v2/product/ocr/ocr.rbs
@@ -1,8 +1,8 @@
 module Mindee
   module V2
     module Product
-      module Ocr
-        class Ocr < BaseProduct
+      module OCR
+        class OCR < BaseProduct
         end
       end
     end
diff --git a/sig/mindee/v2/product/ocr/ocr_inference.rbs b/sig/mindee/v2/product/ocr/ocr_inference.rbs
@@ -1,9 +1,9 @@
 module Mindee
   module V2
     module Product
-      module Ocr
-        class OcrInference
-          attr_reader result: OcrResult
+      module OCR
+        class OCRInference
+          attr_reader result: OCRResult
 
           def initialize: (Hash[String | Symbol, untyped]) -> void
           def to_s: -> String
diff --git a/sig/mindee/v2/product/ocr/ocr_page.rbs b/sig/mindee/v2/product/ocr/ocr_page.rbs
@@ -1,9 +1,9 @@
 module Mindee
   module V2
     module Product
-      module Ocr
-        class OcrPage
-          attr_reader words: Array[OcrWord]
+      module OCR
+        class OCRPage
+          attr_reader words: Array[OCRWord]
           attr_reader content: String
 
           def initialize: (Hash[String | Symbol, untyped]) -> void
diff --git a/sig/mindee/v2/product/ocr/ocr_response.rbs b/sig/mindee/v2/product/ocr/ocr_response.rbs
diff --git a/sig/mindee/v2/product/ocr/ocr_result.rbs b/sig/mindee/v2/product/ocr/ocr_result.rbs
diff --git a/sig/mindee/v2/product/ocr/ocr_word.rbs b/sig/mindee/v2/product/ocr/ocr_word.rbs
diff --git a/sig/mindee/v2/product/ocr/params/ocr_parameters/ocr_parameters.rbs b/sig/mindee/v2/product/ocr/params/ocr_parameters/ocr_parameters.rbs
diff --git a/spec/v2/product/ocr/ocr_integration.rb b/spec/v2/product/ocr/ocr_integration.rb
diff --git a/spec/v2/product/ocr/ocr_spec.rb b/spec/v2/product/ocr/ocr_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ input_source = Mindee::Input::Source::PathInputSource.new(input_path)`
`21`	`21`
`22`	`22`	`# Send for processing`
`23`	`23`	`response = mindee_client.enqueue_and_get_result(`
`24`		`- Mindee::V2::Product::Ocr::Ocr,`
	`24`	`+ Mindee::V2::Product::OCR::Ocr,`
`25`	`25`	`input_source,`
`26`	`26`	`ocr_params`
`27`	`27`	`)`