open_directory_utils 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7106cdd8914ddba15d1bc47057fdbeeac167d9e8d4d89b3af6f9e03675afde9
-  data.tar.gz: 830a9e225de96ed0bb0bbca72856780b23e90b1d1b6dd0ac0ba68e4f22dc9960
+  metadata.gz: 6de1c571a212c010b912433a24f7a277e07c5744f65af17d9384671fd70d48ad
+  data.tar.gz: fc5069610163e65864a51579d095fc58cef7f4a9b6120f69013fd6a4e6ba95e7
 SHA512:
-  metadata.gz: '0941277d11e98e26ab6a6a06e1d7e13acf745e1d91ac595437ccdd69f7a754a300eec60aa5457da622dabc208cd001ac4bcb2ba9ed4123f7626d6ae20d33b8f9'
-  data.tar.gz: f93fb2bf7fed1c375732020193b3884b7944f1c4cabdd010ec50d188c7b69611455a843c659852cd6841527699657b814d72f7c5cc2769b6c78f4ca18fb5d232
+  metadata.gz: 6a12c8b2e7c1fc858d82a7b144332255fea5acca0c835d45b962fa9f4a8a7d16b741dc429851e40dcc535cda7f0dfe2403399972695f7c4e126d2e5253894005
+  data.tar.gz: 01217a3e336327a79a436c13701faa1d0e73bcd828416da3108f19203de68f259f8166868fc72d2fc1641a857bad2466b8572754bf6e3eebf6363ea0d12b1c6f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_directory_utils (0.1.5)
+    open_directory_utils (0.1.7)
       net-ssh (~> 4.2)
 
 GEM
@@ -34,4 +34,4 @@ DEPENDENCIES
   rspec (~> 3.7)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -7,13 +7,25 @@ One can also build custom DSCL commands and send them to the server as needed to
 
 ## Change Log
 
-* **v0.1.6** - 2018-06-14 - 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
+* **v0.1.8** - 2018-06-??
+- remove attribs[:value] side effect (return original attribs - always)
+* **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
+* **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)

data/examples/create_od_users.rb

@@ -31,7 +31,7 @@ ensure
   pp users
 end
 
-make   = false
+make_accts   = false
 puts "Review the user data \nEnter 'Y' to create od accounts\n  (otherwise you see a dry run)"
 answer = gets.chomp.downcase
 if answer.eql? 'y'

data/examples/relations.yml

@@ -0,0 +1,48 @@
+---
+# preferred with first name, last name, email and group membership
+# by default account is disabled unless enabled: true is present
+- :user_name: barrutp220
+  :relations: 511541
+# - :user_name: albuerl430
+#   :relations: 557430
+# - :user_name: rogersl264
+#   :relations: 558264
+# - :user_name: miklauc283
+#   :relations: 558283
+# - :user_name: portilc119
+#   :relations: 559119
+# - :user_name: aguilax190
+#   :relations: 559190
+# - :user_name: gonzalm208
+#   :relations: 559208
+#
+#  milesm866  | 564866
+#  galvanj568 | 565568
+#  tiradob869 | 565869
+#  changt870  | 566870
+#  nohm396    | 570396
+#  grigoli979 | 571979
+#  bedoyac063 | 573063
+#  mariglm633 | 575633
+#  yudinm437  | 576437
+#  fijogai896 | 577896
+#  zunzunj443 | 579443
+#  zhouw300   | 583300
+#  canavej018 | 585018
+#  xuz906     | 588906
+#  benetor857 | 590857
+#  flaskaa617 | 592617
+#  berengd044 | 593044
+#  guow690    | 593690
+#  lacerdm840 | 593840
+#  mussina201 | 599201
+#  binzegj915 | 599915
+#  borowyk252 | 600252
+#  mussina288 | 600288
+#  linj671    | 603671
+#  rizoorm894 | 603894
+#  gonzalg934 | 603934
+#  pieribe687 | 611687
+#  shukshm297 | 615297
+#  elizarf803 | 622803
+#  zuoj861    | 602861

