dnc 0.0.2 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9e67a4e1a35c22ec3d34da5694a2f1f2329a452
-  data.tar.gz: 5cfaf79abf1cff17fca5c305a2a11b9766a60a9f
+  metadata.gz: 66b1ef34df9cb502c35b85313bc576a3de31e043
+  data.tar.gz: 691ed00273f98ed06be51cf361b358965a25b00d
 SHA512:
-  metadata.gz: 037f0e5d5b2560d471094935ed3afe78e8f4beb9195cde87667260a21ebdffd107df3e86daca8ca03db3dad897247581097f3c2bd972251b446922a667ce3d2b
-  data.tar.gz: 6ed48e3892e2a9502f03efd3ef6911d7d562b24ef3f98946b528b088f44fb2579cad5e85b2bc2c7cc354f3f2a40472c6e9c376b4404852cbfe59bd863fe6523b
+  metadata.gz: ca789d0f4c60ea6c846debc8765f27f4388842551752eddccaddaef8a8fddbb5603a07899be98d4732bb2d7e442bcd7156fe2c9e8cb09b2c25abe3fc1fd43fcd
+  data.tar.gz: b338653735df756a52c15bf27c1cc32fce7c5017ace0f1de9f22be8fd6d3f83372ae0218b74b5b92b778039f26f31ed7df8b46126927d80da8b727f8168a2890

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   Exclude:
   - 'dnc.gemspec'
   - 'lib/dnc/version.rb'
+  - 'lib/blank.rb'
   - 'spec/**/*'
   - 'vendor/cache/**/*'
   - 'vendor/bundle/**/*'

data/lib/{dnc/array.rb → array.rb}

@@ -2,7 +2,6 @@
 # Extend the core Array class to include `.wrap`
 #
 class Array
-
   # Duplication of Ruby on Rails Array#wrap method
   def self.wrap(object)
     if object.nil?

data/lib/blank.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies
+  #
+  #   address.nil? || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    BLANK_RE === self
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/dnc.rb

@@ -1,4 +1,5 @@
 require 'dnc/version'
 require 'dnc/dn'
 require 'dnc/string'
-require 'dnc/array'
+require 'blank'
+require 'array'

data/lib/dnc/dn.rb

@@ -5,22 +5,31 @@ class DnDelimiterUnparsableError < TypeError; end
 # Custom exception for strings that can't be parsed as per RFC1779
 class DnStringUnparsableError < TypeError; end
 
+# rubocop:disable ClassLength
 # Accepts various DN strings and returns a DN object
 class DN
-  attr_accessor :original_dn, :dn_string, :delimiter,
-    :cn, :l, :st, :o, :ou, :c, :street, :dc
+  attr_accessor :original_dn, :dn_string, :delimiter, :transformation,
+                :string_order, :cn, :l, :st, :ou, :o, :c, :street, :dc, :uid
 
   # Initialize the instance
   #
   # @param opts [Hash] Options hash for new DN instance attribute values
   # @param opts[:dn_string] [String] The DN string you want to parse into a DN
   # @param opts[:logger] User provided logger vs Rails / Logging default logger
-  def initialize(opts={})
-    @dn_string = opts[:dn_string]
-    @original_dn = dn_string
-    fail "dnc: dn_string parameter is **required**" if dn_string.nil?
-    @logger = opts[:logger].nil? ? logger : opts[:logger]
-    @delimiter = opts[:delimiter].nil? ? identify_delimiter : opts[:delimiter]
+  # NOTE: opts[transformation] defaults to "upcase"; use "to_s" for no change.
+  # @param opts[:transformation] [String] String method for changing DN.
+  # @param opts[:delimiter] [String] Specify a custom delimiter for dn_string
+  # NOTE: opts[:string_order] is a last resort config, defaults to RFC4514 spec.
+  # @param opts[:string_order] [Array] Specify the order of RDNs for .to_s
+  # @return [DN]
+  def initialize(opts = {})
+    @dn_string      = opts[:dn_string]
+    fail 'dnc: dn_string parameter is **required**' if dn_string.nil?
+    @original_dn    = dn_string
+    @logger         = opts[:logger] || logger
+    @transformation = opts[:transformation] || 'upcase'
+    @string_order   = opts[:string_order] || %w(cn l st o ou c street dc uid)
+    @delimiter      = opts[:delimiter] || identify_delimiter
     format_dn
   end
 
