brightbox-cli 0.18.1 → 1.0.0.rc1

data/.gitignore

@@ -1,8 +1,14 @@
-Gemfile.lock
 local
 pkg/
+
+# Testing config fixtures
+spec/configs/*/cache/*
+
+# Old versions
+spec/fixtures/config_files/cache/*
 spec/brightbox/config
 spec/brightbox/cache/
+
 .bundle/
 .rbenv-version
 .rbx/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: ree
+

data/Gemfile

@@ -1,3 +1,5 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    brightbox-cli (1.0.0.rc1)
+      excon
+      fog (~> 1.15.0)
+      gli (~> 2.8)
+      highline (~> 1.6)
+      hirb (~> 0.6)
+      json
+      nokogiri (~> 1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    excon (0.25.3)
+    fog (1.15.0)
+      builder
+      excon (~> 0.25.0)
+      formatador (~> 0.2.0)
+      mime-types
+      multi_json (~> 1.0)
+      net-scp (~> 1.1)
+      net-ssh (>= 2.1.3)
+      nokogiri (~> 1.5)
+      ruby-hmac
+    formatador (0.2.4)
+    gli (2.8.0)
+    highline (1.6.19)
+    hirb (0.7.1)
+    json (1.8.0)
+    metaclass (0.0.1)
+    method_source (0.8.1)
+    mime-types (1.25)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.0)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.7.0)
+    nokogiri (1.5.10)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.2)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    ruby-hmac (0.4.0)
+    slop (3.4.5)
+    vcr (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  brightbox-cli!
+  mocha
+  pry
+  rake
+  rspec (~> 2.14)
+  vcr (~> 2.5)

data/README

@@ -1,47 +1,111 @@
 = Brightbox Cloud Command Line Interface
 
-brightbox-cli is a set of cli tools to interact with the Brightbox
-Cloud API.
+`brightbox-cli` is a set of cli tools to interact with the Brightbox Cloud API.
 
-http://brightbox.com
+You will need a user account on the Brightbox Cloud in order to make use of
+these tools.
 
-http://docs.brightbox.com/reference/cli
+You can sign up at https://manage.brightbox.com
 
-http://docs.brightbox.com/reference/api/
+{<img src="https://travis-ci.org/brightbox/brightbox-cli.png?branch=master" alt="Build Status" />}[https://travis-ci.org/brightbox/brightbox-cli]
 
-== Packaging
+== UPGRADE NOTES
 
-=== Vendoring libraries
+Version 1.0.0 adds a new top level `brightbox` command for the suite.
 
-gems can be vendored into `lib/brightbox-cli/vendor/` for packaging
-and will be prioritised over any gems.
+This may clash with our `brightbox` (brightbox-deployment) gem which, before
+version 2.4.0, used `brightbox` as the name for it's binary. Please ensure you
+update your `brightbox` gem to avoid using the wrong command.
 
-We've customized some gems and they're permanently vendored (i.e: in
-the git tree).
+We have included backwards compatible binaries for all the older CLI commands
+(brightbox-accounts, brightbox-servers etc...) but recommend getting used to the
+new form.
 
-=== Debian/Ubuntu packaging
+== Installation instructions
+
+Install from Rubygems
+
+    $ gem install brightbox-cli
+
+== Usage
+
+The Brightbox CLI is a suite of tools that are accessible through the
+`brightbox` command in a similar way to how you access `git` commands.
+
+For a list of available commands use:
+
+   $ brightbox help
+
+To add client (account based) credentials use:
+
+   $ brightbox config client_add cli-2igtb theclientsecret
+   Using config file /home/ubuntu/.brightbox/config
+   Creating new api client config cli-2igtb
+
+To browse available resources use the resource name as the command:
+
+   $ brightbox servers
+   ... List of servers
+   $ brightbox images
+   ... List of images
+
+Command structure may be subject to change.
+
+== Usage guides
+
+* http://docs.brightbox.com/reference/cli
+* http://brightbox.com
+* http://docs.brightbox.com/reference/api/
 
-Any gems that have equivalent packages available are set as
-dependencies to the Debian package.  Any other gems are vendored prior
-to packaging.  These are:
+== BASH Auto-completion
 
-* formatador (required by hirb)
-* excon (required by fog)
-* gli
-* fog
-* hirb
-* ini
-* multi_json
+A bash shell auto-completion script is provided to allow
+autocompletion of all sub-commands, options and resource
+identifiers. It is automatically configured by the Debian/Ubuntu
+packages, but if you're installing from a gem you can manually tell
+bash about it like this:
 
-Rubygems support can be disabled by defining the `DISABLE_RUBYGEMS`
-constant in `lib/bbcloud/os_config.rb`
+    complete -C _brightbox-bash-completer -o filenames brightbox
+
+The command `_brightbox-bash-completer` should be installed in the
+system path when you install the gem. If for whatever reason it is not
+in the path, just specify the full path to it:
+
+    complete -C /full/path/to/bin/_brightbox-bash-completer -o filenames brightbox
+
+== Testing
+
+You should be able to run the specs and features with the following steps:
+
+    $ bundle install
+    $ bundle exec rake
+
+The specs use VCR to playback filtered recordings from real API sessions. This
+process is not perfect, please report an issue
+
+== Alternatives
+
+There are a number of alternative ways to interact with the Brightbox Cloud.
+
+* The Web GUI - https://manage.brightbox.com/
+* fog - https://github.com/fog/fog
+* knife plugin - https://github.com/rubiojr/knife-brightbox
+* Vagrant plugin - https://github.com/NeilW/vagrant-brightbox
+
+== Packaging
+
+=== Vendoring libraries
+
+gems can be vendored into `lib/brightbox-cli/vendor/` for packaging and will be
+prioritised over any gems.
+
+=== Debian/Ubuntu packaging
 
-Ubuntu packaging scripts are available on the packaging-lucid git
-branch.
+Packaging scripts are available in https://github.com/NeilW/brightbox-cli-debian-packaging
 
 == License
 
-Copyright (c) 2010,2011,2012 John Leach, Brightbox Systems Ltd <john@brightbox.co.uk>
+Copyright (c) 2010-2013 John Leach, Brightbox Systems Ltd <john@brightbox.co.uk>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -1,47 +1,111 @@
 = Brightbox Cloud Command Line Interface
 
-brightbox-cli is a set of cli tools to interact with the Brightbox
-Cloud API.
+`brightbox-cli` is a set of cli tools to interact with the Brightbox Cloud API.
 
-http://brightbox.com
+You will need a user account on the Brightbox Cloud in order to make use of
+these tools.
 
-http://docs.brightbox.com/reference/cli
+You can sign up at https://manage.brightbox.com
 
-http://docs.brightbox.com/reference/api/
+{<img src="https://travis-ci.org/brightbox/brightbox-cli.png?branch=master" alt="Build Status" />}[https://travis-ci.org/brightbox/brightbox-cli]
 
-== Packaging
+== UPGRADE NOTES
 
-=== Vendoring libraries
+Version 1.0.0 adds a new top level `brightbox` command for the suite.
 
-gems can be vendored into `lib/brightbox-cli/vendor/` for packaging
-and will be prioritised over any gems.
+This may clash with our `brightbox` (brightbox-deployment) gem which, before
+version 2.4.0, used `brightbox` as the name for it's binary. Please ensure you
+update your `brightbox` gem to avoid using the wrong command.
 
-We've customized some gems and they're permanently vendored (i.e: in
-the git tree).
+We have included backwards compatible binaries for all the older CLI commands
+(brightbox-accounts, brightbox-servers etc...) but recommend getting used to the
+new form.
 
-=== Debian/Ubuntu packaging
+== Installation instructions
+
+Install from Rubygems
+
+    $ gem install brightbox-cli
+
+== Usage
+
+The Brightbox CLI is a suite of tools that are accessible through the
+`brightbox` command in a similar way to how you access `git` commands.
+
+For a list of available commands use:
+
+   $ brightbox help
+
+To add client (account based) credentials use:
+
+   $ brightbox config client_add cli-2igtb theclientsecret
+   Using config file /home/ubuntu/.brightbox/config
+   Creating new api client config cli-2igtb
+
+To browse available resources use the resource name as the command:
+
+   $ brightbox servers
+   ... List of servers
+   $ brightbox images
+   ... List of images
+
+Command structure may be subject to change.
+
+== Usage guides
+
+* http://docs.brightbox.com/reference/cli
+* http://brightbox.com
+* http://docs.brightbox.com/reference/api/
 
-Any gems that have equivalent packages available are set as
-dependencies to the Debian package.  Any other gems are vendored prior
-to packaging.  These are:
+== BASH Auto-completion
 
-* formatador (required by hirb)
-* excon (required by fog)
-* gli
-* fog
-* hirb
-* ini
-* multi_json
+A bash shell auto-completion script is provided to allow
+autocompletion of all sub-commands, options and resource
+identifiers. It is automatically configured by the Debian/Ubuntu
+packages, but if you're installing from a gem you can manually tell
+bash about it like this:
 
-Rubygems support can be disabled by defining the `DISABLE_RUBYGEMS`
-constant in `lib/bbcloud/os_config.rb`
+    complete -C _brightbox-bash-completer -o filenames brightbox
+
+The command `_brightbox-bash-completer` should be installed in the
+system path when you install the gem. If for whatever reason it is not
+in the path, just specify the full path to it:
+
+    complete -C /full/path/to/bin/_brightbox-bash-completer -o filenames brightbox
+
+== Testing
+
+You should be able to run the specs and features with the following steps:
+
+    $ bundle install
+    $ bundle exec rake
+
+The specs use VCR to playback filtered recordings from real API sessions. This
+process is not perfect, please report an issue
+
+== Alternatives
+
+There are a number of alternative ways to interact with the Brightbox Cloud.
+
+* The Web GUI - https://manage.brightbox.com/
+* fog - https://github.com/fog/fog
+* knife plugin - https://github.com/rubiojr/knife-brightbox
+* Vagrant plugin - https://github.com/NeilW/vagrant-brightbox
+
+== Packaging
+
+=== Vendoring libraries
+
+gems can be vendored into `lib/brightbox-cli/vendor/` for packaging and will be
+prioritised over any gems.
+
+=== Debian/Ubuntu packaging
 
-Ubuntu packaging scripts are available on the packaging-lucid git
-branch.
+Packaging scripts are available in https://github.com/NeilW/brightbox-cli-debian-packaging
 
 == License
 
-Copyright (c) 2010,2011,2012 John Leach, Brightbox Systems Ltd <john@brightbox.co.uk>
+Copyright (c) 2010-2013 John Leach, Brightbox Systems Ltd <john@brightbox.co.uk>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,14 +1,22 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require "bundler"
+require "rspec/core/rake_task"
+require "brightbox-cli/command_generator"
 
-bbcloud_path = File.expand_path('./lib', File.dirname(__FILE__))
+bbcloud_path = File.expand_path("./lib", File.dirname(__FILE__))
 $:.unshift(bbcloud_path)
-require "brightbox-cli/command_generator"
+
+task :default => [:test]
+
+Bundler::GemHelper.install_tasks
 
 desc "generate brightbox-commands"
 task :generate_commands do
   Brightbox::CommandGenerator.new(bbcloud_path)
 end
 
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
+
+desc "Runs all tests (rspec and cucumber)"
+task :test do
+  Rake::Task["spec"].invoke
+end