google-apps-events-subscriptions-v1 0.a → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b333e4f380fd34e82a95512e8dd3173dc2f3c538e3be906db2950b8f913cca6
-  data.tar.gz: 44495d1c9f30444d3ab5275165660bd24c377dcf1f865189c3bfe9c2a27a19e9
+  metadata.gz: f0fb611c3d455b50917a9ec9f6d04323e3d086a8f9b46488314c134fd6cf6702
+  data.tar.gz: 68fad11a689bc9cd440ec20e76d49384f415204edf8869c6b12fdf7a2fe7d600
 SHA512:
-  metadata.gz: e7b4c5def325996c466a083c18214b83514e32153cce6e42f4265461b0bf981ae2468348eb6e119c2e45d4862de2f5416cc7e70e9f33e989e4fdcf91e997f95b
-  data.tar.gz: 0201ae0432c9bc36c4f9e48202f4d437c1fd5cfd19bfc77921ff05404c163fe2204c5719a2c5141e220b70823b5b13ebc374fa98cf9ab59d8ae1c776afe4bcd6
+  metadata.gz: c887293fb9c668c0180ffe5d2ba262e59dc6a9b104a45310175c427abd447b768c72218cfb0becafeb95350f4013775f9a32c291a7d2c43102dd96b8fa081850
+  data.tar.gz: 6e0a713db2f1e753b2871fbfe7318801ec6a10723831aae1820478d38f7b3781179320cf2dd855279d58ae28e0b6bb1869339878a85ea98c0561caabde41403b

data/.yardopts

@@ -0,0 +1,12 @@
+--no-private
+--title="Google Workspace Events V1 API"
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+./proto_docs/**/*.rb
+-
+README.md
+LICENSE.md
+AUTHENTICATION.md

data/AUTHENTICATION.md

