ruby_gpg 0.1.0

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook :initialize do |at|
+  at.add_exception /test_keys\/.*/
+end

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+tmp
+doc
+.yardoc
+
+## PROJECT::SPECIFIC
+test_keys/random_seed

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Blake
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,32 @@
+# Ruby GPG
+
+Ruby wrapper for the `gpg` binary. You probably want to be using the
+`ruby-gpgme` gem instead, but if you can't install the gpgme libraries
+for some reason, I guess you have to settle for this.
+
+## Installation
+
+    gem install ruby_gpg
+
+## Configuration
+
+    # Defaults to "gpg"
+    RubyGpg.config.executable = "/custom/path/to/gpg"
+    
+    # Defaults to "~/.gnupg"
+    RubyGpg.config.homedir = "/custom/path/to/home"
+
+## Usage
+
+    # creates /path/to/file.gpg:
+    RubyGpg.encrypt("/path/to/file", "Mr. Recipient")
+  
+    # creates /path/to/file:
+    RubyGpg.decrypt("/path/to/file.gpg", "passphrase")
+
+For more details, see the
+[RDocs](http://rdoc.info/projects/blaix/ruby_gpg).
+
+## Copyright
+
+Copyright (c) 2010 Justin Blake. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby_gpg"
+    gem.summary = %Q{Ruby wrapper for the gpg binary}
+    gem.description = %Q{Ruby wrapper for the gpg binary}
+    gem.email = "justin@megablaix.com"
+    gem.homepage = "http://github.com/blaix/ruby_gpg"
+    gem.authors = ["Justin Blake"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/cucumber.yml

@@ -0,0 +1 @@
+default: features

data/features/decryption.feature

@@ -0,0 +1,17 @@
+Feature: Decryption
+  In order to read an encrypted file
+  As a user
+  I want to decrypt it
+  
+  Background:
+    Given a file named "secrets" containing "some content"
+    And a key pair for Slow Joe Crow with passphrase test
+
+  Scenario: Decrypt with proper recipient/recipient
+    Given I encrypt the file "secrets" for "Slow Joe Crow"
+    And the file "secrets" does not exist
+    When I decrypt the file "secrets.gpg" with passphrase "test"
+    Then the file "secrets" should exist
+    And the file "secrets" should contain "some content"
+  
+  # TODO: Scenario for failed decrypt (bad recipient and bad passprhase)

data/features/encryption.feature

@@ -0,0 +1,12 @@
+Feature: Encryption
+  In order to keep a file private
+  As a user
+  I want to encrypt the file
+
+  Scenario: Encrypt
+    Given a key pair for Slow Joe Crow with passphrase test
+    And a file named "secrets" containing "some content"
+    And the file "secrets.gpg" does not exist
+    When I encrypt the file "secrets" for "Slow Joe Crow"
+    Then the file "secrets.gpg" should exist
+    And the file "secrets.gpg" should not contain "some content"

data/features/step_definitions/ruby_gpg_steps.rb

@@ -0,0 +1,36 @@
+Given /^a key pair for Slow Joe Crow with passphrase test$/ do
+  # Already built keys in spec/gpg_home. Tell RubyGpg to use this...
+  RubyGpg.config.homedir = File.dirname(__FILE__) + '/../../test_keys'
+end
+
+Given /^a file named "([^\"]*)" containing "([^\"]*)"$/ do |filename, content|
+  File.open("#{TMP_PATH}/#{filename}", 'w') do |f|
+    f.write(content)
+  end
+end
+
+Given /^the file "([^\"]*)" does not exist$/ do |filename|
+  if File.exist?(filename)
+    File.delete("#{TMP_PATH}/#{filename}")
+  end
+end
+
+When /^I encrypt the file "([^\"]*)" for "([^\"]*)"$/ do |filename, recipient|
+  RubyGpg.encrypt("#{TMP_PATH}/#{filename}", recipient)
+end
+
+When /^I decrypt the file "([^\"]*)" with passphrase "([^\"]*)"$/ do |filename, passphrase|
+  RubyGpg.decrypt("#{TMP_PATH}/#{filename}", passphrase)
+end
+
+Then /^the file "([^\"]*)" should exist$/ do |filename|
+  File.exist?("#{TMP_PATH}/#{filename}").should be_true
+end
+
+Then /^the file "([^\"]*)" should not contain "([^\"]*)"$/ do |filename, content|
+  File.read("#{TMP_PATH}/#{filename}").should_not include(content)
+end
+
+Then /^the file "([^\"]*)" should contain "([^\"]*)"$/ do |filename, content|
+  File.read("#{TMP_PATH}/#{filename}").should include(content)
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'ruby_gpg'
+
+require 'spec/expectations'
+
+TMP_PATH = File.dirname(__FILE__) + '/../../tmp'
+
+class Object
+  def true?
+    !!self
+  end
+end

data/lib/ruby_gpg.rb

@@ -0,0 +1,42 @@
+require 'open3'
+
+module RubyGpg
+  extend self
+
+  Config = Struct.new(:executable, :homedir)
+  def config
+    @config ||=  Config.new("gpg", "~/.gnupg")
+  end
+
+  def gpg_command
+    "#{config.executable} --homedir #{config.homedir}" +
+    " --no-secmem-warning --no-permission-warning --no-tty --yes"
+  end
+  
+  def encrypt(file, recipient)
+    command = "#{gpg_command} --output #{file}.gpg" +
+              " --recipient \"#{recipient}\" --encrypt #{file}"
+    run_command(command)
+  end
+  
+  def decrypt(file, passphrase = nil)
+    outfile = file.gsub(/\.gpg$/, '')
+    command = "#{gpg_command} --output #{outfile}"
+    command << " --passphrase #{passphrase}" if passphrase
+    command << " --decrypt #{file}"
+    run_command(command)
+  end
+  
+  private
+  def run_command(command)
+    Open3.popen3(command) do |stdin, stdout, stderr|
+      stdin.close_write
+      unless $?.exitstatus == 0
+        msg = "GPG command (#{command}) failed"
+        errors = stderr.read
+        msg << " with: #{errors}" if errors && !errors.empty?
+        raise msg
+      end
+    end
+  end
+end

data/spec/ruby_gpg_spec.rb

@@ -0,0 +1,132 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RubyGpg" do
+  def expect_command_to_match(part_of_command)
+    Open3.expects(:popen3).with do |command|
+      case part_of_command
+      when Regexp: command =~ part_of_command
+      when String: command.include?(part_of_command)
+      else raise "Can't match that"
+      end
+    end
+  end
+  
+  def expect_error(error_message)
+    $?.stubs(:exitstatus).returns(1)
+    @stderr.write(error_message)
+    @stderr.rewind
+  end
+
+  before do
+    @stdin = StringIO.new
+    @stdout = StringIO.new
+    @stderr = StringIO.new
+    Open3.stubs(:popen3).yields(@stdin, @stdout, @stderr)
+    $?.stubs(:exitstatus).returns(0)
+  end
+  
+  it "allows the use of a custom path to the gpg executable" do
+    RubyGpg.config.executable = "/custom/path/to/gpg"
+    RubyGpg.gpg_command.should =~ /^\/custom\/path\/to\/gpg/
+  end
+  
+  it "allows the use of a custom gpg home directory" do
+    RubyGpg.config.homedir = "/custom/path/to/home"
+    RubyGpg.gpg_command.should include("--homedir /custom/path/to/home")
+  end
+  
+  it "should run with sane, headless defaults" do
+    command = RubyGpg.gpg_command
+    command.should include("--no-secmem-warning")
+    command.should include("--no-permission-warning")
+    command.should include("--no-tty")
+    command.should include("--yes")
+  end
+
+  describe '.encrypt(filename, recipient)' do
+    def run_encrypt
+      RubyGpg.encrypt('filename', 'recipient')
+    end
+    
+    it "uses the configured gpg command" do
+      expect_command_to_match(/^#{Regexp.escape(RubyGpg.gpg_command)}/)
+      run_encrypt
+    end
+    
+    it "issues an encrypt command to gpg" do
+      expect_command_to_match("--encrypt")
+      run_encrypt
+    end
+    
+    it "issues the encrypt command for the passed filename" do
+      expect_command_to_match(/filename$/)
+      run_encrypt
+    end
+    
+    it "issues the encrypts command for the passed recipient" do
+      expect_command_to_match("--recipient \"recipient\"")
+      run_encrypt
+    end
+    
+    it "saves encrypted version to filename.gpg" do
+      expect_command_to_match("--output filename.gpg")
+      run_encrypt
+    end
+    
+    it "raises any errors from gpg" do
+      expect_error("error message")  
+      lambda { run_encrypt }.should raise_error(/GPG command \(.*gpg.*--encrypt.*filename\) failed with: error message/)
+    end
+    
+    it "does not raise if there is no output from gpg" do
+      lambda { run_encrypt }.should_not raise_error
+    end
+  end
+  
+  describe '.decrypt(filename)' do
+    def run_decrypt(passphrase = nil)
+      RubyGpg.decrypt('filename.gpg', passphrase)
+    end
+    
+    it "uses the configured gpg command" do
+      expect_command_to_match(/^#{Regexp.escape(RubyGpg.gpg_command)}/)
+      run_decrypt
+    end
+    
+    it "issues a decrypt command to gpg" do
+      expect_command_to_match("--decrypt")
+      run_decrypt
+    end
+    
+    it "accepts an optional passphrase" do
+      expect_command_to_match("--passphrase secret")
+      run_decrypt("secret")
+    end
+
+    it "issues the decrypt command for the passed filename" do
+      expect_command_to_match(/filename\.gpg$/)
+      run_decrypt
+    end
+    
+    it "saves decrypted version to filename without .gpg extension" do
+      expect_command_to_match("--output filename")
+      run_decrypt
+    end
+    
+    it "raises any errors from gpg" do
+      expect_error("error message")
+      lambda { run_decrypt }.should raise_error(/GPG command \(.*gpg.*--decrypt.*filename\.gpg\) failed with: error message/)
+    end
+    
+    it "does not raise if there is no output from gpg" do
+      lambda { run_decrypt }.should_not raise_error
+    end
+    
+    it "does not raise when gpg spits 'successful' output to stderr" do
+      $?.stubs(:exitstatus).returns(0)
+      @stderr.write("success message")
+      @stderr.rewind
+      lambda { run_decrypt }.should_not raise_error
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ruby_gpg'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: ruby_gpg
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin Blake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id004
+description: Ruby wrapper for the gpg binary
+email: justin@megablaix.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .autotest
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- cucumber.yml
+- features/decryption.feature
+- features/encryption.feature
+- features/step_definitions/ruby_gpg_steps.rb
+- features/support/env.rb
+- lib/ruby_gpg.rb
+- spec/ruby_gpg_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- test_keys/pubring.gpg
+- test_keys/secring.gpg
+- test_keys/trustdb.gpg
+has_rdoc: true
+homepage: http://github.com/blaix/ruby_gpg
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the gpg binary
+test_files: 
+- spec/ruby_gpg_spec.rb
+- spec/spec_helper.rb