OpenDirectoryUtils

This Gem allows one to build or send pre-built commands to control (common OD and LDAP attributes) on an OpenDirectory server.

One can also build custom DSCL commands and send them to the server as needed too.

• v0.1.12 - 2020-03-05

• update dependencies

• v0.1.11 - 2018-06-28

• add attribute delete method for user

• v0.1.10 - 2018-06-??

• remove attribs[:value] side effect (return original attribs - always)

• v0.1.9 - 2018-06-??

• add address, town, city, state, postal_code, country, weblog and homepage, title, company added to user_create and user_update

• v0.1.8 - 2018-06-19

• added department and keywords to user_create and user_update

• v0.1.7 - 2018-06-19

• add update user method
• fix unused variable warnings
• attributes separated from users_creation_delete_update
• able to create and update accounts with relationships & OrganizationInfo

• v0.1.6 - 2018-06-18

• fixed EMailAddress (was incorrectly EMailAttribute)

• v0.1.5

• 2018-06-14 - add version number to connection for easy checking

• v0.1.4 - 2018-06-13

• changed the return hash to {response: xxx, status: 'success'}

• v0.1.3 - 2018-06-13

• able to sync all fields in typcial OD
• refactored results code (ssh_cmds have redacted passwords)
• finished adding pre-built od commands for users - good for syncing accounts

• v0.1.2 - 2018-06-09

• all user creation features enabled
• user creation will add user to a group if group_name present
• new accounts disabled by default (w/ option to enable on creation)
• now repo includes example code (to create accounts)

• v0.1.1 - 2018-06-06

• refactored to separate OD attribute from LDAP attribute commands (shortened methods and better organization and shorter tests)

• v0.1.0 - 2018-06-06
  • can adjust and delete OD attributes for users and groups (pre-built ldap attributes comming soon)

• Do not return dir admin password with command on errors
• LDAP attributes (so las can sync accounts easily)
• Refactor Process Results
• Test direct commands
• Check Connection Unit Tests
• verify which email address is LDAP (& seen in GUI)

Add this line to your application's Gemfile:

gem 'open_directory_utils'

And then execute:

$ bundle

Or install it yourself as:

$ gem install open_directory_utils

Also see examples to see an example of multiple account creation

require 'open_directory_utils'

# Usually Instantiate using ENV-VARS -
# srv_host_name: ENV['OD_HOSTNAME'],
# srv_user_name: ENV['OD_USERNAME'],
# dir_user_name: ENV['DIR_ADMIN_USER'],
# dir_password: ENV['DIR_ADMIN_PASS'],

# Instantiating using params
od = OpenDirectoryUtils::Connection.new(
        { srv_host_name: 'od_hostname', srv_user_name: 'od_ssh_username',
          dir_user_name: 'directory_admin_username',
          dir_password: 'directory_admin_password'
        }
      )
# see gem version in use
od.version

user_params = { user_name: 'someone', user_number: 9876,
                first_name: 'Someone', last__name: 'Special',
                group_number: 4321,group_name: 'employee',
                mobile_phone: '+41 11 111 11 11'
              }
group_params = {group_name: 'agroup', real_name: 'A Group',
                group_number: 5432
              }
# create a user
od.run( command: :user_create,  params: user_params )

# update user's record (all dscl and ldap fields are available)
od.run( command: :user_set_first_email,
        params: {user_name: 'someone', email: 'someone@example.com'} )
# add a second email address
od.run( command: :user_append_email,
        params: {user_name: 'someone', email: 'second@example.com'} )
# fix spelling of first name
od.run( command: :user_set_first_name,
        params: {user_name: 'someone', first_name: 'John'} )

# get user's record
od.run( command: :user_info,  params: user_params )

# create a group
od.run( command: :group_create_full, params: group_params )

# add the first user to the group
od.run( command: :group_add_first_user,
        params: {user_name: 'someone', group_name: 'agroup'} )
# add additional user to the group
od.run( command: :user_append_to_group,
        params: {user_name: 'existinguser', group_name: 'agroup'} )

# get group record and members inf
od.run( command: :group_info,  params: user_params )

# remove a user from a group
od.run( command: :user_remove_from_group,
        params: {user_name: 'someone', group_name: 'agroup'})
od.run( command: :user_remove_from_group,
        params: {user_name: 'existinguser', group_name: 'agroup'})

# delete a group
od.run( command: :group_delete, params: {group__name: 'agroup'})

# delete an attribute
# requires passing in a user_name to find the user record
# and the name of the attribute you wish to delete
od.run( command: :user_delete_attribute, params: {user_name: 'someone', attribute: 'MobileNumber'})

# delete a user
od.run( command: :user_delete, params: user_params)

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/open_directory_utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the OpenDirectoryUtils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.