mtik 4.0.3 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0faffc781b693499b3a24a0b07cc918c146903a6
-  data.tar.gz: 2415ca8ad18b2f83e55ca29e81bfe776f507700c
+SHA256:
+  metadata.gz: c0fcd5a05cdbbb232cc76a9aa321be06965df29d767051feb038d9707b2f75e5
+  data.tar.gz: bc38cf94a3d8e7d14fbce5dfda7092f317c7720133a8e74a9a823a3658abbdf5
 SHA512:
-  metadata.gz: 82acc2725c7f074df88f22585a13a1395ffedd4bf9194daa167e893f1d33d11da70bb4a9825c25c294863b7bd88b8bdf3c435d848461862402bf22cf26824e58
-  data.tar.gz: 04e7aca873f26094fdcd701431bba659ad0663f7528b2ab03ddc9192276cafbda3b80f6d68698d366c9ae74c1049e33602adf8a59b2b625e177f0d2b8c2474ad
+  metadata.gz: dddba29fb56df7da8b2d4d31e51f7bf5bab698d2731662832547b754b6908f7fc101ae404cc23dcaf065fec868c3aaa0eecafe9b0bfd041f268d47b7fcf1f13c
+  data.tar.gz: f461371288c57a6cbe97e29f646193ec0cf9d8f2f0404f6acf5318c67e2fbadbcb0f6e8bb2f3ca3a9dc55ed5cc2d74c0208f3deec3d5dcb022ae2d8ae12396c2

data/CHANGELOG.txt

