kotovalexarian-likes-github/fog--fog
1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00
Code Releases Activity

[docs::aws::storage] requests changed Rdoc to YARD

Browse source
This commit is contained in:
Weston Platter 2013-01-13 19:32:23 -06:00
parent be96b502bb
commit f9f2ebc8f3
6 changed files with 35 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/fog/aws/requests/storage/put_bucket_lifecycle.rb
View file

@ -5,17 +5,16 @@ module Fog
# Change lifecycle configuration for an S3 bucket
#
# ==== Parameters
# * bucket_name<~String> - name of bucket to set lifecycle configuration for
# * lifecycle<~Hash>:
# * 'Rules'<~Array> - object expire rules
# * 'ID'<~String> - Unique identifier for the rule
# * 'Prefix'<~String> - Prefix identifying one or more objects to which the rule applies
# * 'Enabled'<~Boolean> - if rule is currently being applied
# * 'Days'<~Integer> - lifetime, in days, of the objects that are subject to the rule
# ==== See Also
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html
# @param bucket_name [String] name of bucket to set lifecycle configuration for
# * lifecycle [Hash]:
# * Rules [Array] object expire rules
# * ID [String] Unique identifier for the rule
# * Prefix [String] Prefix identifying one or more objects to which the rule applies
# * Enabled [Boolean] if rule is currently being applied
# * Days [Integer] lifetime, in days, of the objects that are subject to the rule
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html
#
def put_bucket_lifecycle(bucket_name, lifecycle)
builder = Nokogiri::XML::Builder.new do
LifecycleConfiguration {

28
lib/fog/aws/requests/storage/put_bucket_logging.rb
View file

@ -5,24 +5,22 @@ module Fog
# Change logging status for an S3 bucket
#
# ==== Parameters
# * bucket_name<~String> - name of bucket to modify
# * logging_status<~Hash>:
# * Owner<~Hash>:
# * ID<~String>: id of owner
# * DisplayName<~String>: display name of owner
# * AccessControlList<~Array>:
# * Grantee<~Hash>:
# * 'DisplayName'<~String> - Display name of grantee
# * 'ID'<~String> - Id of grantee
# @param bucket_name [String] name of bucket to modify
# @param logging_status [Hash]:
# * Owner [Hash]:
# * ID [String]: id of owner
# * DisplayName [String]: display name of owner
# * AccessControlList [Array]:
# * Grantee [Hash]:
# * DisplayName [String] Display name of grantee
# * ID [String] Id of grantee
# or
# * 'EmailAddress'<~String> - Email address of grantee
# * EmailAddress [String] Email address of grantee
# or
# * 'URI'<~String> - URI of group to grant access for
# * Permission<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
# * URI [String] URI of group to grant access for
# * Permission [String] Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
#
# ==== See Also
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html
def put_bucket_logging(bucket_name, logging_status)
if logging_status['LoggingEnabled'].empty?

8
lib/fog/aws/requests/storage/put_bucket_policy.rb
View file

@ -5,12 +5,10 @@ module Fog
# Change bucket policy for an S3 bucket
#
# ==== Parameters
# * bucket_name<~String> - name of bucket to modify
# * policy<~Hash> - policy document
# @param bucket_name [String] name of bucket to modify
# @param policy [Hash] policy document
#
# ==== See Also
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html
# @ee http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html
def put_bucket_policy(bucket_name, policy)
request({

8
lib/fog/aws/requests/storage/put_bucket_versioning.rb
View file

@ -5,12 +5,10 @@ module Fog
# Change versioning status for an S3 bucket
#
# ==== Parameters
# * bucket_name<~String> - name of bucket to modify
# * status<~String> - Status to change to in ['Enabled', 'Suspended']
# @param bucket_name [String] name of bucket to modify
# @param status [String] Status to change to in ['Enabled', 'Suspended']
#
# ==== See Also
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html
def put_bucket_versioning(bucket_name, status)
data =

12
lib/fog/aws/requests/storage/put_bucket_website.rb
View file

@ -5,14 +5,12 @@ module Fog
# Change website configuration for an S3 bucket
#
# ==== Parameters
# * bucket_name<~String> - name of bucket to modify
# * suffix<~String> - suffix to append to requests for the bucket
# * options<~Hash>
# * key<~String> - key to use for 4XX class errors
# @param bucket_name [String] name of bucket to modify
# @param suffix [String] suffix to append to requests for the bucket
# @param options [Hash]
# @option options key [String] key to use for 4XX class errors
#
# ==== See Also
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html
def put_bucket_website(bucket_name, suffix, options = {})
data =

2
lib/fog/aws/requests/storage/upload_part.rb
View file

@ -41,4 +41,4 @@ module Fog
end # Real
end # Storage
end # AWS
end # Fog
end # Fog