google-cloud-document_ai 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6493b60788527b7218abc5054aa7c701b8555eb9564c3a0419d3eb5148a6561
-  data.tar.gz: e4d25262e1cfd5255108a0a7226dd78950c1633f6d8e3600ba597d6c8d78e8c3
+  metadata.gz: 0ee39d470f05e36357d4412614cfda148189cf6a17107a1efbadce9b64ac5007
+  data.tar.gz: b7f73db076d361b2c564733a5bc17990ed7d568bbadf6cd15251b40e06b5cc4e
 SHA512:
-  metadata.gz: ce7c860e6a431fbb7c99159d95b6466bcfec721b8e3c765e123ece2812aec9df6c69fe1afbeb82e7a1137a487868445d83c0cf9c516def8f7caed8ac3efea0ee
-  data.tar.gz: 8d9141f3aa694a0c72c3866010d5c3e8b5b2c7abf95021ad23f3ec2136ef0cc67618e0c8789d3449101d970aec494c044a5abce5775eb4dac31a7e201d275e89
+  metadata.gz: b6e828283f7a6746fcc93576542bea21c19761b01b2a377d992ba0effb6422acd48a4f939c7214797632518640b313c43cb69f502b247389df9e809cb9b616ca
+  data.tar.gz: f65116627cc33c429d80d0902f8cbb1cbea0fe729b9b7e28015f1f19a1b2737e5cf03e826f1cf00134de500f71aa60390145c9c64d6a4c027365172cfe54c8b0

data/README.md

@@ -19,7 +19,7 @@ client gems:
 [google-cloud-document_ai-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-document_ai-v1/latest),
 [google-cloud-document_ai-v1beta3](https://cloud.google.com/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest).
 
-See also the [Product Documentation](https://cloud.google.com/document-ai/)
+See also the [Product Documentation](https://cloud.google.com/document-ai/docs)
 for more usage information.
 
 ## Quick Start
@@ -32,12 +32,43 @@ In order to use this library, you first need to go through the following steps:
 
 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-1. [Enable the API.](https://console.cloud.google.com/apis/library/us-documentai.googleapis.com)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/documentai.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-document_ai-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-document_ai-v1/latest),
+[google-cloud-document_ai-v1beta3](https://cloud.google.com/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/document_ai/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module DocumentAI
-      VERSION = "1.4.0"
+      VERSION = "1.5.0"
     end
   end
 end

data/lib/google/cloud/document_ai.rb

@@ -58,6 +58,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the DocumentProcessorService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::DocumentAI.document_processor_service_available?}.
+      #
       # ## About DocumentProcessorService
       #
       # Service to call Document AI to process documents according to the
@@ -82,6 +87,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the DocumentProcessorService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::DocumentAI.document_processor_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the DocumentProcessorService service,
+      # or if the versioned client gem needs an update to support the DocumentProcessorService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.document_processor_service_available? version: :v1, transport: :grpc
+        require "google/cloud/document_ai/#{version.to_s.downcase}"
+        package_name = Google::Cloud::DocumentAI
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::DocumentAI.const_get package_name
+        return false unless service_module.const_defined? :DocumentProcessorService
+        service_module = service_module.const_get :DocumentProcessorService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-document_ai library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -83,7 +82,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -91,15 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the Document AI API
 test_files: []