socialcast_ldap_integration 1.1.5

data/lib/socialcast/ldap_integration.rb

@@ -0,0 +1,157 @@
+require "net/ldap"
+
+module Socialcast
+  module LdapIntegration
+    
+    NULL_FILTER = ::Net::LDAP::Filter.pres("objectclass")
+  
+    def self.config
+      @@config
+    end
+    
+    def self.config=(config)
+      @@config = config
+    end
+    
+    def self.available?
+      return false unless self.config
+      return self.config['connections'].all? do |connection|
+        ['searcher_username', 'searcher_password', 'filter_string', 'base', 'host', 'port', 'ssl', 'map'].all? { |field| !connection[field].to_s.blank? } && self.required_fields.all? { |field| !connection['map'][field].blank? }
+      end
+    end
+  
+    def self.scheduled?
+      self.config['enableLdapSchedule']
+    end
+    
+    def self.mirror_lazily?
+      return true unless self.available? 
+      !self.config['lazy_mirroring']
+    end
+  
+    def self.schedule
+      config = Socialcast::LdapIntegration.config
+      cron_line = nil
+      if config['enableLdapSchedule']
+        case config['schedule']['checkFreq']
+        when 'Hourly'
+          cron_line = "0 */#{config['schedule']['hourInterval'].to_i} * * *"
+        when 'Daily'
+          cron_line = "0 #{config['schedule']['timeHour']} * * *"
+        when 'Weekly'
+          cron_line = "0 #{config['schedule']['timeHour']} * * #{config['schedule']['timeDay'].to_i + 1}"
+        end
+      end
+    
+      return cron_line
+    end
+    
+    # Connects to the Directory servers specified in the configuration. 
+    # 
+    # Supported Options:
+    # [:config] One or more LDAP connection specifications to connect to, overrides those in LdapIntegration.config
+    #
+    # Yields:
+    # - Connected and authenticated Net::LDAP object
+    # - Connection settings for the connection
+    def self.connect(options={})
+      raise ArgumentError.new("connect requires a block, see connect_to") unless block_given?
+      config = options[:config] ? [options[:config]] : Socialcast::LdapIntegration.config['connections']
+      config.each do |connection_options|
+        ldap = connect_to(connection_options)
+        yield(ldap, connection_options)
+      end
+      nil
+    end
+  
+    def self.connect_to(connection_options)
+      searcher_username = connection_options['searcher_username']
+      searcher_password = connection_options['searcher_password']
+      base = connection_options['base']
+      host = connection_options['host']
+      port = connection_options['port']
+      ssl = connection_options['ssl']
+    
+      ldap = Net::LDAP.new :host => host, :port => port, :base => base
+      ldap.auth searcher_username, searcher_password
+    
+      return ldap
+    end
+  
+    # Supported options
+    # [:filter] A string representing the search filter to use instead of the default search filter.  Overrides any :auxiliary_filter option.
+    # [:auxiliary_filter] A string representing a search filter to use in addition to the defualt search filter.  The two filters will be combined
+    #   using a logical AND.
+    # [:limit] A number representing the maxmimum number of records to return, defaults to unlimited.
+    def self.search(options={})
+      options.reverse_merge! :connect_options => {}
+      Socialcast::LdapIntegration.connect(options.delete(:connect_options) || {}) do |ldap, connection|
+        ldap_search_options = self.construct_filter_for_search(connection, options.delete(:filter), options.delete(:auxiliary_filter))
+        ldap_search_options[:size] = options[:limit] if options.has_key?(:limit)
+        ldap.search(ldap_search_options) do |entry|
+          yield(entry, connection) if block_given?
+        end
+      end
+    end
+  
+    # Supported options:
+    # [:identifying_field] the field which is being used to look up the user.  Should probably be 'company_login' or 'email'.
+    #   Defaults to 'company_login'
+    def self.authenticated?(identifier, password, options = {})
+      return false if password.blank?
+      identifying_field = options.reverse_merge!({:identifying_field => 'company_login'}).delete(:identifying_field)
+
+      Socialcast::LdapIntegration.connect do |ldap, connection|
+        connection_options = {}
+        connection_options.reverse_merge! options
+        base = connection['base']
+        host = connection['host']
+        port = connection['port']
+        map = connection['map']
+        connection_options.reverse_merge! :host => host, :port => port, :base => base, :filter => "#{map[identifying_field]}=#{identifier}", :password => password
+        return true if !ldap.bind_as(connection_options).blank?
+      end
+      return false
+    end    
+    
+    # Returns true if LDAP will manage the user field with the given name
+    def self.mirroring_field?(field)
+      string_field = field.to_s
+      self.available? && (["password", "email"].include?(string_field))
+    end
+    
+    
+    def self.fetch_account_info(identifier, options = {})
+      identifying_field = options.delete(:identifying_field) || 'company_login'
+      matched_account = nil
+    
+      self.connect do |ldap, connection|
+        map = connection['map']
+        ldap.search(self.construct_filter_for_search(connection, nil, "#{map[identifying_field]}=#{identifier}")) do |entry, connection|
+          matched_account = entry
+        end
+        if matched_account
+          mapped_account_info = HashWithIndifferentAccess.new
+          map.each_pair do |sc_field, ldap_field|
+            mapped_account_info[sc_field] = matched_account[ldap_field].first unless ldap_field.blank?
+          end
+          return mapped_account_info
+        end
+      end
+      nil
+    end
+  
+    protected
+    def self.construct_filter_for_search(connection, filter_options=nil, auxiliary_filter=nil)
+      unless filter_options
+        search_filter = connection['filter_string'].blank? ? NULL_FILTER : Net::LDAP::Filter.construct(connection['filter_string'])
+        search_filter = search_filter & Net::LDAP::Filter.construct(auxiliary_filter) if auxiliary_filter
+        return {:filter => search_filter}
+      end
+      {:filter => filter_options}
+    end
+    def self.required_fields
+      ['email', 'company_login']
+    end
+  end
+end

data/lib/socialcast/ldap_integration/version.rb

@@ -0,0 +1,5 @@
+module Socialcast
+  module LdapIntegration
+    VERSION = "1.1.5"
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: socialcast_ldap_integration
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 5
+  version: 1.1.5
+platform: ruby
+authors: 
+- Mitch Williams
+- Sean Cashin
+- Socialcast Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: scashin133-net-ldap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id001
+description: "BLAH. "
+email: 
+- mitch@socialcast.com
+- sean@socialcast.com
+- support@socialcast.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/socialcast/ldap_integration/version.rb
+- lib/socialcast/ldap_integration.rb
+has_rdoc: true
+homepage: http://github.com/socialcast/socialcast_ldap_integration
+licenses: []
+
+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: socialcast_ldap_integration
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Provides support for connecting to and traversing LDAP trees.
+test_files: []
+