mtik 3.1.1 → 3.1.2

data/CHANGELOG.txt

@@ -1,3 +1,17 @@
+2011-01-11 (11 JAN 2011)  VERSION 3.1.2  Aaron D. Gifford (http://www.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
+ * Moved tikfetch.rb, tikcli.rb, and tikcommand.rb from examples/ to bin/ and removed
+   the .rb suffix -- left tikjson.rb behind in examples/
+ * 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)
+ * 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)
  * Added find_sentences() method to MTik::Reply -- just sugar to Array.select()
  * Changed MTik::Connection.fetch() method to add an optional timeout parameter

data/LICENSE.txt

@@ -5,7 +5,7 @@
 #
 #++
 # Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -11,7 +11,6 @@ gemspec = Gem::Specification.new do |spec|
   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.has_rdoc     = true ## Only partially true currently
   spec.rubyforge_project = 'mtik'
   spec.extra_rdoc_files  = [ 'README.txt' ]
   spec.require_paths     = [ 'lib' ]
@@ -21,10 +20,10 @@ gemspec = Gem::Specification.new do |spec|
     'README.txt',
     'VERSION.txt',
     'Rakefile',
-    'examples/tikcli.rb',
-    'examples/tikcommand.rb',
-    'examples/tikfetch.rb',
     'examples/tikjson.rb',
+    'bin/tikcli',
+    'bin/tikcommand',
+    'bin/tikfetch',
     'lib/mtik.rb',
     'lib/mtik/connection.rb',
     'lib/mtik/error.rb',
@@ -33,6 +32,7 @@ gemspec = Gem::Specification.new do |spec|
     'lib/mtik/request.rb',
     'lib/mtik/timeouterror.rb'
   ]
+  spec.executables = [ 'tikcli', 'tikcommand', 'tikfetch' ]
 end
 
 Rake::GemPackageTask.new(gemspec) do |pkg|

data/VERSION.txt

@@ -1 +1 @@
-3.1.1
+3.1.2

data/{examples/tikcli.rb → bin/tikcli}

@@ -6,7 +6,7 @@
 #
 #++
 # Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without
@@ -35,6 +35,8 @@
 # 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'

data/{examples/tikcommand.rb → bin/tikcommand}

@@ -6,7 +6,7 @@
 #
 #++
 # Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without
@@ -35,6 +35,8 @@
 # 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'

data/{examples/tikfetch.rb → bin/tikfetch}

@@ -6,7 +6,7 @@
 #
 #++
 # Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without
@@ -35,6 +35,8 @@
 # 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'

data/examples/tikjson.rb

@@ -6,7 +6,7 @@
 #
 #++
 # Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without
@@ -35,6 +35,8 @@
 # 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'

data/lib/mtik.rb

@@ -2,7 +2,7 @@
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
 ## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,8 @@
 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 ## THE POSSIBILITY OF SUCH DAMAGE.
 ############################################################################
+# encoding: ASCII-8BIT
+
 module MTik
   require 'mtik/error.rb'
   require 'mtik/fatalerror.rb'
@@ -122,7 +124,7 @@ module MTik
               cmd == '/tool/fetch' && sentence.key?('status') && sentence['status'] == 'finished'
             ) || (maxreply > 0 && count == maxreply)
               state = 2
-              req.cancel do |req, sentence|  
+              req.cancel do |r, s|  
                 state = 1
               end
             end

data/lib/mtik/connection.rb

@@ -2,7 +2,7 @@
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
 ## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,7 @@
 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 ## THE POSSIBILITY OF SUCH DAMAGE.
 ############################################################################
+# encoding: ASCII-8BIT
 
 ## The MTik::Connection class is the workhorse where most stuff gets done.
 ## Create an instance of this object to connect to a MikroTik device via
@@ -336,10 +337,10 @@ class MTik::Connection
   ##                    
   def send_request(await_completion, command, *args, &callback)
     if await_completion.is_a?(MTik::Request)
