socialcast 1.1.5 → 1.1.6

data/lib/socialcast/cli.rb

@@ -11,6 +11,7 @@ require File.join(File.dirname(__FILE__), 'net_ldap_ext')
 require 'zlib'
 require 'logger'
 require 'builder'
+require 'set'
 require 'net/ldap'
 
 # uncomment to debug HTTP traffic
@@ -97,6 +98,7 @@ module Socialcast
     method_option :test, :type => :boolean
     method_option :skip_emails, :type => :boolean
     method_option :force, :type => :boolean, :aliases => '-f', :default => false
+    method_option :sanity_check, :type => :boolean, :default => false
     def provision
       config_file = File.expand_path options[:config]
 
@@ -106,11 +108,12 @@ module Socialcast
         end
         return
       end
-      
+
       fail "Unable to load configuration file: #{config_file}" unless File.exists?(config_file)
       say "Using configuration file: #{config_file}"
-      
+
       config = load_configuration config_file
+      http_config = config.fetch('http', {})
 
       required_mappings = %w{email first_name last_name}
       mappings = config.fetch 'mappings', {}
@@ -125,6 +128,8 @@ module Socialcast
       attributes = mappings.values
       attributes << membership_attribute
 
+      user_identifier_list = %w{email unique_identifier employee_number}
+      user_whitelist = Set.new
 			count = 0
       output_file = File.join Dir.pwd, options[:output]
       Zlib::GzipWriter.open(output_file) do |gz|
@@ -132,20 +137,14 @@ module Socialcast
         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(':')}"
-
-              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 "Searching base DN: #{connection["basedn"]} with filter: #{connection["filter"]}"
-
+            ldap_connections(config) do |key, connection, ldap|
               ldap.search(:return_result => false, :filter => connection["filter"], :base => connection["basedn"], :attributes => attributes) do |entry|
                 next if entry.grab(mappings["email"]).blank? || (mappings.has_key?("unique_identifier") && entry.grab(mappings["unique_identifier"]).blank?)
 
                 users.user do |user|
                   entry.build_xml_from_mappings user, ldap, mappings, permission_mappings
                 end
+                user_whitelist << user_identifier_list.map { |identifier| entry.grab(mappings[identifier]) }
                 count += 1
                 say "Scanned #{count} users" if ((count % 100) == 0)
               end # search
@@ -155,11 +154,27 @@ module Socialcast
       end # gzip
       say "Finished scanning #{count} users"
 
+      if options[:sanity_check]
+        say "Sanity checking users currently marked as needing to be terminated"
+        ldap_connections(config) do |key, connection, ldap|
+          (current_socialcast_users(http_config) - user_whitelist).each do |user_identifiers|
+            combined_filters = []
+            user_identifier_list.each_with_index do |identifier, index|
+              combined_filters << ((mappings[identifier].blank? || user_identifiers[index].nil?) ? nil : Net::LDAP::Filter.eq(mappings[identifier], user_identifiers[index]))
+            end
+            combined_filters.compact!
+            filter = ((combined_filters.size > 1) ? '(|%s)' : '%s') % combined_filters.join(' ')
+            filter = Net::LDAP::Filter.construct(filter) & Net::LDAP::Filter.construct(connection["filter"])
+            ldap_result = ldap.search(:return_result => true, :base => connection["basedn"], :filter => filter, :attributes => attributes)
+            abort("Found user marked for termination that should not be terminated: #{user_identifiers}") unless ldap_result.blank?
+          end
+        end
+      end
+
       if count == 0 && !options[:force]
         Kernel.abort("Skipping upload to Socialcast since no users were found")
       else
         say "Uploading dataset to Socialcast..."
-        http_config = config.fetch('http', {})
         resource = Socialcast.resource_for_path '/api/users/provision', http_config
         File.open(output_file, 'r') do |file|
           request_params = {:file => file}
@@ -171,12 +186,47 @@ module Socialcast
       end
       File.delete(output_file) if (config['options']['delete_users_file'] || options[:delete_users_file])
     end
-  
+
     no_tasks do
       def load_configuration(path)
         YAML.load_file path
       end
