swirl 1.6.2 → 1.7.0

data/README.md

@@ -54,6 +54,9 @@ nifty trick we use in (Rack)[http://github.com/rack/rack]
 Use
 ---
 
+    require 'rubygems' # if you're using rubygems
+    require 'swirl/aws'
+
     ec2 = Swirl::EC2.new
 
     # Describe all instances

data/lib/swirl.rb

@@ -1 +1,2 @@
 require 'swirl/ec2'
+require 'swirl/aws'

data/lib/swirl/aws.rb

@@ -0,0 +1,154 @@
+require 'cgi'
+require 'base64'
+require 'net/https'
+
+require 'crack/xml'
+require 'hmac-sha2'
+
+require 'swirl/helpers'
+
+
+module Swirl
+
+  ## Errors
+  class InvalidRequest < StandardError ; end
+
+
+  class AWS
+    include Helpers::Compactor
+    include Helpers::Expander
+
+    @services = {}
+
+    def self.services
+      # This must be modified using `service`
+      @services.dup
+    end
+
+    def self.service(name, url, version)
+      @services[name] = { :url => url, :version => version }
+    end
+
+    # Default Services
+    service :ec2, "https://ec2.amazonaws.com", "2010-11-15"
+
+
+    def initialize(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : Hash.new
+      name = args.shift
+
+      service = self.class.services[name] || {}
+      opts    = service.merge(opts)
+
+      @url = opts[:url] ||
+        raise(ArgumentError, "No url given")
+
+      # Convert this here for future reference
+      @url = URI(@url)
+
+      @version = opts[:version] ||
+        raise(ArgumentError, "No version given")
+
+      @aws_access_key_id  = \
+        ENV["AWS_ACCESS_KEY_ID"] ||
+        opts[:aws_access_key_id] ||
+        raise(ArgumentError, "No aws_access_key_id given")
+
+      @aws_secret_access_key = \
+        ENV["AWS_SECRET_ACCESS_KEY"] ||
+        opts[:aws_secret_access_key] ||
+        raise(ArgumentError, "No aws_secret_access_key given")
+
+      @hmac = HMAC::SHA256.new(@aws_secret_access_key)
+    end
+
+    def escape(value)
+      CGI.escape(value).gsub(/\+/, "%20")
+    end
+
+    def compile_sorted_form_data(query)
+      valid = query.reject {|_, v| v.nil? }
+      valid.sort.map {|k,v| [k, escape(v)] * "=" } * "&"
+    end
+
+    def compile_signature(method, body)
+      string_to_sign = [method, @url.host, "/", body] * "\n"
+      hmac = @hmac.update(string_to_sign)
+      encoded_sig = Base64.encode64(hmac.digest).chomp
+      escape(encoded_sig)
+    end
+
+    ##
+    # Execute an EC2 command, expand the input,
+    # and compact the output
+    #
+    # Examples:
+    #   ec2.call("DescribeInstances")
+    #   ec2.call("TerminateInstances", "InstanceId" => ["i-1234", "i-993j"]
+    #
+    def call(action, query={}, &blk)
+      call!(action, expand(query)) do |code, data|
+        case code
+        when 200
+          response = compact(data)
+        when 400...500
+          messages = Array(data["Response"]["Errors"]).map {|_, e| e["Message"] }
+          raise InvalidRequest, messages.join(",")
+        else
+          msg = "unexpected response #{code} -> #{data.inspect}"
+          raise InvalidRequest, msg
+        end
+
+        if blk
+          blk.call(response)
+        else
+          response
+        end
+      end
+    end
+
+    def call!(action, query={}, &blk)
+      # Hard coding this here until otherwise needed
+      method = "POST"
+
+      query["Action"] = action
+      query["AWSAccessKeyId"] = @aws_access_key_id
+      query["SignatureMethod"] = "HmacSHA256"
+      query["SignatureVersion"] = "2"
+      query["Timestamp"] = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+      query["Version"] = @version
+
+      body = compile_sorted_form_data(query)
+      body += "&" + ["Signature", compile_signature(method, body)].join("=")
+
+      post(body) do |code, xml|
+        if ENV["SWIRL_LOG"]
+          puts response.body
+        end
+
+        data = Crack::XML.parse(xml)
+        blk.call(code, data)
+      end
+    end
+
+    def post(body, &blk)
+      headers = { "Content-Type" => "application/x-www-form-urlencoded" }
+
+      http = Net::HTTP.new(@url.host, @url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Post.new(@url.request_uri, headers)
+      request.body = body
+
+      response = http.request(request)
+      blk.call(response.code.to_i, response.body)
+    end
+
+    def inspect
+      "<#{self.class.name} version: #{@version} url: #{@url} aws_access_key_id: #{@aws_access_key_id}>"
+    end
+
+  end
+
+end

data/lib/swirl/ec2.rb

@@ -1,123 +1,15 @@
-require 'cgi'
-require 'base64'
-require 'net/https'
+require 'swirl/aws'
 
-require 'crack/xml'
-require 'hmac-sha2'
-
-require 'swirl/helpers'
+$stderr.puts "WARNING: Requiring 'swirl' or 'swirl/ec2' will be deprecated.  Require 'swirl/aws' instead."
 
 module Swirl
 
-  ## Errors
-  class InvalidRequest < StandardError ; end
-
-
+  # Compat
   class EC2
-    include Helpers::Compactor
-    include Helpers::Expander
-
-
-    def initialize(options)
-      @aws_access_key_id =
-        options[:aws_access_key_id] ||
-        (raise ArgumentError, "no aws_access_key_id provided")
-      @aws_secret_access_key =
-        options[:aws_secret_access_key] ||
-        (raise ArgumentError, "no aws_secret_access_key provided")
-
-      @hmac = HMAC::SHA256.new(@aws_secret_access_key)
-      @version = options[:version] || "2009-11-30"
-      @url = URI(options[:url] || "https://ec2.amazonaws.com")
-    end
-
-    def escape(value)
-      CGI.escape(value).gsub(/\+/, "%20")
-    end
-
-    def compile_sorted_form_data(query)
-      valid = query.reject {|_, v| v.nil? }
-      valid.sort.map {|k,v| [k, escape(v)] * "=" } * "&"
-    end
-
-    def compile_signature(method, body)
-      string_to_sign = [method, @url.host, "/", body] * "\n"
-      hmac = @hmac.update(string_to_sign)
-      encoded_sig = Base64.encode64(hmac.digest).chomp
-      escape(encoded_sig)
-    end
-
-    ##
-    # Execute an EC2 command, expand the input,
-    # and compact the output
-    #
-    # Examples:
-    #   ec2.call("DescribeInstances")
-    #   ec2.call("TerminateInstances", "InstanceId" => ["i-1234", "i-993j"]
-    #
-    def call(action, query={}, &blk)
-      call!(action, expand(query)) do |code, data|
-        case code
-        when 200
-          response = compact(data)
-        when 400...500
-          messages = Array(data["Response"]["Errors"]).map {|_, e| e["Message"] }
-          raise InvalidRequest, messages.join(",")
-        else
-          msg = "unexpected response #{code} -> #{data.inspect}"
-          raise InvalidRequest, msg
-        end
-
-        if blk
-          blk.call(response)
-        else
-          response
-        end
-      end
+    def self.new(options)
+      $stderr.puts "WARNING: Swirl::EC2 will be deprecated.  Use Swirl::AWS.new(:ec2) instead"
+      return AWS.new(:ec2, options)
     end
-
-    def call!(action, query={}, &blk)
-      # Hard coding this here until otherwise needed
-      method = "POST"
-
-      query["Action"] = action
-      query["AWSAccessKeyId"] = @aws_access_key_id
-      query["SignatureMethod"] = "HmacSHA256"
-      query["SignatureVersion"] = "2"
-      query["Timestamp"] = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
-      query["Version"] = @version
-
-      body = compile_sorted_form_data(query)
-      body += "&" + ["Signature", compile_signature(method, body)].join("=")
-
-      post(body) do |code, xml|
-        if ENV["SWIRL_LOG"]
-          puts response.body
-        end
-
-        data = Crack::XML.parse(xml)
-        blk.call(code, data)
-      end
-    end
-
-    def post(body, &blk)
-      headers = { "Content-Type" => "application/x-www-form-urlencoded" }
-
-      http = Net::HTTP.new(@url.host, @url.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-      request = Net::HTTP::Post.new(@url.request_uri, headers)
-      request.body = body
-
-      response = http.request(request)
-      blk.call(response.code.to_i, response.body)
-    end
-
-    def inspect
-      "<#{self.class.name} version: #{@version} url: #{@url} aws_access_key_id: #{@aws_access_key_id}>"
-    end
-
   end
 
 end

data/lib/swirl/helpers.rb

@@ -37,8 +37,8 @@ module Swirl
 
       def compact!(data)
         data.inject({}) do |com, (key, value)|
-          if Lists.include?(key)
-            converted = if value && value.has_key?("item")
+          if value.is_a?(Hash)
+            converted = if value.has_key?("item")
               items = value["item"]
               items ||= []
               items = items.is_a?(Array) ? items : [items]

data/test/compactor_test.rb

@@ -39,13 +39,6 @@ class CompactorTest < Test::Unit::TestCase
     assert_equal expected, Compactor.compact(response)
   end
 
-  test "makes value empty Array if nil" do
-    response = { "Foo" => { "groupSet" => nil } }
-    expected = { "groupSet" =>  [] }
-
-    assert_equal expected, Compactor.compact(response)
-  end
-
   test "traverses list values and compacts" do
     response = {
       "Foo" => {

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 1
-  - 6
-  - 2
-  version: 1.6.2
+  - 7
+  - 0
+  version: 1.7.0
 platform: ruby
 authors: 
 - Blake Mizerany
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 -08:00
+date: 2011-02-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,7 +78,7 @@ extra_rdoc_files:
 files: 
 - LICENSE
 - README.md
-- list-types
+- lib/swirl/aws.rb
 - lib/swirl/ec2.rb
 - lib/swirl/helpers.rb
 - lib/swirl.rb

data/list-types

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-begin
-  require 'nokogiri'
-rescue LoadError
-  abort <<-MSG
-Unable to load nokogiri.
-  Ensure you have it installed and/or
-  export RUBYOPT=rubygems
-  MSG
-end
-
-require 'open-uri'
-require 'stringio'
-require 'pp'
-
-DefaultWSDL = "http://s3.amazonaws.com/ec2-downloads/2008-02-01.ec2.wsdl"
-
-wsdl_url = ARGV.shift || DefaultWSDL
-Wsdl = Nokogiri::XML.parse(open(wsdl_url))
-
-##__END__
-
-list_keys = []
-item_types = Wsdl.search(%Q|//xs:complexType//xs:element[@name="item"]|)
-item_types.each do |item_type|
-  ns, name = item_type["type"].split(":")
-  next if ns != "tns"
-  complex = item_type.parent.parent
-  uses = Wsdl.search(%Q|//xs:element[@type="#{ns}:#{complex["name"]}"]|)
-  uses.each do |u|
-    list_keys << u["name"]
-  end
-end
-
-pp list_keys.uniq