gpgr 0.0.3 → 0.0.4

data/README.markdown

@@ -83,8 +83,8 @@ not be accepted - I'm happy to assume that it is.
 
 ##Status
 
-Functional if sparsely documented. Gem 0.0.1 has been cut.
+Published as a gem, current version 0.0.4
 
 [1]: http://www.pccl.co.uk
 [2]: http://macgpg.sourceforge.net/
-[3]: http://sourceforge.net/projects/macgpg2/files/
+[3]: http://sourceforge.net/projects/macgpg2/files/

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 require "rake/rdoctask"
 require "rake/gempackagetask"  
 
-GPGR_VERSION = "0.0.3" 
+GPGR_VERSION = "0.0.4" 
 
 task :default => [:test]
        
@@ -22,7 +22,7 @@ Rake::RDocTask.new do |rdoc|
                            "COPYING",
                            "LICENSE", 
                            "HACKING", "lib/" )
-  rdoc.main     = "README"
+  rdoc.main     = "lib/gpgr.rb"
   rdoc.rdoc_dir = "doc/html"
   rdoc.title    = "Gpgr Documentation"
 end     
@@ -40,7 +40,7 @@ spec = Gem::Specification.new do |spec|
   spec.has_rdoc = true
   spec.extra_rdoc_files = %w{HACKING README.markdown LICENSE COPYING}
   spec.rdoc_options << '--title' << 'Gpgr Documentation' <<
-                       '--main'  << 'README' << '-q'
+                       '--main'  << 'lib/gpgr.rb' << '-q'
   spec.author = "Ryan Stenhouse"
   spec.email = "  ryan@ryanstenhouse.eu"
   spec.rubyforge_project = "gpgr"

data/lib/gpgr.rb

@@ -13,9 +13,20 @@
 #    
 #    require 'rubygems'
 #    require 'gpgr'
+#
+#    # Synopsis
+#    #
 #    list_of_keys = [ 'foo@example.com', 'bar@example.com' ]
 #    Gpgr::Encrypt.file('/some_file.txt', :to => '/encrypted.gpg').encrypt_using(list_of_keys)
-#    
+#
+#    # To import all the public keys in a given directory
+#    #
+#    Gpgr::Keys.import_keys_at('/path/to/public/keys')
+#   
+#    #  Will encrypt for every single person you have a public key for
+#    #
+#    Gpgr::Encrypt.file('/some_file.txt', :to => '/encrypted.gpg').encrypt_using(Gpgr::Keys.installed_public_keys)
+#
 module Gpgr
 
   # Returns the command to execute to run GPG. It is defualted to /use/bin/env gpg 
@@ -45,9 +56,19 @@ module Gpgr
       default_options = { :to => "#{path}.pgp" }.merge(options)
       GpgFileForEncryption.new(path, default_options[:to])
     end
-
+  
+    # Raised if there is an invalid e-mail address provided to encrypt with
+    #
     class InvalidEmailException < Exception; end
 
+    # Raised if the input or output files for the GPG Encryption are invalid somehow
+    #
+    class InvalidFileException < Exception; end
+    
+
+    # Contians the details used to encrypt specified +file+, is what actually does
+    # any encryption.
+    # 
     class GpgFileForEncryption
       
       attr_accessor :email_addresses, :file, :file_output
@@ -83,6 +104,15 @@ module Gpgr
       #   
       def encrypt
         bad_key = @email_addresses.empty?
+        
+        if File.exists?(@file)
+          unless File.readable?(@file)
+            raise InvalidFileException.new("File at #{@file} is not readable.") and return
+          end
+        else
+          raise InvalidFileException.new("File at #{@file} does not exist.") and return
+        end
+        
         @email_addresses.each do |add|
           unless Gpgr::Keys.public_key_installed?(add)
             bad_key = true
@@ -118,9 +148,8 @@ module Gpgr
     # those which are likely to be GPG / PGP Public Keys.
     # 
     def self.import_keys_at(path)