@@ -0,0 +1,122 @@
+# Authentication
+
+The recommended way to authenticate to the google-apps-events-subscriptions-v1 library is to use
+[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
+To review all of your authentication options, see [Credentials lookup](#credential-lookup).
+
+## Quickstart
+
+The following example shows how to set up authentication for a local development
+environment with your user credentials. 
+
+**NOTE:** This method is _not_ recommended for running in production. User credentials
+should be used only during development.
+
+1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
+2. Set up a local ADC file with your user credentials:
+
+```sh
+gcloud auth application-default login
+```
+
+3. Write code as if already authenticated.
+
+For more information about setting up authentication for a local development environment, see
+[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
+
+## Credential Lookup
+
+The google-apps-events-subscriptions-v1 library provides several mechanisms to configure your system.
+Generally, using Application Default Credentials to facilitate automatic 
+credentials discovery is the easist method. But if you need to explicitly specify
+credentials, there are several methods available to you.
+
+Credentials are accepted in the following ways, in the following order or precedence:
+
+1. Credentials specified in method arguments
+2. Credentials specified in configuration
+3. Credentials pointed to or included in environment variables
+4. Credentials found in local ADC file
+5. Credentials returned by the metadata server for the attached service account (GCP)
+
+### Configuration
+
+You can configure a path to a JSON credentials file, either for an individual client object or
+globally, for all client objects. The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
+
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
+
+To configure a credentials file for an individual client initialization:
+
+```ruby
+require "google/apps/events/subscriptions/v1"
+
+client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+```
+
+To configure a credentials file globally for all clients:
+
+```ruby
+require "google/apps/events/subscriptions/v1"
+
+::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.configure do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+
+client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new
+```
+
+### Environment Variables
+
+You can also use an environment variable to provide a JSON credentials file.
+The environment variable can contain a path to the credentials file or, for
+environments such as Docker containers where writing files is not encouraged,
+you can include the credentials file itself.
+
+The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
+
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
+
+The environment variables that google-apps-events-subscriptions-v1
+checks for credentials are:
+
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/apps/events/subscriptions/v1"
+
+ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
+
+client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new
+```
+
+### Local ADC file
+
+You can set up a local ADC file with your user credentials for authentication during
+development. If credentials are not provided in code or in environment variables,
+then the local ADC credentials are discovered.
+
+Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
+
+### Google Cloud Platform environments
+
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, credentials are retrieved from the attached
+service account automatically. Code should be written as if already authenticated.
+
+For more information, see
+[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).

data/README.md

@@ -1,8 +1,144 @@
-# Placeholder for Ruby gem google-apps-events-subscriptions-v1
-
-This is a placeholder for the future Google-authored gem google-apps-events-subscriptions-v1.
-This placeholder is being released on 2024-02-15 in order to reserve the name.
-The final gem should be available shortly after that date. If it has not been
-released in a timely manner, or if this placeholder interferes with your work,
-you can contact the Google Ruby team by opening an issue in the GitHub
-repository https://github.com/googleapis/google-cloud-ruby.
+# Ruby Client for the Google Workspace Events V1 API
+
+The Google Workspace Events API lets you subscribe to events and manage change notifications across Google Workspace applications.
+
+The Google Workspace Events API lets you subscribe to events and manage change notifications across Google Workspace applications.
+
+https://github.com/googleapis/google-cloud-ruby
+
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Google Workspace Events V1 API. Most users should consider using
+the main client gem,
+[google-apps-events-subscriptions](https://rubygems.org/gems/google-apps-events-subscriptions).
+See the section below titled *Which client should I use?* for more information.
+
+## Installation
+
+```
+$ gem install google-apps-events-subscriptions-v1
+```
+
+## Before You Begin
+
+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/workspaceevents.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/apps/events/subscriptions/v1"
+
+client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new
+request = ::Google::Apps::Events::Subscriptions::V1::CreateSubscriptionRequest.new # (request fields as keyword arguments...)
+response = client.create_subscription request
+```
+
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-apps-events-subscriptions-v1/latest)
+for class and method documentation.
+
+See also the [Product Documentation](https://developers.google.com/workspace/events)
+for general usage information.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 2.7+.
+
+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
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-apps-events-subscriptions`,
+and lower-level _versioned_ client libraries with names such as
+`google-apps-events-subscriptions-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-apps-events-subscriptions`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-apps-events-subscriptions-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google/apps/events/subscriptions/v1/rest.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/apps/events/subscriptions/v1/subscriptions_service/rest"
+require "google/apps/events/subscriptions/v1/version"
+
+module Google
+  module Apps
+    module Events
+      module Subscriptions
+        ##
+        # To load just the REST part of this package, including all its services, and instantiate a REST client:
+        #
+        # @example
+        #
+        #     require "google/apps/events/subscriptions/v1/rest"
+        #     client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::Client.new
+        #
+        module V1
+        end
+      end
+    end
+  end
+end

data/lib/google/apps/events/subscriptions/v1/subscription_resource_pb.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/apps/events/subscriptions/v1/subscription_resource.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+
+
+descriptor_data = "\n?google/apps/events/subscriptions/v1/subscription_resource.proto\x12#google.apps.events.subscriptions.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1egoogle/protobuf/duration.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xbf\t\n\x0cSubscription\x12\x36\n\x0b\x65xpire_time\x18\r \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x07H\x00\x12-\n\x03ttl\x18\x0e \x01(\x0b\x32\x19.google.protobuf.DurationB\x03\xe0\x41\x04H\x00\x12\x17\n\x04name\x18\x01 \x01(\tB\t\xe0\x41\x08\xe0\x41\x05\xe0\x41\x01\x12\x10\n\x03uid\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12%\n\x0ftarget_resource\x18\x04 \x01(\tB\x0c\xe0\x41\x05\xe0\x41\x02\xfa\x41\x03\n\x01*\x12\x1e\n\x0b\x65vent_types\x18\x05 \x03(\tB\t\xe0\x41\x02\xe0\x41\x06\xe0\x41\x05\x12Q\n\x0fpayload_options\x18\x06 \x01(\x0b\x32\x33.google.apps.events.subscriptions.v1.PayloadOptionsB\x03\xe0\x41\x01\x12`\n\x15notification_endpoint\x18\x07 \x01(\x0b\x32\x39.google.apps.events.subscriptions.v1.NotificationEndpointB\x06\xe0\x41\x02\xe0\x41\x05\x12K\n\x05state\x18\x08 \x01(\x0e\x32\x37.google.apps.events.subscriptions.v1.Subscription.StateB\x03\xe0\x41\x03\x12[\n\x11suspension_reason\x18\x12 \x01(\x0e\x32;.google.apps.events.subscriptions.v1.Subscription.ErrorTypeB\x03\xe0\x41\x03\x12<\n\tauthority\x18\n \x01(\tB)\xe0\x41\x03\xfa\x41#\n!cloudidentity.googleapis.com/User\x12\x34\n\x0b\x63reate_time\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x0c \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x18\n\x0breconciling\x18\x0f \x01(\x08\x42\x03\xe0\x41\x03\x12\x11\n\x04\x65tag\x18\x11 \x01(\tB\x03\xe0\x41\x01\"F\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\n\n\x06\x41\x43TIVE\x10\x01\x12\r\n\tSUSPENDED\x10\x02\x12\x0b\n\x07\x44\x45LETED\x10\x03\"\xd9\x01\n\tErrorType\x12\x1a\n\x16\x45RROR_TYPE_UNSPECIFIED\x10\x00\x12\x16\n\x12USER_SCOPE_REVOKED\x10\x01\x12\x14\n\x10RESOURCE_DELETED\x10\x02\x12\x1e\n\x1aUSER_AUTHORIZATION_FAILURE\x10\x03\x12\x1e\n\x1a\x45NDPOINT_PERMISSION_DENIED\x10\x04\x12\x16\n\x12\x45NDPOINT_NOT_FOUND\x10\x06\x12\x1f\n\x1b\x45NDPOINT_RESOURCE_EXHAUSTED\x10\x07\x12\t\n\x05OTHER\x10\x05:n\xea\x41k\n+workspaceevents.googleapis.com/Subscription\x12\x1csubscriptions/{subscription}*\rsubscriptions2\x0csubscriptionR\x01\x01\x42\x0c\n\nexpiration\"d\n\x0ePayloadOptions\x12\x1d\n\x10include_resource\x18\x01 \x01(\x08\x42\x03\xe0\x41\x01\x12\x33\n\nfield_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMaskB\x03\xe0\x41\x01\"_\n\x14NotificationEndpoint\x12;\n\x0cpubsub_topic\x18\x01 \x01(\tB#\xe0\x41\x05\xfa\x41\x1d\n\x1bpubsub.googleapis.com/TopicH\x00\x42\n\n\x08\x65ndpointB\x88\x03\n\'com.google.apps.events.subscriptions.v1B\x19SubscriptionResourceProtoP\x01ZScloud.google.com/go/apps/events/subscriptions/apiv1/subscriptionspb;subscriptionspb\xaa\x02#Google.Apps.Events.Subscriptions.V1\xca\x02#Google\\Apps\\Events\\Subscriptions\\V1\xea\x02\'Google::Apps::Events::Subscriptions::V1\xea\x41\x31\n!cloudidentity.googleapis.com/User\x12\x0cusers/{user}\xea\x41@\n\x1bpubsub.googleapis.com/Topic\x12!projects/{project}/topics/{topic}b\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+    ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
+    ["google.protobuf.Duration", "google/protobuf/duration.proto"],
+    ["google.protobuf.FieldMask", "google/protobuf/field_mask.proto"],
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
+  end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
+end
+
+module Google
+  module Apps
+    module Events
+      module Subscriptions
+        module V1
+          Subscription = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.apps.events.subscriptions.v1.Subscription").msgclass
+          Subscription::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.apps.events.subscriptions.v1.Subscription.State").enummodule
+          Subscription::ErrorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.apps.events.subscriptions.v1.Subscription.ErrorType").enummodule
+          PayloadOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.apps.events.subscriptions.v1.PayloadOptions").msgclass
+          NotificationEndpoint = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.apps.events.subscriptions.v1.NotificationEndpoint").msgclass
+        end
+      end
+    end
+  end
+end