@@ -31,29 +40,30 @@ class DN
     @logger ||= Kernel.const_defined?('Rails') ? Rails.logger : logger
   end
 
-  # Split passed DN by identified delimiter
-  def split_by_delimiter
-    dn_string.split(delimiter).reject(&:empty?)
-  end
-
-  # Convert DN object into a string
+  # Convert DN object into a string (order follows RFC4514 LDAP specifications)
   def to_s
-    return_string = ""
-    %w(cn dc l st ou o c street).each do |string_name|
-      unless self.send(string_name.to_sym).nil? || self.send(string_name.to_sym).empty?
-        return_string += "," unless return_string.empty?
-        return_string += self.send("#{string_name}_string".to_sym)
+    return_string = ''
+    @string_order.each do |string_name|
+      unless send(string_name.to_sym).blank?
+        return_string += ',' unless return_string.empty?
+        return_string += send("#{string_name}_string".to_sym)
       end
     end
 
     return_string
   end
 
+  # Split passed DN by identified delimiter
+  def split_by_delimiter
+    dn_string.split(delimiter).reject(&:empty?)
+  end
+
   private
 
   # Orchestrates reformatting DN to expected element order for LDAP auth.
   def format_dn
-    dn_string.upcase! # Upcase all DNs for consistency
+    # Transform dn_string for consistency / uniqueness
+    @dn_string = dn_string.send(transformation.to_sym)
     format_dn_element_order unless dn_begins_properly?(dn_string)
     parse_rdns_to_attrs
     self
@@ -62,10 +72,10 @@ class DN
   # Parse @dn_string RDNs and assign them to DN attributes
   def parse_rdns_to_attrs
     split_by_delimiter.each do |rdn|
-      unless rdn.include?('+')
-        parse_top_level_rdn(rdn)
-      else
+      if rdn.include?('+')
         parse_nested_rdn(rdn)
+      else
+        parse_top_level_rdn(rdn)
       end
     end
 
@@ -76,11 +86,10 @@ class DN
     rdn_array = rdn.split('=')
     method = rdn_array[0].downcase.to_sym
     value  = rdn_array[1]
-    unless send(method).nil? || send(method).empty?
-      send("#{method}=", Array.wrap(send(method)))
-      send("#{method}").insert(0, value)
+    if send(method).blank?
+      assign_rdn_as_string(method, value)
     else
-      send("#{method}=", value)
+      assign_rdn_as_array(method, value)
     end
   end
 
@@ -95,20 +104,32 @@ class DN
     send("#{rdn_keypairs.keys.first.downcase}=", rdn_keypairs)
   end
 
-  # Ensure order of DN elements is proper for CAS server with ',' delimiter
+  def assign_rdn_as_string(method_name, value)
+    send("#{method_name}=", value)
+  end
+
+  def assign_rdn_as_array(method_name, value)
+    send("#{method_name}=", Array.wrap(send(method_name)))
+    send("#{method_name}").push(value)
+  end
+
+  # Ensure order of DN elements is proper for CAS server
   def format_dn_element_order
     formatted_dn = split_by_delimiter.reverse.join(delimiter)
     if dn_begins_properly?(formatted_dn)
-      dn_string = formatted_dn
-
+      @dn_string = formatted_dn
     else
-      fail("DN invalid format for LDAP authentication, DN:\r\n#{original_dn}")
+      fail "DN invalid format for LDAP authentication, DN:\r\n#{original_dn}"
     end
   end
 
   # Verify DN starts with 'CN='
   def dn_begins_properly?(dn_str)
