amazon-ec2 0.4.8 → 0.5.0

data/lib/AWS/ELB.rb

@@ -0,0 +1,67 @@
+#--
+# Amazon Web Services EC2 Query API Ruby library
+#
+# Ruby Gem Name::  amazon-ec2
+# Author::    Glenn Rempe  (mailto:glenn@rempe.us)
+# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
+# License::   Distributes under the same terms as Ruby
+# Home::      http://github.com/grempe/amazon-ec2/tree/master
+#++
+
+# Require any lib files that we have bundled with this Ruby Gem in the lib/EC2 directory.
+# Parts of the EC2 module and Base class are broken out into separate
+# files for maintainability and are organized by the functional groupings defined
+# in the EC2 API developers guide.
+Dir[File.join(File.dirname(__FILE__), 'ELB/**/*.rb')].sort.each { |lib| require lib }
+
+module AWS
+  module ELB
+
+    # Which host FQDN will we connect to for all API calls to AWS?
+    # If ELB_URL is defined in the users ENV we can use that. It is
+    # expected that this var is set with something like:
+    #   export ELB_URL='https://ec2.amazonaws.com'
+    #
+    if ENV['ELB_URL']
+      ELB_URL = ENV['ELB_URL']
+      VALID_HOSTS = ['elasticloadbalancing.amazonaws.com']
+      raise ArgumentError, "Invalid ELB_URL environment variable : #{ELB_URL}" unless VALID_HOSTS.include?(ELB_URL)
+      DEFAULT_HOST = URI.parse(ELB_URL).host
+    else
+      # default US host
+      DEFAULT_HOST = 'elasticloadbalancing.amazonaws.com'
+    end
+
+    # This is the version of the API as defined by Amazon Web Services
+    API_VERSION = '2009-05-15'
+
+    #Introduction:
+    #
+    # The library exposes one main interface class, 'AWS::ELB::Base'.
+    # This class provides all the methods for using the ELB service
+    # including the handling of header signing and other security issues .
+    # This class uses Net::HTTP to interface with the ELB Query API interface.
+    #
+    #Required Arguments:
+    #
+    # :access_key_id => String (default : "")
+    # :secret_access_key => String (default : "")
+    #
+    #Optional Arguments:
+    #
+    # :use_ssl => Boolean (default : true)
+    # :server => String (default : 'elasticloadbalancing.amazonaws.com')
+    # :proxy_server => String (default : nil)
+    #
+    class Base < AWS::Base
+      def api_version
+        API_VERSION
+      end
+
+      def default_host
+        DEFAULT_HOST
+      end
+    end
+
+  end
+end

data/lib/AWS/ELB/load_balancers.rb

