brightbox-cli 3.3.0 → 4.0.0.rc2

data/lib/brightbox-cli/commands/sql/snapshots_show.rb

@@ -1,13 +1,10 @@
 module Brightbox
   command [:sql] do |product|
     product.command [:snapshots] do |cmd|
-
       cmd.desc I18n.t("sql.snapshots.show.desc")
       cmd.arg_name "[snapshot-id...]"
       cmd.command [:show] do |c|
-
         c.action do |global_options, _options, args|
-
           raise "You must specify snapshot ids to show" if args.empty?
 
           servers = DatabaseSnapshot.find_or_call(args) do |id|
@@ -16,18 +13,18 @@ module Brightbox
 
           table_opts = global_options.merge(
             :vertical => true,
-            :fields => [
-              :id,
-              :name,
-              :description,
-              :status,
-              :database_engine,
-              :database_version,
-              :locked,
-              :created_on,
-              :created_at,
-              :size,
-              :source
+            :fields => %i[
+              id
+              name
+              description
+              status
+              database_engine
+              database_version
+              locked
+              created_on
+              created_at
+              size
+              source
             ]
           )
           render_table(servers, table_opts)

data/lib/brightbox-cli/commands/sql/snapshots_update.rb

@@ -1,13 +1,11 @@
 module Brightbox
   command [:sql] do |product|
     product.command [:snapshots] do |cmd|
-
       cmd.desc I18n.t("sql.snapshots.update.desc")
       cmd.arg_name "snapshot-id"
       cmd.command [:update] do |c|
-
         c.desc I18n.t("options.name.desc")
-        c.flag [:n, :name]
+        c.flag %i[n name]
 
         c.desc I18n.t("options.description.desc")
         c.flag [:d, "description"]

data/lib/brightbox-cli/commands/sql/types.rb

@@ -1,24 +1,20 @@
 module Brightbox
   command [:sql] do |product|
-
     product.desc I18n.t("sql.types.desc")
     product.command [:types] do |cmd|
-
       cmd.default_command :list
 
       cmd.desc I18n.t("sql.types.list.desc")
       cmd.arg_name "[type-id...]"
       cmd.command [:list] do |c|
-
         c.action do |global_options, _options, args|
-
-          if args.empty?
-            types = DatabaseType.find :all
-          else
-            types = DatabaseType.find_or_call(args) do |id|
-              warn "Couldn't find an SQL type with ID #{id}"
-            end
-          end
+          types = if args.empty?
+                    DatabaseType.find :all
+                  else
+                    DatabaseType.find_or_call(args) do |id|
+                      warn "Couldn't find an SQL type with ID #{id}"
+                    end
+                  end
 
           render_table(types.sort, global_options)
         end
@@ -27,9 +23,7 @@ module Brightbox
       cmd.desc I18n.t("sql.types.show.desc")
       cmd.arg_name "[type-id...]"
       cmd.command [:show] do |c|
-
         c.action do |global_options, _options, args|
-
           if args.empty?
             raise "You must specify the types you want to show"
           end
@@ -40,12 +34,11 @@ module Brightbox
 
           display_options = {
             :vertical => true,
-            :fields => [:id, :name, :description, :ram, :disk]
+            :fields => %i[id name description ram disk]
           }
 
           table_opts = global_options.merge(display_options)
           render_table(types, table_opts)
-
         end
       end
     end

data/lib/brightbox-cli/commands/token.rb

@@ -29,6 +29,5 @@ module Brightbox
         $stdout.puts token.format(options[:format])
       end
     end
-
   end
 end

data/lib/brightbox-cli/commands/types.rb

@@ -1,22 +1,19 @@
 module Brightbox
   desc "Lists the type of templates available for servers"
   command [:types] do |cmd|
-
     cmd.default_command :list
 
     cmd.desc "List types"
     cmd.arg_name "[type-id...]"
     cmd.command [:list] do |c|
-
       c.action do |global_options, _options, args|
-
-        if args.empty?
-          types = Type.find :all
-        else
-          types = Type.find_or_call(args) do |id|
-            warn "Couldn't find type #{id}"
-          end
-        end
+        types = if args.empty?
+                  Type.find :all
+                else
+                  Type.find_or_call(args) do |id|
+                    warn "Couldn't find type #{id}"
+                  end
+                end
 
         render_table(types.sort, global_options)
       end
@@ -25,9 +22,7 @@ module Brightbox
     cmd.desc "Show detailed type info"
     cmd.arg_name "type-id..."
     cmd.command [:show] do |c|
-
       c.action do |global_options, _options, args|
-
         if args.empty?
           raise "You must specify the types you want to show"
         end
@@ -38,12 +33,11 @@ module Brightbox
 
         display_options = {
           :vertical => true,
-          :fields => [:id, :handle, :status, :name, :ram, :disk, :cores]
+          :fields => %i[id handle status name ram disk cores]
         }
 
         table_opts = global_options.merge(display_options)
         render_table(types, table_opts)
-
       end
     end
   end

data/lib/brightbox-cli/commands/{user-collaborations.rb → user_collaborations.rb}

@@ -1,20 +1,19 @@
 module Brightbox
   desc "Lists accounts you can access (when using user credentials)"
   command [:"account-access"] do |cmd|
-
     cmd.default_command :list
 
     cmd.desc "List your collaborations"
     cmd.arg_name "[collaboration-id...]"
     cmd.command [:list] do |c|
       c.action do |global_options, _options, args|
-        if args.empty?
-          collaborations = UserCollaboration.find(:all)
-        else
-          collaborations = UserCollaboration.find_or_call(args) do |id|
-            warn "Couldn't find collaboration #{id}"
-          end
-        end
+        collaborations = if args.empty?
+                           UserCollaboration.find(:all)
+                         else
+                           UserCollaboration.find_or_call(args) do |id|
+                             warn "Couldn't find collaboration #{id}"
+                           end
+                         end
         render_table(collaborations, global_options)
       end
     end

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

@@ -1,13 +1,11 @@
 module Brightbox
   desc I18n.t("users.desc")
   command [:users] do |cmd|
-
     cmd.default_command :list
 
     cmd.desc I18n.t("users.list.desc")
     cmd.arg_name "[user-id...]"
     cmd.command [:list] do |c|
-
       c.action do |global_options, _options, args|
         users = User.find_all_or_warn(args)
         render_table(users, global_options)

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

@@ -1,16 +1,14 @@
 module Brightbox
   command [:users] do |cmd|
-
     cmd.desc I18n.t("users.show.desc")
     cmd.arg_name "user-id..."
     cmd.command [:show] do |c|
-
       c.action do |global_options, _options, args|
         users = User.find_all_or_warn(args)
 
         table_opts = global_options.merge(
           :vertical => true,
-          :fields => [:id, :name, :email_address, :accounts, :ssh_key]
+          :fields => %i[id name email_address accounts ssh_key]
         )
 
         render_table(users, table_opts)

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

@@ -1,26 +1,23 @@
 module Brightbox
   command [:users] do |cmd|
-
     cmd.desc I18n.t("users.update.desc")
     cmd.arg_name "user-id..."
     cmd.command [:update] do |c|
-
       c.desc "Path to public ssh key file"
       c.long_desc "This is the path to the public ssh key that you'd like to use
       for new servers. You can specify '-' to read from stdin"
       c.flag [:f, "ssh-key"]
 
       c.desc I18n.t("options.name.desc")
-      c.flag [:n, :name]
+      c.flag %i[n name]
 
       c.action do |global_options, options, args|
-
         raise "You must specify the user id as the first argument" if args.empty?
 
         user = User.find args.first
 
         if options[:f] == "-"
-          user.ssh_key = STDIN.read
+          user.ssh_key = $stdin.read
         elsif options[:f]
           File.open(File.expand_path(options[:f])) { |f| user.ssh_key = f.read }
         end
@@ -31,7 +28,7 @@ module Brightbox
 
         table_opts = global_options.merge(
           :vertical => true,
-          :fields => [:id, :name, :email_address, :ssh_key]
+          :fields => %i[id name email_address ssh_key]
         )
 
         render_table([user], table_opts)

data/lib/brightbox-cli/commands/zones.rb

@@ -1,22 +1,19 @@
 module Brightbox
   desc "Lists the zones available to an account or see more details"
   command [:zones] do |cmd|
-
     cmd.default_command :list
 
     cmd.desc "List zones"
     cmd.arg_name "[zone-id...]"
     cmd.command [:list] do |c|
-
       c.action do |global_options, _options, args|
-
-        if args.empty?
-          zones = Zone.find(:all)
-        else
-          zones = Zone.find_or_call(args) do |id|
-            warn "Couldn't find zone #{id}"
-          end
-        end
+        zones = if args.empty?
+                  Zone.find(:all)
+                else
+                  Zone.find_or_call(args) do |id|
+                    warn "Couldn't find zone #{id}"
+                  end
+                end
 
         render_table(zones, global_options)
       end

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

@@ -3,23 +3,15 @@ module Brightbox
     module Accounts
       def save_default_account(account_id)
         dirty! unless account_id == selected_config["default_account"]
-        selected_config['default_account'] = account_id
+
+        selected_config["default_account"] = account_id
       end
 
-      #
-      #
-      #
       def default_account
-        if selected_config
-          configured_default_account = selected_config["default_account"]
-          if configured_default_account && !configured_default_account.empty?
-            configured_default_account
-          else
-            nil
-          end
-        else
-          nil
-        end
+        return unless selected_config
+
+        configured_default_account = selected_config["default_account"]
+        return configured_default_account if configured_default_account && !configured_default_account.empty?
       end
 
       def determine_account(preferred_account)
@@ -44,19 +36,19 @@ module Brightbox
       def find_or_set_default_account
         # FIXME: API clients are scoped to their account so this code should
         #   never need to run for them.
-        unless default_account
-          begin
-            service = Fog::Compute.new(to_fog)
-            accounts = service.accounts
+        return if default_account
+
+        begin
+          service = Fog::Compute.new(to_fog)
+          accounts = service.accounts
 
-            @account = accounts.select { |acc| %w(pending active).include?(acc.status) }.first.id
-            save_default_account(@account) if @account
-          rescue Brightbox::BBConfigError
-            # We can't get a suitable fog connection so we can't select an
-            # account
-          rescue Excon::Errors::Unauthorized
-            # This is a helper, if it fails let the other code warn and prompt
-          end
+          @account = accounts.select { |acc| %w[pending active].include?(acc.status) }.first.id
+          save_default_account(@account) if @account
+        rescue Brightbox::BBConfigError
+          # We can't get a suitable fog connection so we can't select an
+          # account
+        rescue Excon::Errors::Unauthorized
+          # This is a helper, if it fails let the other code warn and prompt
         end
       end
     end

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

@@ -1,7 +1,7 @@
 module Brightbox
   module Config
     class ApiClient
-      NON_BLANK_KEYS = %w(api_url client_id secret)
+      NON_BLANK_KEYS = %w[api_url client_id secret].freeze
 
       attr_accessor :selected_config, :client_name
 
@@ -13,11 +13,11 @@ module Brightbox
       def to_fog
         check_required_params
         {
-          :provider => 'Brightbox',
-          :brightbox_api_url => selected_config['api_url'],
-          :brightbox_auth_url => selected_config['auth_url'] || selected_config['api_url'],
-          :brightbox_client_id => selected_config['client_id'],
-          :brightbox_secret => selected_config['secret'],
+          :provider => "Brightbox",
+          :brightbox_api_url => selected_config["api_url"],
+          :brightbox_auth_url => selected_config["auth_url"] || selected_config["api_url"],
+          :brightbox_client_id => selected_config["client_id"],
+          :brightbox_secret => selected_config["secret"],
           :persistent => persistent?
         }
       end
@@ -31,19 +31,15 @@ module Brightbox
       private
 
       def persistent?
-        if selected_config["persistent"] == "false"
-          false
-        else
-          true
-        end
+        selected_config["persistent"] != "false"
       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/authentication_tokens.rb

@@ -12,11 +12,10 @@ module Brightbox
         if defined?(@access_token) && !@access_token.nil?
           return @access_token
         end
-        if File.exist?(access_token_filename)
-          @access_token = cached_access_token
-        else
-          @access_token = nil
-        end
+
+        @access_token = if File.exist?(access_token_filename)
+                          cached_access_token
+                        end
       end
 
       def refresh_token_filename
@@ -28,11 +27,10 @@ module Brightbox
         if defined?(@refresh_token) && !@refresh_token.nil?
           return @refresh_token
         end
-        if File.exist?(refresh_token_filename)
-          @refresh_token = cached_refresh_token
-        else
-          @refresh_token = nil
-        end
+
+        @refresh_token = if File.exist?(refresh_token_filename)
+                           cached_refresh_token
+                         end
       end
 
       # @deprecation use access_token instead
@@ -70,6 +68,7 @@ module Brightbox
         # through the process.
         #
         password = options[:password] if options[:password]
+        one_time_password = options[:one_time_password] if options[:one_time_password]
 
         # To prevent refreshing tokens for the wrong client (using client_name
         # is pretty random) we set it specially
@@ -82,11 +81,15 @@ module Brightbox
             if refresh_token
               begin
                 service = update_tokens_with_refresh_token
-              rescue Excon::Errors::BadRequest, Excon::Errors::Unauthorized
+              rescue Fog::Brightbox::OAuth2::TwoFactorMissingError, Excon::Errors::BadRequest, Excon::Errors::Unauthorized
                 service = update_tokens_with_user_credentials
               end
             else
-              service = update_tokens_with_user_credentials(password)
+              begin
+                service = update_tokens_with_user_credentials(password: password, one_time_password: one_time_password)
+              rescue Fog::Brightbox::OAuth2::TwoFactorMissingError, Excon::Errors::BadRequest, Excon::Errors::Unauthorized
+                service = update_tokens_with_user_credentials(password: password)
+              end
             end
           else
             service = update_tokens_with_client_credentials
@@ -95,7 +98,6 @@ module Brightbox
           new_access_token = service.access_token
           new_refresh_token = service.refresh_token
           update_stored_tokens(new_access_token, new_refresh_token)
-
         rescue Excon::Errors::BadRequest, Excon::Errors::Unauthorized
           error "ERROR: Unable to reauthenticate!"
         ensure
@@ -115,7 +117,9 @@ module Brightbox
       # authenticate with the API.
       #
       def save_access_token(current_access_token)
-        if access_token != current_access_token
+        if access_token == current_access_token
+          debug "Access token remains #{access_token}"
+        else
           @access_token = current_access_token
           debug "Attempting to save new access token: #{current_access_token}"
           debug "In memory access token: #{@access_token}"
@@ -124,8 +128,6 @@ module Brightbox
           persist_token(access_token_filename, current_access_token)
 
           current_access_token
-        else
-          debug "Access token remains #{access_token}"
         end
       end
 
@@ -133,7 +135,9 @@ module Brightbox
       # request a new access token when current one has expired.
       #
       def save_refresh_token(current_token)
-        if refresh_token != current_token
+        if refresh_token == current_token
+          debug "Refresh token remains #{refresh_token}"
+        else
           @refresh_token = current_token
           debug "Attempting to save new refresh token: #{current_token}"
           debug "In memory refresh token: #{@refresh_token}"
@@ -142,8 +146,6 @@ module Brightbox
           persist_token(refresh_token_filename, current_token)
 
           current_token
-        else
-          debug "Refresh token remains #{refresh_token}"
         end
       end
 
@@ -177,32 +179,30 @@ module Brightbox
         connection
       end
 
-      # This asks the user to input their password
-      def prompt_for_password
-        require "highline"
-        highline = HighLine.new
-        highline.say("Your API credentials have expired, enter your password to update them.")
-        # FIXME: Capture interupts if user aborts
-        highline.ask("Enter your password : ") { |q| q.echo = false }
-      end
-
-      def update_tokens_with_user_credentials(password = nil)
+      def update_tokens_with_user_credentials(password: nil, one_time_password: nil)
         user_application = Brightbox::Config::UserApplication.new(selected_config, client_name)
 
-        password ||= gpg_password
-        password ||= password_helper_password
-        password ||= prompt_for_password
-
-        password = extend_with_two_factor_pin(password)
+        password = discover_password(password: password, expired: true)
 
         # FIXME: options are required to work
         options = {
           :client_id => client_name,
           :email => selected_config["username"],
-          :password => password
+          :password => password,
+          :one_time_password => one_time_password
         }
 
-        user_application.fetch_refresh_token(options)
+        begin
+          user_application.fetch_refresh_token(options)
+        rescue Fog::Brightbox::OAuth2::TwoFactorMissingError
+          options = {
+            :client_id => client_name,
+            :email => selected_config["username"],
+            :password => password,
+            :one_time_password => discover_two_factor_pin
+          }
+          user_application.fetch_refresh_token(options)
+        end
       end
 
       def fetch_refresh_token(options)
@@ -210,7 +210,7 @@ module Brightbox
         client_config = config[client_name]
         user_application = Brightbox::Config::UserApplication.new(client_config, client_name)
         # replace this portion with code that actually fetches a token
-        client_config['refresh_token'] = user_application.fetch_refresh_token(options)
+        client_config["refresh_token"] = user_application.fetch_refresh_token(options)
         save_refresh_token
       end
 
@@ -223,9 +223,7 @@ module Brightbox
       def persist_token(filename, token)
         token = "" if token.nil?
         # Write out a token file for this process
-        File.open(filename + ".#{$PID}", "w") do |f|
-          f.write token
-        end
+        File.write(filename + ".#{$PID}", token)
         # Move process version into place
         debug "Saving #{token} to #{filename}"
         FileUtils.mv filename + ".#{$PID}", filename
@@ -258,10 +256,9 @@ module Brightbox
         FileUtils.rm(refresh_token_filename) if File.exist?(refresh_token_filename)
       end
 
-      private
-
       def base_token_name
         return nil if client_name.nil?
+
         client_name.gsub("/", "_")
       end
     end

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

@@ -7,6 +7,7 @@ module Brightbox
 
       def cache_id(cid)
         return if cid.nil?
+
         unless File.exist?(cache_path)
           begin
             FileUtils.mkpath(cache_path)

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

@@ -8,11 +8,9 @@ module Brightbox
 
       # Is the currently selected config using user application details?
       def using_application?
-        if client_name
-          !config[client_name]["username"].nil?
-        else
-          raise NoSelectedClientError, NO_CLIENT_MESSAGE
-        end
+        raise NoSelectedClientError, NO_CLIENT_MESSAGE unless client_name
+
+        !config[client_name]["username"].nil?
       end
 
       # Does this config have multiple clients defined within?
@@ -31,6 +29,7 @@ module Brightbox
       #
       def client_alias
         return nil if selected_config.nil?
+
         # FIXME: The 'alias' field is redundant because we are using the section
         #   heading for the not ID value but we worry about it for now
         selected_config["alias"] || client_name
@@ -61,7 +60,7 @@ module Brightbox
       #
       def default_client
         @default_client ||= core_setting("default_client")
-      rescue
+      rescue StandardError
         nil
       end
 
@@ -76,6 +75,7 @@ module Brightbox
       def determine_client(preferred_client = nil)
         return preferred_client unless preferred_client.nil?
         return default_client unless default_client.nil?
+
         section_names.first unless section_names.empty?
         nil
       end
@@ -85,8 +85,8 @@ module Brightbox
       # If the prefix is in the client ID (identifier not alias) be +true+
       def config_identifier_match_prefix?(prefix)
         client_id = selected_config["client_id"]
-        !! /\A#{prefix}-.*/.match(client_id)
-      rescue
+        !!/\A#{prefix}-.*/.match(client_id)
+      rescue StandardError
         raise NoSelectedClientError, NO_CLIENT_MESSAGE
       end
     end