socialcast 1.0.0.beta1 → 1.0.0.beta3

data/config/ldap.yml

@@ -0,0 +1,44 @@
+--- 
+# LDAP connection information
+connections:
+  example_connection_1:
+    username: "cn=Directory Manager"
+    password: "password"
+    host: ldap.yourdomain.com
+    port: 389
+    basedn: "ou=smallpeople,ou=qa,dc=socialcast,dc=com"
+    filter: "(mail=*)"
+  example_connection_2:
+    username: "cn=Directory Manager"
+    password: "password"
+    host: ldap.yourdomain.com
+    port: 389
+    basedn: "ou=tinypeople,ou=qa,dc=yourdomain,dc=com"
+    filter: "(mail=*)"
+  example_encrypted_connection:
+    username: "cn=Directory Manager"
+    password: "password"
+    host: ldap.yourdomain.com
+    port: 389
+    basedn: "ou=largepeople,ou=qa,dc=yourdomain,dc=com"
+    filter: "(mail=*)"
+    encryption: simple_tls
+
+# LDAP attribute mappings
+mappings: 
+  first_name: givenName
+  last_name: sn
+  email: mail
+  #only use employee_number if the email is unknown
+  #employee_number: emp_id
+  #only use unique_identifier if you do not wish to use email as the main user identification method
+  #unique_identifier: samaccountname
+
+delete_users_file: false
+# test being true implies that you wish to skip_emails
+test: true
+skip_emails: true
+
+# (optional) http_proxy setting
+# only needed if the script must connect to Socialcast through a proxy
+# http_proxy: "http://username:password@proxy.company.com:3128"

data/lib/socialcast.rb

@@ -20,4 +20,7 @@ module Socialcast
     raise 'Unknown Socialcast credentials.  Run `socialcast authenticate` to initialize' unless File.exist?(credentials_file)
     YAML.load_file(credentials_file)
   end
+  def grab_value(entry)
+    entry.is_a?(Array) ? entry.first : entry
+  end
 end

data/lib/socialcast/cli.rb

@@ -5,11 +5,14 @@ require 'highline'
 require 'socialcast'
 require 'socialcast/message'
 
+require 'zlib'
+require 'builder'
+require 'net/ldap'
+
 module Socialcast
   class CLI < Thor
     include Thor::Actions
     include Socialcast
-    default_task :share
 
     desc "authenticate", "Authenticate using your Socialcast credentials"
     method_option :user, :type => :string, :aliases => '-u', :desc => 'email address for the authenticated user'
@@ -63,5 +66,95 @@ module Socialcast
 
       say "Message has been shared"
     end
