ldap_groups_lookup 0.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e986ac6ae6b5a7ef3fa46acd0cba75ea50fcea73
+  data.tar.gz: 967e36cea4f0fdcbeaec12e8191e00bdffdc8976
+SHA512:
+  metadata.gz: c394f00e5269767de53bdca4668b31a9de715e09382a63f5bacb4aa0a099c48d500985327f22a95a17687b2bdb5a4cc0715290082403afad286feb11f815bc6b
+  data.tar.gz: 23d5349dfa67d42cc8faf029db21b9a2c1c1f1617ebffa8b5c7d7bd6303194ffef9bc883d933277d86cc82b5b0e718aa0e6f548fe87b5df4aebb25402b6ab4f7

data/.gitignore

@@ -0,0 +1,10 @@
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# YARD folders
+doc/
+.yardoc/
+
+# temporary files
+*.swp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 2.3
+ - 2.4
+ - 2.5

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,29 @@
+# IU LDAP Groups Lookup
+
+Adds an LDAPGroupsLookup that can be included in a a class to provide an #ldap_groups instance method:
+
+```
+class User
+  attr_accessor :ldap_lookup_key
+  include LDAPGroupsLookup::Behavior
+end
+
+u = User.new
+u.ldap_lookup_key = 'some_username'
+u.ldap_groups
+u.member_of_ldap_group?(['Some-Group'])
+```
+
+The LDAP search will be run by the value of #ldap_lookup_key, so your instance object must provide that through some means:
+
+```
+class User < ActiveRecord::Base
+  validates :username, presence: true, uniqueness: true
+  alias_attribute :ldap_lookup_key, :username
+  include LDAPGroupsLookup::Behavior
+end
+
+u = User.find_by(username: 'some_username')
+u.ldap_groups
+u.member_of_ldap_group?(['Some-Group'])
+```

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/ldap_groups_lookup.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ldap_groups_lookup/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ldap_groups_lookup'
+  gem.version       = LDAPGroupsLookup::VERSION
+  gem.authors       = ['Adam Ploshay', 'Daniel Pierce', 'Avalon Media System']
+  gem.email         = ['aploshay@iu.edu', 'dlpierce@iu.edu']
+  gem.description   = 'Provides easy access to the list of LDAP groups a username is a member of.'
+  gem.summary       = 'Provides easy access to the list of LDAP groups a username is a member of.'
+  gem.homepage      = 'http://github.com/IUBLibTech/ldap_groups_lookup'
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  gem.required_ruby_version = '>= 2.3.0'
+
+  gem.add_dependency 'net-ldap'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+end

data/lib/ldap_groups_lookup.rb

@@ -0,0 +1,16 @@
+require 'net/ldap'
+
+# Adds #ldap_groups instance method
+# Object must provide #ldap_lookup_key to use for LDAP group search
+module LDAPGroupsLookup
+  class InitializationError < RuntimeError; end
+
+  autoload :Configuration, 'ldap_groups_lookup/configuration'
+  autoload :Search, 'ldap_groups_lookup/search'
+  autoload :Behavior, 'ldap_groups_lookup/behavior'
+
+  class << self
+    include LDAPGroupsLookup::Configuration
+    include LDAPGroupsLookup::Search
+  end
+end

data/lib/ldap_groups_lookup/behavior.rb

@@ -0,0 +1,27 @@
+# Adds #ldap_groups instance method
+# Object must provide #ldap_lookup_key to use for LDAP group search
+module LDAPGroupsLookup
+  module Behavior
+    require 'ldap_groups_lookup'
+
+    # Searches object's nested LDAP groups by value of ldap_lookup_key
+    # @return [Array] all of the object's LDAP groups, sorted
+    def ldap_groups
+      return [] unless respond_to? :ldap_lookup_key
+      LDAPGroupsLookup.walk_ldap_groups(
+          LDAPGroupsLookup.ldap_member_of(ldap_lookup_key)
+      ).sort
+    end
+
+    # Checks if a user is in a group's membership tree
+    # @param [Array] groups is a list of group CN strings to search within
+    # @return [Boolean]
+    def member_of_ldap_group?(groups)
+      return false unless respond_to? :ldap_lookup_key
+      return false if LDAPGroupsLookup.service.nil?
+      groups = [groups] if groups.is_a? String
+      dn = LDAPGroupsLookup.lookup_dn ldap_lookup_key
+      return LDAPGroupsLookup.walk_ldap_members(groups, dn)
+    end
+  end
+end

