socialcast 1.3.7 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 788cbe26a9ad449b6b0a366c6d264069586e4653
-  data.tar.gz: 1f21d4c2e36ed4ab2e8809ae8d0aea2d7e38b943
+  metadata.gz: 43487693be70d4bd0315db025f57e8a2c492fcc7
+  data.tar.gz: a527ada1136ef1d6e3f2fd80ae8fb4e69cd493e7
 SHA512:
-  metadata.gz: 90c71da04a539297455463f1b7f81f9b3737c957dd5882acc9539ed52a19f2f43315fcede8e96e38a6b8ce818c91d655d26134e87995715b1444b647e326c777
-  data.tar.gz: 7a254b2b4132c6144a58a2d026e8aede0cae18c7a39c4f63c1f680e324578ddd2789c7f099f5cd5308297a56efa60ddfbe50e526d5189449b71afcc8b25a3f98
+  metadata.gz: 3f23a5a4c44d39c83c2a8b1b41868ecf7c25938141129b55993cd619e832ae44d835bfa022fb2700a5d68b595108a204c26ae3b4745855fc169453ed73684975
+  data.tar.gz: f9703ae386594ee84cac91e11625d2d0589a5697c8ab103b433b3ef1af37826ee7f5b00a915378de274eb77c06afc5b52b8d6bbc6835875cca6d0369f0d470a9

data/lib/socialcast.rb

@@ -2,8 +2,10 @@ require 'yaml'
 require 'fileutils'
 
 require_relative 'socialcast/command_line/ldap_connector'
-require_relative 'socialcast/command_line/provision'
+require_relative 'socialcast/command_line/provisioner'
 require_relative 'socialcast/command_line/authenticate'
+require_relative 'socialcast/command_line/provision_user'
+require_relative 'socialcast/command_line/provision_photo'
 require_relative 'socialcast/command_line/message'
 require_relative 'socialcast/command_line/cli'
 require_relative 'socialcast/command_line/version'

data/lib/socialcast/command_line/cli.rb

@@ -118,7 +118,7 @@ module Socialcast
 
       desc 'provision', 'provision users from ldap compatible user repository'
       method_option :config, :default => 'ldap.yml', :aliases => '-c', :desc => 'Path to ldap config file'
-      method_option :output, :default => Socialcast::CommandLine::Provision::DEFAULT_OUTPUT_FILE, :aliases => '-o', :desc => 'Name of the output file'
+      method_option :output, :default => Socialcast::CommandLine::ProvisionUser::DEFAULT_OUTPUT_FILE, :aliases => '-o', :desc => 'Name of the output file'
       method_option :setup, :type => :boolean, :desc => 'Create an example ldap config file and exit'
       method_option :delete_users_file, :type => :boolean, :desc => 'Delete the output file'
       method_option :test, :type => :boolean, :desc => 'Do not persist changes'
@@ -130,18 +130,19 @@ module Socialcast
         config = ldap_config options
         load_plugins options
 
-        Socialcast::CommandLine::Provision.new(config, options).provision
+        Socialcast::CommandLine::ProvisionUser.new(config, options).provision
 
-      rescue Socialcast::CommandLine::Provision::ProvisionError => e
+      rescue Socialcast::CommandLine::ProvisionUser::ProvisionError => e
         Kernel.abort e.message
       end
 
       desc 'sync_photos', 'Upload default avatar photos from LDAP repository'
       method_option :config, :default => 'ldap.yml', :aliases => '-c'
+      method_option :force_sync, :default => false, :aliases => '-f', :desc => 'Pushes all photos from LDAP to socialcast'
       def sync_photos
         config = ldap_config options
 
-        Socialcast::CommandLine::Provision.new(config).sync_photos
+        Socialcast::CommandLine::ProvisionPhoto.new(config, options).sync
       end
 
       no_tasks do

data/lib/socialcast/command_line/provision_photo.rb

