brightbox-cli 3.3.0 → 4.0.0.rc2

data/lib/brightbox-cli/config/gpg_encrypted_passwords.rb

@@ -1,7 +1,7 @@
 module Brightbox
   module Config
     module GpgEncryptedPasswords
-      attr_accessor :gpg_password
+      attr_writer :gpg_password
 
       def gpg_encrypted_password_filename
         file_name = "#{client_name}.password.gpg"
@@ -13,11 +13,10 @@ module Brightbox
         if defined?(@gpg_password) && !@gpg_password.nil?
           return @gpg_password
         end
-        if File.exist?(gpg_encrypted_password_filename)
-          @gpg_password = gpg_decrypt_password
-        else
-          @gpg_password = nil
-        end
+
+        @gpg_password = if File.exist?(gpg_encrypted_password_filename)
+                          gpg_decrypt_password
+                        end
       end
 
       private
@@ -26,14 +25,13 @@ module Brightbox
       def gpg_decrypt_password
         info "INFO: Decrypting #{gpg_encrypted_password_filename} to obtain password"
         begin
-          IO::popen(["gpg", "--decrypt", gpg_encrypted_password_filename], "r") do |io|
+          IO.popen(["gpg", "--decrypt", gpg_encrypted_password_filename], "r") do |io|
             io.read.chomp
           end
         rescue Errno::ENOENT
           nil
         end
       end
-
     end
   end
 end

data/lib/brightbox-cli/config/password_helper.rb

@@ -1,7 +1,26 @@
 module Brightbox
   module Config
     module PasswordHelper
-      attr_accessor :password_helper_password
+      ENTER_PASSWORD_PROMPT = "Enter your password : ".freeze
+      EXPIRED_TOKEN_PROMPT = "Your API credentials have expired, enter your password to update them.".freeze
+
+      attr_writer :password_helper_password
+
+      # {discover_password} will return the first password that can be
+      # recovered from either the passed input, encrypted storage, a
+      # helper application (if configured) or finally promping.
+      #
+      # @param password [String] a password given to the method
+      # @param expired [Boolean] should the prompt explain tokens have expired?
+      # @return [String] the password
+      #
+      def discover_password(password: nil, expired: false)
+        password ||= gpg_password
+        password ||= password_helper_password
+        password ||= prompt_for_password(expired)
+      end
+
+      private
 
       def password_helper_command
         return config[client_name]["password_helper_command"] unless client_name.nil?
@@ -13,15 +32,11 @@ module Brightbox
           return @password_helper_password
         end
 
-        if password_helper_command
-          @password_helper_password = password_helper_call
-        else
-          @password_helper_password = nil
-        end
+        @password_helper_password = if password_helper_command
+                                      password_helper_call
+                                    end
       end
 
-      private
-
       def password_helper_call
         info "INFO: Calling password helper to obtain password"
         begin
@@ -33,6 +48,16 @@ module Brightbox
           nil
         end
       end
+
+      # This asks the user to input their password
+      def prompt_for_password(expired)
+        require "highline"
+        highline = HighLine.new
+        highline.say(EXPIRED_TOKEN_PROMPT) if expired
+
+        # FIXME: Capture interupts if user aborts
+        highline.ask(ENTER_PASSWORD_PROMPT) { |q| q.echo = false }
+      end
     end
   end
 end

data/lib/brightbox-cli/config/sections.rb

@@ -43,18 +43,27 @@ module Brightbox
         #
         begin
           remove_cached_tokens!
-          renew_tokens(:client_name => config_alias, :password => password)
-        rescue => e
-          error "Something went wrong trying to refresh new tokens #{e.message}"
-        end
+          begin
+            renew_tokens(client_name: config_alias,
+                         password: password)
+          rescue Fog::Brightbox::OAuth2::TwoFactorMissingError
+            discover_two_factor_pin
+
+            renew_tokens(client_name: client_alias,
+                         password: options[:password],
+                         one_time_password: current_second_factor)
+          end
 
