mtik 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ce416fc9ce5a6d6768f40c11b68fc983fcf75ba69e10e3bc660a0b405fc1bcc
-  data.tar.gz: 910a34bcb91770ea3f5607fd91297fa1d518f0020e35e27e810deb4eb797cd71
+  metadata.gz: 69ac4aa4e71fb42516c3f6251de37e64a1041ad5f47f6c95548e601e451f8475
+  data.tar.gz: 3003d97eefc4abe69bf3e0e708e47426cd88ca1ac70c7130ccf8336c14ede4c9
 SHA512:
-  metadata.gz: 86879188b9b9af32b1d61f61d3c539a3f8482ef1da078f4a347ea548e1480e0c5b6502d73784a7acda610a17d4b6be141dae93a20b07c1c85959aec538834be5
-  data.tar.gz: 6778bcf64f479677ccdaec744a8356b936527471870e21aa6878749ceb22d79d43452415113a2e15de4d4be0bbc133d7a32b1d0c7d70807cf7066eb94acab91e
+  metadata.gz: 1ecee89ebbb4ad1f19ed5ddee719883ad0f7612157650487019dbd607580dfbab274c29c07567016b71a1695ef493c6e24358e13d2ccffb89a16adb3855de54c
+  data.tar.gz: f59ffc39d06615562f676499ed1a672be907e95e9d55589c472081c78ccf0670ba024821d4625782dcb2bf7bf1f1d20cead2303e4095d459ed6aeca98a755229

data/CHANGELOG.txt

@@ -1,3 +1,15 @@
+2020-08-24 (24 AUG 2020)  VERSION 4.1.1
+  * Version bump to update copyright notices and author's URL
+  * Moved the tikjson script to the bin subdirectory and updated
+    it to include CLI options like tikcommand and added a
+    --pretty CLI option.
+  * Updated README to use HTTPS URLs where releant AND fixed the
+    examples section to correctly note that example scripts now
+    reside in the bin subdirectory.
+  * Tweaked varous bin subdirectory scripts to add a --verbose
+    CLI option (except for tikcli) and matching MTIK_VERBOSE
+    environment variable.
+
 2020-08-23 (23 AUG 2020)  VERSION 4.1.0
   * Minor version bump due to changing argument passing for the call to
     MTik.interactive_client()
@@ -22,21 +34,21 @@
   * Adam bumped the version number and separated out a gemspec file
   * Jiacheng (github user krhougs) had submitted a similar update as Adam
 
