gpgr 0.0.4 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa19ce161bda622a5e0f932624e885421b6e1345
+  data.tar.gz: 77ec9bf0a0f814c93d1ad5d1f411aab296d74a71
+SHA512:
+  metadata.gz: db43325774a05f02c6c4dbfd2d22cd7c879d73cd928efddb437ead88b3d29a04c5c9a391e99f87b2d4926afbdab5315958f12995f6c68b7758fbf09d0acf022c
+  data.tar.gz: ba54d526fb0f3c7aed077cc5cc28ab0222a2090513437cb578466a4d3b0114d8aa747d2f81680ec76b8e32c374477555d7c06f39fb45ac4fc14d8e09d2211f84

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ryan@ryanstenhouse.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gpgr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryan Stenhouse
+
+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 → README.md}

@@ -1,8 +1,12 @@
-#gpgr - GNU Privacy Guard Encryption in Ruby 
-March 2010, Ryan Stenhouse <ryan@ryanstenhouse.eu> on behalf of [Purchasing
-Card Consultancy Limited][1]
+# gpgr - GNU Privacy Guard Encryption in Ruby
+March 2010 - Present, Ryan Stenhouse <ryan@ryanstenhouse.eu>
+Originally behalf of [Purchasing Card Consultancy Limited][1].
 
-##About
+> The current development version of gpgr is released under the MIT
+> license. Previous versions were licensed under the GNU GPL. If you
+> require the use of a GNU GPL version, please  use `0.0.4`.
+
+## About
 
 gpgr is a lightweight and fast wrapper around the <tt>gpg</tt> command
 commonly found on Linux and other Unix-like operating systems.
@@ -12,28 +16,28 @@ end aside from some basic key-management support, it will not wrap any
 other parts of the gpg functionality.
 
 If you need something that will elegantly and quickly encrypt files for
-you and make managing the keys used within your application for this 
+you and make managing the keys used within your application for this
 purpose a snap, use this. If not, use something else.
 
-##Installation
+## Installation
 
 From Rubygems:
 
-	gem install gpgr
+  gem install gpgr
 
 From GitHub:
-	
-	Download or Clone the repoistory or just gpgr.rb and include it where
-	you need it.
+
+  Download or Clone the repoistory or just gpgr.rb and include it where
+  you need it.
 
 
-##Requirements
+## Requirements
 
 gpgr has only really been tested on *nix environments, and indeed the path
 hard-coded by default for the gpg binary will only be meaningful if you're
 using a Linux-based or other UNIX-like operating system.
 
-The only requirement (apart, obviously, from Ruby) is that you have gpg 
+The only requirement (apart, obviously, from Ruby) is that you have gpg
 installed. On most modern Linux distributions, it should be there by default
 to verify, open a terminal and key in:
 
@@ -42,19 +46,19 @@ to verify, open a terminal and key in:
 If you see something like:
 
 <pre>
-	ryan@ubuntu:~$ gpg --version
-	gpg (GnuPG) 1.4.6
-	Copyright (C) 2006 Free Software Foundation, Inc.
-	This program comes with ABSOLUTELY NO WARRANTY.
-	This is free software, and you are welcome to redistribute it
-	under certain conditions. See the file COPYING for details.
-
-	Home: ~/.gnupg
-	Supported algorithms:
-	Pubkey: RSA, RSA-E, RSA-S, ELG-E, DSA
-	Cipher: 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH
-	Hash: MD5, SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224
-	Compression: Uncompressed, ZIP, ZLIB, BZIP2
+  ryan@ubuntu:~$ gpg --version
+  gpg (GnuPG) 1.4.6
+  Copyright (C) 2006 Free Software Foundation, Inc.
+  This program comes with ABSOLUTELY NO WARRANTY.
+  This is free software, and you are welcome to redistribute it
+  under certain conditions. See the file COPYING for details.
+
+  Home: ~/.gnupg
+  Supported algorithms:
+  Pubkey: RSA, RSA-E, RSA-S, ELG-E, DSA
+  Cipher: 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH
+  Hash: MD5, SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224
+  Compression: Uncompressed, ZIP, ZLIB, BZIP2
 </pre>
 
 Congratulations.
@@ -67,11 +71,11 @@ As well as installing the command-line tools gpgr expects, seahorse which,
 is a fantastic graphical tool for managing your keys, will be installed
 
 
