2pass 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 671d7c33b6f4e5e79ef13a88986405674f456dc06e23f5cc7450fb495ecdcb71
-  data.tar.gz: 415390e6ac546a6af7678058e1231a4ade807df151dca0b163aa4023da8fe229
+  metadata.gz: 1236ce26a8191128890f5d302ae31ebe607f51dd6018bdbc1dd561f782909748
+  data.tar.gz: b5b6cb1c22ce47f83df9a1f403ffce5628ae1d7a9d496b3ccbcc7c79f6a4726b
 SHA512:
-  metadata.gz: f865bb6fac54e13f4ac4c7c917680b0a0ef92194d1a2f1f97cc72333de8215466d4ab598a0a2ddb5360bc61b489c9a0231fa2ec3d53afd98b7e9f15aecb58fb1
-  data.tar.gz: e01b0c574e69fcd8096605c7b7a2f383aad580dbbfd72ec6a89701573ee75a182303b5bd6349bc8022a9354e4a4bc042a090435016bba213aca0c37d54fcf5eb
+  metadata.gz: da6f2bacdade151d6ab41d815aec44f4f21dbd5b14ee330a06a4bf34efcda2b1d7d7f1eefbf455058002ca524f1369e577245692f5329b6a2938348c5799a6c9
+  data.tar.gz: 165926fcf9576c49b62a628beb4ec16cff3ea01a58d07854f88c5e7891d73c40af22406183dfbacd138794fb477c90094e8d208844eac9188adc828c6dd22765

data/2pass.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters", "~> 1.3", ">= 1.3.0"
+
+  spec.add_dependency "terminal-table", "~> 4.0"
 end

data/README.md

@@ -17,13 +17,12 @@ An array of hashes with the following keys:
 
 - id
 - value
-- uuid
 
 ```sh
   touch ~/.2pass/vault_name.yml
 ```
 
-Alternatively, if you have a vault file in a different location, you can link it.
+Alternatively, if you already have a vault file in a different location, you can link it.
 
 ```sh
   2pass link vault_name /path/to/vault_name.yml
@@ -44,6 +43,10 @@ Then build the gem and install it.
   2pass list <vault_name>
   2pass add <vault_name> <id> <value>
 ```
+You can also pass an optional environment to most commands:
+`2pass get myproject mykey production`
+
+This will search for `mykey` within `myproject.production.yml`
 
 ## Development
 

data/bin/2pass

@@ -5,11 +5,13 @@ require_relative "../lib/2pass"
 def help_message
   puts <<~HELP
     Usage:
-      2pass add <vault_name> <id> <value>   - Add new secret
-      2pass get <vault_name> <id>           - Get content by ID from the specified vault
-      2pass list <vault_name>               - List the content of the specified vault
-      2pass link <vault_name> <target_path> - Create a symlink for an existing vault. Useful when the vault is stored in a synced place (iCloud, Dropbox, etc.)
-      2pass -h                              - Display this help message
+      2pass add <vault_name> <id> <value> <env>   - Add new secret. env is optional
+      2pass get <vault_name> <id> <env>           - Get content by ID from the specified vault. env is optional
+      2pass list <vault_name> <env>               - List the content of the specified vault as key=value pairs. env is optional
+      2pass list <vault_name> <env> --json        - List the content of the specified vault as JSON. env is optional
+      2pass list <vault_name> <env> --dotenv      - List the content of the specified vault as key=value pairs. env is optional
+      2pass link <vault_name> <target_path> <env> - Create a symlink for an existing vault. Useful when the vault is stored in a synced place (iCloud, Dropbox, etc.). env is optional
+      2pass -h                                    - Display this help message
   HELP
 end
 
@@ -23,6 +25,12 @@ OptionParser.new do |opts|
   opts.on("-v", "--version", "Display the version") do
     options[:version] = true
   end
+  opts.on("--json", "Use JSON output format") do
+    options[:format] = :json
+  end
+  opts.on("--dotenv", "Use key=value output format") do
+    options[:format] = :dotenv
+  end
 end.parse!
 
 if options[:help]
@@ -43,30 +51,39 @@ end
 command, vault_name, *args = ARGV
 
 begin
-  case command
-  when "get"
+  case command&.to_sym
+  when :get
     if args.length < 1
       help_message
       exit(1)
     end
-    id = args[0]
-    puts TwoPass.get_secret(vault_name, id)
-  when "add"
+    id, env = args[0], args[1]
+    puts TwoPass.get_secret(vault_name, id, env: env)
+  when :add
     if args.length != 2
       help_message
       exit(1)
     end
-    TwoPass.add_secret(vault_name, args[0], args[1])
-  when "list"
-    puts TwoPass.list_content(vault_name)
-  when "link"
+    id, value, env = args[0], args[1], args[2]
+    TwoPass.add_secret(vault_name, id, value, env: env)
+  when :list
+    env = args[0]
+    if options[:format] == :json
+      puts TwoPass.list_content(vault_name, env: env, format: :json)
+    elsif options[:format] == :dotenv
+      puts TwoPass.list_content(vault_name, env: env, format: :dotenv)
+    else
+      puts TwoPass.list_content(vault_name, env: env)
+    end
+    exit(1)
+  when :link
     if args.length < 1
       help_message
       exit(1)
     end
