fog-maestrodev 1.7.0.20121114190951 → 1.8.0.20130109172219

data/lib/fog/aws/models/rds/parameters.rb

@@ -24,7 +24,7 @@ module Fog
           marker = nil
           finished = false
           while !finished
-            data = connection.describe_db_parameters(group.id, filters.merge(:marker => marker)).body
+            data = service.describe_db_parameters(group.id, filters.merge(:marker => marker)).body
             result.concat(data['DescribeDBParametersResult']['Parameters'])
             marker = data['DescribeDBParametersResult']['Marker']
             finished = marker.nil?
@@ -34,4 +34,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/aws/models/rds/security_group.rb

@@ -19,7 +19,7 @@ module Fog
 
         def destroy
           requires :id
-          connection.delete_db_security_group(id)
+          service.delete_db_security_group(id)
           true
         end
 
@@ -27,7 +27,7 @@ module Fog
           requires :id
           requires :description
 
-          data = connection.create_db_security_group(id, description).body['CreateDBSecurityGroupResult']['DBSecurityGroup']
+          data = service.create_db_security_group(id, description).body['CreateDBSecurityGroupResult']['DBSecurityGroup']
           merge_attributes(data)
           true
         end
@@ -55,7 +55,7 @@ module Fog
         end
 
         def authorize_ingress(opts)
-          data = connection.authorize_db_security_group_ingress(id, opts).body['AuthorizeDBSecurityGroupIngressResult']['DBSecurityGroup']
+          data = service.authorize_db_security_group_ingress(id, opts).body['AuthorizeDBSecurityGroupIngressResult']['DBSecurityGroup']
           merge_attributes(data)
         end
 
@@ -72,7 +72,7 @@ module Fog
         end
 
         def revoke_ingress(opts)
-          data = connection.revoke_db_security_group_ingress(id, opts).body['RevokeDBSecurityGroupIngressResult']['DBSecurityGroup']
+          data = service.revoke_db_security_group_ingress(id, opts).body['RevokeDBSecurityGroupIngressResult']['DBSecurityGroup']
           merge_attributes(data)
         end
 

data/lib/fog/aws/models/rds/security_groups.rb

@@ -20,14 +20,14 @@ module Fog
 
         def all(filters = filters)
           self.filters = filters
-          data = connection.describe_db_security_groups(filters).body['DescribeDBSecurityGroupsResult']['DBSecurityGroups']
+          data = service.describe_db_security_groups(filters).body['DescribeDBSecurityGroupsResult']['DBSecurityGroups']
           load(data) # data is an array of attribute hashes
         end
 
         # Example:
         # get('my_db_security_group') # => model for my_db_security_group
         def get(identity)
-          data = connection.describe_db_security_groups(identity).body['DescribeDBSecurityGroupsResult']['DBSecurityGroups'].first
+          data = service.describe_db_security_groups(identity).body['DescribeDBSecurityGroupsResult']['DBSecurityGroups'].first
           new(data) # data is an attribute hash
         rescue Fog::AWS::RDS::NotFound
           nil

data/lib/fog/aws/models/rds/server.rb

@@ -36,8 +36,8 @@ module Fog
         def create_read_replica(replica_id, options={})
           options[:security_group_names] ||= options['DBSecurityGroups']
           params = self.class.new(options).attributes_to_params
-          connection.create_db_instance_read_replica(replica_id, id, params)
-          connection.servers.get(replica_id)
+          service.create_db_instance_read_replica(replica_id, id, params)
+          service.servers.get(replica_id)
         end
 
         def ready?
@@ -46,42 +46,42 @@ module Fog
 
         def destroy(snapshot_identifier=nil)
           requires :id
-          connection.delete_db_instance(id, snapshot_identifier, snapshot_identifier.nil?)
+          service.delete_db_instance(id, snapshot_identifier, snapshot_identifier.nil?)
           true
         end
 
         def reboot
-          connection.reboot_db_instance(id)
+          service.reboot_db_instance(id)
           true
         end
 
         def snapshots
           requires :id
-          connection.snapshots(:server => self)
+          service.snapshots(:server => self)
         end
 
         def tags
           requires :id
