brightbox-cli 0.16.0 → 0.17.0

data/README

@@ -3,26 +3,21 @@
 brightbox-cli is a set of cli tools to interact with the Brightbox
 Cloud API.
 
-http://beta.brightbox.com
+http://brightbox.com
 
-http://docs.brightbox.com/cli
+http://docs.brightbox.com/reference/cli
 
-== Dependencies
-
-It has following dependencies and if you are trying to install the gem from 
-a gem file (rather than via gem command), you might have to install the 
-following:
-
-* fog - 0.8.2
-* json - 1.5.3
-* hirb - 0.3.5
+http://docs.brightbox.com/reference/api/
 
 == Packaging
 
 === Vendoring libraries
 
-gems can be vendored into vendor/ for packaging and will be
-prioritized over any gems.
+gems can be vendored into `lib/brightbox-cli/vendor/` for packaging
+and will be prioritised over any gems.
+
+We've customized some gems and they're permanently vendored (i.e: in
+the git tree).
 
 === Debian/Ubuntu packaging
 
@@ -36,16 +31,17 @@ to packaging.  These are:
 * fog
 * hirb
 * ini
+* multi_json
 
-Rubygems support can be disabled by defining the DISABLE_RUBYGEMS
-constant in lib/bbcloud/os_config.rb
+Rubygems support can be disabled by defining the `DISABLE_RUBYGEMS`
+constant in `lib/bbcloud/os_config.rb`
 
 Ubuntu packaging scripts are available on the packaging-lucid git
 branch.
 
 == License
 
-Copyright (c) 2010,2011 John Leach, Brightbox Systems Ltd <john@brightbox.co.uk>
+Copyright (c) 2010,2011,2012 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
@@ -63,4 +59,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/README.rdoc

@@ -3,26 +3,21 @@
 brightbox-cli is a set of cli tools to interact with the Brightbox
 Cloud API.
 
-http://beta.brightbox.com
+http://brightbox.com
 
-http://docs.brightbox.com/cli
+http://docs.brightbox.com/reference/cli
 
-== Dependencies
-
-It has following dependencies and if you are trying to install the gem from 
-a gem file (rather than via gem command), you might have to install the 
-following:
-
-* fog - 0.8.2
-* json - 1.5.3
-* hirb - 0.3.5
+http://docs.brightbox.com/reference/api/
 
 == Packaging
 
 === Vendoring libraries
 
-gems can be vendored into vendor/ for packaging and will be
-prioritized over any gems.
+gems can be vendored into `lib/brightbox-cli/vendor/` for packaging
+and will be prioritised over any gems.
+
+We've customized some gems and they're permanently vendored (i.e: in
+the git tree).
 
 === Debian/Ubuntu packaging
 
@@ -36,16 +31,17 @@ to packaging.  These are:
 * fog
 * hirb
 * ini
+* multi_json
 
-Rubygems support can be disabled by defining the DISABLE_RUBYGEMS
-constant in lib/bbcloud/os_config.rb
+Rubygems support can be disabled by defining the `DISABLE_RUBYGEMS`
+constant in `lib/bbcloud/os_config.rb`
 
 Ubuntu packaging scripts are available on the packaging-lucid git
 branch.
 
 == License
 
-Copyright (c) 2010,2011 John Leach, Brightbox Systems Ltd <john@brightbox.co.uk>
+Copyright (c) 2010,2011,2012 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
@@ -63,4 +59,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/brightbox-cli.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'excon', '~> 0.6.1'
   s.add_dependency 'builder'
   s.add_dependency 'mime-types'
-  s.add_dependency 'net-scp', '~> 1.0.4'
   s.add_dependency 'net-ssh', '~> 2.2.1'
+  s.add_dependency 'net-scp', '~> 1.0.4'
   s.add_dependency 'nokogiri', '~> 1.5.0'
   s.add_dependency 'ruby-hmac'
   s.add_development_dependency('rake', '~> 0.8.0')

data/lib/brightbox-cli/accounts.rb

@@ -23,6 +23,13 @@ module Brightbox
       [a]
     end
 
+    # The account associated with this connection
+    def self.conn_account
+      a = conn.account
+      a.connection = conn
+      a
+    end
+
     def self.get(id)
       a = conn.account
       a.connection = conn

data/lib/brightbox-cli/api.rb

@@ -1,4 +1,7 @@
 module Brightbox
