awskeyring 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45a2721acc4cc5f198c2bf55ee253dcb9f519093
-  data.tar.gz: 6ea5cdc339047ba1e057a46a8733d90ea5af77da
+  metadata.gz: 1e7e03d81e3086c6acea16f7eb514d1d52066bb5
+  data.tar.gz: 7af0c1e501fd4f11e331f6abec07329c997e0a47
 SHA512:
-  metadata.gz: 0ae669db134da8e9ba7ecff535bb3e3410e6f314358a818a925761e500f3eac220f63bd740ec72906c83040357dd324495c307550f30b91a4f7aab61834a4eee
-  data.tar.gz: 6b005ea78e4fb94f21566edc1c702d75c8e5f2308b21f8bac6fd02329332e0dbd71394d301bf2852c6f82aa2df42dc7b7ffbb6229fdd21ca9a618e90f7a15f04
+  metadata.gz: d067652302c5c5e43e4975c392f880d373f61ca989c644a7c2fd473bd42c0723cbfc2cd041cc12c73a3add31752155ed8dd8bf15f71beb429e1b10f84edd81a4
+  data.tar.gz: 8f3434517adcbdf5185c315b1f33ae250d08dd56cb74e18c7d28397a3dd828fb6ce4209c28d9d6104f0085f34bb29c4f80c47e70d358e9e4cf54857f67bfb80a

data/.rubocop.yml

@@ -1,13 +1,6 @@
-Metrics/AbcSize:
-  Max: 31
-
 Metrics/LineLength:
   Max: 120
 
-Metrics/ClassLength:
-  Exclude:
-    - lib/awskeyring_command.rb
-    
 Metrics/MethodLength:
   Max: 16
 

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+os: osx
 rvm:
-  - 2.0.0
-before_install: gem install bundler -v 1.11.2
+  - 2.3.3
+before_install: gem install bundler

data/CODE_OF_CONDUCT.md

@@ -1,24 +1,41 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -26,24 +43,31 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
 
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at tristanmorgan@users.noreply.github.com. All
+reported by contacting the project team at [tristan@vibrato.com.au]. All
 complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[homepage]: https://www.contributor-covenant.org

data/README.md

@@ -1,7 +1,21 @@
 # Awskeyring
 
