equitrac_utilities 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88383c0054aff33d3e6c0721086e3958b83caa850c4a35618f6731ea825e8465
-  data.tar.gz: 13e974e458f10d5d223004e9f6b2f99fff0b79576d3037f0b1bbc152ed30ca2d
+  metadata.gz: 52ae01d71a54e67378d87b11a652a4049d5f51e1631a1daf61fc312a2b5dce1d
+  data.tar.gz: 237bc1a155e3f92aecb0eac93e1362186257621953b9b7b4d1aea1dc2e3a4bd9
 SHA512:
-  metadata.gz: d53040ec3c9dc6f227af7f7a302e617f289e2ef658fd495b1914cd3ef4ee19d99784cf17d19c5b5210ab475da824dde1d0086754060447fc6c18f17a4d7fbbf2
-  data.tar.gz: a89096a49465fe5dabb9a339b3dc6d2c9de08f23004f6e7f6fe505514c4f7bd62d28c42946b4cb7945226a70988e5811819b9c2954439ecb91721b4e2070e77b
+  metadata.gz: c8726000b99ac7de2d1c2a62049f882af02bfb09d2abccfd0c691deb4c08d53553d7edd6235daab814b09d5b03975613e427cf5c0eb1ad38e94bd60387e5affb
+  data.tar.gz: e48929ad346cf4015dcdd774deafa0b7327899a3cc183bdf92da9a28ba957fed9b9d6af3760105e35ab623bbe94fcd36af8472b5fcaddfc0c7aaf4e58cef3daa

data/lib/equitrac_utilities/connection.rb

@@ -38,7 +38,8 @@ module EquitracUtilities
     def run(command:, attributes:)
       result = ''
       begin
-        action   = send(:check_user_id, command, attributes)
+        action   = send(command, attributes)
+        # action   = send(:check_user_id, command, attributes)
         ssh_cmd  = build_full_command(action)
         response = send_eqcmd(ssh_cmd)
         result   = post_processing(command, response)
@@ -78,8 +79,14 @@ module EquitracUtilities
     end
 
     def post_processing(command, answer)
-      return process_user_exists?(answer) if command.eql? :user_exists?
-      answer
+      # return process_user_exists?(answer) if command.eql? :user_exists?
+      if command.eql? :user_exists?
+        return false if answer.include?("Can't find")
+        return true  if answer.include?("User_ID")
+        raise
+      end
+      # error_count = answer.count { |r| r.include? 'Error' }
+      return answer
     end
 
     def defaults

data/lib/equitrac_utilities/user_actions.rb

@@ -4,25 +4,53 @@ module EquitracUtilities
   module UserActions
 
 
+    # # Be sure Actions have correct user_id data
+    # #
+    # # @param action [Symbol] the action to be formatted
+    # # @return [String] this attribute MUST include: { user_id: "userid" }
+    # def check_user_id(action, attribs)
+    #   # attribs[:uid] = attribs[:uid].to_s.strip
+    #   attribs[:user_id] = attribs[:user_id]&.strip
+    #   answer = send(action, attribs)
+    #   raise ArgumentError, "missing user_id"   if attribs[:user_id].nil? or
+    #                                               attribs[:user_id].empty?
+    #   raise ArgumentError, "user_id has space" if attribs[:user_id].include?(' ')
+    #   return answer
+    # end
+
     # Be sure Actions have correct user_id data
     #
     # @param action [Symbol] the action to be formatted
     # @return [String] this attribute MUST include: { user_id: "userid" }