+
+    desc 'provision', 'provision users from ldap compatible user repository'
+    method_option :setup, :default => false
+    method_option :config, :default => 'ldap.yml', :aliases => '-c'
+    method_option :output, :default => 'users.xml.gz', :aliases => '-o'
+    method_option :delete_users_file, :default => true
+    def provision
+      config_file = File.join Dir.pwd, options[:config]
+
+      if options[:setup]
+        create_file config_file do
+          File.read File.join(File.dirname(__FILE__), '..', '..', 'config', 'ldap.yml')
+        end
+        return
+      end
+
+      config = YAML.load_file config_file
+      required_mappings = %w{email first_name last_name}
+      required_mappings.each do |field|
+        unless config["mappings"].has_key? field
+          fail "Missing required mapping: #{field}"
+        end
+      end
+
+      output_file = File.join Dir.pwd, options[:output]
+      Zlib::GzipWriter.open(output_file) do |gz|
+        xml = Builder::XmlMarkup.new(:target => gz, :indent => 1)
+        xml.instruct!
+        xml.export do |export|
+          export.users(:type => "array") do |users|
+            config["connections"].each_pair do |key, connection|
+              say "Connecting to #{key} at #{[connection["host"], connection["port"]].join(':')} with filter #{connection["basedn"]}"
+
+              ldap = Net::LDAP.new :host => connection["host"], :port => connection["port"], :base => connection["basedn"]
+              ldap.encryption connection['encryption'].to_sym if connection['encryption']
+              ldap.auth connection["username"], connection["password"]
+              say "Connected"
+              say "Searching..." 
+              count = 0
+              ldap.search(:return_result => false, :filter => connection["filter"], :base => connection["basedn"]) do |entry|
+                next if grab_value(entry[config["mappings"]["email"]]).blank? || (config["mappings"].has_key?("unique_identifier") && grab_value(entry[config["mappings"]["unique_identifier"]]).blank?)
+                users.user do |user|
+                  primary_attributes = %w{unique_identifier first_name last_name employee_number}
+                  primary_attributes.each do |attribute|
+                    next unless config['mappings'].has_key?(attribute)
+                    user.tag! attribute, grab_value(entry[config["mappings"][attribute]])
+                  end
+                  contact_attributes = %w{email location cell_phone office_phone}
+                  user.tag! 'contact-info' do |contact_info|
+                   contact_attributes.each do |attribute|
+                      next unless config['mappings'].has_key?(attribute)
+                      contact_info.tag! attribute, grab_value(entry[config["mappings"][attribute]])
+                    end
+                  end
+                  custom_attributes = config['mappings'].keys - (primary_attributes + contact_attributes)
+                  user.tag! 'custom-fields', :type => "array" do |custom_fields|
+                    custom_attributes.each do |attribute|
+                      custom_fields.tag! 'custom-field' do |custom_field|
+                        custom_field.id(attribute)
+                        custom_field.value(grab_value(entry[config["mappings"][attribute]]))
+                      end
+                    end
+                  end
+                end # user
+                count += 1
+                say "Scanned #{count} users..." if ((count % 100) == 0)
+              end # search
+            end # connections
+          end # users
+        end # export
+      end # gzip
+
+      say "Finished Scanning" 
+      say "Sending to Socialcast" 
+
+      RestClient.log = Logger.new(STDOUT)
+      RestClient.proxy = config["http_proxy"] if config["http_proxy"]
+      url = ['https://', credentials[:domain], '/api/users/provision'].join
+      private_resource = RestClient::Resource.new url, :user => credentials[:username], :password => credentials[:password], :timeout => 660
+      File.open(output_file, 'r') do |file|
+        request_params = {:file => file}
+        request_params[:skip_emails] = "true" if config["skip_emails"]
+        request_params[:test] = "true" if config["test"]
+        private_resource.post request_params
+      end
+
+      File.delete(output_file) if options[:delete_users_file]
+
+      say "Finished"
+    end
   end
 end

data/lib/socialcast/version.rb

@@ -1,3 +1,3 @@
 module Socialcast
-  VERSION = "1.0.0.beta1"
+  VERSION = "1.0.0.beta3"
 end

data/socialcast.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '>= 1.4.6'
   s.add_runtime_dependency 'thor', '>= 0.14.6'
   s.add_runtime_dependency 'highline', '>= 1.6.2'
+  s.add_runtime_dependency 'scashin133-net-ldap', '>= 0.1.4'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: socialcast
 version: !ruby/object:Gem::Version 
-  hash: 62196353
+  hash: 62196357
   prerelease: 6
   segments: 
   - 1
   - 0
   - 0
   - beta
-  - 1
-  version: 1.0.0.beta1
+  - 3
+  version: 1.0.0.beta3
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-22 00:00:00 Z
+date: 2011-06-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
@@ -98,6 +98,22 @@ dependencies:
         version: 1.6.2
   type: :runtime
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: scashin133-net-ldap
+  prerelease: false
+  requirement: &id006 !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: *id006
 description: publish messages to your stream from a command line interface
 email: 
 - ryan@socialcast.com
@@ -116,6 +132,7 @@ files:
 - README.md
 - Rakefile
 - bin/socialcast
+- config/ldap.yml
 - lib/socialcast.rb
 - lib/socialcast/cli.rb
 - lib/socialcast/message.rb