kerryb-amazon-ec2 0.3.6

data/lib/EC2/responses.rb

@@ -0,0 +1,64 @@
+#--
+# 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
+#++
+
+# This allows us to access hash values as if they were methods
+# e.g. foo[:bar] can be accessed as foo.bar
+
+class Hash
+  def method_missing(meth, *args, &block)
+    if args.size == 0
+      self[meth.to_s] || self[meth.to_sym]
+    end
+  end
+end
+
+module EC2
+
+  # The make_request() and ec2_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
+  # (e.g. its arguments were incorrect, or it simply failed) then an exception will
+  # be thrown.  The exceptions are defined in exceptions.rb as individual classes and should
+  # match the exceptions that Amazon has defined for EC2.  If the exception raised cannot be
+  # identified then a more generic exception class will be thrown.
+  #
+  # The implication of this is that you need to be prepared to handle any exceptions that
+  # may be raised by this library in YOUR code with a 'rescue' clauses.  It is up to you
+  # how gracefully you want to handle these exceptions that are raised.
+
+
+  require 'rubygems'
+  begin
+    require 'xmlsimple' unless defined? XmlSimple
+  rescue Exception => e
+    require 'xml-simple' unless defined? XmlSimple
+  end
+
+  class Response
+
+    def self.parse(options = {})
+      options = {
+        :xml => "",
+        :parse_options => { 'forcearray' => ['item'], '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
+    end
+
+  end  # class Response
+
+end  # module EC2

data/lib/EC2/security_groups.rb

@@ -0,0 +1,232 @@
+#--
+# 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 EC2
+
+  class 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
+    # unrestricted network access to one another. Instances will reject network access attempts from other
+    # 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
+    #
+    def create_security_group( options = {} )
+
+      options = {:group_name => "",
+                 :group_description => ""
+                 }.merge(options)
+
+      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
+      raise ArgumentError, "No :group_description provided" if options[:group_description].nil? || options[:group_description].empty?
+
+      params = {
+        "GroupName" => options[:group_name],
+        "GroupDescription" => options[:group_description]
+      }
+
+      return response_generator(:action => "CreateSecurityGroup", :params => params)
+
+    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:
+    #
+    # none
+    #
+    #Optional Arguments:
+    #
+    # :group_name => Array (default : [])
+    #
+    def describe_security_groups( options = {} )
+
+      options = { :group_name => [] }.merge(options)
+
+      params = pathlist("GroupName", options[:group_name] )
+
+      return response_generator(:action => "DescribeSecurityGroups", :params => params)
+
+    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
+    #
+    def delete_security_group( options = {} )
+
+      options = { :group_name => "" }.merge(options)
+
+      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
+
+      params = { "GroupName" => options[:group_name] }
+
+      return response_generator(:action => "DeleteSecurityGroup", :params => params)
+
+    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
+    # IP range or an Amazon EC2 user-group pair), source and destination port ranges (for TCP and UDP),
+    # and ICMP codes and types (for ICMP). When authorizing ICMP, -1 may be used as a wildcard in the
+    # type and code fields.
+    #
+    # Permission changes are propagated to instances within the security group being modified as quickly as
+    # possible. However, a small delay is likely, depending on the number of instances that are members of
+    # the indicated group.
+    #
+    # When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and
+    # SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission,
+    # 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
+    #
+    def authorize_security_group_ingress( options = {} )
+
+      # defaults
+      options = { :group_name => nil,
+                  :ip_protocol => nil,
+                  :from_port => nil,
+                  :to_port => nil,
+                  :cidr_ip => nil,
+                  :source_security_group_name => nil,
+                  :source_security_group_owner_id => nil }.merge(options)
+
+      # lets not validate the rest of the possible permutations of required params and instead let
+      # EC2 sort it out on the server side.  We'll only require :group_name as that is always needed.
+      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
+
+      params = { "GroupName" => options[:group_name],
+                 "IpProtocol" => options[:ip_protocol],
+                 "FromPort" => options[:from_port].to_s,
+                 "ToPort" => options[:to_port].to_s,
+                 "CidrIp" => options[:cidr_ip],
+                 "SourceSecurityGroupName" => options[:source_security_group_name],
+                 "SourceSecurityGroupOwnerId" => options[:source_security_group_owner_id]
+                 }
+
+      return response_generator(:action => "AuthorizeSecurityGroupIngress", :params => params)
+
+    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.
+    #
+    # Permissions are specified in terms of the IP protocol (TCP, UDP or ICMP), the source of the request (by
+    # IP range or an Amazon EC2 user-group pair), source and destination port ranges (for TCP and UDP),
+    # and ICMP codes and types (for ICMP). When authorizing ICMP, -1 may be used as a wildcard in the
+    # type and code fields.
+    #
+    # Permission changes are propagated to instances within the security group being modified as quickly as
+    # possible. However, a small delay is likely, depending on the number of instances that are members of
+    # the indicated group.
+    #
+    # When revoking a user/group pair permission, GroupName, SourceSecurityGroupName and
+    # SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission,
+    # 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
+    #
+    def revoke_security_group_ingress( options = {} )
+
+      # defaults
+      options = { :group_name => nil,
+                  :ip_protocol => nil,
+                  :from_port => nil,
+                  :to_port => nil,
+                  :cidr_ip => nil,
+                  :source_security_group_name => nil,
+                  :source_security_group_owner_id => nil }.merge(options)
+
+      # lets not validate the rest of the possible permutations of required params and instead let
+      # EC2 sort it out on the server side.  We'll only require :group_name as that is always needed.
+      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
+
+      params = { "GroupName" => options[:group_name],
+                 "IpProtocol" => options[:ip_protocol],
+                 "FromPort" => options[:from_port].to_s,
+                 "ToPort" => options[:to_port].to_s,
+                 "CidrIp" => options[:cidr_ip],
+                 "SourceSecurityGroupName" => options[:source_security_group_name],
+                 "SourceSecurityGroupOwnerId" => options[:source_security_group_owner_id]
+                 }
+
+      return response_generator(:action => "RevokeSecurityGroupIngress", :params => params)
+
+    end
+
+  end
+
+end

data/lib/EC2/snapshots.rb

@@ -0,0 +1,94 @@
+#--
+# 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 EC2
+
+  class Base
+
+    #Amazon Developer Guide Docs:
+    #
+    # The DescribeSnapshots operation describes the status of Amazon EBS snapshots.
+    #
+    #Required Arguments:
+    #
+    # none
+    #
+    #Optional Arguments:
+    #
+    # :snapshot_id => Array (default : [])
+    #
+
+    def describe_snapshots( options = {} )
+
+      options = { :snapshot_id => [] }.merge(options)
+
+      params = pathlist("SnapshotId", options[:snapshot_id] )
+
+      return response_generator(:action => "DescribeSnapshots", :params => params)
+
+    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:
+    #
+    # 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?
+
+      params = {
+        "VolumeId" => options[:volume_id]
+      }
+
+      return response_generator(:action => "CreateSnapshot", :params => params)
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The DeleteSnapshot operation deletes a snapshot of an Amazon EBS  volume that is stored in Amazon S3.
+    #
+    #Required Arguments:
+    #
+    # :snapshot_id => String (default : '')
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+
+    def delete_snapshot( options = {} )
+
+      options = { :snapshot_id => '' }.merge(options)
+
+      raise ArgumentError, "No :snapshot_id provided" if options[:snapshot_id].nil? || options[:snapshot_id].empty?
+
+      params = {
+        "SnapshotId" => options[:snapshot_id]
+      }
+
+      return response_generator(:action => "DeleteSnapshot", :params => params)
+
+    end
+
+  end
+end

data/lib/EC2/volumes.rb

@@ -0,0 +1,170 @@
+#--
+# 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 EC2
+
+  class 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:
+    #
+    # :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 : '')
+    #
+    #Optional Arguments:
+    #
+    # :size => String (default : '')
+    # :snapshot_id => String (default : '')
+    #
+
+    def create_volume( options = {} )
+
+      # defaults
+      options = { :availability_zone => '' }.merge(options)
+
+      raise ArgumentError, "No :availability_zone provided" if options[:availability_zone].nil? || options[:availability_zone].empty?
+
+      options = { :size => '' }.merge(options)
+      options = { :snapshot_id => '' }.merge(options)
+
+      params = {
+        "AvailabilityZone" => options[:availability_zone],
+        "Size" => options[:size],
+        "SnapshotId" => options[:snapshot_id]
+      }
+
+      return response_generator(:action => "CreateVolume", :params => params)
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The DeleteVolume operation deletes an Amazon EBS volume.
+    #
+    #Required Arguments:
+    #
+    # :volume_id => String (default : '')
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+
+    def delete_volume( options = {} )
+
+      options = { :volume_id => '' }.merge(options)
+
+      raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty?
+
+      params = {
+        "VolumeId" => options[:volume_id]
+      }
+
+      return response_generator(:action => "DeleteVolume", :params => params)
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The AttachVolume operation attaches an Amazon EBS volume to an instance.
+    #
+    #Required Arguments:
+    #
+    # :volume_id => String (default : '')
+    # :instance_id => String (default : '')
+    # :device => String (default : '')
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+
+    def attach_volume( options = {} )
+
+      options = { :volume_id => '' }.merge(options)
+      options = { :instance_id => '' }.merge(options)
+      options = { :device => '' }.merge(options)
+
+      raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty?
+      raise ArgumentError, "No :instance_id provided" if options[:instance_id].nil? || options[:instance_id].empty?
+      raise ArgumentError, "No :device provided" if options[:device].nil? || options[:device].empty?
+
+      params = {
+        "VolumeId" => options[:volume_id],
+        "InstanceId" => options[:instance_id],
+        "Device" => options[:device]
+      }
+
+      return response_generator(:action => "AttachVolume", :params => params)
+
+    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 : '')
+    #
+
+    def detach_volume( options = {} )
+
+      options = { :volume_id => '' }.merge(options)
+
+      raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty?
+
+      options = { :instance_id => '' }.merge(options)
+      options = { :device => '' }.merge(options)
+      options = { :force => '' }.merge(options)
+
+      params = {
+        "VolumeId" => options[:volume_id],
+        "InstanceId" => options[:instance_id],
+        "Device" => options[:device],
+        "Force" => options[:force]
+      }
+
+      return response_generator(:action => "DetachVolume", :params => params)
+
+    end
+  end
+end