ldap_query 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15fdee19f9b94af11b483add2b3c27468e3980fea6cd7a1ba6611b3fd95b88ce
+  data.tar.gz: fdefc85f213d76dabd33933367ddca893d561a5d619399f5375d13800eaa1107
+SHA512:
+  metadata.gz: f6aea9054c415c64aa37c81b623cf8559f9bc1045746a1f913512860b5a236c84b8c8e0051df154b60fb7b73011fb65a7a7a1b85ef66bca7eac277ffb9cfc73a
+  data.tar.gz: 0d52e170bfec76048141366864d9e02ec97472cb062b90054c3d989ad1efb9cb3fe5e02fd0f2b08fc635cb36ddad8d6317d53f89c9bec7d2e182b4151cb2513b

data/.fasterer

@@ -0,0 +1,29 @@
+speedups:
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true
+
+exclude_paths:
+  - '.**'
+  - 'bin/'
+  - 'coverage/'
+  - 'docs/'
+  - 'lib/generators/auth/migration/templates/**'
+  - 'tmp/**/**'
+  - '**.yml'
+  - '**.md'

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+**.gem

data/.rubocop.yml

@@ -0,0 +1,32 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+  Exclude:
+    - Gemfile
+    - Guardfile
+    - Rakefile
+    - '.**'
+    - '**.gemspec'
+    - 'bin/**/*'
+    - 'config/**/*'
+    - 'test/**/*'
+    - 'spec/**/*'
+    - 'vendor/**/*'
+    - '**/**.bak'
+    - '**/**.yml'
+  TargetRubyVersion: 2.6
+  UseCache: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+Layout/LineLength:
+  Max: 160
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 30
+Naming/MemoizedInstanceVariableName:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov-tailwindcss'
+
+SimpleCov.start do
+  add_filter('/bin/')
+  add_filter('/cache/')
+  add_filter('/docs/')
+  add_filter('/lib/ldap_query/version.rb')
+  add_filter('/spec/support/')
+end
+SimpleCov.minimum_coverage(75)
+SimpleCov.use_merging(false)
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::TailwindFormatter
+])

data/.yardopts

@@ -0,0 +1,2 @@
+--title 'LdapQuery'
+--exclude /lib/ldap_query/version.rb

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2021-02-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sailpoint.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'               # Runs tests against your application if spec files are changed
+  gem 'guard-bundler'             # Runs bundle install if anything you Gemfile is changed
+  gem 'guard-rubocop'             # Runs rubocop tests against your code as files are changed
+  gem 'guard-yard'                # Used for generating new yard documentation as changes are made
+
+  gem 'rubocop', require: false
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
+end
+
+group :test do
+  gem 'fuubar'
+  gem 'rspec'
+  gem 'simplecov', require: false
+  gem 'simplecov-tailwindcss', require: false
+end
+
+gem 'pry', group: %i[development test]

data/Gemfile.lock