-      d = Dir.new(path)
-      d.each do |file|
-        puts file.inspect
+      Dir.new(path).each do |file|
+        next if ['..','.'].include?(file)
         Gpgr::Keys.import(path + '/' + file)
       end
     end

data/test/generate_keys.rb

@@ -0,0 +1,31 @@
+path = File.expand_path(File.dirname(__FILE__) + '/test_keys')
+
+
+def generate_key(name, email, start_path)
+  file_path = "#{start_path}/testing_#{Time.now.to_i}"
+  params = <<-PGP
+Key-Type: DSA
+Key-Length: 1024
+Subkey-Type: ELG-E
+Subkey-Length: 1024
+Name-Real: #{name}
+Name-Comment: with stupid passphrase
+Name-Email: #{email}
+Expire-Date: 0
+Passphrase: abc
+%pubring #{file_path}.pub
+%secring #{file_path}.sec
+%commit
+  PGP
+  `echo '#{params}' | gpg --batch --gen-key -a`
+  if File.exists?(file_path + '.pub')
+    return file_path + '.pub'
+  else
+    raise "ARRGH"
+  end
+end
+
+ 
+generate_key('TestyMcTest1', 'testymctest1@example.com', path)
+generate_key('TestyMcTest2', 'testymctest2@example.com', path)
+generate_key('TestyMcTest3', 'testymctest3@example.com', path)

data/test/john_and_marks_keys/john.pub

@@ -0,0 +1,25 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1.4.9 (GNU/Linux)
+
+mQGiBEuiWdgRBACSK3Jckkap+7WT/UT90wF3Gwrn8MFfquOlVpPFdmcgOoHqJqe+
+7Ve6HuGD4DD7Pdtth51p/GjpiDUmLCtsWsmtyokNEcWt8qeAJSdwxs6vurmCETDv
+iNeW5NEFedpDaT8VfLhZYOvL0w0yEiKgozANUw30FbqlONSDSV95XVIzwwCglhtj
+m9yosv/1WSIhE7I/FqQIsZkD/jTZwhlf18N3rSAhPf3mdN3bDQwoQ3J4enRfiIYQ
+HMkAsgQIolDnmB+OYJveJloOy64c3kW7tLy66k0qNsHALYyIm0fVagZ2c2QsjPfo
+f/5AR7mOQH9tyGwimSA3imSbPHUry9J81tFYyAghSlpaFaSzXwaZeVQz9UkYua1v
+C1O3A/wLCgdmSiZPmvUwGO6aRtOlCYkOF1ESFXHf0yrGalEG7z3HnTt5kquuxEqH
+Ju4z5SaCVomj223CiDhoqhuKegv42v1OqSUy2n8xhYaiG8jrYbi3nGBZHa7xDC+e
+5fGRVRnvQak9fWhUiSpxnqmqDoehi31r8xMGsCXsfj3WwWX+HLQ2Sm9obiBTbWl0
+aCAod2l0aCBzdHVwaWQgcGFzc3BocmFzZSkgPGpvaG5AZXhhbXBsZS5jb20+iGAE
+ExECACAFAkuiWdgCGyMGCwkIBwMCBBUCCAMEFgIDAQIeAQIXgAAKCRDItjDcD+Xj
+wNupAJ4p+XOgp0CgrvZJj0lACZ60pkAoLgCfc4SNEmghdfIB7tWzDN5Tn5mvouq5
+AQ0ES6JZ2BAEAMN72E8kKYqoZ9p5O1U6zqSgGLwKgBy/6AvL/DuJ30ZldX5V2IZ2
+3UX+GOLvJLN8th+uq6/D0mTsaXVokiQG4kp+FNdoHttTc4XxlljfHrRzVeh/1v+Y
+Km1dyMrLvXAWvmMRH6yUs8LaLRgTXxJMvj79AlQDlht+whcHCIl670h7AAMGBAC1
+38U2Ijyr3pD2j0yEObN5WTe5Xv8w8FqWzlVgzQ5R3NTZQJdhZL8vg8axfwdSuGi+
+W+EnahCJtoVYomxubZMEwqZhT1Qd51cikvGlrhS8fSfYceQu1pdyFNy9ZNunVcOy
+jQvps3tD+FsbKVty7B/+8H8WaKFuhfhjkTzVJYl6GohJBBgRAgAJBQJLolnYAhsM
+AAoJEMi2MNwP5ePAs9oAnRZy/o5nIKMMDYaq5py3RcghMxM5AJ93keBaAz6CR0qo
+7ZcvIUoos7RKAQ==
+=96fQ
+-----END PGP PUBLIC KEY BLOCK-----