-    dn_str.nil? ? false : (dn_str.start_with?("CN=") || dn_str.start_with?("#{delimiter}CN="))
+    if dn_str.nil?
+      false
+    else
+      dn_str.start_with?('CN=') || dn_str.start_with?("#{delimiter}CN=")
+    end
   end
 
   # Regex to match the DN delimiter by getting the 2nd key non-word predecessor
@@ -118,60 +139,28 @@ class DN
 
   # Identify and set the DN delimiter
   def identify_delimiter
-    begin
-      logger.debug("DN.identify_delimeter: #{dn_string}")
-      delimiter_regexp.match(dn_string)[1]
+    logger.debug("DN.identify_delimeter: #{dn_string}")
+    delimiter_regexp.match(dn_string)[1]
     rescue
-      fail DnDelimiterUnparsableError, "DN delimiter could not be identified
+      raise DnDelimiterUnparsableError, "DN delimiter could not be identified
              \r\nPlease ensure your string complies with RFC1779 formatting."
-    end
-  end
-
-  def cn_string
-    dynamic_strings('cn', cn.class)
   end
 
-  def l_string
-    dynamic_strings('l', l.class)
-  end
-
-  def st_string
-    dynamic_strings('st', st.class)
-  end
-
-  def o_string
-    dynamic_strings('o', o.class)
-  end
-
-  def ou_string
-    dynamic_strings('ou', ou.class)
-  end
-
-  def c_string
-    dynamic_strings('c', c.class)
-  end
-
-  def street_string
-    dynamic_strings('street', street.class)
-  end
+  def method_missing(method_name)
+    # Catch methods that end with _string
+    method_match = method_name.to_s.match(/(.+)_string\z/)
+    unless method_match.blank?
+      method = method_match[1]
+      method_class = send(method.to_sym).class
+      return send(:dynamic_strings, method.to_s, method_class)
+    end
 
-  def dc_string
-    dynamic_strings('dc', dc.class)
+    super
   end
 
-  # Identify which RDN string formatteer to call by value's class
+  # Dynamically format the "#{attr}_string" method by value's class type
   def dynamic_strings(getter_method, value_class)
-    case value_class.to_s
-    when Array.to_s
-      dn_array_to_string(getter_method)
-    when Hash.to_s
-      dn_hash_to_string(getter_method)
-    when String.to_s
-      dn_string_to_string(getter_method)
-    else
-      logger.error "Invalid string accessor method class: #{value_class}"
-      fail "Invalid string accessor method class: #{value_class}"
-    end
+    send("dn_#{value_class.to_s.downcase}_to_string".to_sym, getter_method)
   end
 
   # NOTE:
@@ -180,10 +169,10 @@ class DN
 
   # Dynamically define a method to return DN array values as string format
   def dn_array_to_string(getter_method)
-    return_string = ""
-    value = self.send(getter_method.to_sym)
+    return_string = ''
+    value = send(getter_method.to_sym)
     value.each do |element|
-      return_string += "," unless return_string.empty?
+      return_string += ',' unless return_string.empty?
       return_string += "#{getter_method.to_s.upcase}=#{element}"
     end
 
@@ -192,10 +181,10 @@ class DN
 
   # Dynamically define a method to return DN hash values as string format
   def dn_hash_to_string(getter_method)
-    return_string = ""
-    value = self.send(getter_method.to_sym)
+    return_string = ''
+    value = send(getter_method.to_sym)
     value.each do |key, string|
-      return_string += "+" unless return_string.empty?
+      return_string += '+' unless return_string.empty?
       return_string += "#{key}=#{string}"
     end
 
@@ -204,6 +193,6 @@ class DN
 
   # Dynamically define a method to return DN string values as string format
   def dn_string_to_string(getter_method)
-    "#{getter_method.to_s.upcase}=#{self.send(getter_method.to_sym)}"
+    "#{getter_method.to_s.upcase}=#{send(getter_method.to_sym)}"
   end
 end

data/lib/dnc/string.rb

@@ -4,12 +4,11 @@ require 'dnc'
 # Extend the core String class to include `.to_dn` && `.to_dn!`
 #
 class String
-
   # Parses the string to return a DN object
   # Returns nil if a DN instance cannot be created
   def to_dn
     begin
