samples

Google Cloud Pub/Sub Ruby Samples

Google Cloud Pub/Sub is a simple, reliable, scalable foundation for stream analytics and event-driven computing systems.

Setup

Authentication

Authentication is typically done through Application Default Credentials , which means you do not have to change the code to authenticate as long as your environment has credentials. You have a few options for setting up authentication:

When running locally, use the Google Cloud SDK
```
gcloud auth application-default login
```
When running on App Engine or Compute Engine, credentials are already set-up. However, you may need to configure your Compute Engine instance with additional scopes.
You can create a Service Account key file . This file can be used to authenticate to Google Cloud Platform services from any environment. To use the file, set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path to the key file, for example:
```
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json
```

Set Project ID

Next, set the GOOGLE_CLOUD_PROJECT environment variable to the project name set in the Google Cloud Platform Developer Console:

export GOOGLE_CLOUD_PROJECT="YOUR-PROJECT-ID"

Install Dependencies

Install the Bundler gem.
Install dependencies using:
```
bundle install
```

Run samples

If using the topics.rb create_push_subscription command (see below), first deploy the push listener App Engine app defined in listener.rb and configured in app.yaml. The endpoint argument to create_push_subscription should look like https://my-project.appspot.com/push. You can see messages pushed to the listener in Google Cloud Logging, or simply run tail on the logs as shown below.

gcloud app deploy --promote
gcloud app logs tail -s default

Run the quickstart sample to create a topic:

bundle exec ruby quickstart.rb <topic_id>

Run the sample for using topics:

bundle exec ruby topics.rb

Usage:

bundle exec ruby topics.rb [command] [arguments]

Commands:
create_topic                                    <project_id> <topic_id>                              Create a topic
list_topics                                     <project_id>                                         List topics in a project
list_topic_subscriptions                        <project_id> <topic_id>                              List subscriptions in a topic
delete_topic                                    <project_id> <topic_id>                              Delete topic policies
get_topic_policy                                <project_id> <topic_id>                              Get topic policies
set_topic_policy                                <project_id> <topic_id>                              Set topic policies
test_topic_permissions                          <project_id> <topic_id>                              Test topic permissions
create_pull_subscription                        <project_id> <topic_id> <subscription_id>            Create a pull subscription
create_push_subscription                        <project_id> <topic_id> <subscription_id> <endpoint> Create a push subscription
publish_message                                 <project_id> <topic_id>                              Publish message
publish_message_async                           <project_id> <topic_id>                              Publish messages asynchronously
publish_messages_async_with_batch_settings      <project_id> <topic_id>                              Publish messages asynchronously in batch
publish_message_async_with_custom_attributes    <project_id> <topic_id>                              Publish messages asynchronously with custom attributes
publish_messages_async_with_concurrency_control <project_id> <topic_id>                              Publish messages asynchronously with concurrency control

Example:

bundle exec ruby topics.rb create_topic my-new-topic

Topic my-new-topic created.

Run the sample for using subscriptions:

bundle exec ruby subscriptions.rb

Usage:

bundle exec ruby subscriptions.rb [command] [arguments]

Commands:
update_push_configuration                    <project_id> <subscription_id> <endpoint> Update the endpoint of a push subscription
list_subscriptions                           <project_id>                              List subscriptions of a project
delete_subscription                          <project_id> <subscription_id>            Delete a subscription
get_subscription_policy                      <project_id> <subscription_id>            Get policies of a subscription
set_subscription_policy                      <project_id> <subscription_id>            Set policies of a subscription
test_subscription_policy                     <project_id> <subscription_id>            Test policies of a subscription
listen_for_messages                          <project_id> <subscription_id>            Listen for messages
listen_for_messages_with_custom_attributes   <project_id> <subscription_id>            Listen for messages with custom attributes
pull_messages                                <project_id> <subscription_id>            Pull messages
listen_for_messages_with_error_handler       <project_id> <subscription_id>            Listen for messages with an error handler
listen_for_messages_with_flow_control        <project_id> <subscription_id>            Listen for messages with flow control
listen_for_messages_with_concurrency_control <project_id> <subscription_id>            Listen for messages with concurrency control

