ldap_lookup 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5b583715ad3b95d22f008c3daab7402cc11a348559c0447c7aec8d5bd4010bc
-  data.tar.gz: 595f735c9a167784f00c4d5b4d92dd097a51b0dbc9b7ae94399960b7d8979220
+  metadata.gz: 961db29c00514e73df960b6dc63a1d4a6b0d7270822c138819b11d79cda44e2f
+  data.tar.gz: 2f10335caa65754e25d4209dab0d669bfceffaf25cd107380808d05a1e588388
 SHA512:
-  metadata.gz: 843e17377dd313b7c0eda8c030030bc65953cb3998d80a1a1ea8a75920f9967c119859f6b62793649d198c276aaf6d253e8c5c08f166ec8c17b8507552a1f59f
-  data.tar.gz: abff197d0a1631afbe7f03bf94b0c90b3cf5a8bff6f669a325f85a68aa57f422ca27249861610fc775a0c80b96bbb34cee23bf29aa748682b16ac2d1fcaa7895
+  metadata.gz: 4a9be952748ffa835db73e95776e193798c5886cd7ed39259401498a3a08fa4d8dc031aa55dc6739470ec46a71fbd70eb31237b0a23c7e1e017a5ea3f6e6faea
+  data.tar.gz: 7c0fd6a5de39acbb31000bb857f740af25404795de6d812501e0362e9d3f0e61c3b504d8c6c7d4396f6de54bbfbe3acbb42238b5a500bbba7b87b47490453d7f

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    ldap_lookup (0.1.1)
+      net-ldap (~> 0.16.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    net-ldap (0.16.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ldap_lookup!
+  rake (~> 10.0)
+  rspec (~> 3.7.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -1,6 +1,4 @@
-# LdapLookup for Ruby
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ldap_lookup`. To experiment with that code, run `bin/console` for an interactive prompt.
+# LdapLookup for Ruby [![Gem Version](https://badge.fury.io/rb/ldap_lookup.svg)](https://badge.fury.io/rb/ldap_lookup)
 
 ### Description
 This module is to be used for anonymous lookup of user attributes in the MCommunity service provide at the University of Michigan. It can be easily modifed to use other LDAP server configurations.
@@ -12,23 +10,20 @@ This module is to be used for anonymous lookup of user attributes in the MCommun
 Requirements:
 * Ruby at least 2.0.0
 * Gem 'net-ldap' ~> '0.16.1'
-> Install by running the following command at your command prompt_for_action
 > *The Net::LDAP (aka net-ldap) gem before 0.16.0 for Ruby has a Missing SSL Certificate Validation.*
-```bash
-gem install net-ldap
-```
 
 To try the module out:
 1. Clone the repo
 2. Edit the configurations by opening ldaptest.rb and set the *CONFIGURATION BLOCK* to your environment.
-```ruby
+<pre>
 LdapLookup.configuration do |config|
-      config.host = < your host > # "ldap.umich.edu"
-      config.base = < your LDAP base > # "dc=umich,dc=edu"
-      config.dept_attribute = < your dept attribute > # "umichPostalAddressData"
-      config.group_attribute = < your group email attribute > # "umichGroupEmail"
+      config.host = <em>< your host ></em> # "ldap.umich.edu"
+      config.port = <em>< your port ></em> # "986" the default is set to "389" so this optional
+      config.base = <em>< your LDAP base ></em> # "dc=umich,dc=edu"
+      config.dept_attribute = <em>< your dept attribute ></em> # "umichPostalAddressData"
+      config.group_attribute = <em>< your group email attribute ></em> # "umichGroupEmail"
 end
-```
+</pre>
 
 3. run the ldaptest.rb script
 ```ruby
@@ -54,40 +49,44 @@ Or install it yourself as:
     $ gem install ldap_lookup
 
 In your application create a file config/initializers/ldap_lookup.rb
-```ruby
+<pre>
 LdapLookup.configuration do |config|
-    config.host = < your host > # "ldap.umich.edu"
-    config.port = < your port > # "954" port 389 is set by default
-    config.base = < your LDAP base > # "dc=umich,dc=edu"
-    config.dept_attribute = < your dept attribute > # "umichPostalAddressData"
-    config.group_attribute = < your group email attribute > # "umichGroupEmail"
+    config.host = <em>< your host ></em> # "ldap.umich.edu"
+    config.port = <em>< your port ></em> # "954" port 389 is set by default
+    config.base = <em>< your LDAP base ></em> # "dc=umich,dc=edu"
+    config.dept_attribute = <em>< your dept attribute ></em> # "umichPostalAddressData"
+    config.group_attribute = <em>< your group email attribute ></em> # "umichGroupEmail"
 end
-```
+</pre>
 
 ---
 
 ### Methods available
 
-get_simple_name: returns the Display Name
+__get_simple_name:__ returns the Display Name
 ```
 LdapLookup.get_simple_name(uniqname = nil)
 ```
-get_dept: returns the users Department_name
+__get_dept:__ returns the users Department_name
 ```
 LdapLookup.get_dept(uniqname = nil)
 ```
-get_email: returns the users email address
+__get_email:__ returns the users email address
 ```
 LdapLookup.get_email(uniqname = nil)
 ```
-is_member_of_group?: returns true/false if uniqname is a member of the specified group
+__is_member_of_group?:__ returns true/false if uniqname is a member of the specified group
 ```
 LdapLookup.is_member_of_group?(uid = nil, group_name = nil)
 ```
-get_email_distribution_list: Returns the list of emails that are associated to a group.
+__get_email_distribution_list:__ Returns the list of emails that are associated to a group.
 ```
 LdapLookup.get_email_distribution_list(group_name = nil)
 ```
+all_groups_for_user: Returns the list of groups that a user is a member of.
+```
+LdapLookup.all_groups_for_user(uniqname = nil)
+```
 
 ### Contributing
 

data/ldap_lookup.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
   spec.add_dependency 'net-ldap', '~> 0.16.1'
 end

data/ldaptest.rb

@@ -1,21 +1,20 @@
 #!/usr/bin/env ruby
 
-require_relative 'lib/ldap_lookup'
+require_relative "lib/ldap_lookup"
 
 class Ldaptest
-
   include LdapLookup
 
-############## CONFIGURATION BLOCK ###################
+  ############## CONFIGURATION BLOCK ###################
   LdapLookup.configuration do |config|
     config.host = "ldap.umich.edu"
     config.base = "dc=umich,dc=edu"
     config.dept_attribute = "umichPostalAddressData"
     config.group_attribute = "umichGroupEmail"
   end
-#######################################################
+  #######################################################
 
-  def initialize(name=nil)
+  def initialize(name = nil)
     @uid = name
     @group_uid = nil
   end
@@ -59,6 +58,7 @@ class Ldaptest
     puts "3: get users full name"
     puts "4: get users department"
     puts "5: get users email"
+    puts "55: get all groups a user is a member of"
     puts "+++++++++++++++++++++++++"
     puts "6: get ldap group-name member listing"
     puts "7: check if uid is member of a group"
@@ -72,14 +72,15 @@ class Ldaptest
     when 3 then result_box(LdapLookup.get_simple_name(@uid))
     when 4 then result_box(LdapLookup.get_dept(@uid))
     when 5 then result_box(LdapLookup.get_email(@uid))
+    when 55 then result_box(LdapLookup.all_groups_for_user(@uid))
     when 6 then result_box(LdapLookup.get_email_distribution_list(@group_uid))
-    when 7 then result_box(LdapLookup.is_member_of_group?(@uid,@group_uid))
+    when 7 then result_box(LdapLookup.is_member_of_group?(@uid, @group_uid))
     when 8 then result_box(timestamp)
     when 0 then puts "you chose exit!"
-      throw(:done)
+throw(:done)
     else
       print "\e[2J\e[f"
-      puts "====> Please type 1,2,3,4,5,6,7,8 or 0 only"
+      puts "====> Please type 1,2,3,4,5,55,6,7,8 or 0 only"
       2.times { puts " " }
     end
   end
@@ -92,6 +93,7 @@ class Ldaptest
     end
   end
 end
+
 print "\e[2J\e[f"
 print "Enter a valid UID=> "
 name = gets.chomp.to_s

data/lib/ldap_lookup.rb

@@ -1,7 +1,7 @@
-require_relative 'helpers/configuration'
+require_relative "helpers/configuration"
 
 module LdapLookup
-  require 'net/ldap'
+  require "net/ldap"
 
   extend Configuration
 
@@ -11,126 +11,143 @@ module LdapLookup
   define_setting :dept_attribute
   define_setting :group_attribute
 
-    # this was developed using guidence from this gist:
-    # https://gist.githubusercontent.com/jeffjohnson9046/7012167/raw/86587b9637ddc2ece7a42df774980fa9c0aac9b3/ruby-ldap-sample.rb
+  # this was developed using guidence from this gist:
+  # https://gist.githubusercontent.com/jeffjohnson9046/7012167/raw/86587b9637ddc2ece7a42df774980fa9c0aac9b3/ruby-ldap-sample.rb
 
-    #######################################################################################################################
-    ## HELPER/UTILITY METHOD
-    ##   This method interprets the response/return code from an LDAP bind operation (bind, search, add, modify, rename,
-    ##   delete).  This method isn't necessarily complete, but it's a good starting point for handling the response codes
-    ##   from an LDAP bind operation.
-    ##
-    ##   Additional details for the get_operation_result method can be found here:
-    ##   http://net-ldap.rubyforge.org/Net/LDAP.html#method-i-get_operation_result
-    ########################################################################################################################
-    def self.get_ldap_response(ldap)
-      msg = "Response Code: #{ ldap.get_operation_result.code }, Message: #{ ldap.get_operation_result.message }"
-      raise msg unless ldap.get_operation_result.code == 0
-    end
+  #######################################################################################################################
+  ## HELPER/UTILITY METHOD
+  ##   This method interprets the response/return code from an LDAP bind operation (bind, search, add, modify, rename,
+  ##   delete).  This method isn't necessarily complete, but it's a good starting point for handling the response codes
+  ##   from an LDAP bind operation.
+  ##
+  ##   Additional details for the get_operation_result method can be found here:
+  ##   http://net-ldap.rubyforge.org/Net/LDAP.html#method-i-get_operation_result
+  ########################################################################################################################
+  def self.get_ldap_response(ldap)
+    msg = "Response Code: #{ldap.get_operation_result.code}, Message: #{ldap.get_operation_result.message}"
+    raise msg unless ldap.get_operation_result.code == 0
+  end
 
-    #######################################################################################################################
-    # SET UP LDAP CONNECTION
-    # Setting up a connection to the LDAP server using .new() does not actually send any network traffic to the LDAP
-    # server.  When you call an operation on ldap (e.g. add or search), .bind is called implicitly.  *That's* when the
-    # connection is made to the LDAP server.  This means that each operation called on the ldap object will create its own
-    # network connection to the LDAP server.
-    #######################################################################################################################
-    def self.ldap_connection
-      ldap = Net::LDAP.new  host: LdapLookup.host, # your LDAP host name or IP goes here,
-        port: LdapLookup.port, # your LDAP host port goes here,
-        base: LdapLookup.base, # the base of your AD tree goes here,
-        auth: {
-          :method => :anonymous
-        }
-    end
+  #######################################################################################################################
+  # SET UP LDAP CONNECTION
+  # Setting up a connection to the LDAP server using .new() does not actually send any network traffic to the LDAP
+  # server.  When you call an operation on ldap (e.g. add or search), .bind is called implicitly.  *That's* when the
+  # connection is made to the LDAP server.  This means that each operation called on the ldap object will create its own
+  # network connection to the LDAP server.
+  #######################################################################################################################
+  def self.ldap_connection
+    ldap = Net::LDAP.new host: host, # your LDAP host name or IP goes here,
+                         port: port, # your LDAP host port goes here,
+                         base: base, # the base of your AD tree goes here,
+                         auth: {
+                           :method => :anonymous,
+                         }
+  end
 
-    # GET THE DISPLAY NAME FOR A SINGLE USER
-    def LdapLookup.get_simple_name(uniqname = nil)
-      ldap = ldap_connection
-      search_param = uniqname # the AD account goes here
-      result_attrs = ["displayName"] # Whatever you want to bring back in your result set goes here
-      # Build filter
-      search_filter = Net::LDAP::Filter.eq("uid", search_param)
-      # Execute search
-      ldap.search(filter: search_filter, attributes: result_attrs) { |item|
-        return item.displayName.first
-      }
-      get_ldap_response(ldap)
-    end
+  # GET THE DISPLAY NAME FOR A SINGLE USER
+  def self.get_simple_name(uniqname = nil)
+    ldap = ldap_connection
+    search_param = uniqname # the AD account goes here
+    result_attrs = ["displayName"] # Whatever you want to bring back in your result set goes here
+    # Build filter
+    search_filter = Net::LDAP::Filter.eq("uid", search_param)
+    # Execute search
+    ldap.search(filter: search_filter, attributes: result_attrs) { |item|
+      return item.displayName.first
+    }
+    get_ldap_response(ldap)
+  end
 
-    # GET THE PRIMARY DEPARTMENT FOR A SINGLE USER
-    def LdapLookup.get_dept(uniqname = nil)
-      ldap = ldap_connection
-      search_param = uniqname # the AD account goes here
-      result_attrs = [LdapLookup.dept_attribute] # Whatever you want to bring back in your result set goes here
-      # Build filter
-      search_filter = Net::LDAP::Filter.eq("uid", search_param)
-      # Execute search
-      ldap.search(filter: search_filter, attributes: result_attrs) { |item|
-        return dept_name = item.umichpostaladdressdata.first.split("}:{").first.split("=")[1] unless item.umichpostaladdressdata.first.nil?
-      }
-      get_ldap_response(ldap)
-    end
+  # GET THE PRIMARY DEPARTMENT FOR A SINGLE USER
+  def self.get_dept(uniqname = nil)
+    ldap = ldap_connection
+    search_param = uniqname # the AD account goes here
+    result_attrs = [dept_attribute] # Whatever you want to bring back in your result set goes here
+    # Build filter
+    search_filter = Net::LDAP::Filter.eq("uid", search_param)
+    # Execute search
+    ldap.search(filter: search_filter, attributes: result_attrs) { |item|
+      return dept_name = item.umichpostaladdressdata.first.split("}:{").first.split("=")[1] unless item.umichpostaladdressdata.first.nil?
+    }
+    get_ldap_response(ldap)
+  end
 
-    # GET THE E-MAIL ADDRESS FOR A SINGLE USER
-    def LdapLookup.get_email(uniqname = nil)
-      ldap = ldap_connection
-      search_param = uniqname # the AD account goes here
-      result_attrs = ["mail"] # Whatever you want to bring back in your result set goes here
-      # Build filter
-      search_filter = Net::LDAP::Filter.eq("uid", search_param)
-      # Execute search
-      ldap.search(filter: search_filter, attributes: result_attrs) { |item|
-        return item.mail.first
-      }
-      get_ldap_response(ldap)
-    end
+  # GET THE E-MAIL ADDRESS FOR A SINGLE USER
+  def self.get_email(uniqname = nil)
+    ldap = ldap_connection
+    search_param = uniqname # the AD account goes here
+    result_attrs = ["mail"] # Whatever you want to bring back in your result set goes here
+    # Build filter
+    search_filter = Net::LDAP::Filter.eq("uid", search_param)
+    # Execute search
+    ldap.search(filter: search_filter, attributes: result_attrs) { |item|
+      return item.mail.first
+    }
+    get_ldap_response(ldap)
+  end
 
-    # ---------------------------------------------------------------------------------------------------------------------
-    # Check if the UID is a member of an LDAP group. This function returns TRUE
-    # if uid passed in is a member of group_name passed in. Otherwise it will
-    # return false.
-    def LdapLookup.is_member_of_group?(uid = nil, group_name = nil)
-      ldap = ldap_connection
-      # GET THE MEMBERS OF AN E-MAIL DISTRIBUTION LIST
-      search_param = group_name # the name of the distribution list you're looking for goes here
-      result_attrs = ["member"]
-      # Build filter
-      search_filter = Net::LDAP::Filter.eq("cn", search_param)
-      group_filter = Net::LDAP::Filter.eq("objectClass", "group")
-      composite_filter = Net::LDAP::Filter.join(search_filter, group_filter)
-      # Execute search, extracting the AD account name from each member of the distribution list
-      ldap.search(filter: composite_filter, attributes: result_attrs) do |item|
-        item.member.each do |entry|
-          if entry.split(",").first.split("=")[1] == uid
-            return true
-          end
+  # ---------------------------------------------------------------------------------------------------------------------
+  # Check if the UID is a member of an LDAP group. This function returns TRUE
+  # if uid passed in is a member of group_name passed in. Otherwise it will
+  # return false.
+  def self.is_member_of_group?(uid = nil, group_name = nil)
+    ldap = ldap_connection
+    # GET THE MEMBERS OF AN E-MAIL DISTRIBUTION LIST
+    search_param = group_name # the name of the distribution list you're looking for goes here
+    result_attrs = ["member"]
+    # Build filter
+    search_filter = Net::LDAP::Filter.eq("cn", search_param)
+    group_filter = Net::LDAP::Filter.eq("objectClass", "group")
+    composite_filter = Net::LDAP::Filter.join(search_filter, group_filter)
+    # Execute search, extracting the AD account name from each member of the distribution list
+    ldap.search(filter: composite_filter, attributes: result_attrs) do |item|
+      item.member.each do |entry|
+        if entry.split(",").first.split("=")[1] == uid
+          return true
         end
       end
-      return FALSE
-      get_ldap_response(ldap)
     end
+    return false
+    get_ldap_response(ldap)
+  end
 
-    # ---------------------------------------------------------------------------------------------------------------------
-    # Get the Name email and members of an LDAP group as a hash
-    def LdapLookup.get_email_distribution_list(group_name = nil)
-      ldap = ldap_connection
-      result_hash = {}
-      member_hash = {}
-      # GET THE MEMBERS OF AN E-MAIL DISTRIBUTION LIST
-      search_param = group_name # the name of the distribution list you're looking for goes here
-      result_attrs = ["cn", LdapLookup.group_attribute, "member"]
-      # Build filter
-      search_filter = Net::LDAP::Filter.eq("cn", search_param)
-      group_filter = Net::LDAP::Filter.eq("objectClass", "group")
-      composite_filter = Net::LDAP::Filter.join(search_filter, group_filter)
-      # Execute search, extracting the AD account name from each member of the distribution list
-      ldap.search(filter: composite_filter, attributes: result_attrs) do |item|
-        result_hash["group_name"] = item.cn.first
-        result_hash["group_email"] = item.umichGroupEmail.first
-        result_hash["members"] = item.member
+  # ---------------------------------------------------------------------------------------------------------------------
+  # Get the Name email and members of an LDAP group as a hash
+  def self.get_email_distribution_list(group_name = nil)
+    ldap = ldap_connection
+    result_hash = {}
+    member_hash = {}
+    # GET THE MEMBERS OF AN E-MAIL DISTRIBUTION LIST
+    search_param = group_name # the name of the distribution list you're looking for goes here
+    result_attrs = ["cn", group_attribute, "member"]
+    # Build filter
+    search_filter = Net::LDAP::Filter.eq("cn", search_param)
+    group_filter = Net::LDAP::Filter.eq("objectClass", "group")
+    composite_filter = Net::LDAP::Filter.join(search_filter, group_filter)
+    # Execute search, extracting the AD account name from each member of the distribution list
+    ldap.search(filter: composite_filter, attributes: result_attrs) do |item|
+      result_hash["group_name"] = item.cn.first
+      result_hash["group_email"] = item.umichGroupEmail.first
+      individual_array = []
+      item.member.each do |individual|
+        individual_array.push(individual.split(",").first.split("=")[1])
       end
-      return result_hash
-      get_ldap_response(ldap)
+      result_hash["members"] = individual_array.sort
+    end
+    return result_hash
+    get_ldap_response(ldap)
+  end
+
+  # ---------------------------------------------------------------------------
+  #  Get the groups a user is a member of
+  def self.all_groups_for_user(uid = nil)
+    ldap = ldap_connection
+    result_array = []
+    result_attrs = ["dn"]
+    ldap.search(filter: "member=uid=#{uid},ou=People,dc=umich,dc=edu", attributes: result_attrs) do |item|
+      item.each { |key, value| result_array << value.first.split("=")[1].split(",")[0] }
     end
+    return result_array.sort
+    get_ldap_response(ldap)
   end
+end

data/lib/ldap_lookup/version.rb

@@ -1,3 +1,3 @@
 module LdapLookup
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldap_lookup
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rick Smoke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: net-ldap
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +78,7 @@ files:
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -93,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: For anonymous lookup of user LDAP attributes.