secret_hub 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f49eb823e6839d1fcdd99c1b06dc18fa0c0bcae324228a8a024c24e8743c2b
-  data.tar.gz: b649439d4b9a740c6a2cbe2ad7f85aaf52cd23cba4287b47e6f6b5d013831055
+  metadata.gz: 6395f8f799ffb59615d0c926519b74bc6c924c2696841a16f847f14e1750988c
+  data.tar.gz: 57a8dd0b5de09ea6ff62084a269e882a57a8197736e87a8caeeeed236ecb2817
 SHA512:
-  metadata.gz: 10c662e3948d97f76be14de4afdf66d97a163b1449852261f0c10410b281bce3b205a3c3d3108b286b8e92ac34aa047983fac84ed9bd007b2ffa49001f518cea
-  data.tar.gz: 565e5a95d926b8a78f8299fc3eb49ec36156a3013d98edce0d313929d60742ceea6ec1dc127460b3c95aa340aa4da6a8aa7b30753d25f69a3f00fa6020066e5d
+  metadata.gz: 385b7a968fbb014cfa1166e69dfa7c189af538d98e87f9df9ceaf07bd41f64137ae503732a2b25939edb71c9ee44cba811d5df2fe0ec53bcad7c557ed07d4049
+  data.tar.gz: 28994ec833f8cc308823e300922f28c132b184a7fe105d24c84f0c7e29a41a70525fe109d49ba9600c38427d02b03bc4b84d3e33a7bbda6c8d425649241ee377

data/README.md

@@ -61,7 +61,7 @@ Run secrethub COMMAND --help for command specific help
 $ secrethub repo
 Usage:
   secrethub repo list REPO
-  secrethub repo save REPO KEY VALUE
+  secrethub repo save REPO KEY [VALUE]
   secrethub repo delete REPO KEY
   secrethub repo (-h|--help)
 
@@ -69,7 +69,7 @@ Usage:
 $ secrethub org
 Usage:
   secrethub org list ORG
-  secrethub org save ORG KEY VALUE
+  secrethub org save ORG KEY [VALUE]
   secrethub org delete ORG KEY
   secrethub org (-h|--help)
 

data/bin/secrethub

@@ -8,12 +8,12 @@ router = SecretHub::CLI.router
 
 begin
   exit router.run ARGV
-rescue Interrupt => e
+rescue Interrupt
   say "\nGoodbye"
   exit 1
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!txtred!#{e.class}"
+  say! "rib` #{e.class}`"
   say! e.message
   exit 1
-end
+end

data/lib/secret_hub/cli.rb

@@ -8,8 +8,8 @@ module SecretHub
   class CLI
     def self.router
       router = MisterBin::Runner.new version: VERSION,
-        header: "GitHub Secret Manager",
-        footer: "Run !txtpur!secrethub COMMAND --help!txtrst! for command specific help"
+        header: 'GitHub Secret Manager',
+        footer: 'Run m`secrethub COMMAND --help` for command specific help'
 
       router.route 'repo',   to: Commands::Repo
       router.route 'org',    to: Commands::Org
@@ -18,5 +18,4 @@ module SecretHub
       router
     end
   end
-
 end

data/lib/secret_hub/commands/base.rb

@@ -10,7 +10,6 @@ module SecretHub
       def github
         @github ||= GitHubClient.new
       end
-
     end
   end
-end
+end

data/lib/secret_hub/commands/bulk.rb

@@ -6,45 +6,46 @@ module SecretHub
     class Bulk < Base
       using StringObfuscation
 
