ldap-shell-utils 0.0.4 → 0.1.0

data/bin/lsu

@@ -1,36 +1,12 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W0
 
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
 
-$:.unshift( File.join( File.dirname( __FILE__ ), %w[.. lib] ) )
-
-
-require 'rubygems'
-require 'slop'
 require 'ldap-shell-utils'
 
-
-def validate_options( options )
-
-  options[:config] && options[:filter]
-end
-
-
-slop = Slop.new( :strict => true, :help=> true ) do
-  
-  banner "Usage:\n\t#{$0} [options]\n\nOptions:"
-  
-  on :a, :audit,  'Audit result entries'
-  on :c, :config, 'The configuration file', :optional => false
-  on :f, :filter, 'Query', :optional => false
-  on :attributes, 'Entry attribute list', :optional => true, :as => Array, :delimiter => ','
-end
-
-
-begin
-  slop.parse( )
-  options = slop.to_hash( true )
-  LdapShellUtils::CliApplication.run( options ) if validate_options( options )
-rescue Slop::InvalidOptionError => e
-  $stderr.puts( e.message )
-  exit 
-end
+LdapShellUtils::CliApplication.run( {
+  :config     =>Choice.choices[:config],
+  :filter     =>Choice.choices[:filter],
+  :attributes =>Choice.choices[:attributes],
+  :audit      =>Choice.choices[:audit]
+})

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

@@ -6,20 +6,21 @@ module LdapShellUtils
   module CliApplication
     extend self
     
-    def print_entry( entry )
+    def self.run(options)
 
-      puts "#{entry.dn}"
-      entry.each { |a,v| puts "#{a}: #{(v.size == 1) ? v[0]:v.inspect}" unless a == :dn }
-    end
-    
-    def run( options )
-
-      ConfigContext.configure( File.expand_path( options[:config] ) )
-
-      results = LdapConnection.new( ConfigContext.url, ConfigContext.to_hash ).search( options[:filter], options[:attributes], options[:audit] )
-      results.each { |e| print_entry( e ) } if results
-    rescue Exception => e
-      $stderr.puts( e.message )
+      ConfigContext.configure(File.expand_path(options[:config]))
+      
+      options = { :audit=>false }.merge(options)
+      results = LdapConnection.new(ConfigContext.to_hash).search(options)
+      
+      results.each do |entry|
+        puts "#{entry.dn}"
+        entry.each do |attr,values| 
+          puts "#{attr}: #{(values.size == 1) ? values[0] : values.inspect}" unless attr == :dn 
+        end
+      end if results
+    rescue Exception=>e
+      $stderr.puts(e.message)
     end
   end
 end

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

@@ -6,46 +6,43 @@ require 'net/ldap'
 module LdapShellUtils
   class LdapConnection
       
-    OPERATIONAL_ATTRIBUTES = [
-      :creatorsname, 
-      :createtimestamp, 
-      :modifiersname, 
-      :modifytimestamp
-    ]
-      
     public
-    def initialize( url, config )
+    def initialize(config)
 
