amazon-ec2 0.4.8 → 0.5.0

data/lib/AWS/EC2.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__), 'EC2/**/*.rb')].sort.each { |lib| require lib }
+
+module AWS
+  module EC2
+
+    # Which host FQDN will we connect to for all API calls to AWS?
+    # If EC2_URL is defined in the users ENV we can use that. It is
+    # expected that this var is set with something like:
+    #   export EC2_URL='https://ec2.amazonaws.com'
+    #
+    if ENV['EC2_URL']
+      EC2_URL = ENV['EC2_URL']
+      VALID_HOSTS = ['https://ec2.amazonaws.com', 'https://us-east-1.ec2.amazonaws.com', 'https://eu-west-1.ec2.amazonaws.com']
+      raise ArgumentError, "Invalid EC2_URL environment variable : #{EC2_URL}" unless VALID_HOSTS.include?(EC2_URL)
+      DEFAULT_HOST = URI.parse(EC2_URL).host
+    else
+      # default US host
+      DEFAULT_HOST = 'ec2.amazonaws.com'
+    end
+
+    # This is the version of the API as defined by Amazon Web Services
+    API_VERSION = '2008-12-01'
+
+    #Introduction:
+    #
+    # The library exposes one main interface class, 'AWS::EC2::Base'.
+    # This class provides all the methods for using the EC2 service
+    # including the handling of header signing and other security issues .
+    # This class uses Net::HTTP to interface with the EC2 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 : 'ec2.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/EC2/availability_zones.rb

@@ -0,0 +1,43 @@
+#--
+# 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
+#++
+
+module AWS
+  module EC2
+
+    class Base < AWS::Base
+
+      #Amazon Developer Guide Docs:
+      #
+      # The DescribeAvailabilityZones operation describes availability zones that are currently
+      # available to the account and their states.
+      #
+      # An optional list of zone names can be passed.
+      #
+      #Required Arguments:
+      #
+      # none
+      #
+      #Optional Arguments:
+      #
+      # :zone_name => Array (default : [])
+      #
+
+      def describe_availability_zones( options = {} )
+
+        options = { :zone_name => [] }.merge(options)
+
+        params = pathlist("ZoneName", options[:zone_name] )
+
+        return response_generator(:action => "DescribeAvailabilityZones", :params => params)
+
+      end
+    end
+  end
+end

data/lib/AWS/EC2/console.rb

@@ -0,0 +1,46 @@
+#--
+# 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
+#++
+
+module AWS
+  module EC2
+
+    class Base < AWS::Base
+
+      #Amazon Developer Guide Docs:
+      #
+      # The GetConsoleOutput operation retrieves console output that has been posted for the specified instance.
+      #
+      # Instance console output is buffered and posted shortly after instance boot, reboot and once the instance
+      # is terminated. Only the most recent 64 KB of posted output is available. Console output is available for
+      # at least 1 hour after the most recent post.
+      #
+      #Required Arguments:
+      #
+      # :instance_id => String (default : "")
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def get_console_output( options ={} )
+
+        options = {:instance_id => ""}.merge(options)
+
+        raise ArgumentError, "No instance ID provided" if options[:instance_id].nil? || options[:instance_id].empty?
+
+        params = { "InstanceId" => options[:instance_id] }
+
+        return response_generator(:action => "GetConsoleOutput", :params => params)
+
+      end
+    end
+
+  end
+end

data/lib/AWS/EC2/elastic_ips.rb