+  # The length of the identifier string.
+  IDENTIFIER_SIZE = 9
+
   class Api
     attr_reader :id
     class ApiError < StandardError ; end

data/lib/brightbox-cli/commands/config-client-list.rb

@@ -19,7 +19,7 @@ module Brightbox
         }
       end
 
-      render_table clients, :fields => [:alias, :client_id, :secret, :api_url, :auth_url]
+      render_table clients, global_options.merge(:fields => [:alias, :client_id, :secret, :api_url, :auth_url])
     end
   end
 

data/lib/brightbox-cli/commands/firewall-rules-create.rb

@@ -21,6 +21,9 @@ module Brightbox
     c.desc "Icmp Type name"
     c.flag [:i, :icmptype]
 
+    c.desc "Description"
+    c.flag :description
+
     c.action do |global_options, options, args|
       if args && args.empty?
         raise "You must specify the firewall_policy_id as the first argument"
@@ -42,6 +45,7 @@ module Brightbox
       create_options[:destination_port] = options[:e] if options[:e]
       create_options[:icmp_type_name] = options[:i] if options[:i]
       create_options[:protocol] = options[:p]
+      create_options[:description] = options[:description] if options[:description]
 
       create_options[:firewall_policy_id] = firewall_policy.id
       firewall_rule = FirewallRule.create(create_options)

data/lib/brightbox-cli/commands/firewall-rules-update.rb

@@ -0,0 +1,49 @@
+module Brightbox
+  desc 'Update Firewall Rule'
+  arg_name '[firewall-policy-id...]'
+
+  command [:update] do |c|
+    c.desc "Protocol - [tcp/udp/icmp/Protocol numbers]"
+    c.flag [:p, :protocol]
+
+    c.desc "Source - IPv4/IPv6 address or range (CIDR notation), 'any' for combined IPv4/IPv6 wildcard, server group identifer, server identifier."
+    c.flag [:s, :source]
+
+    c.desc "Source Port"
+    c.flag [:t, :sport]
+
+    c.desc "Destination. IPv4/IPv6 address or range (CIDR notation), 'any' for combined IPv4/IPv6 wildcard, server group identifer, server identifier."
+    c.flag [:d, :destination]
+
+    c.desc "Destination Port"
+    c.flag [:e, :dport]
+
+    c.desc "Icmp Type name"
+    c.flag [:i, :icmptype]
+
+    c.desc "Description"
+    c.flag :description
+
+    c.action do |global_options, options, args|
+      fwr_id = args.shift
+      raise "You must specify a valid firewall rule id as the first argument" unless fwr_id =~ /^fwr-/
+      firewall_rule = FirewallRule.find fwr_id
+      raise "Could not find firewall rule with #{firewall_rule_id}" unless firewall_rule
+
+      params = NilableHash.new
+      params[:source_port]      = options[:t] if options[:t]
+      params[:source]           = options[:s] if options[:s]
+      params[:destination]      = options[:d] if options[:d]
+      params[:destination_port] = options[:e] if options[:e]
+      params[:icmp_type_name]   = options[:i] if options[:i]
+      params[:protocol]         = options[:p] if options[:p]
+      params[:description]      = options[:description] if options[:description]
+      params.nilify_blanks
+
+      info "Updating firewall rule #{firewall_rule}"
+      firewall_rule.update(params)
+
+      render_table([firewall_rule], global_options)
+    end
+  end
+end

data/lib/brightbox-cli/commands/groups-show.rb

@@ -8,7 +8,7 @@ module Brightbox
       sgs = DetailedServerGroup.find_or_call(args) do |id|
         raise "Couldn't find server group #{id}"
       end
-      render_table(sgs, :vertical => true)
+      render_table(sgs, global_options.merge(:vertical => true))
     end
   end
 end

data/lib/brightbox-cli/commands/groups-update.rb

@@ -14,7 +14,7 @@ module Brightbox
       grp_id = args.shift
       raise "You must specify the server group to update as the first argument" unless grp_id =~ /^grp-/
 
-      params = {}
+      params = NilableHash.new
 
       # unless args.empty?
       #   params[:servers] = args.collect { |a| { :server => a } }
@@ -28,6 +28,8 @@ module Brightbox
         params[:description] = options[:d]
       end
 
+      params.nilify_blanks
+
       sg = ServerGroup.find grp_id
       info "Updating server group #{sg}"
       sg = sg.update(params)

