brightbox-cli 3.2.0 → 4.0.0

data/lib/brightbox-cli/config.rb

@@ -1,20 +1,21 @@
 module Brightbox
-  class BBConfigError < StandardError ; end
+  class BBConfigError < StandardError; end
 
   class NoSelectedClientError < BBConfigError; end
-  NO_CLIENT_MESSAGE = "You must specify client to use with --client or set default client"
+  NO_CLIENT_MESSAGE = "You must specify client to use with --client or set default client".freeze
 
   class AmbiguousClientError < BBConfigError; end
-  AMBIGUOUS_CLIENT_ERROR = "You must specify a default client using brightbox config client_default"
+  AMBIGUOUS_CLIENT_ERROR = "You must specify a default client using brightbox config client_default".freeze
 
   class BBConfig
-    require 'fileutils'
-    require 'ini'
+    require "fileutils"
+    require "ini"
     include Brightbox::Logging
     include Brightbox::Config::Cache
     include Brightbox::Config::GpgEncryptedPasswords
     include Brightbox::Config::PasswordHelper
     include Brightbox::Config::TwoFactorAuth
+    include Brightbox::Config::TwoFactorHelper
     include Brightbox::Config::AuthenticationTokens
     include Brightbox::Config::Accounts
     include Brightbox::Config::Clients
@@ -48,6 +49,7 @@ module Brightbox
     # @return [String]
     def config_directory
       return @dir if @dir
+
       path = @options[:directory] || default_config_dir
       @dir = File.expand_path(path)
     end
@@ -64,7 +66,8 @@ module Brightbox
     # @return [String]
     def config_filename
       return @config_filename if @config_filename
-      @config_filename = File.join(config_directory, 'config')
+
+      @config_filename = File.join(config_directory, "config")
     end
 
     # The loads the configuration from disk or creates the directory if missing
@@ -77,22 +80,22 @@ module Brightbox
 
     # Write out the configuration file to disk
     def save
-      if dirty? && config.respond_to?(:write)
-        config.write
-        clean_up
-      end
+      return unless dirty? && config.respond_to?(:write)
+
+      config.write
+      clean_up
     end
 
     # Outputs to debug the current values of the config/client's tokens
     #
     def debug_tokens
-      if ENV["DEBUG"]
-        debug "Access token: #{access_token} (#{cached_access_token})"
-        if using_application?
-          debug "Refresh token: #{refresh_token} (#{cached_refresh_token}))"
-        else
-          debug "Refresh token: <NOT EXPECTED FOR CLIENT>"
-        end
+      return unless ENV["DEBUG"]
+
+      debug "Access token: #{access_token} (#{cached_access_token})"
+      if using_application?
+        debug "Refresh token: #{refresh_token} (#{cached_refresh_token}))"
+      else
+        debug "Refresh token: <NOT EXPECTED FOR CLIENT>"
       end
     end
 
@@ -109,13 +112,14 @@ module Brightbox
     private
 
     def default_config_dir
-      File.join(ENV['HOME'], '.brightbox')
+      File.join(ENV.fetch("HOME", nil), ".brightbox")
     end
 
     def configured?
       if client_name.nil? || config[client_name].nil?
         raise BBConfigError, "client id or alias #{client_name.inspect} not defined in config"
       end
+
       true
     end
 
@@ -123,11 +127,11 @@ module Brightbox
     # in
     #
     def create_directory
-      unless File.exist? config_directory
-        begin
-          FileUtils.mkdir config_directory
-        rescue Errno::EEXIST
-        end
+      return if File.exist? config_directory
+
+      begin
+        FileUtils.mkdir config_directory
+      rescue Errno::EEXIST
       end
     end
 

data/lib/brightbox-cli/connection_manager.rb

@@ -27,11 +27,13 @@ module Brightbox
 
     def connection_options
       merged_options = @connection_options.dup
-      if @connection && @connection.refresh_token
+      merged_options.update(:brightbox_support_two_factor => true)
+
+      if @connection&.refresh_token
         merged_options.update(:brightbox_refresh_token => @connection.refresh_token)
       end
 
-      if @connection && @connection.access_token
+      if @connection&.access_token
         merged_options.update(:brightbox_access_token => @connection.access_token)
       end
       merged_options

data/lib/brightbox-cli/database_server.rb

@@ -33,44 +33,44 @@ module Brightbox
     end
 
     def self.default_field_order
