Clean up SNS examples (Ruby v3 AWS SDK)

Author: brmur

ruby/example_code/sns/README.md

@@ -0,0 +1,26 @@
+# Amazon Cloudwatch JavaScript SDK v3 code examples
+Amazon Cloudwatch enables you to collect, access, and correlate this data on a single platform from across all your AWS resources, applications, and services.
+
+## Code examples
+This is a workspace where you can find the following AWS SDK for JavaScript version 3 (v3) Amazon Cloudwatch examples:
+
+- [Create a subscription](./sns-ruby-example-create-subscription.rb)
+- [Create a topic](./sns-ruby-example-create-topic.rb)
+- [Enable a resource](./sns-ruby-example-enable-resource.rb)
+- [Send a message](./sns-ruby-example-send-message.rb)
+- [List subscriptions](./sns-ruby-example-show-subscriptions.rb)
+- [List topics](./sns-ruby-example-show-topics.rb)
+
+
+## Getting started
+
+1. Clone the [AWS Code Samples repo](https://github.com/awsdocs/aws-doc-sdk-examples) to your local environment. 
+See [the Github documentation](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) for 
+instructions.
+
+
+## Resources
+- [AWS SDK for Ruby repo](https://github.com/aws/aws-sdk-ruby) . 
+- [AWS SDK for Ruby Developer Guide](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/welcome.html)
+- [AWS SDK for Ruby v3 API Reference Guide](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/) 
+

ruby/example_code/sns/sns-ruby-example-create-subscription.rb

@@ -1,36 +1,47 @@
-# snippet-comment:[These are tags for the AWS doc team's sample catalog. Do not remove.]
-# snippet-sourceauthor:[Doug-AWS]
-# snippet-sourcedescription:[Subscribes a user to an SNS topic.]
-# snippet-keyword:[Amazon Simple Notification Service]
-# snippet-keyword:[topic method]
-# snippet-keyword:[Topic.subscribe method]
-# snippet-keyword:[Ruby]
-# snippet-sourcesyntax:[ruby]
-# snippet-service:[sns]
-# snippet-keyword:[Code Sample]
-# snippet-sourcetype:[full-example]
-# snippet-sourcedate:[2018-03-16]
-# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# This file is licensed under the Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License. A copy of the
-# License is located at
-#
-# http://aws.amazon.com/apache2.0/
-#
-# This file 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.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 
+# Purpose:
+# sns-ruby-example-create-subscription.rb demonstrates how to create an Amazon Simple Notification Services (SNS) subscription using
+# the AWS SDK for JavaScript (v3).
+
+# Inputs:
+# - REGION
+# - SNS_TOPIC_ARN
+# - EMAIL_ADDRESS
+
+# snippet-start:[sns.Ruby.createSubscription]
 require 'aws-sdk-sns'  # v2: require 'aws-sdk'
 
-sns = Aws::SNS::Resource.new(region: 'us-west-2')
+def subscription_created?(sns_client, topic_arn, protocol, endpoint)
+
+  sns_client.subscribe(topic_arn: topic_arn, protocol: protocol, endpoint: endpoint)
+
+rescue StandardError => e
+  puts "Error while creating the subscription: #{e.message}"
+end
+# snippet-end:[sns.Ruby.createSubscription]
+#
+# Full example call:
+def run_me
+
+protocol = 'email'
+endpoint = '[email protected]'
+topic_arn = 'arn:aws:sns:eu-west-1:164794437551:brmurrubytopic'
+region = 'eu-west-1'
+
+sns_client = Aws::SNS::Client.new(region: region)
+
+puts "Creating the subscription."
 
-topic = sns.topic('arn:aws:sns:us-west-2:123456789:MyGroovyTopic')
+  if subscription_created?(sns_client, topic_arn, protocol, endpoint)
+    puts 'The subscriptions was created.'
+  else
+    puts 'The subscription was not created. Stopping program.'
+    exit 1
+  end
+end
 
-sub = topic.subscribe({
-  protocol: 'email',
-  endpoint: '[email protected]'
-})
+run_me if $PROGRAM_NAME == __FILE__
 
-puts sub.arn
+# snippet-end:[sns.Ruby.createSubscription]

ruby/example_code/sns/sns-ruby-example-create-topic.rb

@@ -1,29 +1,40 @@
-# snippet-comment:[These are tags for the AWS doc team's sample catalog. Do not remove.]
-# snippet-sourceauthor:[Doug-AWS]
-# snippet-sourcedescription:[Creates an SNS topic.]
-# snippet-keyword:[Amazon Simple Notification Service]
-# snippet-keyword:[create_topic method]
-# snippet-keyword:[Ruby]
-# snippet-sourcesyntax:[ruby]
-# snippet-service:[sns]
-# snippet-keyword:[Code Sample]
-# snippet-sourcetype:[full-example]
-# snippet-sourcedate:[2018-03-16]
-# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# This file is licensed under the Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License. A copy of the
-# License is located at
-#
-# http://aws.amazon.com/apache2.0/
-#
-# This file 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.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 
+# Purpose:
+# sns-ruby-example-create-topic.rb demonstrates how to create an Amazon Simple Notification Services (SNS) topic using
+# the AWS SDK for JavaScript (v3).
+
+# Inputs:
+# - REGION
+# - TOPIC_NAME
+
+# snippet-start:[sns.Ruby.createTopic]
 require 'aws-sdk-sns'  # v2: require 'aws-sdk'
 
-sns = Aws::SNS::Resource.new(region: 'us-west-2')
+def topic_created?(sns_client, topic_name)
+
+sns_client.create_topic(name: topic_name)
+rescue StandardError => e
+  puts "Error while creating the topic named '#{topic_name}': #{e.message}"
+end
+# snippet-end:[sns.Ruby.createTopic]
+# Full example call:
+def run_me
+  topic_name = 'doc-example-topic'
+  region = 'eu-west-1'
+
+  sns_client = Aws::SNS::Client.new(region: region)
+
+  puts "Creating the topic '#{topic_name}'..."
+
+  if topic_created?(sns_client, topic_name)
+    puts 'The topic was created.'
+  else
+    puts 'The topic was not created. Stopping program.'
+    exit 1
+  end
+end
 
-topic = sns.create_topic(name: 'MyGroovyTopic')
-puts topic.arn
+run_me if $PROGRAM_NAME == __FILE__
+# snippet-end:[sns.Ruby.createTopic]

ruby/example_code/sns/sns-ruby-example-enable-resource.rb

@@ -1,27 +1,17 @@
-# snippet-comment:[These are tags for the AWS doc team's sample catalog. Do not remove.]
-# snippet-sourceauthor:[Doug-AWS]
-# snippet-sourcedescription:[Enables a resource to publish to an SNS topic.]
-# snippet-keyword:[Amazon Simple Notification Service]
-# snippet-keyword:[Resource.topic method]
-# snippet-keyword:[Topic.set_attributes method]
-# snippet-keyword:[Ruby]
-# snippet-sourcesyntax:[ruby]
-# snippet-service:[sns]
-# snippet-keyword:[Code Sample]
-# snippet-sourcetype:[full-example]
-# snippet-sourcedate:[2018-03-16]
-# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# This file is licensed under the Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License. A copy of the
-# License is located at
-#
-# http://aws.amazon.com/apache2.0/
-#
-# This file 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.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 
+# Purpose:
+# sns-ruby-example-enable-resource.rb demonstrates how to enable an Amazon Simple Notification Services (SNS) resource using
+# the AWS SDK for JavaScript (v3).
+
+# Inputs:
+# - MY_TOPIC_ARN
+# - MY_RESOURCE_ARN
+# - REGION
+# - POLICY_NAME
+
+# snippet-start:[sns.Ruby.enableResource]
 require 'aws-sdk-sns'  # v2: require 'aws-sdk'
 
 policy  = '{
@@ -34,21 +24,22 @@
       "AWS":"*"
     },
     "Action":["SNS:Publish"],
-    "Resource":"' + my-topic-arn + '",
+    "Resource":"' + MY_TOPIC_ARN + '",
     "Condition":{
       "ArnEquals":{
-        "AWS:SourceArn":"' + my-resource-arn + '"}
+        "AWS:SourceArn":"' + MY_RESOURCE_ARN + '"}
      }
   }]
 }'
 