data/test/john_and_marks_keys/mark.pub

@@ -0,0 +1,25 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1.4.9 (GNU/Linux)
+
+mQGiBEuiWeERBACM6Kr8QCRkjUfQXoul72pYAJC+A9bv+nMgKWRYpgHSJFbDr2rx
+Z/C/YtIBAKLLvL0jayRn5yUuDtBzr8yziTFHVjEYUfezvCOMFA5oFpGdhrbQvbyQ
+lBlMOqlKQhZXjxt1ld7nlic1lLiwOW69gtnF2EqSSKRPWiQPYcbnkCdSVwCgwCi9
+C4buNiT7qgURGAZP4637PsUD+QG9rieVi9py10LseF78wTpsLYK7U7TTUhn8kh1o
+eox3QSw7SMJF5laiC7Gh6KNRZKggInVYYVhzpdEkzd5m93qXqBR/9PZDrAriVqvF
+lAdDaE2C4mQ09a/vqwEkSW/xuwsyj6uPAS3WfGdnxrzaDh1eQiJjCTvhf4Oi5uOQ
+GFgbBACAYq6sKS6fSuWlNKRIG1LwLtF5POLTMnyCnOcY6CqhqwkTV5MVSrEcO0Hr
+70OqddkK61rh90falfuREZDFyVOr9s3Hp00/oFLLyQg4b/QE+BM5ADBh6N9whdyQ
+CFz7+7dZ0hAIIVZSBhsZiNhxMl6xyMtJC3TSg4wIlqH6F5NvtrQ2TWFyayBTbWl0
+aCAod2l0aCBzdHVwaWQgcGFzc3BocmFzZSkgPG1hcmtAZXhhbXBsZS5jb20+iGAE
+ExECACAFAkuiWeECGyMGCwkIBwMCBBUCCAMEFgIDAQIeAQIXgAAKCRCBZ2nT3XFV
+RyiJAJ0XltocgbCDB4Oz2MS1uqaA/6o7rwCeOSxgLd01wuHptqVZ1KJAmv5eedO5
+AQ0ES6JZ4RAEAPfR6NZmERgEd5TcbfO6IW5tFHafcZe8KvFP5RlYaeNBNWzgpkMl
+zVwizM7awH7NMbL7B8kfVND5LE6Qqf9kELJ6fUxBfRYerk7Thiuj5jTa0QWNRKUv
+cKE2I5p4jQsgNMTwumulVLY9a0i2GAlHLYVshx5vqELQMmAHvT/hIfMrAAMGA/0c
+9tmguSta5CCidcVEiWa/ylnGmrcT2uB5PNqA7tdfxkUBVDKKKXJkey4r0dn8blLf
+1W5TytEMYnquKy8NQEgoLHXos5KlWl13j9hOf6uszrbbG7vNjuhlUOQxSoj3tBWc
+gu7pyJmKv5k/F6BQZQt2WKHkZVXorMEUAKOSazQ6HIhJBBgRAgAJBQJLolnhAhsM
+AAoJEIFnadPdcVVHY+cAoKSonlAWGbyxzypSFjQ97qYWGqhpAKCdtvWGFEajnFn1
+Lmb/MRJBEeVVOQ==
+=6klI
+-----END PGP PUBLIC KEY BLOCK-----

data/test/test_file_encryption_functionality.rb

