right_aws 1.9.0 → 3.1.0

data/lib/sns/right_sns_interface.rb

@@ -0,0 +1,286 @@
+#
+# Copyright (c) 2007-2008 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightAws
+  class SnsInterface < RightAwsBase
+    include RightAwsBaseInterface
+
+    DEFAULT_HOST        = 'sns.us-east-1.amazonaws.com'
+    DEFAULT_PORT        = 443
+    DEFAULT_PROTOCOL    = 'https'
+    DEFAULT_SERVICE     = '/'
+    REQUEST_TTL         = 30
+
+    # Apparently boilerplate stuff
+    @@bench = AwsBenchmarkingBlock.new
+    def self.bench_xml
+      @@bench.xml
+    end
+    def self.bench_service
+      @@bench.service
+    end
+
+    def initialize(aws_access_key_id=nil, aws_secret_access_key=nil, params={})
+      if params[:region]
+        server = "sns.#{params[:region]}.amazonaws.com"
+        params.delete(:region)
+      else
+        server = DEFAULT_HOST
+      end
+      init({  :name               => 'SNS',
+              :default_host       => ENV['SNS_URL'] ? URI.parse(ENV['SNS_URL']).host    : server,
+              :default_port       => ENV['SNS_URL'] ? URI.parse(ENV['SNS_URL']).port    : DEFAULT_PORT,
+              :default_service    => ENV['SNS_URL'] ? URI.parse(ENV['SNS_URL']).path    : DEFAULT_SERVICE,
+              :default_protocol   => ENV['SNS_URL'] ? URI.parse(ENV['SNS_URL']).scheme  : DEFAULT_PROTOCOL},
+           aws_access_key_id     || ENV['AWS_ACCESS_KEY_ID'],
+           aws_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY'],
+           params)
+    end
+
+    # TODO: RJG - Seems like generate_request and generate_rest_request could be in a sub class?
+    # Generates a request hash for the sns API
+    def generate_request(action, params={})  # :nodoc:
+        # Sometimes we need to use queue uri (delete queue etc)
+        # In that case we will use Symbol key: 'param[:queue_url]'
+      service = params[:sns_url] ? URI(params[:sns_url]).path : '/'
+        # remove unset(=optional) and symbolyc keys
+      params.each{ |key, value| params.delete(key) if (value.nil? || key.is_a?(Symbol)) }
+        # prepare output hash
+      service_hash = { "Action"           => action,
+                       "Expires"          => (Time.now + REQUEST_TTL).utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
+                       "AWSAccessKeyId"   => @aws_access_key_id }
+                       #"Version"          => API_VERSION }
+      service_hash.update(params)
+      service_params = signed_service_params(@aws_secret_access_key, service_hash, :get, @params[:server], service)
+      request        = Net::HTTP::Get.new("#{AwsUtils::URLencode(service)}?#{service_params}")
+        # prepare output hash
+      { :request  => request,
+        :server   => @params[:server],
+        :port     => @params[:port],
+        :protocol => @params[:protocol] }
+    end
+
+    # Generates a request hash for the REST API
+    def generate_rest_request(method, param) # :nodoc:
+      sns_uri = param[:sns_url] ? URI(param[:sns_url]).path : '/'
+      message   = param[:message]                # extract message body if nesessary
+        # remove unset(=optional) and symbolyc keys
+      param.each{ |key, value| param.delete(key) if (value.nil? || key.is_a?(Symbol)) }
+        # created request
+      param_to_str = param.to_a.collect{|key,val| key.to_s + "=" + CGI::escape(val.to_s) }.join("&")
+      param_to_str = "?#{param_to_str}" unless param_to_str.right_blank?
+      request = "Net::HTTP::#{method.capitalize}".right_constantize.new("#{sns_uri}#{param_to_str}")
+      request.body = message if message
+        # set main headers
+      request['content-md5']  = ''
+      request['Content-Type'] = 'text/plain'
+      request['Date']         = Time.now.httpdate
+        # generate authorization string
+      auth_string = "#{method.upcase}\n#{request['content-md5']}\n#{request['Content-Type']}\n#{request['Date']}\n#{CGI::unescape(sns_uri)}"
+      signature   = AwsUtils::sign(@aws_secret_access_key, auth_string)
+        # set other headers
+      request['Authorization'] = "AWS #{@aws_access_key_id}:#{signature}"
+      #request['AWS-Version']   = API_VERSION
+        # prepare output hash
+      { :request  => request,
+        :server   => @params[:server],
+        :port     => @params[:port],
+        :protocol => @params[:protocol] }
+    end
+
+    # Sends request to Amazon and parses the response
+      # Raises AwsError if any banana happened
+    def request_info(request, parser) # :nodoc:
+      request_info_impl(:sns_connection, @@bench, request, parser)
+    end
+
+    def create_topic(topic_name)
+      req_hash = generate_request('CreateTopic', 'Name' => topic_name)
+      request_info(req_hash, SnsCreateTopicParser.new)
+    end
+
+    def list_topics()
+      req_hash = generate_request('ListTopics')
+      request_info(req_hash, SnsListTopicsParser.new)
+    end
+
+    def delete_topic(topic_arn)
+      req_hash = generate_request('DeleteTopic', 'TopicArn' => topic_arn)
+      request_info(req_hash, RightHttp2xxParser.new)
+    end
+
+    def subscribe(topic_arn, protocol, endpoint)
+      req_hash = generate_request('Subscribe', 'TopicArn' => topic_arn, 'Protocol' => protocol, 'Endpoint' => endpoint)
+      request_info(req_hash, SnsSubscribeParser.new)
+    end
+
+    def unsubscribe(subscription_arn)
+      req_hash = generate_request('Unsubscribe', 'SubscriptionArn' => subscription_arn)
+      request_info(req_hash, RightHttp2xxParser.new)
+    end
+
+    def publish(topic_arn, message, subject)
+      req_hash = generate_request('Publish', 'TopicArn' => topic_arn, 'Message' => message, 'Subject' => subject)
+      request_info(req_hash, SnsPublishParser.new)
+    end
+
+    def set_topic_attribute(topic_arn, attribute_name, attribute_value)
+      if attribute_name != 'Policy' && attribute_name != 'DisplayName'
+        raise(ArgumentError, "The only values accepted for the attribute_name parameter are (Policy, DisplayName)")
+      end
+      req_hash = generate_request('SetTopicAttributes', 'TopicArn' => topic_arn, 'AttributeName' => attribute_name, 'AttributeValue' => attribute_value)
+      request_info(req_hash, RightHttp2xxParser.new)
+    end
+
+    def get_topic_attributes(topic_arn)
+      req_hash = generate_request('GetTopicAttributes', 'TopicArn' => topic_arn)
+      request_info(req_hash, SnsGetTopicAttributesParser.new)
+    end
+
+    # Calls either the ListSubscriptions or ListSubscriptionsByTopic depending on whether or not the topic_arn parameter is provided.
+    def list_subscriptions(topic_arn = nil)
+      req_hash = topic_arn ? generate_request('ListSubscriptionsByTopic', 'TopicArn' => topic_arn) : generate_request('ListSubscriptions')
+      request_info(req_hash, SnsListSubscriptionsParser.new)
+    end
+
+    def confirm_subscription(topic_arn, token, authenticate_on_unsubscribe=false)
+      req_hash = generate_request('ConfirmSubscription', 'AuthenticateOnUnsubscribe' => authenticate_on_unsubscribe.to_s, 'Token' => token, 'TopicArn' => topic_arn)
+      request_info(req_hash, SnsConfirmSubscriptionParser.new)
+    end
+
+    def add_permission(topic_arn, label, acct_action_hash_ary)
+      n_hash = {
+        'TopicArn'  => topic_arn,
+        'Label'     => label
+      }
+
+      acct_action_hash_ary.each_with_index do |hash_val, idx|
+        n_hash["AWSAccountId.member.#{idx+1}"]  = hash_val[:aws_account_id]
+        n_hash["ActionName.member.#{idx+1}"]    = hash_val[:action]
+      end
+
+      req_hash = generate_request('AddPermission', n_hash)
+      request_info(req_hash, RightHttp2xxParser.new)
+    end
+
+    def remove_permission(topic_arn, label)
+      req_hash = generate_request('RemovePermission', 'TopicArn' => topic_arn, 'Label' => label)
+      request_info(req_hash, RightHttp2xxParser.new)
+    end
+
+    class SnsCreateTopicParser < RightAWSParser # :nodoc:
+      def reset
+        @result  = ''
+        @request_id = ''
+      end
+      def tagend(name)
+        case name
+          when 'RequestId'  then @result_id = @text
+          when 'TopicArn'   then @result = @text
+        end
+      end
+    end
+
+    class SnsListTopicsParser < RightAWSParser # :nodoc:
+      def reset
+        @result     = []
+        @request_id = ''
+      end
+      def tagstart(name, attributes)
+        @current_key = {} if name == 'member'
+      end
+      def tagend(name)
+        case name
+          when 'RequestId'  then @result_id         = @text
+          when 'TopicArn'   then @current_key[:arn] = @text
+          when 'member'     then @result << @current_key
+        end
+      end
+    end
+
+    class SnsSubscribeParser < RightAWSParser # :nodoc:
+      def reset
+        @result = ''
+      end
+      def tagend(name)
+        case name
+          when 'SubscriptionArn' then @result = @text
+        end
+      end
+    end
+
+    class SnsPublishParser < RightAWSParser # :nodoc:
+      def reset
+        @result = ''
+      end
+      def tagend(name)
+        case name
+          when 'MessageId' then @result = @text
+        end
+      end
+    end
+
+    class SnsGetTopicAttributesParser < RightAWSParser # :nodoc:
+      def reset
+        @result = {}
+      end
+      def tagend(name)
+        case name
+          when 'key' then @current_attr = @text
+          when 'value' then @result[@current_attr] = @text
+        end
+      end
+    end
+
+    class SnsListSubscriptionsParser < RightAWSParser # :nodoc:
+      def reset
+        @result = []
+      end
+      def tagstart(name, attributes)
+        @current_key = {} if name == 'member'
+      end
+      def tagend(name)
+        case name
+          when 'TopicArn'         then @current_key[:topic_arn]         = @text
+          when 'Protocol'         then @current_key[:protocol]          = @text
+          when 'SubscriptionArn'  then @current_key[:subscription_arn]  = @text
+          when 'Owner'            then @current_key[:owner]             = @text
+          when 'Endpoint'         then @current_key[:endpoint]          = @text
+          when 'member'     then @result << @current_key
+        end
+      end
+    end
+
+    class SnsConfirmSubscriptionParser < RightAWSParser # :nodoc:
+      def reset
+        @result = ''
+      end
+      def tagend(name)
+        case name
+          when 'SubscriptionArn' then @result = @text
+        end
+      end
+    end
+
+  end
+end