-For **Mac OS X**, you will first need to install <tt>gpg</tt>, you can do 
+For **Mac OS X**, you will first need to install <tt>gpg</tt>, you can do
 this through MacPorts or Frink, but the best way is through [MacGPG][2], just
 [download the latest version][3] and install int <tt>.pkg</tt> file it downloads.
 
-##A Note on Testing
+## A Note on Testing
 
 Since gpgr really is just firing of to the GPG binary to all of the real work, there is little
 to test within gpgr itself. I've added the tests I feel are prudent and useful. Feel free to
@@ -81,10 +85,6 @@ I do take the view, however, that GPG it's self is a very well established and p
 project; and as such - any tests which attempt to test that *gpg* is functioning correctly will
 not be accepted - I'm happy to assume that it is.
 
-##Status
-
-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/

data/Rakefile

@@ -1,62 +1,11 @@
-require 'rubygems'
-require 'rake'
+require "bundler/gem_tasks"
 require 'rake/testtask'
-require "rake/rdoctask"
-require "rake/gempackagetask"  
 
-GPGR_VERSION = "0.0.4" 
+task :default => :test
 
-task :default => [:test]
-       
-desc "Run all tests, test-spec, mocha, and pdf-reader required"
 Rake::TestTask.new do |test|
   # test.ruby_opts  << "-w"  # .should == true triggers a lot of warnings
   test.libs       << "testrb"
   test.test_files =  Dir[ "test/test_*.rb" ]
   test.verbose    =  true
 end
-
-desc "genrates documentation"
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include( "README.markdown",
-                           "COPYING",
-                           "LICENSE", 
-                           "HACKING", "lib/" )
-  rdoc.main     = "lib/gpgr.rb"
-  rdoc.rdoc_dir = "doc/html"
-  rdoc.title    = "Gpgr Documentation"
-end     
-
-spec = Gem::Specification.new do |spec|
-  spec.name = "gpgr"
-  spec.version = GPGR_VERSION
-  spec.platform = Gem::Platform::RUBY
-  spec.summary = "A lightweight GPG CLI interface for encyrypting files"
-  spec.files =  Dir.glob("{lib,spec,test}/**/**/*") +
-                      ["Rakefile"]
-  spec.require_path = "lib"
-
-  spec.test_files = Dir[ "test/*_test.rb" ]
-  spec.has_rdoc = true
-  spec.extra_rdoc_files = %w{HACKING README.markdown LICENSE COPYING}
-  spec.rdoc_options << '--title' << 'Gpgr Documentation' <<
-                       '--main'  << 'lib/gpgr.rb' << '-q'
-  spec.author = "Ryan Stenhouse"
-  spec.email = "  ryan@ryanstenhouse.eu"
-  spec.rubyforge_project = "gpgr"
-  spec.homepage = "http://ryanstenhouse.eu"
-  spec.description = <<END_DESC
-  gpgr is a very light interface to the command-line GPG (GNU 
-  Privacy Guard) tool which is soley concerned with making it
-  as easy as possible to encrypt files with one (or more) public
-  keys.
-
-  It does not provide any major key management tools and does not
-  support decryption.   
-END_DESC
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end

data/bin/gpgr-console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gpgr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/gpgr-setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gpgr.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gpgr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gpgr"
+  spec.version       = Gpgr::VERSION
+  spec.authors       = ["Ryan Stenhouse"]
+  spec.email         = ["ryan@ryanstenhouse.eu"]
+
+  spec.summary       = %q{A lightweight GPG CLI interface for encyrypting files}
+  spec.description   = <<-END_DESC
+    gpgr is a very light interface to the command-line GPG (GNU
+    Privacy Guard) tool which is soley concerned with making it
+    as easy as possible to encrypt files with one (or more) public
+    keys.
+    It does not provide any major key management tools and does not
+    support decryption.
+  END_DESC
+  spec.homepage      = "https://ryanstenhouse.jp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "minitest"#, "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gpgr.rb

@@ -1,16 +1,18 @@
+require "gpgr/version"
+
 #  Gpgr by Ryan Stenhouse <ryan@ryanstenhouse.eu>, March 2010
 #  on behalf of Purchasing Card Consultancy Limited.
 #