@@ -0,0 +1,198 @@
+module AWS
+  module ELB
+    class Base < AWS::Base
+      # Amazon Developer Guide Docs:
+      #
+      # This API creates a new LoadBalancer. Once the call has completed
+      # successfully, a new LoadBalancer will be created, but it will not be
+      # usable until at least one instance has been registered. When the
+      # LoadBalancer creation is completed, you can check whether it is usable
+      # by using the DescribeInstanceHealth API. The LoadBalancer is usable as
+      # soon as any registered instance is InService.
+      #
+      # Required Arguments:
+      #
+      #  :load_balancer_name => String
+      #  :availability_zones => Array
+      #  :listeners => Array of Hashes (:protocol, :load_balancer_port, :instance_port)
+      #  :availability_zones => Array of Strings
+      #
+      def create_load_balancer( options = {} )
+        raise ArgumentError, "No :availability_zones provided" if options[:availability_zones].nil? || options[:availability_zones].empty?
+        raise ArgumentError, "No :listeners provided" if options[:listeners].nil? || options[:listeners].empty?
+        raise ArgumentError, "No :load_balancer_name provided" if options[:load_balancer_name].nil? || options[:load_balancer_name].empty?
+
+        params = {}
+
+        params.merge!(pathlist('AvailabilityZones.member', [options[:availability_zones]].flatten))
+        params.merge!(pathhashlist('Listeners.member', [options[:listeners]].flatten, {
+          :protocol => 'Protocol',
+          :load_balancer_port => 'LoadBalancerPort',
+          :instance_port => 'InstancePort'
+        }))
+        params['LoadBalancerName'] = options[:load_balancer_name]
+
+        return response_generator(:action => "CreateLoadBalancer", :params => params)
+      end
+
+      # Amazon Developer Guide Docs:
+      #
+      # This API deletes the specified LoadBalancer. On deletion, all of the
+      # configured properties of the LoadBalancer will be deleted. If you
+      # attempt to recreate the LoadBalancer, you need to reconfigure all the
+      # settings. The DNS name associated with a deleted LoadBalancer is no
+      # longer be usable. Once deleted, the name and associated DNS record of
+      # the LoadBalancer no longer exist and traffic sent to any of its IP
+      # addresses will no longer be delivered to your instances. You will not
+      # get the same DNS name even if you create a new LoadBalancer with same
+      # LoadBalancerName.
+      #
+      # Required Arguments:
+      #
+      #  :load_balancer_name => String
+      #
+      def delete_load_balancer( options = {} )
+        raise ArgumentError, "No :load_balancer_name provided" if options[:load_balancer_name].nil? || options[:load_balancer_name].empty?
+
+        params = { 'LoadBalancerName' => options[:load_balancer_name] }
+
+        return response_generator(:action => "DeleteLoadBalancer", :params => params)
+      end
+
+      # Amazon Developer Guide Docs:
+      #
+      # This API returns detailed configuration information for the specified
+      # LoadBalancers, or if no LoadBalancers are specified, then the API
+      # returns configuration information for all LoadBalancers created by the
+      # caller. For more information, please see LoadBalancer.
+      #
+      # You must have created the specified input LoadBalancers in order to
+      # retrieve this information. In other words, in order to successfully call
+      # this API, you must provide the same account credentials as those that
+      # were used to create the LoadBalancer.
+      #
+      # Optional Arguments:
+      #
+      #  :load_balancer_names => String
+      #
+      def describe_load_balancers( options = {} )
+        options = { :load_balancer_names => [] }.merge(options)
+
+        params = pathlist("LoadBalancerName.member", options[:load_balancer_names])
+
+        return response_generator(:action => "DescribeLoadBalancers", :params => params)
+      end
+
+      # Amazon Developer Guide Docs:
+      #
+      # This API adds new instances to the LoadBalancer.
+      #
+      # Once the instance is registered, it starts receiving traffic and
+      # requests from the LoadBalancer. Any instance that is not in any of the
+      # Availability Zones registered for the LoadBalancer will be moved to
+      # the OutOfService state. It will move to the InService state when the
+      # Availability Zone is added to the LoadBalancer.
+      #
+      # You must have been the one who created the LoadBalancer. In other
+      # words, in order to successfully call this API, you must provide the
+      # same account credentials as those that were used to create the
+      # LoadBalancer.
+      #
+      # NOTE: Completion of this API does not guarantee that operation has
+      # completed. Rather, it means that the request has been registered and
+      # the changes will happen shortly.
+      #
+      # Required Arguments:
+      #
+      #  :instances => Array of Strings
+      #  :load_balancer_name => String
+      #
+      def register_instances_with_load_balancer( options = {} )
+        raise ArgumentError, "No :instances provided" if options[:instances].nil? || options[:instances].empty?
+        raise ArgumentError, "No :load_balancer_name provided" if options[:load_balancer_name].nil? || options[:load_balancer_name].empty?
+
+        params = {}
+
+        params.merge!(pathlist('Instances.member', [options[:instances]].flatten))
+        params['LoadBalancerName'] = options[:load_balancer_name]
+
+        return response_generator(:action => "RegisterInstancesWithLoadBalancer", :params => params)
+      end
+
+      # Amazon Developer Guide Docs:
+      #
+      # This API deregisters instances from the LoadBalancer. Trying to
+      # deregister an instance that is not registered with the LoadBalancer
+      # does nothing.
+      #
+      # In order to successfully call this API, you must provide the same
+      # account credentials as those that were used to create the
+      # LoadBalancer.
+      #
+      # Once the instance is deregistered, it will stop receiving traffic from
+      # the LoadBalancer.
+      #
+      # Required Arguments:
+      #
+      #  :instances => Array of Strings
+      #  :load_balancer_name => String
+      #
+      def deregister_instances_from_load_balancer( options = {} )
+        raise ArgumentError, "No :instances provided" if options[:instances].nil? || options[:instances].empty?
+        raise ArgumentError, "No :load_balancer_name provided" if options[:load_balancer_name].nil? || options[:load_balancer_name].empty?
+
+        params = {}
+
+        params.merge!(pathlist('Instances.member', [options[:instances]].flatten))
+        params['LoadBalancerName'] = options[:load_balancer_name]
+
+        return response_generator(:action => "DeregisterInstancesFromLoadBalancer", :params => params)
+      end
+
+      # Amazon Developer Guide Docs:
+      #
+      # This API enables you to define an application healthcheck for the
+      # instances.
+      #
+      # Note: Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.
+      #
+      # Required Arguments
+      #
+      #  :health_check => Hash (:timeout, :interval, :unhealthy_threshold, :healthy_threshold)
+      #  :load_balancer_name => String
+      #
+      def configure_health_check( options = {} )
+        raise ArgumentError, "No :health_check provided" if options[:health_check].nil? || options[:health_check].empty?
+        raise ArgumentError, "No :health_check => :target provided" if options[:health_check][:target].nil? || options[:health_check][:target].empty?
+        raise ArgumentError, "No :health_check => :timeout provided" if options[:health_check][:timeout].nil? || options[:health_check][:timeout].empty?
+        raise ArgumentError, "No :health_check => :interval provided" if options[:health_check][:interval].nil? || options[:health_check][:interval].empty?
+        raise ArgumentError, "No :health_check => :unhealthy_threshold provided" if options[:health_check][:unhealthy_threshold].nil? || options[:health_check][:unhealthy_threshold].empty?
+        raise ArgumentError, "No :health_check => :healthy_threshold provided" if options[:health_check][:healthy_threshold].nil? || options[:health_check][:healthy_threshold].empty?
+        raise ArgumentError, "No :load_balancer_name provided" if options[:load_balancer_name].nil? || options[:load_balancer_name].empty?
+
+        params = {}
+
+        params['LoadBalancerName'] = options[:load_balancer_name]
+        params['HealthCheck.Target'] = options[:health_check][:target]
+        params['HealthCheck.Timeout'] = options[:health_check][:timeout]
+        params['HealthCheck.Interval'] = options[:health_check][:interval]
+        params['HealthCheck.UnhealthyThreshold'] = options[:health_check][:unhealthy_threshold]
+        params['HealthCheck.HealthyThreshold'] = options[:health_check][:healthy_threshold]
+
+        return response_generator(:action => "ConfigureHealthCheck", :params => params)
+      end
+
+      def describe_intance_health( options = {} )
+        raise "Not yet implemented"
+      end
+
+      def disable_availability_zones_for_load_balancer( options = {} )
+        raise "Not yet implemented"
+      end
+
+      def enable_availability_zones_for_load_balancer( options = {} )
+        raise "Not yet implemented"
+      end
+    end
+  end
+end