@@ -0,0 +1,154 @@
+#--
+# 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
+#++
+
+module AWS
+  module EC2
+    class Base < AWS::Base
+
+
+      #Amazon Developer Guide Docs:
+      #
+      # The AllocateAddress operation acquires an elastic IP address for use with your account.
+      #
+      #Required Arguments:
+      #
+      # none
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def allocate_address
+
+        return response_generator(:action => "AllocateAddress")
+
+      end
+
+      #Amazon Developer Guide Docs:
+      #
+      # The DescribeAddresses operation lists elastic IP addresses assigned to your account.
+      #
+      #Required Arguments:
+      #
+      # :public_ip => Array (default : [], can be empty)
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def describe_addresses( options = {} )
+
+        options = { :public_ip => [] }.merge(options)
+
+        params = pathlist("PublicIp", options[:public_ip])
+
+        return response_generator(:action => "DescribeAddresses", :params => params)
+
+      end
+
+      #Amazon Developer Guide Docs:
+      #
+      # The ReleaseAddress operation releases an elastic IP address associated with your account.
+      #
+      # If you run this operation on an elastic IP address that is already released, the address
+      # might be assigned to another account which will cause Amazon EC2 to return an error.
+      #
+      # Note : Releasing an IP address automatically disassociates it from any instance
+      # with which it is associated. For more information, see DisassociateAddress.
+      #
+      # Important! After releasing an elastic IP address, it is released to the IP
+      # address pool and might no longer be available to your account. Make sure
+      # to update your DNS records and any servers or devices that communicate
+      # with the address.
+      #
+      #Required Arguments:
+      #
+      # :public_ip => String (default : '')
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def release_address( options = {} )
+
+        options = { :public_ip => '' }.merge(options)
+
+        raise ArgumentError, "No ':public_ip' provided" if options[:public_ip].nil? || options[:public_ip].empty?
+
+        params = { "PublicIp" => options[:public_ip] }
+
+        return response_generator(:action => "ReleaseAddress", :params => params)
+
+      end
+
+      #Amazon Developer Guide Docs:
+      #
+      # The AssociateAddress operation associates an elastic IP address with an instance.
+      #
+      # If the IP address is currently assigned to another instance, the IP address
+      # is assigned to the new instance. This is an idempotent operation. If you enter
+      # it more than once, Amazon EC2 does not return an error.
+      #
+      #Required Arguments:
+      #
+      # :instance_id  => String (default : '')
+      # :public_ip    => String (default : '')
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def associate_address( options = {} )
+
+        options = { :instance_id => '', :public_ip => '' }.merge(options)
+
+        raise ArgumentError, "No ':instance_id' provided" if options[:instance_id].nil? || options[:instance_id].empty?
+        raise ArgumentError, "No ':public_ip' provided" if options[:public_ip].nil? || options[:public_ip].empty?
+
+        params = {
+          "InstanceId" => options[:instance_id],
+          "PublicIp" => options[:public_ip]
+        }
+
+        return response_generator(:action => "AssociateAddress", :params => params)
+
+      end
+
+      #Amazon Developer Guide Docs:
+      #
+      # The DisassociateAddress operation disassociates the specified elastic IP
+      # address from the instance to which it is assigned. This is an idempotent
+      # operation. If you enter it more than once, Amazon EC2 does not return
+      # an error.
+      #
+      #Required Arguments:
+      #
+      # :public_ip    => String (default : '')
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def disassociate_address( options = {} )
+
+        options = { :public_ip => '' }.merge(options)
+
+        raise ArgumentError, "No ':public_ip' provided" if options[:public_ip].nil? || options[:public_ip].empty?
+
+        params = { "PublicIp" => options[:public_ip] }
+
+        return response_generator(:action => "DisassociateAddress", :params => params)
+
+      end
+
+    end
+
+  end
+end

data/lib/AWS/EC2/image_attributes.rb

