socialcast 1.0.2 → 1.0.3

data/config/ldap.yml

@@ -63,5 +63,3 @@ options:
 # http options for connecting to Socialcast servers
 http:
   timeout: 660
-  # optional setting if script must connect to Socialcast server through a proxy
-  # proxy: "http://username:password@proxy.company.com:3128"

data/lib/socialcast.rb

@@ -2,22 +2,34 @@ require 'yaml'
 require 'fileutils'
 
 module Socialcast
-  def config_dir
-    config_dir = File.expand_path '~/.socialcast'
-    FileUtils.mkdir config_dir, :mode => 0700 unless File.exist?(config_dir)
-    config_dir
-  end
-  def credentials_file
-    File.join config_dir, 'credentials.yml'
-  end
-  def save_credentials(options)
-    File.open(credentials_file, "w") do |f|
-      f.write(options.to_yaml)
+  class << self
+    def config_dir
+      config_dir = File.expand_path '~/.socialcast'
+      FileUtils.mkdir config_dir, :mode => 0700 unless File.exist?(config_dir)
+      config_dir
+    end
+    def credentials_file
+      File.join config_dir, 'credentials.yml'
+    end
+    def credentials
+      fail 'Unknown Socialcast credentials.  Run `socialcast authenticate` to initialize' unless File.exist?(credentials_file)
+      @@credentials ||= YAML.load_file(credentials_file)
+    end
+    def credentials=(options)
+      File.open(credentials_file, "w") do |f|
+        f.write(options.to_yaml)
+      end
+      File.chmod 0600, credentials_file
+    end
+    def basic_auth_options
+      {:user => credentials[:user], :password => credentials[:password]}
+    end
+    # configure restclient for api call
+    def resource_for_path(path, options = {}, debug = true)
+      RestClient.log = Logger.new(STDOUT) if debug
+      RestClient.proxy = credentials[:proxy] if credentials[:proxy]
+      url = ['https://', credentials[:domain], path].join
+      RestClient::Resource.new url, options.merge(basic_auth_options)
     end
-    File.chmod 0600, credentials_file
-  end
-  def credentials
-    raise 'Unknown Socialcast credentials.  Run `socialcast authenticate` to initialize' unless File.exist?(credentials_file)
-    YAML.load_file(credentials_file)
   end
 end

data/lib/socialcast/cli.rb

@@ -1,3 +1,5 @@
+require 'rubygems'
+
 require "thor"
 require 'json'
 require 'rest_client'
@@ -14,12 +16,14 @@ require 'net/ldap'
 module Socialcast
   class CLI < Thor
     include Thor::Actions
-    include Socialcast
+
+    method_option :trace, :type => :boolean, :aliases => '-v'
+    def initialize(*args); super(*args) end
 
     desc "authenticate", "Authenticate using your Socialcast credentials"
     method_option :user, :type => :string, :aliases => '-u', :desc => 'email address for the authenticated user'
-    method_option :domain, :type => :string, :default => 'api.socialcast.com', :desc => 'socialcast community domain'
-    method_option :trace, :type => :boolean, :aliases => '-v'
+    method_option :domain, :type => :string, :default => 'api.socialcast.com', :desc => 'Socialcast community domain'
+    method_option :proxy, :type => :string, :desc => 'HTTP proxy options for connecting to Socialcast server'
     def authenticate
       user = options[:user] || ask('Socialcast username: ')
       password = HighLine.new.ask("Socialcast password: ") { |q| q.echo = false }
@@ -28,19 +32,20 @@ module Socialcast
       url = ['https://', domain, '/api/authentication.json'].join
       say "Authenticating #{user} to #{url}"
       params = {:email => user, :password => password }
-      resource = RestClient::Resource.new url
       RestClient.log = Logger.new(STDOUT) if options[:trace]
+      RestClient.proxy = options[:proxy] if options[:proxy]
+      resource = RestClient::Resource.new url
       response = resource.post params
       say "API response: #{response.body.to_s}" if options[:trace]
       communities = JSON.parse(response.body.to_s)['communities']
       domain = communities.detect {|c| c['domain'] == domain} ? domain : communities.first['domain']
 