-        # Try to determine a default account
-        unless default_account == find_or_set_default_account
-          info "The default account of #{default_account} has been selected"
-        end
+          # Try to determine a default account
+          unless default_account == find_or_set_default_account
+            info "The default account of #{default_account} has been selected"
+          end
 
-        # If only client then set it as the default
-        set_default_client(client_alias) unless default_client
+          # If only client then set it as the default
+          set_default_client(client_alias) unless default_client
+        rescue StandardError => e
+          error "Something went wrong trying to refresh new tokens #{e.message}"
+        end
 
         # Ensure all our config changes are now saved
         save
@@ -98,18 +107,25 @@ module Brightbox
 
         # Renew tokens via config...
         begin
-          renew_tokens(:client_name => client_alias, :password => options[:password])
-        rescue => e
-          error "Something went wrong trying to refresh new tokens #{e.message}"
-        end
+          begin
+            renew_tokens(client_name: client_alias,
+                         password: options[:password])
+          rescue Fog::Brightbox::OAuth2::TwoFactorMissingError
+            renew_tokens(client_name: client_alias,
+                         password: options[:password],
+                         one_time_password: discover_two_factor_pin)
+          end
 
-        # Try to determine a default account
-        unless default_account == find_or_set_default_account
-          info "The default account of #{default_account} has been selected"
-        end
+          # Try to determine a default account
+          unless default_account == find_or_set_default_account
+            info "The default account of #{default_account} has been selected"
+          end
 
-        # If only client then set it as the default
-        set_default_client(client_alias) unless default_client
+          # If only client then set it as the default
+          set_default_client(client_alias) unless default_client
+        rescue StandardError => e
+          error "Something went wrong trying to refresh new tokens #{e.message}"
+        end
 
         # Ensure all our config changes are now saved
         save
@@ -119,16 +135,16 @@ module Brightbox
       # persisted to disk.
       #
       def delete_section(name)
-        if client_named?(name)
-          if default_client == name
-            clear_default_client
-          end
-          # remove from the Ini object
-          config.delete_section(name)
+        return unless client_named?(name)
 
-          dirty! # to ensure save actually writes to disk
-          save
+        if default_client == name
+          clear_default_client
         end
+        # remove from the Ini object
+        config.delete_section(name)
+
+        dirty! # to ensure save actually writes to disk
+        save
       end
 
       # Config data for a named section
@@ -150,7 +166,7 @@ module Brightbox
       #
       def section_names
         # Exclude the global "core" section
-        config.sections.reject { |s| %w(core alias).include?(s) }
+        config.sections.reject { |s| %w[core alias].include?(s) }
       end
 
       private

data/lib/brightbox-cli/config/two_factor_auth.rb

@@ -1,33 +1,31 @@
 module Brightbox
   module Config
     module TwoFactorAuth
+      ENTER_TWO_FACTOR_PROMPT = "Enter your two factor pin : ".freeze
 
-      def extend_with_two_factor_pin(password)
-        if two_factor_enabled
-          suffix = "+" + two_factor_pin
-          password += suffix unless password.end_with?(suffix)
-        end
-        password
+      attr_accessor :current_second_factor
+
+      def discover_two_factor_pin
+        @two_factor_pin ||= Brightbox.config.two_factor_helper_password
+        @two_factor_pin ||= prompt_for_two_factor_pin
+
+        self.current_second_factor = @two_factor_pin
       end
 
       private
 
       def two_factor_enabled
-        return config[client_name]["two_factor"] == "true" unless client_name.nil?
-      end
+        return false unless client_name.nil?
+        return true if config[client_name]["two_factor"] == "true"
 
-      def two_factor_pin
-        if two_factor_enabled
-          @two_factor_pin ||= Brightbox.config.two_factor_helper_password
-          @two_factor_pin ||= prompt_for_two_factor_pin
-        end
+        false
       end
 
       def prompt_for_two_factor_pin
         require "highline"
         highline = HighLine.new
         # FIXME: Capture interupts if user aborts
-        highline.ask("Enter your two factor pin : ")
+        highline.ask(ENTER_TWO_FACTOR_PROMPT)
       end
     end
   end

