ldap-shell-utils 0.0.1

data/README.rdoc

@@ -0,0 +1,35 @@
+= LDAP Shell utils
+ 
+ A little wrapper over ldapsearch command a piece for working with shell wrappers
+
+
+== Installation
+
+  gem install ldap-shell-utils
+
+
+== Examples
+  
+  * lsu --config myldapconfigfile.yml --filter uid=testuser --attributes mailAlternateAddress
+  * lsu --config myldapconfigfile.yml --filter '(&(ojectClass=VirtualMailAccount)(uid=testuser)(mailAlternateAddress=*@example.com))'
+ 
+  * How to write a simple shell wrapper that can be work with base64 dn for example
+
+    #
+    # Find the Distinguished Name for an UID
+    #
+    __ldap_find_by_uid() {
+     
+      [ -s ${LDAP_CONFIG} ] && [ -n "${1}" ] && lsu --config ${LDAP_CONFIG} --filter uid=${1} dn
+    } 
+
+
+== To Do
+
+ * Testing all this stuff
+ * Improve flexibility... for example changing the ldap base with a simple command line option
+
+
+== License
+
+Copyright © 2007-2010 Javier Juarez, released under the MIT license.

data/bin/lsu

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+$:.unshift( File.join( File.dirname( __FILE__ ), %w[.. lib] ) )
+
+require 'loader'
+
+LdapShellUtils::CliApplication.run( 
+  Choice.choices[:config],
+  Choice.choices[:filter],
+  Choice.choices[:attributes]
+)

data/lib/ldap-shell-utils/cli_application.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'config_context'
+
+
+module LdapShellUtils
+  module CliApplication
+    extend self
+    
+    def run( config, filter, attributes )
+
+      ConfigContext.load( File.expand_path( config ) )
+      results = LdapConnection.new( ConfigContext.url, ConfigContext.all ).search( filter, attributes )
+      
+      if( results )
+        results.each do |entry|
+      
+          puts "dn: #{entry.dn}"
+          entry.each { |a,v| puts " - #{a}: #{v.length == 1 ? v[0]:v.inspect}" unless a == :dn }
+        end
+      end      
+    rescue Exception => e
+      $stderr.puts( e.message )
+    end
+  end
+end

data/lib/ldap-shell-utils/ldap_connection.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'uri'
+require 'net/ldap'
+
+
+module LdapShellUtils
+  class LdapConnection
+      
+    attr_reader :connection
+      
+    def initialize( url, config )
+
+      @uri           = URI.parse( url )
+      @configuration = {
+        :host => @uri.host,
+        :port => @uri.port,
+        :base => config[:base],
+        :auth => {
+          :method   => :simple,
+          :username => config[:username],
+          :password => config[:password]
+        }
+      }
+        
+      @configuration[:encryption] = { :method => :simple_tls } if( @uri.scheme.to_sym == :ldaps )
+      @connection                 = Net::LDAP.new( @configuration )
+      
+      self
+    rescue Exception => e
+      raise ArgumentError.new( e.message )
+    end
+    
+    def search( filter, attributes=[] )
+      
+      @connection.search( :filter=>Net::LDAP::Filter.from_rfc2254( filter ), :attributes=>attributes, :result=>false )
+    end
+    
+    def to_s
+      "#{@configuration.uri}"
+    end
+  end
+end

data/lib/ldap-shell-utils/options_parser.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'choice'
+
+
+Choice.options do
+  
+  header ''
+  header ' options:'
+
+  option :config, :required=>true do
+    short '-c'
+    long  '--config'
+    desc  'The Yaml config file'
+  end
+  
+  option :filter, :required=>true do
+    short '-f'
+    long  '--filter'
+    desc  'The LDAP query'
+  end
+
+  option :attributes, :required=>false do
+    short '-a'
+    long  '--attributes *ATTRIBUTES'
+    desc  'The attributes list'
+  end
+
+  separator ''
+  separator ' help:'
+
+  option :help do
+    short '-h'
+    long  '--help'
+    desc  'Show this help screen'
+  end
+
+  separator ''
+end

data/lib/loader.rb

@@ -0,0 +1,5 @@
+begin
+  Dir.glob( File.join( File.dirname( __FILE__ ), "**", "*.rb" ) ).each { |library| require library }
+rescue LoadError => e
+  $sdterr.puts( e.message )
+end

data/lib/version.rb

@@ -0,0 +1,10 @@
+module Version
+  INFO = {
+    :major =>0,
+    :minor =>0,
+    :patch =>1
+  }
+
+  NAME    = 'ldap-shell-utils'
+  VERSION = [ INFO[:major], INFO[:minor], INFO[:patch] ].join( '.' )
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification 
+name: ldap-shell-utils
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Javier Juarez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-07 00:00:00 +02:00
+default_executable: lsu
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: choice
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: net-ldap
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: config_context
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  name: jeweler
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: net-ldap
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: choice
+  version_requirements: *id009
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: config_context
+  version_requirements: *id010
+  prerelease: false
+description: This is a simple wrapper over ldapsearch util avoiding base64 dn and others gotchas
+email: javier.juarez@gmail.com
+executables: 
+- lsu
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/ldap-shell-utils/cli_application.rb
+- lib/ldap-shell-utils/ldap_connection.rb
+- lib/ldap-shell-utils/options_parser.rb
+- lib/loader.rb
+- lib/version.rb
+- README.rdoc
+- bin/lsu
+has_rdoc: true
+homepage: http://github.com/jjuarez/ldap-shell-utils
+licenses: 
+- MIT License
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: http://github.com/jjuarez/ldap-shell-utils
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A minimal ldapsearch wrapper
+test_files: []
+