rspec-pgp_matchers 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eb943083ec74aa48972ac296c695d83b3831dbbbfd48b5300d7c92bd532a9a0
-  data.tar.gz: 9ca2cace83e1de7d6e8647fa5cbae910c877350e0b52078c7fe940c850c42baa
+  metadata.gz: 1880492b5a4864c566a6fa6004a9646d930d1ad232044384d3e6412b1e796891
+  data.tar.gz: ae2aadaa6617b9243f1625f2e6b1b990ce00efd9b3da67c1d9a93d12f723092c
 SHA512:
-  metadata.gz: 5efad5d499ec287768df9b3ad4ca606f10f6693b100241a9b9d1643751e2acfdcb615976223f696d590015d84d8dd38ec430c750fdea56435741f6f97b0a22c7
-  data.tar.gz: 0040f095aac149995cef3451d6fb697919c3f39e5da412d62044c4e57d14cf19d30fa7e81fbdaa10214d1b96d6772e5330501f548e8dae40a1079cefc97065fe
+  metadata.gz: f40aa2b0c66764c28b155e9540d581a89452b31fba2ecde2adf66a98e57ee3f6da210de4bebac78c3a62da8422aa1fc127f110c212045353b0f98abf0a047702
+  data.tar.gz: 160c8706ecb7c149594faba75351ca6ff7c9c1a0ca1270a0aa17921902469baf30eff5fcb0bf28dc38e7d38a5826ef7c16426d682d25fbc5c1ef911e5520448e

data/README.adoc

@@ -11,6 +11,9 @@ image:https://img.shields.io/codeclimate/maintainability/riboseinc/rspec-pgp_mat
 
 RSpec matchers for testing PGP-encrypted messages, and signatures.
 
+CAUTION: This gem is not meant to bridge GnuPG executables to production
+environments.  Use it in developments and tests only.
+
 IMPORTANT: This gem calls GnuPG executables internally.  However, it does not
 rely on machine-readable interface yet, and may easily break when they change
 something in GnuPG's human-readable output. As long as it is not resolved in