data/lib/sqs/right_sqs.rb

@@ -59,7 +59,6 @@ module RightAws
     #
     #    {:server       => 'queue.amazonaws.com' # Amazon service host: 'queue.amazonaws.com' (default)
     #     :port         => 443                   # Amazon service port: 80 or 443 (default)
-    #     :multi_thread => true|false            # Multi-threaded (connection per each thread): true or false (default)
     #     :signature_version => '0'              # The signature version : '0' or '1'(default)
     #     :logger       => Logger Object}        # Logger instance: logs to STDOUT if omitted }
     #
@@ -271,7 +270,7 @@ module RightAws
           grantees << Grantee.new(self, grantee_email_address, key, value[:name], value[:perms])
         end
         if grantee_email_address
-          grantees.blank? ? nil : grantees.shift
+          grantees.right_blank? ? nil : grantees.shift
         else
           grantees
         end

data/lib/sqs/right_sqs_gen2.rb

@@ -60,7 +60,6 @@ module RightAws
     #
     #    {:server       => 'queue.amazonaws.com' # Amazon service host: 'queue.amazonaws.com' (default)
     #     :port         => 443                   # Amazon service port: 80 or 443 (default)
-    #     :multi_thread => true|false            # Multi-threaded (connection per each thread): true or false (default)
     #     :signature_version => '0'              # The signature version : '0' or '1'(default)
     #     :logger       => Logger Object}        # Logger instance: logs to STDOUT if omitted }
   class SqsGen2