-          connection.list_tags_for_resource(id).
+          service.list_tags_for_resource(id).
             body['ListTagsForResourceResult']['TagList']
         end
 
         def add_tags(new_tags)
           requires :id
-          connection.add_tags_to_resource(id, new_tags)
+          service.add_tags_to_resource(id, new_tags)
           tags
         end
 
         def remove_tags(tag_keys)
           requires :id
-          connection.remove_tags_from_resource(id, tag_keys)
+          service.remove_tags_from_resource(id, tag_keys)
           tags
         end
 
         def modify(immediately, options)
           options[:security_group_names] ||= options['DBSecurityGroups']
           params = self.class.new(options).attributes_to_params
-          data = connection.modify_db_instance(id, immediately, params)
+          data = service.modify_db_instance(id, immediately, params)
           merge_attributes(data.body['ModifyDBInstanceResult']['DBInstance'])
           true
         end
@@ -94,7 +94,7 @@ module Fog
 
           self.flavor_id ||= 'db.m1.small'
 
-          data = connection.create_db_instance(id, attributes_to_params)
+          data = service.create_db_instance(id, attributes_to_params)
           merge_attributes(data.body['CreateDBInstanceResult']['DBInstance'])
           true
         end

data/lib/fog/aws/models/rds/servers.rb

@@ -10,12 +10,12 @@ module Fog
         model Fog::AWS::RDS::Server
 
         def all
-          data = connection.describe_db_instances.body['DescribeDBInstancesResult']['DBInstances']
+          data = service.describe_db_instances.body['DescribeDBInstancesResult']['DBInstances']
           load(data) # data is an array of attribute hashes
         end
 
         def get(identity)
-          data = connection.describe_db_instances(identity).body['DescribeDBInstancesResult']['DBInstances'].first
+          data = service.describe_db_instances(identity).body['DescribeDBInstancesResult']['DBInstances'].first
           new(data) # data is an attribute hash
         rescue Fog::AWS::RDS::NotFound
           nil
@@ -24,4 +24,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/aws/models/rds/snapshot.rb

@@ -26,7 +26,7 @@ module Fog
         def destroy
           requires :id
 
-          connection.delete_db_snapshot(id)
+          service.delete_db_snapshot(id)
           true
         end
 
@@ -34,14 +34,14 @@ module Fog
           requires :instance_id
           requires :id
 
-          data = connection.create_db_snapshot(instance_id, id).body['CreateDBSnapshotResult']['DBSnapshot']
+          data = service.create_db_snapshot(instance_id, id).body['CreateDBSnapshotResult']['DBSnapshot']
           merge_attributes(data)
           true
         end
 
         def server
           requires :instance_id
-          connection.servers.get(instance_id)
+          service.servers.get(instance_id)
         end
 
       end

data/lib/fog/aws/models/rds/snapshots.rb

@@ -23,12 +23,12 @@ module Fog
 
         def all(filters = filters)
           self.filters = filters
-          data = connection.describe_db_snapshots(filters).body['DescribeDBSnapshotsResult']['DBSnapshots']
+          data = service.describe_db_snapshots(filters).body['DescribeDBSnapshotsResult']['DBSnapshots']
           load(data) # data is an array of attribute hashes
         end
 
         def get(identity)
-          data = connection.describe_db_snapshots(:snapshot_id => identity).body['DescribeDBSnapshotsResult']['DBSnapshots'].first
+          data = service.describe_db_snapshots(:snapshot_id => identity).body['DescribeDBSnapshotsResult']['DBSnapshots'].first
           new(data) # data is an attribute hash
         rescue Fog::AWS::RDS::NotFound
           nil
@@ -45,4 +45,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/aws/models/rds/subnet_groups.rb

@@ -10,12 +10,12 @@ module Fog
         model Fog::AWS::RDS::SubnetGroup
 
         def all
-          data = connection.describe_db_subnet_groups.body['DescribeDBSubnetGroupsResult']['DBSubnetGroups']
+          data = service.describe_db_subnet_groups.body['DescribeDBSubnetGroupsResult']['DBSubnetGroups']
           load(data) # data is an array of attribute hashes
         end
 
         def get(identity)