-      summary "Manage multiple secrets in multiple repositories"
-      
-      usage "secrethub bulk init [CONFIG]"
-      usage "secrethub bulk show [CONFIG --visible]"
-      usage "secrethub bulk list [CONFIG]"
-      usage "secrethub bulk save [CONFIG --clean --dry --only REPO]"
-      usage "secrethub bulk clean [CONFIG --dry]"
-      usage "secrethub bulk (-h|--help)"
-
-      command "init", "Create a sample configuration file in the current directory"
-      command "show", "Show the configuration file"
-      command "save", "Save multiple secrets to multiple repositories"
-      command "clean", "Delete secrets from multiple repositories unless they are specified in the config file"
-      command "list", "Show all secrets in all repositories"
-
-      option "-c, --clean", "Also delete any other secret not defined in the configuration file"
-      option "-v, --visible", "Also show secret values"
-      option "-d, --dry", "Dry run"
-      option "-o, --only REPO", "Save all secrets to a single repository from the configuration file"
-
-      param "CONFIG", "Path to the configuration file [default: secrethub.yml]"
-            
-      example "secrethub bulk init"
-      example "secrethub bulk show --visible"
-      example "secrethub bulk clean"
-      example "secrethub bulk list mysecrets.yml"
-      example "secrethub bulk save mysecrets.yml --dry"
-      example "secrethub bulk save --clean"
-      example "secrethub bulk save --only me/my-important-repo"
+      summary 'Manage multiple secrets in multiple repositories'
+
+      usage 'secrethub bulk init [CONFIG]'
+      usage 'secrethub bulk show [CONFIG --visible]'
+      usage 'secrethub bulk list [CONFIG]'
+      usage 'secrethub bulk save [CONFIG --clean --dry --only REPO]'
+      usage 'secrethub bulk clean [CONFIG --dry]'
+      usage 'secrethub bulk (-h|--help)'
+
+      command 'init', 'Create a sample configuration file in the current directory'
+      command 'show', 'Show the configuration file'
+      command 'save', 'Save multiple secrets to multiple repositories'
+      command 'clean', 'Delete secrets from multiple repositories unless they are specified in the config file'
+      command 'list', 'Show all secrets in all repositories'
+
+      option '-c, --clean', 'Also delete any other secret not defined in the configuration file'
+      option '-v, --visible', 'Also show secret values'
+      option '-d, --dry', 'Dry run'
+      option '-o, --only REPO', 'Save all secrets to a single repository from the configuration file'
+
+      param 'CONFIG', 'Path to the configuration file [default: secrethub.yml]'
+
+      example 'secrethub bulk init'
+      example 'secrethub bulk show --visible'
+      example 'secrethub bulk clean'
+      example 'secrethub bulk list mysecrets.yml'
+      example 'secrethub bulk save mysecrets.yml --dry'
+      example 'secrethub bulk save --clean'
+      example 'secrethub bulk save --only me/my-important-repo'
 
       def init_command
         raise SecretHubError, "File #{config_file} already exists" if File.exist? config_file
+
         FileUtils.cp config_template, config_file
-        say "!txtgrn!Saved #{config_file}"
+        say "Saved g`#{config_file}`"
       end
 
       def show_command
         config.each do |repo, secrets|
-          say "!txtblu!#{repo}:"
+          say "b`#{repo}`:"
           secrets.each do |key, value|
             show_secret key, value, args['--visible']
           end
@@ -53,9 +54,9 @@ module SecretHub
 
       def list_command
         config.each_repo do |repo|
-          say "!txtblu!#{repo}:"
+          say "b`#{repo}`:"
           github.secrets(repo).each do |secret|
-            say "- !txtpur!#{secret}"
+            say "- m`#{secret}`"
           end
         end
       end
@@ -66,22 +67,23 @@ module SecretHub
         skipped = 0
 
         config.each do |repo, secrets|
-          next if only and repo != only
-          say "!txtblu!#{repo}"
+          next if only && (repo != only)
+
+          say "b`#{repo}`"
           skipped += update_repo repo, secrets, dry
           clean_repo repo, secrets.keys, dry if args['--clean']
         end
 
-        puts "\n" if skipped > 0 or dry
-        say "Skipped #{skipped} missing secrets" if skipped > 0
-        say "Dry run, nothing happened" if dry
+        puts "\n" if skipped.positive? || dry
+        say "Skipped #{skipped} missing secrets" if skipped.positive?
+        say 'Dry run, nothing happened' if dry
       end
 
       def clean_command
         dry = args['--dry']
 
         config.each do |repo, secrets|