-      new_dn = DN.new(dn_string: self.to_s)
+      new_dn = DN.new(dn_string: to_s)
     rescue StandardError
       new_dn = nil
     end
@@ -21,13 +20,12 @@ class String
   # explicitly parsed to a DN instance
   def to_dn!
     begin
-      new_dn = DN.new(dn_string: self.to_s)
+      new_dn = DN.new(dn_string: to_s)
     rescue StandardError
       raise DnStringUnparsableError,
-        "Could not force conversion to DN:\n#{inspect}"
+            "Could not force conversion to DN:\n#{inspect}"
     end
 
     new_dn
   end
 end
-

data/lib/dnc/version.rb

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

data/spec/fixtures/common_dns.txt

@@ -1,3 +1,7 @@
+CN=Stusrvich Terrance Edward Testusr,OU=D135,OU=Isle,OU=web,O=L.O.S.T.  others,C=us%CN=STUSRVICH TERRANCE EDWARD TESTUSR,OU=D135,OU=ISLE,OU=WEB,O=L.O.S.T. OTHERS,C=US
+CN=DIAGO Desmond d123456,OU=People,OU=PENNY,OU=Not,O=L.O.S.T.  OTHERS,C=US%CN=DIAGO DESMOND D123456,OU=PEOPLE,OU=PENNY,OU=NOT,O=L.O.S.T.  OTHERS,C=US
+CN=BOB-THORNTON William JAMES wjbob,OU=boat,OU=b047,OU=ISLE,OU=NOT,O=l.o.s.t.  others,C=us%CN=BOB-THORNTON WILLIAM JAMES WJBOB,OU=BOAT,OU=B047,OU=ISLE,OU=NOT,O=L.O.S.T. OTHERS,C=US
+CN=NODE RUBY G RGNODE9,OU=JIEDDO,OU=PEOPLE,OU=JCK,OU=JHN,O=L.O.S.T.  OTHERS,C=US%CN=NODE RUBY G RGNODE9,OU=JIEDDO,OU=PEOPLE,OU=JCK,OU=JHN,O=L.O.S.T.  OTHERS,C=US
 /C=US/O=RB/OU=DEV/OU=RAILS/OU=People/CN=Last First (initial)%CN=LAST FIRST (INITIAL),OU=PEOPLE,OU=RAILS,OU=DEV,O=RB,C=US
 /CN=Smith John+initials=cpt/OU=People/OU=RAILS/OU=DEV/O=RB/C=GB%CN=SMITH JOHN+INITIALS=CPT,OU=DEV,OU=RAILS,OU=PEOPLE,O=RB,C=GB
 CN=John Smith+email=jsmith@mayflower.org,O=ISODE Consortium,C=GB,O=ISODE Consortium%CN=JOHN SMITH+EMAIL=JSMITH@MAYFLOWER.ORG,O=ISODE CONSORTIUM,C=GB,O=ISODE CONSORTIUM

data/spec/lib/dn_spec.rb

@@ -4,7 +4,7 @@ describe DN do
   let!(:raw_dn) { '/C=US/O=RB/OU=DEV/OU=JS/OU=People/CN=Last First M (initial)' }
   let!(:dn_to_s) { 'CN=LAST FIRST M (INITIAL),OU=PEOPLE,OU=JS,OU=DEV,O=RB,C=US' }
   let(:valid_subject) { DN.new(dn_string: raw_dn) }
-  let(:dn_elements) { ["C=US", "O=RB", "OU=DEV", "OU=JS", "OU=PEOPLE", "CN=LAST FIRST M (INITIAL)"] }
+  let(:dn_elements) { ["CN=LAST FIRST M (INITIAL)", "OU=PEOPLE", "OU=JS", "OU=DEV", "O=RB", "C=US"] }
 
   #
   # Unit specs
@@ -32,11 +32,11 @@ describe DN do
     end
 
     it "should return appropriate attrs as arrays" do
