ldap_fluff 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28f120e9600034857038687026da6b26a453c2b2
-  data.tar.gz: 4c7793f94f748e29ee2cc0191a28c6f05ff9ff8d
+  metadata.gz: d9bbb3a76eb304f5d32ed7cb7b4cbc0e8b2551be
+  data.tar.gz: 179e0be4fe95dd4da12e036d64691fe8c8597df9
 SHA512:
-  metadata.gz: 39b79a3b20b2285cb98d33b3d8c1e6c706d530f6ee818144e5f9b8f91295b508868750ad9d89e06af56f5f090d3e139799a5d3da8698ee05274e59e39500b2e1
-  data.tar.gz: 91727abfcb17862ae23e5b7b6133e7449a68e3eacd7d8e8fb858d9afc215b44365e509a7471242395b468577cbd7bbac84dfd3853a5566d398cddc5137f1f2d1
+  metadata.gz: bdd878bcb8282f68359fac8376931d32b09f1c5b02b3fb25ca777855e3507460102711337129969f90f86ddc03a69a66ef97593c57956cebc4ef72e5154fd5bc
+  data.tar.gz: dbd1e8e105c879941c04a50b2c7e1a0aafa705e287ff38b2b62fbcd7bef983494c3ecaf517476ca5574409606208cb2192345dea3fac6e2307273c7c2e89d921

data/README.rdoc

@@ -56,6 +56,7 @@ Your global configuration must provide information about your LDAP host to funct
   service_user: # service account for authenticating LDAP calls. required unless you enable anon
   service_pass: # service password for authenticating LDAP calls. required unless you enable anon
   anon_queries: # false by default, true if you don't want to use the service user
+  instrumentation_service: # nil by default, an object that supports the ActiveSupport::Notifications API
 
 You can pass these arguments as a hash to LdapFluff to get a valid LdapFluff object.
 
@@ -85,6 +86,17 @@ service_user (formatted as "ad_domain/username") and service_pass OR anon_querie
 ldap_fluff appends cn=groups,cn=accounts to the beginning of all BIND calls. You do not need to
 include this in your base_dn string
 
+=== Instrumentation
+
+Both net-ldap and ldap_fluff support instrumentation of API calls, which can help debug performance issues or
+to find what LDAP queries are being made.
+
+The :instrumentation_service item in the configuration should support an equivalent API to
+ActiveSupport::Notifications.  ldap_fluff will use this and also pass it to net-ldap.
+
+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
 
 ldap_fluff is licensed under the GPLv2. Please read LICENSE for more information.

data/lib/ldap_fluff/config.rb

@@ -3,15 +3,17 @@ require 'active_support/core_ext/hash'
 
 class LdapFluff::Config
   ATTRIBUTES = %w[host port encryption base_dn group_base server_type service_user
-                    service_pass anon_queries attr_login search_filter]
+                    service_pass anon_queries attr_login search_filter
+                    instrumentation_service ]
   ATTRIBUTES.each { |attr| attr_reader attr.to_sym }
 
-  DEFAULT_CONFIG = { 'port'         => 389,
-                     'encryption'   => nil,
-                     'base_dn'      => 'dc=company,dc=com',
-                     'group_base'   => 'dc=company,dc=com',
-                     'server_type'  => :free_ipa,
-                     'anon_queries' => false }
+  DEFAULT_CONFIG = { 'port' => 389,
+                     'encryption' => nil,
+                     'base_dn' => 'dc=company,dc=com',
+                     'group_base' => 'dc=company,dc=com',
+                     'server_type' => :free_ipa,
+                     'anon_queries' => false,
+                     'instrumentation_service' => nil }
 
   def initialize(config)
     raise ArgumentError unless config.respond_to?(:to_hash)

data/lib/ldap_fluff/generic.rb

@@ -2,10 +2,11 @@ class LdapFluff::Generic
   attr_accessor :ldap, :member_service
 
   def initialize(config = {})
-    @ldap = Net::LDAP.new(:host       => config.host,
-                          :base       => config.base_dn,
-                          :port       => config.port,
-                          :encryption => config.encryption)
+    @ldap = Net::LDAP.new(:host => config.host,
+                          :base => config.base_dn,
+                          :port => config.port,
+                          :encryption => config.encryption,
+                          :instrumentation_service => config.instrumentation_service)
     @bind_user  = config.service_user
     @bind_pass  = config.service_pass
     @anon       = config.anon_queries

data/lib/ldap_fluff/ldap_fluff.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'net/ldap'
 
 class LdapFluff
-  attr_accessor :ldap
+  attr_accessor :ldap, :instrumentation_service
 
   def initialize(config = {})
     config = LdapFluff::Config.new(config)
@@ -16,53 +16,85 @@ class LdapFluff
     else
       raise 'unknown server_type'
     end
+    @instrumentation_service = config.instrumentation_service
   end
 
   def authenticate?(uid, password)
-    if password.nil? || password.empty?
-      false
-    else
-      !!@ldap.bind?(uid, password)
+    instrument('authenticate.ldap_fluff', :uid => uid) do |payload|
+      if password.nil? || password.empty?
+        false
+      else
+        !!@ldap.bind?(uid, password)
+      end
     end
   end
 
   def test