-      [
-        :id,
-        :status,
-        :type,
-        :db_engine,
-        :zone,
-        :created_on,
-        :cloud_ip_ids,
-        :name
+      %i[
+        id
+        status
+        type
+        db_engine
+        zone
+        created_on
+        cloud_ip_ids
+        name
       ]
     end
 
     # These are all the fields show in the longer table form
     def self.detailed_fields
-      [
-        :id, :name, :description, :status, :locked,
-        :type, :engine, :version,
-        :zone,
-        :created_on,
-        :admin_username, :admin_password,
-        :maintenance_window,
-        :snapshots_schedule,
-        :snapshots_schedule_next_at,
-        :allow_access,
-        :cloud_ip_ids, :cloud_ips
+      %i[
+        id name description status locked
+        type engine version
+        zone
+        created_on
+        admin_username admin_password
+        maintenance_window
+        snapshots_schedule
+        snapshots_schedule_next_at
+        allow_access
+        cloud_ip_ids cloud_ips
       ]
     end
 
     def type_identifier
-      if fog_model.attributes.key?("database_server_type")
-        fog_model.attributes["database_server_type"]["id"]
-      end
+      return unless fog_model.attributes.key?("database_server_type")
+
+      fog_model.attributes["database_server_type"]["id"]
     end
 
     def zone_handle
-      if fog_model.attributes.key?("zone")
-        fog_model.attributes["zone"]["handle"]
-      end
+      return unless fog_model.attributes.key?("zone")
+
+      fog_model.attributes["zone"]["handle"]
     end
 
     def to_row
@@ -99,8 +99,9 @@ module Brightbox
     # A more humanised version of the maintenance window
     def maintenance_window
       return nil if maintenance_weekday.nil?
+
       weekday = Date::DAYNAMES[maintenance_weekday]
-      sprintf("%s %02d:00 UTC", weekday, maintenance_hour)
+      format("%s %02d:00 UTC", weekday, maintenance_hour)
     end
 
     def cloud_ips
@@ -149,8 +150,6 @@ module Brightbox
       params
     end
 
-    private
-
     # @param [String] user_input either a day or it's index ('sunday' or '0')
     # @returns [String] The index
     def self.weekday_index(user_input)

data/lib/brightbox-cli/database_snapshot.rb

@@ -23,7 +23,7 @@ module Brightbox
     end
 
     def self.default_field_order
-      [:id, :status, :created_on, :name]
+      %i[id status created_on size name]
     end
 
     def to_row

data/lib/brightbox-cli/database_type.rb

@@ -30,15 +30,15 @@ module Brightbox
     end
 
     def self.default_field_order
-      [:id, :name, :ram, :disk]
+      %i[id name ram disk]
     end
 
     def <=>(other)
-      if other.is_a? DatabaseType
-        ram <=> other.ram
-      else
-        ram <=> other
-      end
+      ram <=> if other.is_a? DatabaseType
+                other.ram
+              else
+                other
+              end
     end
   end
 end

data/lib/brightbox-cli/detailed_server.rb

@@ -6,12 +6,12 @@ module Brightbox
       row_attributes[:compatibility_mode] = row_attributes["compatibility_mode"]
 
       if server_type
-        row_attributes[:type] = server_type['id']
-        row_attributes[:type_handle] = server_type['handle']
-        row_attributes[:type_name] = server_type['name']
-        row_attributes[:ram] = server_type['ram']
-        row_attributes[:cores] = server_type['cores']
-        row_attributes[:disk] = server_type['disk_size'].to_i
+        row_attributes[:type] = server_type["id"]
+        row_attributes[:type_handle] = server_type["handle"]
+        row_attributes[:type_name] = server_type["name"]
+        row_attributes[:ram] = server_type["ram"]
+        row_attributes[:cores] = server_type["cores"]
+        row_attributes[:disk] = server_type["disk_size"].to_i
       end
 
       if image
@@ -19,52 +19,52 @@ module Brightbox
         row_attributes[:arch] = image.arch
       end
 
-      row_attributes[:private_ips] = interfaces.map { |i| i['ipv4_address'] }.join(", ")
-      row_attributes[:ipv6_address] = interfaces.map { |i| i['ipv6_address'] }.join(", ")
+      row_attributes[:private_ips] = interfaces.map { |i| i["ipv4_address"] }.join(", ")
+      row_attributes[:ipv6_address] = interfaces.map { |i| i["ipv6_address"] }.join(", ")
 
-      row_attributes[:cloud_ip_ids] = cloud_ips.map { |i| i['id'] }.join(", ")
-      row_attributes[:cloud_ipv4s] = cloud_ips.map { |i| i['public_ipv4'] }.join(", ")
-      row_attributes[:cloud_ipv6s] = cloud_ips.map { |i| i['public_ipv6'] }.join(", ")
-      row_attributes[:snapshots] = snapshots.map { |i| i['id'] }.join(", ")
+      row_attributes[:cloud_ip_ids] = cloud_ips.map { |i| i["id"] }.join(", ")
+      row_attributes[:cloud_ipv4s] = cloud_ips.map { |i| i["public_ipv4"] }.join(", ")
+      row_attributes[:cloud_ipv6s] = cloud_ips.map { |i| i["public_ipv6"] }.join(", ")
+      row_attributes[:snapshots] = snapshots.map { |i| i["id"] }.join(", ")
 
       if server_groups
-        row_attributes[:server_groups] = server_groups.map { |sg| sg['id'] }.join(", ")
+        row_attributes[:server_groups] = server_groups.map { |sg| sg["id"] }.join(", ")
       end
 
       row_attributes
     end
 
     def self.default_field_order
-      [
-        :id,
-        :status,
-        :locked,
-        :name,
-        :created_at,
-        :deleted_at,
-        :zone,
-        :type,
-        :type_name,
-        :type_handle,
-        :ram,
-        :cores,
-        :disk,
-        :disk_encrypted,
-        :compatibility_mode,
-        :image,
-        :image_name,
-        :arch,
-        :private_ips,
-        :ipv6_address,
-        :hostname,
-        :fqdn,
-        :public_hostname,
-        :ipv6_hostname,
-        :cloud_ip_ids,
-        :cloud_ipv4s,
-        :cloud_ipv6s,
-        :snapshots,
-        :server_groups
+      %i[
+        id
+        status
+        locked
+        name
+        created_at
+        deleted_at
+        zone
+        type
+        type_name
+        type_handle
+        ram
+        cores
+        disk
+        disk_encrypted
+        compatibility_mode
+        image
+        image_name
+        arch
+        private_ips
+        ipv6_address
+        hostname
+        fqdn
+        public_hostname
+        ipv6_hostname
+        cloud_ip_ids
+        cloud_ipv4s
+        cloud_ipv6s
+        snapshots
+        server_groups
       ]
     end
   end

data/lib/brightbox-cli/detailed_server_group.rb

@@ -7,7 +7,7 @@ module Brightbox
     end
 
     def self.default_field_order
-      [:id, :name, :servers, :firewall_policy, :description]
+      %i[id name servers firewall_policy description]
     end
   end
 end

data/lib/brightbox-cli/error_parser.rb

@@ -16,26 +16,26 @@ module Brightbox
       end
     end
 
-    def parse_http_error(e)
-      if e.respond_to?(:response) && e.response.respond_to?(:body)
+    def parse_http_error(err)
+      if err.respond_to?(:response) && err.response.respond_to?(:body)
         begin
-          json_response = MultiJson.load(e.response.body)
-          extract_response_from_json(json_response, e)
-        rescue
+          json_response = MultiJson.load(err.response.body)
+          extract_response_from_json(json_response, err)
+        rescue StandardError
           {}
         end
       else
-        error "ERROR: #{e}"
+        error "ERROR: #{err}"
       end
     end
 
-    def extract_response_from_json(error_json, e)
-      json_error = error_json['errors'] || error_json['error']
+    def extract_response_from_json(error_json, err)
+      json_error = error_json["errors"] || error_json["error"]
       if json_error && !json_error.empty?
         error_string = Array(json_error).join(" ")
         error "ERROR: #{error_string}"
       else
-        error "ERROR: #{e}"
+        error "ERROR: #{err}"
       end
     end
   end

data/lib/brightbox-cli/firewall_policy.rb

@@ -1,6 +1,7 @@
 module Brightbox
   class FirewallPolicy < Api
     def self.require_account?; true; end
+
     def self.create(options)
       new(conn.firewall_policies.create(options))
     end
@@ -26,7 +27,7 @@ module Brightbox
     end
 
     def self.default_field_order
-      [:id, :server_group, :name]
+      %i[id server_group name]
     end
   end
 end

data/lib/brightbox-cli/firewall_rule.rb

@@ -29,8 +29,8 @@ module Brightbox
 
     def to_row
       attrs = attributes.dup
-      [:protocol, :source, :sport, :destination, :dport, :icmp_type].each do |key|
-        attrs[key] = attributes[key] || '-'
+      %i[protocol source sport destination dport icmp_type].each do |key|
+        attrs[key] = attributes[key] || "-"
       end
       attrs
     end
@@ -40,7 +40,7 @@ module Brightbox
     end
 
     def self.default_field_order
-      [:id, :protocol, :source, :sport, :destination, :dport, :icmp_type, :description]
+      %i[id protocol source sport destination dport icmp_type description]
     end
   end
 end

data/lib/brightbox-cli/firewall_rules.rb

@@ -3,19 +3,19 @@ module Brightbox
     def self.from_policy(firewall_policy)
       rules = firewall_policy.rules
       rules.map do |rule|
-        fwr = FirewallRule.new('fwr')
+        fwr = FirewallRule.new("fwr")
         fwr.attributes = symbolize_keys(rule)
         fwr
       end
     end
 
-    def self.symbolize_keys(object) #:nodoc:
+    def self.symbolize_keys(object) # :nodoc:
       modify_keys(object) do |key|
         key.is_a?(String) ? key.to_sym : key
       end
     end
 
-    def self.modify_keys(object, &modifier) #:nodoc:
+    def self.modify_keys(object, &modifier) # :nodoc:
       object.reduce({}) do |result, (key, value)|
         new_key = modifier.call(key)
         result.merge! new_key => value

data/lib/brightbox-cli/gli_global_hooks.rb

@@ -11,7 +11,7 @@ module Brightbox
   #
   # Need to locate the source of double loading under Aruba
   #
-  subcommand_files = Dir.glob(File.expand_path("../commands/**/*.rb", __FILE__))
+  subcommand_files = Dir.glob(File.expand_path("commands/**/*.rb", __dir__))
   subcommand_files.sort.each do |cmd_file|
     require cmd_file
   end
@@ -21,34 +21,34 @@ module Brightbox
 
   # Global options
   desc "Simple output (tab separated, don't draw fancy tables)"
-  switch [:s, :simple], :negatable => false
+  switch %i[s simple], :negatable => false
 
   desc "Set the api client to use"
-  flag [:c, :client]
+  flag %i[c client]
 
   desc "Set the account to use"
   flag :account
 
   desc "Disable peer SSL certificate verification"
-  switch [:k, :insecure], :negatable => false
+  switch %i[k insecure], :negatable => false
 
   pre do |global_options, command, _options, _args|
     # Configuration options
     config_opts = {
-      :client_name => ENV["CLIENT"] || global_options[:client],
-      :account => ENV["ACCOUNT"] || global_options[:account]
+      :client_name => ENV.fetch("CLIENT", global_options[:client]),
+      :account => ENV.fetch("ACCOUNT", global_options[:account])
     }
     Brightbox.config = BBConfig.new(config_opts)
 
     # Commands that alter the config files should not error here
-    unless [:config, :login].include?(command.topmost_ancestor.name)
+    unless %i[config login].include?(command.topmost_ancestor.name)
       raise AmbiguousClientError, AMBIGUOUS_CLIENT_ERROR if Brightbox.config.client_name.nil?
 
       if Brightbox.config.has_multiple_clients?
         if Brightbox.config.client_has_alias?
-          info "INFO: client_id: #{Brightbox.config.client_name} (#{Brightbox.config.client_alias})"
+          debug "client_id: #{Brightbox.config.client_name} (#{Brightbox.config.client_alias})"
         else
-          info "INFO: client_id: #{Brightbox.config.client_name}"
+          debug "client_id: #{Brightbox.config.client_name}"
         end
       end
 
@@ -56,11 +56,11 @@ module Brightbox
       Brightbox.config.debug_tokens if Brightbox.config.respond_to?(:debug_tokens)
     end
 
-    Excon.defaults[:headers]['User-Agent'] = "brightbox-cli/#{Brightbox::VERSION} Fog/#{Fog::Core::VERSION}"
+    Excon.defaults[:headers]["User-Agent"] = "brightbox-cli/#{Brightbox::VERSION} Fog/#{Fog::Core::VERSION}"
 
-    Excon.defaults[:headers]['User-Agent'] ||= "brightbox-cli/#{Brightbox::VERSION}"
+    Excon.defaults[:headers]["User-Agent"] ||= "brightbox-cli/#{Brightbox::VERSION}"
 
-    if global_options[:k] || ENV["INSECURE"]
+    if global_options[:k] || ENV.fetch("INSECURE", false)
       Excon.defaults[:ssl_verify_peer] = false
     end
 
@@ -73,20 +73,18 @@ module Brightbox
   end
 
   post do |_global_options, _command, _options, _args|
-    begin
-      # Api.conn is another global which holds the authentication tokens so
-      # we need to shuffle data between globals at a higher level rather than
-      # force one inside the other
-      access_token = Api.conn.access_token
-      refresh_token = Api.conn.refresh_token
-
-      Brightbox.config.update_stored_tokens(access_token, refresh_token)
-      Brightbox.config.save
-    rescue BBConfigError
-    rescue StandardError => e
-      # FIXME: Other StandardErrors are available
-      warn "Error writing auth token #{Brightbox.config.access_token_filename}: #{e.class}: #{e}"
-    end
+    # Api.conn is another global which holds the authentication tokens so
+    # we need to shuffle data between globals at a higher level rather than
+    # force one inside the other
+    access_token = Api.conn.access_token
+    refresh_token = Api.conn.refresh_token
+
+    Brightbox.config.update_stored_tokens(access_token, refresh_token)
+    Brightbox.config.save
+  rescue BBConfigError
+  rescue StandardError => e
+    # FIXME: Other StandardErrors are available
+    warn "Error writing auth token #{Brightbox.config.access_token_filename}: #{e.class}: #{e}"
   end
 
   on_error do |e|
@@ -103,7 +101,7 @@ module Brightbox
         error "Unable to authenticate with supplied details"
         Brightbox.config.debug_tokens if Brightbox.config.respond_to?(:debug_tokens)
         exit(111)
-      rescue Exception => e
+      rescue StandardError => e
         if ENV["DEBUG"]
           debug e
           debug e.class.to_s

data/lib/brightbox-cli/images.rb

@@ -1,6 +1,7 @@
 module Brightbox
   class Image < Api
     def self.require_account?; true; end
+
     def self.all
       conn.images
     end
@@ -11,40 +12,40 @@ module Brightbox
 
     def self.register(options = {})
       image = conn.create_image(options)
-      find image['id']
+      find image["id"]
     end
 
     def self.default_field_order
-      [:id, :owner, :type, :created_on, :status, :size, :name]
+      %i[id owner type created_on status size name]
     end
 
     # Filter out images that are not of the right type, account or status if the option is passed
     def self.filter_images(images, options = {})
       # Remove images that don't match the given type
       if options[:t]
-        images.reject! { |i| i.type != options[:t] }
+        images.select! { |i| i.type == options[:t] }
       end
 
       # Remove statuses that don't match the argument
       if options[:s]
-        images.reject! { |i| i.status != options[:s] }
+        images.select! { |i| i.status == options[:s] }
       end
 
       # Remove images that don't belong to the specified owner id
       if options[:l]
-        if options[:l] == 'brightbox'
-          images.reject! { |i| !i.official }
+        if options[:l] == "brightbox"
+          images.select!(&:official)
         else
-          images.reject! { |i| i.owner_id != options[:l] }
+          images.select! { |i| i.owner_id == options[:l] }
         end
       end
 
       unless options[:a]
         account = Account.conn.get_scoped_account(:nested => false)
-        images.reject! { |i| !i.official && i.owner_id != account["id"]  }
+        images.reject! { |i| !i.official && i.owner_id != account["id"] }
       end
 
-      snapshots = images.select { |i| i.source_type == 'snapshot' }
+      snapshots = images.select { |i| i.source_type == "snapshot" }
       images -= snapshots
 
       images.sort! { |a, b| a.default_sort_fields <=> b.default_sort_fields }
@@ -68,7 +69,7 @@ module Brightbox
 
     def status
       if fog_model.attributes[:status] == "available"
-        public? ? 'public' : 'private'
+        public? ? "public" : "private"
       else
         fog_model.attributes[:status]
       end
@@ -90,6 +91,7 @@ module Brightbox
       o[:description] = description if description
       o[:licence_name] = licence_name
       o[:size] = virtual_size
+      o[:min_ram] = min_ram
       o
     end
 
@@ -99,9 +101,9 @@ module Brightbox
 
     def status_sort_code
       case fog_model.attributes[:status]
-      when 'available'
+      when "available"
         (public? ? 1 : 2)
-      when 'deprecated'
+      when "deprecated"
         3
       else
         4