routeros-api 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f63f8077dd7855c9c67297abc2801872eb3de689f0fce401d37adf4edbac1d3b
-  data.tar.gz: 43e84dd99ef9e1ee7b8e83fddb14a730bfb35c715564c8a0bc8fc5030e9fdc65
+  metadata.gz: b5febdeccbba11422cb6b855ea59a0f9fb065d375f8782c0ba6771c083d8d2bf
+  data.tar.gz: 27aab05e7586a813b76ebd300d212828d8dcad0b1347485a3878774f21299a11
 SHA512:
-  metadata.gz: d2233021b902cb11e23c911dcf35112d9f2b31845b6760f140bc473498cb460e9efbbbe691ff0ac91145cfb6b76b8615fb90484ec0ee9e0d09975192eab06d2f
-  data.tar.gz: 3ca944848e4d942aea06f6ec8ad32c3ed2cf8d932e89ed172bda0ea6a0236f9673a80cb8afcf1e34eaa2e753633cdc17b92431c3b1f88579feae03875b0ba7d0
+  metadata.gz: 70e416037d768b5e1c7e9c04db9849703409db8c6d64c14a1015c51c671a2c2f50bb237898a37cbddd6d959fe0696bcb0252f7f80c4f358908b833ecf5ddf039
+  data.tar.gz: 38f1a4a21045413c7e5f31b12362ebc52e746245c79dc5357ce1d0a1a373fd17883e4023da38a695aa9c347f1f554313177bd623428d8ed12ce29408200ed43b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.4.0] - 2024-10-22
+
+- Support `async` gem
+
+## [0.3.0] - 2024-10-16
+
+- SSL support
+
 ## [0.2.0] - 2024-10-16
 
 - Parsing of known number and boolean values

data/README.md