@@ -1,18 +1,58 @@
-2014-02-14 (14 FEB 2014)  VERSION 4.2.3  Aaron D. Gifford (http://www.aarongifford.com)
+2020-08-24 (24 AUG 2020)  VERSION 4.1.2
+  * Added tikjson to the executables list in mtik.gemspec
+    (Yes, I totally forgot to do this for 4.1.1. Oops!)
+
+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()
+  * Updated tikcli, tikcommand, and tikfetch commands to add options for
+    enabling SSL and/or to use unencrypted plaintext logins (newer API
+    login style).  Also one can set environment variables MTIK_SSL to 
+    specify SSL use, or MTIK_UNENCRYPTED_PLAINTEXT to enable unencrypted
+    plaintext logins if SSL is NOT used for compatibility with cleartext
+    API usage on RouterOS versions 6.43+
+  * THANKS to Zdenek Crha (zdenek-crha on github) for pointing out that
+    the binary commands were lacking proper argument passing to allow
+    for SSL and/or unencrypted plaintext options, and for suggesting the
+    use of environment variables as an alterative to CLI options for
+    enabling such.
+
+2020-08-22 (22 AUG 2020)  VERSION 4.0.5
+  * This is a cosmetic version bump for the purpose of updating the gem for wider
+    availability via rubygems in addition to directly from github prior to some
+    coming feature updates and fixes for newer versions of RouterOS
+
+2019-07-26 (26 JUL 2020)  VERSION 4.0.4  Adam Kubica (github user xcr)
+  * 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 (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
@@ -28,7 +68,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
@@ -37,12 +77,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,
@@ -56,28 +96,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)
- * Double bug-fix (typo fix and logic fix) to request.rb thanks to Allan Eising and 
+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
@@ -90,7 +130,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/Rakefile

@@ -2,38 +2,7 @@ require 'rubygems'
 require 'rubygems/package_task'
 require 'rdoc/task'
 
-gemspec = Gem::Specification.new do |spec|
-  spec.name         = 'mtik'
-  spec.version      = File.open('VERSION.txt','r').to_a.join.strip
-  spec.date         = File.mtime('VERSION.txt')
-  spec.author       = 'Aaron D. Gifford'
-  spec.email        = 'email_not_accepted@aarongifford.com'
-  spec.homepage     = 'http://www.aarongifford.com/computers/mtik/'
-  spec.summary      = 'MTik implements the MikroTik RouterOS API for use in Ruby.'
-  spec.description  = 'MTik implements the MikroTik RouterOS API for use in Ruby.'
-  spec.rubyforge_project = 'mtik'
-  spec.extra_rdoc_files  = [ 'README.txt' ]
-  spec.require_paths     = [ 'lib' ]
-  spec.files             = [
-    'CHANGELOG.txt',
-    'LICENSE.txt',
-    'README.txt',
-    'VERSION.txt',
-    'Rakefile',
-    'examples/tikjson.rb',
-    'bin/tikcli',
-    'bin/tikcommand',
-    'bin/tikfetch',
-    'lib/mtik.rb',
-    'lib/mtik/connection.rb',
-    'lib/mtik/error.rb',
-    'lib/mtik/fatalerror.rb',
-    'lib/mtik/reply.rb',
-    'lib/mtik/request.rb',
-    'lib/mtik/timeouterror.rb'
-  ]
-  spec.executables = [ 'tikcli', 'tikcommand', 'tikfetch' ]
-end
+gemspec = Gem::Specification.load('mtik.gemspec')
 
 Gem::PackageTask.new(gemspec) do |pkg|
   pkg.need_zip = true

data/VERSION.txt

@@ -1 +1 @@
-4.0.3
+4.1.2

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,10 +42,50 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
 require 'rubygems'
 require 'mtik'
 
-unless ARGV.length == 3
-  STDERR.print("Usage: #{$0} <host> <user> <pass>\n")
+
+def usage(msg='')
+  STDERR.print(
+    (msg.size > 0 ? msg + "\n\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"
+  )
   exit(-1)
 end
 
-MTik::interactive_client(ARGV[0], ARGV[1], ARGV[2])
+use_ssl = unencrypted_plaintext = false
+while !ARGV[0].nil? && ARGV[0][0] == '-'
+  arg = ARGV.shift
+  case arg
+  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
+  else
+    usage("Unknown argument #{arg.inspect}")
+  end
+end
+usage("Too many arguments.")     if ARGV.size > 3
+usage("Insufficient arguments.") if ARGV.size < 3
+
+## 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']
+
+## NOTE: We IGNORE environment variable MTIK_VERBOSE mode as this script
+##       ALWAYS uses verbose mode.
+
+args = {
+  :host => ARGV[0],
+  :user => ARGV[1],
+  :pass => ARGV[2],
+  :ssl  => use_ssl,
+  :unencrypted_plaintext => unencrypted_plaintext
+}
+p args
+
+MTik::interactive_client(args)
 

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,12 +42,46 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
 require 'rubygems'
 require 'mtik'
 
-unless ARGV.length > 3
-  STDERR.print("Usage: #{$0} <host> <user> <pass> <command> [<args>...] [<command> [<args> ...]]\n")
+
+def usage(msg='')
+  STDERR.print(
+    (msg.size > 0 ? msg + "\n\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"     +
+    "       --verbose OR -v                - Enable verbose output via STDERR.\n"
+  )
   exit(-1)
 end
 
-MTik::verbose = true  ## Set how you want
+
+use_ssl = unencrypted_plaintext = verbose = false
+while !ARGV[0].nil? && ARGV[0][0] == '-'
+  arg = ARGV.shift
+  case arg
+  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 use_ssl
+    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:
@@ -62,10 +96,14 @@ while i < ARGV.length
   i += 1
 end
 
-p MTik::command(
-  :host=>ARGV[0],
-  :user=>ARGV[1],
-  :pass=>ARGV[2],
-  :command=>command
-)
+args = {
+  :host    => ARGV[0],
+  :user    => ARGV[1],
+  :pass    => ARGV[2],
+  :command => command,
+  :ssl     => use_ssl,
+  :unencrypted_plaintext => unencrypted_plaintext
+}
+
+p MTik::command(args)
 

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,20 +42,56 @@ $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
 
-if ARGV.length < 4
-  print "Usage: #{$0} <device> <user> <pass> <url> [<localfilename> [<url> [<localfilename> ... ]]]\n"
-  exit
+def usage(msg='')
+  STDERR.print(
+    (msg.size > 0 ? msg + "\n\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"     +
+    "       --verbose OR -v                - Enable verbose output via STDOUT.\n"
+  )
+  exit(-1)
+end
+
+use_ssl = unencrypted_plaintext = verbose = false
+while !ARGV[0].nil? && ARGV[0][0] == '-'
+  arg = ARGV.shift
+  case arg
+  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
+
+## 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,
+  :user => ARGV.shift,
+  :pass => ARGV.shift,
+  :ssl  => use_ssl,
+  :unencrypted_plaintext => unencrypted_plaintext
+}
+
 
-host = ARGV.shift
-user = ARGV.shift
-pass = ARGV.shift
 begin
-  mt = MTik::Connection.new(:host=>host, :user=>user, :pass=>pass)
+  mt = MTik::Connection.new(args)
 rescue Errno::ETIMEDOUT, Errno::ENETUNREACH, Errno::EHOSTUNREACH, MTik::Error => e
   print ">>> ERROR CONNECTING: #{e}\n"
   exit
@@ -129,6 +165,7 @@ print "SIZE        CREATED               FILENAME\n"
 print "====================================================================\n"
 mt.get_reply_each('/file/getall') do |req, s|
   unless s.key?('!done')
+    s['size'] = 'directory' if s['type'] == 'directory'
     print "#{(s['size']+'        ')[0,10]}  #{s['creation-time']}  #{s['name']}\n"
   end
 end

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
@@ -34,20 +34,22 @@
 # encoding: ASCII-8BIT
 
 module MTik
-  require 'mtik/error.rb'
-  require 'mtik/fatalerror.rb'
-  require 'mtik/timeouterror.rb'
-  require 'mtik/request.rb'
-  require 'mtik/reply.rb'
-  require 'mtik/connection.rb'
+  require_relative 'mtik/error.rb'
+  require_relative 'mtik/fatalerror.rb'
+  require_relative 'mtik/timeouterror.rb'
+  require_relative 'mtik/request.rb'
+  require_relative 'mtik/reply.rb'
+  require_relative 'mtik/connection.rb'
 
   ## Default MikroTik RouterOS API TCP port:
   PORT = 8728
+  ## Default MikroTik RouterOS API-SSL TCP port:
+  PORT_SSL = 8729
   ## Default username to use if none is specified:
   USER = 'admin'
   ## Default password to use if none is specified:
   PASS = ''
-  ## Connection timeout default -- *NOT USED* 
+  ## Connection timeout default -- *NOT USED*
   CONN_TIMEOUT = 60
   ## Command timeout -- The maximum number of seconds to wait for more
   ## API data when expecting one or more command responses.
@@ -56,6 +58,9 @@ module MTik
   ## Maximum number of replies before a command is auto-canceled:
   MAXREPLIES   = 1000
 
+  ## SSL is set to false by default
+  USE_SSL = false
+
   @verbose = false
   @debug   = false
 
@@ -81,12 +86,30 @@ module MTik
 
 
   ## Act as an interactive client with the device, accepting user
-  ## input from STDIN.
-  def self.interactive_client(host, user, pass)
+  ## input from STDIN.  Arguments are key/value pairs, and are
+  ## simply passed directly to MTik::Connection().  The below
+  ## documentation is taken directly from MTik::Connection. One
+  ## more ## key/value pair style arguments must be specified.
+  ## The one ## required argument is the host or IP of the device
+  ## to connect to.
+  ## +host+:: This is the only _required_ argument. Example:
+  ##          <i> :host => "rb411.example.org" </i>
+  ## +ssl+::  Use SSL to encrypt communications
+  ## +port+:: Override the default API port (8728/8729)
+  ## +user+:: Override the default API username ('admin')
+  ## +pass+:: Override the default API password (blank)
+  ## +conn_timeout+:: Override the default connection
+  ##                  timeout (60 seconds)
+  ## +cmd_timeout+::  Override the default command timeout
+  ##                  (60 seconds) -- the number of seconds
+  ##                  to wait for additional API input.
+  ## +unencrypted_plaintext+::  Attempt to use the 6.43+ login API
+  ##                            even without SSL
+  def self.interactive_client(args)
     old_verbose = MTik::verbose
     MTik::verbose = true
     begin
-      tk = MTik::Connection.new(:host => host, :user => user, :pass => pass)
+      tk = MTik::Connection.new(args)
     rescue MTik::Error, Errno::ECONNREFUSED => e
       print "=== LOGIN ERROR: #{e.message}\n"
       exit
@@ -127,7 +150,7 @@ module MTik
               cmd == '/tool/fetch' && sentence['status'] == 'finished'
             ) || (maxreply > 0 && count == maxreply)
               state = 2
-              req.cancel do |r, s|  
+              req.cancel do |r, s|
                 state = 1
               end
             end
@@ -154,7 +177,7 @@ module MTik
         end
       end
     end
- 
+
     reply = tk.get_reply('/quit')
     unless reply[0].key?('!fatal')
       raise MTik::Error.new("Unexpected response to '/quit' command.")
@@ -240,16 +263,9 @@ module MTik
   ## Remember that the limit applies separately to each API command
   ## executed.
   def self.command(args)
-    tk = MTik::Connection.new(
-      :host => args[:host],
-      :user => args[:user],
-      :pass => args[:pass],
-      :port => args[:port],
-      :conn_timeout => args[:conn_timeout],
-      :cmd_timeout  => args[:cmd_timeout]
-    )
-    limit = args[:limit]  ## Optional reply limit
-    cmd = args[:command]
+    tk      = MTik::Connection.new(args)
+    limit   = args[:limit]  ## Optional reply limit
+    cmd     = args[:command]
     replies = Array.new
     if cmd.is_a?(String)
       ## Single command, no arguments

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
@@ -39,6 +39,7 @@
 class MTik::Connection
   require 'socket'
   require 'digest/md5'
+  require 'openssl'
 
   ## Initialize/construct the new _MTik_ object.  One or more
   ## key/value pair style arguments must be specified. The one
@@ -46,7 +47,8 @@ class MTik::Connection
   ## to.
   ## +host+:: This is the only _required_ argument. Example:
   ##          <i> :host => "rb411.example.org" </i>
-  ## +port+:: Override the default API port (8728)
+  ## +ssl+::  Use SSL to encrypt communications
+  ## +port+:: Override the default API port (8728/8729)
   ## +user+:: Override the default API username ('admin')
   ## +pass+:: Override the default API password (blank)
   ## +conn_timeout+:: Override the default connection
@@ -54,18 +56,22 @@ class MTik::Connection
   ## +cmd_timeout+::  Override the default command timeout
   ##                  (60 seconds) -- the number of seconds
   ##                  to wait for additional API input.
+  ## +unencrypted_plaintext+::  Attempt to use the 6.43+ login API even without SSL
   def initialize(args)
-    @sock         = nil
-    @requests     = Hash.new
-    @host         = args[:host]
-    @port         = args[:port] || MTik::PORT
-    @user         = args[:user] || MTik::USER
-    @pass         = args[:pass] || MTik::PASS
-    @conn_timeout = args[:conn_timeout] || MTik::CONN_TIMEOUT
-    @cmd_timeout  = args[:cmd_timeout]  || MTik::CMD_TIMEOUT
-    @data         = ''
-    @parsing      = false  ## Recursion flag
-    @os_version   = nil
+    @sock                  = nil
+    @ssl_sock              = nil
+    @requests              = Hash.new
+    @use_ssl               = args[:ssl] || MTik::USE_SSL
+    @unencrypted_plaintext = args[:unencrypted_plaintext]
+    @host                  = args[:host]
+    @port                  = args[:port] || (@use_ssl ? MTik::PORT_SSL : MTik::PORT)
+    @user                  = args[:user] || MTik::USER
+    @pass                  = args[:pass] || MTik::PASS
+    @conn_timeout          = args[:conn_timeout] || MTik::CONN_TIMEOUT
+    @cmd_timeout           = args[:cmd_timeout]  || MTik::CMD_TIMEOUT
+    @data                  = ''
+    @parsing               = false  ## Recursion flag
+    @os_version            = nil
 
     ## Initiate connection and immediately login to device:
     login
@@ -95,28 +101,41 @@ class MTik::Connection
       raise MTik::Error.new("Login failed: Unable to connect to device.")
     end
 
-    ## Send first /login command to obtain the challenge:
-    reply = get_reply('/login')
-    ## Make sure the reply has the info we expect:
-    if reply.length != 1 || reply[0].length != 3 || !reply[0].key?('ret')
-      raise MTik::Error.new("Login failed: unexpected reply to login attempt.")
+    # Try using the the post-6.43 login API; on older routers this still initiates
+    # a regular challenge-response cycle.
+    if @use_ssl || @unencrypted_plaintext
+      warn("SENDING PLAINTEXT PASSWORD OVER UNENCRYPTED CONNECTION") unless @use_ssl
+      reply = get_reply('/login',["=name=#{@user}","=password=#{@pass}"])
+      if reply.length == 1 && reply[0].length == 2 && reply[0].key?('!done')
+        v_6_43_login_successful = true
+      end
+    else
+      ## Just send first /login command to obtain the challenge, if not using SSL
+      reply = get_reply('/login')
     end
 
-    ## Grab the challenge from first (only) sentence in the reply:
-    challenge = hex2bin(reply[0]['ret'])
+    unless v_6_43_login_successful
+      ## Make sure the reply has the info we expect for challenge-response authentication:
+      if reply.length != 1 || reply[0].length != 3 || !reply[0].key?('ret')
+        raise MTik::Error.new("Login failed: unexpected reply to login attempt.")
+      end
 
-    ## Generate reply MD5 hash and convert binary hash to hex string:
-    response  = Digest::MD5.hexdigest(0.chr + @pass + challenge)
+      ## Grab the challenge from first (only) sentence in the reply:
+      challenge = hex2bin(reply[0]['ret'])
 
-    ## Send second /login command with our response:
-    reply = get_reply('/login', '=name=' + @user, '=response=00' + response)
-    if reply[0].key?('!trap')
-      raise MTik::Error.new("Login failed: " + (reply[0].key?('message') ? reply[0]['message'] : 'Unknown error.'))
-    end
-    unless reply.length == 1 && reply[0].length == 2 && reply[0].key?('!done')
-      @sock.close
-      @sock = nil
-      raise MTik::Error.new('Login failed: Unknown response to login.')
+      ## Generate reply MD5 hash and convert binary hash to hex string:
+      response  = Digest::MD5.hexdigest(0.chr + @pass + challenge)
+
+      ## Send second /login command with our response:
+      reply = get_reply('/login', '=name=' + @user, '=response=00' + response)
+      if reply[0].key?('!trap')
+        raise MTik::Error.new("Login failed: " + (reply[0].key?('message') ? reply[0]['message'] : 'Unknown error.'))
+      end
+      unless reply.length == 1 && reply[0].length == 2 && reply[0].key?('!done')
+        @sock.close
+        @sock = nil
+        raise MTik::Error.new('Login failed: Unknown response to login.')
+      end
     end
 
     ## Request the RouterOS version of the device as different versions
@@ -132,27 +151,37 @@ class MTik::Connection
     return unless @sock.nil?
     ## TODO: Perhaps catch more errors
     begin
-      addr = Socket.getaddrinfo(@host, nil)
+      addr  = Socket.getaddrinfo(@host, nil)
       @sock = Socket.new(Socket.const_get(addr[0][0]), Socket::SOCK_STREAM, 0)
 
       begin
         @sock.connect_nonblock(Socket.pack_sockaddr_in(@port, addr[0][3]))
       rescue Errno::EINPROGRESS
         ready = IO.select([@sock], [@sock], [], @conn_timeout)
-        if ready
-          @sock
-        else
-          raise Errno::ETIMEDOUT
+        raise Errno::ETIMEDOUT unless ready
       end
-    end
 
-    rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::ENETUNREACH,
+      connect_ssl(@sock) if @use_ssl
+    rescue Errno::ECONNREFUSED,
+           Errno::ETIMEDOUT,
+           Errno::ENETUNREACH,
            Errno::EHOSTUNREACH => e
       @sock = nil
       raise e ## Re-raise the exception
     end
   end
 
+  def connect_ssl(sock)
+    ssl_context = OpenSSL::SSL::SSLContext.new()
+    ssl_context.ciphers = ['HIGH']
+    ssl_socket = OpenSSL::SSL::SSLSocket.new(sock, ssl_context)
+    ssl_socket.sync_close = true
+    unless ssl_socket.connect
+      raise MTik::Error.new("Cannot establish SSL connection.")
+    end
+    @ssl_sock = ssl_socket
+  end
+
   ## Wait for and read exactly one sentence, regardless of content:
   def get_sentence
     ## TODO: Implement timeouts, detect disconnection, maybe do auto-reconnect
@@ -206,7 +235,8 @@ class MTik::Connection
       end
       oldlen = @data.length
       ## Read some more data IF any is available:
-      sel = IO.select([@sock],nil,[@sock], @cmd_timeout)
+      sock = @ssl_sock || @sock
+      sel = IO.select([sock],nil,[sock], @cmd_timeout)
       if sel.nil?
         raise MTik::TimeoutError.new(
           "Time-out while awaiting data with #{outstanding} pending " +
@@ -214,7 +244,7 @@ class MTik::Connection
         )
       end
       if sel[0].length == 1
-        @data += @sock.recv(8192)
+        @data += recv(8192)
       elsif sel[2].length == 1
         raise MTik::Error.new(
           "I/O (select) error while awaiting data with #{outstanding} pending " +
@@ -384,10 +414,45 @@ class MTik::Connection
 
   ## Send the request object over the socket
   def xmit(req)
-    @sock.send(req.request, 0)
+    begin
+      if @ssl_sock
+        @ssl_sock.write(req.request)
+      else
+        @sock.send(req.request, 0)
+      end
+    rescue Errno::EPIPE => e
+      @sock = @ssl_sock = nil
+      raise e ## Re-raise the exception
+    end
     return req
   end
 
+  def recv(buffer_size)
+    if @ssl_sock
+      recv_openssl(buffer_size)
+    else
+      @sock.recv(buffer_size)
+    end
+  end
+
+  # 2 cases for backwards compatibility
+  def recv_openssl(buffer_size)
+    if OpenSSL::SSL.const_defined? 'SSLErrorWaitReadable'.freeze
+      begin
+        @ssl_sock.read_nonblock(buffer_size)
+      rescue OpenSSL::SSL::SSLErrorWaitReadable
+        ''
+      end
+    else
+      begin
+        @ssl_sock.read_nonblock(buffer_size)
+      rescue OpenSSL::SSL::SSLError => e
+        return '' if e.message == 'read would block'.freeze
+        raise e
+      end
+    end
+  end
+
   ## Send a command, then wait for the command to complete, then return
   ## the completed reply.
   ##
@@ -420,8 +485,10 @@ class MTik::Connection
 
   ## Close the connection.
   def close
-    return if @sock.nil?
-    @sock.close
+    return if @sock.nil? and @ssl_sock.nil?
+    @ssl_sock.close if @ssl_sock and !@ssl_sock.closed?
+    @sock.close if @sock and !@sock.closed?
+    @ssl_sock = nil
     @sock = nil
   end
 

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.0.3
+  version: 4.1.2
 platform: ruby
 authors:
 - Aaron D. Gifford
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-06-06 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
@@ -16,6 +16,7 @@ executables:
 - tikcli
 - tikcommand
 - tikfetch
+- tikjson
 extensions: []
 extra_rdoc_files:
 - README.txt
@@ -28,7 +29,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,27 +37,26 @@ 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: 
+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: mtik
-rubygems_version: 2.2.1
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: MTik implements the MikroTik RouterOS API for use in Ruby.
 test_files: []

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"
-