-    def check_user_id(action, attribs)
-      attribs[:user_id] = attribs[:user_id]&.strip
-      answer = send(action, attribs)
-      raise ArgumentError, "missing user_id"   if attribs[:user_id].nil? or
-                                                  attribs[:user_id].empty?
+    def check_atrribs(attrs, command=nil)
+      raise ArgumentError, "user_id missing"   if attrs[:user_id].nil?
+      # attribs[:uid] = attribs[:uid].to_s.strip
+      attribs = {}
+      attrs.each do |k,v|
+        attribs[k] = v&.strip     if v.is_a? String
+        attribs[k] = v        unless v.is_a? String
+      end
+      # attribs[:user_id] = attribs[:user_id]&.strip
+      # attribs[:user_name] = attribs[:user_name]&.strip
+      # attribs[:email] = attribs[:email]&.strip
+      raise ArgumentError, "user_id empty"     if attribs[:user_id].empty?
       raise ArgumentError, "user_id has space" if attribs[:user_id].include?(' ')
-      return answer
+      if command.eql? :user_add
+        raise ArgumentError, " missing user_name" if attribs[:user_name].nil?
+        raise ArgumentError, " missing email"     if attribs[:email].nil?
+        raise ArgumentError, " missing dept_name" if attribs[:dept_name].nil?
+      end
+      return attribs
     end
 
+
     # Get Equitrac User Info
     #
     # @param attr [Hash] this attribute MUST include: { user_id: "userid" }
     # @return [String] Formatted for EQCmd.exe command execution
-    def user_query(attr)
-      "query ur #{attr[:user_id]}"
+    def user_query(attribs)
+      attribs = check_atrribs(attribs)
+      "query ur #{attribs[:user_id]}"
     end
 
     # Query to test if user exists in Equitrac System
@@ -30,8 +58,9 @@ module EquitracUtilities
     #
     # @param attr [Hash] this attribute MUST include: { user_id: "userid" }
     # @return [String] Formatted for EQCmd.exe command execution
-    def user_exists?(attr)
-      user_query(attr)
+    def user_exists?(attribs)
+      attribs = check_atrribs(attribs)
+      user_query(attribs)
     end
 
     # Process to test if user exists in Equitrac System
@@ -49,59 +78,82 @@ module EquitracUtilities
     #
     # @param attributes [Hash] this attribute MUST include { user_id: "userid", init_bal: 0, username: "Test USER", dept_name: "Testdept", primary_pin: "99999"}
     # @return [String] Formatted for EQCmd.exe command execution
-    def user_add(attributes)
-      defaults = { min_bal: 0.0, secondary_pin: '""',quota: 0,
-                  alternate_pin: '""', home_server: '""', locked: 0,
-                  location: '""', additional_info: 0, home_folder: '""'}
-      attr = defaults.merge( attributes )
-
-      "add ur #{attr[:user_id]} #{attr[:init_bal]} \"#{attr[:user_name]}\" " +
-      "#{attr[:min_bal]} #{attr[:email]} #{attr[:dept_name]}" +
-      " #{attr[:primary_pin]} #{attr[:secondary_pin]} #{attr[:quota]}" +
-      " #{attr[:alternate_pin]} #{attr[:home_server]} #{attr[:locked]}" +
-      " #{attr[:location]} #{attr[:additional_info]} #{attr[:home_folder]}"
+    def user_add(attribs)
+      defaults   = {init_bal: 50.0, min_bal: 0.0, secondary_pin: '""',quota: 0,
+                    alternate_pin: '""', home_server: '""', locked: 0,
+                    location: '""', additional_info: 0, home_folder: '""'}
+      attribs = defaults.merge( attribs )
+
+      attribs = check_atrribs(attribs, :user_add)
+
+      "add ur #{attribs[:user_id]} #{attribs[:init_bal]}" +
+      " \"#{attribs[:user_name]}\" #{attribs[:min_bal]}" +
+      " #{attribs[:email]} #{attribs[:dept_name]}" +
+      " #{attribs[:primary_pin]} #{attribs[:secondary_pin]}" +
+      " #{attribs[:quota]} #{attribs[:alternate_pin]}" +
+      " #{attribs[:home_server]} #{attribs[:locked]}" +
+      " #{attribs[:location]} #{attribs[:additional_info]}" +
+      " #{attribs[:home_folder]}"
     end
 
     # Process to delete a user from the Equitrac System
     #
     # @param attr [Hash] this attribute MUST include: { user_id: "userid" }
     # @return [String] Formatted for EQCmd.exe command execution
