Sha256: 84aa35191977715ac929ad831c8d25a9e590af8ec974e2b6bfb1c8f0a50988a7

Contents?: true

Size: 1.96 KB

Versions: 2

Compression:

Stored size: 1.96 KB

Contents

vagrant_cloud
=============
Minimalistic ruby client for the [HashiCorp Atlas API](https://vagrantcloud.com/docs) (previously *Vagrant Cloud API*).

[![Build Status](https://img.shields.io/travis/cargomedia/vagrant_cloud/master.svg)](https://travis-ci.org/cargomedia/vagrant_cloud)
[![Gem Version](https://img.shields.io/gem/v/vagrant_cloud.svg)](https://rubygems.org/gems/vagrant_cloud)


This client allows to create, modify and delete *boxes*, *versions* and *providers*.
The main entry point is an object referencing your *account*.

Usage
-----
Example usage:
```ruby
account = VagrantCloud::Account.new('<username>', '<access_token>')
box = account.ensure_box('my_box')
version = box.ensure_version('0.0.1')
provider = version.ensure_provider('virtualbox', 'http://example.com/foo.box')

version.release
puts provider.download_url
```

Example CLI usage:
Create a version and provider within an existing Box, upload a file to be hosted by Vagrant/Atlas, and release the version
```sh
vagrant_cloud create_version --username $USERNAME --token $VAGRANT_CLOUD_TOKEN --box $BOX_NAME --version $BOX_VERSION
vagrant_cloud create_provider --username $USERNAME --token $VAGRANT_CLOUD_TOKEN --box $BOX_NAME --version $BOX_VERSION
vagrant_cloud upload_file --username $USERNAME --token $VAGRANT_CLOUD_TOKEN --box $BOX_NAME --version $BOX_VERSION --provider_file_path $PACKAGE_PATH
vagrant_cloud release_version --username $USERNAME --token $VAGRANT_CLOUD_TOKEN --box $BOX_NAME --version $BOX_VERSION
```
If you installed vagrant_cloud with bundler, then you may have to invoke using `bundle exec vagrant_cloud`

Development & Contributing
--------------------------
Pull requests are very welcome!

Install dependencies:
```
bundle install
```

Run the tests:
```
bundle exec rspec
```

Check the code syntax:
```
bundle exec rubocop
```

Release a new version:

1. Bump the version in `vagrant_cloud.gemspec`, merge to master.
2. Push a new tag to master.
3. Release to RubyGems with `bundle exec rake release`.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
vagrant_cloud-1.1.0 README.md
vagrant_cloud-1.0.0 README.md