secrit 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebe7a9abd529893db98b6ea4169e629418e6328210f57a3c84b953f960c15301
-  data.tar.gz: bff251e6d9c4ebf773480d04d5b2b1a40a0895260bede6112260804b4fcee8d6
+  metadata.gz: d6faa44d62bd340907b101bf6ba6e56837587d51638f8741452fcc27b5c12095
+  data.tar.gz: ce5893a67b02b928ac95a214151cf1bd3bd2daf7332ed2813f4d89798e4d6124
 SHA512:
-  metadata.gz: 454260a665033b13a4e2de64ccd9d49642678b25aca857e1b9b40f8c82c988b9900f1ba361dd7e7fa7cc94dcc35843993695d4aaa591f603617b019ed0f227ad
-  data.tar.gz: 4eecd853e9b0ced9a7029cfc81a1d0360662f7dcbc282112eed9c4608f862a9b6d9debd0a051d5efcc6102fe9001f9a19f818fc3093b6ea65cbb1581ca8b2a38
+  metadata.gz: 3f34ba5b85f46dd496c32a388aea79e29737748cead405b268f64c4923ebe91cb51ca58a48b476f8befdd012d2a7a2694be94d193412c502728d457e24f82d30
+  data.tar.gz: 2d476217fc7b85149af601e19d6af6471ff7155c8788ffa413e2b2196310d3f795eed4d68623d24f3b6515062c34e8ec6afd861e57538fcc9ecf6c483cbb5024

data/lib/secrit.rb

@@ -1,38 +1,63 @@
 #!/usr/bin/env ruby
 require 'gpgme'
 
-# Define an interface (or contract) for decryption
+# Decryptor provides an interface for decryption. Classes that extend Decryptor
+# must implement the decrypt method.
 class Decryptor
+  # Decrypts a file at the given path.
+  #
+  # @param file_path [String] the path to the file to be decrypted.
+  # @raise [NotImplementedError] if the method is called on the Decryptor class
+  #   itself, rather than a subclass.
   def decrypt(file_path)
     raise NotImplementedError
   end
 end
 
-# Provide a default implementation
+# GPGDecryptor is a default implementation of the Decryptor interface using GPG.
 class GPGDecryptor < Decryptor
+  # Decrypts a file at the given path using GPG.
+  #
+  # @param file_path [String] the path to the file to be decrypted.
+  # @return [GPGME::Data] the decrypted data.
   def decrypt(file_path)
     crypto = GPGME::Crypto.new
     decrypted_data = crypto.decrypt(File.open(file_path))
-    #decrypted_data.to_s.strip
     decrypted_data
   end
 end
 
+# Secrit provides methods to get encrypted data, allowing optional customization
+# of the decryption process.
 class Secrit
   attr_accessor :storage
 
+  # Retrieves decrypted data for a given entry path.
+  #
+  # @param entry_path [String] the entry path to the encrypted data.
+  # @param storage [String] the storage path for the encrypted files (optional).
+  # @return [String] the decrypted content as a string.
   def self.get(entry_path, storage: nil)
     new(
       storage: storage
     ).get(entry_path).to_s.strip
   end
 
-  # Allow optional injection of custom Decryptor
+  # Initializes a new Secrit object with optional customization.
+  #
+  # @param decryptor [Decryptor] an object that responds to the decrypt method
+  #   (optional, defaults to GPGDecryptor.new).
+  # @param storage [String] the storage path for the encrypted files (optional).
   def initialize(decryptor: GPGDecryptor.new, storage: nil)
     @decryptor = decryptor
     @storage = storage || File.expand_path("~/.password-store/")
   end
 
+  # Retrieves decrypted data for a given entry path.
+  #
+  # @param entry_path [String] the entry path to the encrypted data.
+  # @return [GPGME::Data] the decrypted data.
+  # @raise [RuntimeError] if the file does not exist at the constructed path.
   def get(entry_path)
     full_path = construct_path(entry_path)
     validate_file_existence(full_path)
@@ -41,10 +66,18 @@ class Secrit
 
   private
 
+  # Constructs the full path to an encrypted file based on the entry path.
+  #
+  # @param entry_path [String] the entry path.
+  # @return [String] the full path to the encrypted file.
   def construct_path(entry_path)
     File.join(storage, "#{entry_path}.gpg")
   end
 
+  # Validates that a file exists at the given path.
+  #
+  # @param full_path [String] the full path to the file.
+  # @raise [RuntimeError] if the file does not exist at the given path.
   def validate_file_existence(full_path)
     raise "File not found: #{full_path}" unless File.exist?(full_path)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secrit
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Simpthy