grempe-amazon-ec2 0.5.1 → 0.5.2

data/lib/AWS/EC2/image_attributes.rb

@@ -1,20 +1,7 @@
-#--
-# 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:
       #
@@ -25,17 +12,12 @@ module AWS
       # 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 : [])
+      # @option options [String] :image_id ("")
+      # @option options [String] :attribute ("launchPermission") An attribute to modify, "launchPermission" or "productCodes"
+      # @option options [String] :operation_type ("")
+      # @option options [optional, Array] :user_id ([])
+      # @option options [optional, Array] :group ([])
+      # @option options [optional, Array] :product_code ([])
       #
       def modify_image_attribute( options = {} )
 
@@ -87,18 +69,10 @@ module AWS
 
       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
+      # @option options [String] :image_id ("")
+      # @option options [String] :attribute ("launchPermission") An attribute to describe, "launchPermission" or "productCodes"
       #
       def describe_image_attribute( options = {} )
 
@@ -125,18 +99,10 @@ module AWS
       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
+      # @option options [String] :image_id ("")
+      # @option options [String] :attribute ("launchPermission") An attribute to reset
       #
       def reset_image_attribute( options = {} )
 
@@ -163,6 +129,5 @@ module AWS
       end
 
     end
-
   end
 end

data/lib/AWS/EC2/images.rb

@@ -1,20 +1,8 @@
-#--
-# 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 RegisterImage operation registers an AMI with Amazon EC2. Images must be registered before
       # they can be launched.  Each AMI is associated with an unique ID which is provided by the EC2
       # service via the Registerimage operation. As part of the registration process, Amazon EC2 will
@@ -24,13 +12,7 @@ module AWS
       # If you do have to make changes and upload a new image deregister the previous image and register
       # the new image.
       #
-      #Required Arguments:
-      #
-      # :image_location => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [String] :image_location ("")
       #
       def register_image( options = {} )
 
@@ -44,8 +26,6 @@ module AWS
 
       end
 
-      #Amazon Developer Guide Docs:
-      #
       # The DescribeImages operation returns information about AMIs available for use by the user. This
       # includes both public AMIs (those available for any user to launch) and private AMIs (those owned by
       # the user making the request and those owned by other users that the user making the request has explicit
@@ -82,15 +62,9 @@ module AWS
       # Deregistered images will be included in the returned results for an unspecified interval subsequent to
       # deregistration.
       #
-      #Required Arguments:
-      #
-      # none
-      #
-      #Optional Arguments:
-      #
-      # :image_id => Array (default : [])
-      # :owner_id => Array (default : [])
-      # :executable_by => Array (default : [])
+      # @option options [Array] :image_id ([])
+      # @option options [Array] :owner_id ([])
+      # @option options [Array] :executable_by ([])
       #
       def describe_images( options = {} )
 
@@ -104,22 +78,13 @@ module AWS
 
       end
 
-      #Amazon Developer Guide Docs:
-      #
       # The DeregisterImage operation deregisters an AMI. Once deregistered, instances of the AMI may no
       # longer be launched.
       #
-      #Required Arguments:
-      #
-      # :image_id => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [String] :image_id ("")
       #
       def deregister_image( options = {} )
 
-        # defaults
         options = { :image_id => "" }.merge(options)
 
         raise ArgumentError, "No :image_id provided" if options[:image_id].nil? || options[:image_id].empty?

data/lib/AWS/EC2/instances.rb

@@ -1,20 +1,8 @@
-#--
-# 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 RunInstances operation launches a specified number of instances.
       #
       # Note : The Query version of RunInstances only allows instances of a single AMI to be launched in
@@ -52,22 +40,17 @@ module AWS
       # If any of the AMIs have product codes attached for which the user has not subscribed,
       # the RunInstances call will fail.
       #
-      #Required Arguments:
-      #
-      # :image_id => String (Default : "")
-      # :min_count => Integer (default : 1 )
-      # :max_count => Integer (default : 1 )
-      #
-      #Optional Arguments:
-      #
-      # :key_name => String (default : nil)
-      # :group_id => Array (default : [])
-      # :user_data => String (default : nil)
-      # :addressing_type => String (default : "public")
-      # :instance_type => String (default : "m1.small")
-      # :kernel_id => String (default : nil)
-      # :availability_zone => String (default : nil)
-      # :base64_encoded => Boolean (default : false)
+      # @option options [String] :image_id ("")
+      # @option options [Integer] :min_count (1)
+      # @option options [Integer] :max_count (1)
+      # @option options [optional, String] :key_name (nil)
+      # @option options [optional, Array] :group_id ([])
+      # @option options [optional, String] :user_data (nil)
+      # @option options [optional, String] :addressing_type ("public")
+      # @option options [optional, String] :instance_type ("m1.small")
+      # @option options [optional, String] :kernel_id (nil)
+      # @option options [optional, String] :availability_zone (nil)
+      # @option options [optional, Boolean] :base64_encoded (false)
       #
       def run_instances( options = {} )
 