-      save_credentials :user => user, :password => password, :domain => domain
+      Socialcast.credentials = {:user => user, :password => password, :domain => domain, :proxy => options[:proxy]}
       say "Authentication successful for #{domain}"
     end
 
     desc "share MESSAGE", "Posts a new message into socialcast"
-    method_option :url, :type => :string
+    method_option :url, :type => :string, :desc => '(optional) url to associate to the message'
     method_option :attachments, :type => :array, :default => []
     def share(message = nil)
       message ||= $stdin.read_nonblock(100_000) rescue nil
@@ -48,10 +53,9 @@ module Socialcast
       attachment_ids = []
       options[:attachments].each do |path|
         Dir[File.expand_path(path)].each do |attachment|
-          attachment_url = ['https://', credentials[:domain], '/api/attachments.json'].join
           say "Uploading attachment #{attachment}..."
-          attachment_uploader = RestClient::Resource.new attachment_url, :user => credentials[:user], :password => credentials[:password]
-          attachment_uploader.post :attachment => File.new(attachment) do |response, request, result|
+          uploader = Socialcast.resource_for_path '/api/attachments.json', {}, options[:trace]
+          uploader.post :attachment => File.new(attachment) do |response, request, result|
             if response.code == 201
               attachment_ids << JSON.parse(response.body)['attachment']['id']
             else
@@ -61,10 +65,7 @@ module Socialcast
         end
       end
 
-      Socialcast::Message.site = ['https://', credentials[:domain], '/api'].join
-      Socialcast::Message.user = credentials[:user]
-      Socialcast::Message.password = credentials[:password]
-
+      Socialcast::Message.configure_from_credentials
       Socialcast::Message.create :body => message, :url => options[:url], :attachment_ids => attachment_ids
 
       say "Message has been shared"
@@ -123,46 +124,8 @@ module Socialcast
                 next if entry.grab(mappings["email"]).blank? || (mappings.has_key?("unique_identifier") && entry.grab(mappings["unique_identifier"]).blank?)
 
                 users.user do |user|
-                  primary_attributes = %w{unique_identifier first_name last_name employee_number}
-                  primary_attributes.each do |attribute|
-                    next unless mappings.has_key?(attribute)
-                    user.tag! attribute, entry.grab(mappings[attribute])
-                  end
-
-                  contact_attributes = %w{email location cell_phone office_phone}
-                  user.tag! 'contact-info' do |contact_info|
-                   contact_attributes.each do |attribute|
-                      next unless mappings.has_key?(attribute)
-                      contact_info.tag! attribute, entry.grab(mappings[attribute])
-                    end
-                  end
-
-                  custom_attributes = mappings.keys - (primary_attributes + contact_attributes)
-                  user.tag! 'custom-fields', :type => "array" do |custom_fields|
-                    custom_attributes.each do |attribute|
-                      custom_fields.tag! 'custom-field' do |custom_field|
-                        custom_field.id attribute
-                        custom_field.label attribute
-                        custom_field.value entry.grab(mappings[attribute])
-                      end
-                    end
-                  end
-
-                  memberships = entry[membership_attribute]
-                  external_ldap_group = permission_mappings.fetch('account_types', {})['external']
-                  if external_ldap_group && memberships.include?(external_ldap_group)
-                    user.tag! 'account-type', 'external'
-                  else
-                    user.tag! 'account-type', 'member'
-                    if permission_roles_mappings = permission_mappings['roles']
-                      user.tag! 'roles', :type => 'array' do |roles|
-                        permission_roles_mappings.each_pair do |socialcast_role, ldap_group|
-                          roles.role socialcast_role if entry[membership_attribute].include?(ldap_group)
-                        end
-                      end
-                    end
-                  end
-                end # user
+                  entry.build_xml_from_mappings user, mappings, permission_mappings
+                end
                 count += 1
                 say "Scanned #{count} users..." if ((count % 100) == 0)
               end # search
