open_directory 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rake"
+# Specify your gem's dependencies in open_directory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mauro Morales
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# OpenDirectory
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'open_directory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_directory
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/open_directory.rb

@@ -0,0 +1,10 @@
+require "net/ssh"
+
+require "open_directory/version"
+require "open_directory/configuration"
+require "open_directory/user"
+require "open_directory/dscl"
+
+module OpenDirectory
+    extend Configuration
+end

data/lib/open_directory/configuration.rb

@@ -0,0 +1,31 @@
+module OpenDirectory
+    module Configuration
+        VALID_OPTIONS_KEYS    = %w(host_name host_username host_password od_username od_password od_datasource).freeze
+
+        HOST_NAME = nil
+        HOST_USERNAME = nil
+        HOST_PASSWORD = nil
+        OD_USERNAME = nil
+        OD_PASSWORD = nil
+        OD_DATASOURCE = '/LDAPv3/127.0.0.1/'
+
+        attr_accessor *VALID_OPTIONS_KEYS
+
+        def self.extended(base)
+            base.reset
+        end
+
+        def reset
+            self.host_name = HOST_NAME
+            self.host_username = HOST_USERNAME
+            self.host_password = HOST_PASSWORD
+            self.od_username = OD_USERNAME
+            self.od_password = OD_PASSWORD
+            self.od_datasource = OD_DATASOURCE
+        end
+
+        def configure
+            yield self
+        end
+    end
+end

data/lib/open_directory/dscl.rb

@@ -0,0 +1,48 @@
+require "plist"
+
+module OpenDirectory
+    class Dscl
+        @@commands = []
+
+        def self.generate(command, path, params="")
+            datasource ||= OpenDirectory.od_datasource
+            params = params.join(" ") unless params.empty?
+            
+            @@commands << "dscl -plist -u #{OpenDirectory.od_username} -P #{OpenDirectory.od_password} #{datasource} -#{command} #{path} #{params}"
+        end
+
+        def self.parse_output(string)
+            begin
+                parsed_xml = Plist::parse_xml( string )
+                if parsed_xml.nil?
+                    string.split("\n")
+                else
+                    parsed_xml
+                end
+            rescue RuntimeError => e
+                string.split("\n")
+            rescue TypeError => e
+                if e.nil?
+                    ""
+                else
+                    e.to_s
+                end
+            end
+        end
+
+        def self.run
+            response = []
+            $ssh ||= Net::SSH.start(OpenDirectory.host_name, OpenDirectory.host_username, :password => OpenDirectory.host_password)
+            @@commands.each do |command|
+                output = $ssh.exec!(command)
+                response << {:parsed_out => parse_output(output), :output => output, :command => command} unless output.nil?
+            end
+            @@commands.clear
+            if response.size == 1
+                response[0][:parsed_out]
+            else
+                response
+            end
+        end
+    end
+end

data/lib/open_directory/user.rb

@@ -0,0 +1,73 @@
+module OpenDirectory
+    class User
+        def self.all
+            Dscl.generate("list","/Users")
+            Dscl.run
+        end
+
+        def self.exists?(username)
+            users = all
+            users.include?(username)
+        end
+
+        def self.read(username, params="")
+            if exists?(username)
+                Dscl.generate("read", "/Users/#{username}",params)
+                Dscl.run
+            else
+                false
+            end
+        end
+
+        def self.auth(username, password)
+            params = [password]
+            Dscl.generate("authonly", username, params)
+            output = Dscl.run
+            if output.empty?
+                true
+            else
+                !output[0].include?("eDSAuthFailed")
+            end
+        end
+
+        def self.create(username, password, params)
+            Dscl.generate("create", "/Users/#{username}")
+            Dscl.generate("passwd", "/Users/#{username}", ["'#{password}'"])
+            Dscl.generate("create", "/Users/#{username}", ["NFSHomeDirectory", "/Users/#{username}"])
+            params.each do |key, value|
+                if key == :Keywords
+                    value.each do |keyword|
+                        Dscl.generate("append", "/Users/#{username}", [key, "'#{keyword}'"])
+                    end
+                else
+                    Dscl.generate("create", "/Users/#{username}", [key, "'#{value}'"])
+                end
+            end
+            Dscl.run
+        end
+
+        def self.delete(username)
+            Dscl.generate("delete", "/Users/#{username}")
+            Dscl.run
+        end
+
+        def self.active?(username)
+            record = read(username, ["AuthenticationAuthority"])
+            !record["dsAttrTypeStandard:AuthenticationAuthority"].include? ";DisabledUser;"
+        end
+
+        def self.disable(username)
+            params = %w(AuthenticationAuthority ';DisabledUser;')
+            Dscl.generate("append", "/Users/#{username}", params)
+            Dscl.run
+        end
+
+        def self.enable(username)
+            response = read(username, ["AuthenticationAuthority"])
+            response["dsAttrTypeStandard:AuthenticationAuthority"].delete(";DisabledUser;")
+            params = ["dsAttrTypeStandard:AuthenticationAuthority", "'" + response["dsAttrTypeStandard:AuthenticationAuthority"].join(" ") + "'"]
+            Dscl.generate("create", "/Users/#{username}", params)
+            Dscl.run
+        end
+    end
+end