@@ -113,7 +96,7 @@ module AWS
       # If :user_data is passed in then URL escape and Base64 encode it
       # as needed.  Need for URL Escape + Base64 encoding is determined
       # by :base64_encoded param.
-      def extract_user_data(options)
+      def extract_user_data( options = {} )
         return unless options[:user_data]
         if options[:user_data]
           if options[:base64_encoded]
@@ -125,8 +108,6 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The DescribeInstances operation returns information about instances owned by the user
       # making the request.
       #
@@ -138,13 +119,7 @@ module AWS
       # Recently terminated instances will be included in the returned results for a small interval subsequent to
       # their termination. This interval is typically of the order of one hour
       #
-      #Required Arguments:
-      #
-      # none
-      #
-      #Optional Arguments:
-      #
-      # :instance_id => Array (default : [])
+      # @option options [Array] :instance_id ([])
       #
       def describe_instances( options = {} )
 
@@ -157,19 +132,11 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The RebootInstances operation requests a reboot of one or more instances. This operation is
       # asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed
       # provided the instances are valid and belong to the user. Terminated instances will be ignored.
       #
-      #Required Arguments:
-      #
-      # :instance_id => Array (default : [])
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [Array] :instance_id ([])
       #
       def reboot_instances( options = {} )
 
@@ -185,20 +152,12 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The TerminateInstances operation shuts down one or more instances. This operation is idempotent
       # and terminating an instance that is in the process of shutting down (or already terminated) will succeed.
       # Terminated instances remain visible for a short period of time (approximately one hour) after
       # termination, after which their instance ID is invalidated.
       #
-      #Required Arguments:
-      #
-      # :instance_id => Array (default : [])
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [Array] :instance_id ([])
       #
       def terminate_instances( options = {} )
 

data/lib/AWS/EC2/keypairs.rb

@@ -1,35 +1,16 @@
-#--
-# 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 CreateKeyPair operation creates a new 2048 bit RSA keypair and returns a unique ID that can be
       # used to reference this keypair when launching new instances.
       #
-      #Required Arguments:
-      #
-      # :key_name => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [String] :key_name ("")
       #
       def create_keypair( options = {} )
 
-        # defaults
         options = { :key_name => "" }.merge(options)
 
         raise ArgumentError, "No :key_name provided" if options[:key_name].nil? || options[:key_name].empty?
@@ -41,19 +22,11 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The DescribeKeyPairs operation returns information about keypairs available for use by the user
       # making the request. Selected keypairs may be specified or the list may be left empty if information for
       # all registered keypairs is required.
       #
-      #Required Arguments:
-      #
-      # :key_name => Array (default : [])
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [Array] :key_name ([])
       #
       def describe_keypairs( options = {} )
 
@@ -66,17 +39,9 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The DeleteKeyPair operation deletes a keypair.
       #
-      #Required Arguments:
-      #
-      # :key_name => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [String] :key_name ("")
       #
       def delete_keypair( options = {} )
 

data/lib/AWS/EC2/products.rb

@@ -1,45 +1,21 @@
-#--
-# 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 ConfirmProductInstance operation returns true if the given product code is attached to the instance
       # with the given instance id. False is returned if the product code is not attached to the instance.
       #
-      #Required Arguments:
-      #
-      # :product_code => String (default : "")
-      # :instance_id => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [String] :product_code ("")
+      # @option options [String] :instance_id ("")
       #
       def confirm_product_instance( options ={} )
-
         options = {:product_code => "", :instance_id => ""}.merge(options)
-
         raise ArgumentError, "No product code provided" if options[:product_code].nil? || options[:product_code].empty?
         raise ArgumentError, "No instance ID provided" if options[:instance_id].nil? || options[:instance_id].empty?
-
         params = { "ProductCode" => options[:product_code], "InstanceId" => options[:instance_id] }
-
         return response_generator(:action => "ConfirmProductInstance", :params => params)
-
       end
-    end
 
+    end
   end
 end

data/lib/AWS/EC2/security_groups.rb

@@ -1,21 +1,7 @@
-#--
-# 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 CreateSecurityGroup operation creates a new security group. Every instance is launched
       # in a security group. If none is specified as part of the launch request then instances
       # are launched in the default security group. Instances within the same security group have
@@ -23,14 +9,8 @@ module AWS
       # instances in a different security group. As the owner of instances you may grant or revoke specific
       # permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations.
       #
