aws-sdk 1.0.4 → 1.1.0

data/lib/aws/ec2/security_group.rb

@@ -20,6 +20,14 @@ module AWS
   class EC2
 
     # Represents a security group in EC2.
+    #
+    # @attr_reader [String] description The short informal description 
+    #   given when the group was created.
+    #
+    # @attr_reader [String] name The name of the security group.
+    #
+    # @attr_reader [String] owner_id The security group owner's id.
+    #
     class SecurityGroup < Resource
 
       include TaggedItem
@@ -37,28 +45,24 @@ module AWS
 
       alias_method :group_id, :id
 
-      # @return [Boolean] True if the security group exists.
-      def exists?
-        client.describe_security_groups(:filters =>
-                                         [{ :name => "group-id",
-                                            :values => [id] }]).
-          security_group_index.key?(id)
-      end
+      attribute :name, :as => :group_name, :static => true
 
-      # @return [String] The name of the security group.
-      def name; end
-      describe_call_attribute :group_name, :getter => :name, :memoize => true
+      attribute :owner_id, :static => true
 
-      # @return [String] The id of the owner for this security group.
-      def owner_id; end
-      describe_call_attribute :owner_id, :memoize => true
+      attribute :description, :as => :group_description, :static => true
 
-      # @return [String] The short informal description given when the
-      #   group was created.
-      def description; end
-      describe_call_attribute :group_description, :getter => :description, :memoize => true
+      attribute :ip_permissions_list, :as => :ip_permissions
 
-      describe_call_attribute :ip_permissions, :getter => :ip_permissions_list
+      populates_from(:describe_security_groups) do |resp|
+        resp.security_group_index[id]
+      end
+
+      # @return [Boolean] True if the security group exists.
+      def exists?
+        client.describe_security_groups(:filters => [
+          { :name => "group-id", :values => [id] }
+        ]).security_group_index.key?(id)
+      end
 
       # @return [SecurityGroup::IpPermissionCollection] Returns a
       #   collection of {IpPermission} objects that represents all of

data/lib/aws/ec2/security_group_collection.rb

@@ -110,11 +110,8 @@ module AWS
         response = filtered_request(:describe_security_groups)
         response.security_group_info.each do |info|
 
-          group = SecurityGroup.new(info.group_id,
-            :name => info.group_name,
-            :description => info.group_description,
-            :owner_id => info.owner_id,
-            :config => config)
+          group = SecurityGroup.new_from(:describe_security_groups, info, 
+            info.group_id, :config => config)
 
           yield(group)
 

data/lib/aws/ec2/snapshot.rb

@@ -55,22 +55,51 @@ module AWS
     #   snapshot provided at snapshot initiation.
     class Snapshot < Resource
 
-      include HasPermissions
       include TaggedItem
-      alias_method :create_volume_permissions, :permissions
-
-      # The snapshot ID
-      attr_reader :id
+      include HasPermissions
 
       # @private
-      def initialize(id, opts = {})
+      def initialize id, options = {}
         @id = id
-        super(opts)
+        super(options)
+      end
+
+      # @return [String] Returns the snapshot's ID.
+      attr_reader :id
+
+      attribute :status, :to_sym => true
+
+      attribute :start_time, :static => true
+
+      attribute :progress do
+        translates_output {|value| value.to_i if value }
+      end
+
+      attribute :owner_id, :static => true
+
+      attribute :volume_size, :static => true
+
+      attribute :volume_id, :static => true
+
+      attribute :owner_alias, :static => true
+
+      attribute :description, :static => true
+
+      alias_method :create_volume_permissions, :permissions
+
+      populates_from(:create_snapshot) do |resp|
+        resp if resp.snapshot_id == id
+      end
+
+      populates_from(:describe_snapshots) do |resp|
+        resp.snapshot_index[id]
       end
 
       # Deletes the snapshot.
+      # @return [nil]
       def delete
         client.delete_snapshot(:snapshot_id => id)
+        nil
       end
 
       # Creates a volume from the snapshot.