@@ -0,0 +1,79 @@
+require 'digest/md5'
+
+module Socialcast
+  module CommandLine
+    class ProvisionPhoto
+      include Socialcast::CommandLine::Provisioner
+      def sync
+        each_ldap_connector do |connector|
+
+          connector.attribute_mappings.fetch('profile_photo')
+
+          each_ldap_entry do |entry|
+            attr_mappings = connector.attribute_mappings
+            email = connector.grab(entry, attr_mappings['email'])
+
+            ## GET USER INFO
+            search_users_resource = Socialcast::CommandLine.resource_for_path '/api/users/search', http_config
+            user_search_response = search_users_resource.get(:params => { :q => email, :per_page => 1 }, :accept => :json)
+            user_info = JSON.parse(user_search_response)['users'].first
+
+            is_community_default = user_info && user_info['avatars'] && user_info['avatars']['is_community_default']
+            return unless is_community_default || @options[:force_sync]
+
+            ## PHOTO URL TO BINARY
+            if profile_photo_data = connector.grab(entry, attr_mappings['profile_photo'])
+              if profile_photo_data.start_with?('http')
+                begin
+                  profile_photo_data = RestClient.get(profile_photo_data)
+                rescue => e
+                  puts "Unable to download photo #{profile_photo_data} for #{email}"
+                  puts e.response
+                  next
+                end
+              end
+
+              ## FORCE ENCODING
+              profile_photo_data = profile_photo_data.force_encoding('binary')
+
+              ## CONTENT TYPE
+              unless content_type = binary_to_content_type(profile_photo_data)
+                puts "Skipping photo for #{email}: unknown image format (supports .gif, .png, .jpg)"
+                next
+              end
+
+              ## WRITE TEMP FILE
+              tempfile = Tempfile.new(["photo_upload", ".#{content_type}"])
+              tempfile.write(profile_photo_data)
+              tempfile.rewind
+
+              puts "Uploading photo for #{email}"
+
+              ## SUBMIT PHOTO
+              begin
+                user_resource = Socialcast::CommandLine.resource_for_path "/api/users/#{user_info['id']}", http_config
+                user_resource.put({ :user => { :profile_photo => { :data => tempfile } } })
+              ensure
+                tempfile.unlink
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def binary_to_content_type(binary_photo_data)
+        case binary_photo_data
+        when Regexp.new("^GIF8", nil, 'n')
+          'gif'
+        when Regexp.new('^\x89PNG', nil, 'n')
+          'png'
+        when Regexp.new("^\xff\xd8\xff\xe0\x00\x10JFIF", nil, 'n'), Regexp.new("^\xff\xd8\xff\xe1(.*){2}Exif", nil, 'n')
+          'jpg'
+        end
+      end
+
+    end
+  end
+end

data/lib/socialcast/command_line/provision_user.rb

@@ -0,0 +1,66 @@
+require 'zlib'
+require 'builder'
+require 'set'
+require 'fileutils'
+
+module Socialcast
+  module CommandLine
+    class ProvisionUser
+      include Socialcast::CommandLine::Provisioner
+
+      def each_user_hash
+        each_ldap_connector do |connector|
+          connector.each_user_hash do |user_hash|
+            yield user_hash
+          end
+        end
+      end
+
+      def fetch_user_hash(identifier, options = {})
+        each_ldap_connector do |connector|
+          user_hash = connector.fetch_user_hash(identifier, options)
+          return user_hash if user_hash
+        end
+        nil
+      end
+
+      def provision
+        user_whitelist = Set.new
+        output_file = File.join Dir.pwd, @options[:output]
+        params = http_config.merge(:external_system => !!@options[:external_system])
+
+        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|
+              each_user_hash do |user_hash|
+                users << user_hash.to_xml(:skip_instruct => true, :root => 'user')
+                user_whitelist << [user_hash['contact_info']['email'], user_hash['unique_identifier'], user_hash['employee_number']]
+              end
+            end # users
+          end # export
+        end # gzip
+
+        if user_whitelist.empty? && !@options[:force]
+          raise ProvisionError.new "Skipping upload to Socialcast since no users were found"
+        else
+          puts "Uploading dataset to Socialcast..."
+          resource = Socialcast::CommandLine.resource_for_path '/api/users/provision', params
+          begin
+            File.open(output_file, 'r') do |file|
+              request_params = {:file => file}
+              request_params[:skip_emails] = 'true' if (@ldap_config['options']["skip_emails"] || @options[:skip_emails])
+              request_params[:test] = 'true' if (@ldap_config['options']["test"] || @options[:test])
+              resource.post request_params, :accept => :json
+            end
+          rescue RestClient::Unauthorized => e
+            raise ProvisionError.new "Authenticated user either does not have administration privileges or the community is not configured to allow provisioning. Please contact Socialcast support to if you need help." if e.http_code == 401
+          end
+          puts "Finished"
+        end
+        File.delete(output_file) if (@ldap_config['options']['delete_users_file'] || @options[:delete_users_file])
+      end
+    end
+  end
+end

data/lib/socialcast/command_line/provisioner.rb

@@ -0,0 +1,51 @@
+module Socialcast
+  module CommandLine
+    module Provisioner
+      class ProvisionError < StandardError; end
+
+      DEFAULT_OUTPUT_FILE = 'users.xml.gz'
+
+      def initialize(ldap_config, options = {})
+        @ldap_config = ldap_config.dup
+        @options = options.dup
+
+        @options[:output] ||= DEFAULT_OUTPUT_FILE
+      end
+
+      private
+
+      def http_config
+        @http_config ||= @ldap_config.fetch 'http', {}
+      end
+
+      def ldap_connector(connection_name)
+        @connectors ||= {}
+
+        unless @connectors[connection_name]
+          @connectors[connection_name] = Socialcast::CommandLine::LDAPConnector.new(connection_name, @ldap_config)
+        end
+
+        @connectors[connection_name]
+      end
+
+      def each_ldap_connector
+        @ldap_config['connections'].keys.each do |connection_name|
+          yield ldap_connector(connection_name)
+        end
+      end
+
+      def each_ldap_entry(&block)
+        count = 0
+
+        each_ldap_connector do |connector|
+          connector.each_ldap_entry do |entry|
+            yield entry, connector.connection_name
+            count += 1
+            puts "Scanned #{count} users" if ((count % 100) == 0)
+          end
+        end
+        puts "Finished scanning #{count} users"
+      end
+    end
+  end
+end