data/lib/brightbox-cli/commands/images-destroy.rb

@@ -19,7 +19,7 @@ module Brightbox
         i.reload
       end
 
-      render_table(images)
+      render_table(images, global_options)
 
     end
   end

data/lib/brightbox-cli/commands/images-list.rb

@@ -2,8 +2,11 @@ module Brightbox
   desc 'List available images'
   arg_name '[image-id...]'
   command [:list] do |c|
-    c.action do |global_options, options, args|
+    c.desc "Show all public images from all accounts"
+    c.switch [:a, "show-all"]
 
+    c.action do |global_options, options, args|
+      
       if args.empty?
         images = Image.find(:all)
       else
@@ -16,10 +19,13 @@ module Brightbox
 
       images = images - snapshots
 
-      images.sort! do |a,b|
-        [a.official ? 0 : 1, a.name, a.arch] <=> [b.official ? 0 : 1, b.name, b.arch]
+      unless options[:a]
+        account = Account.conn_account
+        images.reject! { |i| !i.official and i.owner_id != account.id  }
       end
 
+      images.sort! { |a, b| a.default_sort_fields <=> b.default_sort_fields }
+
       snapshots.sort! { |a, b| a.created_at <=> b.created_at }
 
       render_table(images + snapshots, global_options)

data/lib/brightbox-cli/commands/images-register.rb

@@ -53,7 +53,7 @@ module Brightbox
 
       image = Image.register(image_options)
 
-      render_table([image])
+      render_table([image], global_options)
 
     end
   end

data/lib/brightbox-cli/commands/images-update.rb

@@ -34,7 +34,7 @@ module Brightbox
         raise "Public must be true or false" unless options[:p] == "true" || options[:p] == "false"
       end
 
-      params = {}
+      params = NilableHash.new
       params[:name]               = options[:n] if options[:n]
       params[:arch]               = options[:a] if options[:a]
       params[:source]             = options[:s] if options[:s]
@@ -51,6 +51,8 @@ module Brightbox
       params[:status] = "deprecated" if options[:deprecated] == "true"
       params[:status] = "available" if options[:deprecated] == "false"
 
+      params.nilify_blanks
+
       image = Image.find img_id
 
       info "Updating image #{image}"

data/lib/brightbox-cli/commands/lbs-update.rb

@@ -40,7 +40,7 @@ module Brightbox
       lb_id = args.shift
       raise "You must specify the load balancer to update as the first argument" unless lb_id =~ /^lba-/
 
-      lbopts = {}
+      lbopts = NilableHash.new
 
       unless args.empty?
         lbopts[:nodes] = args.collect { |a| { :node => a } }
@@ -75,7 +75,9 @@ module Brightbox
 
       if options[:p]
         lbopts[:policy] = options[:p]
-      end 
+      end
+
+      lbopts.nilify_blanks
 
       lb = LoadBalancer.find lb_id
 

data/lib/brightbox-cli/commands/{servers-activate-cloud.rb → servers-activate-console.rb}

@@ -16,7 +16,8 @@ module Brightbox
       servers.each do |s|
         info "Activating console for server #{s}"
         r = s.activate_console
-        consoles << { :url => r["console_url"], :token => r["console_token"], :expires => r["console_token_expires"] }
+        url = "#{r["console_url"]}/?password=#{r["console_token"]}"
+        consoles << { :url => url, :token => r["console_token"], :expires => r["console_token_expires"] }
       end
 
       render_table(consoles, global_options.merge(:fields => [:url, :token, :expires]))

data/lib/brightbox-cli/commands/servers-update.rb

@@ -46,9 +46,10 @@ module Brightbox
         raise "User data too big (>16k)" if user_data.size > 16 * 1024
       end
 
-      params = {}
+      params = NilableHash.new
       params[:name] = options[:n] if options[:n]
       params[:user_data] = user_data if user_data
+      params.nilify_blanks
 
       info "Updating server #{server}#{" with %.2fk of user data" % (user_data.size / 1024.0) if user_data}"
       server.update params

data/lib/brightbox-cli/config.rb

@@ -104,6 +104,10 @@ module Brightbox
       end
     end
 
+    def alias
+      config[client_name]['alias']
+    end
+
     def to_fog
       raise Ini::Error, "No api client configured" unless configured?
       c = config[client_name]
@@ -122,6 +126,12 @@ module Brightbox
       }
     end
 
