equitrac-utilities 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0545997f5d66d764be64790d11a9459e0f8f419eae60a339334259823c1eb14
+  data.tar.gz: 01ea34bfe90b5f9fdd26f0913a9626bbef74aea3eaf190ff616897df99ab22ec
+SHA512:
+  metadata.gz: 0c5cc9b79ae95b6266e24ac138f9dfc92de44137e329eb5773d00485896edbd4a7a0e1f1b56acc48bb0c41f609ceb9a54d5a29e79570ce87b2a5ed09f349741d
+  data.tar.gz: 586dd27ab6253e76e84227459481075ffa274ae62a2f9565245ec7f1d71f23cfcf52ed39ea488d1b09a716fea8302a9a67dc8425727d00b2bb045540fd13cbeb

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+#/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+/*.gem
+*.DS_Store
+.rbenv-vars
+/examples/users.yml
+/examples/server.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in equitrac-utilities.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    equitrac-utilities (0.1.0)
+      net-ssh (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codacy-coverage (1.1.8)
+      simplecov
+    docile (1.1.5)
+    json (2.1.0)
+    minitest (5.11.3)
+    net-ssh (4.2.0)
+    rake (12.3.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  codacy-coverage (~> 1.1)
+  equitrac-utilities!
+  minitest (~> 5.0)
+  rake (~> 12.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Elliott Hebert
+
+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,98 @@
+# Equitrac::Utilities
+
+[![Build Status](https://travis-ci.org/LAS-IT/equitrac-utilities.svg?branch=master)](https://travis-ci.org/LAS-IT/equitrac-utilities)  [![Dependency Status](https://beta.gemnasium.com/badges/github.com/LAS-IT/equitrac-utilities.svg)](https://beta.gemnasium.com/projects/github.com/LAS-IT/equitrac-utilities)  [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3d1bbe096fe34e3c8785cd6fb2af103c)](https://www.codacy.com/app/btihen/equitrac-utilities?utm_source=github.com&utm_medium=referral&utm_content=LAS-IT/equitrac-utilities&utm_campaign=Badge_Grade)  [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/3d1bbe096fe34e3c8785cd6fb2af103c)](https://www.codacy.com/app/btihen/equitrac-utilities?utm_source=github.com&utm_medium=referral&utm_content=LAS-IT/equitrac-utilities&utm_campaign=Badge_Coverage)  [![BCH compliance](https://bettercodehub.com/edge/badge/LAS-IT/equitrac-utilities?branch=master)](https://bettercodehub.com/)
+
+Equitrac utilities help you run any EQCmd command within ruby. It use SSH by default so make sure you windows server is setup for ssh.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'equitrac-utilities'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install equitrac-utilities
+
+## Usage
+
+### Initialize server object
+
+```ruby
+require 'equitrac-utilities'
+
+# With variables
+server = Equitrac::Server.new "host.exemple.com", "admin", "server-name", "password"
+
+# OR with environment variables
+
+ENV['EQUITRAC_HOST'] = "host.exemple.com"
+ENV['EQUITRAC_USER'] = "admin"
+ENV['EQUITRAC_SERVICE_NAME'] = "server-name"
+ENV['EQUITRAC_HOST_PASSWORD'] = "password"
+
+server = Equitrac::Server.new
+```
+
+if you want to use key based authentication just ignore the password.
+
+### Generate add user command
+
+```ruby
+
+min_user_params = {
+  user_id: "jdoe",
+  init_bal: 50.0,
+  user_name: "John DOE",
+  email: "jdoe@exemple.com",
+  dept_name: "employee",
+  primary_pin: 0420,
+}
+
+cmd = Equitrac::Utilities::User.add( min_user_params )
+
+```
+
+### Execute command
+
+```ruby
+  # with key authentication do:
+
+  # server object = Equitrac::Server.new "host.exemple.com", "admin", "server-name"
+  server.execute(cmd)
+
+  # if the password is define in the object, it will be included automatically into the options.
+  # server object = Equitrac::Server.new "host.exemple.com", "admin", "server-name", "password"
+  server.execute(cmd, {verify_host_key: false})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org).
+
+## Test
+
+using:
+```
+rake test TEST=test/equitrac/*
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/las-it/equitrac-utilities.
+
+Pull requests need tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+All rights on Equitract are owned by [Nuance Communications, Inc.](https://www.nuance.com/index.html)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "equitrac/utilities"
+require "equitrac/server"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/equitrac-utilities.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "equitrac/utilities/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "equitrac-utilities"
+  spec.version       = Equitrac::Utilities::VERSION
+  spec.authors       = ["Elliott Hebert", "Bill Tihen"]
+  spec.email         = ["ehebert@las.ch", "btihen@gmail.com", "btihen@las.ch"]
+
+  spec.summary       = "A gem to interact with equitrac 5.6"
+  spec.description   = "equitrac"
+  spec.homepage      = "https://github.com/las-it/equitrac-utilities"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "net-ssh", "~> 4.0"
+
+  spec.add_development_dependency 'codacy-coverage', '~> 1.1'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/examples/create_users.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby -w
+
+require 'equitrac/utilities'
+require 'equitrac/server'
+require 'yaml'
+
+# SERVER #
+##########
+srv_file   = 'server-sample.yml'           if File.file?('server-sample.yml')
+srv_file   = 'server.yml'                  if File.file?('server.yml') # real
+srv_file ||= nil
+#
+srv_info   = nil
+begin
+  srv_info = YAML.load_file(srv_file)
+rescue ArgumentError => e
+  puts "YAML Error: #{e.message}"
+end                                    unless srv_file.nil?
+srv_info    = YAML.load_file(srv_file) unless srv_file.nil?
+srv_info  ||= { hostname: 'equitrac.example.com', # remote server hostname
+                username: 'remote',               # remote login username
+                eq_service: 'eq56',               # equitrac SERVICE name
+              }
+# File.write("server-sample.yml",srv_info.to_yaml)
+puts "\nSRV_INFO: #{srv_info}"
+
+server  = Equitrac::Server.new( srv_info[:hostname],
+                                srv_info[:username],
+                                srv_info[:eq_service]
+                              )        unless srv_info.nil?
+# USERS #
+#########
+users_file = 'users-sample.yml'            if File.file?('users-sample.yml')
+users_file = 'users.yml'                   if File.file?('users.yml') # real
+users_file ||= nil
+#
+users = nil
+begin
+  users  = YAML.load( File.open(users_file) )
+rescue ArgumentError => e
+  puts "YAML Error: #{e.message}"
+end                                    unless users_file.nil?
+# srv_info   = YAML.load_file(users_file) unless users_file.nil?
+# users ||= [
+#             { primary_pin: 12345,
+#               user_id: "username1",
+#               email: "username1@examle.com",
+#               user_name: "FirstName1 LastName1",
+#               dept_name: 'employee',
+#             }
+#           ]
+# File.write("users-sample.yml",users.to_yaml)
+puts "\nUSERS:"
+pp users
+
+# CREATE #
+##########
+puts "\nEQ56 Commands:"
+users.each do |person|
+  person[:init_bal] = 50.0
+  cmd = Equitrac::Utilities::User.add( person )
+  puts cmd
+  puts server.execute(cmd)
+end                                    unless users.nil?

data/examples/server-sample.yml

@@ -0,0 +1,4 @@
+---
+:hostname: equitrac.example.com
+:username: remote
+:eq_service: eq56

data/examples/users-sample.yml

@@ -0,0 +1,11 @@
+---
+- :primary_pin: 12345
+  :user_id: username1
+  :email: username1@examle.com
+  :user_name: FirstName1 LastName1
+  :dept_name: employee
+- :primary_pin: 23456
+  :user_id: username2
+  :email: username2@examle.com
+  :user_name: FirstName2 LastName1
+  :dept_name: student

data/lib/equitrac/server.rb

@@ -0,0 +1,69 @@
+require 'net/ssh'
+
+module Equitrac
+  # The Equitrac server definition, handling communication with the server.
+  # @since 0.1.0
+  #
+  # @note If the password is define in the object, it will be included automatically into the options.
+  # @note You can also use environment variables to initialize your server.
+  #
+  # @!attribute [r] eqcmd_path
+  #   @return [String] The path where Equitrac utilities is installed
+  # @!attribute [r] service_name
+  #   @return [String] The name of the Equitrac service.
+  class Server
+    attr_reader :service_name, :eqcmd_path
+
+    # @note Host, User and Service name are required
+    # @param host [String] The server hostname.
+    # @param user [String] The user that ssh gonna use.
+    # @param service_name [String] The name of the Equitrac service.
+    # @param host_password [String] The password used for authentification.
+    # @param eqcmd_path [String] The path where Equitrac utilities is installed
+    def initialize(
+        host=ENV['EQUITRAC_HOST'],
+        user=ENV['EQUITRAC_USER'],
+        service_name=ENV['EQUITRAC_SERVICE_NAME'],
+        host_password=ENV['EQUITRAC_HOST_PASSWORD'],
+        eqcmd_path='C:\Program Files\Equitrac\Express\Tools\EQCmd.exe'
+      )
+
+      raise ArgumentError, 'host is missing' if host.nil? or host.empty?
+      raise ArgumentError, 'user is missing' if user.nil? or user.empty?
+      raise ArgumentError, 'service_name is missing' if service_name.nil? or service_name.empty?
+
+      @host = host
+      @user = user
+      @host_password = host_password
+      @service_name = service_name
+      @eqcmd_path = eqcmd_path
+    end
+
+    # Execute a command on the remote server via SSH.
+    #
+    # @param command [String] the command that need to be executed.
+    # @param options [Hash] options for ssh.
+    # @return [String] the result from the ssh command
+    def execute(command, options={})
+      options[:password] = @host_password if @host_password
+      session = Net::SSH.start(@host, @user, options)
+
+      result = session.exec! "#{self.eqcmd_path} -s#{self.service_name} #{command}"
+
+      session.close
+
+      return clean_up_output(result)
+    end
+
+    private
+
+      # Clean return from ssh execution
+      #
+      # @param string [String] the string that need to be clean
+      # @return [String] the clean string
+      def clean_up_output(string)
+        string.gsub("\u0000",'').gsub(/\\/,'')
+      end
+
+  end
+end

data/lib/equitrac/utilities/user.rb

@@ -0,0 +1,43 @@
+module Equitrac
+  module Utilities
+    # User commands for equitrac.
+    # @since 0.1.0
+    module User
+      # Generate the add command for a user.
+      # @param user_id [String] The id of the user.
+      # @param init_bal [Float] The initial balance for the account.
+      # @param user_name [String] The name of the user.
+      # @param min_bal [Float] The minimum balance allowed.
+      # @param email [String] The e-mail of the user.
+      # @param dept_name [String] The department the user is in.
+      # @param primary_pin [String] The primary pin code.
+      # @param secondary_pin [String] The secondary pin code.
+      # @param quota [Integer] The print quota.
+      # @param alternate_pin [String] The alternate pin code.
+      # @param home_server [String] The home server.
+      # @param locked [String] The status of the account 0 = unlocked; 1 = locked.
+      # @param location [String] The user location.
+      # @param additional_info [String] Any additional_info information for the account.
+      # @param home_folder [String] The home folder.
+      #
+      # Default params are:
+      #   min_bal: 1
+      #   secondary_pin: ""
+      #   quota: 0
+      #   alternate_pin: 1
+      #   home_server: ""
+      #   locked: 0
+      #   location: ""
+      #   additional_info: 0
+      #   home_folder:""
+      #
+      # @return [String] The equitrac command to add a user.
+      #
+      def add(user_id:, init_bal:, user_name:, min_bal: 0.0, email:, dept_name:, primary_pin:, secondary_pin: '""', quota: 0, alternate_pin: '""', home_server: '""', locked: 0, location: '""', additional_info: 0, home_folder: '""')
+        return "add ur #{user_id} #{init_bal} \"#{user_name}\" #{min_bal} #{email} #{dept_name} #{primary_pin} #{secondary_pin} #{quota} #{alternate_pin} #{home_server} #{locked} #{location} #{additional_info} #{home_folder}"
+      end
+
+      module_function :add
+    end
+  end
+end

data/lib/equitrac/utilities/version.rb

@@ -0,0 +1,6 @@
+module Equitrac
+  module Utilities
+    # The version number.
+    VERSION = "0.1.0"
+  end
+end

data/lib/equitrac/utilities.rb

@@ -0,0 +1,10 @@
+require "equitrac/utilities/version"
+require "equitrac/utilities/user"
+
+# Namespace for classes and modules that handle Equitrac commands and execution.
+module Equitrac
+  # Namespace for classes and modules that generate Equitrac commands.
+  module Utilities
+
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: equitrac-utilities
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elliott Hebert
+- Bill Tihen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-06 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: codacy-coverage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: equitrac
+email:
+- ehebert@las.ch
+- btihen@gmail.com
+- btihen@las.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- equitrac-utilities.gemspec
+- examples/create_users.rb
+- examples/server-sample.yml
+- examples/users-sample.yml
+- lib/equitrac/server.rb
+- lib/equitrac/utilities.rb
+- lib/equitrac/utilities/user.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.4
+signing_key: 
+specification_version: 4
+summary: A gem to interact with equitrac 5.6
+test_files: []