aws-sdk-v1 1.52.0

data/lib/aws/sns/topic_collection.rb

@@ -0,0 +1,62 @@
+# 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
+
+    class TopicCollection
+
+      include Core::Collection::WithNextToken
+
+      # Creates and returns a new SNS Topic.
+      # @return [Topic] Returns a new topic with the given name.
+      def create name
+        response = client.create_topic(:name => name)
+        Topic.new(response.topic_arn, :config => config)
+      end
+
+      # @param [String] topic_arn An AWS SNS Topic ARN.  It should be
+      #   formatted something like:
+      #
+      #       arn:aws:sns:us-west-2:123456789012:TopicName
+      #
+      # @return [Topic] Returns a topic with the given Topic ARN.
+      def [] topic_arn
+        unless topic_arn =~ /^arn:aws/
+          raise ArgumentError, "invalid topic arn `#{topic_arn}`"
+        end
+        Topic.new(topic_arn, :config => config)
+      end
+
+      protected
+
+      def _each_item next_token, options, &block
+
+        options[:next_token] = next_token if next_token
+
+        resp = client.list_topics(options)
+        resp.data[:topics].each do |details|
+
+          topic = Topic.new(details[:topic_arn], :config => config)
+
+          yield(topic)
+
+        end
+
+        resp.data[:next_token]
+
+      end
+
+    end
+  end
+end

data/lib/aws/sns/topic_subscription_collection.rb

@@ -0,0 +1,54 @@
+# 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 a particular
+    # topic.  For example:
+    #
+    #     # get the e-mail addressess that receive plain-text
+    #     # messages sent to the topic
+    #     topic.subscriptions.
+    #       select { |s| s.protocol == :email }.
+    #       map(&:endpoint)
+    #
+    class TopicSubscriptionCollection < SubscriptionCollection
+
+      include Core::Model
+      include Enumerable
+
+      # @api private
+      def initialize(topic, opts = {})
+        @topic = topic
+        super
+      end
+
+      # @return [Topic] The topic to which all the subscriptions
+      # belong.
+      attr_reader :topic
+
+      protected
+
+      def client_method
+        :list_subscriptions_by_topic
+      end
+
+      def request_options
+        { :topic_arn => topic.arn }
+      end
+
+    end
+
+  end
+end

data/lib/aws/sqs.rb

@@ -0,0 +1,80 @@
+# 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.
+
+require 'aws/core'
+require 'aws/sqs/config'
+
+module AWS
+
+  # Provides an expressive, object-oriented interface to Amazon SQS.
+  #
+  # ## Credentials
+  #
+  # You can setup default credentials for all AWS services via
+  # AWS.config:
+  #
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # Or you can set them directly on the SQS interface:
+  #
+  #     sqs = AWS::SQS.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # ## Queues and Messages
+  #
+  # Amazon SQS is a distributed queue system that enables web
+  # service applications to quickly and reliably queue messages that
+  # one component in the application generates to be consumed by
+  # another component. A queue is a temporary repository for
+  # messages that are awaiting processing.
+  #
+  # You can access your queues using the {#queues} collection.  For
+  # example, to create a queue, use {QueueCollection#create}:
+  #
+  #     queue = sqs.queues.create("myqueue")
+  #
+  # Or to find out what queues you have in your account:
+  #
+  #     pp sqs.queues.collect(&:url)
+  #
+  # See the {Queue} class for more information on how to send and
+  # receive messages.
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level SQS client object
+  class SQS
+
+    autoload :Client, 'aws/sqs/client'
+    autoload :Errors, 'aws/sqs/errors'
+    autoload :Queue, 'aws/sqs/queue'
+    autoload :QueueCollection, 'aws/sqs/queue_collection'
+    autoload :Policy, 'aws/sqs/policy'
+    autoload :ReceivedMessage, 'aws/sqs/received_message'
+    autoload :ReceivedSNSMessage, 'aws/sqs/received_sns_message'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'sqs'
+
+    # @return [QueueCollection] The collection of all {Queue}
+    #   objects in your account.
+    def queues
+      QueueCollection.new(:config => config)
+    end
+
+  end
+
+end

data/lib/aws/sqs/client.rb

@@ -0,0 +1,53 @@
+# 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 SQS
+
+    # Client class for Amazon Simple Queue Service (SQS).
+    class Client < Core::QueryClient
+
+      API_VERSION = '2012-11-05'
+
+      signature_version :Version4, 'sqs'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[]
+
+      private
+
+      def build_request *args
+        request = super(*args)
+        if url_param = request.params.find { |p| p.name == "QueueUrl" }
+          url = URI.parse(url_param.value)
+          if url.class == URI::Generic
+            raise ArgumentError, "invalid queue url `#{url_param.value}'"
+          end
+          request.host = url.host
+          request.uri = url.request_uri
+          if matches = request.host.match(/^sqs\.(.+?)\./)
+            request.region = matches[1]
+          end
+        end
+        request
+      end
+
+    end
+
+    class Client::V20121105 < Client
+
+      define_client_methods('2012-11-05')
+
+    end
+  end
+end