+    def api_hostname
+      URI(to_fog[:brightbox_api_url]).host
+    rescue StandardError
+      "api.gb1.brightbox.com"
+    end
+
     def oauth_token
       if @oauth_token.nil?
         if File.exists? oauth_token_filename
@@ -139,19 +149,24 @@ module Brightbox
 
     def finish
       begin
-        if configured? and @oauth_token != Api.conn.oauth_token
+        if configured? && @oauth_token != Api.conn.oauth_token
           File.open(oauth_token_filename + ".#{$$}", "w") do |f|
             f.write Api.conn.oauth_token
           end
           FileUtils.mv oauth_token_filename + ".#{$$}", oauth_token_filename
         end
+      rescue BBConfigError
       rescue StandardError => e
         warn "Error writing auth token #{oauth_token_filename}: #{e.class}: #{e}"
       end
     end
 
     def configured?
-      client_name != nil and !clients.empty?
+      configured = client_name != nil && !clients.empty?
+      if configured && (config[client_name].nil? || config[client_name].empty?)
+        raise BBConfigError, "client id or alias #{client_name.inspect} not defined in config"
+      end
+      configured
     end
 
     private

data/lib/brightbox-cli/detailed_server.rb

@@ -35,7 +35,7 @@ module Brightbox
       [:id, :status, :name, :created_at, :deleted_at,
         :zone, :type, :type_name, :type_handle, :ram, :cores,
         :disk, :image, :image_name, :private_ips, :cloud_ips, :ipv6_address,
-        :cloud_ip_ids, :hostname, :public_hostname, :snapshots,
+        :cloud_ip_ids, :hostname, :public_hostname, :ipv6_hostname, :snapshots,
         :server_groups
       ]
     end

data/lib/brightbox-cli/firewall_rule.rb

@@ -11,6 +11,12 @@ module Brightbox
       conn.firewall_rules.get(id)
     end
 
+    def update params
+      self.class.conn.update_firewall_rule id, params
+      self.reload
+      self
+    end
+
     def attributes
       t = @attributes || fog_model.attributes
       t[:sport] = t[:source_port]

data/lib/brightbox-cli/gli_global_hooks.rb

@@ -34,8 +34,15 @@ module Brightbox
         end
       end
     end
+
+    unless global_options[:s]
+      Hirb.enable
+      Hirb::View.resize
+    end
+
     command = commands[:help] if global_options[:h]
-    info "INFO: client_id: #{CONFIG.client_name}" if CONFIG.clients.size > 1
+    config_alias = CONFIG.alias == CONFIG.client_name ? nil : "(#{CONFIG.alias})"
+    info "INFO: client_id: #{CONFIG.client_name} #{config_alias}" if CONFIG.clients.size > 1
     true
   end
 

data/lib/brightbox-cli/images.rb

@@ -15,7 +15,7 @@ module Brightbox
     end
 
     def self.default_field_order
-      [:id, :owner, :type, :created_on, :status, :size, :username, :name]
+      [:id, :owner, :type, :created_on, :status, :size, :name]
     end
 
     def update options
@@ -53,5 +53,26 @@ module Brightbox
       public
     end
 
+    def status_sort_code
+      case self.status
+      when 'available'
+        (self.public ? 1 : 2)
+      when 'deprecated'
+        3
+      else
+        4
+      end
+    end
+
+    def default_sort_fields
+      [
+        self.official ? 0 : 1,
+        self.name,
+        self.arch,
+        self.status_sort_code,
+        - self.created_at.to_i
+      ]
+    end
+
   end
 end

data/lib/brightbox-cli/nilable_hash.rb

@@ -0,0 +1,7 @@
+class NilableHash < Hash
+  def nilify_blanks
+    keys.each do |k|
+      self[k] = nil if self[k] == ''
+    end
+  end
+end

data/lib/brightbox-cli/server_groups.rb

@@ -52,11 +52,5 @@ module Brightbox
       server_ids.respond_to?(:join) ? server_ids.join(" ") : ""
     end
 
-    def server_ids
-      if attributes["servers"]
-        @server_ids ||= attributes["servers"].collect { |s| s["id"] }
-      end
-    end
-
   end
 end

data/lib/brightbox-cli/servers.rb

@@ -45,6 +45,7 @@ module Brightbox
       a[:zone] = zone && zone['handle']
       a[:hostname] = hostname
       a[:public_hostname] = public_hostname unless cloud_ips.empty?