+      req = await_completion
       if req.done?
         raise MTik::Error.new("Cannot MTik#send_request() with an already-completed MTik::Request object.")
       end
-      req = await_completion
       req.addarg(command)
       req.addargs(*args)
     else
@@ -511,7 +512,7 @@ class MTik::Connection
       '/tool/fetch',
       '=url=' + url,
       '=dst-path=' + filename
-    ) do |req, s|
+    ) do |r, s|
       if s.key?('!re') && !done
         unless s.key?('status')
           raise MTik::Error.new("Unknown response to '/tool/fetch': missing 'status' in response.")
@@ -525,24 +526,24 @@ class MTik::Connection
             lastactivity = Time.now
           elsif timeout != 0 && !timeout.nil? && Time.now - lastactivity > timeout
             ## Cancel the request (idle too long):
-            get_reply('/cancel', '=tag=' + req.tag) {}
+            get_reply('/cancel', '=tag=' + r.tag) {}
           end
-          callback.call(status, total, bytes, req)
+          callback.call(status, total, bytes, r)
         when 'connecting', 'requesting'
-          callback.call(status, 0, 0, req)
+          callback.call(status, 0, 0, r)
         when 'failed', 'finished'
           bytes = total if status == 'finished'
-          callback.call(status, total, bytes, req)
+          callback.call(status, total, bytes, r)
           done = true
           ## Now terminate the download request (since it's done):
-          get_reply('/cancel', '=tag=' + req.tag) {}
+          get_reply('/cancel', '=tag=' + r.tag) {}
         else
           raise MTik::Error.new("Unknown status in '/tool/fetch' response: '#{status}'")
         end
       elsif s.key?('!trap')
         ## Pass trap message back (unless finished--in which case we
         ## ignore the 'interrrupted' trap message):
-        callback.call(s['message'], total, bytes, req) if !done
+        callback.call(s['message'], total, bytes, r) if !done
       end
     end
   end
@@ -605,8 +606,8 @@ class MTik::Connection
           if s.key?(key)
             ## A key matches! && s[k] != v
             oldv = s[k]
-            get_reply(cmdpath + '/set', '='+k+'='+v) do |req, s|
-              trap = req.reply.find_sentence('!trap')
+            get_reply(cmdpath + '/set', '='+k+'='+v) do |r, sn|
+              trap = r.reply.find_sentence('!trap')
               unless trap.nil?
                 raise MTik::Error.new("Trap while executing '#{cmdpath}/set =#{k}=#{v}': #{trap['message']}")
               end

data/lib/mtik/error.rb

@@ -2,7 +2,7 @@
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
 ## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,7 @@
 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 ## THE POSSIBILITY OF SUCH DAMAGE.
 ############################################################################
+# encoding: ASCII-8BIT
 
 ## Basic execption type raised by this code
 class MTik::Error < RuntimeError ; end

data/lib/mtik/fatalerror.rb

@@ -2,7 +2,7 @@
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
 ## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,7 @@
 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 ## THE POSSIBILITY OF SUCH DAMAGE.
 ############################################################################
+# encoding: ASCII-8BIT
 
 ## Execption raised when a <i>"!fatal"</i> response is received from a device
 class MTik::FatalError < MTik::Error ; end

data/lib/mtik/reply.rb

@@ -2,7 +2,7 @@
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
 ## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,7 @@
 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 ## THE POSSIBILITY OF SUCH DAMAGE.
 ############################################################################
+# encoding: ASCII-8BIT
 
 ## A MikroTik API reply is stored as an array of response sentences. Each
 ## sentence is a key/value Hash object. The MTik::Reply class is simply

data/lib/mtik/request.rb

@@ -2,7 +2,7 @@
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
 ## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,7 @@
 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 ## THE POSSIBILITY OF SUCH DAMAGE.
 ############################################################################