data/lib/{EC2 → AWS}/exceptions.rb

@@ -8,8 +8,7 @@
 # Home::      http://github.com/grempe/amazon-ec2/tree/master
 #++
 
-module EC2
-
+module AWS
   # OUR CUSTOM ERROR CODES
 
   # All of our errors are superclassed by Error < RuntimeError
@@ -127,6 +126,26 @@ module EC2
   class InvalidAMIAttributeItemValue < Error #:nodoc:
   end
 
+  # ELB ERRORS
+
+  class LoadBalancerNotFound < Error #:nodoc:
+  end
+
+  class ValidationError < Error #:nodoc:
+  end
+
+  class DuplicateLoadBalancerName < Error #:nodoc:
+  end
+
+  class TooManyLoadBalancers < Error #:nodoc:
+  end
+
+  class InvalidInstance < Error #:nodoc:
+  end
+
+  class InvalidConfigurationRequest < Error #:nodoc:
+  end
+
   # AWS EC2 SERVER ERROR CODES
 
   # Internal AWS EC2 Error.

data/lib/{EC2 → AWS}/responses.rb

@@ -19,9 +19,9 @@ class Hash
   end
 end
 
-module EC2
+module AWS
 
-  # The make_request() and ec2_error? methods, which are shared by all, will raise any
+  # The make_request() and aws_error? methods, which are shared by all, will raise any
   # exceptions encountered along the way as it converses with EC2.
   #
   # Exception Handling: If for some reason an error occurrs when executing a method