@@ -24,11 +24,9 @@ if response.ok?
 end
 ```
 
-## Planned Features
+### Async
 
-- [ ] SSL support
-- [ ] Async support
-- [ ] Auto deploy and auto changelog
+Async gem is supported but not required, if the gem can be loaded a method `async_command` will be available. Look at the examples folder for a full example.
 
 ## Development
 

data/examples/async.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "routeros/api"
+
+api = RouterOS::API.new("192.168.1.1", 8728, ssl: false)
+response = api.login("test", "test")
+puts(response) # (OK) []
+
+if response.ok?
+  if RouterOS::API.async_enabled?
+    response = api.async_command("ip/route/getall")
+    puts(response) # Async::Task
+    puts(response.wait.data) # [{ ... }]
+  else
+    warn('asyn gem could not be loaded')
+  end
+end
+
+api.close

data/examples/simple.rb

@@ -3,11 +3,13 @@
 require "bundler/setup"
 require "routeros/api"
 
-api = RouterOS::API.new("192.168.1.1", 8728)
-response = api.login("lupadmin", "M0N3frHsuS)6:")
+api = RouterOS::API.new("192.168.1.1", 8728, ssl: false)
+response = api.login("test", "test")
 puts(response) # (OK) []
 
 if response.ok?
   response = api.command("ip/route/getall")
-  puts(response.data) # (OK) [{ ... }]
+  puts(response.data) # [{ ... }]
 end
+
+api.close

data/lib/routeros/api.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "socket"
+require "openssl"
+require_relative "async"
 require_relative "request"
 require_relative "response"
 require_relative "word_stream"
@@ -8,12 +10,25 @@ require_relative "word_stream"
 module RouterOS
   # Main abstraction to connect to RouterOS
   class API
-    VERSION = "0.2.0"
+    include RouterOS::Async
+
+    VERSION = "0.4.0"
 
     class Error < StandardError; end
 
-    def initialize(host, port)
-      @stream = RouterOS::WordStream.new(TCPSocket.new(host, port))
+    def initialize(host, port, ssl: false, ssl_ctx: nil)
+      raw_socket = TCPSocket.new(host, port)
+
+      if ssl
+        ssl_socket = OpenSSL::SSL::SSLSocket.new(raw_socket, ssl_ctx || OpenSSL::SSL::SSLContext.new)
+        ssl_socket.connect
+        socket = ssl_socket
+      else
+        socket = raw_socket
+      end
+
+      @ssl = ssl
+      @stream = RouterOS::WordStream.new(socket)
       @tag = 0
     end
 
@@ -23,7 +38,12 @@ module RouterOS
     end
 
     def login(name, password)
-      command("/login", { name: name, password: password })
+      warn("non encrypted connection, be careful") unless @ssl
+      command("/login", { name:, password: })
+    end
+
+    def close
+      @stream.close
     end
 
     private
@@ -49,7 +69,7 @@ module RouterOS
 
         response << sentence
 
-        break if sentence.include? "!done"
+        break if sentence.include?("!done")
       end
 
       RouterOS::Response.new(response)

data/lib/routeros/async.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RouterOS
+  # adds async support if async gem is present
+  module Async
+    @enabled = false
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def self.enabled?
+      @enabled
+    end
+
+    # class methods to be added when this module is included
+    module ClassMethods
+      def async_enabled?
+        RouterOS::Async.enabled?
+      end
+    end
+
+    begin
+      require 'async'
+
+      def async_command(cmd, args = [])
+        Async do
+          command(cmd, args)
+        end
+      end
+
+      @enabled = true
+    rescue LoadError
+      # async gem is not available, so no-op
+    end
+  end
+end

data/lib/routeros/response.rb

@@ -3,8 +3,8 @@
 module RouterOS
   # Represents a parsed RouterOS response
   class Response
-    KNOWN_NUMBER_FIELDS = %i[scope distance target-scope]
-    KNOWN_BOOLEAN_VALUES = %w[true false]
+    KNOWN_NUMBER_FIELDS = %i[scope distance target-scope].freeze
+    KNOWN_BOOLEAN_VALUES = %w[true false].freeze
 
     attr_reader :raw_sentences, :data, :tag
 

data/lib/routeros/word_stream.rb

@@ -19,6 +19,10 @@ module RouterOS
       @stream.read(read_length)
     end
 
+    def close
+      @stream.close
+    end
+
     # utility to encode the length
     def self.encode_length(length)
       case length
@@ -49,9 +53,14 @@ module RouterOS
 
     private
 
+    def readbyte
+      bytes = @stream.read(1).bytes
+      bytes[0]
+    end
+
     # reads the length from the underlying stream
     def read_length
-      length = @stream.readbyte
+      length = readbyte
       mask = 0xFF
 
       if length & 0x80 == 0x00 # first bit is 0
@@ -66,7 +75,7 @@ module RouterOS
         byte_amount = 4
         mask = 0x1F
       elsif length & 0xF8 == 0xF0 # first, second, third and fourth bits are 1, fifth is 0
-        length = @stream.readbyte
+        length = readbyte
         byte_amount = 3
       end
 
@@ -74,7 +83,7 @@ module RouterOS
 
       (byte_amount - 1).times do
         length <<= 8
-        length += @stream.readbyte
+        length += readbyte
       end
 
       length

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: routeros-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marcelo Barros
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies: []
-description:
+description: 
 email:
 - mcbarros@gmail.com
 executables: []
@@ -23,8 +23,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/async.rb
 - examples/simple.rb
 - lib/routeros/api.rb
+- lib/routeros/async.rb
 - lib/routeros/request.rb
 - lib/routeros/response.rb
 - lib/routeros/word_stream.rb
@@ -33,10 +35,9 @@ homepage: https://github.com/mcbarros/routeros-api
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/mcbarros/routeros-api
   source_code_uri: https://github.com/mcbarros/routeros-api
   changelog_uri: https://github.com/mcbarros/routeros-api/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -52,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.16
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Ruby lib to access RouterOS API.
 test_files: []