Class: SecretConfig::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/secret_config/cli.rb

Constant Summary collapse

PROVIDERS = 
i[ssm].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ CLI

Returns a new instance of CLI.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/secret_config/cli.rb', line 24

def initialize(argv)
  @export       = false
  @import       = false
  @path         = nil
  @key_id       = nil
  @region       = ENV['AWS_REGION']
  @provider     = :ssm
  @random_size  = 32
  @no_filter    = false
  @prune        = false
  @replace      = false
  @copy_path    = nil
  @show_version = false
  @console      = false

  if argv.empty?
    puts parser
    exit(-10)
  end
  parser.parse!(argv)
end

Instance Attribute Details

#console ⇒ Object (readonly)

Returns the value of attribute console.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def console
  @console
end

#copy_path ⇒ Object (readonly)

Returns the value of attribute copy_path.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def copy_path
  @copy_path
end

#export ⇒ Object (readonly)

Returns the value of attribute export.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def export
  @export
end

#import ⇒ Object (readonly)

Returns the value of attribute import.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def import
  @import
end

#key_id ⇒ Object (readonly)

Returns the value of attribute key_id.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def key_id
  @key_id
end

#no_filter ⇒ Object (readonly)

Returns the value of attribute no_filter.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def no_filter
  @no_filter
end

#overwrite ⇒ Object (readonly)

Returns the value of attribute overwrite.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def overwrite
  @overwrite
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def path
  @path
end

#provider ⇒ Object (readonly)

Returns the value of attribute provider.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def provider
  @provider
end

#prune ⇒ Object (readonly)

Returns the value of attribute prune.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def prune
  @prune
end

#random_size ⇒ Object (readonly)

Returns the value of attribute random_size.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def random_size
  @random_size
end

#region ⇒ Object (readonly)

Returns the value of attribute region.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def region
  @region
end

#show_version ⇒ Object (readonly)

Returns the value of attribute show_version.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def show_version
  @show_version
end

Class Method Details

.run!(argv) ⇒ Object 



20
21
22
 
# File 'lib/secret_config/cli.rb', line 20

def self.run!(argv)
  new(argv).run!
end

Instance Method Details

#parser ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/secret_config/cli.rb', line 63

def parser
  @parser ||= OptionParser.new do |opts|
    opts.banner = "      Secret Config v\#{VERSION}\n\n        For more information, see: https://rocketjob.github.io/secret_config/\n\n      secret_config [options]\n    BANNER\n\n    opts.on '-e', '--export [FILE_NAME]', 'Export configuration to a file or stdout if no file_name supplied.' do |file_name|\n      @export = file_name || STDOUT\n    end\n\n    opts.on '-i', '--import [FILE_NAME]', 'Import configuration from a file or stdin if no file_name supplied.' do |file_name|\n      @import = file_name || STDIN\n    end\n\n    opts.on '-c', '--copy SOURCE_PATH', 'Import configuration from a file or stdin if no file_name supplied.' do |path|\n      @copy_path = path\n    end\n\n    opts.on '-i', '--console', 'Start interactive console.' do\n      @console = true\n    end\n\n    opts.on '-p', '--path PATH', 'Path to import from / export to.' do |path|\n      @path = path\n    end\n\n    opts.on '-P', '--provider PROVIDER', 'Provider to use. [ssm | file]. Default: ssm' do |provider|\n      @provider = provider.to_sym\n    end\n\n    opts.on '-U', '--no-filter', 'Do not filter passwords and keys.' do\n      @no_filter = true\n    end\n\n    # TODO:\n    # opts.on '-Q', '--prune', 'During import delete all existing keys for which their is no key in the import file' do\n    #   @prune = true\n    # end\n    #\n    # opts.on '-r', '--replace', 'During import replace existing keys if present' do\n    #   @replace = true\n    # end\n\n    opts.on '-k', '--key_id KEY_ID', 'AWS KMS Key id or Key Alias to use when importing configuration values. Default: AWS Default key.' do |key_id|\n      @key_id = key_id\n    end\n\n    opts.on '-r', '--region REGION', 'AWS Region to use. Default: AWS_REGION env var.' do |region|\n      @region = region\n    end\n\n    opts.on '-R', '--random_size INTEGER', 'Size to use when generating random values. Whenever $random is encountered during an import. Default: 32' do |region|\n      @random_size = random_size\n    end\n\n    opts.on '-v', '--version', 'Display Symmetric Encryption version.' do\n      @show_version = true\n    end\n\n    opts.on('-h', '--help', 'Prints this help.') do\n      puts opts\n      exit\n    end\n  end\nend\n"

#run! ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/secret_config/cli.rb', line 46

def run!
  if show_version
    puts "Secret Config v#{VERSION}"
    puts "Region: #{region}"
  elsif console
    run_console
  elsif export
    run_export(export, filtered: !no_filter)
  elsif import
    run_import(import)
  elsif copy_path
    run_copy(copy_path, path)
  else
    puts parser
  end
end