data/lib/aws/sqs/config.rb

@@ -0,0 +1,20 @@
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'SQS', 'sqs', 'sqs'
+
+  add_option :sqs_verify_checksums, true, :boolean => true
+
+end

data/lib/aws/sqs/errors.rb

@@ -0,0 +1,125 @@
+# 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 SQS
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+      # @api private
+      def self.error_class(code)
+        super(code.sub(/^AWS\.SimpleQueueService\./, ''))
+      end
+
+      # Raised when one or more messages fail to delete during a
+      # batch delete operation.
+      #
+      # See {#failures} for a complete list of failures.
+      #
+      class BatchDeleteError < StandardError
+
+        def initialize failures
+          @failures = failures
+          super("Failed to delete #{failures.size} messages")
+        end
+
+        # @return [Array<Hash>] Returns a list of hashes.  Each hash
+        #   contains information about one message that failed to delete.
+        #   Hash keys include:
+        #
+        #   * `:error_code`
+        #   * `:error_message`
+        #   * `:sender_fault`
+        #   * `:receipt_handle`
+        #
+        attr_reader :failures
+
+      end
+
+      # Raised from a batch change message visibility call when one or more
+      # of the updates fail.
+      #
+      # See {#failures} for a complete list of failures.
+      #
+      class BatchChangeVisibilityError < StandardError
+
+        def initialize failures
+          @failures = failures
+          super("Failed to change visibility for #{failures.size} messages")
+        end
+
+        # @return [Array<Hash>] Returns a list of hashes.  Each hash
+        #   contains information about one message that failed to change
+        #   visibility. Hash keys include:
+        #
+        #   * `:error_code`
+        #   * `:error_message`
+        #   * `:sender_fault`
+        #   * `:receipt_handle`
+        #
+        attr_reader :failures
+
+      end
+
+      class BatchSendError < StandardError
+
+        def initialize sent, failures
+          @sent = sent
+          @failures = failures
+          super("Failed to send #{failures.size} messages")
+        end
+
+        # @return [Array<Queue::SentMessage>] Returns a list of
+        #   {Queue::SentMessage} objects.
+        attr_reader :sent
+
+        # @return [Array<Hash>] Returns a list of hashes.  Each hash
+        #   contains information about one message that was not sent.   
+        #
+        #   * `:error_code` - identifies the type of failure
+        #   * `:error_message` - human readable description of the failure
+        #   * `:sender_fault` - whether the failure was caused by a server fault
+        #   * `:message_body` - the message body as passed to `:batch_send`
+        #   * `:batch_index` - the index in the list of messages passed 
+        #      to `batch_send` of the failed message.
+        #
+        attr_reader :failures
+
+      end
+
+      class ChecksumError < StandardError
+
+        def initialize failures
+          # failures can also be a single failure, always generate an array
+          @failures = failures.is_a?(Array) ? failures : [failures]
+          super("#{@failures.size} messages failed checksum verification")
+        end
+
+        attr_reader :failures
+      end
+
+      class BatchSendMultiError < StandardError
+        def initialize *error_set
+          @errors = []
+          error_set.each do |error|
+            @errors << error
+          end
+        end
+
+        attr_reader :errors
+      end
+
+    end
+  end
+end

data/lib/aws/sqs/policy.rb

@@ -0,0 +1,48 @@
+# 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 SQS
+
+    # (see Core::Policy)
+    class Policy < Core::Policy
+
+      class Statement < Core::Policy::Statement
+
+        ACTION_MAPPING = {
+          :add_permission => 'sqs:AddPermission',
+          :change_message_visibility => 'sqs:ChangeMessageVisibility',
+          :create_queue => 'sqs:CreateQueue',
+          :delete_message => 'sqs:DeleteMessage',
+          :delete_queue => 'sqs:DeleteQueue',
+          :get_queue_attributes => 'sqs:GetQueueAttributes',
+          :list_queues => 'sqs:ListQueues',
+          :receive_message => 'sqs:ReceiveMessage',
+          :remove_permission => 'sqs:RemovePermission',
+          :send_message => 'sqs:SendMessage',
+          :set_queue_attributes => 'sqs:SetQueueAttributes',
+        }
+
+        protected
+        def resource_arn resource
+          case resource
+          when Queue then URI.parse(resource.url).path
+          else resource.to_s
+          end
+        end
+
+      end
+
+    end
+  end
+end