@@ -45,13 +45,12 @@ module EC2
     def self.parse(options = {})
       options = {
         :xml => "",
-        :parse_options => { 'forcearray' => ['item'], 'suppressempty' => nil, 'keeproot' => false }
+        :parse_options => { 'forcearray' => ['item', 'member'], 'suppressempty' => nil, 'keeproot' => false }
       }.merge(options)
 
       # NOTE: Parsing the response as a nested set of Response objects was extremely
       # memory intensive and appeared to leak (the memory was not freed on subsequent requests).
       # It was changed to return the raw XmlSimple response.
-
       response = XmlSimple.xml_in(options[:xml], options[:parse_options])
 
       return response
@@ -59,4 +58,4 @@ module EC2
 
   end  # class Response
 
-end  # module EC2
+end  # module AWS

data/perftools/ec2prof-results.txt

@@ -99,7 +99,7 @@ Total: 2178 samples
        0   0.0%  99.6%       32   1.5% Net::HTTPResponse#read_chunked
        0   0.0%  99.6%       12   0.6% REXML::Parsers::XPathParser#LocationPath
        0   0.0%  99.6%      152   7.0% Array#map
-       0   0.0%  99.6%      945  43.4% EC2::Base#response_generator
+       0   0.0%  99.6%      945  43.4% AWS::EC2::Base#response_generator
        0   0.0%  99.6%        1   0.0% Net::HTTPResponse.read_status_line
        0   0.0%  99.6%       34   1.6% Net::HTTP#request
        0   0.0%  99.6%      275  12.6% Array#each
@@ -109,7 +109,7 @@ Total: 2178 samples
        0   0.0%  99.6%       32   1.5% Net::HTTPResponse#reading_body
        0   0.0%  99.6%        1   0.0% Net::HTTPResponse.each_response_header
        0   0.0%  99.6%      801  36.8% REXML::Document#build
-       0   0.0%  99.6%       34   1.6% EC2::Base#make_request
+       0   0.0%  99.6%       34   1.6% AWS::EC2::Base#make_request
        0   0.0%  99.6%       32   1.5% Net::HTTPResponse#body
        0   0.0%  99.6%       32   1.5% Array#delete_if
        0   0.0%  99.6%        1   0.0% REXML::XPathParser#namespaces=
@@ -117,8 +117,8 @@ Total: 2178 samples
        0   0.0%  99.6%     1113  51.1% XmlSimple#xml_in
        0   0.0%  99.6%       27   1.2% Object#timeout
        0   0.0%  99.6%      801  36.8% XmlSimple#parse
-       0   0.0%  99.6%      918  42.1% EC2::Base#describe_images
-       0   0.0%  99.6%      934  42.9% EC2::Response.parse
+       0   0.0%  99.6%      918  42.1% AWS::EC2::Base#describe_images
+       0   0.0%  99.6%      934  42.9% AWS::Response.parse
        0   0.0%  99.6%      801  36.8% REXML::Document#initialize
        0   0.0%  99.6%       22   1.0% Array#join
        0   0.0%  99.6%        1   0.0% Net::BufferedIO#readline

data/perftools/ec2prof.symbols

@@ -7,9 +7,9 @@
 01222665: REXML::Element#each_element
 011249a9: XmlSimple#xml_in
 0223eb95: XmlSimple.xml_in
-022884f1: EC2::Response.parse
-011ba34d: EC2::Base#response_generator
-011ba17d: EC2::Base#describe_images
+022884f1: AWS::Response.parse
+011ba34d: AWS::EC2::Base#response_generator
+011ba17d: AWS::EC2::Base#describe_images
 01124af1: XmlSimple#get_attributes
 012219b1: REXML::Attributes#each_attribute
 01219c51: REXML::Attributes#each
@@ -48,7 +48,7 @@
 025a912d: Net::HTTPResponse.each_response_header
 025a8bfd: Net::HTTPResponse.read_new
 012d8c71: Net::HTTP#request
