awskeyring 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cc56e9c03339dd2516abf62a94d07dcccef3b50
-  data.tar.gz: d568b27b9b8648cfc5e72bc2aa033397d21163f3
+  metadata.gz: c52288c55a349f5e4bea3c89a39752efe70fe778
+  data.tar.gz: 05e3ca54d599fc277f5b24bda0d133c76495a0c7
 SHA512:
-  metadata.gz: c153176f3d556eecd47ecd3dc7d1b825a187913e82a41f17e1fc514d9dc3ea49bf80d7f1cb624d6737c10199c1e7b4c1521eb809699be5ef30dba0ee0b318633
-  data.tar.gz: c6ec6d01d3ecaaf7c9bb3a22dc0ec361485f5fe1f864174cd43420923fd0ebf6a80cfb26592f970e771612ef84943e10b7c98af9a9a9810afa5b5b60e046006f
+  metadata.gz: c2704ef84b7221d35d351784fca20f4297257d9a5a6a5f70c829135163704f4ff08baa9e289f73650d7ed5da301a5bf4413617835feb5d21093987cdfc3a2174
+  data.tar.gz: 2d84f66fa5caa38b241c08d2541722ecbfcfec0c20adc2d3612d960ce5aecaca598c3e05d43d711bc37b7e54025ad5e48541c0993c4033ff95a67e35111e79b7

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [v0.5.3](https://github.com/vibrato/awskeyring/tree/v0.5.3) (2018-10-04)
+[Full Changelog](https://github.com/vibrato/awskeyring/compare/v0.5.2...v0.5.3)
+
+**Implemented enhancements:**
+
+- Console favourites [\#31](https://github.com/vibrato/awskeyring/pull/31) ([tristanmorgan](https://github.com/tristanmorgan))
+
 ## [v0.5.2](https://github.com/vibrato/awskeyring/tree/v0.5.2) (2018-09-18)
 [Full Changelog](https://github.com/vibrato/awskeyring/compare/v0.5.1...v0.5.2)
 

data/lib/awskeyring.rb

@@ -14,8 +14,12 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   SESSION_KEY_PREFIX = 'session-key '.freeze
   # Prefix for Session Tokens
   SESSION_TOKEN_PREFIX = 'session-token '.freeze
+  # Default keychain Lock period
+  FIVE_MINUTES = 300
   # Default warning of key age in days.
   DEFAULT_KEY_AGE = 90
+  # Default Console Paths
+  DEFAULT_CONSOLE_LIST = %w[cloudformation ec2/v2 iam rds route53 s3 sns sqs vpc].freeze
 
   # Retrieve the preferences
   #
@@ -29,14 +33,17 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # Create a new Keychain
+  #
+  # @param [String] awskeyring The keychain name to create
   def self.init_keychain(awskeyring:)
     keychain = Keychain.create(awskeyring)
-    keychain.lock_interval = 300
+    keychain.lock_interval = FIVE_MINUTES
     keychain.lock_on_sleep = true
 
     prefs = {
       awskeyring: awskeyring,
-      keyage: DEFAULT_KEY_AGE
+      keyage: DEFAULT_KEY_AGE,
+      console: DEFAULT_CONSOLE_LIST
     }
     File.new(Awskeyring::PREFS_FILE, 'w').write JSON.dump(prefs)
   end
@@ -51,7 +58,7 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
     end
 
     keychain = Keychain.open(prefs['awskeyring'])
-    warn I18n.t('message.timeout') if keychain && keychain.lock_interval > 300
+    warn I18n.t('message.timeout') if keychain && keychain.lock_interval > FIVE_MINUTES
 
     keychain
   end
@@ -78,6 +85,11 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # Add an account item
+  #
+  # @param [String] account The account name to create
+  # @param [String] key The aws_access_key_id
+  # @param [String] secret The aws_secret_key
+  # @param [String] mfa The arn of the MFA device
   def self.add_account(account:, key:, secret:, mfa:)
     all_items.create(
       label: ACCOUNT_PREFIX + account,
@@ -88,6 +100,10 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # update and account item
+  #
+  # @param [String] account The account to update
+  # @param [String] key The aws_access_key_id
+  # @param [String] secret The aws_secret_key
   def self.update_account(account:, key:, secret:)
     item = get_item(account: account)
     item.attributes[:account] = key
@@ -96,6 +112,10 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # Add a Role item
+  #
+  # @param [String] role The role name to add
+  # @param [String] arn The arn of the role
+  # @param [String] account The account associate (optional)
   def self.add_role(role:, arn:, account:)
     all_items.create(
       label: ROLE_PREFIX + role,
@@ -106,6 +126,14 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # add a session token pair of items
+  #
+  # @param [Hash] params including
+  #    account The name of the accont
+  #    key The aws_access_key_id
+  #    secret The aws_secret_access_key
+  #    token The aws_sesson_token
+  #    expiry time of expiry
+  #    role The role used
   def self.add_token(params = {})
     all_items.create(label: SESSION_KEY_PREFIX + params[:account],
                      account: params[:key],
@@ -144,6 +172,16 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
     list_roles.map { |elem| elem.attributes[:label][(ROLE_PREFIX.length)..-1] }
   end
 
+  # Return a list of console paths
+  def self.list_console_path
+    prefs.key?('console') ? prefs['console'] : DEFAULT_CONSOLE_LIST
+  end
+
+  # Return Key age warning number
+  def self.key_age
+    prefs.key?('keyage') ? prefs['keyage'] : DEFAULT_KEY_AGE
+  end
+
   # Return a session token if available or a static key
   private_class_method def self.get_valid_item_pair(account:, no_token: false)
     session_key, session_token = get_token_pair(account: account)
@@ -163,6 +201,9 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # Return valid creds for account
+  #
+  # @param [String] account The account to retrieve
+  # @param [Boolean] no_token Flag to skip tokens
   def self.get_valid_creds(account:, no_token: false)
     cred, temp_cred = get_valid_item_pair(account: account, no_token: no_token)
     token = temp_cred.password unless temp_cred.nil?
@@ -179,6 +220,8 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # get the ARN for a role
+  #
+  # @param [String] role_name The role name to retrieve
   def self.get_role_arn(role_name:)
     role_item = get_role(role_name: role_name)
     role_item.attributes[:account] if role_item
@@ -205,12 +248,18 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # Delete a session token
+  #
+  # @param [String] account The account to delete a token for
+  # @param [String] message The message to display
   def self.delete_token(account:, message:)
     session_key, session_token = get_token_pair(account: account)
     delete_pair(key: session_key, token: session_token, message: message)
   end
 
   # Delete an Account
+  #
+  # @param [String] account The account to delete
+  # @param [String] message The message to display
   def self.delete_account(account:, message:)
     delete_token(account: account, message: I18n.t('message.delexpired'))
     cred = get_item(account: account)
@@ -221,6 +270,9 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   end
 
   # Delete a role
+  #
+  # @param [String] role_name The role to delete
+  # @param [String] message The message to display
   def self.delete_role(role_name:, message:)
     role = get_role(role_name: role_name)
     return unless role

data/lib/awskeyring/version.rb

@@ -1,4 +1,4 @@
 module Awskeyring
   # The Gems version number
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.5.3'.freeze
 end

data/lib/awskeyring_command.rb

@@ -360,7 +360,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   def age_check_and_get(account:, no_token:)
     cred = Awskeyring.get_valid_creds(account: account, no_token: no_token)
 
-    maxage = Awskeyring.prefs[:keyage] || Awskeyring::DEFAULT_KEY_AGE
+    maxage = Awskeyring.key_age
     age = (Time.new - cred[:updated]).div Awskeyring::Awsapi::ONE_DAY
     warn I18n.t('message.age_check', account: account, age: age) unless age < maxage
 
@@ -378,6 +378,8 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
       comp_len = 0
     when 'remove-role', '-r', 'rmr'
       comp_len = 2
+    when '--path', '-p'
+      comp_len = 4
     end
 
     [curr, comp_len, sub_cmd]
@@ -404,6 +406,8 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
       list = Awskeyring.list_role_names
     when 3
       list = list_arguments(command: sub_cmd)
+    when 4
+      list = Awskeyring.list_console_path
     else
       exit 1
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awskeyring
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Tristan Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-iam