data/examples/update_relationship.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby -w
+
+require 'yaml'
+require 'open_directory_utils'
+
+# setup server connection
+srv_info = {}
+begin
+  srv_info = YAML.load_file( File.open('connection.yml') )
+rescue Errno::ENOENT, LoadError, Psych::Error, Psych::SyntaxError
+  srv_info = {srv_hostname: 'od.example.com', srv_username: 'odsshlogin',
+              dir_username: 'diradmin', dir_password: 'T0p-S3cret' }
+end
+
+od = OpenDirectoryUtils::Connection.new( srv_info )
+puts "\nSERVER SETTINGS:"
+pp od
+
+
+# get users
+users = []
+begin
+  users  = YAML.load( File.open('relations.yml') )
+rescue Errno::ENOENT, LoadError, Psych::SyntaxError, YAML::Error
+  users = [
+    {username: 'odtest1', usernumber: '87654321', primary_group_id: 1031},
+    {username: 'odtest2', usernumber: '87654322', primary_group_id: 1031},
+  ]
+ensure
+  pp "USERS:"
+  pp users
+end
+
+make_accts   = false
+puts "Review the user data \nEnter 'Y' to create od accounts\n  (otherwise you see a dry run)"
+answer = gets.chomp.downcase
+if answer.eql? 'y'
+  make_accts = true
+end
+
+# create accounts
+puts "\nCreating OD Accounts:"
+Array(users).each do |person|
+  # show commands
+  pp od.send(:user_set_relationships, person, od.dir_info)
+  # Make Account
+  pp od.run(command: :user_set_relationships, params: person )  if make_accts.eql? true
+end

data/lib/open_directory_utils/clean_check.rb

@@ -16,16 +16,16 @@ module OpenDirectoryUtils
       assert{not attrib[key].eql? '{}'}
       assert{not attrib[key].include? ' '} if key.eql? :scope
       assert{not attrib[key].include? ' '} if [:uid, :username, :record_name].include? key
-      rescue NoMethodError, ArgumentError => error
+      rescue NoMethodError, ArgumentError # => error
         message  = "#{key}: '#{attrib[key].inspect}' invalid"
         message += ", value_name: :#{value}"  unless value.nil?
         raise ArgumentError, message
     end
 
     def tidy_attribs(attribs)
-      user_attrs = {}
-      attribs.each{ |k,v| user_attrs[k] = v.to_s.strip }
-      return user_attrs
+      user_attribs = {}
+      attribs.each{ |k,v| user_attribs[k] = v.to_s.strip }
+      return user_attribs
     end
 
     def user_record_name_alternatives(attribs)

data/lib/open_directory_utils/commands_base.rb

@@ -45,17 +45,18 @@ module OpenDirectoryUtils
     end
 
     # /usr/bin/pwpolicy -a diradmin -p "BigSecret" -u username -setpolicy "isDisabled=0"