data/lib/brightbox-cli/config/two_factor_helper.rb

@@ -1,7 +1,7 @@
 module Brightbox
   module Config
     module TwoFactorHelper
-      attr_accessor :two_factor_helper_password
+      attr_writer :two_factor_helper_password
 
       def two_factor_helper_command
         return config[client_name]["two_factor_helper_command"] unless client_name.nil?
@@ -13,11 +13,9 @@ module Brightbox
           return @two_factor_helper_password
         end
 
-        if two_factor_helper_command
-          @two_factor_helper_password = two_factor_helper_call
-        else
-          @two_factor_helper_password = nil
-        end
+        @two_factor_helper_password = if two_factor_helper_command
+                                        two_factor_helper_call
+                                      end
       end
 
       private
@@ -29,7 +27,7 @@ module Brightbox
           IO.popen(cmd, "r") do |io|
             io.readline.chomp
           end
-        rescue Errno::ENOENT
+        rescue ArgumentError, Errno::ENOENT
           nil
         end
       end

data/lib/brightbox-cli/config/user_application.rb

@@ -3,7 +3,7 @@ module Brightbox
     class UserApplication
       # FIXME: api_url should use fog's underlying default
       #
-      NON_BLANK_KEYS = %w(api_url username)
+      NON_BLANK_KEYS = %w[api_url username].freeze
 
       attr_accessor :selected_config, :client_name
 
@@ -16,11 +16,12 @@ module Brightbox
         check_required_params
         # Note we have to merge in refresh token at the higher level
         {
-          :provider => 'Brightbox',
-          :brightbox_api_url => selected_config['api_url'],
-          :brightbox_auth_url => selected_config['auth_url'] || selected_config['api_url'],
+          :provider => "Brightbox",
+          :brightbox_api_url => selected_config["api_url"],
+          :brightbox_auth_url => selected_config["auth_url"] || selected_config["api_url"],
           :brightbox_client_id => client_id,
           :brightbox_secret => client_secret,
+          :brightbox_support_two_factor => true,
           :persistent => persistent?
         }
       end
@@ -40,7 +41,9 @@ module Brightbox
       #
       def fetch_refresh_token(options)
         password_options = {
-          :brightbox_password => options[:password]
+          :brightbox_password => options[:password],
+          :brightbox_support_two_factor => true,
+          :brightbox_one_time_password => options[:one_time_password]
         }
 
         default_fog_options = password_auth_params.merge(password_options)
@@ -64,31 +67,28 @@ module Brightbox
       end
 
       def persistent?
-        if selected_config["persistent"] == "false"
-          false
-        else
-          true
-        end
+        selected_config["persistent"] != "false"
       end
 
       def password_auth_params
         {
-          :provider => 'Brightbox',
-          :brightbox_api_url => selected_config['api_url'],
-          :brightbox_auth_url => selected_config['auth_url'] || selected_config['api_url'],
+          :provider => "Brightbox",
+          :brightbox_api_url => selected_config["api_url"],
+          :brightbox_auth_url => selected_config["auth_url"] || selected_config["api_url"],
           :brightbox_client_id => client_id,
           :brightbox_secret => client_secret,
           :brightbox_username => selected_config["username"],
+          :brightbox_support_two_factor => true,
           :persistent => persistent?
         }
       end
 
       def check_required_params
-        unless valid?
-          NON_BLANK_KEYS.each do |key|
-            unless selected_config.key?(key) && !selected_config[key].to_s.empty?
-              raise Brightbox::BBConfigError, "#{key} option missing from config in section #{client_name}"
-            end
+        return if valid?
+
+        NON_BLANK_KEYS.each do |key|
+          unless selected_config.key?(key) && !selected_config[key].to_s.empty?
+            raise Brightbox::BBConfigError, "#{key} option missing from config in section #{client_name}"
           end
         end
       end

data/lib/brightbox-cli/config.rb

@@ -1,15 +1,15 @@
 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
@@ -49,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
@@ -65,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
@@ -78,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
 
@@ -110,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
 
@@ -124,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, :size, :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