data/lib/ldap_groups_lookup/configuration.rb

@@ -0,0 +1,63 @@
+require 'yaml'
+
+# Provides access to the configuration YAML file.
+module LDAPGroupsLookup
+  module Configuration
+
+    # Attempts to create a connection to LDAP and returns a cached Net::LDAP instance if successful.
+    def service
+      return nil if config[:enabled] == false
+      if @ldap_service.nil?
+        @ldap_service = Net::LDAP.new(host: config[:host], auth: config[:auth])
+        raise Net::LDAP::Error unless @ldap_service.bind
+      end
+      @ldap_service
+    end
+
+    # Loads LDAP host and authentication configuration
+    def config
+      if @config.nil?
+        if defined? Rails
+          configure(Rails.root.join('config', 'ldap_groups_lookup.yml').to_s)
+        else
+          configure(File.join(__dir__, 'config', 'ldap_groups_lookup.yml').to_s)
+        end
+      end
+      @config
+    end
+
+    # Clears internal cached objects.
+    def reset
+      @ldap_service = nil
+      @config = nil
+    end
+
+    def group_tree
+      "#{config[:group_ou]},#{tree}"
+    end
+
+    def account_tree
+      "#{config[:account_ou]},#{tree}"
+    end
+
+    def tree
+      config[:tree]
+    end
+
+    private
+
+    def configure(value)
+      if value.nil? || value.is_a?(Hash)
+        @config = value
+      elsif value.is_a?(String)
+        if File.exists?(value)
+          @config = YAML.load(ERB.new(File.read(value)).result)
+        else
+          @config = { enabled: false }
+        end
+      else
+        raise InitializationError, "Unrecognized configuration: #{value.inspect}"
+      end
+    end
+  end
+end

data/lib/ldap_groups_lookup/search.rb