-    target_path = args[0]
-    TwoPass.create_symlink(vault_name, target_path)
-  when "help"
+    target_path, env = args[0], args[1]
+    TwoPass.create_symlink(vault_name, target_path, env: env)
+  when :help
     help_message
   else
     help_message
@@ -79,5 +96,5 @@ rescue => e
     STDERR.puts e.backtrace
   end
 
-  exit 1
+  exit(1)
 end

data/lib/2pass/version.rb

@@ -1,3 +1,3 @@
 module TwoPass
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/lib/2pass.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require "optparse"
 require "json"
 require "yaml"
 require "fileutils"
-require "securerandom"
+require "terminal-table"
 
 require_relative "2pass/version"
 
@@ -10,9 +12,9 @@ module TwoPass
   VAULT_DIR = "#{Dir.home}/.2pass"
 
   class << self
-    def create_symlink(vault_name, target_path)
+    def create_symlink(vault_name, target_path, env: nil)
       FileUtils.mkdir_p(VAULT_DIR)
-      symlink_path = "#{VAULT_DIR}/#{vault_name}.yml"
+      symlink_path = vault_file_path(vault_name, env: env)
 
       if File.exist?(symlink_path)
         puts "Symlink already exists: #{symlink_path}"
@@ -22,44 +24,55 @@ module TwoPass
       end
     end
 
-    def load_vault(vault_name)
-      file_path = "#{VAULT_DIR}/#{vault_name}.yml"
-      return [] unless File.exist?(file_path)
-
-      YAML.load_file(file_path, symbolize_names: true) || []
-    rescue Psych::SyntaxError => e
-      STDERR.puts "Error parsing YAML file: #{e.message}"
-      []
-    end
-
-    def save_vault(vault_name, data)
+    def save_vault(vault_name, data, env: nil)
       FileUtils.mkdir_p(VAULT_DIR)
-      file_path = "#{VAULT_DIR}/#{vault_name}.yml"
+      file_path = vault_file_path(vault_name, env: env)
       File.write(file_path, YAML.dump(data))
     end
 
-    def list_content(vault_name)
-      vault = load_vault(vault_name)
-      JSON.pretty_generate(vault)
+    def list_content(vault_name, env: nil, format: :table)
+      vault = load_vault(vault_name, env: env)
+      if format == :table
+        rows = vault
+          .sort_by { |hash| hash[:id] }
+          .each_with_object([]) do |h, arr|
+          arr << [h[:id], h[:value]]
+        end
+        Terminal::Table.new(
+          rows: rows,
+          title: env || nil,
+          style: {all_separators: true}
+        ).to_s
+      elsif format == :dotenv
+        vault
+          .map { |h| "#{h[:id]}=#{h[:value]}" }
+          .sort
+          .join("\n")
+      elsif format == :json
+        JSON.pretty_generate(
+          vault
+            .map { |hash| hash.slice(:id, :value) }
+            .sort_by { |hash| hash[:id] }
+        )
+      end
     end
 
-    def add_secret(vault_name, id, value)
+    def add_secret(vault_name, id, value, env: nil)
       new_secret = {
         id: id,
-        value: value,
-        uuid: SecureRandom.uuid
+        value: value
       }
-      data = load_vault(vault_name)
+      data = load_vault(vault_name, env: env)
       existing_entry_id = data.find_index { |hash| hash[:id] == new_secret[:id] }
       if existing_entry_id
         raise "The secret already exists"
       end
       data << new_secret
-      save_vault(vault_name, data)
+      save_vault(vault_name, data, env: env)
     end
 
-    def get_secret(vault_name, id)
-      vault = load_vault(vault_name)
+    def get_secret(vault_name, id, env: nil)
+      vault = load_vault(vault_name, env: env)
       entry = vault.find { |hash| hash[:id] == id }
       if entry
         entry[:value]
@@ -67,5 +80,24 @@ module TwoPass
         raise "Entry not found"
       end
     end
+
+    private
+
+    def load_vault(vault_name, env: nil)
+      file_path = self.vault_file_path(vault_name, env: env)
+      return [] unless File.exist?(file_path)
+
+      YAML.load_file(file_path, symbolize_names: true) || []
+    rescue Psych::SyntaxError => e
+      STDERR.puts "Error parsing YAML file: #{e.message}"
+      []
+    end
+
+    def vault_file_path(vault_name, env: nil)
+      [
+        VAULT_DIR,
+        [vault_name, env].compact.join(".")
+      ].join("/") + ".yml"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 2pass
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Olivier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: 2pass is a CLI application for managing YAML-based vaults.
 email:
 - contact@yafoy.com