-      #Required Arguments:
-      #
-      # :group_name => String (default : "")
-      # :group_description => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [String] :group_name ("")
+      # @option options [String] :group_description ("")
       #
       def create_security_group( options = {} )
 
@@ -51,22 +31,14 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The DescribeSecurityGroups operation returns information about security groups owned by the
       # user making the request.
       #
       # An optional list of security group names may be provided to request information for those security
       # groups only. If no security group names are provided, information of all security groups will be
-      # returned. If a group is specified that does not exist a fault is returned.
-      #
-      #Required Arguments:
+      # returned. If a group is specified that does not exist an exception is returned.
       #
-      # none
-      #
-      #Optional Arguments:
-      #
-      # :group_name => Array (default : [])
+      # @option options [optional, Array] :group_name ([])
       #
       def describe_security_groups( options = {} )
 
@@ -79,20 +51,12 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The DeleteSecurityGroup operation deletes a security group.
       #
       # If an attempt is made to delete a security group and any instances exist that are members of that group a
       # fault is returned.
       #
-      #Required Arguments:
-      #
-      # :group_name => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # none
+      # @option options [String] :group_name ("")
       #
       def delete_security_group( options = {} )
 
@@ -107,8 +71,6 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The AuthorizeSecurityGroupIngress operation adds permissions to a security group.
       #
       # Permissions are specified in terms of the IP protocol (TCP, UDP or ICMP), the source of the request (by
@@ -125,18 +87,13 @@ module AWS
       # GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified. Mixing these two types
       # of parameters is not allowed.
       #
-      #Required Arguments:
-      #
-      # :group_name => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # :ip_protocol => String (default : nil) : Required when authorizing CIDR IP permission
-      # :from_port => Integer (default : nil) : Required when authorizing CIDR IP permission
-      # :to_port => Integer (default : nil) : Required when authorizing CIDR IP permission
-      # :cidr_ip => String (default : nil): Required when authorizing CIDR IP permission
-      # :source_security_group_name => String (default : nil) : Required when authorizing user group pair permissions
-      # :source_security_group_owner_id => String (default : nil) : Required when authorizing user group pair permissions
+      # @option options [String] :group_name ("")
+      # @option options [optional, String] :ip_protocol (nil) Required when authorizing CIDR IP permission
+      # @option options [optional, Integer] :from_port (nil) Required when authorizing CIDR IP permission
+      # @option options [optional, Integer] :to_port (nil) Required when authorizing CIDR IP permission
+      # @option options [optional, String] :cidr_ip (nil) Required when authorizing CIDR IP permission
+      # @option options [optional, String] :source_security_group_name (nil) Required when authorizing user group pair permissions
+      # @option options [optional, String] :source_security_group_owner_id (nil) Required when authorizing user group pair permissions
       #
       def authorize_security_group_ingress( options = {} )
 
@@ -167,8 +124,6 @@ module AWS
       end
 
 
-      #Amazon Developer Guide Docs:
-      #
       # The RevokeSecurityGroupIngress operation revokes existing permissions that were previously
       # granted to a security group. The permissions to revoke must be specified using the same values
       # originally used to grant the permission.
@@ -187,18 +142,13 @@ module AWS
       # GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified. Mixing these two types
       # of parameters is not allowed.
       #
-      #Required Arguments:
-      #
-      # :group_name => String (default : "")
-      #
-      #Optional Arguments:
-      #
-      # :ip_protocol => String (default : nil) : Required when revoking CIDR IP permission
-      # :from_port => Integer (default : nil) : Required when revoking CIDR IP permission
-      # :to_port => Integer (default : nil) : Required when revoking CIDR IP permission
-      # :cidr_ip => String (default : nil): Required when revoking CIDR IP permission
-      # :source_security_group_name => String (default : nil) : Required when revoking user group pair permissions
-      # :source_security_group_owner_id => String (default : nil) : Required when revoking user group pair permissions
+      # @option options [String] :group_name ("")
+      # @option options [optional, String] :ip_protocol (nil) Required when revoking CIDR IP permission
+      # @option options [optional, Integer] :from_port (nil) Required when revoking CIDR IP permission
+      # @option options [optional, Integer] :to_port (nil) Required when revoking CIDR IP permission
+      # @option options [optional, String] :cidr_ip (nil) Required when revoking CIDR IP permission
+      # @option options [optional, String] :source_security_group_name (nil) Required when revoking user group pair permissions
+      # @option options [optional, String] :source_security_group_owner_id (nil) Required when revoking user group pair permissions
       #
       def revoke_security_group_ingress( options = {} )
 
@@ -229,6 +179,5 @@ module AWS
       end
 
     end
-
   end
 end