-          say "!txtblu!#{repo}"
+          say "b`#{repo}`"
           clean_repo repo, secrets.keys, dry
         end
 
@@ -95,9 +97,9 @@ module SecretHub
         delete_candidates = repo_keys - keys
 
         delete_candidates.each do |key|
-          say "delete  !txtpur!#{key}  "
+          say "delete  m`#{key}`  "
           github.delete_secret repo, key unless dry
-          say "!txtgrn!OK"
+          say 'g`OK`'
         end
       end
 
@@ -105,12 +107,12 @@ module SecretHub
         skipped = 0
 
         secrets.each do |key, value|
-          say "save    !txtpur!#{key}  "
+          say "save    m`#{key}`  "
           if value
             github.put_secret repo, key, value unless dry
-            say "!txtgrn!OK"
+            say 'g`OK`'
           else
-            say "!txtred!MISSING"
+            say 'r`MISSING`'
             skipped += 1
           end
         end
@@ -121,9 +123,9 @@ module SecretHub
       def show_secret(key, value, visible)
         if value
           value = value.obfuscate unless visible
-          say "  !txtpur!#{key}: !txtcyn!#{value}"
+          say "  m`#{key}`: c`#{value}`"
         else
-          say "  !txtpur!#{key}: !txtred!*MISSING*"
+          say "  m`#{key}`: r`*MISSING*`"
         end
       end
 

data/lib/secret_hub/commands/org.rb

@@ -1,40 +1,41 @@
 module SecretHub
   module Commands
     class Org < Base
-      summary "Manage organization secrets"
-      
-      usage "secrethub org list ORG"
-      usage "secrethub org save ORG KEY VALUE"
-      usage "secrethub org delete ORG KEY"
-      usage "secrethub org (-h|--help)"
+      summary 'Manage organization secrets'
 
-      command "list", "Show all organization secrets"
-      command "save", "Create or update an organization secret (with private repositories visibility)"
-      command "delete", "Delete an organization secret"
+      usage 'secrethub org list ORG'
+      usage 'secrethub org save ORG KEY [VALUE]'
+      usage 'secrethub org delete ORG KEY'
+      usage 'secrethub org (-h|--help)'
 
-      param "ORG", "Name of the organization"
-      param "KEY", "The name of the secret"
-      param "VALUE", "The plain text secret value"
+      command 'list', 'Show all organization secrets'
+      command 'save', 'Create or update an organization secret (with private repositories visibility)'
+      command 'delete', 'Delete an organization secret'
 
-      example "secrethub org list myorg"
-      example "secrethub org save myorg PASSWORD s3cr3t"
-      example "secrethub org delete myorg PASSWORD"
+      param 'ORG', 'Name of the organization'
+      param 'KEY', 'The name of the secret'
+      param 'VALUE', 'The plain text secret value. If not provided, it is expected to be set as an environment variable'
+
+      example 'secrethub org list myorg'
+      example 'secrethub org save myorg PASSWORD'
+      example 'secrethub org save myorg PASSWORD s3cr3t'
+      example 'secrethub org delete myorg PASSWORD'
 
       def list_command
-        say "!txtblu!#{org}:"
+        say "b`#{org}`:"
         github.org_secrets(org).each do |secret|
-          say "- !txtpur!#{secret}"
+          say "- m`#{secret}`"
         end
       end
 
-      def save_command       
+      def save_command
         github.put_org_secret org, key, value
-        say "Saved !txtblu!#{org} !txtpur!#{key}"
+        say "Saved b`#{org}` m`#{key}`"
       end
 
       def delete_command
         github.delete_org_secret org, key
-        say "Deleted !txtblu!#{org} !txtpur!#{key}"
+        say "Deleted b`#{org}` m`#{key}`"
       end
 
     private
@@ -48,9 +49,14 @@ module SecretHub
       end
 
       def value
