Class | RightAws::S3::Grantee |
In: |
lib/s3/right_s3.rb
|
Parent: | Object |
There are 2 ways to set permissions for a bucket or key (called a thing below):
1 . Use perms param to set ‘Canned Access Policies’ when calling the bucket.create, bucket.put and key.put methods. The perms param can take these values: ‘private’, ‘public-read’, ‘public-read-write’ and ‘authenticated-read’. (see docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html).
bucket = s3.bucket('bucket_for_kd_test_13', true, 'public-read') key.put('Woohoo!','public-read-write' )
2 . Use Grantee instances (the permission is a String or an Array of: ‘READ’, ‘WRITE’, ‘READ_ACP’, ‘WRITE_ACP’, ‘FULL_CONTROL’):
bucket = s3.bucket('my_awesome_bucket', true) grantee1 = RightAws::S3::Grantee.new(bucket, 'a123b...223c', FULL_CONTROL, :apply) grantee2 = RightAws::S3::Grantee.new(bucket, 'xy3v3...5fhp', [READ, WRITE], :apply)
There is only one way to get and to remove permission (via Grantee instances):
grantees = bucket.grantees # a list of Grantees that have any access for this bucket grantee1 = RightAws::S3::Grantee.new(bucket, 'a123b...223c') grantee1.perms #=> returns a list of perms for this grantee to that bucket ... grantee1.drop # remove all perms for this grantee grantee2.revoke('WRITE') # revoke write access only
Retrieves a list of Grantees instances that have an access to this thing(bucket or key).
bucket = s3.bucket('my_awesome_bucket', true, 'public-read') ... RightAws::S3::Grantee.grantees(bucket) #=> grantees
Create a new Grantee instance. Grantee id must exist on S3. If action == :refresh, then retrieve permissions from S3 and update @perms. If action == :apply, then apply perms to thing at S3. If action == :apply_and_refresh then it performs. both the actions. This is used for the new grantees that had no perms to this thing before. The default action is :refresh.
bucket = s3.bucket('my_awesome_bucket', true, 'public-read') grantee1 = RightAws::S3::Grantee.new(bucket, 'a123b...223c', FULL_CONTROL) ... grantee2 = RightAws::S3::Grantee.new(bucket, 'abcde...asdf', [FULL_CONTROL, READ], :apply) grantee3 = RightAws::S3::Grantee.new(bucket, 'aaaaa...aaaa', 'READ', :apply_and_refresh)
Add permissions for grantee. Permissions: ‘READ’, ‘WRITE’, ‘READ_ACP’, ‘WRITE_ACP’, ‘FULL_CONTROL’. See docs.amazonwebservices.com/AmazonS3/2006-03-01/UsingPermissions.html . Returns true.
grantee.grant('FULL_CONTROL') #=> true grantee.grant('FULL_CONTROL','WRITE','READ') #=> true grantee.grant(['WRITE_ACP','READ','READ_ACP']) #=> true
Refresh grantee perms for its thing. Returns true if the grantee has perms for this thing or false otherwise, and updates @perms value as a side-effect.
grantee.grant('FULL_CONTROL') #=> true grantee.refresh #=> true grantee.drop #=> true grantee.refresh #=> false
Revoke permissions for grantee. Permissions: ‘READ’, ‘WRITE’, ‘READ_ACP’, ‘WRITE_ACP’, ‘FULL_CONTROL’ See docs.amazonwebservices.com/AmazonS3/2006-03-01/UsingPermissions.html . Default value is ‘FULL_CONTROL’. Returns true.
grantee.revoke('READ') #=> true grantee.revoke('FULL_CONTROL','WRITE') #=> true grantee.revoke(['READ_ACP','WRITE_ACP']) #=> true