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] WIP on get requests

Browse source
This commit is contained in:
Weston Platter 2013-01-02 19:55:08 -06:00
parent 47df9f1b69
commit f02ebbd890
5 changed files with 63 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
lib/fog/aws/requests/storage/get_bucket.rb
View file

@ -7,38 +7,35 @@ module Fog
# List information about objects in an S3 bucket # List information about objects in an S3 bucket
# #
# ==== Parameters # @param bucket_name [String] name of bucket to list object keys from
# * bucket_name<~String> - name of bucket to list object keys from # @param options [Hash] config arguments for list. Defaults to {}.
# * options<~Hash> - config arguments for list. Defaults to {}. # @option options delimiter [String] causes keys with the same string between the prefix
# * 'delimiter'<~String> - causes keys with the same string between the prefix
# value and the first occurence of delimiter to be rolled up # value and the first occurence of delimiter to be rolled up
# * 'marker'<~String> - limits object keys to only those that appear # @option options marker [String] limits object keys to only those that appear
# lexicographically after its value. # lexicographically after its value.
# * 'max-keys'<~Integer> - limits number of object keys returned # @option options max-keys [Integer] limits number of object keys returned
# * 'prefix'<~String> - limits object keys to those beginning with its value. # @option options prefix [String] limits object keys to those beginning with its value.
# #
# ==== Returns # @return [Excon::Response] response:
# * response<~Excon::Response>: # * body [Hash]:
# * body<~Hash>: # * Delimeter [String] - Delimiter specified for query
# * 'Delimeter'<~String> - Delimiter specified for query # * IsTruncated [Boolean] - Whether or not the listing is truncated
# * 'IsTruncated'<~Boolean> - Whether or not the listing is truncated # * Marker [String]- Marker specified for query
# * 'Marker'<~String> - Marker specified for query # * MaxKeys [Integer] - Maximum number of keys specified for query
# * 'MaxKeys'<~Integer> - Maximum number of keys specified for query # * Name [String] - Name of the bucket
# * 'Name'<~String> - Name of the bucket # * Prefix [String] - Prefix specified for query
# * 'Prefix'<~String> - Prefix specified for query # * CommonPrefixes [Array] - Array of strings for common prefixes
# * 'CommonPrefixes'<~Array> - Array of strings for common prefixes # * Contents [Array]:
# * 'Contents'<~Array>: # * ETag [String] - Etag of object
# * 'ETag'<~String>: Etag of object # * Key [String] - Name of object
# * 'Key'<~String>: Name of object # * LastModified [String] - Timestamp of last modification of object
# * 'LastModified'<~String>: Timestamp of last modification of object # * Owner [Hash]:
# * 'Owner'<~Hash>: # * DisplayName [String] - Display name of object owner
# * 'DisplayName'<~String> - Display name of object owner # * ID [String] - Id of object owner
# * 'ID'<~String> - Id of object owner # * Size [Integer] - Size of object
# * 'Size'<~Integer> - Size of object # * StorageClass [String] - Storage class of object
# * 'StorageClass'<~String> - Storage class of object
# #
# ==== See Also # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html
def get_bucket(bucket_name, options = {}) def get_bucket(bucket_name, options = {})
unless bucket_name unless bucket_name

33
lib/fog/aws/requests/storage/get_bucket_acl.rb
View file

@ -7,27 +7,24 @@ module Fog
# Get access control list for an S3 bucket # Get access control list for an S3 bucket
# #
# ==== Parameters # @param bucket_name [String] name of bucket to get access control list for
# * bucket_name<~String> - name of bucket to get access control list for
# #
# ==== Returns # @return [Excon::Response] response:
# * response<~Excon::Response>: # * body [Hash]:
# * body<~Hash>: # * AccessControlPolicy [Hash]:
# * 'AccessControlPolicy'<~Hash> # * Owner [Hash]:
# * 'Owner'<~Hash>: # * DisplayName [String] - Display name of object owner
# * 'DisplayName'<~String> - Display name of object owner # * ID [String] - Id of object owner
# * 'ID'<~String> - Id of object owner # * AccessControlList [Array]:
# * 'AccessControlList'<~Array>: # * Grant [Hash]:
# * 'Grant'<~Hash>: # * Grantee [Hash]:
# * 'Grantee'<~Hash>: # * DisplayName [String] - Display name of grantee
# * 'DisplayName'<~String> - Display name of grantee # * ID [String] - Id of grantee
# * 'ID'<~String> - Id of grantee
# or # or
# * 'URI'<~String> - URI of group to grant access for # * URI [String] - URI of group to grant access for
# * 'Permission'<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP] # * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
# #
# ==== See Also # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html
def get_bucket_acl(bucket_name) def get_bucket_acl(bucket_name)
unless bucket_name unless bucket_name

