[DO NOT MERGE] Upgrade Pub/Sub samples. #63
Conversation
| require "google/cloud" | ||
|
|
||
| gcloud = Google::Cloud.new | ||
| $pubsub_client = gcloud.pubsub |
There was a problem hiding this comment.
Please do not use global variables
| # For more information, see the README.md under /pubsub and the documentation at | ||
| # https://cloud.google.com/pubsub/docs. | ||
|
|
||
| require "google/cloud" |
There was a problem hiding this comment.
Please include gem requirement and client instantiation in snippets
See example of Ruby sample snippet template: create_dataset
| gcloud = Google::Cloud.new | ||
| $pubsub_client = gcloud.pubsub | ||
|
|
||
| # [START pubsub_list_subscriptions] |
There was a problem hiding this comment.
Please do not include method definition in Ruby sample snippet
See example of Ruby sample snippet template: create_dataset
|
|
||
| # [START pubsub_list_topic_subscriptions] | ||
| def list_topic_subscriptions topic_name: | ||
| # References an existing topic, e.g. "my-topic" |
There was a problem hiding this comment.
Ruby sample snippets use in-line variable definitions that document required variables.
Example of Ruby sample snippet template: create_dataset
# project_id = "Your Google Cloud project ID"
# dataset_id = "ID of the dataset to create"
require "google/cloud"
gcloud = Google::Cloud.new project_id
bigquery = gcloud.bigquery
bigquery.create_dataset dataset_id
puts "Created dataset: #{dataset_id}"This provides a good developer user experience allowing the developer to copy the whole snippet into IRB or an .rb file, replace the placeholder variable, and get up-and-running
| # [START pubsub_list_topic_subscriptions] | ||
| def list_topic_subscriptions topic_name: | ||
| # References an existing topic, e.g. "my-topic" | ||
| topic = $pubsub_client.topic topic_name, skip_lookup: true |
There was a problem hiding this comment.
Do not use skip_lookup option
To get a topic using google-cloud-pubsub:
require "google/cloud"
gcloud = Google::Cloud.new
pubsub = gcloud.pubsub
topic = pubsub.topic "existing-topic"| # References an existing topic, e.g. "my-topic" | ||
| topic = $pubsub_client.topic topic_name, skip_lookup: true | ||
|
|
||
| project_id = ENV["GCLOUD_PROJECT"] || "YOUR_PROJECT_ID" |
There was a problem hiding this comment.
Sample snippets should not contain conditional logic. This snippet should not include a reference to environment variables. The project ID should be stored in variable that the developer can edit.
Please use a project_id variable such as the following convention followed by Ruby sample snippets:
# project_id = "Your Google Cloud project ID"
# topic_name = "Name of topic to subscribe to, eg. my-topic"
# subscription_name = "Name of subscription to create, eg. my-subscription"
require "google/cloud"
gcloud = Google::Cloud.new
pubsub = gcloud.pubsub
topic = pubsub.topic
subscription = topic.subscribe(
subscription_name,
# Set to an HTTPS endpoint of your choice. If necessary, register
# (authorize) the domain on which the server is hosted.
endpoint: "https://#{project_id}.appspot.com/push"
)
puts "Subscription #{subscription.name} created."
jmdobry
changed the title
|
See also Proposals implemented by the 3 PRs: |
jmdobry
force-pushed
the
pubsub-sample-style
branch
from
502e990 to
e5e8b97
Compare
jmdobry
force-pushed
the
pubsub-sample-style
branch
from
e5e8b97 to
e1a0c74
Compare
|
Pub/Sub sample has been updated to use the latest google-cloud-pubsub library. Existing Pub/Sub code is continuing to be improved, as is. This code does not match idioms of Ruby, Google Cloud Ruby library, or that of other samples in this repository. Also missing test coverage. Can be reopened pending fixes and offline consistency decision making. |
topics.rbandsubscriptions.rbgoogle-cloud-pubsubpackageCompare to: