File: subscription_collection.rb

package info (click to toggle)
ruby-aws-sdk 1.67.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster
  • size: 6,840 kB
  • sloc: ruby: 28,436; makefile: 7
file content (78 lines) | stat: -rw-r--r-- 2,191 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# 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/
#
# or in the "license" file accompanying this file. 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.

module AWS
  class SNS

    # Represents the collection of all subscriptions for the AWS
    # account.  For example:
    #
    #     # get the ARNs of all SQS queues with subscriptions to topics
    #     # owned by this account
    #     topic.subscriptions.
    #       select { |s| s.protocol == :sqs }.
    #       collect(&:endpoint)
    #
    class SubscriptionCollection

      include Core::Collection::WithNextToken

      # Returns a subscription with the given ARN.  This does not make
      # a request to AWS.
      # @param [String] arn The subscription ARN.
      # @return [Subscription]
      def [] arn
        Subscription.new(arn, :config => config)
      end

      protected

      # Yield each subscription belonging to this account.
      # @yieldparam [Subscription] subscription Each of the
      #   subscriptions in the account.
      # @return [nil]
      def _each_item next_token, options, &block

        options[:next_token] = next_token if next_token

        resp = client.send(client_method, options.merge(request_options))
        resp.data[:subscriptions].each do |sub|

          subscription = Subscription.new(
            sub[:subscription_arn],
            :endpoint => sub[:endpoint],
            :protocol => sub[:protocol].tr('-','_').to_sym,
            :owner_id => sub[:owner],
            :topic_arn => sub[:topic_arn],
            :config => config)

          yield(subscription)

        end

        resp.data[:next_token]

      end

      def client_method
        :list_subscriptions
      end

      def request_options
        {}
      end

    end

  end
end