socialcast 1.3.13 → 1.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e47c7a2ae5e15e428bb10de22c9c82314e7b3cae
-  data.tar.gz: a9eb506a41820efa452980829fcc0f49f22ae24a
+  metadata.gz: 9de45230b2671da6dbe2c97752900207a128bb08
+  data.tar.gz: 2d24c42f2afbfba3c82cca8a3b592b7fe53f0cdc
 SHA512:
-  metadata.gz: 0199e8f8d5ef41ccbcda5c9f83a0dfedbb170f63718681f31431b8df98ab2a347e0818a1368898be5171adb77eed1ef46a421c7f359e6067856d9e7ee6496ed2
-  data.tar.gz: 2f8e999cc04e34c4bfb975f0579c044dba57e811a58351ca10aacb696a6daa73caa867ab7f311725eb808c2496a6c7c1ed37073dde8392ec087542fb81a14ae1
+  metadata.gz: c876a5f5b3e9865dfca6507d3b03e40cd0521af86418572dc0111f0f1037b3c4d75840dc490e793be901594a905cd65565be8abc026862fc29ada3e804215e63
+  data.tar.gz: ecfebccebe6e9180a68682d2dd52a7141960b0d05e3993e38c46a82f0bd67b9a4a94d7d4e34e2dfb5aa7f22e8c8000216d4d65aaff8de47f1082fcf9e09be3cf

data/lib/socialcast/command_line/provision_photo.rb

@@ -2,93 +2,83 @@ module Socialcast
   module CommandLine
     class ProvisionPhoto
       include Socialcast::CommandLine::Provisioner
-      attr_accessor :users
-      MAX_BATCH_SIZE = 50
 
-      def sync
-        @ldap_config['connections'].keys.each do |connection_name|
-          LDAPConnector.attribute_mappings_for(connection_name, @ldap_config).fetch(LDAPConnector::PROFILE_PHOTO_ATTRIBUTE)
-        end
+      attr_accessor :sync_strategy
 
-        init_users
+      def sync(strategy_klass = ApiSyncStrategy)
+        assert_ldap_connections_support_photo!
+        sync_strategy = strategy_klass.new(self)
+        process_options = {
+          :http_config => http_config,
+          :force_sync => @options[:force_sync]
+        }
 
-        each_ldap_connector do |connector|
-          connector.each_photo_hash do |photo_hash|
-            email = photo_hash[LDAPConnector::EMAIL_ATTRIBUTE]
-            users[email] = photo_hash[LDAPConnector::PROFILE_PHOTO_ATTRIBUTE]
-            handle_batch if users.size >= MAX_BATCH_SIZE
+        user_photos = {}
+
+        each_photo_hash do |photo_hash|
+          email = photo_hash[LDAPConnector::EMAIL_ATTRIBUTE]
+          user_photos[email] = photo_hash[LDAPConnector::PROFILE_PHOTO_ATTRIBUTE]
+          if user_photos.size >= sync_strategy.batch_size
+            sync_strategy.process(user_photos, process_options)
+            user_photos = {}
           end
         end
 
-        handle_batch if users.any?
+        sync_strategy.process(user_photos, process_options) if user_photos.any?
       end
 
-      private
+      def photo_data_to_file(profile_photo_data)
+        if profile_photo_data.start_with?('http')
+          profile_photo_data = download_photo_data(profile_photo_data)
+          return unless profile_photo_data
+        end
 
-      def init_users
-        @users = {}
-      end
+        ## FORCE ENCODING
+        profile_photo_data = profile_photo_data.force_encoding('binary')
 
-      def handle_batch
-        users.each_slice(MAX_BATCH_SIZE) do |user_batch|
-          search_users_resource = Socialcast::CommandLine.resource_for_path '/api/users/search', http_config
-          user_emails_query = user_batch.map { |u| "\"#{u[0]}\"" }.join(" OR ")
-          user_search_response = search_users_resource.get(:params => { :q => user_emails_query, :per_page => MAX_BATCH_SIZE }, :accept => :json)
-          JSON.parse(user_search_response)['users'].each do |user_hash|
-            sync_photo_for(user_hash)
-          end
+        ## CONTENT TYPE
+        unless content_type = binary_to_content_type(profile_photo_data)
+          log "Skipping photo: unknown image format (supports .gif, .png, .jpg)"
+          return
         end
 
-        init_users
+        ## WRITE TEMP FILE
+        Tempfile.new(["photo_upload", ".#{content_type}"]).tap do |tempfile|
+          tempfile.binmode
+          tempfile.write(profile_photo_data)
+          tempfile.rewind
+        end
       end
 