@@ -80,16 +109,18 @@ module AWS
       #   {EC2#availability_zones} for how to get a list of
       #   availability zones.
       #
-      # @param [Hash] opts Additional options for creating the volume
+      # @param [Hash] options Additional options for creating the volume
       #
-      # @option opts [Integer] size The desired size (in gigabytes)
+      # @option options [Integer] size The desired size (in gigabytes)
       #   for the volume.
       #
       # @return [Volume] The newly created volume
-      def create_volume(availability_zone, opts = {})
-        VolumeCollection.new(:config => config).
-          create(opts.merge(:snapshot => self,
-                            :availability_zone => availability_zone))
+      def create_volume availability_zone, options = {}
+        volumes = VolumeCollection.new(:config => config)
+        volumes.create(options.merge(
+          :availability_zone => availability_zone,
+          :snapshot => self
+        ))
       end
 
       # @return [Boolean] True if the snapshot exists.
@@ -100,38 +131,16 @@ module AWS
           !resp.snapshot_set.empty?
       end
 
-      describe_call_attribute :volume_id
-
       # @return [Volume] The volume this snapshot was created from.
       def volume
         Volume.new(volume_id, :config => config) if volume_id
       end
 
-      describe_call_attribute :status, :to_sym => true
-      describe_call_attribute :start_time
-      describe_call_attribute :progress do
-        translate_output { |value| value.to_i if value }
-      end
-      describe_call_attribute :owner_id
-      describe_call_attribute :volume_size
-      describe_call_attribute :owner_alias
-      describe_call_attribute :description
-
       # @private
       def __permissions_attribute__
         "createVolumePermission"
       end
 
-      populate_from :create_snapshot do |resp|
-        attributes_from_response_object(resp) if
-          resp.snapshot_id == id
-      end
-
-      protected
-      def find_in_response(resp)
-        resp.snapshot_index[id]
-      end
-
     end
 
   end

data/lib/aws/ec2/snapshot_collection.rb

@@ -39,10 +39,21 @@ module AWS
 
       include TaggedCollection
 
+      # @private
+      def initialize(options = {})
+        @owners = options[:owners] || []
+        @restorable_by = options[:restorable_by] || []
+        super(options)
+      end
+
       # @yield [Instance] Yields each volume in the collection.
       # @return [nil]
       def each(&block)
-        resp = filtered_request(:describe_snapshots)
+        opts = {}
+        opts[:owner_ids] = @owners.map { |id| id.to_s } unless @owners.empty?
+        opts[:restorable_by_user_ids] = @restorable_by.map { |id| id.to_s } unless
+          @restorable_by.empty?
+        resp = filtered_request(:describe_snapshots, opts)
         resp.snapshot_set.each do |v|
           snapshot = Snapshot.new(v.snapshot_id, :config => config)
           yield(snapshot)
@@ -50,6 +61,31 @@ module AWS
         nil
       end
 
+      # @return [SnapshotCollection] A new collection that only
+      #   includes snapshots owned by one or more of the specified AWS
+      #   accounts.  The IDs +:amazon+ and +:self+ can be used to
+      #   include snapshots owned by Amazon or AMIs owned by you,
+      #   respectively.
+      #
+      # @param [Array of Strings] owners The AWS account IDs by
+      #   which the new collection should be filtered.
+      def with_owner(*owners)
+        collection_with(:owners => @owners + owners)
+      end
+
+      # @return [ImageCollection] A new collection that only includes
+      #   images for which the specified user ID has explicit launch
+      #   permissions. The user ID can be an AWS account ID, +:self+
+      #   to return AMIs for which the sender of the request has
+      #   explicit launch permissions, or +:all+ to return AMIs with
+      #   public launch permissions.
+      #
+      # @param [Array of Strings] users The AWS account IDs by which
+      #   the new collection should be filtered.
+      def restorable_by(*users)
+        collection_with(:restorable_by => @restorable_by + users)
+      end
+
       # Creates a snapshot of an Amazon EBS volume and stores it in
       # Amazon S3. You can use snapshots for backups, to make
       # identical copies of instance devices, and to save data
