ruby_gpg 0.2.0 → 0.3.0

data/CHANGELOG.markdown

@@ -1,3 +1,13 @@
+# v0.3.0 (2010-07-16)
+
+In which other people do my work for me...
+
+## Thanks to Scott and Divya of [gitcaps](http://github.com/gitcapps) for:
+
+* New `RubyGpg.encrypt_string` method.
+* Option to allow decryption of ascii armored files (*.asc).
+* Option to specify output filename.
+
 # v0.2.0 (2010-03-17)
 
 * Add `RubyGpg.decrypt_string` method.
@@ -8,4 +18,4 @@
 
 # v0.1.0 (2010-03-16)
 
-* First version with `RubyGpg.encrypt` and `RubyGpg.decrypt` methods.
+* First version with `RubyGpg.encrypt` and `RubyGpg.decrypt` methods.

data/README.markdown

@@ -27,6 +27,11 @@ for some reason, I guess you have to settle for this.
 For more details, see the
 [RDocs](http://rdoc.info/projects/blaix/ruby_gpg).
 
+## Credits
+
+Scott and Divya of [gitcaps](http://github.com/gitcapps) added some sorely
+missing features. Thanks, guys.
+
 ## Copyright
 
 Copyright (c) 2010 Justin Blake. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/ruby_gpg.rb

@@ -13,14 +13,32 @@ module RubyGpg
     " --no-secmem-warning --no-permission-warning --no-tty --yes"
   end
   
-  def encrypt(file, recipient)
-    command = "#{gpg_command} --output #{file}.gpg" +
+  def encrypt(file, recipient, opts = {})
+    options = {
+      :armor => false
+    }.merge(opts)
+    
+    output = output_filename(file, options)
+    
+    ascii = options[:armor] == true ? "-a " : ""
+    
+    command = "#{gpg_command} #{ascii}--output #{output}" +
               " --recipient \"#{recipient}\" --encrypt #{file}"
+    
     run_command(command)
   end
   
-  def decrypt(file, passphrase = nil)
-    outfile = file.gsub(/\.gpg$/, '')
+  # Encrypt a string from stdin
+  def encrypt_string(string, recipient, opts = {})
+    command = gpg_command.dup
+    command << " -a" if opts[:armor]
+    command << " --encrypt"
+    command << " --recipient \"#{recipient}\""
+    run_command(command, string)
+  end
+  
+  def decrypt(file, passphrase = nil, opts = {})
+    outfile = opts[:output].nil? ? file.gsub(/\.gpg$|\.asc$/, '') : opts[:output]
     command = "#{gpg_command} --output #{outfile}"
     command << " --passphrase #{passphrase}" if passphrase
     command << " --decrypt #{file}"
@@ -35,6 +53,7 @@ module RubyGpg
   end
   
   private
+  
   def run_command(command, input = nil)
     output = ""
     Open3.popen3(command) do |stdin, stdout, stderr|
@@ -48,4 +67,11 @@ module RubyGpg
     end
     output
   end
+  
+  # Return the output filename to use
+  def output_filename(file, opts)
+    extension = opts[:armor] ? "asc" : "gpg"
+    opts[:output].nil? ? "#{file}.#{extension}" : opts[:output]
+  end
+  
 end

data/ruby_gpg.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby_gpg}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Blake"]
-  s.date = %q{2010-03-17}
+  s.date = %q{2010-07-16}
   s.description = %q{Ruby wrapper for the gpg binary}
   s.email = %q{justin@megablaix.com}
   s.extra_rdoc_files = [
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/blaix/ruby_gpg}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Ruby wrapper for the gpg binary}
   s.test_files = [
     "spec/ruby_gpg_spec.rb",

data/spec/ruby_gpg_spec.rb

@@ -82,6 +82,61 @@ describe "RubyGpg" do
     end
   end
   
+  describe '.encrypt(filename, recipient, opts) with armor specified' do
+    def run_encrypt
+      RubyGpg.encrypt('filename', 'recipient', {:armor => true})
+    end
+    
+    it "saves armored version to filename.asc" do
+      expect_command_to_match("-a --output filename.asc")
+      run_encrypt
+    end
+  end
+  
+  describe '.encrypt(filename, recipient, opts) with ascii output file specified' do
+    def run_encrypt
+      RubyGpg.encrypt('filename', 'recipient', {:armor => true, :output => "foo.asc"})
+    end
+    
+    it "saves armored version to foo.asc" do
+      expect_command_to_match("-a --output foo.asc")
+      run_encrypt
+    end
+  end
+  
+  describe '.encrypt_string(string, recipient, opts)' do
+    def run_encrypt_string
+      RubyGpg.encrypt_string("string to encrypt", "recipient")
+    end
+    
+    it "uses the configured gpg command" do
+      expect_command_to_match(/^#{Regexp.escape(RubyGpg.gpg_command)}/)
+      run_encrypt_string
+    end
+    
+    it "issues an encrypt command to gpg" do
+      expect_command_to_match("--encrypt")
+      run_encrypt_string
+    end
+    
+    it "issues the encrypts command for the passed recipient" do
+      expect_command_to_match("--recipient \"recipient\"")
+      run_encrypt_string
+    end
+    
+    it "sends the passed string as stdin" do
+      @stdin.expects(:write).with('string to encrypt')
+      run_encrypt_string
+    end
+    
+    it "returns the encrypted string" do
+      @stdout.write("encrypted string")
+      @stdout.rewind
+      run_encrypt_string.should == "encrypted string"
+    end
+    
+  end
+  
   describe '.decrypt(filename)' do
     def run_decrypt(passphrase = nil)
       RubyGpg.decrypt('filename.gpg', passphrase)
@@ -108,7 +163,9 @@ describe "RubyGpg" do
     end
     
     it "saves decrypted version to filename without .gpg extension" do
-      expect_command_to_match("--output filename")
+      # Note the space after "filename". Without the space it is possible that
+      # the file extention still exists
+      expect_command_to_match("--output filename ")
       run_decrypt
     end
     
@@ -122,6 +179,25 @@ describe "RubyGpg" do
     end
   end
 
+  describe '.decrypt(filename) for asc file' do
+    def run_decrypt(passphrase = nil, opts = {})
+      RubyGpg.decrypt('filename.asc', passphrase, opts)
+    end
+    
+    it "issues the decrypt command for the ascii filename" do
+      # Note the space after "filename". Without the space it is possible that
+      # the file extention still exists
+      expect_command_to_match("--output filename ")
+      run_decrypt
+    end
+    
+    it "issues the decrypt command for the filename passed in options" do
+      expect_command_to_match("--output foo.txt ")
+      run_decrypt(nil, {:output => "foo.txt"})
+    end
+
+  end
+  
   describe '.decrypt_string(string)' do
     def run_decrypt_string(passphrase = nil)
       RubyGpg.decrypt_string('encrypted string', passphrase)

metadata

@@ -1,12 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_gpg
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Justin Blake
@@ -14,61 +9,49 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-17 00:00:00 -04:00
+date: 2010-07-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 9
         version: 1.2.9
-  type: :development
-  version_requirements: *id001
+    version: 
 - !ruby/object:Gem::Dependency 
   name: yard
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
-  version_requirements: *id002
+    version: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
-  version_requirements: *id003
+    version: 
 - !ruby/object:Gem::Dependency 
   name: mocha
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 8
         version: 0.9.8
-  type: :development
-  version_requirements: *id004
+    version: 
 description: Ruby wrapper for the gpg binary
 email: justin@megablaix.com
 executables: []
@@ -113,20 +96,18 @@ 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: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the gpg binary