+# encoding: ASCII-8BIT
 
 ## A MikroTik API request object is stored as an array of MikroTik
 ## API-style words, the first word being the command, subsequent words
@@ -67,7 +68,7 @@ class MTik::Request < Array
     @reply            = MTik::Reply.new
     @command          = command
     @await_completion = await_completion
-    @state            = 'new'  ## 'new', 'sent', 'cancelled', 'complete'
+    @state            = :new  ## :new, :sent, :canceled, :complete
     @conn             = nil
 
     args.flatten!
@@ -134,7 +135,7 @@ class MTik::Request < Array
   ## Return the boolean completion status of the request,
   ## _true_ if complete, _false_ if not-yet-complete.
   def done?
-    return @state == 'complete'
+    return @state == :complete
   end
 
   attr_reader :command, :tag, :await_completion, :reply, :state
@@ -232,39 +233,42 @@ class MTik::Request < Array
         "is not yet associated with an MTik::Connection object."
       )
     end
-    @state = 'sent'
+    @state = :sent
     return @conn.xmit(self)
   end
 
   ## Cancel a 'sent' request:
   def cancel(&callback)
-    if @state != 'sent'
+    if @state != :sent
       raise MTik::Error.new(
         "Method MTik::Request#cancel() called with state '#{@state}' " +
         "(should only call when state is 'sent')"
       )
     end
     @conn.send_request(true, '/cancel', '=tag=' + @tag, &callback)
-    @state = 'cancelled'
+    @state = :canceled
   end
 
   ## Cancel a 'sent' request:
   def cancel_each(&callback)
-    if @state != 'sent'
+    if @state != :sent
       raise MTik::Error.new(
         "Method MTik::Request#cancel() called with state '#{@state}' " +
         "(should only call when state is 'sent')"
       )
     end
     @conn.send_request(false, '/cancel', '=tag=' + @tag, &callback)
-    @state = 'cancelled'
+    @state = :canceled
   end
 
   ## Method the internal parser calls to flag this reply as completed
-  ## upon receipt of a <i>"!done"</i> reply sentence.
+  ## upon receipt of a <i>"!done"</i> reply sentence.  WARNING: If you
+  ## call this manually and another sentence arrives, an exception
+  ## will be raised!
   def done!
-    @state = 'complete'
+    @state = :complete
     return true
   end
+
 end
 

data/lib/mtik/timeouterror.rb

@@ -2,7 +2,7 @@
 ## A Ruby library implementing the Ruby MikroTik API
 ############################################################################
 ## Author::    Aaron D. Gifford - http://www.aarongifford.com/
-## Copyright:: Copyright (c) 2009-2010, InfoWest, Inc.
+## Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
 ## License::   BSD license
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,7 @@
 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 ## THE POSSIBILITY OF SUCH DAMAGE.
 ############################################################################
+# encoding: ASCII-8BIT
 
 ## Exception raised upon timeout
 class MTik::TimeoutError < MTik::Error ; end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 1
-  - 1
-  version: 3.1.1
+  - 2
+  version: 3.1.2
 platform: ruby
 authors: 
 - Aaron D. Gifford
@@ -14,14 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-30 00:00:00 -07:00
+date: 2011-01-11 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
 description: MTik implements the MikroTik RouterOS API for use in Ruby.
 email: email_not_accepted@aarongifford.com
-executables: []
-
+executables: 
+- tikcli
+- tikcommand
+- tikfetch
 extensions: []
 
 extra_rdoc_files: 
@@ -32,10 +34,10 @@ files:
 - README.txt
 - VERSION.txt
 - Rakefile
-- examples/tikcli.rb
-- examples/tikcommand.rb
-- examples/tikfetch.rb
 - examples/tikjson.rb
+- bin/tikcli
+- bin/tikcommand
+- bin/tikfetch
 - lib/mtik.rb
 - lib/mtik/connection.rb
 - lib/mtik/error.rb