grempe-amazon-ec2 0.5.1 → 0.5.2

data/lib/AWS/EC2/snapshots.rb

@@ -1,31 +1,12 @@
-#--
-# Amazon Web Services EC2 Query API Ruby library, EBS snaphshots support
-#
-# Ruby Gem Name::  amazon-ec2
-# Author::    Yann Klis  (mailto:yann.klis@novelys.com)
-# Copyright:: Copyright (c) 2008 Yann Klis
-# 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 DescribeSnapshots operation describes the status of Amazon EBS snapshots.
       #
-      #Required Arguments:
-      #
-      # none
-      #
-      #Optional Arguments:
-      #
-      # :snapshot_id => Array (default : [])
+      # @option options [Array] :snapshot_id ([])
       #
-
       def describe_snapshots( options = {} )
 
         options = { :snapshot_id => [] }.merge(options)
@@ -36,22 +17,12 @@ module AWS
 
       end
 
-      #Amazon Developer Guide Docs:
-      #
       # The CreateSnapshot operation creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to launch instances from identical snapshots, and to save data before shutting down an instance.
       #
-      #Required Arguments:
-      #
-      # :volume_id => String (default : '')
-      #
-      #Optional Arguments:
+      # @option options [String] :volume_id ('')
       #
-      # none
-      #
-
       def create_snapshot( options = {} )
 
-        # defaults
         options = { :volume_id => '' }.merge(options)
 
         raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty?
@@ -64,19 +35,11 @@ module AWS
 
       end
 
-      #Amazon Developer Guide Docs:
-      #
+
       # The DeleteSnapshot operation deletes a snapshot of an Amazon EBS  volume that is stored in Amazon S3.
       #
-      #Required Arguments:
+      # @option options [String] :snapshot_id ('')
       #
-      # :snapshot_id => String (default : '')
-      #
-      #Optional Arguments:
-      #
-      # none
-      #
-
       def delete_snapshot( options = {} )
 
         options = { :snapshot_id => '' }.merge(options)

data/lib/AWS/EC2/volumes.rb

@@ -1,55 +1,23 @@
-#--
-# Amazon Web Services EC2 Query API Ruby library, EBS volumes support
-#
-# Ruby Gem Name::  amazon-ec2
-# Author::    Yann Klis  (mailto:yann.klis@novelys.com)
-# Copyright:: Copyright (c) 2008 Yann Klis
-# 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 DescribeVolumes operation lists one or more Amazon EBS volumes that you own, If you do not specify any volumes, Amazon EBS returns all volumes that you own.
       #
-      #Required Arguments:
-      #
-      # none
-      #
-      #Optional Arguments:
+      # @option options [optional, String] :volume_id ([])
       #
-      # :volume_id => Array (default : [])
-      #
-
       def describe_volumes( options = {} )
-
         options = { :volume_id => [] }.merge(options)
-
         params = pathlist("VolumeId", options[:volume_id] )
-
         return response_generator(:action => "DescribeVolumes", :params => params)
-
       end
 
-      #Amazon Developer Guide Docs:
-      #
       # The CreateVolume operation creates a new Amazon EBS volume that you can mount from any Amazon EC2 instance.
       #
-      #Required Arguments:
-      #
-      # :availability_zone => String (default : '')
+      # @option options [String] :availability_zone ('')
+      # @option options [optional, String] :size ('')
+      # @option options [optional, String] :snapshot_id ('')
       #
-      #Optional Arguments:
-      #
-      # :size => String (default : '')
-      # :snapshot_id => String (default : '')
-      #
-
       def create_volume( options = {} )
 
         # defaults
@@ -70,19 +38,10 @@ module AWS
 
       end
 
-      #Amazon Developer Guide Docs:
-      #
       # The DeleteVolume operation deletes an Amazon EBS volume.
       #
-      #Required Arguments:
+      # @option options [String] :volume_id ('')
       #
-      # :volume_id => String (default : '')
-      #
-      #Optional Arguments:
-      #
-      # none
-      #
-
       def delete_volume( options = {} )
 
         options = { :volume_id => '' }.merge(options)
@@ -97,21 +56,12 @@ module AWS
 
       end
 
-      #Amazon Developer Guide Docs:
-      #
       # The AttachVolume operation attaches an Amazon EBS volume to an instance.
       #
-      #Required Arguments:
+      # @option options [String] :volume_id ('')
+      # @option options [String] :instance_id ('')
+      # @option options [String] :device ('')
       #