@@ -86,6 +89,28 @@ expect(encrypted).to be_a_pgp_encrypted_message.encrypted_for(recipient1_uid, re
 expect(encrypted).to be_a_pgp_encrypted_message.encrypted_for(someones_uid)
 ----
 
+=== Running arbitrary GnuPG commands
+
+An `RSpec::PGPMatchers::GPGRunner` module can be used to run arbitrary GnuPG
+commands:
+
+[source,ruby]
+----
+RSpec::PGPMatchers::GPGRunner.run_command("--decrypt PATH_TO_FILE")
+RSpec::PGPMatchers::GPGRunner.run_command("--list-keys")
+----
+
+Also, convenient helpers are defined for two common commands:
+
+[source,ruby]
+----
+RSpec::PGPMatchers::GPGRunner.run_decrypt("encrypted_string")
+RSpec::PGPMatchers::GPGRunner.run_verify("cleartext", "signature_string")
+----
+
+In all above cases, a triple consisting of captured standard output, captured
+standard error, and `Process::Status` instance is returned.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/ci/gemfiles/common.gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 gemspec path: "../.."
 
 gem "codecov", require: false
-gem "simplecov", require: false
+gem "simplecov", require: false

data/lib/rspec/pgp_matchers/be_a_pgp_encrypted_message.rb

@@ -43,7 +43,7 @@ RSpec::Matchers.define :be_a_pgp_encrypted_message do
 
   # Returns +nil+ if signature is valid, or an error message otherwise.
   def validate_encrypted_message(encrypted_string)
-    cmd_output = run_gpg_decrypt(encrypted_string)
+    cmd_output = run_decrypt(encrypted_string)
     cmd_result = analyse_decrypt_output(*cmd_output)
 
     if cmd_result[:well_formed_pgp_data]
@@ -53,12 +53,6 @@ RSpec::Matchers.define :be_a_pgp_encrypted_message do
     end
   end
 
-  def run_gpg_decrypt(encrypted_string)
-    enc_file = make_tempfile_containing(encrypted_string)
-    cmd = gpg_decrypt_command(enc_file)
-    run_command(cmd)
-  end
-
   def analyse_decrypt_output(stdout_str, stderr_str, status)
     {
       well_formed_pgp_data: (status.exitstatus != 2),
@@ -76,18 +70,6 @@ RSpec::Matchers.define :be_a_pgp_encrypted_message do
     ].detect { |x| x }
   end
 
-  def gpg_decrypt_command(enc_file)
-    homedir_path = Shellwords.escape(RSpec::PGPMatchers.homedir)
-    enc_path = Shellwords.escape(enc_file.path)
-
-    <<~SH
-      gpg \
-      --homedir #{homedir_path} \
-      --no-permission-warning \
-      --decrypt #{enc_path}
-    SH
-  end
-
   def msg_mismatch(text)
     "expected given Open PGP message to contain following " +
       "text:\n#{expected_cleartext}\nbut was:\n#{text}"

data/lib/rspec/pgp_matchers/be_a_valid_pgp_signature_of.rb

@@ -37,7 +37,7 @@ RSpec::Matchers.define :be_a_valid_pgp_signature_of do |text|
 
   # Returns +nil+ if first signature is valid, or an error message otherwise.
   def verify_signature(cleartext, signature_string)
-    cmd_output = run_gpg_verify(cleartext, signature_string)
+    cmd_output = run_verify(cleartext, signature_string)
     cmd_result = analyse_verify_output(*cmd_output)
 
     if cmd_result[:well_formed_pgp_data]
@@ -47,13 +47,6 @@ RSpec::Matchers.define :be_a_valid_pgp_signature_of do |text|
     end
   end
 
-  def run_gpg_verify(cleartext, signature_string)
-    sig_file = make_tempfile_containing(signature_string)
-    data_file = make_tempfile_containing(cleartext)
-    cmd = gpg_verify_command(sig_file, data_file)
-    run_command(cmd)
-  end
-
   def analyse_verify_output(_stdout_str, stderr_str, status)
     {
       well_formed_pgp_data: (status.exitstatus != 2),
@@ -65,19 +58,6 @@ RSpec::Matchers.define :be_a_valid_pgp_signature_of do |text|
     match_signature(signature)
   end
 
-  def gpg_verify_command(sig_file, data_file)
-    homedir_path = Shellwords.escape(RSpec::PGPMatchers.homedir)
-    sig_path = Shellwords.escape(sig_file.path)
-    data_path = Shellwords.escape(data_file.path)
-
-    <<~SH
-      gpg \
-      --homedir #{homedir_path} \
-      --no-permission-warning \
-      --verify #{sig_path} #{data_path}
-    SH
-  end
-
   def msg_mismatch(text)
     "expected given signature to be a valid Open PGP signature " +
       "of following text:\n#{text}"

data/lib/rspec/pgp_matchers/gpg_matcher_helper.rb

@@ -7,6 +7,10 @@ require "tempfile"
 module RSpec
   module PGPMatchers
     module GPGMatcherHelper
+      extend Forwardable
+
+      def_delegators :"RSpec::PGPMatchers::GPGRunner", :run_verify, :run_decrypt
+
       def detect_signers(stderr_str)
         rx = /(?<ok>Good|BAD) signature from .*\<(?<email>[^>]+)\>/
 
@@ -47,17 +51,6 @@ module RSpec
           msg_wrong_signer(signature[:email])
         end
       end
-
-      def make_tempfile_containing(file_content)
-        tempfile = Tempfile.new
-        tempfile.write(file_content)
-        tempfile.flush
-      end
-
-      def run_command(cmd)
-        env = { "LC_ALL" => "C" } # Gettext English locale
-        Open3.capture3(env, cmd)
-      end
     end
   end
 end

data/lib/rspec/pgp_matchers/gpg_runner.rb

@@ -0,0 +1,58 @@
+# (c) Copyright 2018 Ribose Inc.
+#
+
+require "open3"
+require "tempfile"
+
+module RSpec
+  module PGPMatchers
+    module GPGRunner
+      class << self
+        def run_command(gpg_cmd)
+          env = { "LC_ALL" => "C" } # Gettext English locale
+
+          homedir_path = Shellwords.escape(RSpec::PGPMatchers.homedir)
+
+          Open3.capture3(env, <<~SH)
+            gpg \
+            --homedir #{homedir_path} \
+            --no-permission-warning \
+            #{gpg_cmd}
+          SH
+        end
+
+        def run_decrypt(encrypted_string)
+          enc_file = make_tempfile_containing(encrypted_string)
+          cmd = gpg_decrypt_command(enc_file)
+          run_command(cmd)
+        end
+
+        def run_verify(cleartext, signature_string)
+          sig_file = make_tempfile_containing(signature_string)
+          data_file = make_tempfile_containing(cleartext)
+          cmd = gpg_verify_command(sig_file, data_file)
+          run_command(cmd)
+        end
+
+        private
+
+        def make_tempfile_containing(file_content)
+          tempfile = Tempfile.new
+          tempfile.write(file_content)
+          tempfile.flush
+        end
+
+        def gpg_decrypt_command(enc_file)
+          enc_path = Shellwords.escape(enc_file.path)
+          "--decrypt #{enc_path}"
+        end
+
+        def gpg_verify_command(sig_file, data_file)
+          sig_path = Shellwords.escape(sig_file.path)
+          data_path = Shellwords.escape(data_file.path)
+          "--verify #{sig_path} #{data_path}"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/pgp_matchers/version.rb

@@ -3,6 +3,6 @@
 
 module RSpec
   module PGPMatchers
-    VERSION = "0.1.0".freeze
+    VERSION = "0.1.1".freeze
   end
 end

data/lib/rspec/pgp_matchers.rb

@@ -3,6 +3,7 @@
 
 require "rspec/pgp_matchers/version"
 require "rspec/pgp_matchers/gpg_matcher_helper"
+require "rspec/pgp_matchers/gpg_runner"
 require "rspec/pgp_matchers/be_a_pgp_encrypted_message"
 require "rspec/pgp_matchers/be_a_valid_pgp_signature_of"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-pgp_matchers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
@@ -135,6 +135,7 @@ files:
 - lib/rspec/pgp_matchers/be_a_pgp_encrypted_message.rb
 - lib/rspec/pgp_matchers/be_a_valid_pgp_signature_of.rb
 - lib/rspec/pgp_matchers/gpg_matcher_helper.rb
+- lib/rspec/pgp_matchers/gpg_runner.rb
 - lib/rspec/pgp_matchers/version.rb
 - rspec-pgp_matchers.gemspec
 homepage: https://github.com/riboseinc/rspec-pgp_matchers