@@ -84,6 +120,12 @@ module AWS
         Snapshot
       end
 
+      # @private
+      protected
+      def preserved_options
+        super.merge(:owners => @owners, :restorable_by => @restorable_by)
+      end
+
     end
 
   end

data/lib/aws/ec2/tag.rb

@@ -18,6 +18,7 @@ module AWS
   class EC2
 
     # Represents an EC2 tag.
+    # @attr [String] value The tag value.
     class Tag < Resource
 
       # @param [String] key The name of the tag
@@ -37,9 +38,11 @@ module AWS
 
       alias_method :name, :key
 
-      # @return [String] The tag value.
-      def value; end
-      describe_call_attribute :value
+      attribute :value
+
+      populates_from(:describe_tags) do |resp|
+        resp.tag_index[response_index_key]
+      end
 
       # Deletes this tag.
       # @return [nil]
@@ -52,12 +55,12 @@ module AWS
 
       # @private
       def inspect
-        "<#{local_cache_key}>"
+        "<#{self.class}:#{local_cache_key}>"
       end
 
       # @private
       def local_cache_key
-        "#{self.class}:#{response_index_key}"
+        response_index_key
       end
 
       private
@@ -68,19 +71,12 @@ module AWS
       end
 
       protected
-      def find_in_response(resp)
-        resp.tag_index[response_index_key]
-      end
-
-      protected
-      def describe_call
-        client.describe_tags(:filters =>
-                             [{ :name => "key",
-                                :values => [key] },
-                              { :name => "resource-type",
-                                :values => [resource.tagging_resource_type] },
-                              { :name => "resource-id",
-                                :values => [resource.send(:__resource_id__)] }])
+      def get_resource attr
+        client.describe_tags(:filters => [
+          { :name => "key", :values => [key] },
+          { :name => "resource-type", :values => [resource.tagging_resource_type] },
+          { :name => "resource-id", :values => [resource.send(:__resource_id__)] }
+        ])
       end
 
     end

data/lib/aws/ec2/volume.rb

@@ -48,8 +48,8 @@ module AWS
     # @attr_reader [Integer] size The size of the volume in
     #   gigabytes.
     #
-    # @attr_reader [AvailabilityZone] availability_zone Availability
-    #   Zone in which the volume was created.
+    # @attr_reader [String] availability_zone_name Name of the
+    #   Availability Zone in which the volume was created.
     #
     # @attr_reader [Time] create_time The time at which the volume
     #   was created.
@@ -57,28 +57,54 @@ module AWS
 
       include TaggedItem
 
-      attr_reader :id
-
       # @private
       def initialize(id, opts = {})
         @id = id
         super(opts)
       end
 
+      # @return [String] Returns the volume ID.
+      attr_reader :id
+
+      attribute :status, :to_sym => true
+
+      alias_method :state, :status
+
+      attribute :snapshot_id, :static => true
+
+      attribute :size, :static => true do
+        translates_output {|value| value.to_i if value }
+      end
+
+      attribute :availability_zone_name, :as => :availability_zone,
+        :static => true
+
+      attribute :create_time, :static => true
+
+      attribute :attachment_set
+
+      populates_from(:create_volume) do |resp|
+        resp if resp.volume_id == id
+      end
+
+      populates_from(:describe_volumes) do |resp|
+        resp.volume_index[id]
+      end
+
       # Deletes the volume.
       def delete
         client.delete_volume(:volume_id => id)
+        nil
       end
 
       # @return [Snapshot] A new snapshot created from the volume.
       #
       # @param [String] description An optional description of the
       #   snapshot.  May be up to 255 characters in length.
-      def create_snapshot(description = nil)
+      def create_snapshot description = nil
         opts = { :volume => self }
         opts[:description] = description if description
-        SnapshotCollection.new(:config => config).
-          create(opts)
+        SnapshotCollection.new(:config => config).create(opts)
       end
 
       # Attaches the volume to an instance.