-      def sync_photo_for(user_hash)
-        is_system_default = user_hash && user_hash['avatars'] && user_hash['avatars']['is_system_default']
-        is_community_default = user_hash && user_hash['avatars'] && (user_hash['avatars']['id'] == default_profile_photo_id)
-        user_email = user_hash && user_hash['contact_info'] && user_hash['contact_info']['email']
-        return unless is_system_default || is_community_default || @options[:force_sync]
-
-        ## PHOTO URL TO BINARY
-        if profile_photo_data = users[user_email]
-          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 #{user_email}"
-              puts e.response
-              return
-            end
-          end
+      def default_profile_photo_id
+        @default_profile_photo_id ||= Socialcast::CommandLine::Authenticate.current_user['community']['default_profile_photo_id']
+      end
 
-          ## FORCE ENCODING
-          profile_photo_data = profile_photo_data.force_encoding('binary')
+      protected
 
-          ## CONTENT TYPE
-          unless content_type = binary_to_content_type(profile_photo_data)
-            puts "Skipping photo for #{user_email}: unknown image format (supports .gif, .png, .jpg)"
-            return
+      def each_photo_hash
+        each_ldap_connector do |connector|
+          connector.each_photo_hash do |photo_hash|
+            yield photo_hash
           end
+        end
+      end
 
-          ## WRITE TEMP FILE
-          tempfile = Tempfile.new(["photo_upload", ".#{content_type}"])
-          tempfile.binmode
-          tempfile.write(profile_photo_data)
-          tempfile.rewind
-
-          puts "Uploading photo for #{user_email}"
-
-          ## SUBMIT PHOTO
-          begin
-            user_resource = Socialcast::CommandLine.resource_for_path "/api/users/#{user_hash['id']}", http_config
-            user_resource.put({ :user => { :profile_photo => { :data => tempfile } } })
-          ensure
-            tempfile.unlink
+      def assert_ldap_connections_support_photo!
+        @ldap_config['connections'].each do |connection_name, _|
+          unless LDAPConnector.attribute_mappings_for(connection_name, @ldap_config).key? LDAPConnector::PROFILE_PHOTO_ATTRIBUTE
+            message = "Cannot sync photos: #{connection_name} does not have a mapping for the profile photo field."
+            log(message)
+            raise Socialcast::CommandLine::Provisioner::ProvisionError, message
           end
         end
       end
 
-      def default_profile_photo_id
-        @default_profile_photo_id ||= Socialcast::CommandLine::Authenticate.current_user['community']['default_profile_photo_id']
+      def download_photo_data(profile_photo_data)
+        RestClient.get(profile_photo_data)
+      rescue => e
+        log "Unable to download photo #{profile_photo_data}"
+        log e.response
       end
 
       def binary_to_content_type(binary_photo_data)
@@ -101,6 +91,64 @@ module Socialcast
           'jpg'
         end
       end
+
+      class ApiSyncStrategy
+        attr_reader :provisioner
+        attr_reader :http_config
+
+        MAX_BATCH_SIZE = 50
+
+        def initialize(provisioner, options = {})
+          @provisioner = provisioner
+        end
+
+        def process(user_photos, options = {})
+          @http_config = options[:http_config]
+          @force_sync = options[:force_sync]
+
+          search_users_resource = Socialcast::CommandLine.resource_for_path '/api/users/search', http_config
+          user_emails_query = user_photos.map { |email, _| "\"#{email}\"" }.join(" OR ")
+          user_search_response = search_users_resource.get(:params => { :q => user_emails_query, :per_page => batch_size }, :accept => :json)
+          JSON.parse(user_search_response)['users'].each do |user_hash|
+            email = user_hash['contact_info']['email']
+            sync_photo(user_hash, user_photos[email])
+          end
+        end
+
+        def batch_size
+          MAX_BATCH_SIZE
+        end
+
+        private
+
+        def sync_photo(user_hash, profile_photo_data)
+          is_system_default = user_hash && user_hash['avatars'] && user_hash['avatars']['is_system_default']
+          is_community_default = user_hash && user_hash['avatars'] && (user_hash['avatars']['id'] == provisioner.default_profile_photo_id)
+          user_email = user_hash && user_hash['contact_info'] && user_hash['contact_info']['email']
+          return unless is_system_default || is_community_default || force_sync?
+
+          log "Syncing photo for #{user_email}"
+
+          if profile_photo_data && file = provisioner.photo_data_to_file(profile_photo_data)
+            begin
+              log "Uploading photo for #{user_email}"
+              user_resource = Socialcast::CommandLine.resource_for_path "/api/users/#{user_hash['id']}", http_config
+              user_resource.put({ :user => { :profile_photo => { :data => file } } })
+            ensure
+              file.unlink
+            end
+          end
+        end
+
+        def force_sync?
+          !!@force_sync
+        end
+
+        def log(message)
+          provisioner.send(:log, message)
+        end
+      end
+
     end
   end
 end

