secrit 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70cd3930aa08c99cedd7b991a68e67e9136e9eecea9e37936d780ca5ea9ffb5a
-  data.tar.gz: 40f8176c0130166a9297d30192defb9ef6d7127e226de16832b664a20e1eb915
+  metadata.gz: d6faa44d62bd340907b101bf6ba6e56837587d51638f8741452fcc27b5c12095
+  data.tar.gz: ce5893a67b02b928ac95a214151cf1bd3bd2daf7332ed2813f4d89798e4d6124
 SHA512:
-  metadata.gz: da7895eab947c91fd9d3b5f9e25209b58861b077ea68332292142f79b31e34d43028316e8a6d3c0120246e07251b9d259c957c316d27d4ad69911086cfacb97f
-  data.tar.gz: a21ae1183cc336b570831eb0dba023672c4bef71266714579c01acb6d8027dff6fd5b622620746eab4c935ad6696b9cef896162ca62b75db5f52e168996b27c9
+  metadata.gz: 3f34ba5b85f46dd496c32a388aea79e29737748cead405b268f64c4923ebe91cb51ca58a48b476f8befdd012d2a7a2694be94d193412c502728d457e24f82d30
+  data.tar.gz: 2d476217fc7b85149af601e19d6af6471ff7155c8788ffa413e2b2196310d3f795eed4d68623d24f3b6515062c34e8ec6afd861e57538fcc9ecf6c483cbb5024

data/lib/secrit.rb

@@ -1,20 +1,84 @@
 #!/usr/bin/env ruby
 require 'gpgme'
 
-PASSWORD_STORE_PATH = File.expand_path("~/.password-store/")
+# 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
+
+# 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
+  end
+end
 
+# Secrit provides methods to get encrypted data, allowing optional customization
+# of the decryption process.
 class Secrit
-  def self.get(entry_path)
-    full_path = File.join(PASSWORD_STORE_PATH, "#{entry_path}.gpg")
+  attr_accessor :storage
 
-    # Ensure the file exists
-    raise "File not found: #{full_path}" unless File.exist?(full_path)
+  # 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
 
-    # Decrypt the file
-    crypto = GPGME::Crypto.new
-    decrypted_data = crypto.decrypt(File.open(full_path))
+  # 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)
+    @decryptor.decrypt(full_path)
+  end
 
-    # Return the decrypted content
-    decrypted_data.to_s.strip
+  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
 end

data/test/secrit_test.rb

@@ -4,6 +4,30 @@ require 'mocha/minitest'
 require_relative '../lib/secrit'
 
 class SecritTest < Minitest::Test
+  def with_encrypted_file(contents, key_path = 'test_entry')
+    Dir.mktmpdir do |temp_dir|
+      # Create a temporary GPG file with known content
+      test_file_path = File.join(temp_dir, "#{key_path}.gpg")
+      file = File.open(test_file_path, 'w+')
+
+      crypto = GPGME::Crypto.new
+      crypto.encrypt(contents, output: file)
+
+      yield(temp_dir)
+    end
+  end
+
+  def test_real_decryption
+    # Create a temporary GPG file with known content
+    key_path = 'foo_bar'
+
+    with_encrypted_file('test content', key_path) do |storage|
+      # Run the get method and check the result
+      result = Secrit.get(key_path, storage: storage)
+      assert_equal "test content", result
+    end
+  end
+
   def test_successful_decryption
     # Mocking the file existence check
     File.stubs(:exist?).returns(true)
@@ -21,12 +45,32 @@ class SecritTest < Minitest::Test
     assert_equal 'decrypted content', result
   end
 
+  def test_successful_decryption_object
+    entry_path = "valid_entry_path"
+    expected_decrypted_content = "secret content"
+
+    # Create a mock decryptor
+    mock_decryptor = Minitest::Mock.new
+    mock_decryptor.expect(:decrypt, expected_decrypted_content, [String])
+    File.stubs(:exist?).returns(true)
+
+    # Create an instance of Secrit with the mock decryptor
+    secrit = Secrit.new(decryptor: mock_decryptor)
+
+    # Test the get method
+    decrypted_content = secrit.get(entry_path)
+    assert_equal expected_decrypted_content, decrypted_content
+
+    # Verify that the mock expectations were met
+    mock_decryptor.verify
+  end
+
   def test_file_not_found
     # Mocking the file existence check to return false
     File.stubs(:exist?).returns(false)
 
     # Testing the get method to ensure it raises the correct error
-    assert_raises(RuntimeError, "File not found: #{File.join(PASSWORD_STORE_PATH, 'non_existent_file.gpg')}") do
+    assert_raises(RuntimeError, "File not found: #{File.join(Secrit.new.storage, 'non_existent_file.gpg')}") do
       Secrit.get('non_existent_file')
     end
   end

metadata

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