lita-ldap 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3167e6fec632522988a1c129cc05aa2939e47ee3
-  data.tar.gz: 3fbf2d94042554e7eaa663c3513fc8ef8f01fb0a
+  metadata.gz: dd7f06cd70351f1cb694ef2c370a21871be3d116
+  data.tar.gz: c8bbe175bd45feff62ec4538e5d53afc13fd6729
 SHA512:
-  metadata.gz: f08e28135ac41a108d49a642b33b9626c4a9719f7348c2d71e483f046262c317265735e0d04f01f9d10b79f9376b5268366f0397d2c20d307fd4021ea47b422b
-  data.tar.gz: d3a45ddb8ff0d6a46ffa6b8c55224d4c5b0e1d34b4e62de2b89efad9762f452b34d41bb4e9a7460df60c4f5ecdd3559fb9911b843bd0b7a4b51787d3437d863c
+  metadata.gz: 9fe2c4a6547e01d8f91688b9c8b67e38bc10c6e8d1d6e94538b71f29eb0311c70a506beb4b4ab3ec3456ff84698e947ef1ce6985c6e03bd4de41aa0b66ff21c1
+  data.tar.gz: 82b6043191d6158b0ea203cab51595195e6cecda36a9a47f3d1d330e74be8811f36e00275836ac451b03defe918bd881537786f17406e29bf85bac9b89bd911b

data/README.md

@@ -29,3 +29,5 @@ end
 
 * lita search user nexus
 * lita search group nx-admin
+* lita search with filter 'cn=gerrit'
+* lita show dn 'cn=gerrit,ou=people,dc=ldap,dc=example,dc=com'

data/lib/ldaphelper/misc.rb

@@ -17,5 +17,51 @@ module LitaLDAPHelper
         raise "Cannot connect to ldap server"
       end
     end
-  end
-end
+
+    def valid_filter?(filter_str)
+      begin
+        filter=Net::LDAP::Filter.construct(filter_str)
+        true
+      rescue Exception => e
+        false
+      end
+    end
+
+    def search_with_filter(filter_str)
+      tree_base = "#{config.base_dn}"
+      puts "search base_dn : #{tree_base}"
+      filter=Net::LDAP::Filter.construct(filter_str)
+      return_attributes = config.default_attributes || '*'
+      return_attributes = return_attributes.split(',')
+      entries = client.search(:base => tree_base, :filter => filter, :attributes =>return_attributes , :return_result => true)
+      results = []
+      unless entries.nil?
+        entries.each do |entry|
+          results << entry.to_ldif
+          results << '*********'
+        end
+      end
+      #puts results
+      results
+    end
+
+    def get_entry_by_dn(dn)
+      dn_spec = dn.split(':',2)
+      dn_str = dn_spec[0]
+      if dn_spec.length>1
+        dn_str = dn_spec[1]
+      end
+      dn_str = dn_str.strip
+      entries = client.search(:base => dn_str, :filter => nil, :attributes =>['*'] , :return_result => true)
+      results = []
+      unless entries.nil?
+        entries.each do |entry|
+          results << entry.to_ldif
+          results << '*********'
+        end
+      end
+      #puts results
+      results
+    end
+  end#module misc
+end#module LitaLDAPHelper

data/lib/lita/handlers/ldap.rb

@@ -55,6 +55,36 @@ module Lita
        }
       )
 
