cert_munger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 357e8e3b75fd4217745c092f3f35db2e59861c13
-  data.tar.gz: 1fabf56ee2f1b1a6bc5825660bcce5cc87bac450
+  metadata.gz: 2f3d57b7cab1e4d9a8e8e12854e7df697a67d4aa
+  data.tar.gz: 1b05487531aa24fe809d72b4042363702dc18a19
 SHA512:
-  metadata.gz: 1bd59cfc0d5761408303d454ffe3e78f13acd599823ea0d2fdaf2f24c0d03fd47488df3115091438a48aaa95965dc55fdad4e171236897843d05f6a061c0dacb
-  data.tar.gz: c1df8fc5c44007d583625958b99ed9fc24af73b85e700ba0a7736ccd81c283ec13ddefbbf8f8836a4c4eb7811f900cf436585c815e31aef3ce2e958a44a5a79b
+  metadata.gz: bfeab5bd41b934d4838c42c6ecd83b3917eb3cb312eee4f1b689c95ae86474e8e92b5da0be7ec576e842453dc52e357ccabcd3c0273c6a79368c903edeb7a516
+  data.tar.gz: 8d2fa7bd0d5f54cab96cbae8d15bc546e23f09d4d573a7b750ddf2c35b58a69537ab2e3ad02bfe3e0dc52b3f11818c9daf5e2b8da3d404cfd3cef061d9e1aa70

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -1,6 +1,6 @@
-[![Gem Version](https://badge.fury.io/rb/cert_munger.png)](http://badge.fury.io/rb/cert_munger) [![Coverage Status](https://coveralls.io/repos/stevenhaddox/cert_munger/badge.png)](https://coveralls.io/r/stevenhaddox/cert_munger) [![Code Climate](https://codeclimate.com/github/stevenhaddox/cert_munger/badges/gpa.svg)](https://codeclimate.com/github/stevenhaddox/cert_munger) [![Dependency Status](https://gemnasium.com/stevenhaddox/cert_munger.png)](https://gemnasium.com/stevenhaddox/cert_munger) [![Travis CI](https://travis-ci.org/stevenhaddox/cert_munger.svg?branch=master)](https://travis-ci.org/stevenhaddox/cert_munger.svg?branch=master)
+# CertMunger [![Gem Version](https://badge.fury.io/rb/cert_munger.png)](http://badge.fury.io/rb/cert_munger)
 
-# CertMunger
+[![Travis CI](https://travis-ci.org/stevenhaddox/cert_munger.svg?branch=master)](https://travis-ci.org/stevenhaddox/cert_munger) [![Dependency Status](https://gemnasium.com/stevenhaddox/cert_munger.png)](https://gemnasium.com/stevenhaddox/cert_munger) [![Coverage Status](https://coveralls.io/repos/stevenhaddox/cert_munger/badge.png)](https://coveralls.io/r/stevenhaddox/cert_munger) [![Code Climate](https://codeclimate.com/github/stevenhaddox/cert_munger/badges/gpa.svg)](https://codeclimate.com/github/stevenhaddox/cert_munger) [![Inline docs](http://inch-ci.org/github/stevenhaddox/cert_munger.svg?branch=master)](http://inch-ci.org/github/stevenhaddox/cert_munger)
 
 A gem that takes string input for X509 certificates and attempts to reformat
 them into a valid certificate. This gem extends the core String class to add

data/lib/cert_munger/formatter.rb

@@ -1,4 +1,6 @@
 require 'logging'
+
+# Custom exception for strings that can't be parsed as X509 Certificates
 class UnparsableCertError < TypeError; end
 
 #
@@ -6,24 +8,31 @@ class UnparsableCertError < TypeError; end
 # formatted certificate.
 #
 module CertMunger
+  # Enables `include CertMunger` to also extend class methods
   def self.included(base)
     base.extend(ClassMethods)
   end
 
+  # Instance variable accessor for CertMunger#to_cert
   def to_cert(raw_cert)
     self.class.send(:to_cert, raw_cert)
   end
 
   #
-  # Extended class methods via `include CertMunger`
+  # Class methods provided by CertMunger module
   #
   module ClassMethods
+    # logger method to return Rails logger if defined, else logging logger
     def logger
       return @logger if @logger
       logger = Logging.logger[self] unless @logger
       @logger ||= Kernel.const_defined?('Rails') ? Rails.logger : logger
     end
 
+    # Attempts to munge a string into a valid X509 certificate
+    #
+    # @param raw_cert [String] The string of text you wish to parse into a cert
+    # @return [OpenSSL::X509::Certificate]
     def to_cert(raw_cert)
       logger.debug "CertMunger raw_cert:\n#{raw_cert}"
       new_cert = build_cert(raw_cert)
@@ -33,6 +42,10 @@ module CertMunger
       OpenSSL::X509::Certificate.new new_cert
     end
 
+    # Creates a temporary cert and orchestrates certificate body reformatting
+    #
+    # @param raw_cert [String] The string of text you wish to parse into a cert
+    # @return [String] reformatted and (hopefully) parseable certificate string
     def build_cert(raw_cert)
       tmp_cert = ['-----BEGIN CERTIFICATE-----']
       if raw_cert.lines.count == 1
@@ -45,6 +58,10 @@ module CertMunger
       tmp_cert.join("\n").rstrip
     end
 
+    # Attempts to reformat one-line certificate bodies
+    #
+    # @param raw_cert [String] The string of text you wish to parse into a cert
+    # @return [String] reformatted certificate body
     def one_line_contents(raw_cert)
       cert_contents = raw_cert.split('\n')
       cert_contents.pop
@@ -52,6 +69,10 @@ module CertMunger
       cert_contents.map! { |el| el.match('\W+[t|n|r](.*)')[1] }
     end
 
+    # Attempts to reformat multi-line certificate bodies
+    #
+    # @param raw_cert [String] The string of text you wish to parse into a cert
+    # @return [String] reformatted certificate body
     def multi_line_contents(raw_cert)
       cert_contents = raw_cert.split(/[-](.*)[-]/)[2]
       cert_contents.lines.map do |line|

data/lib/cert_munger/string.rb

@@ -1,8 +1,11 @@
-class String # rubocop:disable Documentation
+#
+# Extend the core String class to include `.to_cert` && `.to_cert!`
+#
+class String
   include CertMunger
 
   # Returns an X509 certificate after parsing the value of this object.
-  # Returns false if an X509 certificate cannot be created.
+  # Returns false if an X509 certificate cannot be created
   def to_cert
     begin
       new_cert = self.class.send(:to_cert, self)
@@ -14,7 +17,7 @@ class String # rubocop:disable Documentation
   end
 
   # Similar to {#to_cert}, but raises an error unless the string can be
-  # explicitly parsed to an X509 certifcate.
+  # explicitly parsed to an X509 certifcate
   def to_cert!
     begin
       new_cert = self.class.send(:to_cert, self)

data/lib/cert_munger/version.rb

@@ -1,3 +1,3 @@
 module CertMunger
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cert_munger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Steven Haddox
@@ -197,6 +197,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md