-      # :volume_id => String (default : '')
-      # :instance_id => String (default : '')
-      # :device => String (default : '')
-      #
-      #Optional Arguments:
-      #
-      # none
-      #
-
       def attach_volume( options = {} )
 
         options = { :volume_id => '' }.merge(options)
@@ -132,21 +82,13 @@ module AWS
 
       end
 
-      #Amazon Developer Guide Docs:
-      #
       # The DetachVolume operation detaches an Amazon EBS volume from an instance.
       #
-      #Required Arguments:
-      #
-      # :volume_id => String (default : '')
-      #
-      #Optional Arguments:
-      #
-      # :instance_id => String (default : '')
-      # :device => String (default : '')
-      # :force => Boolean (default : '')
+      # @option options [String] :volume_id ('')
+      # @option options [optional, String] :instance_id ('')
+      # @option options [optional, String] :device ('')
+      # @option options [optional, Boolean] :force ('')
       #
-
       def detach_volume( options = {} )
 
         options = { :volume_id => '' }.merge(options)
@@ -165,8 +107,9 @@ module AWS
         }
 
         return response_generator(:action => "DetachVolume", :params => params)
-
       end
+
     end
   end
-end
+end
+

data/lib/AWS/ELB.rb

@@ -1,58 +1,23 @@
-#--
-# 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 ELB_URL is defined in the users ENV we can override the default with that.
+    # 
+    # @example
+    #   export ELB_URL='https://elasticloadbalancing.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 US API endpoint
       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

data/lib/AWS/ELB/load_balancers.rb

@@ -1,8 +1,7 @@
 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
@@ -10,12 +9,10 @@ module AWS
       # 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
+      # @option options [String] :load_balancer_name (nil) the name of the load balancer
+      # @option options [Array] :availability_zones (nil)
+      # @option options [Array] :listeners (nil) An Array of Hashes (:protocol, :load_balancer_port, :instance_port)
+      # @option options [Array] :availability_zones (nil) An Array of Strings
       #
       def create_load_balancer( options = {} )
         raise ArgumentError, "No :availability_zones provided" if options[:availability_zones].nil? || options[:availability_zones].empty?
@@ -35,8 +32,6 @@ module AWS
         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
@@ -47,20 +42,14 @@ module AWS
       # get the same DNS name even if you create a new LoadBalancer with same
       # LoadBalancerName.
       #
-      # Required Arguments:
-      #
-      #  :load_balancer_name => String
+      # @option options [String] :load_balancer_name the name of the load balancer
       #
       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
@@ -71,20 +60,14 @@ module AWS
       # this API, you must provide the same account credentials as those that
       # were used to create the LoadBalancer.
       #
-      # Optional Arguments:
-      #
-      #  :load_balancer_names => String
+      # @option options [Array<String>] :load_balancer_names ([]) An Array of names of load balancers to describe.
       #
       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
@@ -102,25 +85,18 @@ module AWS
       # 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
+      # @option options [Array<String>] :instances An Array of instance names to add to the load balancer.
+      # @option options [String] :load_balancer_name The name of the load balancer.
       #
       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.
@@ -132,34 +108,25 @@ module AWS
       # Once the instance is deregistered, it will stop receiving traffic from
       # the LoadBalancer.
       #
-      # Required Arguments:
-      #
-      #  :instances => Array of Strings
-      #  :load_balancer_name => String
+      # @option options [Array<String>] :instances An Array of instance names to remove from the load balancer.
+      # @option options [String] :load_balancer_name The name of the load balancer.
       #
       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
+      # @option options [Hash] :health_check A Hash with the keys (:timeout, :interval, :unhealthy_threshold, :healthy_threshold)
+      # @option options [String] :load_balancer_name The name of the load balancer.
       #
       def configure_health_check( options = {} )
         raise ArgumentError, "No :health_check provided" if options[:health_check].nil? || options[:health_check].empty?
@@ -182,17 +149,30 @@ module AWS
         return response_generator(:action => "ConfigureHealthCheck", :params => params)
       end
 
-      def describe_intance_health( options = {} )
+      # Not yet implemented
+      #
+      # @todo Implement this method
+      #
+      def describe_instance_health( options = {} )
         raise "Not yet implemented"
       end
 
+      # Not yet implemented
+      #
+      # @todo Implement this method
+      #
       def disable_availability_zones_for_load_balancer( options = {} )
         raise "Not yet implemented"
       end
 
+      # Not yet implemented
+      #
+      # @todo Implement this method
+      #
       def enable_availability_zones_for_load_balancer( options = {} )
         raise "Not yet implemented"
       end
+
     end
   end
 end