Class: VagrantCloud::Box

Class

VagrantCloud::Box

In:

lib/vagrant_cloud/box.rb

Parent:

Object

Methods

create create_version data delete description description_short ensure_version get_version new param_name private read update versions

Constants

ATTR_MAP = { is_private: 'private', description: 'description_markdown' Vagrant Cloud returns keys different from what you set for some params. Values in this map should be strings.

Attributes

account	[RW]
name	[RW]

Public Class methods

new(account, name = nil, data = nil, short_description = nil, description = nil, access_token = nil, custom_server = nil)

@param [String] account @param [String] name @param [Hash] data @param [String] description @param [String] short_description @param [String] access_token

Public Instance methods

create(short_description = nil, description = nil, org = nil, box_name = nil, is_private = false)

@param [String] short_description @param [String] description @param [Bool] is_private @return [Hash]

create_version(name, description = nil)

@param [String] name @param [String] description @return [Version]

Read this box @return [Hash]

delete(org = nil, box_name = nil)

A generic function to read any box on Vagrant Cloud If org and box name is not supplied, it will default to reading the given Box object

@param [String] org - organization of the box to read @param [String] box_name - name of the box to read @return [Hash]

@return [String]

description_short()

@return [String]

ensure_version(name, description = nil)

@param [String] name @param [String] description @return [Version]

get_version(number, data = nil)

@param [Integer] number @param [Hash] data @return [Version]

param_name(param)

@param [Symbol] @return [String]

@return [TrueClass, FalseClass]

read(org = nil, box_name = nil)

A generic function to read any box on Vagrant Cloud

@param [String] org - organization of the box to read @param [String] box_name - name of the box to read @return [Hash]

update(args = {})

Update a box

@param [Hash] args @param [String] org - organization of the box to read @param [String] box_name - name of the box to read @return [Hash] @data

@return [Array<Version>]