@@ -0,0 +1,117 @@
+module LDAPGroupsLookup
+  module Search
+    # Searches (without recursion) LDAP groups
+    # @param [String] cn the group or user to search by
+    # @return [Array] LDAP groups for cn, one level deep, unsorted
+    def ldap_member_of(cn)
+      return [] if service.nil?
+      entry = service.search(base: tree,
+                                filter: Net::LDAP::Filter.equals('cn', cn),
+                                attributes: ['memberof']).first
+      if entry.nil?
+        []
+      else
+        entry['memberof'].collect { |mo| mo.split(',').first.split('=')[1] }
+      end
+    end
+
+    # Searches (recursively) LDAP group membership tree
+    # @param [Array] groups to search group membership of
+    # @param [Array] seen the accumulated list of group membership, defaults to []
+    # @return [Array] results of searching group membership tree
+    def walk_ldap_groups(groups, seen = [])
+      groups.each do |g|
+        next if seen.include? g
+        seen << g
+        walk_ldap_groups(ldap_member_of(g), seen)
+      end
+      seen
+    end
+
+    # Returns the DN for the given CN attribute
+    def lookup_dn(cn)
+      service.search(base: tree, filter: Net::LDAP::Filter.equals('cn', cn), attributes: 'dn').first&.dn
+    end
+
+    # Strips a DN string down to just its CN segment.
+    def dn_to_cn(dn)
+      dn.match(/CN=(.+?),/)[1]
+    end
+
+    # Searches a group and its nested member groups for a member DN
+    # @param [Array] groups CNs to search
+    # @param [String] dn the DN to search for
+    # @param [Array] seen groups that have already been traversed
+    # @return [Boolean] true if dn was seen in groups
+    def walk_ldap_members(groups, dn, seen = [])
+      groups.each do |g|
+        members = ldap_members(g)
+        return true if members.include? dn
+        next if seen.include? g
+        seen << g
+        member_groups = members.collect do |mg|
+          dn_to_cn(mg) if mg.include? 'OU=Groups'
+        end
+        member_groups.compact!
+        return true if walk_ldap_members(member_groups, dn, seen)
+      end
+      return false
+    end
+
+    # Gets the entire list of members for a CN.
+    # Handles range results.
+    # @param [String] cn of the entry to fetch.
+    # @param [Integer] start index of range result
+    # @return [Array] list of member CNs
+    def ldap_members(cn, start=0)
+      return [] if service.nil?
+      # print "Getting members of #{cn} at index #{start}\n"
+      entry = service.search(base: tree,
+                             filter: Net::LDAP::Filter.equals('cn', cn),
+                             attributes: ["member;range=#{start}-*"]).first
+      return [] if entry.nil?
+
+      field_name = entry.attribute_names[1] # Is this always ordered [dn, member]?
+      return [] if field_name.nil? # Sometimes member is not present.
+
+      range_end = field_name.to_s.match(/^member;range=\d+-([0-9*]+)$/)[1]
+      # print "#{start}-#{range_end}\n"
+      members = entry[field_name]#.collect { |mo| mo.split(',').first.split('=')[1] }
+      members.concat ldap_members(cn, range_end.to_i+1) unless range_end == '*'
+      return members
+    end
+
+    # Checks if a user is in a group's membership tree
+    # @param [String] username to search for
+    # @param [String] groupname to search within
+    # @return [Boolean]
+    def belongs_to_ldap_group?(username, groupname)
+      return false if service.nil?
+      group_filter = Net::LDAP::Filter.equals('cn', groupname)
+      member_filter = Net::LDAP::Filter.equals('member', "cn=#{username},#{account_tree}")
+      entry = service.search(base: tree,
+                             filter: group_filter & member_filter,
+                             attributes: ['cn'])
+      entry.count > 0
+    end
+
+    # Lists all groups that a user belongs to.
+    # Warning: Utilizes server-side recursive search but may be slower than walking the tree client-side.
+    # @param [string] username the user to search by
+    def all_ldap_groups(username)
+      return [] if service.nil?
+      results = service.search(base: group_tree,
+                   filter: Net::LDAP::Filter.eq('objectcategory', 'group') &
+                       Net::LDAP::Filter.ex('member:1.2.840.113556.1.4.1941',
+                                            "CN=#{Net::LDAP::Filter.escape(username)},#{account_tree}"),
+                   attributes: ['cn'])
+      if results.nil?
+        []
+      else
+        results.collect do |entry|
+          entry[:cn].first
+        end
+      end
+    end
+  end
+end

data/lib/ldap_groups_lookup/version.rb

@@ -0,0 +1,5 @@
+# Gem version release tracking
+module LDAPGroupsLookup
+  # Define release version
+  VERSION = '0.4.3'.freeze
+end

data/spec/fixtures/ldap_groups_lookup.yml.example

@@ -0,0 +1,9 @@
+:enabled: true
+:host: ads.example.net
+:auth:
+  :method: :simple
+  :username: example
+  :password: changeme
+:tree: dc=ads,dc=example,dc=net
+:account_ou: ou=Accounts
+:group_ou: ou=Groups