-    @ldap.ldap.open {}
+    instrument('test.ldap_fluff') do |payload|
+      @ldap.ldap.open {}
+    end
   end
 
   # return a list[] of users for a given gid
   def user_list(gid)
-    @ldap.users_for_gid(gid)
+    instrument('user_list.ldap_fluff', :gid => gid) do |payload|
+      @ldap.users_for_gid(gid)
+    end
   end
 
   # return a list[] of groups for a given uid
   def group_list(uid)
-    @ldap.groups_for_uid(uid)
+    instrument('group_list.ldap_fluff', :uid => uid) do |payload|
+      @ldap.groups_for_uid(uid)
+    end
   end
 
   # return true if a user is in all of the groups
   # in grouplist
   def is_in_groups?(uid, grouplist)
-    @ldap.is_in_groups(uid, grouplist, true)
+    instrument('is_in_groups?.ldap_fluff', :uid => uid, :grouplist => grouplist) do |payload|
+      @ldap.is_in_groups(uid, grouplist, true)
+    end
   end
 
   # return true if uid exists
   def valid_user?(uid)
-    @ldap.user_exists? uid
+    instrument('valid_user?.ldap_fluff', :uid => uid) do |payload|
+      @ldap.user_exists? uid
+    end
   end
 
   # return true if group exists
   def valid_group?(gid)
-    @ldap.group_exists? gid
+    instrument('valid_group?.ldap_fluff', :gid => gid) do |payload|
+      @ldap.group_exists? gid
+    end
   end
 
   # return ldap entry
   def find_user(uid)
-    @ldap.member_service.find_user(uid)
+    instrument('find_user.ldap_fluff', :uid => uid) do |payload|
+      @ldap.member_service.find_user(uid)
+    end
   end
 
   # return ldap entry
   def find_group(gid)
-    @ldap.member_service.find_group(gid)
+    instrument('find_group.ldap_fluff', :gid => gid) do |payload|
+      @ldap.member_service.find_group(gid)
+    end
+  end
+
+  private
+
+  def instrument(event, payload = {})
+    payload = (payload || {}).dup
+    if instrumentation_service
+      instrumentation_service.instrument(event, payload) do |payload|
+        payload[:result] = yield(payload) if block_given?
+      end
+    else
+      yield(payload) if block_given?
+    end
   end
 end

data/test/config_test.rb

@@ -22,4 +22,9 @@ class ConfigTest < MiniTest::Test
     assert_instance_of LdapFluff::FreeIPA, ldap.ldap
   end
 
+  def test_instrumentation_service
+    is = Object.new
+    net_ldap = LdapFluff.new(config_hash.update :instrumentation_service => is).ldap.ldap
+    assert_equal is, net_ldap.send(:instrumentation_service)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldap_fluff
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Jordan O'Mara
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ldap
@@ -83,29 +83,29 @@ extra_rdoc_files:
 - README.rdoc
 - LICENSE
 files:
+- LICENSE
+- README.rdoc
 - lib/ldap_fluff.rb
-- lib/ldap_fluff/generic.rb
-- lib/ldap_fluff/generic_member_service.rb
+- lib/ldap_fluff/active_directory.rb
+- lib/ldap_fluff/ad_member_service.rb
+- lib/ldap_fluff/config.rb
+- lib/ldap_fluff/error.rb
 - lib/ldap_fluff/freeipa.rb
 - lib/ldap_fluff/freeipa_member_service.rb
-- lib/ldap_fluff/error.rb
+- lib/ldap_fluff/generic.rb
+- lib/ldap_fluff/generic_member_service.rb
 - lib/ldap_fluff/ldap_fluff.rb
-- lib/ldap_fluff/active_directory.rb
-- lib/ldap_fluff/posix_member_service.rb
-- lib/ldap_fluff/config.rb
 - lib/ldap_fluff/posix.rb
-- lib/ldap_fluff/ad_member_service.rb
+- lib/ldap_fluff/posix_member_service.rb
 - test/ad_member_services_test.rb
-- test/config_test.rb
-- test/ldap_test.rb
-- test/posix_member_services_test.rb
 - test/ad_test.rb
-- test/ipa_test.rb
+- test/config_test.rb
 - test/ipa_member_services_test.rb
+- test/ipa_test.rb
+- test/ldap_test.rb
 - test/lib/ldap_test_helper.rb
+- test/posix_member_services_test.rb
 - test/posix_test.rb
-- README.rdoc
-- LICENSE
 homepage: https://github.com/theforeman/ldap_fluff
 licenses:
 - GPLv2
@@ -126,18 +126,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: LDAP querying tools for Active Directory, FreeIPA and POSIX-style
 test_files:
-- test/ad_member_services_test.rb
-- test/config_test.rb
-- test/ldap_test.rb
+- test/ipa_member_services_test.rb
 - test/posix_member_services_test.rb
 - test/ad_test.rb
 - test/ipa_test.rb
-- test/ipa_member_services_test.rb
+- test/ldap_test.rb
 - test/lib/ldap_test_helper.rb
 - test/posix_test.rb
-has_rdoc: true
+- test/ad_member_services_test.rb
+- test/config_test.rb