-sns = Aws::SNS::Resource.new(region: 'us-west-2')
+sns = Aws::SNS::Resource.new(region: 'REGION')
 
 # Get topic by ARN
-topic = sns.topic(my-topic-arn)
+topic = sns.topic()
 
 # Add policy to topic
 topic.set_attributes({
-  attribute_name: "Policy",
+  attribute_name: "POLICY_NAME",
   attribute_value: policy
 })
+# snippet-end:[sns.Ruby.enableResource]

ruby/example_code/sns/sns-ruby-example-send-message.rb

@@ -1,33 +1,42 @@
-# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# This file is licensed under the Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License. A copy of the
-# License is located at
-# snippet-comment:[These are tags for the AWS doc team's sample catalog. Do not remove.]
-# snippet-sourceauthor:[Doug-AWS]
-# snippet-sourcedescription:[Publishes a message to an SNS topic.]
-# snippet-keyword:[Amazon Simple Notification Service]
-# snippet-keyword:[Resource.topic method]
-# snippet-keyword:[Topic.publish method]
-# snippet-keyword:[Ruby]
-# snippet-sourcesyntax:[ruby]
-# snippet-service:[sns]
-# snippet-keyword:[Code Sample]
-# snippet-sourcetype:[full-example]
-# snippet-sourcedate:[2018-03-16]
-#
-# http://aws.amazon.com/apache2.0/
-#
-# This file 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.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 
+# Purpose:
+# sns-ruby-example-send-message.rb demonstrates how to send a message using the Amazon Simple Notification Services (SNS) topic using
+# the AWS SDK for JavaScript (v3).
+
+# Inputs:
+# - REGION
+# - SNS_TOPIC_ARN
+# - MESSAGE
+
+# snippet-start:[sns.Ruby.sendMessage]
 require 'aws-sdk-sns'  # v2: require 'aws-sdk'
 