@@ -136,7 +135,7 @@ module RightAws
         #  queue.clear() #=> true
         #
       def clear()
-          @sqs.interface.clear_queue(@url)
+        @sqs.interface.clear_queue(@url)
       end
       
         # Deletes queue.  Any messages in the queue will be permanently lost. 
@@ -167,11 +166,10 @@ module RightAws
         #
         #  queue.receive_messages(2,10) #=> array of messages
         #
-      def receive_messages(number_of_messages=1, visibility=nil)
-        list = @sqs.interface.receive_message(@url, number_of_messages, visibility)
+      def receive_messages(number_of_messages=1, visibility=nil, attributes=nil)
+        list = @sqs.interface.receive_message(@url, number_of_messages, visibility, attributes)
         list.map! do |entry|
-          msg = Message.new(self, entry['MessageId'], entry['ReceiptHandle'],
-                            entry['Body'], visibility)
+          msg = Message.new(self, entry['MessageId'], entry['ReceiptHandle'], entry['Body'], visibility, entry['Attributes'])
           msg.received_at = Time.now 
           msg.receive_checksum = entry['MD5OfBody']
           msg
@@ -183,8 +181,8 @@ module RightAws
         #
         #  queue.receive #=> #<RightAws::SqsGen2::Message:0xb7bf0884 ... >
         #