@@ -93,95 +119,56 @@ module AWS
       # @return [Attachment] An object representing the attachment,
       #   which you can use to query the attachment status.
       def attach_to(instance, device)
-        resp = client.attach_volume(:volume_id => id,
-                                    :instance_id => instance.id,
-                                    :device => device)
-        Attachment.new(self,
-                       Instance.new(resp.instance_id),
-                       resp.device,
-                       :config => config)
+        resp = client.attach_volume(
+          :volume_id => id,
+          :instance_id => instance.id,
+          :device => device
+        )
+        instance = Instance.new(resp.instance_id, :config => config)
+        Attachment.new(self, instance, resp.device, :config => config)
       end
       alias_method :attach, :attach_to
 
       # Detaches the volume from an instance.
       #
       # @param [Instance] instance The instance to detach from.
-      #
       # @param [String] device The device name.
-      #
-      # @param [Hash] opts Additional options for detaching the
-      #   volume.
-      #
-      # @option opts [Boolean] :force Forces detachment if the
-      #   previous detachment attempt did not occur cleanly (logging
-      #   into an instance, unmounting the volume, and detaching
-      #   normally). This option can lead to data loss or a
-      #   corrupted file system. Use this option only as a last
-      #   resort to detach a volume from a failed instance. The
-      #   instance will not have an opportunity to flush file system
-      #   caches or file system metadata. If you use this option,
-      #   you must perform file system check and repair procedures.
-      def detach_from(instance, device, opts = {})
-        a = Attachment.new(self,
-                           Instance.new(instance.id),
-                           device,
-                           :config => config)
-        a.delete
+      # @param [Hash] options
+      # @option (see Attachment#delete)
+      # @return [Attachment] Returns the no-longer valid attachment.
+      def detach_from(instance, device, options = {})
+        instance = Instance.new(instance.id, :config => config),
+        a = Attachment.new(self, instance, device, :config => config)
+        a.delete(options)
         a
       end
 
-      # @return [AttachmentCollection] The collection of attachments
-      #   that involve this volume.
-      def attachments
-        AttachmentCollection.new(self, :config => config)
-      end
-
       # @return [Boolean] True if the volume exists.
       def exists?
-        resp =
-          client.describe_volumes(:filters => [{ :name => 'volume-id',
-                                                 :values => [id] }]) and
-          resp.volume_index.key?(id)
+        resp = client.describe_volumes(:filters => [
+          { :name => 'volume-id', :values => [id] }
+        ]) 
+        resp.volume_index.key?(id)
       end
 
-      describe_call_attribute :status, :to_sym => true
-      alias_method :state, :status
-
-      describe_call_attribute :snapshot_id
-
       # @return [Snapshot] Snapshot from which the volume was created
       #   (may be nil).
-      def snapshot;
-        if snapshot_id = self.snapshot_id
-          Snapshot.new(snapshot_id, :config => config)
-        end
-      end
-
-      describe_call_attribute :size do
-        translate_output { |value| value.to_i if value }
+      def snapshot
+        snapshot_id ? Snapshot.new(snapshot_id, :config => config) : nil
       end
 
-      describe_call_attribute :availability_zone, :getter => :availability_zone_name
-
+      # @return [AvailabilityZone] Returns the Availability
+      #   Zone in which the volume was created.
       def availability_zone
         if name = availability_zone_name
           AvailabilityZone.new(name, :config => config)
         end
       end
 
-      describe_call_attribute :create_time
-
-      describe_call_attribute :attachment_set
-
-      populate_from :create_volume do |resp|
-        attributes_from_response_object(resp) if
-          resp.volume_id == id
-      end
-
-      # @private
-      protected
-      def find_in_response(resp)
-        resp.volume_index[id]
+      # @return [AttachmentCollection] The collection of attachments
+      #   that involve this volume.
+      def attachments
+        AttachmentCollection.new(self, :config => config)
       end
 
     end