amaze_sns 1.3.0 → 2.0.0

data/README.md

@@ -2,26 +2,31 @@ Amazon SNS gem
 ==============
 
 Introduction
----------
+------------
 
 A Ruby gem for use with the Amazon Simple Notification service (http://aws.amazon.com/sns/).
 
 Usage
----------------
+------
+
+### Quickstart Guide ###
 
-gem install amaze_sns
+    gem install amaze_sns
 
-require 'amaze-sns'
+    require 'amaze-sns'
 
-AmazeSNS.skey = <your amazon aws secret key>
+    AmazeSNS.skey = 'your amazon aws secret key'
 
-AmazeSNS.akey = <your amazon aws access key>
+    AmazeSNS.akey = 'your amazon aws access key'
+    
+    # add new topic to local hash and to SNS
+    # You need to call create in order to access the ARN of the topic
+    AmazeSNS['your_topic_name'].create 
+    
+    AmazeSNS['your_topic_name'].delete # removes it from both SNS and local hash
 
-AmazeSNS['your_topic_name'] # creates a new Topic Object but not yet published
-AmazeSNS['your_topic_name'].create # add new topic to local hash and to SNS
-AmazeSNS['your_topic_name'].delete # removes it from both SNS and local hash
+    AmazeSNS.logger = my_logger # set a logger for the response`
 
-AmazeSNS.logger = my_logger # set a logger for the response
 
 Dependencies
 ---------------
@@ -34,14 +39,21 @@ higher than 0.2.10 although the gemspec has been updated to reflect this
 
 
 Tests
----------------
+------
 The specs are partly working at the moment as the gem is still under development
 
 The gem itself has been tested on systems running ruby 1.8.6, 1.8.7, 1.9.2
 
 
+License
+-------
+
+(The MIT License)
+
+Copyright © 2010 Chee Yeo, 29 Steps UK
+
+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:
 
-Copyright
----------
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-Copyright (c) 2010 29 Steps UK. See LICENSE for details.
+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.

data/lib/amaze/request.rb

@@ -1,5 +1,6 @@
-
+require "rubygems"
 require 'crack/xml'
+require 'ruby-debug'
 
 require File.dirname(__FILE__) + "/helpers"
 require File.dirname(__FILE__) + "/exceptions"
@@ -8,30 +9,12 @@ require 'em-http'
 
 
 class Request
+  include EM::Deferrable
   
-  attr_accessor :params, :options, :httpresponse
+  attr_accessor :params, :httpresponse
   
-  def initialize(params, options={})
+  def initialize(params)
     @params = params
-    @options = options
-  end
-  
-  def process2
-    query_string = canonical_querystring(@params)
-string_to_sign = "GET
-#{AmazeSNS.host}
-/
-#{query_string}"
-     
-     hmac = HMAC::SHA256.new(AmazeSNS.skey)
-     hmac.update( string_to_sign )
-     signature = Base64.encode64(hmac.digest).chomp
-
-     params['Signature'] = signature
-     querystring2 = params.collect { |key, value| [url_encode(key), url_encode(value)].join("=") }.join('&') # order doesn't matter for the actual request
-     response = HttpClient.get "#{AmazeSNS.host}?#{querystring2}"
-     parsed_response = Crack::XML.parse(response)
-     return parsed_response
   end
   
   def process
@@ -55,10 +38,13 @@ string_to_sign = "GET
       
       require 'em-http' unless defined?(EventMachine::HttpRequest)
       
-      @httpresponse ||=  http_class.new("http://#{AmazeSNS.host}/?#{querystring2}").send(:get)
-      @httpresponse.callback{ success_callback }
-      @httpresponse.errback{ error_callback }
-      nil
+      @httpresponse ||= http_class.new("http://#{AmazeSNS.host}/?").get({
+        :query => querystring2, :timeout => 2
+      })
+      
+      # a bit misleading but call is still successful even if the status code is not 200
+      @httpresponse.callback{ success_callback } 
+      @httpresponse.errback{ error_callback } 
   end
   
   def http_class
@@ -68,6 +54,8 @@ string_to_sign = "GET
   
   def success_callback
     case @httpresponse.response_header.status
+     when 200
+       self.succeed(@httpresponse)
      when 403
        raise AuthorizationError
      when 500
@@ -77,12 +65,14 @@ string_to_sign = "GET
      when 404
        raise NotFoundError
      else
-       call_user_success_handler
+       self.fail("Call to Amazon SNS API failed")
      end #end case
   end
   
   def call_user_success_handler
-    @options[:on_success].call(httpresponse) if options[:on_success].respond_to?(:call)
+    #puts "#{@options[:on_success]}"
+    @options[:on_success].call(@httpresponse) if @options[:on_success].respond_to?(:call)
+    #self.succeed(@httpresponse)
   end
   
   def error_callback

data/lib/amaze/topic.rb

@@ -5,18 +5,26 @@ require "json"
 
 class Topic
   
-  attr_accessor :topic, :arn, :attrs
+  attr_accessor :topic, :arn, :attributes
 
   def initialize(topic, arn='')
     @topic = topic
     @arn = arn
-    @attrs ||= {}
+    @attributes = {}
   end
   
-  def generate_request(params,&blk)
-    req_options={}
-    req_options[:on_success] = blk if blk
-    Request.new(params, req_options).process
+  def generate_request(params)
+    request = Request.new(params)
+    request.process
+    
+    request.callback do |data|
+      yield data
+    end
+    
+    request.errback do |resp|
+      puts "ERROR - #{resp.inspect}"
+      EM.stop
+    end
   end
   
   # for running th EM loop w/o repetitions
@@ -80,7 +88,7 @@ class Topic
   def attrs
     outcome = nil
     params = {
-      'TopicArn' => "#{arn}",
+      'TopicArn' => "#{@arn}",
       'Action' => 'GetTopicAttributes',
       'SignatureMethod' => 'HmacSHA256',
       'SignatureVersion' => 2,
@@ -93,6 +101,7 @@ class Topic
          parsed_response = Crack::XML.parse(response.response) 
          res = parsed_response['GetTopicAttributesResponse']['GetTopicAttributesResult']['Attributes']["entry"]
          outcome = make_hash(res) #res["entry"] is an array of hashes - need to turn it into hash with key value
+         self.attributes = outcome
          EM.stop
         end
      }
@@ -108,6 +117,7 @@ class Topic
   
   def set_attrs(opts)
     outcome = nil
+    #TODO: check format of opts to make sure they are compilant with API
     params = {
       'AttributeName' => "#{opts[:name]}",
       'AttributeValue' => "#{opts[:value]}",
@@ -123,6 +133,8 @@ class Topic
       generate_request(params) do |response|
         parsed_response = Crack::XML.parse(response.response) 
         outcome = parsed_response['SetTopicAttributesResponse']['ResponseMetadata']['RequestId']
+        # update the attributes hash if request is successful ...
+        self.attributes["#{opts[:name]}"] = "#{opts[:value]}" if response.response_header.status == 200
         EM.stop
       end
     }
@@ -134,7 +146,7 @@ class Topic
     raise InvalidOptions unless ( !(opts.empty?) && opts.instance_of?(Hash) )
     res=''
     params = {
-      'TopicArn' => "#{arn}",
+      'TopicArn' => "#{@arn}",
       'Endpoint' => "#{opts[:endpoint]}",
       'Protocol' => "#{opts[:protocol]}",
       'Action' => 'Subscribe',
@@ -179,9 +191,9 @@ class Topic
   
   # grabs list of subscriptions for this topic only
   def subscriptions
-    nh={}
+    res=nil
     params = {
-      'TopicArn' => "#{arn}",
+      'TopicArn' => "#{@arn}",
       'Action' => 'ListSubscriptionsByTopic',
       'SignatureMethod' => 'HmacSHA256',
       'SignatureVersion' => 2,
@@ -195,23 +207,21 @@ class Topic
          arr = parsed_response['ListSubscriptionsByTopicResponse']['ListSubscriptionsByTopicResult']['Subscriptions']['member'] unless (parsed_response['ListSubscriptionsByTopicResponse']['ListSubscriptionsByTopicResult']['Subscriptions'].nil?)
 
          if !(arr.nil?) && (arr.instance_of?(Array))
-           #temp fix for now
-           nh = arr.inject({}) do |h,v|
-             key = v["SubscriptionArn"].to_s
-             value = v
-             h[key.to_s] = value
-             h
-           end
+           res = arr
          elsif !(arr.nil?) && (arr.instance_of?(Hash))
            # to deal with one subscription issue
+           nh={}
            key = arr["SubscriptionArn"]
            arr.delete("SubscriptionArn")
            nh[key.to_s] = arr
+           res = nh
+         else
+           res = []
          end
          EM.stop
        end
     }
-    nh
+    res
   end
   
   # The AddPermission action adds a statement to a topic's access control policy, granting access for the 
@@ -221,7 +231,7 @@ class Topic
     raise InvalidOptions unless ( !(opts.empty?) && opts.instance_of?(Hash) )
     res=''
     params = {
-      'TopicArn' => "#{arn}",
+      'TopicArn' => "#{@arn}",
       'Label' => "#{opts[:label]}",
       'ActionName.member.1' => "#{opts[:action_name]}",
       'AWSAccountId.member.1' => "#{opts[:account_id]}",
@@ -247,7 +257,7 @@ class Topic
     raise InvalidOptions unless ( !(label.empty?) && label.instance_of?(String) )
     res=''
     params = {
-      'TopicArn' => "#{arn}",
+      'TopicArn' => "#{@arn}",
       'Label' => "#{label}",
       'Action' => 'RemovePermission',
       'SignatureMethod' => 'HmacSHA256',
@@ -272,7 +282,7 @@ class Topic
     res=''
     params = {
       'Subject' => subject,
-      'TopicArn' => "#{arn}",
+      'TopicArn' => "#{@arn}",
       "Message" => "#{msg}",
       'Action' => 'Publish',
       'SignatureMethod' => 'HmacSHA256',
@@ -318,17 +328,16 @@ class Topic
   
   
   
-    
-  def make_hash(arr)
-    hash = arr.inject({}) do |h, v|
-      (v["key"] == "Policy")? value = JSON.parse(v["value"]) : value = v["value"]
-      key = v["key"].to_s
-      h[key] = value
-      h
+  private  
+    def make_hash(arr)
+      hash = arr.inject({}) do |h, v|
+        (v["key"] == "Policy")? value = JSON.parse(v["value"]) : value = v["value"]
+        key = v["key"].to_s
+        h[key] = value
+        h
+      end
+      hash
     end
-    
-    hash
-  end
   
   
   

data/lib/amaze_sns.rb

@@ -1,6 +1,5 @@
 autoload 'Logger', 'logger'
 
-
 require File.dirname(__FILE__) + "/amaze/topic"
 require File.dirname(__FILE__) + "/amaze/subscription"
 require File.dirname(__FILE__) + "/amaze/helpers"
@@ -18,13 +17,19 @@ class AmazeSNS
   end
   
   class << self
-    attr_accessor :host, :logger, :topics, :skey, :akey, :subscriptions
-    #attr_writer :skey, :akey
+    attr_accessor :host, :topics, :skey, :akey, :subscriptions, :logger
+    
+    def logger
+      @logger ||= begin
+        log = Logger.new(STDOUT)
+        log.level = Logger::INFO
+        log
+      end
+    end
   end
-
   
+
   self.host = 'sns.us-east-1.amazonaws.com'
-  self.logger = Logger.new($STDOUT)
   self.skey = ''
   self.akey=''
   self.topics ||= {}
@@ -40,61 +45,59 @@ class AmazeSNS
   def self.method_missing(id, *args, &blk)
     case(id.to_s)
     when /^list_(.*)/
-      send(:process_query, $1, &blk)
+      send(:process_query, $1, &Proc.new)
     when /^refresh_(.*)/
-      send(:process_query, $1, &blk)
+      send(:process_query, $1)
     else
-      #super
       raise NoMethodError
     end
   end
   
-  def self.process_query(type, &blk)
-   # p "INSIDE PROCESS query"
+  def self.process_query(type,&prc)
     type = type.capitalize
     params = {
       'Action' => "List#{type}",
       'SignatureMethod' => 'HmacSHA256',
       'SignatureVersion' => 2,
-      'Timestamp' => Time.now.iso8601,
+      'Timestamp' => Time.now.iso8601, #Time.now.iso8601 makes tests fail
       'AWSAccessKeyId' => @akey
     }
     
-    req_options={}
+    request = Request.new(params)
+    request.process
     
-    if (blk)
-      prc = blk
-    else
-      prc = default_prc
+    request.callback do |data|
+      yield data
     end
     
-    req_options[:on_success] = prc
-    #req = Request.new(params, req_options).process
-    
-    EM.run{
-      Request.new(params, req_options).process
-    }
+    request.errback do |resp|
+      puts "ERROR - #{resp.inspect}"
+      EM.stop
+    end
     
   end
   
   def self.default_prc
     prc = Proc.new do |resp|
       parsed_response = Crack::XML.parse(resp.response)
-      #p "SUB RESPONSE: #{parsed_response.inspect}"
       self.process_response(parsed_response)
       EM.stop
     end
   end
   
+  def self.process_data(resp)
+    parsed_response = Crack::XML.parse(resp.response)
+    self.process_response(parsed_response)
+    EM.stop
+  end
+  
   def self.process_response(resp)
     kind = (resp.has_key?("ListTopicsResponse"))? "Topics" : "Subscriptions"
     cla = (resp.has_key?("ListTopicsResponse"))? "Topic" : "Subscription"
-    #p "KIND IS #{kind}"
-    
+
     result = resp["List#{kind}Response"]["List#{kind}Result"]["#{kind}"]
     if result.nil?
-      p "NO DATA FOUND"
-      return nil
+      nil
     else
       results = result["member"]
     end
@@ -120,11 +123,9 @@ class AmazeSNS
             when "Topic"
               @collection[label].arn = t["TopicArn"]
             when "Subscription"
-              #@collection[label] = t["TopicArn"]
               sub = Subscription.new(t)
               @collection[label] << sub unless  @collection[label].detect{|x| x.subarn == sub.subarn}
             end
-            #@collection[label].arn = t["TopicArn"]
           end
         end
       elsif (results.instance_of?(Hash))
@@ -136,11 +137,9 @@ class AmazeSNS
          when "Subscription"
            @collection[label] = Subscription.new(results)
          end
-         
-         #@collection[label] = Kernel.const_get("#{cla}").new(results)
       end
     else
-      return nil
+      nil
     end # end outer if
   end