dnc 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66b1ef34df9cb502c35b85313bc576a3de31e043
-  data.tar.gz: 691ed00273f98ed06be51cf361b358965a25b00d
+  metadata.gz: a396eb196c442711ef2e116e7bc1a999ae5ccceb
+  data.tar.gz: d1bfc2c1f2a9ba9b76ae828e5d5d1c43751bcc71
 SHA512:
-  metadata.gz: ca789d0f4c60ea6c846debc8765f27f4388842551752eddccaddaef8a8fddbb5603a07899be98d4732bb2d7e442bcd7156fe2c9e8cb09b2c25abe3fc1fd43fcd
-  data.tar.gz: b338653735df756a52c15bf27c1cc32fce7c5017ace0f1de9f22be8fd6d3f83372ae0218b74b5b92b778039f26f31ed7df8b46126927d80da8b727f8168a2890
+  metadata.gz: 5d4f4c56864855d24f42fd8cc10ebe10f0a800e4645dfec23dfc3bb3c397ede886b49f6ec096b086a34567a60318f07711f7c77516cab87b11db175923405d76
+  data.tar.gz: 006cab85e2b1e56f9e2eddd4a2ebf8831488f0b468464c8ce37de6766e67ba768fb9086684f71723fd55c7ec9d68299f5d5d0c016f657511fca2db8b4800b0cc

data/.travis.yml

@@ -3,7 +3,6 @@ cache: bundler
 
 rvm:
   - ruby-head
-  - jruby-head
   - 2.1.2
   - 2.1.1
   - 2.0.0

data/README.md

@@ -1,39 +1,82 @@
 # Distinguished Name (DN) Converter
 
-TODO: Write a gem description
+Convert multiple X509 DN strings into a consistent format.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'dnc'
-```
+    gem 'dnc'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself with:
 
     $ gem install dnc
 
 ## Usage
 
+To create a DN instance:
+
 ```ruby
 require 'dnc'
-dn_string = 'CN=Some Valid, O=DN, OU=string'
-dn = DN.new(dn_string: dn_string)
+dn = DN.new(dn_string: '/C=US/OU=string/O=DN/CN=Some Valid')
 # Or:
-dn_string.to_dn
-# And:
-dn_string.to_dn.to_s
+dn = '/C=US/OU=string/O=DN/CN=Some Valid'.to_dn
+dn = '/C=US/OU=string/O=DN/CN=Some Valid'.to_dn!
+```
+
+To return a consistently formatted string:
+
+```ruby
+dn.to_s
+#=> 'CN=SOME VALID,O=DN,OU=STRING,C=US'
+```
+
+This is what a basic DN object looks like:
+
+```yaml
+puts dn.to_yaml
+#=>
+--- !ruby/object:DN
+dn_string: CN=SOME VALID/O=DN/OU=STRING/C=US
+original_dn: "/C=US/OU=string/O=DN/CN=Some Valid"
+logger: !ruby/object:Logging::Logger
+  [... snipped ...]
+transformation: upcase
+delimiter: "/"
+cn: SOME VALID
+o: DN
+ou: STRING
+c: US
+string_order:
+- cn
+- l
+- st
+- o
+- ou
+- c
+- street
+- dc
+- uid
 ```
 
+There are multiple parameters you can pass in to modify the DN's formatting:
+
+* `dn_string`: **REQUIRED** The DN string you want to parse into a DN object.
+* `transformation`: `upcase`, `downcase`, `to_s` (or any valid String method).
+* `delimiter`: Custom delimiter, DN auto detects if possible, but this forces it.
+* `string_order`: DNC returns RDN elements as per LDAP specs ([RFC4514](http://www.rfc-editor.org/rfc/rfc4514.txt)), but to customize it you can send an array (of strings) to sort your `.to_s` results.  
+  The default order is: `%w(cn l st o ou c street dc uid)`
+* `logger`: Custom logger, defaults to Rails logger or Logging gem logger.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/dnc/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+2. Add specs and make them pass (see 3)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/lib/dnc/version.rb

@@ -1,3 +1,3 @@
 module Dnc
-  VERSION = "0.1"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnc
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Steven Haddox