ldap_groups_lookup 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93b710e0c55641a70229aef31de0eb3bcbac110ee8ea7f34e4aea784cd605c74
-  data.tar.gz: eaa38276bd60526a24ce3979e757cb1423985b71bc05647017ce04a13566ac46
+  metadata.gz: 87571e7afbf4949aab968013b93e8aef388659e5196346d1b1d70cf9bdfa34ed
+  data.tar.gz: 4ffba8461216819da410a872d463fe8a49e73495c8f7d4ca3e96aeff6e81123d
 SHA512:
-  metadata.gz: 5041fe650a03a4a70732df646a1b86e61c28c1c5e366f6254dc156edc6e6a46afb35e315bd7985e90c4097ffb280f1b617e5fe0ea8641d2ff300222e8ec6feb3
-  data.tar.gz: aee6357c288d1b069a274c7aa413ac8a26170a177d1b269b2ea0d871f4f6c1e77d5a375994a45eadc28159f1e126cc62504db747e5e45cc679a1245835da8707
+  metadata.gz: '009ec292b50df3a270bca37bdf49ce1dfa3cc82c21dd0efb9764743489d5ec16cf983af3446019aed0a58923d174abb0e2e8af2122a583b11e633ba210d37cfe'
+  data.tar.gz: 9ac84ea34432eb8430793031d9a4f45e34eb06cba597e59d0f8c7978af13608cdb25fe91d4e99fc236cbeddb42ea2f03b95a0166359d0a9f3fec1012aaba5471

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.2']
+
+    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
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,8 +1,10 @@
 # IU LDAP Groups Lookup
 
+## Usage
+
 Adds an LDAPGroupsLookup that can be included in a a class to provide an #ldap_groups instance method:
 
-```
+```ruby
 class User
   attr_accessor :ldap_lookup_key
   include LDAPGroupsLookup::Behavior
@@ -16,7 +18,7 @@ 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:
 
-```
+```ruby
 class User < ActiveRecord::Base
   validates :username, presence: true, uniqueness: true
   alias_attribute :ldap_lookup_key, :username
@@ -27,3 +29,22 @@ u = User.find_by(username: 'some_username')
 u.ldap_groups
 u.member_of_ldap_group?(['Some-Group'])
 ```
+
+## Configuration
+
+Create a file `config/ldap_groups_lookup.yml` that looks like:
+
+```yaml
+:enabled: true
+:host: ads.example.net
+:port: 636
+:auth:
+  :method: :simple
+  :username: example
+  :password: changeme
+:tree: dc=ads,dc=example,dc=net
+:account_ou: ou=Accounts
+:group_ou: ou=Groups
+:member_whitelist:
+  - OU=Groups
+```

data/ldap_groups_lookup.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
   gem.required_ruby_version = '>= 2.3.0'
+  gem.metadata      = { "rubygems_mfa_required" => "true" }
 
   gem.add_dependency 'net-ldap'
   gem.add_development_dependency 'rake'

data/lib/ldap_groups_lookup/configuration.rb

@@ -9,7 +9,11 @@ module LDAPGroupsLookup
     def service
       return nil if config[:enabled] == false
       if @ldap_service.nil?
-        @ldap_service = Net::LDAP.new(host: config[:host], auth: config[:auth])
+        if config[:config].is_a? Hash
+          @ldap_service = Net::LDAP.new(**config[:config])
+        else
+          @ldap_service = Net::LDAP.new(host: config[:host], port: config[:port] || Net::LDAP::DefaultPort, auth: config[:auth])
+        end
         raise Net::LDAP::Error unless @ldap_service.bind
       end
       @ldap_service
@@ -55,7 +59,7 @@ module LDAPGroupsLookup
       if value.nil? || value.is_a?(Hash)
         @config = value
       elsif value.is_a?(String)
-        if File.exists?(value)
+        if File.exist?(value)
           @config = YAML.load(ERB.new(File.read(value)).result)
         else
           @config = { enabled: false }

data/lib/ldap_groups_lookup/version.rb

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

data/spec/fixtures/ldap_groups_lookup.yml.example

@@ -1,5 +1,6 @@
 :enabled: true
 :host: ads.example.net
+:port: 636
 :auth:
   :method: :simple
   :username: example

data/spec/lib/ldap_groups_lookup_spec.rb

@@ -28,7 +28,7 @@ RSpec.describe LDAPGroupsLookup 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$/)
+        expect(File).to receive(:exist?).with(/config\/ldap_groups_lookup\.yml$/)
       end
       it 'should return nil' do
         expect(LDAPGroupsLookup.service).to be_nil
@@ -61,6 +61,15 @@ RSpec.describe LDAPGroupsLookup do
         it 'should return a Net::LDAP instance' do
           expect(LDAPGroupsLookup.service).to be_an_instance_of(Net::LDAP)
         end
+
+        context 'when the :config key is set' do
+          let(:config_hash) { { host: 'localhost', port: 636, encryption: { method: :simple_tls, tls_options: OpenSSL::SSL::SSLContext::DEFAULT_PARAMS } } }
+          before { config[:config] = config_hash }
+          it 'uses that config' do
+            expect(Net::LDAP).to receive(:new).with(config_hash).and_call_original
+            expect(LDAPGroupsLookup.service).to be_an_instance_of(Net::LDAP)
+          end
+        end
       end
     end
   end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ldap_groups_lookup
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Adam Ploshay
 - Daniel Pierce
 - Avalon Media System
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ldap
@@ -77,9 +77,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -95,8 +95,9 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/IUBLibTech/ldap_groups_lookup
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,9 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: Provides easy access to the list of LDAP groups a username is a member of.
 test_files:

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
- - 2.3
- - 2.4
- - 2.5
- - 2.6
- - 2.7