+      a[:ipv6_hostname] = ipv6_hostname if interfaces.any? {|i| i['ipv6_address'] }
       a
     end
 
@@ -60,13 +61,16 @@ module Brightbox
     end
 
     def hostname
-      "#{id}.gb1.brightbox.com"
+      "#{id}.#{Brightbox::CONFIG.api_hostname}"
     end
 
     def public_hostname
       "public.#{hostname}"
     end
-  end
 
+    def ipv6_hostname
+      "ipv6.#{hostname}"
+    end
+  end
 
 end

data/lib/brightbox-cli/tables.rb

@@ -1,6 +1,13 @@
 require 'hirb'
 
 module Brightbox
+
+  # Hack to set ascii art table cell width due to limitations in Hirb
+  class Hirb::Helpers::Table
+    remove_const :BORDER_LENGTH
+    BORDER_LENGTH = 2
+  end
+
   # Remove most of the ascii art table output
   class SimpleTable < Hirb::Helpers::Table
     def render_table_header
@@ -26,6 +33,12 @@ module Brightbox
       end
     end
 
+  def enforce_field_constraints
+    max_fields.each {|k,max| @field_lengths[k] = max if @field_lengths[k].to_i > max }
+    # Never shrink the id field
+    @field_lengths[:id] = IDENTIFIER_SIZE if @field_lengths[:id]
+  end
+
   end
 
   # Vertical table for "show" views

data/lib/brightbox-cli/vendor/fog/README.rdoc

@@ -105,20 +105,12 @@ geemus says: "That should give you everything you need to get started, but let m
 
 == Contributing
 
-* Find something you would like to work on. For suggestions look for the `easy`, `medium` and `hard` tags in the {issues}[http://github.com/geemus/fog/issues]
+* Find something you would like to work on. For suggestions look for the `easy`, `medium` and `hard` tags in the {issues}[http://github.com/fog/fog/issues]
 * Fork the project and do your work in a topic branch.
 * Add shindo tests to prove your code works and run all the tests using `bundle exec rake`.
 * Rebase your branch against geemus/fog to make sure everything is up to date.
 * Commit your changes and send a pull request.
 
-== T-Shirts
-
-Wonder how you can get a lovely fog shirt? Look no further!
-
-* Blue shirts go to people who have contributed indirectly, great examples are writing blog posts or giving lightning talks.
-* Grey shirts and a follow from @fog go to people who have made it on to the {contributors list}[https://github.com/geemus/fog/contributors] by submitting code.
-* Black shirts go to people who have made it on to the {collaborators list}[https://github.com/api/v2/json/repos/show/geemus/fog/collaborators] by coercing geemus into adding them.
-
 == Additional Resources
 
 {fog.io}[http://fog.io]
@@ -128,6 +120,7 @@ Wonder how you can get a lovely fog shirt? Look no further!
 http://www.engineyard.com/images/logo.png
 
 All new work on fog is sponsored by {Engine Yard}[http://engineyard.com]
+
 == Copyright
 
 (The MIT License)

data/lib/brightbox-cli/vendor/fog/Rakefile

@@ -203,9 +203,9 @@ task :changelog do
   changelog << ''
 
   require 'multi_json'
-  github_repo_data = MultiJson.decode(Excon.get('http://github.com/api/v2/json/repos/show/geemus/fog').body)
+  github_repo_data = MultiJson.decode(Excon.get('http://github.com/api/v2/json/repos/show/fog/fog').body)
   data = github_repo_data['repository'].reject {|key, value| !['forks', 'open_issues', 'watchers'].include?(key)}
-  github_collaborator_data = MultiJson.decode(Excon.get('http://github.com/api/v2/json/repos/show/geemus/fog/collaborators').body)
+  github_collaborator_data = MultiJson.decode(Excon.get('http://github.com/api/v2/json/repos/show/fog/fog/collaborators').body)
   data['collaborators'] = github_collaborator_data['collaborators'].length
   rubygems_data = MultiJson.decode(Excon.get('https://rubygems.org/api/v1/gems/fog.json').body)
   data['downloads'] = rubygems_data['downloads']
@@ -249,6 +249,7 @@ task :changelog do
         'Henry Addison',
         'Lincoln Stoll',
         'Luqman Amjad',
+        'Michael Zeng',
         'nightshade427',
         'Patrick Debois',
         'Wesley Beary'