data/lib/open_directory/version.rb

@@ -0,0 +1,3 @@
+module OpenDirectory
+  VERSION = "0.0.1"
+end

data/open_directory.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_directory/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "open_directory"
+  gem.version       = OpenDirectory::VERSION
+  gem.authors       = ["Mauro Morales"]
+  gem.email         = ["contact@mauromorales.com"]
+  gem.description   = "Interact with Open Directory"
+  gem.summary       = "Generate dscl commands and run them on OD"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency "plist"
+  gem.add_dependency "net-ssh"
+
+  gem.add_development_dependency "rspec", "~> 2.6"
+end

data/spec/open_directory_spec.rb

@@ -0,0 +1,71 @@
+require 'open_directory'
+
+describe OpenDirectory do
+    before(:all) do
+        OpenDirectory.configure do |config|
+            config.host_name = 'yourhost.com'
+            config.host_username = 'deploy'
+            config.host_password = 'd3pl0y'
+            config.od_username = 'admin'
+            config.od_password = '4dm1n'
+        end
+
+        @username = 'jdoe'
+        @password = 'super5ecret!'
+    end
+
+    it "should list all users" do
+        users = OpenDirectory::User.all
+        users.class.should == Array
+        users.size.should_not == 0
+    end
+
+    it "should create a new user" do
+        params = { :UniqueID => '9999',
+                   :LastName => 'Doe',
+                   :FirstName => 'John',
+                   :EMailAddress => 'jdoe@johndoe.com',
+                   :Keywords => ['test', 'ruby']
+        }
+        OpenDirectory::User.create(@username, @password, params)
+        OpenDirectory::User.exists?(@username).should == true
+    end
+
+    it "should know if a user exists" do
+        OpenDirectory::User.exists?(@username).should == true
+        username = "idontexists"
+        OpenDirectory::User.exists?(username).should == false
+    end
+
+    it "should read an existing user" do
+        record = OpenDirectory::User.read(@username)
+        record["dsAttrTypeStandard:RecordName"][0].should == @username
+        username = "idontexists"
+        OpenDirectory::User.read(username).should == false
+    end
+
+    it "should know if a user is active" do
+        OpenDirectory::User.active?(@username).should == true
+    end
+
+    it "should be able to disable an active user" do
+        OpenDirectory::User.disable(@username)
+        OpenDirectory::User.active?(@username).should_not == true
+    end
+
+    it "should be able to enable an inactive user" do
+        OpenDirectory::User.enable(@username)
+        OpenDirectory::User.active?(@username).should == true
+    end
+
+    it "should check user authentication" do
+        OpenDirectory::User.auth(@username, @password).should == true
+        password = "badpass"
+        OpenDirectory::User.auth(@username, password).should == false
+    end
+
+    it "should delete an existing user" do
+        OpenDirectory::User.delete(@username)
+        OpenDirectory::User.exists?(@username).should == false
+    end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: open_directory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mauro Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Interact with Open Directory
+email:
+- contact@mauromorales.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/open_directory.rb
+- lib/open_directory/configuration.rb
+- lib/open_directory/dscl.rb
+- lib/open_directory/user.rb
+- lib/open_directory/version.rb
+- open_directory.gemspec
+- spec/open_directory_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4132442276101860958
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4132442276101860958
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Generate dscl commands and run them on OD
+test_files:
+- spec/open_directory_spec.rb