-          data = connection.describe_db_subnet_groups(identity).body['DescribeDBSubnetGroupsResult']['DBSubnetGroups'].first
+          data = service.describe_db_subnet_groups(identity).body['DescribeDBSubnetGroupsResult']['DBSubnetGroups'].first
           new(data) # data is an attribute hash
         rescue Fog::AWS::RDS::NotFound
           nil

data/lib/fog/aws/models/storage/directories.rb

@@ -10,7 +10,7 @@ module Fog
         model Fog::Storage::AWS::Directory
 
         def all
-          data = connection.get_service.body['Buckets']
+          data = service.get_service.body['Buckets']
           load(data)
         end
 
@@ -21,7 +21,7 @@ module Fog
             :max_keys   => 'max-keys',
             :prefix     => 'prefix'
           })
-          data = connection.get_bucket(key, options).body
+          data = service.get_bucket(key, options).body
           directory = new(:key => data['Name'])
           options = {}
           for k, v in data

data/lib/fog/aws/models/storage/directory.rb

@@ -28,7 +28,7 @@ module Fog
 
         def destroy
           requires :key
-          connection.delete_bucket(key)
+          service.delete_bucket(key)
           true
         rescue Excon::Errors::NotFound
           false
@@ -36,7 +36,7 @@ module Fog
 
         def location
           requires :key
-          attributes[:location] || bucket_location || self.connection.region
+          attributes[:location] || bucket_location || self.service.region
         end
 
         def location=(new_location)
@@ -48,34 +48,34 @@ module Fog
         end
 
         def files
-          @files ||= Fog::Storage::AWS::Files.new(:directory => self, :connection => connection)
+          @files ||= Fog::Storage::AWS::Files.new(:directory => self, :service => service)
         end
 
         def payer
           requires :key
-          data = connection.get_request_payment(key)
+          data = service.get_request_payment(key)
           data.body['Payer']
         end
 
         def payer=(new_payer)
           requires :key
-          connection.put_request_payment(key, new_payer)
+          service.put_request_payment(key, new_payer)
           @payer = new_payer
         end
 
         def versioning?
           requires :key
-          data = connection.get_bucket_versioning(key)
+          data = service.get_bucket_versioning(key)
           data.body['VersioningConfiguration']['Status'] == 'Enabled'
         end
 
         def versioning=(new_versioning)
           requires :key
-          connection.put_bucket_versioning(key, new_versioning ? 'Enabled' : 'Suspended')
+          service.put_bucket_versioning(key, new_versioning ? 'Enabled' : 'Suspended')
         end
 
         def versions
-          @versions ||= Fog::Storage::AWS::Versions.new(:directory => self, :connection => connection)
+          @versions ||= Fog::Storage::AWS::Versions.new(:directory => self, :service => service)
         end
 
         def public=(new_public)
@@ -85,8 +85,8 @@ module Fog
 
         def public_url
           requires :key
