module AccessHelper - vps_cli-0.1.31 Documentation

decrypt(yaml_file:, path:) click to toggle source

uses an access file via SOPS SOPS is an encryption tool @see github.com/mozilla/sops It will decrypt the file, please use a .yaml file @param file [File]

The .yaml file encrypted with sops used to login to various accounts

@path [String] JSON formatted string to traverse

a yaml file tree
Example: "[\"github\"][\"username\"]"

@return [String] The value of key given in the .yaml file

# File lib/vps_cli/helpers/access_helper.rb, line 105
def decrypt(yaml_file:, path:)
  # puts all keys into a ["key"] within the array
  sops_cmd = "sops -d --extract '#{path}' #{yaml_file}"

  # this allows you to enter your passphrase
  export_tty
  # this will return in the string form the value you were looking for
  stdout, _stderr, _status = Open3.capture3(sops_cmd)

  stdout
end

dig_for_path(*path) click to toggle source

@param [#to_s, Array<#to_s>] The ordered path to traverse @return [String] Returns a path string to be able to traverse a yaml file @see VpsCli::Access#decrypt

# File lib/vps_cli/helpers/access_helper.rb, line 120
def dig_for_path(*path)
  path.flatten.inject('') do |final_path, node|
    final_path + "[#{node.to_s.to_json}]"
  end
end

export_tty() click to toggle source

I noticed needing to export $(tty) while troubleshooting issues with gpg keys. It is here just in case its not in your zshrc / bashrc file @return void

# File lib/vps_cli/helpers/access_helper.rb, line 130
def export_tty
  Rake.sh('GPG_TTY=$(tty) && export GPG_TTY')
end

heroku_api_string(yaml_file:) click to toggle source

retrieves the values of .netrc for heroku and creates a writable string @return [String] Returns the string to be written to netrc

# File lib/vps_cli/helpers/access_helper.rb, line 13
def heroku_api_string(yaml_file:)
  # initial tree traversal in the .yaml file
  heroku_api = %i[heroku api]
  heroku_api_keys = %i[machine login password]

  make_string(base: heroku_api, keys: heroku_api_keys) do |path|
    decrypt(yaml_file: yaml_file, path: path)
  end
end

heroku_git_string(yaml_file:) click to toggle source

retries the git values for heroku in your .yaml file @return [String] Returns the string to be written to your netrc file

# File lib/vps_cli/helpers/access_helper.rb, line 25
def heroku_git_string(yaml_file:)
  heroku_git = %i[heroku git]
  heroku_git_keys = %i[machine login password]

  make_string(base: heroku_git, keys: heroku_git_keys) do |path|
    decrypt(yaml_file: yaml_file, path: path)
  end
end

make_string(base:, keys:) { |path| ... } click to toggle source

Creates a string to be used to write to .netrc @param base [String] Provides the base string from which to add to @param keys [Array<String>] An array of strings to append to base @return [String] Returns the string after concatenating them

# File lib/vps_cli/helpers/access_helper.rb, line 57
def make_string(base:, keys:)
  # iterates through the keys to provide a path to each array
  # essentialy is the equivalent of Hash.dig(:heroku, :api, :key)
  my_inject_with_count(keys) do |string, key, count|
    path = dig_for_path(base, key)

    value = yield(path)
    value << "\n  " if count < keys.length - 1
    string + value
  end
end

my_inject_with_count(array) { |accum, element, count| ... } click to toggle source

my version of Enumerable#inject intended to return a string provides a count to know what # object youre on @param array [Array<#to_s>]

For each element in the array, yield to the block given.

@yieldparam accum [String]

The value that will persist throughout the block

@yieldparam element [String] The current element in the array @yield param count [Integer] @return [String] Returns the string returned by the block passed to it

# File lib/vps_cli/helpers/access_helper.rb, line 43
def my_inject_with_count(array)
  value = nil
  count = 0
  array.inject('') do |accum, element|
    value = yield(accum, element, count)
    count += 1
    value # if not here, returns the value of count
  end
end

netrc_error(netrc_file:, error:) click to toggle source

Adds the error to VpsCli#errors array @param [File] Location of netrc_file @param [Exception] The error to write to the array @return void

# File lib/vps_cli/helpers/access_helper.rb, line 90
def netrc_error(netrc_file:, error:)
  error_msg = "Unable to write to your #{netrc_file}."
  VpsCli.errors << error.exception(error_msg)
end

write_to_netrc(netrc_file: nil, string:) click to toggle source

Writes the value of string to netrc @param netrc_file [File] ($HOME/.netrc)

The location of your .netrc file to be read by heroku

@param string [String] The String to write to the netrc file @return void

# File lib/vps_cli/helpers/access_helper.rb, line 74
def write_to_netrc(netrc_file: nil, string:)
  netrc_file ||= File.join(Dir.home, '.netrc')
  Rake.mkdir_p(File.dirname(netrc_file))
  Rake.touch(netrc_file) unless File.exist?(netrc_file)

  begin
    File.write(netrc_file, string)
  rescue Errno::EACCES => e
    netrc_error(netrc_file: netrc_file, error: e)
  end
end