+      def ldap_connections(config)
+        config["connections"].each_pair do |key, connection|
+          say "Connecting to #{key} at #{[connection["host"], connection["port"]].join(':')}"
+          ldap = create_ldap_instance(connection)
+          say "Searching base DN: #{connection["basedn"]} with filter: #{connection["filter"]}"
+          yield key, connection, ldap
+        end
+      end
+      def create_ldap_instance(connection)
+        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"]
+        ldap
+      end
+      def current_socialcast_users(http_config)
+        current_socialcast_list = Set.new
+        request_params = {:per_page => 500, :format => 'json'}
+        request_params[:page] = 1
+        resource = create_socialcast_user_index_request(http_config, request_params)
+        while true
+          response = resource.get
+          result = JSON.parse(response)
+          users = result["users"]
+          break if users.blank?
+          request_params[:page] += 1
+          resource = create_socialcast_user_index_request(http_config, request_params)
+          users.each do |user|
+            current_socialcast_list << [user['contact_info']['email'], user['company_login'], user['employee_number']]
+          end
+        end
+        current_socialcast_list
+      end
+      def create_socialcast_user_index_request(http_config, request_params)
+        path_template = "/api/users.json?format=%{format}&per_page=%{per_page}&page=%{page}"
+        Socialcast.resource_for_path((path_template % request_params), http_config)
+      end
     end
-    
   end
 end

data/lib/socialcast/net_ldap_ext.rb

@@ -9,7 +9,7 @@ class Net::LDAP::Entry
     when Hash
       value = attribute.delete("value")
       value % Hash[attribute.map {|k,v| [k, grab(v)]}].symbolize_keys
-    else
+    when String
       Array.wrap(self[attribute]).compact.first
     end
   end

data/lib/socialcast/version.rb

@@ -1,3 +1,3 @@
 module Socialcast
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

data/socialcast.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'highline', '>= 1.6.2'
   s.add_runtime_dependency 'socialcast-net-ldap', '>= 0.1.6'
   s.add_runtime_dependency 'activeresource', '>= 2.3.11'
-  s.add_development_dependency "rspec", '>= 2.6.0'
+  s.add_development_dependency "rspec", '>= 2.11.0'
   s.add_development_dependency "webmock", '>= 1.7.7'
   s.add_development_dependency 'rake', '0.9.2.2'
 

data/spec/cli_spec.rb

