socialcast 1.0.8 → 1.1.0

data/.rvmrc

@@ -1 +1 @@
-rvm use ree-1.8.7-2011.03@socialcast-command-line --create
+rvm use ree-1.8.7-2011.12@socialcast-command-line --create

data/config/ldap.yml

@@ -34,6 +34,15 @@ mappings:
   # employee_number: emp_id
   # only use unique_identifier if you do not wish to use email as the main user identification method
   # unique_identifier: samaccountname
+  # To combine multiple ldap attributes into one Socialcast attribute use the following pattern
+  # The key is the socialcast attribute and the value is a hash.  The hash requires a key of value
+  # which will use the other keys to interpolate the values.
+  # location:
+  #   value: "%{city}, %{state} %{zip}"
+  #   city: city
+  #   state: state
+  #   zip: zipcode
+  
 
 
 # Map LDAP Group Memberships to Socialcast Permissions

data/lib/ext/string_ext.rb

@@ -0,0 +1,13 @@
+if RUBY_VERSION < '1.9.2'
+  class String
+    old_format = instance_method(:%)
+
+    define_method(:%) do |arg|
+      if arg.is_a?(Hash)
+        self.gsub(/%\{(.*?)\}/) { arg[$1.to_sym] }
+      else
+        old_format.bind(self).call(arg)
+      end
+    end
+  end
+end

data/lib/socialcast.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'fileutils'
 require File.join(File.dirname(__FILE__), 'ext', 'array_ext') unless Array.respond_to?(:wrap)
+require File.join(File.dirname(__FILE__), 'ext', 'string_ext')
 
 module Socialcast
   class << self

data/lib/socialcast/cli.rb

@@ -80,6 +80,7 @@ module Socialcast
     method_option :delete_users_file, :type => :boolean
     method_option :test, :type => :boolean
     method_option :skip_emails, :type => :boolean
+    method_option :force, :type => :boolean, :aliases => '-f', :default => false
     def provision
       config_file = File.expand_path options[:config]
 
@@ -136,17 +137,20 @@ module Socialcast
       end # gzip
       say "Finished scanning #{count} users"
 
-      say "Uploading dataset to Socialcast..."
-      http_config = config.fetch('http', {})
-      resource = Socialcast.resource_for_path '/api/users/provision', http_config
-      File.open(output_file, 'r') do |file|
-        request_params = {:file => file}
-        request_params[:skip_emails] = 'true' if (config['options']["skip_emails"] || options[:skip_emails])
-        request_params[:test] = 'true' if (config['options']["test"] || options[:test])
-        resource.post request_params
+      if count == 0 && !options[:force]
+        Kernel.abort("Skipping upload to Socialcast since no users were found")
+      else
+        say "Uploading dataset to Socialcast..."
+        http_config = config.fetch('http', {})
+        resource = Socialcast.resource_for_path '/api/users/provision', http_config
+        File.open(output_file, 'r') do |file|
+          request_params = {:file => file}
+          request_params[:skip_emails] = 'true' if (config['options']["skip_emails"] || options[:skip_emails])
+          request_params[:test] = 'true' if (config['options']["test"] || options[:test])
+          resource.post request_params
+        end
+        say "Finished"
       end
-      say "Finished"
-
       File.delete(output_file) if (config['options']['delete_users_file'] || options[:delete_users_file])
     end
   end

data/lib/socialcast/net_ldap_ext.rb

@@ -5,7 +5,13 @@ class Net::LDAP::Entry
   # grab a *single* value of an attribute
   # abstracts away ldap multivalue attributes
   def grab(attribute)
-    Array.wrap(self[attribute]).compact.first
+    case attribute
+    when Hash
+      value = attribute.delete("value")
+      value % Hash[attribute.map {|k,v| [k, grab(v)]}].symbolize_keys
+    else
+      Array.wrap(self[attribute]).compact.first
+    end
   end
 
   def build_xml_from_mappings(user, mappings = {}, permission_mappings = {})

data/lib/socialcast/version.rb

@@ -1,3 +1,3 @@
 module Socialcast
-  VERSION = "1.0.8"
+  VERSION = "1.1.0"
 end

data/spec/cli_spec.rb

@@ -6,8 +6,10 @@ describe Socialcast::CLI do
     # Expects -u=emily@socialcast.com -p=demo --domain=demo.socialcast.com
     context 'with a basic message' do
       before do
-        stub_request(:post, "https://emily%40socialcast.com:demo@demo.socialcast.com/api/messages.xml").
-                 with(:body => /<message-type.*nil="true">.*testing/m).
+        File.stub(:open).with(/credentials.yml/).and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+        stub_request(:post, "https://ryan%40socialcast.com:foo@test.staging.socialcast.com/api/messages.json").
+                 with(:body => /message\_type\"\:null/).
+                 with(:body => /testing/).
                  to_return(:status => 200, :body => "", :headers => {})
         
         Socialcast::CLI.start ['share', 'testing']
@@ -19,8 +21,10 @@ describe Socialcast::CLI do
     
     context 'with a message_type message' do
       before do
-        stub_request(:post, "https://emily%40socialcast.com:demo@demo.socialcast.com/api/messages.xml").
-                 with(:body => /<message-type>review_request<\/message-type>.*please review/m).
+        File.stub(:open).with(/credentials.yml/).and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+        stub_request(:post, "https://ryan%40socialcast.com:foo@test.staging.socialcast.com/api/messages.json").
+                 with(:body => /message\_type\"\:review\_request/).
+                 with(:body => /please\sreview/).
                  to_return(:status => 200, :body => "", :headers => {})
         
         Socialcast::CLI.start ['share', 'please review', '--message_type=review_request']
@@ -33,6 +37,44 @@ describe Socialcast::CLI do
   end
   
   describe '#provision' do
+    context 'with 0 users found in ldap' do
+      before do
+        Net::LDAP.any_instance.stub(:search).and_return(nil)
+
+        @result = ''
+        Zlib::GzipWriter.stub(:open).and_yield(@result)
+        
+        File.should_receive(:open).with('/my/path/to/ldap.yml').and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'ldap_without_permission_mappings.yml')))
+        File.should_receive(:exists?).with('/my/path/to/ldap.yml').and_return(true)
+        File.stub(:open).with(/users.xml.gz/, anything).and_yield(@result)
+        File.stub(:open).with(/credentials.yml/).and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+
+        RestClient::Resource.any_instance.should_not_receive(:post)
+        Kernel.should_receive(:abort).once
+
+        Socialcast::CLI.start ['provision', '-c', '/my/path/to/ldap.yml']
+      end
+      it 'does not post to Socialcast and throws Kernel.abort' do end # see expectations
+    end
+    context 'with 0 users found in ldap and force option passed' do
+      before do
+        Net::LDAP.any_instance.stub(:search).and_return(nil)
+
+        @result = ''
+        Zlib::GzipWriter.stub(:open).and_yield(@result)
+        
+        File.should_receive(:open).with('/my/path/to/ldap.yml').and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'ldap_without_permission_mappings.yml')))
+        File.should_receive(:exists?).with('/my/path/to/ldap.yml').and_return(true)
+        File.stub(:open).with(/users.xml.gz/, anything).and_yield(@result)
+        File.stub(:open).with(/credentials.yml/).and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+
+        RestClient::Resource.any_instance.should_receive(:post).once
+        Kernel.should_not_receive(:abort)
+
+        Socialcast::CLI.start ['provision', '-c', '/my/path/to/ldap.yml', '-f']
+      end
+      it 'does post to Socialcast and does not call Kernel.abort' do end # see expectations
+    end
     context 'with absolute path to ldap.yml file' do
       before do
         @entry = Net::LDAP::Entry.new("dc=example,dc=com")
@@ -194,4 +236,27 @@ describe Socialcast::CLI do
       end
     end
   end
+  context 'with ldap.yml configuration including template value' do
+    before do
+      @entry = Net::LDAP::Entry.new("dc=example,dc=com")
+      @entry[:mail] = 'ryan@example.com'
+      @entry[:l] = 'San Francisco'
+      @entry[:co] = 'USA'
+
+      Net::LDAP.any_instance.stub(:search).and_yield(@entry)
+
+      @result = ''
+      Zlib::GzipWriter.stub(:open).and_yield(@result)
+      File.stub(:open).with(/ldap.yml/).and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'ldap_with_interpolated_values.yml')))
+      File.stub(:open).with(/users.xml.gz/, anything).and_yield(@result)
+      File.stub(:open).with(/credentials.yml/).and_yield(File.read(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+
+      RestClient::Resource.any_instance.stub(:post)
+
+      Socialcast::CLI.start ['provision', '-c', 'spec/fixtures/ldap.yml']
+    end
+    it 'formats l and co according to template' do
+      @result.should =~ %r{<location>San Francisco, USA</location>}
+    end
+  end
 end

data/spec/fixtures/ldap_with_interpolated_values.yml

@@ -0,0 +1,57 @@
+--- 
+# LDAP connections
+connections:
+  example_connection_1:
+    username: "cn=Directory Manager"
+    password: "test"
+    host: localhost
+    port: 1389
+    basedn: "dc=example,dc=com"
+    filter: "(mail=*)"
+
+
+# LDAP attribute mappings
+mappings: 
+  first_name: givenName
+  last_name: sn
+  email: mail
+  location:
+    value: "%{city}, %{country}"
+    city: l
+    country: co
+  # only use employee_number if the email is unknown
+  # employee_number: emp_id
+  # only use unique_identifier if you do not wish to use email as the main user identification method
+  # unique_identifier: samaccountname
+
+
+# Map LDAP Group Memberships to Socialcast Permissions
+# permission_mappings:
+#   # configure LDAP field for group memberships (ex: memberof, isMemberOf, etc)
+#   attribute_name: isMemberOf
+#   account_types:
+#     external: "cn=External,dc=example,dc=com"
+#   roles:
+#     tenant_admin: "cn=Admins,dc=example,dc=com"
+#     sbi_admin: "cn=SbiAdmins,dc=example,dc=com"
+#     reach_admin: "cn=ReachAdmins,dc=example,dc=com"
+#     town_hall_admin: "cn=TownHallAdmins,dc=example,dc=com"
+
+
+# general script options
+options:
+  # cleanup the extracted ldap data file after run is complete
+  delete_users_file: false
+  # skip sending emails to newly activated users
+  skip_emails: true
+  # do not actually provision accounts
+  # useful during testing
+  test: true
+
+
+# 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,178 +1,124 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: socialcast
-version: !ruby/object:Gem::Version 
-  hash: 7
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 8
-  version: 1.0.8
 platform: ruby
-authors: 
+authors:
 - Ryan Sonnek
 - Sean Cashin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156569520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.0
-  version_requirements: *id001
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156569520
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2156568780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 4
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.6
-  version_requirements: *id002
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  name: thor
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2156568780
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &2156568060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 14
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.14.6
-  version_requirements: *id003
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  name: highline
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2156568060
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &2156567200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 6
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.6.2
-  version_requirements: *id004
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  name: scashin133-net-ldap
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2156567200
+- !ruby/object:Gem::Dependency
+  name: scashin133-net-ldap
+  requirement: &2156566420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 1
-        - 4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.1.4
-  version_requirements: *id005
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  name: activeresource
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2156566420
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: &2156565780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 2
-        - 3
-        - 11
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.11
-  version_requirements: *id006
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2156565780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156564700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.6.0
-  version_requirements: *id007
   type: :development
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2156564700
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2156564040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 7
-        - 7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.7.7
-  version_requirements: *id008
   type: :development
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *2156564040
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156563440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 9
-        - 2
-        - 2
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.9.2.2
-  version_requirements: *id009
   type: :development
+  prerelease: false
+  version_requirements: *2156563440
 description: publish messages to your stream from a command line interface
-email: 
+email:
 - ryan@socialcast.com
-executables: 
+executables:
 - socialcast
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
 - .rspec
@@ -185,6 +131,7 @@ files:
 - bin/socialcast
 - config/ldap.yml
 - lib/ext/array_ext.rb
+- lib/ext/string_ext.rb
 - lib/socialcast.rb
 - lib/socialcast/cli.rb
 - lib/socialcast/message.rb
@@ -195,45 +142,38 @@ files:
 - spec/fixtures/credentials.yml
 - spec/fixtures/ldap.yml
 - spec/fixtures/ldap_with_array_permission_mapping.yml
+- spec/fixtures/ldap_with_interpolated_values.yml
 - spec/fixtures/ldap_without_permission_mappings.yml
 - spec/spec_helper.rb
 homepage: http://github.com/wireframe/socialcast-command-line
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: socialcast
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: command line interface to socialcast api
-test_files: 
+test_files:
 - spec/cli_spec.rb
 - spec/fixtures/credentials.yml
 - spec/fixtures/ldap.yml
 - spec/fixtures/ldap_with_array_permission_mapping.yml
+- spec/fixtures/ldap_with_interpolated_values.yml
 - spec/fixtures/ldap_without_permission_mappings.yml
 - spec/spec_helper.rb