Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor code/tests to apply almost rubocop rules #60

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add development guide into README file
  • Loading branch information
nthachus committed Nov 13, 2019
commit 8e2e3afe2b4f2fdc25ccd28c723a5fd0d642cf08
19 changes: 14 additions & 5 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,12 @@ Your global configuration must provide information about your LDAP host to funct

You can pass these arguments as a hash to LdapFluff to get a valid LdapFluff object.

ldap_config = { :host => "freeipa.localdomain", :port => 389, :encryption => nil, :base_dn => "DC=mydomain,DC=com",
:group_base => "DC=groups,DC=mydomain,DC=com", :attr_login => "uid", :server_type => :free_ipa,
:service_user => "admin", :search_filter => "(objectClass=*)", :service_pass => "mypass",
:anon_queries => false }
ldap_config = {
:host => "freeipa.localdomain", :port => 389, :encryption => nil, :base_dn => "DC=mydomain,DC=com",
:group_base => "DC=groups,DC=mydomain,DC=com", :attr_login => "uid", :server_type => :free_ipa,
:service_user => "admin", :search_filter => "(objectClass=*)", :service_pass => "mypass",
:anon_queries => false
}

fluff = LdapFluff.new(ldap_config)
fluff.valid_user?("admin") # returns true
Expand Down Expand Up @@ -99,6 +101,13 @@ ActiveSupport::Notifications. ldap_fluff will use this and also pass it to net-
When using Rails, pass `:instrumentation_service => ActiveSupport::Notifications` and then subscribe to, and
optionally log events (e.g. https://gist.github.com/mnutt/566725).

=== License
== Development

After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake` to run the tests.
You can also run `irb -r bundler/setup -r ldap_fluff` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`.

== License

ldap_fluff is licensed under the GPLv2. Please read LICENSE for more information.