socialcast 1.3.9 → 1.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e51c9793ebf4ee2583d3ed81fa89daff0b434030
-  data.tar.gz: e2e52ed618072b8aba3d3b8d66f530220b2bbc27
+  metadata.gz: 666669e1a4a45b54b0831459e0e2611f4aff0689
+  data.tar.gz: 2de4ab5a30c01bdbc982b42f00a0df9aa2fb3de7
 SHA512:
-  metadata.gz: 91ed1ae61a7c01ce7e3d62758873e65588d2a65dced1b6c5745e55fb155d5aa00ca6be823cefd925417351a4b4f4535bc5863f141866d92e695ae285f8fd5243
-  data.tar.gz: bafba8c661f3f7ff5e5878b15167b6362ac3d558614b7d4fdea7de044847864da7086e76785b1f36f5204a96d587a88eeaeb7ec36a7d16d16dcbc7e40322a549
+  metadata.gz: a536bbd57dfe1c7baa506c5be8a2ffed642532fe55576bedcd0854c37ea3895998d82e23abfa172045774c8097e138f80dd326c60ca55ae6fcd04e9cb67b5650
+  data.tar.gz: af16fbf3fd088e9a021615703f47ee726544a295aeec3a5f046c7d10b775445e037cadd1e680154c0b05360f8cfd4a3a3b47bc65f5179525757238851a3b4e4e

data/README.md