-011ba2e5: EC2::Base#make_request
+011ba2e5: AWS::EC2::Base#make_request
 012d4611: Net::HTTP#start
 005067ad: Net::BufferedIO#read
 012d87bd: Net::HTTPResponse#read_chunked

data/test/test_EC2.rb

@@ -12,11 +12,11 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 context "The EC2 method " do
 
-  setup do
+  before do
   end
 
-  specify "EC2::Base attribute readers should be available" do
-    @ec2 = EC2::Base.new( :access_key_id => "not a key",
+  specify "AWS::EC2::Base attribute readers should be available" do
+    @ec2 = AWS::EC2::Base.new( :access_key_id => "not a key",
                           :secret_access_key => "not a secret",
                           :use_ssl => true,
                           :server => "foo.example.com" )
@@ -26,8 +26,8 @@ context "The EC2 method " do
     @ec2.server.should.equal "foo.example.com"
   end
 
-  specify "EC2::Base should work with insecure connections as well" do
-    @ec2 = EC2::Base.new( :access_key_id => "not a key",
+  specify "AWS::EC2::Base should work with insecure connections as well" do
+    @ec2 = AWS::EC2::Base.new( :access_key_id => "not a key",
                           :secret_access_key => "not a secret",
                           :use_ssl => false,
                           :server => "foo.example.com" )
@@ -37,8 +37,8 @@ context "The EC2 method " do
     @ec2.server.should.equal "foo.example.com"
   end
 
-  specify "EC2::Base should allow specification of port" do
-    @ec2 = EC2::Base.new( :access_key_id => "not a key",
+  specify "AWS::EC2::Base should allow specification of port" do
+    @ec2 = AWS::EC2::Base.new( :access_key_id => "not a key",
                           :secret_access_key => "not a secret",
                           :use_ssl => true,
                           :server => "foo.example.com",
@@ -49,20 +49,20 @@ context "The EC2 method " do
     @ec2.server.should.equal "foo.example.com"
   end
 
-  specify "EC2.canonical_string(path) should conform to Amazon's requirements " do
+  specify "AWS.canonical_string(path) should conform to Amazon's requirements " do
     path = {"name1" => "value1", "name2" => "value2", "name3" => "value3"}
     if ENV['EC2_URL'].nil? || ENV['EC2_URL'] == 'https://ec2.amazonaws.com'
-      EC2.canonical_string(path).should.equal "POST\nec2.amazonaws.com\n/\nname1=value1&name2=value2&name3=value3"
+      AWS.canonical_string(path, 'ec2.amazonaws.com').should.equal "POST\nec2.amazonaws.com\n/\nname1=value1&name2=value2&name3=value3"
     elsif ENV['EC2_URL'] == 'https://us-east-1.ec2.amazonaws.com'
-      EC2.canonical_string(path).should.equal "POST\nus-east-1.ec2.amazonaws.com\n/\nname1=value1&name2=value2&name3=value3"
+      AWS.canonical_string(path, 'ec2.amazonaws.com').should.equal "POST\nus-east-1.ec2.amazonaws.com\n/\nname1=value1&name2=value2&name3=value3"
     elsif ENV['EC2_URL'] == 'https://eu-west-1.ec2.amazonaws.com'
-      EC2.canonical_string(path).should.equal "POST\neu-west-1.ec2.amazonaws.com\n/\nname1=value1&name2=value2&name3=value3"
+      AWS.canonical_string(path, 'ec2.amazonaws.com').should.equal "POST\neu-west-1.ec2.amazonaws.com\n/\nname1=value1&name2=value2&name3=value3"
     end
   end
 
-  specify "EC2.encode should return the expected string" do
-    EC2.encode("secretaccesskey", "foobar123", urlencode=true).should.equal "e3jeuDc3DIX2mW8cVqWiByj4j5g%3D"
-    EC2.encode("secretaccesskey", "foobar123", urlencode=false).should.equal "e3jeuDc3DIX2mW8cVqWiByj4j5g="
+  specify "AWS.encode should return the expected string" do
+    AWS.encode("secretaccesskey", "foobar123", urlencode=true).should.equal "e3jeuDc3DIX2mW8cVqWiByj4j5g%3D"
+    AWS.encode("secretaccesskey", "foobar123", urlencode=false).should.equal "e3jeuDc3DIX2mW8cVqWiByj4j5g="
   end
 
 end