-          if connection.get_bucket_acl(key).body['AccessControlList'].detect {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
-            if key.to_s =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\-(?![\.])){1,61}[a-z0-9]$/
+          if service.get_bucket_acl(key).body['AccessControlList'].detect {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
+            if key.to_s =~ Fog::AWS::COMPLIANT_BUCKET_NAMES
               "https://#{key}.s3.amazonaws.com"
             else
               "https://s3.amazonaws.com/#{key}"
@@ -103,11 +103,11 @@ module Fog
 
           options['x-amz-acl'] = acl if acl
 
-          if location = attributes[:location] || (self.connection.region != 'us-east-1' && self.connection.region)
+          if location = attributes[:location] || (self.service.region != 'us-east-1' && self.service.region)
             options['LocationConstraint'] = location
           end
 
-          connection.put_bucket(key, options)
+          service.put_bucket(key, options)
 
           true
         end
@@ -115,7 +115,7 @@ module Fog
         private
 
         def bucket_location
-          data = connection.get_bucket_location(key)
+          data = service.get_bucket_location(key)
           data.body['LocationConstraint']
         end
 

data/lib/fog/aws/models/storage/file.rb

@@ -6,6 +6,7 @@ module Fog
     class AWS
 
       class File < Fog::Model
+        # @see AWS Object docs http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectOps.html 
 
         identity  :key,             :aliases => 'Key'
 
@@ -25,11 +26,18 @@ module Fog
         attribute :encryption,          :aliases => 'x-amz-server-side-encryption'
         attribute :version,             :aliases => 'x-amz-version-id'
 
-        # Chunk size to use for multipart uploads
-        # Use small chunk sizes to minimize memory
-        # E.g. 5242880 = 5mb
+        # @note Chunk size to use for multipart uploads.
+        #     Use small chunk sizes to minimize memory. E.g. 5242880 = 5mb
         attr_accessor :multipart_chunk_size
 
+
+        # Set file's access control list (ACL).
+        # 
+        #     valid acls: private, public-read, public-read-write, authenticated-read
+        # 
+        # @param [String] new_acl one of valid options
+        # @return [String] @acl
+        # 
         def acl=(new_acl)
           valid_acls = ['private', 'public-read', 'public-read-write', 'authenticated-read']
           unless valid_acls.include?(new_acl)
@@ -38,6 +46,11 @@ module Fog
           @acl = new_acl
         end
 
+
+        # Get file's body if exists, else ' '.
+        # 
+        # @return [File]
+        # 
         def body
           attributes[:body] ||= if last_modified && (file = collection.get(identity))
             file.body
@@ -46,38 +59,71 @@ module Fog
           end
         end
 
+
+        # Set body attribute.
+        # 
+        # @param [File] new_body
+        # @return [File] attributes[:body]
+        # 
         def body=(new_body)
           attributes[:body] = new_body
         end
 
+
+        # Get the file instance's directory.
+        # 
+        # @return [Fog::AWS::Storage::Directory]
+        # 
         def directory
           @directory
         end
 
+
+        # Copy object from one bucket to other bucket.
+        # 
+        #     required attributes: directory, key
+        # 
+        # @param target_directory_key [String]
+        # @param target_file_key [String]
+        # @param options [Hash] options for copy_object method
+        # @return [String] Fog::AWS::Files#head status of directory contents
+        # 
         def copy(target_directory_key, target_file_key, options = {})
           requires :directory, :key
-          connection.copy_object(directory.key, key, target_directory_key, target_file_key, options)
-          target_directory = connection.directories.new(:key => target_directory_key)
+          service.copy_object(directory.key, key, target_directory_key, target_file_key, options)
+          target_directory = service.directories.new(:key => target_directory_key)
           target_directory.files.head(target_file_key)
         end
 
+
+        # Destroy file via http DELETE.
+        # 
+        #     required attributes: directory, key
+        # 
+        # @param options [Hash]
+        # @option options versionId []
+        # @return [Boolean] true if successful
+        # 
         def destroy(options = {})
           requires :directory, :key
           attributes[:body] = nil if options['versionId'] == version
-          connection.delete_object(directory.key, key, options)
+          service.delete_object(directory.key, key, options)
           true
         end
 
+
         remove_method :metadata
         def metadata
           attributes.reject {|key, value| !(key.to_s =~ /^x-amz-/)}
         end
 
+
         remove_method :metadata=
         def metadata=(new_metadata)
           merge_attributes(new_metadata)
         end
 
+
         remove_method :owner=
         def owner=(new_owner)
           if new_owner
@@ -88,6 +134,14 @@ module Fog
           end
         end
 
+
+        # Set Access-Control-List permissions.
+        #   
+        #     valid new_publics: public_read, private
+        # 
+        # @param [String] new_public
+        # @return [String] new_puplic 
+        # 
         def public=(new_public)
           if new_public
             @acl = 'public-read'
@@ -97,10 +151,19 @@ module Fog
           new_public
         end
 
+
+        # Get pubically acessible url via http GET.
+        # Checks persmissions before creating. 
+        # Defaults to s3 subdomain or compliant bucket name
+        # 
+        #     required attributes: directory, key
+        # 
+        # @return [String] public url
+        # 
         def public_url
           requires :directory, :key
-          if connection.get_object_acl(directory.key, key).body['AccessControlList'].detect {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
-            if directory.key.to_s =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\-(?![\.])){1,61}[a-z0-9]$/
+          if service.get_object_acl(directory.key, key).body['AccessControlList'].detect {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
+            if directory.key.to_s =~ Fog::AWS::COMPLIANT_BUCKET_NAMES
               "https://#{directory.key}.s3.amazonaws.com/#{Fog::AWS.escape(key)}".gsub('%2F','/')
             else
               "https://s3.amazonaws.com/#{directory.key}/#{Fog::AWS.escape(key)}".gsub('%2F','/')
@@ -110,6 +173,22 @@ module Fog
           end
         end
 
+        # Save file with body as contents to directory.key with name key via http PUT
+        # 
+        #   required attributes: body, directory, key
+        # 
+        # @param [Hash] options  
+        # @option options [String] acl sets x-amz-acl HTTP header. Valid values include, private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control
+        # @option options [String] cache_controle sets Cache-Control header. For example, 'No-cache'
+        # @option options [String] content_disposition sets Content-Disposition HTTP header. For exampple, 'attachment; filename=testing.txt'
+        # @option options [String] content_encoding sets Content-Encoding HTTP header. For example, 'x-gzip'
+        # @option options [String] content_md5 sets Content-MD5. For example, '79054025255fb1a26e4bc422aef54eb4'
+        # @option options [String] content_type Content-Type. For example, 'text/plain'
+        # @option options [String] expires sets number of seconds before AWS Object expires.
+        # @option options [String] storage_class sets x-amz-storage-class HTTP header. Defaults to 'STANDARD'. Or, 'REDUCED_REDUNDANCY'
+        # @option options [String] encryption sets HTTP encryption header. Set to 'AES256' to encrypt files at rest on S3
+        # @return [Boolean] true if no errors
+        # 
         def save(options = {})
           requires :body, :directory, :key
           if options != {}
@@ -130,7 +209,7 @@ module Fog
             data = multipart_save(options)
             merge_attributes(data.body)
           else
-            data = connection.put_object(directory.key, key, body, options)
+            data = service.put_object(directory.key, key, body, options)
             merge_attributes(data.headers.reject {|key, value| ['Content-Length', 'Content-Type'].include?(key)})
           end
           self.etag.gsub!('"','')
@@ -139,16 +218,29 @@ module Fog
           true
         end
 
+
+        # Get a url for file.
+        # 
+        #     required attributes: key
+        # 
+        # @param expires [String] number of seconds before url expires
+        # @param options [Hash]
+        # @return [String] url
+        # 
         def url(expires, options = {})
           requires :key
           collection.get_url(key, expires, options)
         end
 
+
+        # File version if exists or creates new version.
+        # @return [Fog::Storage::AWS::Version] 
+        # 
         def versions
           @versions ||= begin
             Fog::Storage::AWS::Versions.new(
               :file         => self,
-              :connection   => connection
+              :service   => service
             )
           end
         end
@@ -161,7 +253,7 @@ module Fog
 
         def multipart_save(options)
           # Initiate the upload
-          res = connection.initiate_multipart_upload(directory.key, key, options)
+          res = service.initiate_multipart_upload(directory.key, key, options)
           upload_id = res.body["UploadId"]
 
           # Store ETags of upload parts
@@ -174,17 +266,17 @@ module Fog
           body.rewind if body.respond_to?(:rewind)
           while (chunk = body.read(multipart_chunk_size)) do
             md5 = Base64.encode64(Digest::MD5.digest(chunk)).strip
-            part_upload = connection.upload_part(directory.key, key, upload_id, part_tags.size + 1, chunk, 'Content-MD5' => md5 )
+            part_upload = service.upload_part(directory.key, key, upload_id, part_tags.size + 1, chunk, 'Content-MD5' => md5 )
             part_tags << part_upload.headers["ETag"]
           end
 
         rescue
           # Abort the upload & reraise
-          connection.abort_multipart_upload(directory.key, key, upload_id) if upload_id
+          service.abort_multipart_upload(directory.key, key, upload_id) if upload_id
           raise
         else
           # Complete the upload
-          connection.complete_multipart_upload(directory.key, key, upload_id, part_tags)
+          service.complete_multipart_upload(directory.key, key, upload_id, part_tags)
         end
 
       end