ldap_groups_lookup 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6da72dceefbf3ea333aeb46b7288da0d3ec3517c05fbcbc77f53eb3fc955f2
-  data.tar.gz: 1720d92a5e416dbb2f4fafec7c2fc85239d82bb8ef6982909646217260d91457
+  metadata.gz: 9e7affc77773609169dc9b5bd910bd7c1d9e8a3e157f0c9f33e843dd626df735
+  data.tar.gz: 9b1c0bf677410247aec9634defcd67e5ade14ec40a86ad72d7ea59aae9dead55
 SHA512:
-  metadata.gz: b05d74e63567fb0e0272cf2242a395c9a0dc0125306112e1671eba47bd9460c73c1fff154d1b5708fc4669f0877d9d30dd87320256fcbdf7f39ca56269d8d9cc
-  data.tar.gz: 5becbdb0a9356bfa9b53df4133d9ffc955b77a0c50757265d80457ee7a0c86b59d74cca811732fefbb8700879d1210de3cd120c50095bd81cc4fb464f686f468
+  metadata.gz: 7f98193e36b4165186f6aaa6aeb99f213d71f84feb90391a231084d61395ea022fabdbe38031a8607ffd8c97cebf02420036a6ff0327cb2537a60ad17d49f7c7
+  data.tar.gz: 6d7456b672ec139e12c60a428c279cb02cd5bebaea54f25e02467a1b7663836057c352fa32baa1010d8999eef9ef0c47da7950a8a5ea195476dabeb2a30b93e3

data/.github/workflows/ruby.yml

@@ -18,19 +18,17 @@ permissions:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.2']
-
+        ruby-version: ['2.7', '3.3']
     steps:
     - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/README.md

@@ -1,4 +1,5 @@
 # IU LDAP Groups Lookup
+[![Gem Version](https://badge.fury.io/rb/ldap_groups_lookup.svg)](https://badge.fury.io/rb/ldap_groups_lookup)
 
 ## Usage
 
@@ -32,12 +33,37 @@ u.member_of_ldap_group?(['Some-Group'])
 
 ## Configuration
 
-Create a file `config/ldap_groups_lookup.yml` that looks like:
+### Initializer
+Create an initializer `config/initializers/ldap_groups_lookup.rb` that looks like:
+```ruby
+LDAPGroupsLookup.config = {
+  enabled: true,
+  config: { host: 'ads.example.net',
+            port: 636,
+            encryption: {
+              method: :simple_tls,
+              tls_options: OpenSSL::SSL::SSLContext::DEFAULT_PARAMS,
+            },
+            auth: {
+              method: :simple,
+              username: "cn=example",
+              password: 'changeme',
+            }
+  },
+  tree: 'dc=ads,dc=example,dc=net',
+  account_ou: 'ou=Accounts',
+  group_ou: 'ou=Groups',
+  member_allowlist: ['OU=Groups']
+}
+```
+
+### YAML
+Alternatively, create a file `config/ldap_groups_lookup.yml` that looks like:
 
 ```yaml
 :enabled: true
 :host: ads.example.net
-:port: 636
+:port: 389
 :auth:
   :method: :simple
   :username: example
@@ -45,6 +71,7 @@ Create a file `config/ldap_groups_lookup.yml` that looks like:
 :tree: dc=ads,dc=example,dc=net
 :account_ou: ou=Accounts
 :group_ou: ou=Groups
-:member_whitelist:
+:member_allowlist:
   - OU=Groups
-```
+```
+Note: The yaml style does not allow for easy configuration of some properties like tls_options or other auth methods.

data/lib/ldap_groups_lookup/configuration.rb

@@ -50,8 +50,8 @@ module LDAPGroupsLookup
       config[:tree]
     end
 
-    def member_whitelist
-      config[:member_whitelist].to_a
+    def member_allowlist
+      config[:member_allowlist] || ['OU=Groups']
     end
 
     private

data/lib/ldap_groups_lookup/search.rb

@@ -57,7 +57,7 @@ module LDAPGroupsLookup
         next if seen.include? g
         seen << g
         member_groups = members.collect do |mg|
-          dn_to_cn(mg) if member_whitelist.empty? || member_whitelist.any? do |fil|
+          dn_to_cn(mg) if member_allowlist.empty? || member_allowlist.any? do |fil|
             mg.include? fil
           end
         end

data/lib/ldap_groups_lookup/version.rb

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

data/spec/fixtures/ldap_groups_lookup.yml.example

@@ -8,5 +8,5 @@
 :tree: dc=ads,dc=example,dc=net
 :account_ou: ou=Accounts
 :group_ou: ou=Groups
-:member_whitelist:
+:member_allowlist:
   - OU=Groups

data/spec/lib/ldap_groups_lookup_spec.rb

@@ -243,25 +243,25 @@ RSpec.describe LDAPGroupsLookup do
                   hash_including(filter: Net::LDAP::Filter.equals('cn', 'Nested-Group'),
                                  attributes: ['member;range=1-*'])).and_return([@nested_group_page_2])
             end
-            context 'when the group is whitelisted' do
+            context 'when the group is allowlisted' do
               before do
-                allow(LDAPGroupsLookup).to receive(:member_whitelist).and_return(['OU=Groups'])
+                allow(LDAPGroupsLookup).to receive(:member_allowlist).and_return(['OU=Groups'])
               end
               it 'should return true' do
                 expect(user.member_of_ldap_group?('Top-Group')).to eq(true)
               end
             end
-            context 'when the whitelist is empty' do
+            context 'when the allowlist is empty' do
               before do
-                allow(LDAPGroupsLookup).to receive(:member_whitelist).and_return([])
+                allow(LDAPGroupsLookup).to receive(:member_allowlist).and_return([])
               end
-              it 'should return true (whitelisting is disabled)' do
+              it 'should return true (allowlisting is disabled)' do
                 expect(user.member_of_ldap_group?('Top-Group')).to eq(true)
               end
             end
-            context 'when the group is not whitelisted' do
+            context 'when the group is not allowlisted' do
               before do
-                allow(LDAPGroupsLookup).to receive(:member_whitelist).and_return(['OU=Not-A-Match'])
+                allow(LDAPGroupsLookup).to receive(:member_allowlist).and_return(['OU=Not-A-Match'])
               end
               it 'should return false' do
                 expect(user.member_of_ldap_group?('Top-Group')).to eq(false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldap_groups_lookup
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Adam Ploshay
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ldap