+* [![Build Status](https://travis-ci.org/vibrato/awskeyring.svg?branch=master)](https://travis-ci.org/vibrato/awskeyring)
+* [![Gem Version](https://badge.fury.io/rb/awskeyring.svg)](https://badge.fury.io/rb/awskeyring)
+* [![license MIT](http://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+* [![All Downloads](http://ruby-gem-downloads-badge.herokuapp.com/awskeyring?type=total)](https://rubygems.org/gems/awskeyring)
+* [![Version Downloads](http://ruby-gem-downloads-badge.herokuapp.com/awskeyring?label=downloads-current-version)](https://rubygems.org/gems/awskeyring)
+
 Awskeyring is a small tool to manage AWS account keys in the macOS Keychain.
 
+## Motivation
+
+The motivation of this application is to provide a local secure store of AWS
+credentials using specifically in the macOS Keychain, to have them easily accessed
+from the Terminal, and to provide useful functions like assuming roles.
+For Enterprise environments there are better suited tools to use
+like [HashiCorp Vault](https://vaultproject.io/).
+
 ## Installation
 
 Install it with:
@@ -10,7 +24,7 @@ Install it with:
 
 ## Usage
 
-The CLI is using [Thor](http://whatisthor.com) with help provided interactivly.
+The CLI is using [Thor](http://whatisthor.com) with help provided interactively.
 
     Commands:
     awskeyring --version, -v               # Prints the version
@@ -28,22 +42,21 @@ The CLI is using [Thor](http://whatisthor.com) with help provided interactivly.
 
 and autocomplete that can be installed with:
 
-    $ complete -C /usr/local/bin/aws-creds aws-creds
+    $ complete -C /usr/local/bin/awskeyring awskeyring
 
-To set your environment easily the following function helps:
+To set your environment easily the following bash function helps:
 
     awsenv() { eval "$(awskeyring env $1)"; }
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec awskeyring` to use the gem in this directory, ignoring other installed copies of this gem.
+After checking out the repo, run `bundle update` to install dependencies. Then, run `rake` to run the tests. Run `bundle exec awskeyring` to use the gem in this directory, ignoring other installed copies of this gem.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tristanmorgan/awskeyring. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/vibrato/awskeyring. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/awskeyring.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |spec|
   spec.name          = 'awskeyring'
   spec.version       = Awskeyring::VERSION
   spec.authors       = ['Tristan Morgan']
-  spec.email         = ['tristanmorgan@users.noreply.github.com']
+  spec.email         = ['tristan@vibrato.com.au']
 
-  spec.summary       = 'Manages AWS credentials in the OS X keychain'
-  spec.description   = 'Manages AWS credentials in the OS X keychain'
-  spec.homepage      = 'https://github.com/tristanmorgan/awskeyring'
+  spec.summary       = 'Manages AWS credentials in the macOS keychain'
+  spec.description   = 'Manages AWS credentials in the macOS keychain'
+  spec.homepage      = 'https://github.com/vibrato/awskeyring'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/awskeyring/version.rb

@@ -1,3 +1,3 @@
 module Awskeyring
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/lib/awskeyring.rb

@@ -1,8 +1,6 @@
 require 'keychain'
 require 'aws-sdk-iam'
 
-require 'awskeyring/version'
-
 # Aws Key-ring logical object,
 # gives you an interface to access keychains and items.
 module Awskeyring
@@ -76,15 +74,15 @@ module Awskeyring
     )
   end
 
-  def self.add_pair(account:, key:, secret:, token:, expiry:, role:)
-    all_items.create(label: "session-key #{account}",
-                     account: key,
-                     password: secret,
-                     comment: "#{ROLE_PREFIX}#{role}")
-    all_items.create(label: "session-token #{account}",
-                     account: expiry,
-                     password: token,
-                     comment: "#{ROLE_PREFIX}#{role}")
+  def self.add_pair(params = {})
+    all_items.create(label: "session-key #{params[:account]}",
+                     account: params[:key],
+                     password: params[:secret],
+                     comment: "#{ROLE_PREFIX}#{params[:role]}")
+    all_items.create(label: "session-token #{params[:account]}",
+                     account: params[:expiry],
+                     password: params[:token],
+                     comment: "#{ROLE_PREFIX}#{params[:role]}")
   end
 
   def self.get_item(account)

data/lib/awskeyring_command.rb

@@ -6,9 +6,10 @@ require 'open-uri'
 require 'thor'
 
 require_relative 'awskeyring'
+require 'awskeyring/version'
 
 # AWS Key-ring command line interface.
-class AwskeyringCommand < Thor
+class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   map %w[--version -v] => :__version
   map ['ls'] => :list
   map ['lsr'] => :list_role
@@ -22,14 +23,13 @@ class AwskeyringCommand < Thor
 
   desc 'initialise', 'Initialises a new KEYCHAIN'
   method_option :keychain, type: :string, aliases: '-n', desc: 'Name of KEYCHAIN to initialise.'
-  def initialise
+  def initialise # rubocop:disable  Metrics/AbcSize
     unless Awskeyring.prefs.empty?
       puts "#{Awskeyring::PREFS_FILE} exists. no need to initialise."
       exit 1
     end
 
-    keychain ||= options[:keychain]
-    keychain ||= ask(message: "Name for new keychain (default: 'awskeyring')")
+    keychain = ask_missing(existing: options[:keychain], message: "Name for new keychain (default: 'awskeyring')")
     keychain = 'awskeyring' if keychain.empty?
 
     puts 'Creating a new Keychain, you will be prompted for a password for it.'
@@ -55,7 +55,7 @@ class AwskeyringCommand < Thor
 
   desc 'env ACCOUNT', 'Outputs bourne shell environment exports for an ACCOUNT'
   def env(account = nil)
-    account ||= ask(message: 'account name')
+    account = ask_missing(existing: account, message: 'account name')
     cred, temp_cred = get_valid_item_pair(account: account)
     token = temp_cred.password unless temp_cred.nil?
     put_env_string(
@@ -71,13 +71,10 @@ class AwskeyringCommand < Thor
   method_option :secret, type: :string, aliases: '-s', desc: 'AWS account secret.'
   method_option :mfa, type: :string, aliases: '-m', desc: 'AWS virtual mfa arn.'
   def add(account = nil)
-    account ||= ask(message: 'account name')
-    key ||= options[:key]
-    key ||= ask(message: 'access key id')
-    secret ||= options[:secret]
-    secret ||= ask(message: 'secret access key', secure: true)
-    mfa ||= options[:mfa]
-    mfa ||= ask(message: 'mfa arn', optional: true)
+    account = ask_missing(existing: account, message: 'account name')
+    key = ask_missing(existing: options[:key], message: 'access key id')
+    secret = ask_missing(existing: options[:secret], message: 'secret access key', secure: true)
+    mfa = ask_missing(existing: options[:mfa], message: 'mfa arn', optional: true)
 
     Awskeyring.add_item(
       account: account,
@@ -91,10 +88,9 @@ class AwskeyringCommand < Thor
   desc 'add-role ROLE', 'Adds a ROLE to the keyring'
   method_option :arn, type: :string, aliases: '-a', desc: 'AWS role arn.'
   def add_role(role = nil)
-    role ||= ask(message: 'role name')
-    arn ||= options[:arn]
-    arn ||= ask(message: 'role arn')
-    account ||= ask(message: 'account', optional: true)
+    role = ask_missing(existing: role, message: 'role name')
+    arn = ask_missing(existing: options[:arn], message: 'role arn')
+    account = ask_missing(existing: account, message: 'account', optional: true)
 
     Awskeyring.add_role(
       role: role,
@@ -105,7 +101,7 @@ class AwskeyringCommand < Thor
 
   desc 'remove ACCOUNT', 'Removes an ACCOUNT from the keyring'
   def remove(account = nil)
-    account ||= ask(message: 'account name')
+    account = ask_missing(existing: account, message: 'account name')
     cred, temp_cred = get_valid_item_pair(account: account)
     Awskeyring.delete_pair(cred, temp_cred, "# Removing account #{account}")
   end
@@ -113,7 +109,7 @@ class AwskeyringCommand < Thor
   map 'remove-role' => :remove_role
   desc 'remove-role ROLE', 'Removes a ROLE from the keyring'
   def remove_role(role = nil)
-    role ||= ask(message: 'role name')
+    role = ask_missing(existing: role, message: 'role name')
     item_role = Awskeyring.get_role(role)
     Awskeyring.delete_pair(item_role, nil, "# Removing role #{role}")
   end
@@ -122,8 +118,8 @@ class AwskeyringCommand < Thor
   method_option :role, type: :string, aliases: '-r', desc: 'The ROLE to assume.'
   method_option :code, type: :string, aliases: '-c', desc: 'Virtual mfa CODE.'
   method_option :duration, type: :string, aliases: '-d', desc: 'Session DURATION in seconds.'
-  def token(account = nil, role = nil, code = nil)
-    account ||= ask(message: 'account name')
+  def token(account = nil, role = nil, code = nil) # rubocop:disable all
+    account = ask_missing(existing: account, message: 'account name')
     role ||= options[:role]
     code ||= options[:code]
     duration = options[:duration]
@@ -184,8 +180,8 @@ class AwskeyringCommand < Thor
   end
 
   desc 'console ACCOUNT', 'Open the AWS Console for the ACCOUNT'
-  def console(account = nil)
-    account ||= ask(message: 'account name')
+  def console(account = nil) # rubocop:disable all
+    account = ask_missing(existing: account, message: 'account name')
     cred, temp_cred = get_valid_item_pair(account: account)
     token = temp_cred.password unless temp_cred.nil?
 
@@ -246,17 +242,19 @@ class AwskeyringCommand < Thor
     comp_len = comp_line.split.length
     comp_len += 1 if curr == ''
 
-    case comp_len
+    comp_len = 2 if prev == 'help'
+    comp_len = 4 if prev == 'remove-role'
+    print_auto_resp(curr, comp_len)
+  end
+
+  private
+
+  def print_auto_resp(curr, len) # rubocop:disable  Metrics/AbcSize
+    case len
     when 2
       puts list_commands.select { |elem| elem.start_with?(curr) }.join("\n")
     when 3
-      if prev == 'help'
-        puts list_commands.select { |elem| elem.start_with?(curr) }.join("\n")
-      elsif prev == 'remove-role'
-        puts Awskeyring.list_role_names.select { |elem| elem.start_with?(curr) }.join("\n")
-      else
-        puts Awskeyring.list_item_names.select { |elem| elem.start_with?(curr) }.join("\n")
-      end
+      puts Awskeyring.list_item_names.select { |elem| elem.start_with?(curr) }.join("\n")
     when 4
       puts Awskeyring.list_role_names.select { |elem| elem.start_with?(curr) }.join("\n")
     else
@@ -264,8 +262,6 @@ class AwskeyringCommand < Thor
     end
   end
 
-  private
-
   def list_commands
     self.class.all_commands.keys.map { |elem| elem.tr('_', '-') }
   end
@@ -302,6 +298,10 @@ class AwskeyringCommand < Thor
     end
   end
 
+  def ask_missing(existing:, message:, secure: false, optional: false)
+    existing || ask(message: message, secure: secure, optional: optional)
+  end
+
   def ask(message:, secure: false, optional: false)
     if secure
       HighLine.new.ask(message.rjust(20) + ': ') { |q| q.echo = '*' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awskeyring
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tristan Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-25 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-iam
@@ -122,9 +122,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Manages AWS credentials in the OS X keychain
+description: Manages AWS credentials in the macOS keychain
 email:
-- tristanmorgan@users.noreply.github.com
+- tristan@vibrato.com.au
 executables:
 - awskeyring
 extensions: []
@@ -144,7 +144,7 @@ files:
 - lib/awskeyring.rb
 - lib/awskeyring/version.rb
 - lib/awskeyring_command.rb
-homepage: https://github.com/tristanmorgan/awskeyring
+homepage: https://github.com/vibrato/awskeyring
 licenses:
 - MIT
 metadata: {}
@@ -167,5 +167,5 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Manages AWS credentials in the OS X keychain
+summary: Manages AWS credentials in the macOS keychain
 test_files: []