socialcast 1.1.6 → 1.2.0

data/lib/socialcast/cli.rb

@@ -4,6 +4,7 @@ require "thor"
 require 'json'
 require 'rest_client'
 require 'highline'
+require 'net/ldap'
 require 'socialcast'
 require 'socialcast/message'
 require File.join(File.dirname(__FILE__), 'net_ldap_ext')
@@ -12,7 +13,7 @@ require 'zlib'
 require 'logger'
 require 'builder'
 require 'set'
-require 'net/ldap'
+require 'fileutils'
 
 # uncomment to debug HTTP traffic
 # class ActiveResource::Connection
@@ -99,6 +100,7 @@ module Socialcast
     method_option :skip_emails, :type => :boolean
     method_option :force, :type => :boolean, :aliases => '-f', :default => false
     method_option :sanity_check, :type => :boolean, :default => false
+    method_option :plugins, :type => :array, :desc => "Pass in an array of plugins. Can be either the gem require or the absolute path to a ruby file."
     def provision
       config_file = File.expand_path options[:config]
 
@@ -115,6 +117,14 @@ module Socialcast
       config = load_configuration config_file
       http_config = config.fetch('http', {})
 
+      Array.wrap(options[:plugins]).each do |plugin|
+        begin
+          require plugin
+        rescue LoadError => e
+          fail "Unable to load #{plugin}: #{e}"
+        end
+      end
+
       required_mappings = %w{email first_name last_name}
       mappings = config.fetch 'mappings', {}
       required_mappings.each do |field|

data/lib/socialcast/net_ldap_ext.rb

@@ -5,15 +5,24 @@ class Net::LDAP::Entry
   # grab a *single* value of an attribute
   # abstracts away ldap multivalue attributes
   def grab(attribute)
+    attribute = begin
+      attribute.classify.constantize
+    rescue NameError
+      attribute
+    end
+
     case attribute
     when Hash
       value = attribute.delete("value")
       value % Hash[attribute.map {|k,v| [k, grab(v)]}].symbolize_keys
     when String
       Array.wrap(self[attribute]).compact.first
+    when Class, Module
+      return nil unless attribute.respond_to?(:run)
+      attribute.run(self)
     end
   end
-  
+
   def dereference_mail(ldap_connection, dn_field, mail_attribute)
     dn = grab(dn_field)
     ldap_connection.search(:base => dn, :scope => Net::LDAP::SearchScope_BaseObject) do |entry|

data/lib/socialcast/version.rb

@@ -1,3 +1,3 @@
 module Socialcast
-  VERSION = "1.1.6"
+  VERSION = "1.2.0"
 end

data/spec/cli_spec.rb

@@ -123,6 +123,43 @@ describe Socialcast::CLI do
       end
       it 'resolves absolute path without using current process directory' do end # see expectations
     end