@@ -33,7 +33,16 @@ class TestFileEncryptionFunctionality < Test::Unit::TestCase
     assert_raise Gpgr::Encrypt::InvalidEmailException do
       o.encrypt
     end
-    assert !File.exists(o.file_output)
+    assert !File.exists?(o.file_output)
+  end
+  
+  def test_encrypt_will_not_work_if_source_file_doesnt_exist
+    o = Gpgr::Encrypt.file('/tmp/i_just_made_this_up')
+    o.using [ 'nobody@example.com' ]
+    assert_raise Gpgr::Encrypt::InvalidFileException do
+      o.encrypt
+    end
+    assert !File.exists?(o.file_output)
   end
  
 end

data/test/test_helper.rb

@@ -8,35 +8,6 @@ GPGR_ROOT = File.expand_path(File.dirname(__FILE__) + '/../lib')
 #
 require GPGR_ROOT + '/gpgr.rb'
 
-
-
-# Helper methods for the tests.
-#
-
-def generate_key_for(email, name)
-  file_path = "/tmp/gpgr_testing_#{Time.now.to_i}"
-  params = <<-PGP
-Key-Type: DSA
-Key-Length: 1024
-Subkey-Type: ELG-E
-Subkey-Length: 1024
-Name-Real: #{name}
-Name-Comment: with stupid passphrase
-Name-Email: #{email}
-Expire-Date: 0
-Passphrase: abc
-%pubring #{file_path}.pub
-%secring #{file_path}.sec
-%commit
-  PGP
-  `echo '#{params}' | gpg -q --no-verbose --batch --gen-key -a`
-  if File.exists?(file_path + '.pub')
-    return file_path + '.pub'
-  else
-    raise "ARRGH"
-  end
-end
-
 def remove_installed_key(email)
   system "gpg -q --no-verbose --delete-key --yes --batch #{email}"
 end

data/test/test_key_management_functionality.rb

@@ -40,10 +40,8 @@ class TestKeyManagementFunctionality < Test::Unit::TestCase
   end
   
   def setup_for_key_tests
-    puts "=>\tGenerating keys for test - please wait"
-    @john_key = generate_key_for('john@example.com','John Test')
-    @mark_key = generate_key_for('mark@example.com','Mark Test')
-    puts "=>\tDone!"
+    @john_key = File.dirname(__FILE__) + '/john_and_marks_keys/john.pub'
+    @mark_key = File.dirname(__FILE__) + '/john_and_marks_keys/mark.pub'
   end
   
   def teardown_for_key_tests

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: gpgr
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Ryan Stenhouse
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-18 00:00:00 +00:00
+date: 2010-03-19 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -26,16 +31,19 @@ extra_rdoc_files:
 - COPYING
 files: 
 - lib/gpgr.rb
-- test/test_keys/testing_1268859031.pub
+- test/generate_keys.rb
+- test/john_and_marks_keys/john.pub
+- test/john_and_marks_keys/mark.pub
+- test/test_file_encryption_functionality.rb
+- test/test_helper.rb
+- test/test_key_management_functionality.rb
 - test/test_keys/testing_1268859016.pub
 - test/test_keys/testing_1268859023.pub
-- test/test_key_management_functionality.rb
-- test/test_file_encryption_functionality.rb
+- test/test_keys/testing_1268859031.pub
 - test/test_keys_with_non_key_files/test.csv
-- test/test_keys_with_non_key_files/testing_1268859031.pub
 - test/test_keys_with_non_key_files/testing_1268859016.pub
 - test/test_keys_with_non_key_files/testing_1268859023.pub
-- test/test_helper.rb
+- test/test_keys_with_non_key_files/testing_1268859031.pub
 - Rakefile
 - HACKING
 - README.markdown
@@ -50,7 +58,7 @@ rdoc_options:
 - --title
 - Gpgr Documentation
 - --main
-- README
+- lib/gpgr.rb
 - -q
 require_paths: 
 - lib
@@ -58,18 +66,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: gpgr
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A lightweight GPG CLI interface for encyrypting files