-        args['VALUE']
-      end
+        result = args['VALUE'] || ENV[key]
+        unless result
+          raise InvalidInput,
+            "Please provide a value, either in the command line or in the environment variable '#{key}'"
+        end
 
+        result
+      end
     end
   end
 end

data/lib/secret_hub/commands/repo.rb

@@ -1,40 +1,41 @@
 module SecretHub
   module Commands
     class Repo < Base
-      summary "Manage repository secrets"
-      
-      usage "secrethub repo list REPO"
-      usage "secrethub repo save REPO KEY VALUE"
-      usage "secrethub repo delete REPO KEY"
-      usage "secrethub repo (-h|--help)"
+      summary 'Manage repository secrets'
 
-      command "list", "Show all repository secrets"
-      command "save", "Create or update a repository secret"
-      command "delete", "Delete a repository secret"
+      usage 'secrethub repo list REPO'
+      usage 'secrethub repo save REPO KEY [VALUE]'
+      usage 'secrethub repo delete REPO KEY'
+      usage 'secrethub repo (-h|--help)'
 
-      param "REPO", "Full name of the GitHub repository (user/repo)"
-      param "KEY", "The name of the secret"
-      param "VALUE", "The plain text secret value"
+      command 'list', 'Show all repository secrets'
+      command 'save', 'Create or update a repository secret'
+      command 'delete', 'Delete a repository secret'
 
-      example "secrethub repo list me/myrepo"
-      example "secrethub repo save me/myrepo PASSWORD s3cr3t"
-      example "secrethub repo delete me/myrepo PASSWORD"
+      param 'REPO', 'Full name of the GitHub repository (user/repo)'
+      param 'KEY', 'The name of the secret'
+      param 'VALUE', 'The plain text secret value. If not provided, it is expected to be set as an environment variable'
+
+      example 'secrethub repo list me/myrepo'
+      example 'secrethub repo save me/myrepo PASSWORD'
+      example 'secrethub repo save me/myrepo PASSWORD s3cr3t'
+      example 'secrethub repo delete me/myrepo PASSWORD'
 
       def list_command
-        say "!txtblu!#{repo}:"
+        say "b`#{repo}`:"
         github.secrets(repo).each do |secret|
-          say "- !txtpur!#{secret}"
+          say "- m`#{secret}`"
         end
       end
 
-      def save_command       
+      def save_command
         github.put_secret repo, key, value
-        say "Saved !txtblu!#{repo} !txtpur!#{key}"
+        say "Saved b`#{repo}` m`#{key}`"
       end
 
       def delete_command
         github.delete_secret repo, key
-        say "Deleted !txtblu!#{repo} !txtpur!#{key}"
+        say "Deleted b`#{repo}` m`#{key}`"
       end
 
     private
@@ -48,9 +49,14 @@ module SecretHub
       end
 
       def value
-        args['VALUE']
-      end
+        result = args['VALUE'] || ENV[key]
+        unless result
+          raise InvalidInput,
+            "Please provide a value, either in the command line or in the environment variable '#{key}'"
+        end
 
+        result
+      end
     end
   end
 end

data/lib/secret_hub/config.rb

@@ -6,7 +6,12 @@ module SecretHub
 
     def self.load(config_file)
       raise ConfigurationError, "Config file not found #{config_file}" unless File.exist? config_file
+
+      new YAML.load_file config_file, aliases: true
+    rescue ArgumentError
+      # :nocov:
       new YAML.load_file config_file
+      # :nocov:
     end
 
     def initialize(data)
@@ -18,11 +23,11 @@ module SecretHub
     end
 
     def each(&block)
-      to_h.each &block
+      to_h.each(&block)
     end
 
     def each_repo(&block)
-      to_h.keys.each &block
+      to_h.keys.each(&block)
     end
 
   private
@@ -31,18 +36,20 @@ module SecretHub
       result = {}
       data.each do |repo, secrets|
         next unless repo.include? '/'
+
         result[repo] = resolve_secrets secrets
       end
       result
     end
 
     def resolve_secrets(secrets)