Example:

bundle exec ruby subscriptions.rb list_subscriptions

Subscriptions:
YOUR-SUBSCRIPTION

Test samples

Test the samples using the Project ID configured above:

bundle exec rake test

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

Google Cloud Pub/Sub Ruby Samples

Setup

Authentication

Set Project ID

Install Dependencies

Run samples

Test samples

Name		Name	Last commit message	Last commit date
parent directory ..
acceptance		acceptance
utilities		utilities
.rubocop.yml		.rubocop.yml
CONTRIBUTING.md		CONTRIBUTING.md
Gemfile		Gemfile
README.md		README.md
Rakefile		Rakefile
app.yaml		app.yaml
listener.rb		listener.rb
pubsub_commit_avro_schema.rb		pubsub_commit_avro_schema.rb
pubsub_commit_proto_schema.rb		pubsub_commit_proto_schema.rb
pubsub_create_avro_schema.rb		pubsub_create_avro_schema.rb
pubsub_create_bigquery_subscription.rb		pubsub_create_bigquery_subscription.rb
pubsub_create_cloud_storage_subscription.rb		pubsub_create_cloud_storage_subscription.rb
pubsub_create_proto_schema.rb		pubsub_create_proto_schema.rb
pubsub_create_pull_subscription.rb		pubsub_create_pull_subscription.rb
pubsub_create_push_subscription.rb		pubsub_create_push_subscription.rb
pubsub_create_subscription_with_exactly_once_delivery.rb		pubsub_create_subscription_with_exactly_once_delivery.rb
pubsub_create_subscription_with_filter.rb		pubsub_create_subscription_with_filter.rb
pubsub_create_subscription_with_smt.rb		pubsub_create_subscription_with_smt.rb
pubsub_create_topic.rb		pubsub_create_topic.rb
pubsub_create_topic_with_aws_msk_ingestion.rb		pubsub_create_topic_with_aws_msk_ingestion.rb
pubsub_create_topic_with_azure_event_hubs_ingestion.rb		pubsub_create_topic_with_azure_event_hubs_ingestion.rb
pubsub_create_topic_with_cloud_storage_ingestion.rb		pubsub_create_topic_with_cloud_storage_ingestion.rb
pubsub_create_topic_with_confluent_cloud_ingestion.rb		pubsub_create_topic_with_confluent_cloud_ingestion.rb
pubsub_create_topic_with_kinesis_ingestion.rb		pubsub_create_topic_with_kinesis_ingestion.rb
pubsub_create_topic_with_schema.rb		pubsub_create_topic_with_schema.rb
pubsub_create_topic_with_schema_revisions.rb		pubsub_create_topic_with_schema_revisions.rb
pubsub_create_topic_with_smt.rb		pubsub_create_topic_with_smt.rb
pubsub_create_unwrapped_push_subscription.rb		pubsub_create_unwrapped_push_subscription.rb
pubsub_dead_letter_create_subscription.rb		pubsub_dead_letter_create_subscription.rb
pubsub_dead_letter_delivery_attempt.rb		pubsub_dead_letter_delivery_attempt.rb
pubsub_dead_letter_remove.rb		pubsub_dead_letter_remove.rb
pubsub_dead_letter_update_subscription.rb		pubsub_dead_letter_update_subscription.rb
pubsub_delete_schema.rb		pubsub_delete_schema.rb
pubsub_delete_schema_revision.rb		pubsub_delete_schema_revision.rb
pubsub_delete_subscription.rb		pubsub_delete_subscription.rb
pubsub_delete_topic.rb		pubsub_delete_topic.rb
pubsub_detach_subscription.rb		pubsub_detach_subscription.rb
pubsub_enable_subscription_ordering.rb		pubsub_enable_subscription_ordering.rb
pubsub_get_schema.rb		pubsub_get_schema.rb
pubsub_get_schema_revision.rb		pubsub_get_schema_revision.rb
pubsub_get_subscription_policy.rb		pubsub_get_subscription_policy.rb
pubsub_get_topic_policy.rb		pubsub_get_topic_policy.rb
pubsub_list_schema_revisions.rb		pubsub_list_schema_revisions.rb
pubsub_list_schemas.rb		pubsub_list_schemas.rb
pubsub_list_subscriptions.rb		pubsub_list_subscriptions.rb
pubsub_list_topic_subscriptions.rb		pubsub_list_topic_subscriptions.rb
pubsub_list_topics.rb		pubsub_list_topics.rb
pubsub_optimistic_subscribe.rb		pubsub_optimistic_subscribe.rb
pubsub_publish.rb		pubsub_publish.rb
pubsub_publish_avro_records.rb		pubsub_publish_avro_records.rb
pubsub_publish_custom_attributes.rb		pubsub_publish_custom_attributes.rb
pubsub_publish_proto_messages.rb		pubsub_publish_proto_messages.rb
pubsub_publish_with_error_handler.rb		pubsub_publish_with_error_handler.rb
pubsub_publish_with_ordering_keys.rb		pubsub_publish_with_ordering_keys.rb
pubsub_publisher_batch_settings.rb		pubsub_publisher_batch_settings.rb
pubsub_publisher_concurrency_control.rb		pubsub_publisher_concurrency_control.rb
pubsub_publisher_flow_control.rb		pubsub_publisher_flow_control.rb
pubsub_publisher_with_compression.rb		pubsub_publisher_with_compression.rb
pubsub_quickstart_publisher.rb		pubsub_quickstart_publisher.rb
pubsub_resume_publish_with_ordering_keys.rb		pubsub_resume_publish_with_ordering_keys.rb
pubsub_set_subscription_policy.rb		pubsub_set_subscription_policy.rb
pubsub_set_topic_policy.rb		pubsub_set_topic_policy.rb
pubsub_subscribe_avro_records.rb		pubsub_subscribe_avro_records.rb
pubsub_subscribe_avro_records_with_revisions.rb		pubsub_subscribe_avro_records_with_revisions.rb
pubsub_subscribe_proto_messages.rb		pubsub_subscribe_proto_messages.rb
pubsub_subscriber_async_pull.rb		pubsub_subscriber_async_pull.rb
pubsub_subscriber_async_pull_custom_attributes.rb		pubsub_subscriber_async_pull_custom_attributes.rb
pubsub_subscriber_concurrency_control.rb		pubsub_subscriber_concurrency_control.rb
pubsub_subscriber_error_listener.rb		pubsub_subscriber_error_listener.rb
pubsub_subscriber_exactly_once_delivery.rb		pubsub_subscriber_exactly_once_delivery.rb
pubsub_subscriber_flow_settings.rb		pubsub_subscriber_flow_settings.rb
pubsub_subscriber_sync_pull.rb		pubsub_subscriber_sync_pull.rb
pubsub_subscriber_sync_pull_with_lease.rb		pubsub_subscriber_sync_pull_with_lease.rb
pubsub_test_subscription_permissions.rb		pubsub_test_subscription_permissions.rb
pubsub_test_topic_permissions.rb		pubsub_test_topic_permissions.rb
pubsub_update_push_configuration.rb		pubsub_update_push_configuration.rb
pubsub_update_topic_type.rb		pubsub_update_topic_type.rb
quickstart.rb		quickstart.rb

FilesExpand file tree

samples

Directory actions

More options

Directory actions

More options

Latest commit

History

samples

Folders and files

parent directory

README.md

Google Cloud Pub/Sub Ruby Samples

Setup

Authentication

Set Project ID

Install Dependencies

Run samples

Test samples