-      def receive(visibility=nil)
-        list = receive_messages(1, visibility)
+      def receive(visibility=nil, attributes=nil)
+        list = receive_messages(1, visibility, attributes)
         list.empty? ? nil : list[0]
       end
 
@@ -193,12 +191,15 @@ module RightAws
         #
         #  queue.pop #=> #<RightAws::SqsGen2::Message:0xb7bf0884 ... >
         #
-      def pop
-        list = @sqs.interface.pop_messages(@url, 1)
+        #  # pop a message with custom attributes
+        #  m = queue.pop(['SenderId', 'SentTimestamp']) #=> #<RightAws::SqsGen2::Message:0xb7bf1884 ... >
+        #  m.attributes #=> {"SentTimestamp"=>"1240991906937", "SenderId"=>"800000000005"}
+        #
+      def pop(attributes=nil)
+        list = @sqs.interface.pop_messages(@url, 1, attributes)
         return nil if list.empty?
         entry = list[0]
-        msg = Message.new(self, entry['MessageId'], entry['ReceiptHandle'],
-                            entry['Body'], visibility)
+        msg = Message.new(self, entry['MessageId'], entry['ReceiptHandle'], entry['Body'], visibility, entry['Attributes'])
         msg.received_at = Time.now 
         msg.receive_checksum = entry['MD5OfBody']
         msg
@@ -241,27 +242,77 @@ module RightAws
       end
         
         # Retrieves queue attributes. 
-        # At this moment Amazon supports +VisibilityTimeout+ and +ApproximateNumberOfMessages+ only. 
         # If the name of attribute is set, returns its value. Otherwise, returns a hash of attributes.
         #
         # queue.get_attribute('VisibilityTimeout')  #=> {"VisibilityTimeout"=>"45"} 
         #