+    context 'with plugins option used with non-existent ruby files' do
+      before do
+        @entry = Net::LDAP::Entry.new("dc=example,dc=com")
+        @entry[:mail] = 'ryan@example.com'
+        Net::LDAP.any_instance.stub(:search).and_yield(@entry)
+
+        @result = ''
+        Zlib::GzipWriter.stub(:open).and_yield(@result)
+        Socialcast.stub(:credentials).and_return(YAML.load_file(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+        Socialcast::CLI.any_instance.should_receive(:load_configuration).with('/my/path/to/ldap.yml').and_return(YAML.load_file(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)
+        RestClient::Resource.any_instance.stub(:post)
+
+      end
+      it 'does not post to Socialcast and throws Kernel.abort' do
+        lambda { Socialcast::CLI.start ['provision', '-c', '/my/path/to/ldap.yml', '--plugins', ['does_not_exist.rb', 'also_does_not_exist.rb']] }.should raise_error
+      end
+    end
+    context 'with plugins option used with existent ruby file' do
+      before do
+        @entry = Net::LDAP::Entry.new("dc=example,dc=com")
+        @entry[:mail] = 'ryan@example.com'
+        Net::LDAP.any_instance.stub(:search).and_yield(@entry)
+
+        @result = ''
+        Zlib::GzipWriter.stub(:open).and_yield(@result)
+        Socialcast.stub(:credentials).and_return(YAML.load_file(File.join(File.dirname(__FILE__), 'fixtures', 'credentials.yml')))
+        Socialcast::CLI.any_instance.should_receive(:load_configuration).with('/my/path/to/ldap.yml').and_return(YAML.load_file(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)
+        RestClient::Resource.any_instance.stub(:post)
+
+        Socialcast::CLI.start ['provision', '-c', '/my/path/to/ldap.yml', '--plugins', [File.join(File.dirname(__FILE__), 'fixtures', 'fake_attribute_map')]]
+      end
+      it 'successfully processes' do end # see expectations
+    end
     context 'with ldap.yml configuration excluding permission_mappings' do
       before do
         @entry = Net::LDAP::Entry.new("dc=example,dc=com")

data/spec/fixtures/fake_attribute_map.rb

@@ -0,0 +1,7 @@
+module Socialcast
+  class FakeAttributeMap
+    def self.run(entry)
+      return "#{entry[:mail].first.gsub(/a/,'b')}"
+    end
+  end
+end

data/spec/net_ldap_ext_spec.rb

@@ -18,4 +18,90 @@ describe Net::LDAP::Entry do
       end
     end
   end
+  describe "#grab" do
+    context "passed hash for attribute" do
+      subject {
+        entry = Net::LDAP::Entry.new("cn=sean,dc=example,dc=com")
+        entry[:mail] = 'sean@example.com'
+        entry
+      }
+      it "returns a string that used defined string template" do
+        subject.grab({"value" => "123%{mail}", "mail" => "mail"}).should == "123sean@example.com"
+      end
+    end
+    context "passed string for attribute" do
+      subject {
+        entry = Net::LDAP::Entry.new("cn=sean,dc=example,dc=com")
+        entry[:mail] = 'sean@example.com'
+        entry
+      }
+      it "returns exact string stored in entry" do
+        subject.grab("mail").should == "sean@example.com"
+      end
+    end
+    context "passed string that can be constantized and the resulting Class responds to run" do
+      subject {
+        entry = Net::LDAP::Entry.new("cn=sean,dc=example,dc=com")
+        entry[:mail] = 'sean@example.com'
+        entry
+      }
+      it "returns result of run method" do
+        module Socialcast
+          class FakeAttributeMap
+            def self.run(entry)
+              return "#{entry[:mail].first.gsub(/a/,'b')}"
+            end
+          end
+        end
+        subject.grab("Socialcast::FakeAttributeMap").should == "sebn@exbmple.com"
+      end
+    end
+    context "passed string that must be classified and the resulting Class responds to run" do
+      subject {
+        entry = Net::LDAP::Entry.new("cn=sean,dc=example,dc=com")
+        entry[:mail] = 'sean@example.com'
+        entry
+      }
+      it "returns result of run method" do
+        module Socialcast
+          class FakeAttributeMap
+            def self.run(entry)
+              return "#{entry[:mail].first.gsub(/a/,'b')}"
+            end
+          end
+        end
+        subject.grab("socialcast/fake_attribute_map").should == "sebn@exbmple.com"
+      end
+    end
+    context "attribute passed has a collision between string and Class" do
+      subject {
+        entry = Net::LDAP::Entry.new("cn=sean,dc=example,dc=com")
+        entry[:mail] = 'sean@example.com'
+        entry
+      }
+      it "returns the result of the Class run method" do
+        class Mail
+          def self.run(entry)
+            return "#{entry[:mail].first.gsub(/a/,'b')}"
+          end
+        end
+        subject.grab("mail").should == "sebn@exbmple.com"
+      end
+    end
+    context "attribute passed constantizes to a module instead of a class" do
+      subject {
+        entry = Net::LDAP::Entry.new("cn=sean,dc=example,dc=com")
+        entry[:mail] = 'sean@example.com'
+        entry
+      }
+      it "returns the result of the Module run method" do
+        module FakeAttributeMap
+          def self.run(entry)
+            return "#{entry[:mail].first.gsub(/a/,'b')}"
+          end
+        end
+        subject.grab("FakeAttributeMap").should == "sebn@exbmple.com"
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socialcast
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2159242000 !ruby/object:Gem::Requirement
+  requirement: &2159242780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2159242000
+  version_requirements: *2159242780
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2159241000 !ruby/object:Gem::Requirement
+  requirement: &2159241780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *2159241000
+  version_requirements: *2159241780
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2159240520 !ruby/object:Gem::Requirement
+  requirement: &2159241300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *2159240520
+  version_requirements: *2159241300
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &2159240060 !ruby/object:Gem::Requirement
+  requirement: &2159240840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 1.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *2159240060
+  version_requirements: *2159240840
 - !ruby/object:Gem::Dependency
   name: socialcast-net-ldap
-  requirement: &2159239420 !ruby/object:Gem::Requirement
+  requirement: &2159240200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 0.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *2159239420
+  version_requirements: *2159240200
 - !ruby/object:Gem::Dependency
   name: activeresource
-  requirement: &2159238740 !ruby/object:Gem::Requirement
+  requirement: &2159239520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.3.11
   type: :runtime
   prerelease: false
-  version_requirements: *2159238740
+  version_requirements: *2159239520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2159238080 !ruby/object:Gem::Requirement
+  requirement: &2159238860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *2159238080
+  version_requirements: *2159238860
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2159237620 !ruby/object:Gem::Requirement
+  requirement: &2159238400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: 1.7.7
   type: :development
   prerelease: false
-  version_requirements: *2159237620
+  version_requirements: *2159238400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2159237160 !ruby/object:Gem::Requirement
+  requirement: &2159237940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -110,7 +110,7 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *2159237160
+  version_requirements: *2159237940
 description: publish messages to your stream from a command line interface
 email:
 - ryan@socialcast.com
@@ -142,6 +142,7 @@ files:
 - spec/cli_spec.rb
 - spec/fixtures/credentials.yml
 - spec/fixtures/credentials_with_proxy.yml
+- spec/fixtures/fake_attribute_map.rb
 - spec/fixtures/ldap.yml
 - spec/fixtures/ldap_with_array_permission_mapping.yml
 - spec/fixtures/ldap_with_interpolated_values.yml
@@ -177,6 +178,7 @@ test_files:
 - spec/cli_spec.rb
 - spec/fixtures/credentials.yml
 - spec/fixtures/credentials_with_proxy.yml
+- spec/fixtures/fake_attribute_map.rb
 - spec/fixtures/ldap.yml
 - spec/fixtures/ldap_with_array_permission_mapping.yml
 - spec/fixtures/ldap_with_interpolated_values.yml