mail-gpg 0.0.2 → 0.0.3

data/.gitignore

@@ -1,5 +1,4 @@
 .ruby-version
-test/gpghome
 *.gem
 *.rbc
 .bundle

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+gemfile:
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails4.gemfile

data/History.txt

@@ -1,3 +1,9 @@
+== 0.0.3 2013-08-20
+
+* better ActionMailer integration
+* 'gpg encrypt: true' instead of 'gpg true'
+* test coverage
+
 == 0.0.2 2013-08-19
 
 * ActionMailer integration

data/README.md

@@ -1,4 +1,4 @@
-# Mail::Gpg
+# Mail::Gpg [![Build Status](https://travis-ci.org/jkraemer/mail-gpg.png?branch=master)](https://travis-ci.org/jkraemer/mail-gpg)
 
 This gem adds GPG/MIME encryption capabilities to the [Ruby Mail
 Library](https://github.com/mikel/mail)
@@ -32,19 +32,19 @@ with the gpg method:
       add_file "some_attachment.zip"
 
       # encrypt message, no signing
-      gpg true
+      gpg encrypt: true
 
       # encrypt and sign message with sender's private key, using the given
       # passphrase to decrypt the key
-      gpg sign: true, password: 'secret'
+      gpg encrypt: true, sign: true, password: 'secret'
 
       # encrypt and sign message using a different key
-      gpg sign_as: 'joe@otherdomain.com', password: 'secret'
+      gpg encrypt: true, sign_as: 'joe@otherdomain.com', password: 'secret'
 
 
       # encrypt and sign message and use a callback function to provide the
       # passphrase.
-      gpg sign_as: 'joe@otherdomain.com',
+      gpg encrypt: true, sign_as: 'joe@otherdomain.com',
           passphrase_callback: ->(obj, uid_hint, passphrase_info, prev_was_bad, fd){puts "Enter passphrase for #{passphrase_info}: "; (IO.for_fd(fd, 'w') << readline.chomp).flush }
     end.deliver
 
@@ -64,11 +64,11 @@ armored key data for recipients using the `:keys` option like this:
 
     Mail.new do
       to 'john@foo.bar'
-      gpg keys: { 'john@foo.bar' => johns_key }
+      gpg encrypt: true, keys: { 'john@foo.bar' => johns_key }
     end
 
 The key will then be imported before actually trying to encrypt/send the mail.
-SoiIn theory you only need to specify the key once like that, however doing it
+In theory you only need to specify the key once like that, however doing it
 every time does not hurt as gpg is clever enough to recognize known keys, only
 updating it's db when necessary.
 
@@ -85,7 +85,7 @@ This is not implemented yet
     class MyMailer < ActionMailer::Base
       default from: 'baz@bar.com'
       def some_mail
-        mail to: 'foo@bar.com', subject: 'subject!', gpg: true
+        mail to: 'foo@bar.com', subject: 'subject!', gpg: { encrypt: true }
       end
     end
 
@@ -96,19 +96,19 @@ Mail::Message#gpg method.
 
     bundle exec rake
 
-The first run will take a while since it sets up a mock gpg home directory in
-`test/gpghome` containing two different identities used in the test cases.
-Following test runs will use that directory if it still exists and will
-therefore be substantially faster.
+Test cases use a mock gpghome located in `test/gpghome` in order to not mess
+around with your personal gpg keychain.
+
 
 ## Todo
 
 * Signing of unencrypted mails
-* Decryption
-* Signature verification
-* Add optional on the fly import of recipients' keys from public key servers based on email address
-* Send encrypted mails to recipients when possible, fall back to unencrypted
-  mail otherwise
+* Decryption and signature verification for received mails
+* on the fly import of recipients' keys from public key servers based on email address or key id
+* handle encryption errors due to missing keys - maybe return a list of failed
+  recipients
+* add some setup code to help initialize a basic keychain directory with
+  public/private keypair.
 
 
 ## Contributing

data/gemfiles/rails3.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gem 'mail', '~> 2.5.3'
+gem 'gpgme', '~> 2.0.2'
+gem 'actionmailer', '~> 3.2.14'
+
+gem 'shoulda-context', '~> 1.1.5'
+

data/gemfiles/rails4.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gem 'mail', '~> 2.5.3'
+gem 'gpgme', '~> 2.0.2'
+gem 'actionmailer', '~> 4.0.0'
+
+gem 'shoulda-context', '~> 1.1.5'
+
+

data/lib/mail/gpg/delivery_handler.rb

@@ -6,12 +6,26 @@ module Mail
         if mail.gpg
           encrypted_mail = nil
           begin
-            options = TrueClass === mail.gpg ? {} : mail.gpg
-            encrypted_mail = Mail::Gpg.encrypt(mail, options)
+            options = TrueClass === mail.gpg ? { encrypt: true } : mail.gpg
+            if options.delete(:encrypt)
+              encrypted_mail = Mail::Gpg.encrypt(mail, options)
+            elsif options[:sign] || options[:sign_as]
+              raise "signing without encryption is not supported yet"
+            else
+              # encrypt and sign are off -> do not encrypt or sign
+              yield
+            end
           rescue Exception
             raise $! if mail.raise_encryption_errors
           end
-          encrypted_mail.deliver if encrypted_mail
+          if encrypted_mail
+            if dm = mail.delivery_method
+              encrypted_mail.instance_variable_set :@delivery_method, dm
+            end
+            encrypted_mail.perform_deliveries = mail.perform_deliveries
+            encrypted_mail.raise_delivery_errors = mail.raise_delivery_errors
+            encrypted_mail.deliver
+          end
         else
           yield
         end

data/lib/mail/gpg/message_patch.rb

@@ -21,7 +21,11 @@ module Mail
       # See Mail::Gpg methods encrypt and sign for more
       # possible options
       #
-      # mail.gpg true
+      # mail.gpg encrypt: true
+      # mail.gpg encrypt: true, sign: true
+      # mail.gpg encrypt: true, sign_as: "other_address@host.com"
+      #
+      # future versions will also support sign-only mode:
       # mail.gpg sign_as: 'jane@doe.com', encrypt: false
       #
       # To turn off gpg encryption use:

data/lib/mail/gpg/version.rb

@@ -1,5 +1,5 @@
 module Mail
   module Gpg
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/mail/gpg/version_part.rb

@@ -5,7 +5,7 @@ module Mail
     class VersionPart < Mail::Part
       def initialize(*args)
         super
-        body 'Version 1.0'
+        body 'Version: 1'
         content_type 'application/pgp-encrypted'
         content_description 'PGP/MIME Versions Identification'
       end

data/test/action_mailer_test.rb

@@ -8,7 +8,7 @@ class MyMailer < ActionMailer::Base
   end
 
   def encrypted
-    mail subject: 'encrypted', body: 'encrypted mail', gpg: true
+    mail subject: 'encrypted', body: 'encrypted mail', gpg: {encrypt: true}
   end
 
 
@@ -30,7 +30,7 @@ class ActionMailerTest < Test::Unit::TestCase
 
     should "send encrypted mail" do
       assert m = MyMailer.encrypted
-      assert true == m.gpg
+      assert true == m.gpg[:encrypt]
       m.deliver
       assert_equal 1, @emails.size
       assert m = @emails.first

data/test/gpg_test.rb

@@ -13,7 +13,7 @@ class GpgTest < Test::Unit::TestCase
     assert_equal 2, encrypted.parts.size
     v_part, enc_part = encrypted.parts
 
-    assert_match /Version 1/, v_part.to_s
+    assert_match /Version: 1/, v_part.to_s
     assert_equal 'application/pgp-encrypted; charset=UTF-8', v_part.content_type
 
     assert_equal 'application/octet-stream; name=encrypted.asc',

data/test/message_test.rb

@@ -29,7 +29,7 @@ class MessageTest < Test::Unit::TestCase
 
     context "with gpg turned on" do
       setup do
-        @mail.gpg true
+        @mail.gpg encrypt: true
       end
 
       context "with missing key" do
@@ -77,7 +77,7 @@ class MessageTest < Test::Unit::TestCase
 
       should "set and unset delivery_handler" do
         m = Mail.new do
-          gpg true
+          gpg encrypt: true
         end
         assert m.gpg
         assert dh = m.delivery_handler

data/test/test_helper.rb

@@ -1,9 +1,13 @@
 require 'test/unit'
 require 'shoulda/context'
 require 'mail-gpg'
-require 'pry-nav'
 require 'action_mailer'
 
+begin
+  require 'pry-nav'
+rescue LoadError
+end
+
 Mail.defaults do
   delivery_method :test
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail-gpg
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -134,11 +134,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - History.txt
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/rails3.gemfile
+- gemfiles/rails4.gemfile
 - lib/hkp.rb
 - lib/mail-gpg.rb
 - lib/mail/gpg.rb
@@ -152,6 +155,11 @@ files:
 - mail-gpg.gemspec
 - test/action_mailer_test.rb
 - test/gpg_test.rb
+- test/gpghome/pubring.gpg
+- test/gpghome/pubring.gpg~
+- test/gpghome/random_seed
+- test/gpghome/secring.gpg
+- test/gpghome/trustdb.gpg
 - test/message_test.rb
 - test/test_helper.rb
 homepage: https://github.com/jkraemer/mail-gpg
@@ -182,5 +190,10 @@ summary: GPG/MIME encryption plugin for the Ruby Mail Library
 test_files:
 - test/action_mailer_test.rb
 - test/gpg_test.rb
+- test/gpghome/pubring.gpg
+- test/gpghome/pubring.gpg~
+- test/gpghome/random_seed
+- test/gpghome/secring.gpg
+- test/gpghome/trustdb.gpg
 - test/message_test.rb
 - test/test_helper.rb