-    def build_pwpolicy_command(params, dir_info)
+    def build_pwpolicy_command(attribs, dir_info)
       ans  = %Q[#{dir_info[:pwpol]}]
       ans += %Q[ -a #{dir_info[:username]}]    unless dir_info[:username].nil? or
                                                       dir_info[:username].empty?
       ans += %Q[ -p "#{dir_info[:password]}"]  unless dir_info[:password].nil? or
                                                       dir_info[:password].empty?
       ans += %Q[ -n #{dir_info[:data_path]}]
-      ans += %Q[ -u #{params[:record_name]}]
-      ans += %Q[ -#{params[:attribute]}]
-      ans += %Q[ "#{params[:value]}"]          unless params[:value].nil? or
-                                                      params[:value].empty?
+      ans += %Q[ -u #{attribs[:record_name]}]
+      ans += %Q[ -#{attribs[:attribute]}]
+      ans += %Q[ "#{attribs[:value]}"]         unless attribs[:value].nil? or
+                                                      attribs[:value].empty?
+      attribs[:value] = nil
       return ans
     end
 
@@ -86,6 +87,7 @@ module OpenDirectoryUtils
                                                       attribs[:attribute].empty?
       ans += %Q[ "#{attribs[:value]}"]         unless attribs[:value].nil? or
                                                       attribs[:value].empty?
+      attribs[:value] = nil
       return ans
     end
 
@@ -119,6 +121,8 @@ module OpenDirectoryUtils
         ans += %Q[ -t #{params[:type]}]            # type can be user or group
       end
       ans += %Q[ #{params[:value]}]   # the group to be manipulated
+      params[:value] = nil
+      return ans
     end
 
   end

data/lib/open_directory_utils/{commands_group_create_remove.rb → commands_groups.rb}

@@ -8,7 +8,7 @@ module OpenDirectoryUtils
   # @note - these commands were derived from the following resrouces:
   # * http://krypted.com/mac-os-x/create-groups-using-dscl/
   # * https://apple.stackexchange.com/questions/307173/creating-a-group-via-users-groups-in-command-line?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
-  module CommandsGroupCreateRemove
+  module CommandsGroups
 
     # include OpenDirectoryUtils::Dscl
     include OpenDirectoryUtils::CleanCheck
@@ -44,7 +44,7 @@ module OpenDirectoryUtils
       # pp attribs
 
       attribs    = group_record_name_alternatives(attribs)
-      groupname  = attribs[:record_name]
+      # groupname  = attribs[:record_name]
       attribs[:value] = username
       # pp attribs
 
@@ -58,26 +58,6 @@ module OpenDirectoryUtils
       dscl( cmd_attribs, dir_info )
     end
 
-    # def user_remove_from_group(attribs, dir_info)
-    #   attribs = user_record_name_alternatives(attribs)
-    #
-    #   attribs[:value] = attribs[:group_membership]
-    #   attribs[:value] = attribs[:value] || attribs[:groupmembership]
-    #   attribs[:value] = attribs[:value] || attribs[:group_name]
-    #   attribs[:value] = attribs[:value] || attribs[:groupname]
-    #   attribs[:value] = attribs[:value] || attribs[:gid]
-    #
-    #   check_critical_attribute( attribs, :record_name, :username )
-    #   check_critical_attribute( attribs, :value, :groupname )
-    #   attribs    = tidy_attribs(attribs)
-    #   command    = { operation: 'edit', action: 'delete', type: 'user'}
-    #   user_attrs  = attribs.merge(command)
-    #
-    #   dseditgroup( user_attrs, dir_info )
-    # end
-    # # module_function :user_remove_from_group
-    # # alias_method :user_remove_group_memebership, :user_remove_from_group
-
     # dscl . -delete /Groups/yourGroupName
     # https://tutorialforlinux.com/2011/09/15/delete-users-and-groups-from-terminal/
     def group_delete(attribs, dir_info)
@@ -143,27 +123,6 @@ module OpenDirectoryUtils
       dscl( user_attrs, dir_info )
     end
 
-    # # probably can't create password for group?
-    # # /usr/bin/dscl -u diradmin -P liaP-meD-Aj-pHi-hOb-en-c /LDAPv3/127.0.0.1 -create /Groups/odgrouptest passwd "*"
-    # #  "<main> attribute status: eDSNoStdMappingAvailable\n" +
-    # #  "<dscl_cmd> DS Error: -14140 (eDSNoStdMappingAvailable)"]
-    # def group_set_passwd(attribs, dir_info)
-    #   attribs = group_record_name_alternatives(attribs)
-    #
-    #   attribs[:value] = attribs[:value] || attribs[:password]
-    #   attribs[:value] = attribs[:value] || attribs[:passwd]
-    #   attribs[:value] = attribs[:value] || '*'
-    #
-    #   check_critical_attribute( attribs, :record_name )
-    #   check_critical_attribute( attribs, :value, :password )
-    #
-    #   command = {action: 'passwd', scope: 'Groups', attribute: nil}
-    #   user_attrs = attribs.merge(command)
-    #
-    #   dscl( user_attrs, dir_info )
-    # end
-    # alias_method :group_set_password, :group_set_passwd
-
     # create group     -- dscl . -create /Groups/ladmins
     # add group passwd -- dscl . -create /Groups/ladmins passwd “*”
     # add group name   -- dscl . -create /Groups/ladmins RealName “Local Admins”