@@ -1,9 +1,50 @@
 [![Build Status](https://secure.travis-ci.org/socialcast/socialcast-command-line.png?branch=master)](http://travis-ci.org/socialcast/socialcast-command-line)
 # socialcast-command-line
 
-command line interface to the Socialcast API
+## Purpose
+Used as a command line interface to interact with the Socialcast API
 http://www.socialcast.com/resources/api.html
 
+## Installing
+
+1. Run: `gem install socialcast`
+2. Authenticate: `socialcast authenticate`
+	* If your account is private cloud or On-Premise you will need to use `socialcast authenticate --domain YOUR_DOMAIN_NAME`
+
+## Available Commands
+### socialcast info
+Used to tell you information about the currently installed gem.
+
+> Example `$ socialcast -v`
+
+### socialcast authenticate
+Used to authenticate your local system to the Socialcast servers. This will create a credentials file stored locally that will be later used to send secure, authenticated requests to Socialcast.
+> Example `$ socialcast authenticate --domain demo.socialcast.com`
+
+### socialcast authenticate_external_system
+Similar to the `socialcast authenticate` command listed above but will allow you to use a provisioning system to authenticate against Socialcast.
+
+> Example `$ socialcast authenticate_external_system --domain demo.socialcast.com`
+
+*Note: Using an external system is currently limited to the provisioning endpoint*
+
+### socialcast share
+Used to post a message to the stream as the currently authenticated person.
+> Example `$ socialcast share 'Hi Team!'`
+
+### socialcast provision
+Used to sync an LDAP server with your Socialcast community.
+
+[For more detailed information](http://developers.socialcast.com/admin/directory-integration-overview/)
+
+> Example `$ socialcast provision --config /path/to/ldap.yml`
+
+### socialcast sync_photos
+Used to sync an employees photos stored in LDAP with their Socialcast
+profile photo.
+
+> Example `$ socialcast sync_photos --config /path/to/ldap.yml`
+
 ## Contributing
 
 * Fork the project.
@@ -11,9 +52,9 @@ http://www.socialcast.com/resources/api.html
 * Add tests
 * Send me a pull request. Bonus points for topic branches.
 
-see CONTRIBUTORS.txt for list of contributors
+See [CONTRIBUTORS.txt](https://github.com/socialcast/socialcast-command-line/blob/master/CONTRIBUTORS.txt) for list of contributors
 
 ## Copyright
 
-Copyright (c) 2011 Socialcast Inc.
-See LICENSE.txt for details.
+Copyright (c) 2011 - 2014 Socialcast Inc.
+See [LICENSE.txt](https://github.com/socialcast/socialcast-command-line/blob/master/LICENSE.txt) for details.

data/lib/socialcast/command_line/authenticate.rb

@@ -10,6 +10,20 @@ module Socialcast
         self.headers = headers
       end
 
+      def self.current_user
+        @current_user ||= find_current_user
+      end
+
+      def self.find_current_user
+        response = Socialcast::CommandLine.resource_for_path('/api/userinfo.json').get
+        json_body = JSON.parse(response.body)
+        if json_body['user']
+          json_body['user']
+        else
+          raise "Unable to find the current user: #{response.body}"
+        end
+      end
+
       def request
         @request ||= send_request
       end

data/lib/socialcast/command_line/provision_photo.rb

@@ -1,67 +1,95 @@
-require 'digest/md5'
-
 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
 
+        init_users
+
         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
+          end
+        end
+
+        handle_batch if users.any?
+      end
+
+      private
+
+      def init_users
+        @users = {}
+      end
+
+      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
+        end
 
-            ## 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']
-            next unless is_community_default || @options[:force_sync]
-
-            ## PHOTO URL TO BINARY
-            if profile_photo_data = photo_hash[LDAPConnector::PROFILE_PHOTO_ATTRIBUTE]
-              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
+        init_users
+      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
+
+          ## 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 #{user_email}: unknown image format (supports .gif, .png, .jpg)"
+            return
+          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
+          end
         end
       end
 
-      private
+      def default_profile_photo_id
+        @default_profile_photo_id ||= Socialcast::CommandLine::Authenticate.current_user['community']['default_profile_photo_id']
+      end
 
       def binary_to_content_type(binary_photo_data)
         case binary_photo_data
@@ -73,7 +101,6 @@ module Socialcast
           'jpg'
         end
       end
-
     end
   end
 end

data/lib/socialcast/command_line/version.rb

@@ -1,5 +1,5 @@
 module Socialcast
   module CommandLine
-    VERSION = "1.3.9"
+    VERSION = "1.3.10"
   end
 end

data/spec/socialcast/command_line/authenticate_spec.rb

@@ -27,4 +27,33 @@ describe Socialcast::CommandLine::Authenticate do
     end
   end
 
+  describe '.current_user' do
+    subject(:current_user) { Socialcast::CommandLine::Authenticate.current_user }
+    after do
+      Socialcast::CommandLine::Authenticate.instance_variable_set(:@current_user, nil)
+    end
+    context 'as an unauthenticated user' do
+      it { expect { current_user }.to raise_error(RuntimeError, 'Unknown Socialcast credentials.  Run `socialcast authenticate` to initialize') }
+    end
+    context 'with credentials specified out' do
+      let(:stubbed_config_dir) { File.join(File.dirname(__FILE__), '..', '..', 'fixtures') }
+      let(:current_user_stub) { { :user => { :id => 123 } } }
+      let(:current_user_error) { { :error => "Failed to authenticate due to password" } }
+      before { Socialcast::CommandLine.stub(:config_dir).and_return(stubbed_config_dir) }
+      context 'as a successfull authenticated user' do
+        before do
+          stub_request(:get, "https://ryan%40socialcast.com:foo@test.staging.socialcast.com/api/userinfo.json").
+            to_return(:status => 200, :body => current_user_stub.to_json)
+        end
+        it { current_user['id'].should == 123 }
+      end
+      context 'when you not authenticated properly' do
+        before do
+          stub_request(:get, "https://ryan%40socialcast.com:foo@test.staging.socialcast.com/api/userinfo.json").
+            to_return(:status => 200, :body => current_user_error.to_json)
+        end
+        it { expect { current_user }.to raise_error(RuntimeError) }
+      end
+    end
+  end
 end

data/spec/socialcast/command_line/cli_spec.rb

@@ -11,9 +11,12 @@ describe Socialcast::CommandLine::CLI do
   let(:ldap_with_plugin_mapping_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_plugin_mapping.yml')) }
   let(:ldap_with_profile_photo_config) { YAML.load_file(ldap_with_profile_photo_config_file) }
   let(:ldap_without_permission_mappings_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_without_permission_mappings.yml')) }
+  let(:default_profile_photo_id) { 3 }
+  let(:another_profile_photo_id) { 4 }
 
   before do
     Socialcast::CommandLine.stub(:credentials).and_return(credentials)
+    Socialcast::CommandLine::ProvisionPhoto.any_instance.stub(:default_profile_photo_id).and_return(default_profile_photo_id)
   end
 
   let(:ldap) do
@@ -155,7 +158,6 @@ describe Socialcast::CommandLine::CLI do
 
     context "user does not have a profile photo" do
       let(:config_file) { ldap_with_profile_photo_config_file }
-      let(:system_default_photo) { true }
       let(:photo_data) { "\x89PNGabc".force_encoding('binary') }
       before do
         @entry = Net::LDAP::Entry.new("dc=example,dc=com")
@@ -169,7 +171,10 @@ describe Socialcast::CommandLine::CLI do
             {
               'id' => 7,
               'avatars' => {
-                'is_community_default' => system_default_photo
+                'id' => default_profile_photo_id
+              },
+              'contact_info' => {
+                'email' => 'ryan@example.com'
               }
             }
           ]
@@ -192,7 +197,6 @@ describe Socialcast::CommandLine::CLI do
 
     context "unknown image format" do
       let(:config_file) { ldap_with_profile_photo_config_file }
-      let(:system_default_photo) { true }
       let(:photo_data) { "abc" }
       before do
         @entry = Net::LDAP::Entry.new("dc=example,dc=com")
@@ -206,7 +210,7 @@ describe Socialcast::CommandLine::CLI do
             {
               'id' => 7,
               'avatars' => {
-                'is_community_default' => system_default_photo
+                'id' => default_profile_photo_id
               }
             }
           ]
@@ -225,7 +229,6 @@ describe Socialcast::CommandLine::CLI do
 
     context "user already has a profile photo" do
       let(:config_file) { ldap_with_profile_photo_config_file }
-      let(:system_default_photo) { false }
       let(:photo_data) { "\x89PNGabc".force_encoding('binary') }
       before do
         @entry = Net::LDAP::Entry.new("dc=example,dc=com")
@@ -239,7 +242,7 @@ describe Socialcast::CommandLine::CLI do
             {
               'id' => 7,
               'avatars' => {
-                'is_community_default' => system_default_photo
+                'id' => another_profile_photo_id
               }
             }
           ]

data/spec/socialcast/command_line/provision_photo_spec.rb

@@ -3,6 +3,12 @@ require 'spec_helper'
 describe Socialcast::CommandLine::ProvisionPhoto do
   let!(:ldap_with_profile_photo_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_profile_photo.yml')) }
   let!(:ldap_multiple_connection_mapping_config) { YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'ldap_with_multiple_connection_mappings.yml')) }
+  let(:default_profile_photo_id) { 3 }
+  let(:another_profile_photo_id) { 4 }
+
+  before do
+    Socialcast::CommandLine::ProvisionPhoto.any_instance.stub(:default_profile_photo_id).and_return(default_profile_photo_id)
+  end
 
   let(:ldap) do
     ldap_instance = double(Net::LDAP, :auth => nil, :encryption => nil)
@@ -11,13 +17,12 @@ describe Socialcast::CommandLine::ProvisionPhoto do
     ldap_instance
   end
 
-  context '#sync' do
+  describe '#sync' do
     context "with a single ldap connection" do
       let(:options) { {} }
       subject(:sync_photos) { Socialcast::CommandLine::ProvisionPhoto.new(ldap_with_profile_photo_config, 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
         {
@@ -25,8 +30,10 @@ describe Socialcast::CommandLine::ProvisionPhoto do
             {
               'id' => 7,
               'avatars' => {
-                'is_community_default' => is_community_default,
-                'data_fingerprint' => data_fingerprint
+                'id' => default_profile_photo_id
+              },
+              'contact_info' => {
+                'email' => 'user@example.com'
               }
             }
           ]
@@ -79,7 +86,9 @@ describe Socialcast::CommandLine::ProvisionPhoto do
       end
 
       context 'when there is already a photo set' do
-        let(:is_community_default) { false }
+        before do
+          Socialcast::CommandLine::ProvisionPhoto.any_instance.stub(:default_profile_photo_id).and_return(another_profile_photo_id)
+        end
         let(:photo_data) { "\x89PNGabc" }
         before { user_search_resource.should_receive(:get).and_return(search_api_response.to_json) }
         context 'for a regular sync' do
@@ -103,25 +112,25 @@ describe Socialcast::CommandLine::ProvisionPhoto do
 
     context "with multiple ldap connections" do
       let(:user_search_resource) { double(:user_search_resource) }
-      let(:search_api_response1) do
+      let(:search_api_response) do
         {
           'users' => [
             {
               'id' => 7,
               'avatars' => {
-                'is_community_default' => true
+                'id' => default_profile_photo_id
+              },
+              'contact_info' => {
+                'email' => 'user@example.com'
               }
-            }
-          ]
-        }
-      end
-      let(:search_api_response2) do
-        {
-          'users' => [
+            },
             {
               'id' => 8,
               'avatars' => {
-                'is_community_default' => true
+                'id' => default_profile_photo_id
+              },
+              'contact_info' => {
+                'email' => 'user2@example.com'
               }
             }
           ]
@@ -131,6 +140,8 @@ 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)
+
         ldap_instance1 = double(Net::LDAP, :encryption => nil, :auth => nil)
         ldap_instance1.should_receive(:open).and_yield(ldap_instance1)
         Net::LDAP.should_receive(:new).once.ordered.and_return(ldap_instance1)
@@ -145,8 +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.and_return(search_api_response1.to_json)
-        user_search_resource.should_receive(:get).once.and_return(search_api_response2.to_json)
+        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_resource1 = double(:user_resource)
         user_resource1.should_receive(:put) do |data|
@@ -168,7 +178,7 @@ describe Socialcast::CommandLine::ProvisionPhoto do
     end
   end
 
-  context '.binary_to_content_type' do
+  describe '.binary_to_content_type' do
     subject { Socialcast::CommandLine::ProvisionPhoto.new(ldap_with_profile_photo_config, {}).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 } }

data/spec/spec_helper.rb

@@ -15,23 +15,6 @@ RSpec.configure do |config|
     Socialcast::CommandLine.stub(:config_dir).and_return(stubbed_credentials)
   end
 
-  def capture_with_status(stream)
-    exit_status = 0
-    begin
-      stream = stream.to_s
-      eval "$#{stream} = StringIO.new"
-      begin
-        yield
-      rescue SystemExit => system_exit # catch any exit calls
-        exit_status = system_exit.status
-      end
-      result = eval("$#{stream}").string
-    ensure
-      eval("$#{stream} = #{stream.upcase}")
-    end
-    return result, exit_status
-  end
-
   def create_entry(cn, entry_attributes)
     Net::LDAP::Entry.new("cn=#{cn},dc=example,dc=com").tap do |e|
       entry_attributes.each_pair do |attr, value|
@@ -39,11 +22,4 @@ RSpec.configure do |config|
       end
     end
   end
-
-  def remove_directories(*names)
-    project_dir = Pathname.new(Dir.pwd)
-    names.each do |name|
-      FileUtils.rm_rf(project_dir.join(name)) if FileTest.exists?(project_dir.join(name))
-    end
-  end
 end

metadata

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