-      @uri           = URI.parse( url )
-      @configuration = {
-        :host => @uri.host,
-        :port => @uri.port,
-        :base => config[:base],
-        :auth => {
-          :method   => :simple,
-          :username => config[:username],
-          :password => config[:password]
-        }
+      uri           = URI.parse( config[:url] )
+      auth_config   = {
+        :method   =>:simple,
+        :username =>config[:username],
+        :password =>config[:password]
+      }
+      
+      configuration = {
+        :host=>uri.host,
+        :port=>uri.port,
+        :base=>config[:base],
+        :auth=>auth_config
       }
       
-      @configuration[:encryption] = { :method => :simple_tls } if( @uri.scheme.to_sym == :ldaps )
-      @connection                 = Net::LDAP.new( @configuration )
+      configuration[:encryption] = { :method => :simple_tls } if(uri.scheme == 'ldaps')
+      @connection                = Net::LDAP.new(configuration)
       
       self
-    rescue Exception => e
-      raise ArgumentError.new( e.message )
+    rescue StandardError=>e
+      raise ArgumentError.new(e.message)
     end
-    
-    
-    def search( filter, attributes, audit=false )
+     
+    def search(options)
+      
+      ldap_filter = ""
       
-      final_attributes = attributes ? attributes : []
-      final_attributes += OPERATIONAL_ATTRIBUTES if audit
-      final_filter     = Net::LDAP::Filter.construct( filter )
+      begin
+        ldap_filter = Net::LDAP::Filter.from_rfc2254(options[:filter])
+      rescue StandardError=>e
+        raise ArgumentError.new(e.message)
+      end
       
-      @connection.search( :filter=>Net::LDAP::Filter.from_rfc2254( filter ), 
-                          :attributes=>final_attributes, 
-                          :return_result=>true )
+      options[:attributes] += [:creatorsname, :createtimestamp, :modifiersname, :modifytimestamp] if options[:audit]
+      @connection.search( :filter=>ldap_filter, :attributes=>options[:attributes], :return_result=>true )
     end    
   end
 end

data/lib/ldap-shell-utils/options-parser.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'choice'
+
+Choice.options do
+  
+  header ''
+  header ' options:'
+
+  option :config, :required=>true do
+    short '-c'
+    long  '--config'
+    desc  'The LDAP config file'
+  end
+
+  option :filter, :required=>false do
+    short '-f'
+    long  '--filter'
+    desc  'LDAP query filter'
+    default "(objectClass=*)"
+  end
+
+  option :attributes, :required=>false do
+    short '-a'
+    long  '--attributes *ATTRIBUTES'
+    desc  'The attributes list'
+    default [:dn]
+  end
+
+  option :audit, :required=>false do
+    long  '--audit'
+    desc  'Audit attributes'
+    default false
+  end
+
+  separator ''
+  separator ' help:'
+  
+  option :help do
+    short '-h'
+    long  '--help'
+    desc  'Show this help screen'
+  end
+
+  separator ''
+end

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

@@ -2,8 +2,8 @@ module LdapShellUtils
   module Version
     INFO = {
       :major =>0,
-      :minor =>0,
-      :patch =>4
+      :minor =>1,
+      :patch =>0
     }
 
     NAME    = 'ldap-shell-utils'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldap-shell-utils
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,8 +12,8 @@ cert_chain: []
 date: 2011-06-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: slop
-  requirement: &2161265180 !ruby/object:Gem::Requirement
+  name: choice
+  requirement: &2156251920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161265180
+  version_requirements: *2156251920
 - !ruby/object:Gem::Dependency
   name: net-ldap
-  requirement: &2161238240 !ruby/object:Gem::Requirement
+  requirement: &2156251440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161238240
+  version_requirements: *2156251440
 - !ruby/object:Gem::Dependency
   name: config_context
-  requirement: &2161236000 !ruby/object:Gem::Requirement
+  requirement: &2156250960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161236000
+  version_requirements: *2156250960
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2161216640 !ruby/object:Gem::Requirement
+  requirement: &2156250480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2161216640
+  version_requirements: *2156250480
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2161215240 !ruby/object:Gem::Requirement
+  requirement: &2156250000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161215240
+  version_requirements: *2156250000
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2161213560 !ruby/object:Gem::Requirement
+  requirement: &2156249520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *2161213560
+  version_requirements: *2156249520
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2161212200 !ruby/object:Gem::Requirement
+  requirement: &2156249040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161212200
+  version_requirements: *2156249040
 - !ruby/object:Gem::Dependency
   name: net-ldap
-  requirement: &2161210580 !ruby/object:Gem::Requirement
+  requirement: &2156248560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161210580
+  version_requirements: *2156248560
 - !ruby/object:Gem::Dependency
   name: slop
-  requirement: &2161206140 !ruby/object:Gem::Requirement
+  requirement: &2156248080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161206140
+  version_requirements: *2156248080
 - !ruby/object:Gem::Dependency
   name: config_context
-  requirement: &2161204540 !ruby/object:Gem::Requirement
+  requirement: &2156247600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161204540
+  version_requirements: *2156247600
 description: This is a simple wrapper over ldapsearch util avoiding base64 dn and
   others gotchas
 email: javier.juarez@gmail.com
@@ -133,6 +133,7 @@ files:
 - lib/ldap-shell-utils.rb
 - lib/ldap-shell-utils/cli_application.rb
 - lib/ldap-shell-utils/ldap_connection.rb
+- lib/ldap-shell-utils/options-parser.rb
 - lib/ldap-shell-utils/version.rb
 - README.rdoc
 - bin/lsu
@@ -151,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3098725512291486326
+      hash: 2177724174337720231
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: