socialcast 1.0.0 → 1.0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in socialcast.gemspec
+# add gem dependencies via *.gemspec file
 gemspec

data/Rakefile

@@ -1,16 +1,6 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rake'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/test_*.rb'
-end
-
-namespace :test do
-  task :all => ['test']
-end
-
-task :default => 'test:all'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/config/ldap.yml

@@ -36,6 +36,19 @@ mappings:
   # unique_identifier: samaccountname
 
 
+# Map LDAP Group Memberships to Socialcast Permissions
+permission_mappings:
+  # configure LDAP field for group memberships (ex: memberof, isMemberOf, etc)
+  attribute_name: memberof
+  account_types:
+    external: "cn=External,dc=example,dc=com"
+  roles:
+    tenant_admin: "cn=Admins,dc=example,dc=com"
+    sbi_admin: "cn=Admins,dc=example,dc=com"
+    reach_admin: "cn=Admins,dc=example,dc=com"
+    town_hall_admin: "cn=Admins,dc=example,dc=com"
+
+
 # general script options
 options:
   # cleanup the extracted ldap data file after run is complete

data/lib/socialcast/cli.rb

@@ -4,6 +4,7 @@ require 'rest_client'
 require 'highline'
 require 'socialcast'
 require 'socialcast/message'
+require File.join(File.dirname(__FILE__), 'net_ldap_ext')
 
 require 'zlib'
 require 'logger'
@@ -86,14 +87,22 @@ module Socialcast
         return
       end
 
+      fail "Unable to load configuration file: #{config_file}" unless File.exist?(config_file)
+      say "Using configuration file: #{config_file}"
       config = YAML.load_file config_file
       required_mappings = %w{email first_name last_name}
+      mappings = config.fetch 'mappings', {}
       required_mappings.each do |field|
-        unless config["mappings"].has_key? field
+        unless mappings.has_key? field
           fail "Missing required mapping: #{field}"
         end
       end
 
+      permission_mappings = config.fetch 'permission_mappings', {}
+      membership_attribute = permission_mappings.fetch 'attribute_name', 'memberof'
+      attributes = mappings.values
+      attributes << membership_attribute
+
       output_file = File.join Dir.pwd, options[:output]
       Zlib::GzipWriter.open(output_file) do |gz|
         xml = Builder::XmlMarkup.new(:target => gz, :indent => 1)
@@ -109,27 +118,44 @@ module Socialcast
               say "Connected"
               say "Searching..." 
               count = 0
-              ldap.search(:return_result => false, :filter => connection["filter"], :base => connection["basedn"]) do |entry|
-                next if grab_value(entry[config["mappings"]["email"]]).blank? || (config["mappings"].has_key?("unique_identifier") && grab_value(entry[config["mappings"]["unique_identifier"]]).blank?)
+
+              ldap.search(:return_result => false, :filter => connection["filter"], :base => connection["basedn"], :attributes => attributes) do |entry|
+                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 config['mappings'].has_key?(attribute)
-                    user.tag! attribute, grab_value(entry[config["mappings"][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 config['mappings'].has_key?(attribute)
-                      contact_info.tag! attribute, grab_value(entry[config["mappings"][attribute]])
+                      next unless mappings.has_key?(attribute)
+                      contact_info.tag! attribute, entry.grab(mappings[attribute])
                     end
                   end
-                  custom_attributes = config['mappings'].keys - (primary_attributes + contact_attributes)
+
+                  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.value(grab_value(entry[config["mappings"][attribute]]))
+                        custom_field.id attribute
+                        custom_field.label attribute
+                        custom_field.value entry.grab(mappings[attribute])
+                      end
+                    end
+                  end
+
+                  memberships = entry[membership_attribute]
+                  if memberships.include?(permission_mappings['account_types']['external'])
+                    user.tag! 'account-type', 'external'
+                  else
+                    user.tag! 'account-type', 'member'
+                    user.tag! 'roles', :type => 'array' do |roles|
+                      permission_mappings['roles'].each_pair do |socialcast_role, ldap_role|
+                        roles.role socialcast_role if entry[membership_attribute].include?(ldap_role)
                       end
                     end
                   end

data/lib/socialcast/net_ldap_ext.rb

@@ -0,0 +1,10 @@
+require 'net/ldap'
+
+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
+  end
+end

data/lib/socialcast/version.rb

@@ -1,3 +1,3 @@
 module Socialcast
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/socialcast.rb

@@ -20,7 +20,4 @@ module Socialcast
     raise 'Unknown Socialcast credentials.  Run `socialcast authenticate` to initialize' unless File.exist?(credentials_file)
     YAML.load_file(credentials_file)
   end
-  def grab_value(entry)
-    entry.is_a?(Array) ? entry.first : entry
-  end
 end

data/socialcast.gemspec

@@ -14,12 +14,13 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "socialcast"
   
-  s.add_development_dependency  "shoulda", ">= 0"
   s.add_runtime_dependency 'rest-client', '>= 1.4.0'
   s.add_runtime_dependency 'json', '>= 1.4.6'
   s.add_runtime_dependency 'thor', '>= 0.14.6'
   s.add_runtime_dependency 'highline', '>= 1.6.2'
   s.add_runtime_dependency 'scashin133-net-ldap', '>= 0.1.4'
+  s.add_runtime_dependency 'activeresource', '>= 2.3.11'
+  s.add_development_dependency "rspec", '>= 2.6.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/cli_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Socialcast::CLI do
+  describe '#provision' do
+    context 'with external group member' do
+      before do
+        @entry = Net::LDAP::Entry.new("dc=example,dc=com")
+        @entry[:mail] = 'ryan@example.com'
+        @entry[:isMemberOf] = 'cn=External,dc=example,dc=com'
+
+        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.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 'sets account-type to external' do
+        @result.should =~ %r{<account-type>external</account-type>}
+      end
+    end
+
+    context 'with tenant_admin group member' do
+      before do
+        @entry = Net::LDAP::Entry.new("dc=example,dc=com")
+        @entry[:mail] = 'ryan@example.com'
+        @entry[:isMemberOf] = 'cn=Admins,dc=example,dc=com'
+
+        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.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 'sets account-type to member' do
+        @result.should =~ %r{<account-type>member</account-type>}
+      end
+      it 'adds tenant_admin role' do
+        @result.should =~ %r{<role>tenant_admin</role>}
+      end
+    end
+  end
+end

data/spec/fixtures/credentials.yml

@@ -0,0 +1,4 @@
+--- 
+:user: ryan@socialcast.com
+:password: foo
+:domain: test.staging.socialcast.com

data/spec/fixtures/ldap.yml

@@ -0,0 +1,53 @@
+--- 
+# 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
+  # 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"
+

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec/mocks'
+RSpec::Mocks::setup(Object.new)
+
+require 'socialcast/cli'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  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 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,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: socialcast
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -16,26 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 Z
+date: 2011-07-13 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,11 +33,11 @@ dependencies:
         - 0
         version: 1.4.0
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -63,11 +49,11 @@ dependencies:
         - 6
         version: 1.4.6
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: thor
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,11 +65,11 @@ dependencies:
         - 6
         version: 0.14.6
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: highline
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,11 +81,11 @@ dependencies:
         - 2
         version: 1.6.2
   type: :runtime
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: scashin133-net-ldap
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -111,7 +97,39 @@ dependencies:
         - 4
         version: 0.1.4
   type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  type: :runtime
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id007
 description: publish messages to your stream from a command line interface
 email: 
 - ryan@socialcast.com
@@ -124,6 +142,7 @@ extra_rdoc_files: []
 files: 
 - .document
 - .gitignore
+- .rspec
 - CONTRIBUTORS.txt
 - Gemfile
 - LICENSE.txt
@@ -134,11 +153,13 @@ files:
 - lib/socialcast.rb
 - lib/socialcast/cli.rb
 - lib/socialcast/message.rb
+- lib/socialcast/net_ldap_ext.rb
 - lib/socialcast/version.rb
 - socialcast.gemspec
-- test/commander_helper.rb
-- test/helper.rb
-- test/test_socialcast.rb
+- spec/cli_spec.rb
+- spec/fixtures/credentials.yml
+- spec/fixtures/ldap.yml
+- spec/spec_helper.rb
 homepage: http://github.com/wireframe/socialcast-command-line
 licenses: []
 
@@ -173,6 +194,7 @@ signing_key:
 specification_version: 3
 summary: command line interface to socialcast api
 test_files: 
-- test/commander_helper.rb
-- test/helper.rb
-- test/test_socialcast.rb
+- spec/cli_spec.rb
+- spec/fixtures/credentials.yml
+- spec/fixtures/ldap.yml
+- spec/spec_helper.rb

data/test/commander_helper.rb

@@ -1,54 +0,0 @@
-require 'commander/import'
-
-# require 'rubygems'
-# require 'commander/import'
-# require 'stringio'
-# 
-# # Mock terminal IO streams so we can spec against them
-# 
-# def mock_terminal
-#   @input = StringIO.new
-#   @output = StringIO.new
-#   $terminal = HighLine.new @input, @output
-# end
-# 
-# # Create test command for usage within several specs
-# 
-# def create_test_command
-#   command :test do |c|
-#     c.syntax = "test [options] <file>"
-#     c.description = "test description"
-#     c.example "description", "command"
-#     c.example "description 2", "command 2"
-#     c.option '-v', "--verbose", "verbose description"
-#     c.when_called do |args, options|
-#       "test %s" % args.join
-#     end
-#   end
-#   @command = command :test
-# end
-# 
-# # Create a new command runner
-# 
-# def new_command_runner *args, &block
-#   Commander::Runner.instance_variable_set :"@singleton", Commander::Runner.new(args)
-#   program :name, 'test'
-#   program :version, '1.2.3'
-#   program :description, 'something'
-#   create_test_command
-#   yield if block
-#   Commander::Runner.instance
-# end
-# 
-# # Comply with how specs were previously written
-# 
-# def command_runner
-#   Commander::Runner.instance
-# end
-# 
-# def run *args
-#   new_command_runner *args do
-#     program :formatter, Commander::HelpFormatter::Base
-#   end.run!    
-#   @output.string
-# end

data/test/helper.rb

@@ -1,11 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require File.join(File.dirname(__FILE__), 'commander_helper')
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'socialcast'
-
-class Test::Unit::TestCase
-end

data/test/test_socialcast.rb

@@ -1,12 +0,0 @@
-require File.join(File.dirname(__FILE__), 'helper')
-load File.join(File.dirname(__FILE__), '..', 'bin', 'socialcast')
-
-class TestSocialcast < Test::Unit::TestCase
-  context 'socialcast command' do
-    setup do
-      command(:share).run
-    end
-    should 'run' do
-    end
-  end
-end