@@ -10,14 +10,14 @@ describe Socialcast::CLI do
                  with(:body => /message\_type\"\:null/).
                  with(:body => /testing/).
                  to_return(:status => 200, :body => "", :headers => {})
-        
+
         Socialcast::CLI.start ['share', 'testing']
       end
       it 'should send a POST with a message body of "testing" and nil message-type' do
         # See expectations
       end
     end
-    
+
     context 'with a message_type message' do
       before do
         Socialcast.stub(:credentials).and_return(YAML.load_file(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
@@ -25,7 +25,7 @@ describe Socialcast::CLI do
                  with(:body => /message\_type\"\:review\_request/).
                  with(:body => /please\sreview/).
                  to_return(:status => 200, :body => "", :headers => {})
-        
+
         Socialcast::CLI.start ['share', 'please review', '--message_type=review_request']
       end
       it 'should send a POST with a message body of "please review" and message_type of "review_request"' do
@@ -38,7 +38,7 @@ describe Socialcast::CLI do
         stub_request(:post, "https://ryan%40socialcast.com:foo@test.staging.socialcast.com/api/messages.json").
                  with(:body => /group\_id\"\:123/).
                  to_return(:status => 200, :body => "", :headers => {})
-        
+
         Socialcast::CLI.start ['share', 'hi', '--group_id=123']
       end
       it 'should send a POST with group_id param == 123' do
@@ -52,16 +52,16 @@ describe Socialcast::CLI do
                  with(:body => /message\_type\"\:null/).
                  with(:body => /testing/).
                  to_return(:status => 200, :body => "", :headers => {})
-        
+
         Socialcast::CLI.start ['share', 'testing']
       end
       it 'should send a POST with a message body of "testing" and nil message-type' do
         # See expectations
       end
     end
-    
+
   end
-  
+
   describe '#provision' do
     before do
       Socialcast::CLI.instance_eval do # to supress warning from stubbing load_configuration
@@ -144,6 +144,37 @@ describe Socialcast::CLI do
         @result.should_not =~ %r{roles}
       end
     end
+    context "with a user marked for termination that shouldn't be and sanity_check option passed" do
+      before do
+        @entry = Net::LDAP::Entry.new("cn=Ryan,dc=example,dc=com")
+        @entry[:mail] = 'ryan@example.com'
+        @valid_entry = Net::LDAP::Entry.new("cn=Sean,dc=example,dc=com")
+        @valid_entry[:mail] = 'sean@example.com'
+        ldap_search_block = double("ldapsearchblock")
+        ldap_search_block.should_receive(:search).and_yield(@entry)
+        ldap_return = double("ldapreturn")
+        ldap_return.should_receive(:search).with(include(:filter=>Net::LDAP::Filter.construct("(&(mail=sean@example.com)(mail=*))"))).and_return(@valid_entry)
+
+        Socialcast::CLI.any_instance.should_receive(:create_ldap_instance).and_return(ldap_search_block, ldap_return)
+
+        @result = ''
+        Zlib::GzipWriter.stub(:open).and_yield(@result)
+        Socialcast.stub(:credentials).and_return(YAML.load_file(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+        Socialcast::CLI.any_instance.should_receive(:load_configuration).with(/ldap.yml/).and_return(YAML.load_file(File.join(File.dirname(__FILE__), 'fixtures', 'ldap.yml')))
+        File.stub(:open).with(/users.xml.gz/, anything).and_yield(@result)
+
+        Socialcast::CLI.any_instance.should_receive(:create_socialcast_user_index_request).and_return(
+          double("request1", :get => {"users" => [{"contact_info" => {"email" => @entry[:mail][0]}}]}.to_json),
+          double("request2", :get => {"users" => [{"contact_info" => {"email" => @valid_entry[:mail][0]}}]}.to_json),
+          double("empty_request", :get => {"users" => []}.to_json)
+        )
+
+        RestClient::Resource.any_instance.should_receive(:post).never
+      end
+      it 'does not post to Socialcast and throws Kernel.abort' do
+        lambda { Socialcast::CLI.start ['provision', '-c', 'spec/fixtures/ldap.yml', '--sanity_check', true] }.should raise_error SystemExit
+      end
+    end
     context 'with external group member' do
       before do
         @entry = Net::LDAP::Entry.new("dc=example,dc=com")
@@ -294,10 +325,10 @@ describe Socialcast::CLI do
       @entry[:mail] = 'ryan@example.com'
       @entry[:manager] = 'cn=bossman,dc=example,dc=com'
       @manager_email = 'bossman@example.com'
-      
+
       @entry.stub(:dereference_mail).with(kind_of(Net::LDAP), "manager", "mail").and_return(@manager_email)
       Net::LDAP.any_instance.stub(:search).and_yield(@entry)
-      
+
       @result = ''
       Zlib::GzipWriter.stub(:open).and_yield(@result)
       Socialcast.stub(:credentials).and_return(YAML.load_file(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socialcast
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2156001940 !ruby/object:Gem::Requirement
+  requirement: &2159242000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156001940
+  version_requirements: *2159242000
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156001420 !ruby/object:Gem::Requirement
+  requirement: &2159241000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156001420
+  version_requirements: *2159241000
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2156000780 !ruby/object:Gem::Requirement
+  requirement: &2159240520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156000780
+  version_requirements: *2159240520
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &2156016340 !ruby/object:Gem::Requirement
+  requirement: &2159240060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 1.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *2156016340
+  version_requirements: *2159240060
 - !ruby/object:Gem::Dependency
   name: socialcast-net-ldap
-  requirement: &2156015780 !ruby/object:Gem::Requirement
+  requirement: &2159239420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 0.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156015780
+  version_requirements: *2159239420
 - !ruby/object:Gem::Dependency
   name: activeresource
-  requirement: &2156015320 !ruby/object:Gem::Requirement
+  requirement: &2159238740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,21 +77,21 @@ dependencies:
         version: 2.3.11
   type: :runtime
   prerelease: false
-  version_requirements: *2156015320
+  version_requirements: *2159238740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156014820 !ruby/object:Gem::Requirement
+  requirement: &2159238080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *2156014820
+  version_requirements: *2159238080
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2156014320 !ruby/object:Gem::Requirement
+  requirement: &2159237620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: 1.7.7
   type: :development
   prerelease: false
-  version_requirements: *2156014320
+  version_requirements: *2159237620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156013820 !ruby/object:Gem::Requirement
+  requirement: &2159237160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -110,7 +110,7 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *2156013820
+  version_requirements: *2159237160
 description: publish messages to your stream from a command line interface
 email:
 - ryan@socialcast.com