-sns = Aws::SNS::Resource.new(region: 'us-west-2')
+def message_sent?(sns_client, topic_arn, message)
+
+  sns_client.publish(topic_arn: topic_arn, message: message)
+rescue StandardError => e
+  puts "Error while sending the message: #{e.message}"
+  end
+# snippet-end:[sns.Ruby.sendMessage]
+def run_me
+
+  topic_arn = 'SNS_TOPIC_ARN'
+  region = 'REGION'
+  message = 'MESSAGE' # The text of the message to send.
+
+  sns_client = Aws::SNS::Client.new(region: region)
+
+  puts "Message sending."
 
-topic = sns.topic('arn:aws:sns:us-west-2:123456789:MyGroovyTopic')
+  if message_sent?(sns_client, topic_arn, message)
+    puts 'The message was sent.'
+  else
+    puts 'The message was not sent. Stopping program.'
+    exit 1
+  end
+  end
 
-topic.publish({
-  message: 'Hello!'
-})
+run_me if $PROGRAM_NAME == __FILE__
+# snippet-start:[sns.Ruby.sendMessage]

ruby/example_code/sns/sns-ruby-example-show-subscriptions.rb

@@ -1,33 +1,41 @@
-# snippet-comment:[These are tags for the AWS doc team's sample catalog. Do not remove.]
-# snippet-sourceauthor:[Doug-AWS]
-# snippet-sourcedescription:[Lists the endpoints for your SNS subscriptions.]
-# snippet-keyword:[Amazon Simple Notification Service]
-# snippet-keyword:[Resource.topic method]
-# snippet-keyword:[Topic.subscriptions method]
-# snippet-keyword:[Ruby]
-# snippet-sourcesyntax:[ruby]
-# snippet-service:[sns]
-# snippet-keyword:[Code Sample]
-# snippet-sourcetype:[full-example]
-# snippet-sourcedate:[2018-03-16]
-# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# This file is licensed under the Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License. A copy of the
-# License is located at
-#
-# http://aws.amazon.com/apache2.0/
-#
-# This file 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.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 
+# Purpose:
+# sns-ruby-example-show-subscriptions.rb demonstrates how to list subscriptions to the Amazon Simple Notification Services (SNS) topic using
+# the AWS SDK for JavaScript (v3).
+
+# Inputs:
+# - REGION
+# - SNS_TOPIC
+
+# snippet-start:[sns.Ruby.showSubscription]
 require 'aws-sdk-sns'  # v2: require 'aws-sdk'
 
-sns = Aws::SNS::Resource.new(region: 'us-west-2')
+def show_subscriptions?(sns_client, topic_arn)
+  topic = sns_client.topic(topic_arn)
+  topic.subscriptions.each do |s|
+    puts s.attributes['Endpoint']
+  end
+
+rescue StandardError => e
+  puts "Error while sending the message: #{e.message}"
+end
+# snippet-end:[sns.Ruby.showSubscription]
+def run_me
 
-topic = sns.topic('arn:aws:sns:us-west-2:123456789:MyGroovyTopic')
+  topic_arn = 'arn:aws:sns:eu-west-1:164794437551:brmurrubytopic'
+  region = 'eu-west-1'
 
-topic.subscriptions.each do |s|
-  puts s.attributes['Endpoint']
+  sns_client = Aws::SNS::Resource.new(region: region)
+
+  puts "Listing subscriptions to the topic."
+
+  if show_subscriptions?(sns_client, topic_arn)
+  else
+    puts 'There was an error. Stopping program.'
+    exit 1
+  end
 end
+
+run_me if $PROGRAM_NAME == __FILE__