+        # P.S. This guy is deprecated. Use +get_attributes+ instead.
       def get_attribute(attribute='All')
-        attributes = @sqs.interface.get_queue_attributes(@url, attribute)
+        attributes = get_attributes(attribute)
         attribute=='All' ? attributes : attributes[attribute]
       end
+
+      # Retrieves queue attributes.
+      #
+      #  queue.get_attributes #=>
+      #    {"ApproximateNumberOfMessages" => "0",
+      #     "LastModifiedTimestamp"       => "1240946032",
+      #     "CreatedTimestamp"            => "1240816887",
+      #     "VisibilityTimeout"           => "30",
+      #     "Policy"                      => "{"Version":"2008-10-17","Id":...}"}
+      #
+      #  queue.get_attributes("LastModifiedTimestamp", "VisibilityTimeout") #=>
+      #    {"LastModifiedTimestamp" => "1240946032",
+      #     "VisibilityTimeout"     => "30"}
+      #
+      def get_attributes(*attributes)
+        @sqs.interface.get_queue_attributes(@url, attributes)
+      end
+
+      # Add permission to the queue.
+      #
+      #  queue.add_permissions('testLabel',['125074342641', '125074342642'],
+      #                        ['SendMessage','SendMessage','ReceiveMessage']) #=> true
+      #
+      def add_permissions(label, grantees, actions)
+        @sqs.interface.add_permissions(@url, label, grantees, actions)
+      end
+
+      # Revoke any permissions in the queue policy that matches the +label+ parameter.
+      #
+      #  sqs.remove_permissions('testLabel') # => true
+      #
+      def remove_permissions(label)
+        @sqs.interface.remove_permissions(@url, label)
+      end
+
+      # Get current permissions set. The set is JSON packed.
+      # 
+      #  sqs.get_permissions #=>
+      #    '{"Version":"2008-10-17","Id":"/826693181925/kd-test-gen-2_5/SQSDefaultPolicy",
+      #      "Statement":[{"Sid":"kd-perm-04","Effect":"Allow","Principal":{"AWS":"100000000001",
+      #      "AWS":"100000000001","AWS":"100000000002"},"Action":["SQS:SendMessage","SQS:DeleteMessage",
+      #      "SQS:ReceiveMessage"],"Resource":"/826693181925/kd-test-gen-2_5"},{"Sid":"kd-perm-03",
+      #      "Effect":"Allow","Principal":{"AWS":"648772224137"},"Action":"SQS:SendMessage",
+      #      "Resource":"/826693181925/kd-test-gen-2_5"}]}'
+      #
+      def get_permissions
+        get_attributes('Policy')['Policy']
+      end
+      
     end
         
     class Message
-      attr_reader   :queue, :id, :body, :visibility, :receipt_handle
+      attr_reader   :queue, :id, :body, :visibility, :receipt_handle, :attributes
       attr_accessor :sent_at, :received_at, :send_checksum, :receive_checksum
       
-      def initialize(queue, id=nil, rh = nil, body=nil, visibility=nil)
+      def initialize(queue, id=nil, rh = nil, body=nil, visibility=nil, attributes=nil)
         @queue       = queue
         @id          = id
         @receipt_handle = rh 
         @body        = body
         @visibility  = visibility
+        @attributes  = attributes
         @sent_at     = nil
         @received_at = nil
         @send_checksum = nil
@@ -273,6 +324,12 @@ module RightAws
         @body
       end
 
+      # Set message visibility timeout.
+      def visibility=(visibility_timeout)
+        @queue.sqs.interface.change_message_visibility(@queue.url, @receipt_handle, visibility_timeout)
+        @visibility = visibility_timeout
+      end
+
         # Removes message from queue. 
         # Returns +true+.
       def delete
@@ -281,6 +338,5 @@ module RightAws
 
     end
 
-
   end
 end