@@ -175,15 +138,12 @@ module Socialcast
       say "Sending to Socialcast" 
 
       http_config = config.fetch('http', {})
-      RestClient.log = Logger.new(STDOUT)
-      RestClient.proxy = http_config['proxy'] if http_config['proxy']
-      url = ['https://', credentials[:domain], '/api/users/provision'].join
-      private_resource = RestClient::Resource.new url, :user => credentials[:user], :password => credentials[:password], :timeout => http_config['timeout']
+      resource = Socialcast.resource_for_path '/api/users/provision', http_config
       File.open(output_file, 'r') do |file|
         request_params = {:file => file}
         request_params[:skip_emails] = 'true' if (config['options']["skip_emails"] || options[:skip_emails])
         request_params[:test] = 'true' if (config['options']["test"] || options[:test])
-        private_resource.post request_params
+        resource.post request_params
       end
 
       File.delete(output_file) if (config['options']['delete_users_file'] || options[:delete_users_file])

data/lib/socialcast/message.rb

@@ -2,6 +2,12 @@ require 'active_resource'
 
 module Socialcast
   class Message < ActiveResource::Base
+    def self.configure_from_credentials
+      Socialcast::Message.site = ['https://', Socialcast.credentials[:domain], '/api'].join
+      Socialcast::Message.proxy = credentials[:proxy] if Socialcast.credentials[:proxy]
+      Socialcast::Message.user = Socialcast.credentials[:user]
+      Socialcast::Message.password = Socialcast.credentials[:password]
+    end
   end
 end
 

data/lib/socialcast/net_ldap_ext.rb

@@ -7,4 +7,47 @@ class Net::LDAP::Entry
   def grab(attribute)
     Array.wrap(self[attribute]).compact.first
   end
+
+  def build_xml_from_mappings(user, mappings = {}, permission_mappings = {})
+    primary_attributes = %w{unique_identifier first_name last_name employee_number}
+    primary_attributes.each do |attribute|
+      next unless mappings.has_key?(attribute)
+      user.tag! attribute, grab(mappings[attribute])
+    end
+
+    contact_attributes = %w{email location cell_phone office_phone}
+    user.tag! 'contact-info' do |contact_info|
+     contact_attributes.each do |attribute|
+        next unless mappings.has_key?(attribute)
+        contact_info.tag! attribute, grab(mappings[attribute])
+      end
+    end
+
+    custom_attributes = mappings.keys - (primary_attributes + contact_attributes)
+    user.tag! 'custom-fields', :type => "array" do |custom_fields|
+      custom_attributes.each do |attribute|
+        custom_fields.tag! 'custom-field' do |custom_field|
+          custom_field.id attribute
+          custom_field.label attribute
+          custom_field.value grab(mappings[attribute])
+        end
+      end
+    end
+
+    membership_attribute = permission_mappings.fetch 'attribute_name', 'memberof'
+    memberships = self[membership_attribute]
+    external_ldap_group = permission_mappings.fetch('account_types', {})['external']
+    if external_ldap_group && memberships.include?(external_ldap_group)
+      user.tag! 'account-type', 'external'
+    else
+      user.tag! 'account-type', 'member'
+      if permission_roles_mappings = permission_mappings['roles']
+        user.tag! 'roles', :type => 'array' do |roles|
+          permission_roles_mappings.each_pair do |socialcast_role, ldap_group|
+            roles.role socialcast_role if memberships.include?(ldap_group)
+          end
+        end
+      end
+    end
+  end
 end

data/lib/socialcast/version.rb

@@ -1,3 +1,3 @@
 module Socialcast
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/fixtures/ldap.yml

@@ -48,6 +48,3 @@ options:
 # http options for connecting to Socialcast servers
 http:
   timeout: 660
-  # optional setting if script must connect to Socialcast server through a proxy
-  # proxy: "http://username:password@proxy.company.com:3128"
-

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: socialcast
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 Z
+date: 2011-07-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: socialcast
-rubygems_version: 1.8.1
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: command line interface to socialcast api