-      [:ou, :dc].each do |array_wrapped_el|
-        dn = DN.new(dn_string: '/C=US/O=RB/OU=DEV/OU=JS/OU=People/DC=example/DC=org/CN=Last First M (initial)')
-        expect(dn.dc).to eq(['ORG', 'EXAMPLE'])
-        expect(dn.ou).to eq(['PEOPLE', 'JS', 'DEV'])
-      end
+      expect(valid_subject.ou).to eq(['PEOPLE','JS','DEV'])
+      expect(DN.new(dn_string: dn_to_s).ou).to eq(['PEOPLE','JS','DEV'])
+      dn = DN.new(dn_string: '/C=US/O=RB/OU=DEV/OU=JS/OU=People/DC=example/DC=org/CN=Last First M (initial)')
+      expect(dn.ou).to eq(['PEOPLE', 'JS', 'DEV'])
+      expect(dn.dc).to eq(['ORG', 'EXAMPLE'])
     end
 
     it "should handle multiple RDN key value pairs in the CN and return an array of elements" do
@@ -55,19 +55,16 @@ describe DN do
   describe ".to_s" do
     it "should return a properly formatted string for CAS & RFC1779 use" do
       dn = DN.new(dn_string: '/C=US/O=RB/OU=DEV/OU=JS/OU=People/DC=example/DC=org/CN=Last First M (initial)+email=initial@example.org+office=home')
-      dn_string = 'CN=LAST FIRST M (INITIAL)+EMAIL=INITIAL@EXAMPLE.ORG+OFFICE=HOME,DC=ORG,DC=EXAMPLE,OU=PEOPLE,OU=JS,OU=DEV,O=RB,C=US'
+      dn_string = 'CN=LAST FIRST M (INITIAL)+EMAIL=INITIAL@EXAMPLE.ORG+OFFICE=HOME,O=RB,OU=PEOPLE,OU=JS,OU=DEV,C=US,DC=ORG,DC=EXAMPLE'
       expect(dn.to_s).to eq(dn_string)
     end
 
-    it "should parse common DN formats into DN objects" do
-      pending "Finish this"
-      File.readlines('spec/fixtures/common_dns.txt').each do |line|
-        dn_in = line.rstrip.split('%')[0]
-        dn_out = line.rstrip.split('%')[1]
-        #ap dn_in
-        #ap dn_out
-        expect(DN.new(dn_string: dn_in).to_s).to eq(dn_out)
-      end
-    end
+#    it "should parse common DN formats into DN objects" do
+#      File.readlines('spec/fixtures/common_dns.txt').each do |line|
+#        dn_in = line.rstrip.split('%')[0]
+#        dn_out = line.rstrip.split('%')[1]
+#        expect(DN.new(dn_string: dn_in).to_s).to eq(dn_out)
+#      end
+#    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: '0.1'
 platform: ruby
 authors:
 - Steven Haddox
@@ -30,7 +30,7 @@ cert_chain:
   42qdwEXvvkODZAD6KAIXPdmbMfBgPbcd+B/4eUA0PyKo+4dgL1NuqX4MPWToevIZ
   O8EKLF2X7NmC6FY1bOsSj/J8r1SOkx0rxgF+geRvY1P+hfNjDfxTsjU=
   -----END CERTIFICATE-----
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -204,8 +204,9 @@ files:
 - Rakefile
 - certs/stevenhaddox.pem
 - dnc.gemspec
+- lib/array.rb
+- lib/blank.rb
 - lib/dnc.rb
-- lib/dnc/array.rb
 - lib/dnc/dn.rb
 - lib/dnc/string.rb
 - lib/dnc/version.rb

metadata.gz.sig

@@ -1 +1,3 @@
-(�Q�W�@��)�5�M+Q$Q\R�m�(#l�{��ۊ��G!Ƕ��B��~�/Ov�Jm�B.���K��Gǭ) ���e&EJ,j�6~���-�v
+�)�`�mq��P���N�r�kQ�$-J�BB�x]�}j�Ԥ�'�ܴ?�y��
+$N
+�on1�E�THD�=���Os.S���4k(�0�i�@�j��%*���p@�E3��Y�GaO�����Y