data/lib/socialcast/command_line/version.rb

@@ -1,5 +1,5 @@
 module Socialcast
   module CommandLine
-    VERSION = "1.3.7"
+    VERSION = "1.3.8"
   end
 end

data/spec/socialcast/command_line/authenticate_spec.rb

@@ -3,13 +3,14 @@ require 'spec_helper'
 describe Socialcast::CommandLine::Authenticate do
   let(:options) { { :domain => "test.socialcast.local" } }
   let(:params) { {  } }
-  subject { Socialcast::CommandLine::Authenticate.new(authenticate_type, options, params) }
+  subject(:authenticate) { Socialcast::CommandLine::Authenticate.new(authenticate_type, options, params) }
 
   describe '#request' do
     before do
       RestClient::Resource.should_receive(:new).with(url, {}).and_call_original
       RestClient::Resource.any_instance.should_receive(:post).with(subject.params, :accept => :json)
-      subject.request
+      authenticate.should_receive(:set_default_credentials).and_return(true)
+      authenticate.request
     end
     context 'for a regular user' do
       let(:authenticate_type) { :user }

data/spec/socialcast/command_line/cli_spec.rb

@@ -162,7 +162,7 @@ describe Socialcast::CommandLine::CLI do
             {
               'id' => 7,
               'avatars' => {
-                'is_system_default' => system_default_photo
+                'is_community_default' => system_default_photo
               }
             }
           ]
@@ -199,7 +199,7 @@ describe Socialcast::CommandLine::CLI do
             {
               'id' => 7,
               'avatars' => {
-                'is_system_default' => system_default_photo
+                'is_community_default' => system_default_photo
               }
             }
           ]
@@ -232,7 +232,7 @@ describe Socialcast::CommandLine::CLI do
             {
               'id' => 7,
               'avatars' => {
-                'is_system_default' => system_default_photo
+                'is_community_default' => system_default_photo
               }
             }
           ]
@@ -299,7 +299,7 @@ describe Socialcast::CommandLine::CLI do
         rest_client_resource = double(:rest_client_resource)
         rest_client_resource.stub(:post).and_raise(RestClient::Unauthorized.new(double('Unauthorized HTTP Response', :code => '401', :body => 'Unauthorized HTTP Response')))
         Socialcast::CommandLine.stub(:resource_for_path).and_return(rest_client_resource)
-        Kernel.should_receive(:abort).with("Authenticated user either does not have administration privileges or the community is not configured to allow provisioning. Please contact Socialcast support to if you need help.\nResponse from server: Unauthorized HTTP Response").once
+        Kernel.should_receive(:abort).with("Authenticated user either does not have administration privileges or the community is not configured to allow provisioning. Please contact Socialcast support to if you need help.").once
 
         Socialcast::CommandLine::CLI.start ['provision', '-f']
       end

data/spec/socialcast/command_line/provision_photo_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Socialcast::CommandLine::ProvisionPhoto do
+  let(:ldap_with_profile_photo) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_profile_photo.yml')) }
+
+  context '#sync' do
+    let(:options) { {} }
+    subject(:sync_photos) { Socialcast::CommandLine::ProvisionPhoto.new(ldap_with_profile_photo, options).sync }
+    let(:user_search_resource) { double(:user_search_resource) }
+    let(:user_submit_resource) { double(:user_submit_resource) }
+    let(:is_community_default) { true }
+    let(:data_fingerprint) { '5d41402abc4b2a76b9719d911017c592' }
+    let(:search_api_response) do
+      {
+        'users' => [
+          {
+            'id' => 7,
+            'avatars' => {
+              'is_community_default' => is_community_default,
+              'data_fingerprint' => data_fingerprint
+            }
+          }
+        ]
+      }
+    end
+    before do
+      entry = create_entry :mail => 'user@example.com', :givenName => 'first name', :sn => 'last name', :jpegPhoto => photo_data
+      Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', 'jpegPhoto', 'memberof'])).and_yield(entry)
+      Socialcast::CommandLine.stub(:resource_for_path).with('/api/users/search', anything).and_return(user_search_resource)
+    end
+
+    context 'for when it does successfully post the photo' do
+      before do
+        user_search_resource.should_receive(:get).and_return(search_api_response.to_json)
+        user_resource = double(:user_resource)
+        user_resource.should_receive(:put) do |data|
+          uploaded_data = data[:user][:profile_photo][:data]
+          uploaded_data.path.should =~ /\.png\Z/
+        end
+        Socialcast::CommandLine.stub(:resource_for_path).with('/api/users/7', anything).and_return(user_resource)
+      end
+      context 'for a binary file' do
+        let(:photo_data) { "\x89PNGabc" }
+        before do
+          RestClient.should_not_receive(:get)
+          sync_photos
+        end
+        it 'uses the original binary to upload the photo' do end
+      end
+      context 'for an image file' do
+        let(:photo_data) { "http://socialcast.com/someimage.png" }
+        before do
+          RestClient.should_receive(:get).with(photo_data).and_return("\x89PNGabc")
+          sync_photos
+        end
+        it 'downloads the image form the web to upload the photo' do end
+      end
+    end
+
+    context 'for when it does not successfully post the photo' do
+      context 'for an image file' do
+        let(:photo_data) { "http://socialcast.com/someimage.png" }
+        before do
+          user_search_resource.should_receive(:get).and_return(search_api_response.to_json)
+          RestClient.should_receive(:get).with(photo_data).and_raise(RestClient::ResourceNotFound)
+          sync_photos
+        end
+        it 'tries to download the image from the web and rescues 404' do end
+      end
+    end
+
+    context 'when their is already a photo set' do
+      let(:is_community_default) { false }
+      let(:photo_data) { "\x89PNGabc" }
+      before { user_search_resource.should_receive(:get).and_return(search_api_response.to_json) }
+      context 'for a regular sync' do
+        before do
+          sync_photos
+          Socialcast::CommandLine.should_not_receive(:resource_for_path)
+        end
+        it 'does not post the new photo' do end
+      end
+      context 'when they do a force sync' do
+        let(:options) { { :force_sync => true } }
+        before do
+          Socialcast::CommandLine.should_receive(:resource_for_path).with('/api/users/7', {}).and_return(user_submit_resource)
+          user_submit_resource.should_receive(:put).and_return(true)
+          sync_photos
+        end
+        it 'submits the photo anyways' do end
+      end
+    end
+  end
+
+
+  context '.binary_to_content_type' do
+    subject { Socialcast::CommandLine::ProvisionPhoto.new(ldap_with_profile_photo, {}).send(:binary_to_content_type, binary_photo_data) }
+    let(:file_dir) { File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'test_images') }
+    let(:binary_photo_data) { File.open(File.join(file_dir, image_name), 'rb') { |file| file.read } }
+    context 'with a jpg' do
+      let(:image_name) { 'test-jpg-image.jpg' }
+      it { should == 'jpg' }
+    end
+    context 'with a gif' do
+      let(:image_name) { 'test-gif-image.gif' }
+      it { should == 'gif' }
+    end
+    context 'with a png' do
+      let(:image_name) { 'test-png-image.png' }
+      it { should == 'png' }
+    end
+    context 'with a tiff' do
+      let(:image_name) { 'test-tiff-image.tiff' }
+      it { should be_nil }
+    end
+  end
+end

