routeros-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c6115c02446080bc47d5ad9b98e15e19cb34771adfce52ebd0919d2c61cac6
-  data.tar.gz: 63287c6efaba8a6d654d5ca939f6aa2cb1f301077561bce58a5db7e7b43a01cd
+  metadata.gz: b5febdeccbba11422cb6b855ea59a0f9fb065d375f8782c0ba6771c083d8d2bf
+  data.tar.gz: 27aab05e7586a813b76ebd300d212828d8dcad0b1347485a3878774f21299a11
 SHA512:
-  metadata.gz: 8f9ccae171b00da8b4dc1216bede71a1608ba252264e708140fc757a4fd14e35c832d6829192996c2859c7376f8f0e540f7c48ede314a88887366ec2490f6b43
-  data.tar.gz: e72a2576902ab545c98daf4336b16b1d1c9e236f28397fe3af7fed022609981b62a7abeef9857f82b154ce2f49f25ca76badcdd05e410cf29b3c0c1068ac17f8
+  metadata.gz: 70e416037d768b5e1c7e9c04db9849703409db8c6d64c14a1015c51c671a2c2f50bb237898a37cbddd6d959fe0696bcb0252f7f80c4f358908b833ecf5ddf039
+  data.tar.gz: 38f1a4a21045413c7e5f31b12362ebc52e746245c79dc5357ce1d0a1a373fd17883e4023da38a695aa9c347f1f554313177bd623428d8ed12ce29408200ed43b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.4.0] - 2024-10-22
+
+- Support `async` gem
+
 ## [0.3.0] - 2024-10-16
 
 - SSL support

data/README.md

@@ -24,10 +24,9 @@ if response.ok?
 end
 ```
 
-## Planned Features
+### Async
 
-- [ ] 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

@@ -9,7 +9,7 @@ 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

@@ -2,6 +2,7 @@
 
 require "socket"
 require "openssl"
+require_relative "async"
 require_relative "request"
 require_relative "response"
 require_relative "word_stream"
@@ -9,7 +10,9 @@ require_relative "word_stream"
 module RouterOS
   # Main abstraction to connect to RouterOS
   class API
-    VERSION = "0.3.0"
+    include RouterOS::Async
+
+    VERSION = "0.4.0"
 
     class Error < StandardError; end
 

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routeros-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marcelo Barros
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -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