database_cleaner-ldap 0.1.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e3bf95bf018753b3ce51d8c1212f62cc17165aa9b437e831ff7979505d7360d
+  data.tar.gz: 339de7b3c63b4d8734a3f4a2919d54f81f70885fad5be1ab1de2db02e8be41e3
+SHA512:
+  metadata.gz: 9d7f75f7fb0731571d7f0d60045cd0907f2a7042fe7efe7e7d40e2d5e409e6936df1148f83a08c6a08e782b763109d3541b376ba3bdb34b4e451ad7381349f5b
+  data.tar.gz: fd16babf5cfa69f5f68a45a73091e4379b1e8fe8a4006ff6c9f7935bd71831514601603fa4c668817be72a20abd8ef8526648b9d6ab7e613fbaf7bd59cbbbd09

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thomas.scholz@swisscom.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in database_cleaner-ldap.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    database_cleaner-ldap (0.1.0)
+      database_cleaner-core (~> 2.0.0.beta)
+      net-ldap (~> 0.16.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    database_cleaner-core (2.0.0.beta2)
+    diff-lcs (1.4.4)
+    net-ldap (0.16.3)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  database_cleaner-ldap!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,52 @@
+# Database Cleaner Adapter for LDAP
+
+Clean your LDAP Database with Database Cleaner.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+group :test do
+  gem 'database_cleaner-ldap', '~> 0.1.0'
+end
+```
+
+## Usage
+
+### RSpec Example
+
+```ruby
+# spec/support/database_cleaner.rb
+
+require 'database_cleaner/ldap'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner[:ldap, db: Net::LDAP.new].strategy = :deletion, {
+      # Clean posixGroups and posixAccounts only, don't touch other LDAP entries
+      filter: Net::LDAP::Filter.eq('objectClass', 'posixGroup') | Net::LDAP::Filter.eq('objectClass', 'posixAccount')
+    }
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning { example.run }
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/database_cleaner-ldap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/database_cleaner-ldap/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the DatabaseCleaner::Ldap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/database_cleaner-ldap/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "database_cleaner/ldap"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/database_cleaner-ldap.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/database_cleaner/ldap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_cleaner-ldap"
+  spec.version       = DatabaseCleaner::Ldap::VERSION
+  spec.authors       = ["Thomas Scholz"]
+  spec.email         = ["thomas.scholz@swisscom.com"]
+
+  spec.summary       = %q{Strategy for cleaning LDAP databases. Can be used to ensure a clean state for testing.}
+  spec.description   = %q{Strategy for cleaning LDAP databases. Can be used to ensure a clean state for testing.}
+  spec.homepage      = "https://github.com/tscholz/database_cleaner-ldap"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tscholz/database_cleaner-ldap"
+  spec.metadata["changelog_uri"] = "https://github.com/tscholz/database_cleaner-ldap/CHANGELOG"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "database_cleaner-core", "~> 2.0.0.beta"
+  spec.add_dependency "net-ldap", '~> 0.16.0'
+end

data/lib/database_cleaner-ldap.rb

@@ -0,0 +1 @@
+require 'database_cleaner/ldap'

data/lib/database_cleaner/ldap.rb

@@ -0,0 +1,14 @@
+require "net/ldap"
+require "database_cleaner/core"
+
+require "database_cleaner/ldap/version"
+require "database_cleaner/ldap/deletion"
+
+module DatabaseCleaner
+  module Ldap
+
+  end
+end
+
+# This triggers the DATABASE_URL safeguard before it can be configured. :( TODO file an issue on the Database Cleaner project
+# DatabaseCleaner[:ldap].strategy = :deletion

data/lib/database_cleaner/ldap/deletion.rb

@@ -0,0 +1,35 @@
+require "database_cleaner/strategy"
+
+module DatabaseCleaner
+  module Ldap
+    class Deletion < Strategy
+      attr_reader :filter
+
+      def initialize(filter: nil)
+        raise ArgumentError,
+          "Option :filter must be a Net::LDAP::Filter" unless filter.nil? || filter.is_a?(Net::LDAP::Filter)
+
+        @filter = filter
+      end
+
+      def clean
+        entries.each { |ldap_entry| delete! ldap_entry.dn }
+      end
+
+      def db
+        @db ||= Net::LDAP.new
+      end
+
+      private
+
+      def entries
+        Array db.search(filter: filter)
+      end
+
+      def delete!(dn)
+        db.delete(dn: dn) or
+          raise "Could no delete #{dn}. Reason: #{db.get_operation_result}"
+      end
+    end
+  end
+end

data/lib/database_cleaner/ldap/version.rb

@@ -0,0 +1,5 @@
+module DatabaseCleaner
+  module Ldap
+    VERSION = "0.1.0.pre.1"
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: database_cleaner-ldap
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.1
+platform: ruby
+authors:
+- Thomas Scholz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: Strategy for cleaning LDAP databases. Can be used to ensure a clean state
+  for testing.
+email:
+- thomas.scholz@swisscom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- database_cleaner-ldap.gemspec
+- lib/database_cleaner-ldap.rb
+- lib/database_cleaner/ldap.rb
+- lib/database_cleaner/ldap/deletion.rb
+- lib/database_cleaner/ldap/version.rb
+homepage: https://github.com/tscholz/database_cleaner-ldap
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tscholz/database_cleaner-ldap
+  source_code_uri: https://github.com/tscholz/database_cleaner-ldap
+  changelog_uri: https://github.com/tscholz/database_cleaner-ldap/CHANGELOG
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Strategy for cleaning LDAP databases. Can be used to ensure a clean state
+  for testing.
+test_files: []