27
lib/fog/aws/requests/storage/get_bucket_cors.rb
View file

@ -7,23 +7,20 @@ module Fog
# Gets the CORS configuration for an S3 bucket # Gets the CORS configuration for an S3 bucket
# #
# ==== Parameters # @param bucket_name [String] name of bucket to get access control list for
# * bucket_name<~String> - name of bucket to get access control list for
# #
# ==== Returns # @return [Excon::Response] response:
# * response<~Excon::Response>: # * body [Hash]:
# * body<~Hash>: # * CORSConfiguration [Array]:
# * 'CORSConfiguration'<~Array>: # * CORSRule [Hash]:
# * 'CORSRule'<~Hash>: # * AllowedHeader [String] - Which headers are allowed in a pre-flight OPTIONS request through the Access-Control-Request-Headers header.
# * 'AllowedHeader'<~String> - Which headers are allowed in a pre-flight OPTIONS request through the Access-Control-Request-Headers header. # * AllowedMethod [String] - Identifies an HTTP method that the domain/origin specified in the rule is allowed to execute.
# * 'AllowedMethod'<~String> - Identifies an HTTP method that the domain/origin specified in the rule is allowed to execute. # * AllowedOrigin [String] - One or more response headers that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
# * 'AllowedOrigin'<~String> - One or more response headers that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object). # * ExposeHeader [String] - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
# * 'ExposeHeader'<~String> - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object). # * ID [String] - An optional unique identifier for the rule. The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration.
# * 'ID'<~String> - An optional unique identifier for the rule. The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. # * MaxAgeSeconds [Integer] - The time in seconds that your browser is to cache the preflight response for the specified resource.
# * 'MaxAgeSeconds'<~Integer> - The time in seconds that your browser is to cache the preflight response for the specified resource.
# #
# ==== See Also # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html
def get_bucket_cors(bucket_name) def get_bucket_cors(bucket_name)
unless bucket_name unless bucket_name

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

@ -7,20 +7,17 @@ module Fog
# Get bucket lifecycle configuration # Get bucket lifecycle configuration
# #
# ==== Parameters # @param bucket_name [String] name of bucket to get lifecycle configuration for
# * bucket_name<~String> - name of bucket to get lifecycle configuration for
# #
# ==== Returns # @return [Excon::Response] response:
# * response<~Excon::Response>: # * body [Hash]:
# * body<~Hash>: # * Rules - object expire rules [Array]:
# * 'Rules'<~Array> - object expire rules # * ID [String] - Unique identifier for the rule
# * 'ID'<~String> - Unique identifier for the rule # * Prefix [String] - Prefix identifying one or more objects to which the rule applies
# * 'Prefix'<~String> - Prefix identifying one or more objects to which the rule applies # * Enabled [Boolean] - if rule is currently being applied
# * 'Enabled'<~Boolean> - if rule is currently being applied # * Days [Integer] - lifetime, in days, of the objects that are subject to the rule
# * 'Days'<~Integer> - lifetime, in days, of the objects that are subject to the rule
# #
# ==== See Also # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html
# http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html
def get_bucket_lifecycle(bucket_name) def get_bucket_lifecycle(bucket_name)
request({ request({

6
lib/fog/aws/requests/storage/get_bucket_location.rb
View file

@ -7,11 +7,9 @@ module Fog
# Get location constraint for an S3 bucket # Get location constraint for an S3 bucket
# #
# ==== Parameters # @param bucket_name [String] - name of bucket to get location constraint for
# * bucket_name<~String> - name of bucket to get location constraint for
# #
# ==== Returns # @return response [Excon::Response]:
# * response<~Excon::Response>:
# * body<~Hash>: # * body<~Hash>:
# * 'LocationConstraint'<~String> - Location constraint of the bucket # * 'LocationConstraint'<~String> - Location constraint of the bucket
# #