-#  gpgr is a very light interface to the command-line GPG (GNU 
+#  gpgr is a very light interface to the command-line GPG (GNU
 #  Privacy Guard) tool which is soley concerned with making it
 #  as easy as possible to encrypt files with one (or more) public
 #  keys.
 #
 #  It does not provide any major key management tools and does not
-#  support decryption.   
+#  support decryption.
 #
 #  Usage:
-#    
+#
 #    require 'rubygems'
 #    require 'gpgr'
 #
@@ -22,14 +24,14 @@
 #    # 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 
+  # Returns the command to execute to run GPG. It is defualted to /use/bin/env gpg
   # which should correctly track down gpg on any UNIX-like operating system. If you
   # need to use this on Windows, simply change the method to return the path to where
   # gpg is installed.
@@ -45,7 +47,7 @@ module Gpgr
   # is done by the class GpgGileForEncryption.
   #
   module Encrypt
-    
+
     # Takes the path to the file you want to encrypt; and returns a GpgFileForEncryption
     # object for you to modify with the people (e-mail addresses) you want to encrypt this
     # file for. Optionally you can specify where you want the encrypted file to be written,
@@ -56,7 +58,7 @@ 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
@@ -64,15 +66,15 @@ module Gpgr
     # 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
-      
+
       # The path to the file which GPG Will be encrypting and the path where
       # you want the encrypted file to be output.
       #
@@ -85,34 +87,34 @@ module Gpgr
         end
         @email_addresses = []
       end
-      
+
       # Takes a list of e-mail addresses and then encrypts the file straight away.
       #
       def encrypt_using(email_addresses)
         using(email_addresses)
         encrypt
       end
-      
-      # Expects an array of e-mail addresses for people who this file file should be  
-      # decryptable by. 
+
+      # Expects an array of e-mail addresses for people who this file file should be
+      # decryptable by.
       #
       def using(email_addresses)
         @email_addresses = email_addresses
       end
-      
+
       # Encrypts the current file for the list of recipients specific (if they are valid)
-      #   
+      #
       def encrypt
         bad_key = @email_addresses.empty?
-        
-        if File.exists?(@file)
+
+        if File.exist?(@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
@@ -125,7 +127,7 @@ module Gpgr
           system(command)
         end
       end
-      
+
     end
 
   end
@@ -133,7 +135,7 @@ module Gpgr
   # Encapsulates all the functionality for dealing with GPG Keys. There isn't much here since
   # key managment isn't really one of the goals of this project. It will, however, allow you
   # to import new keys and provides a means to list existing installed keys.
-  # 
+  #
   module Keys
 
     # Imports the key at the specified path into the keyring. Since this is
@@ -146,14 +148,14 @@ module Gpgr
 
     # Iterates through all of the files at a specified path and attempts to import
     # those which are likely to be GPG / PGP Public Keys.
-    # 
+    #
     def self.import_keys_at(path)
       Dir.new(path).each do |file|
         next if ['..','.'].include?(file)
         Gpgr::Keys.import(path + '/' + file)
       end
     end
-    
+
     # Returns an array with the e-mail addresses of every installed public key
     # for looping through and detecting if a particular key is installed.
     #
@@ -164,26 +166,26 @@ module Gpgr
       # Select the output to grep for, which is different depending on the version
       # of GPG installed. This is tested on 1.4 and 2.1.
       #
-      if `#{Gpgr.command} --version | grep GnuPG`.include?('1.')
-        grep_for = 'pub'
-      else
+      if `#{Gpgr.command} --version | grep GnuPG`.include?('2.')
         grep_for = 'uid'
+      else
+        grep_for = 'pub'
       end
 
-      `#{Gpgr.command} --list-public-keys --with-colons | grep #{grep_for}`.split("\n").each do |key| 
+      `#{Gpgr.command} --list-public-keys --with-colons | grep #{grep_for}`.split("\n").each do |key|
         keys << email_regexp.match(key)[1].upcase
       end
 
       keys.uniq
     end
-    
+
     # Simply checks to see if the e-mail address passed through as an argument has a
     # public key attached to it by checking in installed_public_keys.
     #
     def self.public_key_installed?(email)
       installed_public_keys.include?(email.upcase)
     end
-    
+
   end
 
 end