-    def user_delete(attr)
-      "delete ur #{attr[:user_id]}"
+    def user_delete(attribs)
+      attribs = check_atrribs(attribs)
+      "delete ur #{attribs[:user_id]}"
     end
 
     # Process to lock a user in the Equitrac System
     #
     # @param attr [Hash] this attribute MUST include: { user_id: "userid" }
     # @return [String] Formatted for EQCmd.exe command execution
-    def user_lock(attr)
-      "lock ur #{attr[:user_id]}"
+    def user_lock(attribs)
+      attribs = check_atrribs(attribs)
+      "lock ur #{attribs[:user_id]}"
     end
 
     # Process to unlock a user in the Equitrac System
     #
     # @param attr [Hash] this attribute MUST include: { user_id: "userid" }
     # @return [String] Formatted for EQCmd.exe command execution
-    def user_unlock(attr)
-      "unlock ur #{attr[:user_id]}"
+    def user_unlock(attribs)
+      attribs = check_atrribs(attribs)
+      "unlock ur #{attribs[:user_id]}"
     end
 
     # Process to lock a user in the Equitrac System
     #
     # @param attr [Hash] this attribute MUST include: { user_id: "userid" }
     # @return [String] Formatted for EQCmd.exe command execution
-    def user_modify(attributes)
+    def user_modify(attribs)
       defaults = {user_name: "!", min_bal: "!",
                   email: "!", dept_name: "!", pimary_pin: "!",
                   secondary_pin: "!", quota: "!", alternate_pin: "!",
                   home_server: "!", locked: "!", location: "!",
                   default_bc: "!", additional_info: "!", home_folder: "!"}
-      attr = defaults.merge( attributes )
-      "modify ur #{attr[:user_id]} \"#{attr[:user_name]}\" #{attr[:min_bal]}" +
-      " #{attr[:email]} #{attr[:dept_name]} #{attr[:primary_pin]}" +
-      " #{attr[:secondary_pin]} #{attr[:quota]} #{attr[:alternate_pin]}" +
-      " #{attr[:home_server]} #{attr[:locked]} #{attr[:location]}" +
-      " #{attr[:default_bc]} #{attr[:additional_info]} #{attr[:home_folder]}"
+      attribs = defaults.merge(attribs)
+      attribs = check_atrribs(attribs)
+      "modify ur #{attribs[:user_id]} \"#{attribs[:user_name]}\"" +
+      " #{attribs[:min_bal]} #{attribs[:email]} #{attribs[:dept_name]}" +
+      " #{attribs[:primary_pin]} #{attribs[:secondary_pin]}" +
+      " #{attribs[:quota]} #{attribs[:alternate_pin]}" +
+      " #{attribs[:home_server]} #{attribs[:locked]}" +
+      " #{attribs[:location]} #{attribs[:default_bc]}" +
+      " #{attribs[:additional_info]} #{attribs[:home_folder]}"
+    end
+
+    # Process to set a new balance for a user in the Equitrac System
+    #
+    # @param attr [Hash] this attribute MUST include: { user_id: "userid" }
+    # @note attr new_bal defaults to 0, if not included in the attributes
+    # @return [String] Formatted for EQCmd.exe command execution
+    def user_adjust_set(attribs)
+      defaults = {new_bal: 0.0, description: nil}
+      attribs = defaults.merge(attribs)
+      attribs = check_atrribs(attribs)
+      "adjust ur #{attribs[:user_id]} set #{attribs[:new_bal]} #{attribs[:description]}"
     end
   end
 end

data/lib/equitrac_utilities/version.rb

@@ -1,5 +1,5 @@
 module EquitracUtilities
   module Version
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: equitrac_utilities
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Bill Tihen
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -46,28 +46,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
 description: uses ssh to connect to an Equitrac server and send user commands
 email:
 - btihen@gmail.com