-      secrets = [] unless secrets
-      
-      if secrets.is_a? Hash
-        secrets.map { |key, value| [key, value || ENV[key]] }.to_h
-      elsif secrets.is_a? Array
-        secrets.map { |key| [key, ENV[key]] }.to_h
+      secrets ||= []
+
+      case secrets
+      when Hash
+        secrets.to_h { |key, value| [key, value || ENV[key]] }
+      when Array
+        secrets.to_h { |key| [key, ENV[key]] }
       end
     end
   end

data/lib/secret_hub/exceptions.rb

@@ -1,7 +1,8 @@
 module SecretHub
   SecretHubError = Class.new StandardError
   ConfigurationError = Class.new SecretHubError
-  
+  InvalidInput = Class.new SecretHubError
+
   class APIError < SecretHubError
     attr_reader :response
 
@@ -10,4 +11,4 @@ module SecretHub
       super "[#{response.code}] #{response.body}"
     end
   end
-end
+end

data/lib/secret_hub/github_client.rb

@@ -39,8 +39,8 @@ module SecretHub
       secret = encrypt_for repo, value
       key_id = public_key(repo)['key_id']
       put "/repos/#{repo}/actions/secrets/#{name}",
-        encrypted_value: secret, 
-        key_id: key_id
+        encrypted_value: secret,
+        key_id:          key_id
     end
 
     # PUT /orgs/:org/actions/secrets/:secret_name
@@ -48,9 +48,9 @@ module SecretHub
       secret = encrypt_for org, value
       key_id = public_key(org)['key_id']
       put "/orgs/#{org}/actions/secrets/#{name}",
-        encrypted_value: secret, 
-        key_id: key_id,
-        visibility: 'private'
+        encrypted_value: secret,
+        key_id:          key_id,
+        visibility:      'private'
     end
 
     # DELETE /repos/:owner/:repo/actions/secrets/:name
@@ -97,15 +97,14 @@ module SecretHub
     end
 
     def headers
-      { 
-        "Authorization" => "token #{secret_token}",
-        "User-Agent" =>    "SecretHub Gem"
+      {
+        'Authorization' => "token #{secret_token}",
+        'User-Agent'    => 'SecretHub Gem',
       }
     end
 
     def secret_token
-      ENV['GITHUB_ACCESS_TOKEN'] || raise(ConfigurationError, "Please set GITHUB_ACCESS_TOKEN")
+      ENV['GITHUB_ACCESS_TOKEN'] || raise(ConfigurationError, 'Please set GITHUB_ACCESS_TOKEN')
     end
-
   end
 end

data/lib/secret_hub/refinements/string_obfuscation.rb

@@ -6,18 +6,18 @@ module SecretHub
       def obfuscate
         text = dup
         trim = false
-        
+
         if text.size > 40
           trim = true
           text = text[0..40]
         end
-        
+
         result = StringObfuscator.obfuscate text,
-          percent: 60,
+          percent:               60,
           min_obfuscated_length: 5
 
         trim ? "#{result}..." : result
       end
     end
   end
-end
+end

data/lib/secret_hub/sodium.rb

@@ -1,4 +1,4 @@
-require "base64"
+require 'base64'
 require 'rbnacl'
 
 module SecretHub

data/lib/secret_hub/version.rb

@@ -1,3 +1,3 @@
 module SecretHub
-  VERSION = "0.2.0"
-end
+  VERSION = '0.2.2'
+end

data/lib/secret_hub.rb

@@ -2,5 +2,3 @@ require 'secret_hub/version'
 require 'secret_hub/exceptions'
 require 'secret_hub/github_client'
 require 'secret_hub/config'
-
-require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,71 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: secret_hub
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mister_bin
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: lp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
-  name: lp
+  name: rackup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +114,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Command line interface for managing GitHub secrets in bulk
 email: db@dannyben.com
 executables:
@@ -119,8 +167,9 @@ files:
 homepage: https://github.com/dannyben/secret_hub
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,15 +177,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
 summary: Manage GitHub secrets over multiple repositories
 test_files: []