equitrac_utilities 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18c56d5baffe1fc3d4fed4283391c508869b24faaa73ad76406211ffc906a166
+  data.tar.gz: f36337e3cecaf50ec47dee44180a69ae5df8cfb51bb233912865c9192af30542
+SHA512:
+  metadata.gz: 3545e140782698895a8671b1c6f343bc3a7a6335e63ced8f80e23be8145df845710c9e063b94feafc9fb23be325462654e1a16626d8383825af91ed79febe167
+  data.tar.gz: b04e946ccdf95b44a6f182519d5bc7ef5fe740e4148b92ba1e546ff9b3aadbe801aa06a4884c6ec7509e5468f90c0de2c759dcf3a9b0c9f6ac568693c919415b

data/lib/equitrac_utilities.rb

@@ -0,0 +1,6 @@
+require "equitrac_utilities/version"
+require "equitrac_utilities/connection"
+
+module EquitracUtilities
+  # Your code goes here...
+end

data/lib/equitrac_utilities/connection.rb

@@ -0,0 +1,93 @@
+require 'net/ssh'
+require 'timeout'
+require 'equitrac_utilities/user_actions'
+
+module EquitracUtilities
+
+  # The EquitracUtilities, makes it east to work with Equitac EQCmd.exe commands
+  # @since 0.1.0
+  #
+  # @note You should use environment variables to initialize your server.
+  class Connection
+
+    attr_reader :hostname, :username, :servicename, :eqcmd_path, :ssh_options
+
+    include EquitracUtilities::UserActions
+
+    # Make connection to the Equitrac server
+    # @note Hostname, Username and Servicename are required
+    # @param params [Hash] The server configuration parameters. Options available `:hostname`, `:username`, `:servicename`, `:eqcmd_path`, `:ssh_options`
+    def initialize(params={})
+      config = defaults.merge(params)
+      @hostname    = config[:hostname]
+      @username    = config[:username]
+      @servicename = config[:servicename]
+      @eqcmd_path  = config[:eqcmd_path]
+      @ssh_options = config[:ssh_options]
+
+      raise ArgumentError, 'hostname missing'    if hostname.nil? or hostname.empty?
+      raise ArgumentError, 'username missing'    if username.nil? or username.empty?
+      raise ArgumentError, 'servicename missing' if servicename.nil? or servicename.empty?
+    end
+
+    # @note Run a command against the Equitrac server
+    #
+    # @param command [Symbol] choose command to perform these include: :user_query, :user_exists? (t/f), :user_add, :user_delete, :user_lock, :user_unlock, :user_modify
+    # @param attributes [Hash] attributes needed to perform command
+    # @return [String] the restult from the ssh command
+    def run(command:, attributes:)
+      unless attributes[:user_id].nil? or attributes[:user_id].empty? or attributes[:user_id].eql? ''
+        # Prep command
+        action  = send(command, attributes)
+        ssh_cmd = build_full_command(action)
+        # Execute command
+        answer = send_eqcmd(ssh_cmd)
+        # Post processing answer
+        return post_processing(command, answer)
+      end
+      return "user_id missing -- #{attributes}"
+    end
+
+    private
+
+    def build_full_command(action)
+      # sample:
+      "#{eqcmd_path} -s#{servicename} #{action}"
+    end
+
+    def send_eqcmd(command)
+      output = nil
+      # quicker timeout config - https://gist.github.com/makaroni4/8792775
+      # Timeout::timeout(10) do
+        Net::SSH.start(hostname, username, ssh_options) do |ssh|
+          # Capture all stderr and stdout output from a remote process
+          output = ssh.exec!(command)
+        end
+      # end
+      # EQ56 returns unicode jibberish & looks like
+      # "C\u0000a\u0000n\u0000'\u0000t\u0000 \u0000f\u0000i\u0000n\u0000d"
+      convert_eq56_unicode_to_ascii(output)
+    end
+
+    # Clean return from ssh execution
+    #
+    # @param string [String] the string that need to be clean
+    # @return [String] the clean string
+    def convert_eq56_unicode_to_ascii(string)
+      string.gsub("\u0000",'').gsub(/\\/,'')
+    end
+
+    def post_processing(command, answer)
+      return process_user_exists?(answer) if command.eql? :user_exists?
+      answer
+    end
+
+    def defaults
+      { hostname: ENV['EQ_HOSTNAME'],
+        username: ENV['EQ_USERNAME'],
+        servicename: ENV['EQ_SERVICENAME'],
+        eqcmd_path: ( ENV['EQ_EQCMD_PATH'] || 'C:\Program Files\Equitrac\Express\Tools\EQCmd.exe' ),
+        ssh_options: (eval(ENV['EQ_SSH_OPTIONS'].to_s) || {}) }
+    end
+  end
+end

data/lib/equitrac_utilities/user_actions.rb

@@ -0,0 +1,93 @@
+module EquitracUtilities
+
+  # @note Equitrac Administration Guide - https://download.equitrac.com/271828/EE5.6/Docs/Administration_Guide.pdf
+  module UserActions
+
+    # 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]}"
+    end
+
+    # Query to test if user exists in Equitrac System
+    # @note This required post-answer_post_processing
+    #
+    # @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)
+    end
+
+    # Process to test if user exists in Equitrac System
+    #
+    # @param test [Hash] this attribute MUST include: { user_id: "userid" }
+    # @return [Boolean] True or False depending on if the user was found or not
+    def process_user_exists?(test)
+      return false if test.include?("Can't find")
+      return true  if test.include?("User_ID")
+      raise
+    end
+
+    # Add a user to the system
+    # @note user_id, initial_balance, user_name, department_name, and primary_pin required
+    #
+    # @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]}"
+    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]}"
+    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]}"
+    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]}"
+    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)
+      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]}"
+    end
+  end
+end

data/lib/equitrac_utilities/version.rb

@@ -0,0 +1,5 @@
+module EquitracUtilities
+  module Version
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: equitrac_utilities
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bill Tihen
+- Lee Weisbecker
+- Elliott Herbert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: uses ssh to connect to an Equitrac server and send user commands
+email:
+- btihen@gmail.com
+- leeweisbecker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/equitrac_utilities.rb
+- lib/equitrac_utilities/connection.rb
+- lib/equitrac_utilities/user_actions.rb
+- lib/equitrac_utilities/version.rb
+homepage: https://github.com/LAS-IT/equitrac_utilities
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Simple ruby wrapper for equitrac user management
+test_files: []