data/spec/socialcast/command_line/{provision_spec.rb → provision_user_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Socialcast::CommandLine::Provision do
+describe Socialcast::CommandLine::ProvisionUser do
   let!(:credentials) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'credentials.yml')) }
   let!(:ldap_default_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap.yml')) }
   let!(:ldap_blank_basedn_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_blank_basedn.yml')) }
@@ -13,17 +13,8 @@ describe Socialcast::CommandLine::Provision do
   let!(:ldap_with_manager_attribute_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_manager_attribute.yml')) }
   let!(:ldap_with_roles_without_account_type_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_roles_without_account_type.yml')) }
   let!(:ldap_with_unique_identifier_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_unique_identifier.yml')) }
-  let!(:ldap_with_profile_photo) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_profile_photo.yml')) }
   let!(:ldap_without_account_type_or_roles_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_without_account_type_or_roles.yml')) }
 
-  def create_entry(entry_attributes)
-    Net::LDAP::Entry.new("dc=example,dc=com").tap do |e|
-      entry_attributes.each_pair do |attr, value|
-        e[attr] = value
-      end
-    end
-  end
-
   describe "#provision" do
     let(:result) { '' }
 
@@ -39,7 +30,7 @@ describe Socialcast::CommandLine::Provision do
         Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', 'isMemberOf'])).and_yield(entry)
         RestClient::Resource.any_instance.should_receive(:post).once.with(hash_including(:file => result), { :accept => :json })
 
-        Socialcast::CommandLine::Provision.new(ldap_default_config, {}).provision
+        Socialcast::CommandLine::ProvisionUser.new(ldap_default_config, {}).provision
       end
       it "puts the user in the output file" do
         result.should =~ /user@example.com/
@@ -51,7 +42,7 @@ describe Socialcast::CommandLine::Provision do
         Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'uid', 'isMemberOf'])).and_yield(entry)
         RestClient::Resource.any_instance.should_receive(:post).once.with(hash_including(:file => result), { :accept => :json })
 
-        Socialcast::CommandLine::Provision.new(ldap_with_unique_identifier_config, {}).provision
+        Socialcast::CommandLine::ProvisionUser.new(ldap_with_unique_identifier_config, {}).provision
       end
       it "puts the user in the output file" do
         result.should =~ /userID/
@@ -65,8 +56,8 @@ describe Socialcast::CommandLine::Provision do
       end
       it "does not put the user in the output file" do
         expect do
-          Socialcast::CommandLine::Provision.new(ldap_default_config, {}).provision
-        end.to raise_error(Socialcast::CommandLine::Provision::ProvisionError, "Skipping upload to Socialcast since no users were found")
+          Socialcast::CommandLine::ProvisionUser.new(ldap_default_config, {}).provision
+        end.to raise_error(Socialcast::CommandLine::ProvisionUser::ProvisionError, "Skipping upload to Socialcast since no users were found")
       end
     end
     context "attribute mappings" do
@@ -99,7 +90,7 @@ describe Socialcast::CommandLine::Provision do
           entry = create_entry :mail => 'user@example.com', :givenName => 'first name', :sn => 'last name'
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', 'isMemberOf'])).and_yield(entry)
 
-          Socialcast::CommandLine::Provision.new(ldap_default_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_default_config, {}).provision
         end
         let(:expected_attribute_xml) do
           %Q[<first-name>first name</first-name>
@@ -114,7 +105,7 @@ describe Socialcast::CommandLine::Provision do
 
       context "with mappings at the connection level" do
         before do
-          provision_instance = Socialcast::CommandLine::Provision.new(ldap_multiple_connection_mapping_config, {})
+          provision_instance = Socialcast::CommandLine::ProvisionUser.new(ldap_multiple_connection_mapping_config, {})
 
           ldap_instance1 = double(Net::LDAP, :encryption => nil, :auth => nil)
           Net::LDAP.should_receive(:new).once.ordered.and_return(ldap_instance1)
@@ -148,7 +139,7 @@ describe Socialcast::CommandLine::Provision do
           entry = create_entry :mail => 'user@example.com', :custom_ldap1 => 'custom value 1', :custom_ldap2 => 'custom value 2'
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['custom_ldap1', 'custom_ldap2', 'mail', 'isMemberOf'])).and_yield(entry)
 
-          Socialcast::CommandLine::Provision.new(ldap_with_custom_attributes_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_with_custom_attributes_config, {}).provision
         end
         let(:expected_attribute_xml) do
           %Q[<contact-info>
@@ -172,7 +163,7 @@ describe Socialcast::CommandLine::Provision do
 
       context "with manager" do
         before do
-          provision_instance = Socialcast::CommandLine::Provision.new(ldap_with_manager_attribute_config, {})
+          provision_instance = Socialcast::CommandLine::ProvisionUser.new(ldap_with_manager_attribute_config, {})
 
           ldap_instance = double(Net::LDAP, :encryption => nil, :auth => nil)
           Net::LDAP.should_receive(:new).once.and_return(ldap_instance)
@@ -205,7 +196,7 @@ describe Socialcast::CommandLine::Provision do
           entry = create_entry :test_ldap_attribute_mapping => 'user@example.com'
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['test_ldap_attribute_mapping', 'isMemberOf'])).and_yield(entry)
 
-          Socialcast::CommandLine::Provision.new(ldap_with_class_ldap_attribute_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_with_class_ldap_attribute_config, {}).provision
         end
         after do
           Object.send(:remove_const, :TestLdapAttributeMapping)
@@ -255,7 +246,7 @@ describe Socialcast::CommandLine::Provision do
         let(:ldap_groups) { ["cn=External,dc=example,dc=com", "cn=SbiAdmins,dc=example,dc=com", "cn=TownHallAdmins,dc=example,dc=com"] }
         before do
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', ldap_group_attribute])).and_yield(entry)
-          Socialcast::CommandLine::Provision.new(ldap_default_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_default_config, {}).provision
         end
         let(:expected_permission_xml) do
           %Q[<account-type>external</account-type>]
@@ -267,7 +258,7 @@ describe Socialcast::CommandLine::Provision do
         let(:ldap_groups) { ["cn=SbiAdmins,dc=example,dc=com", "cn=TownHallAdmins,dc=example,dc=com"] }
         before do
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', ldap_group_attribute])).and_yield(entry)
-          Socialcast::CommandLine::Provision.new(ldap_default_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_default_config, {}).provision
         end
         let(:expected_permission_xml) do
           %Q[<account-type>member</account-type>
@@ -283,7 +274,7 @@ describe Socialcast::CommandLine::Provision do
         let(:ldap_groups) { ["cn=SbiAdmins,dc=example,dc=com", "cn=TownHallAdmins,dc=example,dc=com"] }
         before do
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', ldap_group_attribute])).and_yield(entry)
-          Socialcast::CommandLine::Provision.new(ldap_with_account_type_without_roles_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_with_account_type_without_roles_config, {}).provision
         end
         let(:expected_permission_xml) do
           %Q[<account-type>member</account-type>]
@@ -295,7 +286,7 @@ describe Socialcast::CommandLine::Provision do
         let(:ldap_groups) { ["cn=SbiAdmins,dc=example,dc=com", "cn=TownHallAdmins,dc=example,dc=com"] }
         before do
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', ldap_group_attribute])).and_yield(entry)
-          Socialcast::CommandLine::Provision.new(ldap_with_roles_without_account_type_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_with_roles_without_account_type_config, {}).provision
         end
         let(:expected_permission_xml) do
           %Q[<account-type>member</account-type>
@@ -311,7 +302,7 @@ describe Socialcast::CommandLine::Provision do
         let(:ldap_groups) { ["cn=SbiAdmins,dc=example,dc=com", "cn=TownHallAdmins,dc=example,dc=com"] }
         before do
           Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', ldap_group_attribute])).and_yield(entry)
-          Socialcast::CommandLine::Provision.new(ldap_without_account_type_or_roles_config, {}).provision
+          Socialcast::CommandLine::ProvisionUser.new(ldap_without_account_type_or_roles_config, {}).provision
         end
         let(:expected_permission_xml) do
           %Q[<account-type>member</account-type>]
@@ -323,7 +314,7 @@ describe Socialcast::CommandLine::Provision do
         let(:ldap_group_attribute) { 'memberOf' }
         let(:ldap_groups) {  }
         before do
-          provision_instance = Socialcast::CommandLine::Provision.new(ldap_multiple_connection_permission_mapping_config, {})
+          provision_instance = Socialcast::CommandLine::ProvisionUser.new(ldap_multiple_connection_permission_mapping_config, {})
 
           ldap_instance1 = double(Net::LDAP, :encryption => nil, :auth => nil)
           Net::LDAP.should_receive(:new).once.ordered.and_return(ldap_instance1)
@@ -355,7 +346,7 @@ describe Socialcast::CommandLine::Provision do
       before do
         RestClient::Resource.any_instance.should_receive(:post).once.with(hash_including(:file => result), { :accept => :json })
 
-        provision_instance = Socialcast::CommandLine::Provision.new(ldap_blank_basedn_config, {})
+        provision_instance = Socialcast::CommandLine::ProvisionUser.new(ldap_blank_basedn_config, {})
 
         root_entry = create_entry(:namingcontexts => ['dc=foo,dc=com', 'dc=bar,dc=com'])
         ldap_instance = double(Net::LDAP, :encryption => nil, :auth => nil)
@@ -375,7 +366,7 @@ describe Socialcast::CommandLine::Provision do
   end
 
   describe "#each_user_hash" do
-    let(:provision_instance) { Socialcast::CommandLine::Provision.new(ldap_default_config) }
+    let(:provision_instance) { Socialcast::CommandLine::ProvisionUser.new(ldap_default_config) }
     before do
       entry = create_entry :mail => 'user@example.com', :givenName => 'first name', :sn => 'last name'
       Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', 'isMemberOf'])).and_yield(entry)
@@ -398,7 +389,7 @@ describe Socialcast::CommandLine::Provision do
 
   describe "#fetch_user_hash" do
     context "when the first connector returns the entry" do
-      let(:provision_instance) { Socialcast::CommandLine::Provision.new(ldap_multiple_connection_mapping_config, {}) }
+      let(:provision_instance) { Socialcast::CommandLine::ProvisionUser.new(ldap_multiple_connection_mapping_config, {}) }
       let(:entry) { create_entry :mailCon => 'user@example.com' }
       before do
         filter = Net::LDAP::Filter.construct('(&(mail=*)(mailCon=user@example.com))')
@@ -418,7 +409,7 @@ describe Socialcast::CommandLine::Provision do
       end
     end
     context "when another connector returns the entry" do
-      let(:provision_instance) { Socialcast::CommandLine::Provision.new(ldap_multiple_connection_mapping_config, {}) }
+      let(:provision_instance) { Socialcast::CommandLine::ProvisionUser.new(ldap_multiple_connection_mapping_config, {}) }
       let(:entry) { create_entry :mailCon2 => 'user@example.com', :firstName => 'first name' }
       before do
         ldap_instance1 = double(Net::LDAP, :auth => nil)
@@ -448,7 +439,7 @@ describe Socialcast::CommandLine::Provision do
       end
     end
     context "when no connectors return the entry" do
-      let(:provision_instance) { Socialcast::CommandLine::Provision.new(ldap_multiple_connection_mapping_config, {}) }
+      let(:provision_instance) { Socialcast::CommandLine::ProvisionUser.new(ldap_multiple_connection_mapping_config, {}) }
       before do
         ldap_instance1 = double(Net::LDAP, :auth => nil)
         Net::LDAP.should_receive(:new).once.ordered.and_return(ldap_instance1)
@@ -467,71 +458,4 @@ describe Socialcast::CommandLine::Provision do
       end
     end
   end
-
-  describe '#sync_photos' do
-    let(:user_search_resource) { double(:user_search_resource) }
-    let(:search_api_response) do
-      {
-        'users' => [
-          {
-            'id' => 7,
-            'avatars' => {
-              'is_system_default' => true
-            }
-          }
-        ]
-      }
-    end
-    before do
-      entry = create_entry :mail => 'user@example.com', :givenName => 'first name', :sn => 'last name', :jpegPhoto => photo_data
-      Net::LDAP.any_instance.should_receive(:search).once.with(hash_including(:attributes => ['givenName', 'sn', 'mail', 'jpegPhoto', 'memberof'])).and_yield(entry)
-
-      Socialcast::CommandLine.stub(:resource_for_path).with('/api/users/search', anything).and_return(user_search_resource)
-    end
-    let(:sync_photos) { Socialcast::CommandLine::Provision.new(ldap_with_profile_photo, {}).sync_photos }
-
-    context 'for when it does successfully post the photo' do
-      before do
-        user_search_resource.should_receive(:get).and_return(search_api_response.to_json)
-        user_resource = double(:user_resource)
-        user_resource.should_receive(:put) do |data|
-          uploaded_data = data[:user][:profile_photo][:data]
-          uploaded_data.path.should =~ /\.png\Z/
-        end
-        Socialcast::CommandLine.stub(:resource_for_path).with('/api/users/7', anything).and_return(user_resource)
-      end
-      context 'for a binary file' do
-        let(:photo_data) { "\x89PNGabc" }
-        before do
-          RestClient.should_not_receive(:get)
-          sync_photos
-        end
-        it 'uses the original binary to upload the photo' do end
-      end
-      context 'for an image file' do
-        let(:photo_data) { "http://socialcast.com/someimage.png" }
-        context 'when it successfully downloads' do
-          before do
-            RestClient.should_receive(:get).with(photo_data).and_return("\x89PNGabc")
-            sync_photos
-          end
-          it 'downloads the image form the web to upload the photo' do end
-        end
-      end
-    end
-
-    context 'for when it does not successfully post the photo' do
-      context 'for an image file' do
-        let(:photo_data) { "http://socialcast.com/someimage.png" }
-        before do
-          user_search_resource.should_not_receive(:get)
-          RestClient.should_receive(:get).with(photo_data).and_raise(RestClient::ResourceNotFound)
-          sync_photos
-        end
-        it 'tries to download the image from the web and rescues 404' do end
-      end
-    end
-
-  end
-
 end

data/spec/spec_helper.rb

@@ -10,6 +10,11 @@ require_relative '../lib/socialcast'
 RSpec.configure do |config|
   config.mock_with :rspec
 
+  config.before do
+    stubbed_credentials = File.join(File.dirname(__FILE__), '..', 'fixtures')
+    Socialcast::CommandLine.stub(:config_dir).and_return(stubbed_credentials)
+  end
+
   def capture_with_status(stream)
     exit_status = 0
     begin
@@ -27,6 +32,14 @@ RSpec.configure do |config|
     return result, exit_status
   end
 
+  def create_entry(entry_attributes)
+    Net::LDAP::Entry.new("dc=example,dc=com").tap do |e|
+      entry_attributes.each_pair do |attr, value|
+        e[attr] = value
+      end
+    end
+  end
+
   def remove_directories(*names)
     project_dir = Pathname.new(Dir.pwd)
     names.each do |name|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socialcast
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.3.8
 platform: ruby
 authors:
 - Ryan Sonnek
@@ -221,7 +221,9 @@ files:
 - lib/socialcast/command_line/cli.rb
 - lib/socialcast/command_line/ldap_connector.rb
 - lib/socialcast/command_line/message.rb
-- lib/socialcast/command_line/provision.rb
+- lib/socialcast/command_line/provision_photo.rb
+- lib/socialcast/command_line/provision_user.rb
+- lib/socialcast/command_line/provisioner.rb
 - lib/socialcast/command_line/version.rb
 - socialcast.gemspec
 - spec/fixtures/credentials.yml
@@ -245,10 +247,15 @@ files:
 - spec/fixtures/ldap_with_unique_identifier.yml
 - spec/fixtures/ldap_without_account_type_or_roles.yml
 - spec/fixtures/ldap_without_permission_mappings.yml
+- spec/fixtures/test_images/test-gif-image.gif
+- spec/fixtures/test_images/test-jpg-image.jpg
+- spec/fixtures/test_images/test-png-image.png
+- spec/fixtures/test_images/test-tiff-image.tiff
 - spec/socialcast/command_line/authenticate_spec.rb
 - spec/socialcast/command_line/cli_spec.rb
 - spec/socialcast/command_line/ldap_connector_spec.rb
-- spec/socialcast/command_line/provision_spec.rb
+- spec/socialcast/command_line/provision_photo_spec.rb
+- spec/socialcast/command_line/provision_user_spec.rb
 - spec/socialcast/socialcast_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/socialcast/socialcast-command-line
@@ -297,9 +304,14 @@ test_files:
 - spec/fixtures/ldap_with_unique_identifier.yml
 - spec/fixtures/ldap_without_account_type_or_roles.yml
 - spec/fixtures/ldap_without_permission_mappings.yml
+- spec/fixtures/test_images/test-gif-image.gif
+- spec/fixtures/test_images/test-jpg-image.jpg
+- spec/fixtures/test_images/test-png-image.png
+- spec/fixtures/test_images/test-tiff-image.tiff
 - spec/socialcast/command_line/authenticate_spec.rb
 - spec/socialcast/command_line/cli_spec.rb
 - spec/socialcast/command_line/ldap_connector_spec.rb
-- spec/socialcast/command_line/provision_spec.rb
+- spec/socialcast/command_line/provision_photo_spec.rb
+- spec/socialcast/command_line/provision_user_spec.rb
 - spec/socialcast/socialcast_spec.rb
 - spec/spec_helper.rb

data/lib/socialcast/command_line/provision.rb

@@ -1,166 +0,0 @@
-require 'zlib'
-require 'builder'
-require 'set'
-require 'fileutils'
-
-module Socialcast
-  module CommandLine
-    class Provision
-      DEFAULT_OUTPUT_FILE = 'users.xml.gz'
-
-      class ProvisionError < StandardError; end
-
-      def initialize(ldap_config, options = {})
-        @ldap_config = ldap_config.dup
-        @options = options.dup
-
-        @options[:output] ||= DEFAULT_OUTPUT_FILE
-      end
-
-      def each_user_hash
-        each_ldap_connector do |connector|
-          connector.each_user_hash do |user_hash|
-            yield user_hash
-          end
-        end
-      end
-
-      def fetch_user_hash(identifier, options = {})
-        each_ldap_connector do |connector|
-          user_hash = connector.fetch_user_hash(identifier, options)
-          return user_hash if user_hash
-        end
-        nil
-      end
-
-      def provision
-        params = @ldap_config.fetch('http', {}).merge(:external_system => !!@options[:external_system])
-
-        user_whitelist = Set.new
-        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|
-              each_user_hash do |user_hash|
-                users << user_hash.to_xml(:skip_instruct => true, :root => 'user')
-                user_whitelist << [user_hash['contact_info']['email'], user_hash['unique_identifier'], user_hash['employee_number']]
-              end
-            end # users
-          end # export
-        end # gzip
-
-        if user_whitelist.empty? && !@options[:force]
-          raise ProvisionError.new "Skipping upload to Socialcast since no users were found"
-        else
-          puts "Uploading dataset to Socialcast..."
-          resource = Socialcast::CommandLine.resource_for_path '/api/users/provision', params
-          begin
-            File.open(output_file, 'r') do |file|
-              request_params = {:file => file}
-              request_params[:skip_emails] = 'true' if (@ldap_config['options']["skip_emails"] || @options[:skip_emails])
-              request_params[:test] = 'true' if (@ldap_config['options']["test"] || @options[:test])
-              resource.post request_params, :accept => :json
-            end
-          rescue RestClient::Unauthorized => e
-            error_message = @options[:external_system] ? "External Provisioning System was not found." : "Authenticated user either does not have administration privileges or the community is not configured to allow provisioning."
-            contact_message = "Please contact Socialcast support to if you need help."
-            raise ProvisionError.new "#{error_message} #{contact_message}\nResponse from server: #{e.response.body}" if e.http_code == 401
-          end
-          puts "Finished"
-        end
-        File.delete(output_file) if (@ldap_config['options']['delete_users_file'] || @options[:delete_users_file])
-      end
-
-      def sync_photos
-        http_config = @ldap_config.fetch 'http', {}
-
-        each_ldap_connector do |connector|
-          connector.attribute_mappings.fetch('profile_photo')
-        end
-
-        search_users_resource = Socialcast::CommandLine.resource_for_path '/api/users/search', http_config
-
-        each_ldap_connector do |connector|
-          each_ldap_entry do |entry|
-            attr_mappings = connector.attribute_mappings
-            email = connector.grab(entry, attr_mappings['email'])
-            if profile_photo_data = connector.grab(entry, attr_mappings['profile_photo'])
-              if profile_photo_data.start_with?('http')
-                begin
-                  profile_photo_data = RestClient.get(profile_photo_data)
-                rescue => e
-                  puts "Unable to download photo #{profile_photo_data} for #{email}"
-                  puts e.response
-                  next
-                end
-              end
-              profile_photo_data = profile_photo_data.force_encoding('binary')
-
-              user_search_response = search_users_resource.get(:params => { :q => email, :per_page => 1 }, :accept => :json)
-              user_info = JSON.parse(user_search_response)['users'].first
-              if user_info && user_info['avatars'] && user_info['avatars']['is_system_default']
-                puts "Uploading photo for #{email}"
-
-                user_resource = Socialcast::CommandLine.resource_for_path "/api/users/#{user_info['id']}", http_config
-                content_type = case profile_photo_data
-                when Regexp.new("\AGIF8", nil, 'n')
-                  'gif'
-                when Regexp.new('\A\x89PNG', nil, 'n')
-                  'png'
-                when Regexp.new("\A\xff\xd8\xff\xe0\x00\x10JFIF", nil, 'n'), Regexp.new("\A\xff\xd8\xff\xe1(.*){2}Exif", nil, 'n')
-                  'jpg'
-                else
-                  puts "Skipping photo for #{email}: unknown image format (supports .gif, .png, .jpg)"
-                  next
-                end
-
-                tempfile = Tempfile.new(["photo_upload", ".#{content_type}"])
-                tempfile.write(profile_photo_data)
-                tempfile.rewind
-                begin
-                  user_resource.put({ :user => { :profile_photo => { :data => tempfile } } })
-                ensure
-                  tempfile.unlink
-                end
-              end
-            end
-          end
-        end
-      end
-
-      private
-
-      def ldap_connector(connection_name)
-        @connectors ||= {}
-
-        unless @connectors[connection_name]
-          @connectors[connection_name] = Socialcast::CommandLine::LDAPConnector.new(connection_name, @ldap_config)
-        end
-
-        @connectors[connection_name]
-      end
-
-      def each_ldap_connector
-        @ldap_config['connections'].keys.each do |connection_name|
-          yield ldap_connector(connection_name)
-        end
-      end
-
-      def each_ldap_entry(&block)
-        count = 0
-
-        each_ldap_connector do |connector|
-          connector.each_ldap_entry do |entry|
-            yield entry, connector.connection_name
-            count += 1
-            puts "Scanned #{count} users" if ((count % 100) == 0)
-          end
-        end
-        puts "Finished scanning #{count} users"
-      end
-    end
-  end
-end