+      #https://dzone.com/articles/matching-quoted-strings-ruby
+      #matching quoted string
+      route(
+        /^ldap\s+check\s+filter\s+(["'])([^\1]+)(\1)$/,
+        :cmd_check_filter,
+        command: true,
+        help: {
+          t('help.cmd_check_filter_key') => t('help.cmd_check_filter_value')
+        }
+      )
+
+      route(
+        /^ldap\s+search\s+with\s+filter\s+(["'])([^\1]+)(\1)$/,
+        :cmd_search_with_filter,
+        command: true,
+        help: {
+          t('help.cmd_search_with_filter_key') => t('help.cmd_search_with_filter_value')
+        }
+      )
+
+      route(
+        /^ldap\s+show\s+dn\s+(["'])([^\1]+)(\1)$/,
+        :cmd_search_with_dn,
+        command: true,
+        help: {
+          t('help.cmd_search_with_dn_key') => t('help.cmd_search_with_dn_value')
+        }
+      )
+
+
       def cmd_search_user(response)
         search_string = response.matches[0][0]
         #logger.info "searching user with #{search_string}"
@@ -69,6 +99,46 @@ module Lita
         response.reply results
       end
 
+      def cmd_check_filter(response)
+        filter_string = response.matches[0][1]
+        #puts "filter_string: #{filter_string}"
+        if ! filter_string.nil? && filter_string.strip.length>0
+          is_valid = valid_filter?(filter_string)
+          if is_valid
+            response.reply "Filter is valid"
+          else
+            response.reply "Filter in not valid"
+          end
+        else
+          response.reply "Filter string is empty"
+        end
+      end
+
+      def cmd_search_with_filter(response)
+        filter_string = response.matches[0][1]
+        if ! filter_string.nil? && filter_string.strip.length>0
+          is_valid = valid_filter?(filter_string)
+          if is_valid
+            results = search_with_filter(filter_string)
+            response.reply results
+          else
+            response.reply "Filter in not valid"
+          end
+        else
+          response.reply "Filter string is empty"
+        end
+      end
+
+      def cmd_search_with_dn(response)
+        dn = response.matches[0][1]
+        if ! dn.nil? && dn.strip.length>0
+          results = get_entry_by_dn(dn)
+          response.reply results
+        else
+          response.reply "Invalid dn"
+        end
+      end
+
       Lita.register_handler(self)
     end #class
   end # module

data/lita-ldap.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-ldap"
-  spec.version       = "0.1.0"
+  spec.version       = "0.1.1"
   spec.authors       = ["Wang, Dawei"]
   spec.email         = ["daweiwang.gatekeeper@gmail.com"]
   spec.description   = "Lita LDAP operations like search user and group."

data/locales/en.yml

@@ -6,3 +6,9 @@ en:
         cmd_search_user_value: 'Search user with search string'
         cmd_search_group_key: 'ldap search user SEARCH_STRING'
         cmd_search_group_value: 'Search user with search string'
+        cmd_check_filter_key: 'ldap check filter "FILTER_STRING"'
+        cmd_check_filter_value: 'Check ldap filter syntax'
+        cmd_search_with_filter_key: 'ldap search with filter "FILTER_STRING"'
+        cmd_search_with_filter_value: 'Search entry with filter "FILTER_STRING"'
+        cmd_search_with_dn_key: 'ldap show dn "DN_STRING"'
+        cmd_search_with_dn_value: 'Show entry with dn "DN_STRING"'

data/spec/lita/handlers/ldap_spec.rb

@@ -55,6 +55,8 @@ describe Lita::Handlers::Ldap, lita_handler: true do
   it do
     is_expected.to route_command('ldap search user nexus').to(:cmd_search_user)
     is_expected.to route_command('ldap search group nx-admin').to(:cmd_search_group)
+    is_expected.to route_command('ldap check filter "cn=admin"').to(:cmd_check_filter)
+    is_expected.to route_command('ldap search with filter "cn=nexus"').to(:cmd_search_with_filter)
   end
 
   describe '#search user' do
@@ -70,4 +72,26 @@ describe Lita::Handlers::Ldap, lita_handler: true do
       puts replies
     end
   end
+
+  describe '#check filter' do
+    it 'validate filter syntax' do
+      send_command("ldap check filter '(|(objectclass=user)(objectclass=person)(objectclass=inetOrgPerson)(objectclass=organizationalPerson))'")
+      puts replies
+    end
+  end
+
+  describe '#search with filter' do
+    it 'search with filter' do
+      send_command("ldap search with filter 'cn=gerrit'")
+      puts replies
+    end
+  end
+
+  describe '#show dn' do
+    it 'show entry with specified dn' do
+      send_command("ldap show dn 'dn: cn=nx-admin,ou=groups,dc=ldap,dc=example,dc=com'")
+      puts "ldap show dn"
+      puts replies
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-ldap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Wang, Dawei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack