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

[rackspace] fixing yard warnings

Browse source
This commit is contained in:
Kyle Rames 2013-03-11 10:05:23 -05:00
parent 242bde2503
commit 588bf4a3d2
6 changed files with 13 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/fog/rackspace/models/storage/account.rb
View file

@ -6,8 +6,8 @@ module Fog
class Account < Fog::Model
# @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/View_Account_Info-d1e11995.html
# @!attribute [rw] meta_temp_url_key is used to generate temporary access to files
# @return [String] The temporary URL key
# @!attribute [rw] meta_temp_url_key
# @return [String] The temporary URL key used to generate temporary access to files
# @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/Create_TempURL-d1a444.html
attribute :meta_temp_url_key, :aliases => 'X-Account-Meta-Temp-Url-Key'

6
lib/fog/rackspace/models/storage/directories.rb
View file

@ -22,9 +22,11 @@ module Fog
# @param [String] key of directory
# @param options [Hash]:
# @option options [String] cdn_cname CDN CNAME used when calling Directory#public_url
# @return [Fog::Storage::Rackspace:Directory]
# @return [Fog::Storage::Rackspace::Directory]
# @example
# fog.directories.get('video', :cdn_cname => 'http://cdn.lunenburg.org').files.first.public_url
# directory = fog.directories.get('video', :cdn_cname => 'http://cdn.lunenburg.org')
# files = directory.files
# files.first.public_url
#
# @see Directory#public_url
# @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/View-Container_Info-d1e1285.html

2
lib/fog/rackspace/models/storage/directory.rb
View file

@ -99,7 +99,7 @@ module Fog
end
# Returns the public url for the directory.
# If the directory has not been published to the CDN, this method will return nil as it is not publically accessable. This method will return the approprate
# If the directory has not been published to the CDN, this method will return nil as it is not publically accessible. This method will return the approprate
# url in the following order:
#
# 1. If the service used to access this directory was created with the option :rackspace_cdn_ssl => true, this method will return the SSL-secured URL.

6
lib/fog/rackspace/models/storage/file.rb
View file

@ -52,6 +52,7 @@ module Fog
# @example Retrieve and download contents of Cloud Files object to file system
# file_object = directory.files.get('germany.jpg')
# File.open('germany.jpg', 'w') {|f| f.write(file_object.body) }
# @see Fog::Storage::Rackspace:Files#get
def body
attributes[:body] ||= if last_modified
collection.get(identity).body
@ -83,7 +84,6 @@ module Fog
# Destroy the file
# @return [Boolean] returns true if file is destroyed
# @note Directory must be empty before destroying directory
# @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/Delete_Object-d1e2264.html
def destroy
requires :directory, :key
@ -125,7 +125,7 @@ module Fog
end
# Returns the public url for the file.
# If the file has not been published to the CDN, this method will return nil as it is not publically accessable. This method will return the approprate
# If the file has not been published to the CDN, this method will return nil as it is not publically accessible. This method will return the approprate
# url in the following order:
#
# 1. If the service used to access this file was created with the option :rackspace_cdn_ssl => true, this method will return the SSL-secured URL.
@ -145,7 +145,7 @@ module Fog
end
# URL used to stream resources
# return [String] streaming url
# @return [String] streaming url
# @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/Streaming-CDN-Enabled_Containers-d1f3721.html
def streaming_url
Files::file_url directory.streaming_url, key

4
lib/fog/rackspace/models/storage/files.rb
View file

@ -84,7 +84,7 @@ module Fog
# @yieldparam [Integer] remaining
# @yieldparam [Integer] content_length
# @return [Fog::Storage::Rackspace:File]
# @note If a block is provided, the body attribute will be empty. By default Chunk size is 1 MB. This value can be changed by passing the parameter :chunk_size
# @note If a block is provided, the body attribute will be empty. By default chunk size is 1 MB. This value can be changed by passing the parameter :chunk_size
# into the :connection_options hash in the service constructor.
# @example Download an image from Cloud Files and save it to file
#
@ -122,7 +122,7 @@ module Fog
end
# View directory detail without loading file contents
# @param key - key of the object
# @param key of the object
# @param options Required for compatibility with other Fog providers. Not Used.
# @return [Fog::Storage::Rackspace::File]
def head(key, options = {})

2
lib/fog/rackspace/requests/compute_v2/create_server.rb
View file

@ -4,7 +4,7 @@ module Fog
class Real
# Create server
# @param [String] name name of server
# @param [String] image_id id of the image used to create server
# @param [String] image_id of the image used to create server
# @param [String] flavor_id id of the flavor of the image
# @param [String] min_count
# @param [String] max_count