data/lib/socialcast/command_line/provision_user.rb

@@ -45,7 +45,7 @@ module Socialcast
         if user_whitelist.empty? && !@options[:force]
           raise ProvisionError.new "Skipping upload to Socialcast since no users were found"
         else
-          puts "Uploading dataset to Socialcast..."
+          log "Uploading dataset to Socialcast..."
           resource = Socialcast::CommandLine.resource_for_path '/api/users/provision', params
           begin
             File.open(output_file, 'r') do |file|
@@ -58,7 +58,7 @@ module Socialcast
           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"
+          log "Finished"
         end
         File.delete(output_file) if (@ldap_config.fetch('options', {})['delete_users_file'] || @options[:delete_users_file])
       end

data/lib/socialcast/command_line/provisioner.rb

@@ -40,7 +40,11 @@ module Socialcast
             puts "Scanned #{count} users" if ((count % 100) == 0)
           end
         end
-        puts "Finished scanning #{count} users"
+        log "Finished scanning #{count} users"
+      end
+
+      def log(message)
+        $stdout.puts message
       end
     end
   end

data/lib/socialcast/command_line/version.rb

@@ -1,5 +1,5 @@
 module Socialcast
   module CommandLine
-    VERSION = "1.3.13"
+    VERSION = "1.3.14"
   end
 end

data/spec/socialcast/command_line/cli_spec.rb

@@ -168,7 +168,7 @@ describe Socialcast::CommandLine::CLI do
     context "with no profile_photo mapping" do
       let(:config_file) { ldap_default_config_file }
       it "reports an error" do
-        lambda { Socialcast::CommandLine::CLI.start ['sync_photos', '-c', config_file] }.should raise_error KeyError
+        lambda { Socialcast::CommandLine::CLI.start ['sync_photos', '-c', config_file] }.should raise_error Socialcast::CommandLine::Provisioner::ProvisionError
       end
     end
 
@@ -227,6 +227,9 @@ describe Socialcast::CommandLine::CLI do
               'id' => 7,
               'avatars' => {
                 'id' => default_profile_photo_id
+              },
+              'contact_info' => {
+                'email' => 'ryan@example.com'
               }
             }
           ]
@@ -259,6 +262,9 @@ describe Socialcast::CommandLine::CLI do
               'id' => 7,
               'avatars' => {
                 'id' => another_profile_photo_id
+              },
+              'contact_info' => {
+                'email' => 'ryan@example.com'
               }
             }
           ]

data/spec/socialcast/command_line/provision_photo_spec.rb

@@ -140,7 +140,7 @@ describe Socialcast::CommandLine::ProvisionPhoto do
       let(:sync_photos) { Socialcast::CommandLine::ProvisionPhoto.new(ldap_multiple_connection_mapping_config, {}).sync }
       let(:binary_photo_data) { "\x89PNGabc".force_encoding('binary') }
       before do
-        stub_const("Socialcast::CommandLine::ProvisionPhoto::MAX_BATCH_SIZE", 2)
+        Socialcast::CommandLine::ProvisionPhoto::ApiSyncStrategy.any_instance.stub(:batch_size).and_return(2)
 
         ldap_instance1 = double(Net::LDAP, :encryption => nil, :auth => nil)
         ldap_instance1.should_receive(:open).and_yield
@@ -156,7 +156,7 @@ describe Socialcast::CommandLine::ProvisionPhoto do
 
         Socialcast::CommandLine.stub(:resource_for_path).with('/api/users/search', anything).and_return(user_search_resource)
 
-        user_search_resource.should_receive(:get).once.with({:params=>{:q=>"\"user@example.com\" OR \"user2@example.com\"", :per_page=>Socialcast::CommandLine::ProvisionPhoto::MAX_BATCH_SIZE}, :accept=>:json}).and_return(search_api_response.to_json)
+        user_search_resource.should_receive(:get).once.with({:params => { :q => "\"user@example.com\" OR \"user2@example.com\"", :per_page => 2}, :accept => :json}).and_return(search_api_response.to_json)
 
         user_resource1 = double(:user_resource)
         user_resource1.should_receive(:put) do |data|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socialcast
 version: !ruby/object:Gem::Version
-  version: 1.3.13
+  version: 1.3.14
 platform: ruby
 authors:
 - Ryan Sonnek
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client