equitrac-utilities 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0545997f5d66d764be64790d11a9459e0f8f419eae60a339334259823c1eb14
-  data.tar.gz: 01ea34bfe90b5f9fdd26f0913a9626bbef74aea3eaf190ff616897df99ab22ec
+  metadata.gz: f7f0e1249ce701862a767dc3eb80e99d87ad972b65dd2dc8e4315e123786ad6b
+  data.tar.gz: 036cc0288a6633a616ce86e26f3e1a8a98f3409c445ef5106ddd0a071ab88f15
 SHA512:
-  metadata.gz: 0c5cc9b79ae95b6266e24ac138f9dfc92de44137e329eb5773d00485896edbd4a7a0e1f1b56acc48bb0c41f609ceb9a54d5a29e79570ce87b2a5ed09f349741d
-  data.tar.gz: 586dd27ab6253e76e84227459481075ffa274ae62a2f9565245ec7f1d71f23cfcf52ed39ea488d1b09a716fea8302a9a67dc8425727d00b2bb045540fd13cbeb
+  metadata.gz: 0fe7955ed1561f34150af21ec5d45e7dc43fcb7005abc5aeb27ef7684055b0d36dac9c545e6d3933fbab6b6dea594a1e8bf4bddc5ebbe30e0a39b5975431c761
+  data.tar.gz: 8b8ad70ee6325cb2842a5aae861dbfc10d2a9801f259728713a49ecec14b21d9300ad91c10bf6c52ea680c6fdbaff960d0578afd575a208cbe49be6d5730d2ef

data/.gitignore

@@ -12,4 +12,4 @@
 *.DS_Store
 .rbenv-vars
 /examples/users.yml
-/examples/server.yml
+/examples/connection.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    equitrac-utilities (0.1.0)
+    equitrac-utilities (0.2.0)
       net-ssh (~> 4.0)
 
 GEM
@@ -9,13 +9,13 @@ GEM
   specs:
     codacy-coverage (1.1.8)
       simplecov
-    docile (1.1.5)
+    docile (1.3.0)
     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)
+    rake (12.3.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)

data/README.md

@@ -4,6 +4,13 @@
 
 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.
 
+## CHANGE LOG
+
+* 0.2.0 - not compatible with 0.1.0
+  - rename Server Class to Connection Class be consistent a with a suite of account management gems
+
+* 0.1.0 - initial gem
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,7 +35,7 @@ Or install it yourself as:
 require 'equitrac-utilities'
 
 # With variables
-server = Equitrac::Server.new "host.exemple.com", "admin", "server-name", "password"
+server = Equitrac::Connection.new "host.exemple.com", "admin", "server-name", "password"
 
 # OR with environment variables
 
@@ -37,7 +44,7 @@ ENV['EQUITRAC_USER'] = "admin"
 ENV['EQUITRAC_SERVICE_NAME'] = "server-name"
 ENV['EQUITRAC_HOST_PASSWORD'] = "password"
 
-server = Equitrac::Server.new
+server = Equitrac::Connection.new
 ```
 
 if you want to use key based authentication just ignore the password.
@@ -64,11 +71,11 @@ cmd = Equitrac::Utilities::User.add( min_user_params )
 ```ruby
   # with key authentication do:
 
-  # server object = Equitrac::Server.new "host.exemple.com", "admin", "server-name"
+  # server object = Equitrac::Connection.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 object = Equitrac::Connection.new "host.exemple.com", "admin", "server-name", "password"
   server.execute(cmd, {verify_host_key: false})
 ```
 
@@ -95,4 +102,4 @@ Pull requests need tests.
 
 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)
+All rights on Equitrac are owned by [Nuance Communications, Inc.](https://www.nuance.com/index.html)

data/bin/console

@@ -2,7 +2,7 @@
 
 require "bundler/setup"
 require "equitrac/utilities"
-require "equitrac/server"
+require "equitrac/connection"
 
 # 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.

data/examples/create_users.rb

@@ -1,13 +1,16 @@
 #!/usr/bin/env ruby -w
 
+# run using:
+# ./create_users.rb
+
+require 'equitrac/connection'
 require 'equitrac/utilities'
-require 'equitrac/server'
 require 'yaml'
 
-# SERVER #
+# CONNECTION #
 ##########
-srv_file   = 'server-sample.yml'           if File.file?('server-sample.yml')
-srv_file   = 'server.yml'                  if File.file?('server.yml') # real
+srv_file   = 'connection-sample.yml' if File.file?('connection-sample.yml')
+srv_file   = 'connection.yml'        if File.file?('connection.yml') # real
 srv_file ||= nil
 #
 srv_info   = nil
@@ -21,10 +24,10 @@ 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)
+# File.write("connection-sample.yml",srv_info.to_yaml)
 puts "\nSRV_INFO: #{srv_info}"
 
-server  = Equitrac::Server.new( srv_info[:hostname],
+server  = Equitrac::Connection.new( srv_info[:hostname],
                                 srv_info[:username],
                                 srv_info[:eq_service]
                               )        unless srv_info.nil?
@@ -53,6 +56,13 @@ end                                    unless users_file.nil?
 puts "\nUSERS:"
 pp users
 
+# add is this what you expect?
+puts "Review the user data \nEnter 'Y' to create eq56 accounts"
+answer = gets.chomp.downcase
+puts "aborting account creation"  unless answer.eql? 'y'
+exit                              unless answer.eql? 'y'
+puts "creating eq56 accounts ..."
+
 # CREATE #
 ##########
 puts "\nEQ56 Commands:"

data/lib/equitrac/{server.rb → connection.rb}

@@ -11,7 +11,7 @@ module Equitrac
   #   @return [String] The path where Equitrac utilities is installed
   # @!attribute [r] service_name
   #   @return [String] The name of the Equitrac service.
-  class Server
+  class Connection
     attr_reader :service_name, :eqcmd_path
 
     # @note Host, User and Service name are required

data/lib/equitrac/utilities/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: equitrac-utilities
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Elliott Hebert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -100,10 +100,10 @@ files:
 - bin/console
 - bin/setup
 - equitrac-utilities.gemspec
+- examples/connection-sample.yml
 - examples/create_users.rb
-- examples/server-sample.yml
 - examples/users-sample.yml
-- lib/equitrac/server.rb
+- lib/equitrac/connection.rb
 - lib/equitrac/utilities.rb
 - lib/equitrac/utilities/user.rb
 - lib/equitrac/utilities/version.rb
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A gem to interact with equitrac 5.6