-2014-02-14 (14 FEB 2014)  VERSION 4.0.3  Aaron D. Gifford (http://www.aarongifford.com)
+2014-02-14 (14 FEB 2014)  VERSION 4.0.3  Aaron D. Gifford (https://aarongifford.com)
  * Update to fetch() utility, along with some very minor some cosmetic changes
 
-2013-06-06 (06 JUN 2013)  VERSION 4.0.2  Aaron D. Gifford (http://www.aarongifford.com)
+2013-06-06 (06 JUN 2013)  VERSION 4.0.2  Aaron D. Gifford (https://aarongifford.com)
                                          Bart Braem (http://www.lalunerouge.net/)
  * Merged Bart Braem's implementation of timeouts and bumped up the version.  Thanks, Bart!
  * Updated Rakefile to remove a bit of obsolescence
 
-2012-02-09 (09 FEB 2012)  VERSION 4.0.1  Aaron D. Gifford (http://www.aarongifford.com)
+2012-02-09 (09 FEB 2012)  VERSION 4.0.1  Aaron D. Gifford (https://aarongifford.com)
  * Added os_version to connections.  Upon successful connect and login, the RouterOS
    version is fetched and stored.  This will allow future updates to better support
    some commands that differ (like fetch) depending on which RouterOS version is
    installed on the device.
 
-2011-03-25 (25 MAR 2011)  VERSION 4.0.0  Aaron D. Gifford (http://www.aarongifford.com)
+2011-03-25 (25 MAR 2011)  VERSION 4.0.0  Aaron D. Gifford (https://aarongifford.com)
  * Per user suggestion, added a new optional cancel parameter to the MTik#command()
    method that will auto-cancel the supplied command after receiving the specified
    number of '!re' reply sentences.  This is usful for executing a command that otherwise
@@ -52,7 +64,7 @@
    eliminated a few redundant key?() calls, and fixed a replycounter initialization
    typo (had set it to 1 instead of 0).
 
-2011-01-11 (11 JAN 2011)  VERSION 3.1.2  Aaron D. Gifford (http://www.aarongifford.com)
+2011-01-11 (11 JAN 2011)  VERSION 3.1.2  Aaron D. Gifford (https://aarongifford.com)
  * Added source file encoding comments and updated the copyright notices
  * Fixed a tiny bug in lib/mtik/connection.rb
  * Changed MTik::Request@state member in lib/mtik/request.rb to Symbol instead of String
@@ -61,12 +73,12 @@
  * Renamed a few variables that, with warnings enabled, Ruby complained were overlapping
    or hiding outer variables of the same name to avoid the warning.
 
-2010-12-30 (30 DEC 2011)  VERSION 3.1.1  Aaron D. Gifford (http://www.aarongifford.com)
+2010-12-30 (30 DEC 2011)  VERSION 3.1.1  Aaron D. Gifford (https://aarongifford.com)
  * Changed the tikfetch.rb utility so it no longer requires a destination filename
    by default--it will use the supplied URL's final path element as a filename.  Also
    updated the stats output a bit.
 
-2010-04-24 (24 APR 2010)  VERSION 3.1.0  Aaron D. Gifford (http://www.aarongifford.com)
+2010-04-24 (24 APR 2010)  VERSION 3.1.0  Aaron D. Gifford (https://aarongifford.com)
  * Added find_sentences() method to MTik::Reply -- just sugar to Array.select()
  * Changed MTik::Connection.fetch() method to add an optional timeout parameter
    which should not affect the API and should be backward compatible.  By default,
@@ -80,28 +92,28 @@
    command if needed.  Due to this change, I decided to bump the version to 3.1.0.
  * Fixed RDoc formatting in several files, and added an RDocTask to the Rakefile
 
-2010-04-23 (23 APR 2010)  VERSION 3.0.5  Aaron D. Gifford (http://www.aarongifford.com)
+2010-04-23 (23 APR 2010)  VERSION 3.0.5  Aaron D. Gifford (https://aarongifford.com)
  * Double bug-fix (typo fix and logic fix) to request.rb thanks to Allan Eising and
    Søren Daugaard.  Thank you both for the patch!
  * Added a brief sanity-check in request.rb to help spotlight logic errors.
 
-2010-04-09 (09 APR 2010)  VERSION 3.0.4  Aaron D. Gifford (http://www.aarongifford.com)
+2010-04-09 (09 APR 2010)  VERSION 3.0.4  Aaron D. Gifford (https://aarongifford.com)
  * Bug fix to lib/mtik.rb thanks to Allan Eising to the command validation regular
    expression to permit the '-' character in a command.  Thanks!
 
-2010-03-11 (11 MAR 2010)  VERSION 3.0.3  Aaron D. Gifford (http://www.aarongifford.com)
+2010-03-11 (11 MAR 2010)  VERSION 3.0.3  Aaron D. Gifford (https://aarongifford.com)
   * Bug fix to lib/mtik.rb command() method so when executing multiple commands
     response array order matches command array order.
   * Cosmetic change for hex encoding with a little simplification, and one very small
     readability change in lib/mtik/connection.rb
 
-2010-02-05 (05 FEB 2010)  VERSION 3.0.2  Aaron D. Gifford (http://www.aarongifford.com)
+2010-02-05 (05 FEB 2010)  VERSION 3.0.2  Aaron D. Gifford (https://aarongifford.com)
   * Typo fixes to example tikfetch.rb
   * Multi-command functionality added to interactive client and to tikcommand.rb example
   * Removed kludge path stuff for author's broken FreeBSD Ruby 1.9.1 gem system
   * Removed lame JSON-ifier from example and switched to require 'json' instead
 
-2010-01-19 (19 JAN 2010)  VERSION 3.0.1  Aaron D. Gifford (http://www.aarongifford.com/)
+2010-01-19 (19 JAN 2010)  VERSION 3.0.1  Aaron D. Gifford (https://aarongifford.com/)
   * Added support for '/tool/fetch' 'requesting' state
   * Added auto-cancel of finished '/tool/fetch' command in MTik#command()
   * Added MTik::Request#cancel() method
@@ -114,7 +126,7 @@
     messed-up FreeBSD Ruby 1.9 installation
   * Renamed examples with a 'tik' prefix
 
-2010-01-15 (15 JAN 2010)  VERSION 3.0.0  Aaron D. Gifford  (http://www.aarongifford.com/)
+2010-01-15 (15 JAN 2010)  VERSION 3.0.0  Aaron D. Gifford  (https://aarongifford.com/)
   * Bumped the version to 3.0.0 due to modularization and gemification changes
   that break any software using the older Ruby API classes.
   * Split out (as separate files) and added a few more examples:

data/LICENSE.txt

@@ -1,11 +1,11 @@
 ########################################################################
 #--
 #
-# GEM:      MTik -- A Ruby gem implementing the MikroTik RouterOS API
+# GEM:        MTik -- A Ruby gem implementing the MikroTik RouterOS API
 #
 #++
-# Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+# Author::    Aaron D. Gifford - https://aarongifford.com/
+# Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without

data/README.txt

@@ -6,48 +6,48 @@ devices running RouterOS (with the API enabled) over the network.
 
 == Examples
 
-Included in the examples subdirectory are four example ruby scripts
+Included in the bin subdirectory are four example ruby scripts
 that use the Ruby API implementation:
 
-tikcli.rb::     A command-line-like API interface
-tikcommand.rb:: A tool for executing a single API command from
-                a unix command-line
-tikfetch.rb::   A tool for instructing devices to download files
-                from specified URLs (unix command-line tool)
-tikjson.rb::    Like 'command.rb' a tool for executing a single
-                API command, except the output is formatted  in
-                JSON-style
+tikcli::     A command-line-like API interface
+tikcommand:: A tool for executing a single API command from
+             a unix command-line
+tikfetch::   A tool for instructing devices to download files
+             from specified URLs (unix command-line tool)
+tikjson::    Like 'tikcommand' a tool for executing a single
+             API command, except the output is formatted  in
+             JSON-style
 
 
 == Download
 
 The latest version of MTik can be found at
 
-* http://www.aarongifford.com/computers/mtik/
+* https://aarongifford.com/computers/mtik/
 
 Ruby RDoc documentation can be found online at
 
-* http://www.aarongifford.com/computers/mtik/latest/doc/
+* https://aarongifford.com/computers/mtik/doc/
 
 Additional documentation is available at
 
-* http://www.aarongifford.com/computers/mtik/
-* http://wiki.mikrotik.com/wiki/API_Ruby_class
+* https://aarongifford.com/computers/mtik/
+* https://wiki.mikrotik.com/wiki/API_Ruby_class
 
 Source code is available on GitHub:
 
-* http://www.github.com/astounding/mtik/
+* https://www.github.com/astounding/mtik/
 
-For documentation on the MikroTik RouterOS APi, see
+For documentation on the MikroTik RouterOS API, see
 
-* http://wiki.mikrotik.com/wiki/API
+* https://wiki.mikrotik.com/wiki/API
 
 
 == Installation
 
 To install MTik is through its GEM file:
 
-  % [sudo] gem install mtik-4.0.0.gem
+  % [sudo] gem install mtik-4.1.1.gem
 
 == License
 
@@ -59,13 +59,13 @@ under a BSD-style license.  (See the LICENSE.txt file.)
 
 Bugs/issues may also be reported via GitHub:
 
-* http://www.github.com/astounding/mtik/issues/
+* https://www.github.com/astounding/mtik/issues/
 
 ALSO, please send the author a note regarding the issue by clicking on the
 "Contact Me" link in the left-hand menu of the author's web site.
 The direct URL is:
 
-* http://www.aarongifford.com/leaveanote.html
+* https://aarongifford.com/leaveanote.html
 
 Thank you!
 

data/VERSION.txt

@@ -1 +1 @@
-4.1.0
+4.1.1

data/bin/tikcli

@@ -2,11 +2,11 @@
 ########################################################################
 #--
 #
-# FILE:     tikcli.rb -- Example of using the Ruby MikroTik API in Ruby
+# FILE:       tikcli -- Example of using the Ruby MikroTik API in Ruby
 #
 #++
-# Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+# Author::    Aaron D. Gifford - https://aarongifford.com/
+# Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without
@@ -42,13 +42,14 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
 require 'rubygems'
 require 'mtik'
 
+
 def usage(msg='')
   STDERR.print(
     (msg.size > 0 ? msg + "\n\n" : '') +
-    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] <host> <user> <pass>\n"  +
+    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] <host> <user> <pass>\n"   +
+    "       --ssl OR -s                    - Use SSL for the API connection.\n"     +
     "       --unencrypted_plaintext OR -u  - Use the 6.43+ login API even if NOT\n" +
-    "                                        using SSL.\n"                          +
-    "       --ssl OR -s                    - Use SSL for the API connection.\n"
+    "                                        using SSL.\n"
   )
   exit(-1)
 end
@@ -74,6 +75,9 @@ usage("Insufficient arguments.") if ARGV.size < 3
 use_ssl               = true if ENV['MTIK_SSL']
 unencrypted_plaintext = true if ENV['MTIK_UNENCRYPTED_PLAINTEXT']
 
+## NOTE: We IGNORE environment variable MTIK_VERBOSE mode as this script
+##       ALWAYS uses verbose mode.
+
 args = {
   :host => ARGV[0],
   :user => ARGV[1],

data/bin/tikcommand

@@ -2,11 +2,11 @@
 ########################################################################
 #--
 #
-# FILE:     command.rb -- Example of using the Ruby MikroTik API in Ruby
+# FILE:       tikcommand -- Example of using the Ruby MikroTik API in Ruby
 #
 #++
-# Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+# Author::    Aaron D. Gifford - https://aarongifford.com/
+# Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without
@@ -42,20 +42,21 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
 require 'rubygems'
 require 'mtik'
 
+
 def usage(msg='')
   STDERR.print(
     (msg.size > 0 ? msg + "\n\n" : '') +
-    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] <host> <user> <pass> <command> [<args>...] [<command> [<args> ...]]\n" +
+    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] [-v|--verbose] <host> <user> <pass> <command> [<args>...] [<command> [<args> ...]]\n" +
     "       --unencrypted_plaintext OR -u  - Use the 6.43+ login API even if NOT\n" +
     "                                        using SSL.\n"                          +
-    "       --ssl OR -s                    - Use SSL for the API connection.\n"
+    "       --ssl OR -s                    - Use SSL for the API connection.\n"     +
+    "       --verbose OR -v                - Enable verbose output via STDERR.\n"
   )
   exit(-1)
 end
 
-MTik::verbose = true  ## Set how verbose you want things
 
-use_ssl = unencrypted_plaintext = false
+use_ssl = unencrypted_plaintext = verbose = false
 while !ARGV[0].nil? && ARGV[0][0] == '-'
   arg = ARGV.shift
   case arg
@@ -65,6 +66,9 @@ while !ARGV[0].nil? && ARGV[0][0] == '-'
   when '--unencrypted_plaintext', '-u'
     usage("Please do not repeat the --unencrypted_plaintext (or -u) parameter") if unencrypted_plaintext
     unencrypted_plaintext = true
+  when '--verbose', '-v'
+    usage("Please do not repeat the --verbose (or -v) parameter") if use_ssl
+    verbose = true
   else
     usage("Unknown argument #{arg.inspect}")
   end
@@ -75,6 +79,9 @@ usage("First command must start with a slash '/' character. #{ARGV[3].inspect}")
 ## Permit setting use_ssl and unencrypted_plaintext via environment variables:
 use_ssl               = true if ENV['MTIK_SSL']
 unencrypted_plaintext = true if ENV['MTIK_UNENCRYPTED_PLAINTEXT']
+verbose               = true if ENV['MTIK_VERBOSE']
+
+MTik::verbose = verbose
 
 ## Detect multiple command sequences and build an array of arrays
 ## where each outer array element is a command plus arguments:

data/bin/tikfetch

@@ -2,11 +2,11 @@
 ########################################################################
 #--
 #
-# FILE:     fetch.rb -- Example of using the Ruby MikroTik API in Ruby
+# FILE:       tikfetch -- Example of using the Ruby MikroTik API in Ruby
 #
 #++
-# Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+# Author::    Aaron D. Gifford - https://aarongifford.com/
+# Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without
@@ -42,22 +42,20 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
 require 'rubygems'
 require 'mtik'
 
-## Uncomment this (set $VERBOSE to true) if you want crazy verbose
-## output of all API interactions:
-#MTik::verbose = true
 
 def usage(msg='')
   STDERR.print(
     (msg.size > 0 ? msg + "\n\n" : '') +
-    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] <device> <user> <pass> <url> [<localfilename> [<url> [<localfilename> ... ]]]\n" +
+    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] [-v|--verbose] <device> <user> <pass> <url> [<localfilename> [<url> [<localfilename> ... ]]]\n" +
     "       --unencrypted_plaintext OR -u  - Use the 6.43+ login API even if NOT\n" +
     "                                        using SSL.\n"                          +
-    "       --ssl OR -s                    - Use SSL for the API connection.\n"
+    "       --ssl OR -s                    - Use SSL for the API connection.\n"     +
+    "       --verbose OR -v                - Enable verbose output via STDOUT.\n"
   )
   exit(-1)
 end
 
-use_ssl = unencrypted_plaintext = false
+use_ssl = unencrypted_plaintext = verbose = false
 while !ARGV[0].nil? && ARGV[0][0] == '-'
   arg = ARGV.shift
   case arg
@@ -67,6 +65,9 @@ while !ARGV[0].nil? && ARGV[0][0] == '-'
   when '--unencrypted_plaintext', '-u'
     usage("Please do not repeat the --unencrypted_plaintext (or -u) parameter") if unencrypted_plaintext
     unencrypted_plaintext = true
+  when '--verbose', '-v'
+    usage("Please do not repeat the --verbose (or -v) parameter") if verbose
+    verbose = true
   else
     usage("Unknown argument #{arg.inspect}")
   end
@@ -76,6 +77,9 @@ usage("Too few arguments.") if ARGV.size < 4
 ## Permit setting use_ssl and unencrypted_plaintext via environment variables:
 use_ssl               = true if ENV['MTIK_SSL']
 unencrypted_plaintext = true if ENV['MTIK_UNENCRYPTED_PLAINTEXT']
+verbose               = true if ENV['MTIK_VERBOSE']
+
+MTik::verbose = verbose
 
 args = {
   :host => ARGV.shift,

data/bin/tikjson

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+########################################################################
+#--
+#
+# FILE:       tikjson -- Example of using the Ruby MikroTik API in Ruby
+#                        to execute an API command and retrieve results
+#                        in JSON format
+#
+#++
+# Author::    Aaron D. Gifford - https://aarongifford.com/
+# Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
+# License::   BSD license
+#--
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, the above list of authors and contributors, this list of
+#    conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+# 3. Neither the name of the author(s) or copyright holder(s) nor the
+#    names of any contributors may be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S), AUTHOR(S) AND
+# CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), AUTHOR(S), OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# DCONSEQUENTIAL AMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+# THE POSSIBILITY OF SUCH DAMAGE.
+########################################################################
+# encoding: ASCII-8BIT
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
+
+require 'rubygems'
+require 'mtik'
+require 'json'
+
+
+def usage(msg='')
+  STDERR.print(
+    (msg.size > 0 ? msg + "\n\n" : '') +
+    "Usage: #{$0} [-p|--pretty] [-s|--ssl] [-u|--unencrypted_plaintext] [-v|--verbose] <host> <user> <pass> <command> [<args>...] [<command> [<args> ...]]\n" +
+    "       --pretty OR -p                 - Output JSON using JSON.pretty_generate()\n" +
+    "       --ssl OR -s                    - Use SSL for the API connection.\n"          +
+    "       --unencrypted_plaintext OR -u  - Use the 6.43+ login API even if NOT\n"      +
+    "                                        using SSL.\n"                               +
+    "       --verbose OR -v                - Enable verbose output to STDERR.\n"
+  )
+  exit(-1)
+end
+
+use_ssl = unencrypted_plaintext = pretty = verbose = false
+while !ARGV[0].nil? && ARGV[0][0] == '-'
+  arg = ARGV.shift
+  case arg
+  when '--pretty', '-p'
+    usage("Please do not repeat the --pretty (or -p) parameter") if pretty
+    pretty = true
+  when '--ssl', '-s'
+    usage("Please do not repeat the --ssl (or -s) parameter") if use_ssl
+    use_ssl = true
+  when '--unencrypted_plaintext', '-u'
+    usage("Please do not repeat the --unencrypted_plaintext (or -u) parameter") if unencrypted_plaintext
+    unencrypted_plaintext = true
+  when '--verbose', '-v'
+    usage("Please do not repeat the --verbose (or -v) parameter") if verbose
+    verbose = true
+  else
+    usage("Unknown argument #{arg.inspect}")
+  end
+end
+usage("Too few arguments.") if ARGV.size < 4
+usage("First command must start with a slash '/' character. #{ARGV[3].inspect}") if ARGV[3].nil? || ARGV[3][0] != '/'
+
+## Permit setting use_ssl and unencrypted_plaintext via environment variables:
+use_ssl               = true if ENV['MTIK_SSL']
+unencrypted_plaintext = true if ENV['MTIK_UNENCRYPTED_PLAINTEXT']
+verbose               = true if ENV['MTIK_VERBOSE']
+
+MTik::verbose = verbose
+
+## Detect multiple command sequences and build an array of arrays
+## where each outer array element is a command plus arguments:
+command = Array.new
+i = 3
+while i < ARGV.length
+  if ARGV[i][0,1] == '/'  ## Command detected...
+    command << [ ARGV[i] ]
+  else
+    command[command.length-1] << ARGV[i]
+  end
+  i += 1
+end
+
+args = {
+  :host    => ARGV[0],
+  :user    => ARGV[1],
+  :pass    => ARGV[2],
+  :command => command,
+  :ssl     => use_ssl,
+  :unencrypted_plaintext => unencrypted_plaintext
+}
+
+if pretty
+  puts JSON.pretty_generate(MTik::command(args))
+else
+  print MTik::command(args).to_json + "\n"
+end
+

data/lib/mtik.rb

@@ -1,8 +1,8 @@
 ############################################################################
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
-## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+## Author::    Aaron D. Gifford - https://aarongifford.com/
+## Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without

data/lib/mtik/connection.rb

@@ -1,8 +1,8 @@
 ############################################################################
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
-## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+## Author::    Aaron D. Gifford - https://aarongifford.com/
+## Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without

data/lib/mtik/error.rb

@@ -1,8 +1,8 @@
 ############################################################################
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
-## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+## Author::    Aaron D. Gifford - https://aarongifford.com/
+## Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without

data/lib/mtik/fatalerror.rb

@@ -1,8 +1,8 @@
 ############################################################################
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
-## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+## Author::    Aaron D. Gifford - https://aarongifford.com/
+## Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without

data/lib/mtik/reply.rb

@@ -1,8 +1,8 @@
 ############################################################################
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
-## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+## Author::    Aaron D. Gifford - https://aarongifford.com/
+## Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without

data/lib/mtik/request.rb

@@ -1,8 +1,8 @@
 ############################################################################
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
-## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+## Author::    Aaron D. Gifford - https://aarongifford.com/
+## Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without

data/lib/mtik/timeouterror.rb

@@ -1,8 +1,8 @@
 ############################################################################
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
-## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+## Author::    Aaron D. Gifford - https://aarongifford.com/
+## Copyright:: Copyright (c) 2009-2020, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtik
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Aaron D. Gifford
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-22 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies: []
 description: MTik implements the MikroTik RouterOS API for use in Ruby.
 email: email_not_accepted@aarongifford.com
@@ -28,7 +28,7 @@ files:
 - bin/tikcli
 - bin/tikcommand
 - bin/tikfetch
-- examples/tikjson.rb
+- bin/tikjson
 - lib/mtik.rb
 - lib/mtik/connection.rb
 - lib/mtik/error.rb
@@ -36,7 +36,7 @@ files:
 - lib/mtik/reply.rb
 - lib/mtik/request.rb
 - lib/mtik/timeouterror.rb
-homepage: http://www.aarongifford.com/computers/mtik/
+homepage: https://aarongifford.com/computers/mtik/
 licenses: []
 metadata: {}
 post_install_message:

data/examples/tikjson.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-########################################################################
-#--
-#
-# FILE:  tikjson.rb -- Example of using the Ruby MikroTik API in Ruby
-#                      to execute an API command and retrieve results
-#                      in JSON format
-#
-#++
-# Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2014, InfoWest, Inc.
-# License::   BSD license
-#--
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions
-# are met:
-# 1. Redistributions of source code must retain the above copyright
-#    notice, the above list of authors and contributors, this list of
-#    conditions and the following disclaimer.
-# 2. Redistributions in binary form must reproduce the above copyright
-#    notice, this list of conditions and the following disclaimer in the
-#    documentation and/or other materials provided with the distribution.
-# 3. Neither the name of the author(s) or copyright holder(s) nor the
-#    names of any contributors may be used to endorse or promote products
-#    derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S), AUTHOR(S) AND
-# CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
-# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), AUTHOR(S), OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# DCONSEQUENTIAL AMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
-# THE POSSIBILITY OF SUCH DAMAGE.
-########################################################################
-# encoding: ASCII-8BIT
-
-$LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
-
-require 'rubygems'
-require 'mtik'
-require 'json'
-
-unless ARGV.length > 3
-  STDERR.print("Usage: #{$0} <host> <user> <pass> <command> [<args>...] [<command> [<args> ...]]\n")
-  exit(-1)
-end
-
-## Detect multiple command sequences and build an array of arrays
-## where each outer array element is a command plus arguments:
-command = Array.new
-i = 3
-while i < ARGV.length
-  if ARGV[i][0,1] == '/'  ## Command detected...
-    command << [ ARGV[i] ]
-  else
-    command[command.length-1] << ARGV[i]
-  end
-  i += 1
-end
-
-print MTik::command(
-  :host=>ARGV[0],
-  :user=>ARGV[1],
-  :pass=>ARGV[2],
-  :command=>command
-).to_json + "\n"
-