@@ -0,0 +1,146 @@
+PATH
+  remote: .
+  specs:
+    ldap_query (0.0.1)
+      activesupport (>= 5.0)
+      net-ldap (~> 0.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    fuubar (2.5.1)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (3.0.0)
+      bundler (>= 2.1, < 3)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.4.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
+    guard-yard (2.2.1)
+      guard (>= 1.1.0)
+      yard (>= 0.7.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    nenv (0.3.0)
+    net-ldap (0.17.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-tailwindcss (1.0.2)
+      simplecov (~> 0.16)
+    simplecov_json_formatter (0.1.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (>= 1.17, < 3.0)
+  fuubar
+  guard
+  guard-bundler
+  guard-rspec
+  guard-rubocop
+  guard-yard
+  ldap_query!
+  pry
+  rake (~> 13)
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  simplecov
+  simplecov-tailwindcss
+
+BUNDLED WITH
+   2.2.11

data/Guardfile

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+rspec_options = {
+  version:        1,
+  all_after_pass: false,
+  all_on_start:   false
+}.freeze
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+# guard :rubocop do
+# guard :rubocop, cli: %w(--format fuubar --format html -o ./tmp/rubocop_results.html), launchy: './tmp/rubocop_results.html' do
+guard :rubocop, cli: %w(--format fuubar) do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+# Generates new Yard documentation as the files are changed
+guard 'yard' do
+  watch(%r{lib\/.+\.rb})
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Brandon Hicks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+[![LdapQuery][rubygems-downloads]][rubygems-link]
+[![Gem Version][rubygems-version]][rubygems-link]
+[![MIT License][license-shield]][license-url]
+
+# LdapQuery
+
+I used to make querying LDAP with a ruby or rails application an easy process rather than pain trying to figure out how to bind the connections. Build a LDAP filter and querying the LDAP host for matching results.
+
+It was taken into account that not all ruby scripts are part of a rails application, so you can either pass it a credentials hash. But if you're making the queries from a rails application with and haven't passed a credentials hash it resolves to looking for an entry in your encrypted credentials with an ldap key.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ldap_query'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ldap_query
+
+## Usage
+
+If you're using this gems functionality from a rails application you'll want to either add the following to your encrypted credentials file or pass the credentials to your query helpers as an optional parameter.
+
+```yaml
+ldap:
+  host: company_host.tld
+  base: DC=company,DC=org,DC=tld
+  username: cn=Common,OU=Organization,DC=Domain,DC=tld
+  password: password123
+  port: 636
+  encryption: simple_tls
+  method: simple
+```
+
+_(port, encryption, and method are optional)_
+
+If using this gem in a rails application there are helpers available that you can called from your controllers, views/helpers, and/or models.
+
+#### Rails Helpers
+
+```ruby
+search_ldap_by_username(str)  # seaches for a matching `cn`
+
+search_ldap_by_name(str)  # searches for a matching `displayname`
+
+search_ldap_by_group(str) # tries to find a match against a matching `memberof`
+
+search_ldap_by_mail(str)  # matches against the ldap users mail attribute
+
+search_ldap_by_other(attr: 'key', val: 'val') # matches against the specified ldap attribute and value
+
+authenticate_user(username: 'jdoe', password: 'pass123')  # Bind a user against the ldap base to authenticate their credentials
+```
+
+There are 2 optional keyword parameters you can pass when using these helpers, `wildcard:` and `limit:`.
+
+Default values
+
+```ruby
+wildcard: false # when set as false it expects an exact match
+limit: 20       # default limit of ldap results returned
+```
+
+Without wildcard ldap requires an exact match like, ie if you have a user with a displayname of `John A. Doe` and you do a lookup with wildcard as false with the str `John Doe` it won't return the user. But if wildcard is set as true it compares against ldap with the value of `John*Doe`. Which _should_ match the user,
+
+To change these values you just add the key and value to the method call.
+
+`search_ldap_by_username('jdoe', wildcard: true)`
+
+
+These helpers also allow a _(optional)_ secondary parameter to be passed to them. This secondary will be used as the ldap credential. By default the gem will pull the ldap connections credentials from your encrypted credentials, so you don't need to pass paramters, if you have set the credentials with a base key of `ldap:`. But the one case were you may need to pass the credentials is if you want to hit multiple ldap hosts/bases to grab different results.
+
+```ruby
+first_results = search_ldap_by_username('jdoe', first_host_credentials_hash)
+second_results = search_ldap_by_username('jdoe', hash_host_credentials_hash)
+```
+
+#### CLI or Ruby script
+
+But these helpers are optional and can be used in CLI or through a ruby script without having to use rails.
+
+Jsut be sure to include the LdapQuery gem into your ruby script or terminal with the following: `require 'ldap_query'`.
+
+The main part of build the query if using `LdapQuery::Query.perform` method. You need to ensure you pass the credentials hash, the ldap attribute you want to query againt _(ie: :cn)_ and the val you are will be querying ldap with. As see from the helper methods above you can also pass the keyword/values for `wildcard` and `limit`.
+
+```ruby
+require 'ldap_query'
+
+# You LDAP credentials always need to be passed as hash, listed below are the required parameters
+# (optional parameters include: port, method, and encryption)
+credentials = { base: 'DC=company,DC=org,DC=tld', username: 'cn=Common,OU=Organization,DC=Domain,DC=tld', password: 'password123', host: 'company.tld' }
+
+LdapQuery::Query.perform(credentials, attr: :cn, val: str)
+LdapQuery::Query.perform(credentials, attr: :displayname, val: 'John Doe', limit: 3)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tarellel/ldap_query.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[license-shield]: https://img.shields.io/github/license/tarellel/ldap_query.svg?style=flat-square
+[license-url]: https://github.com/tarellel/ldap_query/blob/master/LICENSE
+[rubygems-downloads]: https://ruby-gem-downloads-badge.herokuapp.com/ldap_query?type=total
+[rubygems-link]: https://rubygems.org/gems/ldap_query
+[rubygems-version]: https://badge.fury.io/rb/ldap_query.svg