@@ -0,0 +1,168 @@
+#--
+# 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
+#++
+
+module AWS
+  module EC2
+
+    class Base < AWS::Base
+
+      #Amazon Developer Guide Docs:
+      #
+      # The ModifyImageAttribute operation modifies an attribute of an AMI.  The following attributes may
+      # currently be modified:
+      #
+      # 'launchPermission' : Controls who has permission to launch the AMI. Launch permissions can be
+      # granted to specific users by adding userIds. The AMI can be made public by adding the 'all' group.
+      #
+      # 'productCodes' : Associates product codes with AMIs. This allows a developer to charge a user extra
+      # for using the AMIs. productCodes is a write once attribute - once it has been set it can not be
+      # changed or removed.  Currently only one product code is supported per AMI.
+      #
+      #Required Arguments:
+      #
+      # :image_id => String (default : "")
+      # :attribute => String ('launchPermission' or 'productCodes', default : "launchPermission")
+      # :operation_type => String (default : "")
+      #
+      #Optional Arguments:
+      #
+      # :user_id => Array (default : [])
+      # :group => Array (default : [])
+      # :product_code => Array (default : [])
+      #
+      def modify_image_attribute( options = {} )
+
+        # defaults
+        options = { :image_id => "",
+                    :attribute => "launchPermission",
+                    :operation_type => "",
+                    :user_id => [],
+                    :group => [],
+                    :product_code => [] }.merge(options)
+
+        raise ArgumentError, "No ':image_id' provided" if options[:image_id].nil? || options[:image_id].empty?
+        raise ArgumentError, "No ':attribute' provided" if options[:attribute].nil? || options[:attribute].empty?
+
+        # OperationType is not required if modifying a product code.
+        unless options[:attribute] == 'productCodes'
+          raise ArgumentError, "No ':operation_type' provided" if options[:operation_type].nil? || options[:operation_type].empty?
+        end
+
+        params = {
+          "ImageId" => options[:image_id],
+          "Attribute" => options[:attribute],
+          "OperationType" => options[:operation_type]
+        }
+
+        # test options provided and make sure they are valid
+        case options[:attribute]
+        when "launchPermission"
+
+          unless options[:operation_type] == "add" || options[:operation_type] == "remove"
+            raise ArgumentError, ":operation_type was #{options[:operation_type].to_s} but must be either 'add' or 'remove'"
+          end
+
+          if (options[:user_id].nil? || options[:user_id].empty?) && (options[:group].nil? || options[:group].empty?)
+            raise ArgumentError, "Option :attribute=>'launchPermission' requires ':user_id' or ':group' options to also be specified"
+          end
+          params.merge!(pathlist("UserId", options[:user_id])) unless options[:user_id].nil?
+          params.merge!(pathlist("Group", options[:group])) unless options[:group].nil?
+        when "productCodes"
+          if (options[:product_code].nil? || options[:product_code].empty?)
+            raise ArgumentError, "Option :attribute=>'productCodes' requires ':product_code' to be specified"
+          end
+          params.merge!(pathlist("ProductCode", options[:product_code])) unless options[:product_code].nil?
+        else
+          raise ArgumentError, "attribute : #{options[:attribute].to_s} is not an known attribute."
+        end
+
+        return response_generator(:action => "ModifyImageAttribute", :params => params)
+
+      end
+
+      #Amazon Developer Guide Docs:
+      #
+      # The DescribeImageAttribute operation returns information about an attribute of an AMI.
+      #
+      #Required Arguments:
+      #
+      # :image_id => String (default : "")
+      # :attribute => String ("launchPermission" or "productCodes", default : "launchPermission")
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def describe_image_attribute( options = {} )
+
+        # defaults
+        options = {:image_id => "",
+                   :attribute => "launchPermission"
+                   }.merge(options)
+
+        raise ArgumentError, "No ':image_id' provided" if options[:image_id].nil? || options[:image_id].empty?
+        raise ArgumentError, "No ':attribute' provided" if options[:attribute].nil? || options[:attribute].empty?
+
+        params = { "ImageId" => options[:image_id], "Attribute" => options[:attribute] }
+
+        # test options provided and make sure they are valid
+        case options[:attribute]
+        when "launchPermission", "productCodes"
+          # these args are ok
+        else
+          raise ArgumentError, "attribute : #{options[:attribute].to_s} is not an known attribute."
+        end
+
+        return response_generator(:action => "DescribeImageAttribute", :params => params)
+
+      end
+
+
+      #Amazon Developer Guide Docs:
+      #
+      # The ResetImageAttribute operation resets an attribute of an AMI to its default value.
+      #
+      #Required Arguments:
+      #
+      # :image_id => String (default : "")
+      # :attribute => String (default : "launchPermission")
+      #
+      #Optional Arguments:
+      #
+      # none
+      #
+      def reset_image_attribute( options = {} )
+
+        # defaults
+        options = {:image_id => "",
+                   :attribute => "launchPermission"}.merge(options)
+
+        raise ArgumentError, "No ':image_id' provided" if options[:image_id].nil? || options[:image_id].empty?
+        raise ArgumentError, "No ':attribute' provided" if options[:attribute].nil? || options[:attribute].empty?
+
+        params = {"ImageId" => options[:image_id],
+                  "Attribute" => options[:attribute] }
+
+        # test options provided and make sure they are valid
+        case options[:attribute]
+        when "launchPermission"
+          # these args are ok
+        else
+          raise ArgumentError, "attribute : #{options[:attribute].to_s} is not an known attribute."
+        end
+
+        return response_generator(:action => "ResetImageAttribute", :params => params)
+
+      end
+
+    end
+
+  end
+end