data/spec/lib/ldap_groups_lookup_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+require 'ldap_groups_lookup/behavior'
+require 'pry'
+
+RSpec.describe LDAPGroupsLookup do
+  let(:user_class) do
+    class User
+      def ldap_lookup_key
+        'user'
+      end
+      include LDAPGroupsLookup::Behavior
+    end
+  end
+  let(:user) { user_class.new }
+
+  # Load the example config from fixtures
+  let(:config) { YAML.load(ERB.new(File.read(File.join(File.dirname(__dir__), 'fixtures', 'ldap_groups_lookup.yml.example'))).result) }
+
+  before do
+    allow(LDAPGroupsLookup).to receive(:config).and_return(config)
+  end
+
+  after do
+    LDAPGroupsLookup.reset
+  end
+
+  describe '#service' do
+    context 'when the config file is missing' do
+      before do
+        allow(LDAPGroupsLookup).to receive(:config).and_call_original
+        expect(File).to receive(:exists?).with(/config\/ldap_groups_lookup\.yml$/)
+      end
+      it 'should return nil' do
+        expect(LDAPGroupsLookup.service).to be_nil
+      end
+    end
+    context 'when disabled in the configuration file' do
+      before do
+        config[:enabled] = false
+      end
+      it 'should return nil' do
+        expect(LDAPGroupsLookup.service).to be_nil
+      end
+    end
+    context 'when enabled in the configuration file' do
+      it 'should be enabled' do
+        expect(config[:enabled]).to eq(true)
+      end
+      context 'when the auth credentials are incorrect' do
+        before do
+          allow_any_instance_of(Net::LDAP).to receive(:bind).and_return(false)
+        end
+        it 'should raise an LdapError' do
+          expect { LDAPGroupsLookup.service }.to raise_error(Net::LDAP::Error)
+        end
+      end
+      context 'when the auth credentials are correct' do
+        before do
+          allow_any_instance_of(Net::LDAP).to receive(:bind).and_return(true)
+        end
+        it 'should return a Net::LDAP instance' do
+          expect(LDAPGroupsLookup.service).to be_an_instance_of(Net::LDAP)
+        end
+      end
+    end
+  end
+
+  describe '#ldap_groups' do
+    before(:each) do
+      entry = Net::LDAP::Entry.new('CN=user,DC=ads,DC=example,DC=net')
+      entry['memberof'] = ['CN=Group1,DC=ads,DC=example,DC=net',
+                           'CN=Group2,DC=ads,DC=example,DC=net']
+      allow_any_instance_of(Net::LDAP).to receive(:search).and_return([entry])
+      allow_any_instance_of(Net::LDAP).to receive(:bind).and_return(true)
+    end
+    context 'when subject does not provide ldap_lookup_key' do
+      before(:each) { user.class.send(:remove_method, :ldap_lookup_key) }
+      it 'should return []' do
+        expect(user.ldap_groups).to eq([])
+      end
+    end
+    context 'when subject provides ldap_lookup_key' do
+      context 'when LDAP is not configured' do
+        before(:each) do
+          config[:enabled] = false
+        end
+        it 'should return []' do
+          expect(user.ldap_groups).to eq([])
+        end
+      end
+      context 'when LDAP is configured' do
+        it 'user should belong to Group1 and Group2 in mock LDAP' do
+          expect(user.ldap_groups).to eq(%w(Group1 Group2))
+        end
+      end
+    end
+  end
+
+  describe '#member_of_ldap_group?' do
+    context 'when subject does not provide ldap_lookup_key' do
+      before(:each) { user.class.send(:remove_method, :ldap_lookup_key) }
+      it 'should return false' do
+        expect(user.member_of_ldap_group?('Test-Group')).to eq(false)
+      end
+    end
+    context 'when subject provides ldap_lookup_key' do
+      context 'when LDAP is not configured' do
+        before(:each) do
+          config[:enabled] = false
+        end
+        it 'should return false' do
+          expect(user.member_of_ldap_group?('Test-Group')).to eq(false)
+        end
+      end
+      context 'when LDAP is configured' do
+        before(:each) do
+          @service = double('ldap_service')
+          allow(LDAPGroupsLookup).to receive(:service).and_return(@service)
+
+          allow(LDAPGroupsLookup).to receive(:lookup_dn) do |args|
+            Net::LDAP::Entry.new("CN=#{args},DC=ads,DC=example,DC=net").dn
+          end
+
+          @other_group = Net::LDAP::Entry.new('CN=Other-Group,OU=Groups,DC=ads,DC=example,DC=net')
+          @other_group['member;range=0-*'] = ['CN=otheruser,DC=ads,DC=example,DC=net']
+
+          @nested_group_page_1 = Net::LDAP::Entry.new('CN=Nested-Group,OU=Groups,DC=ads,DC=example,DC=net')
+          @nested_group_page_1['member;range=0-0'] = ['CN=otheruser,DC=ads,DC=example,DC=net']
+
+          @nested_group_page_2 = Net::LDAP::Entry.new('CN=Nested-Group,OU=Groups,DC=ads,DC=example,DC=net')
+          @nested_group_page_2['member;range=1-*'] = ['CN=user,DC=ads,DC=example,DC=net']
+
+          @top_group = Net::LDAP::Entry.new('CN=Top-Group,OU=Groups,DC=ads,DC=example,DC=net')
+          @top_group['member;range=0-*'] = ['CN=Nested-Group,OU=Groups,DC=ads,DC=example,DC=net']
+
+          @no_member_group = Net::LDAP::Entry.new('CN=No-Member-Group,OU=Groups,DC=ads,DC=example,DC=net')
+        end
+        context 'when searching for a group that does not exist' do
+          it 'should return false' do
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'Fake-Group'))).and_return([])
+            expect(user.member_of_ldap_group?('Fake-Group')).to eq(false)
+          end
+        end
+        context 'when searching for a group that user is not a member of' do
+          it 'should return false' do
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'Other-Group'))).and_return([@other_group])
+            expect(user.member_of_ldap_group?('Other-Group')).to eq(false)
+          end
+        end
+        context 'when searching for a group that has no members' do
+          it 'should return false' do
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'No-Member-Group'))).and_return([@no_member_group])
+            expect(user.member_of_ldap_group?('No-Member-Group')).to eq(false)
+          end
+        end
+        context 'when searching for a group that user is a direct member of on the second page' do
+          it 'should return true' do
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'Nested-Group'),
+                               attributes: ['member;range=0-*'])).and_return([@nested_group_page_1])
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'Nested-Group'),
+                               attributes: ['member;range=1-*'])).and_return([@nested_group_page_2])
+            expect(user.member_of_ldap_group?('Nested-Group')).to eq(true)
+          end
+        end
+        context 'when searching for a group that user is a nested member of' do
+          it 'should return true' do
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'Top-Group'))).and_return([@top_group])
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'Nested-Group'),
+                               attributes: ['member;range=0-*'])).and_return([@nested_group_page_1])
+            expect(@service).to receive(:search).with(
+                hash_including(filter: Net::LDAP::Filter.equals('cn', 'Nested-Group'),
+                               attributes: ['member;range=1-*'])).and_return([@nested_group_page_2])
+            expect(user.member_of_ldap_group?('Top-Group')).to eq(true)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: ldap_groups_lookup
+version: !ruby/object:Gem::Version
+  version: 0.4.3
+platform: ruby
+authors:
+- Adam Ploshay
+- Daniel Pierce
+- Avalon Media System
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides easy access to the list of LDAP groups a username is a member
+  of.
+email:
+- aploshay@iu.edu
+- dlpierce@iu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ldap_groups_lookup.gemspec
+- lib/ldap_groups_lookup.rb
+- lib/ldap_groups_lookup/behavior.rb
+- lib/ldap_groups_lookup/configuration.rb
+- lib/ldap_groups_lookup/search.rb
+- lib/ldap_groups_lookup/version.rb
+- spec/fixtures/ldap_groups_lookup.yml.example
+- spec/lib/ldap_groups_lookup_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/IUBLibTech/ldap_groups_lookup
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Provides easy access to the list of LDAP groups a username is a member of.
+test_files:
+- spec/fixtures/ldap_groups_lookup.yml.example
+- spec/lib/ldap_groups_lookup_spec.rb
+- spec/spec_helper.rb