routeros-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7eb704522500000ae772fe0c97412127677a31ddbd861899ba1365f923d71f8e
+  data.tar.gz: 5a4f49fb090e5742d93b2a3cc4e10485beff8eece3a5d4351832cf7d8e4c4c32
+SHA512:
+  metadata.gz: 8678dfcbbbcc942b98b0190d2e4ae54e0ebd90bc421d5920b8f8876b7a07c384473526b6579fb3fd6e82634c03c80399b9a64a622ae3ce93406e760f62e08442
+  data.tar.gz: 943ac4f6b61fdc10d51a14fb10af4cdbd2d5848d36f78423d6fb2f462cac999d6a5196775b241aab10bae178ddba58ad5f2f363c5c7b7f8b467a6cffdd7974cd

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# RouterOS::API
+
+Simple Ruby implementation of the [RouterOS API protocol](https://help.mikrotik.com/docs/display/ROS/API).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add routeros-api
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install routeros-api
+
+## Usage
+
+```ruby
+api = RouterOS::API.new('192.168.1.1', 8728)
+response = api.login('admin', 'my_password')
+
+if response.ok?
+  response = api.command('ip/route/getall')
+  puts(response.data)
+end
+```
+
+## Planned Features
+
+- [ ] SSL support
+- [ ] Async support
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mcbarros/routeros-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mcbarros/routeros-api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RouterOS::API project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/routeros-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/examples/simple.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "../lib/routeros/api"
+
+api = RouterOS::API.new("192.168.1.1", 8728)
+response = api.login("admin", "my-secret-password")
+puts(response) # (OK) []
+
+if response.ok?
+  response = api.command("ip/route/getall")
+  puts(response.data) # [{ ... }]
+end

data/lib/routeros/api.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "socket"
+require_relative "request"
+require_relative "response"
+require_relative "word_stream"
+
+module RouterOS
+  # Main abstraction to connect to RouterOS
+  class API
+    VERSION = "0.1.0"
+
+    class Error < StandardError; end
+
+    def initialize(host, port)
+      @stream = RouterOS::WordStream.new(TCPSocket.new(host, port))
+      @tag = 0
+    end
+
+    def command(cmd, args = [])
+      send_request(create_request(cmd, args))
+      read_response
+    end
+
+    def login(name, password)
+      command("/login", { name: name, password: password })
+    end
+
+    private
+
+    def create_request(cmd, args)
+      @tag += 1
+      RouterOS::Request.new(cmd, args, @tag)
+    end
+
+    def send_request(request)
+      request.each do |word|
+        @stream.write_word(word)
+      end
+
+      @stream.write_word("")
+    end
+
+    def read_response
+      response = []
+
+      loop do
+        sentence = read_sentence
+
+        response << sentence
+
+        break if sentence.include? "!done"
+      end
+
+      RouterOS::Response.new(response)
+    end
+
+    def read_sentence
+      sentence = []
+
+      loop do
+        word = @stream.read_word
+
+        break if word.size.zero?
+
+        sentence << word
+      end
+
+      sentence
+    end
+  end
+end

data/lib/routeros/request.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RouterOS
+  # Class used to create a request to be sent to RouterOS
+  class Request
+    attr_reader :sentence
+
+    def initialize(cmd, args, tag = nil)
+      args = args.map { |k, v| Request.attr_word(k, v) } if args.is_a?(Hash)
+      args = args.reject { |v| v.start_with?(".tag") }
+
+      @tag = tag
+      @sentence = [
+        cmd.start_with?("/") ? cmd : "/#{cmd}",
+        *args
+      ]
+
+      @sentence << ".tag=#{@tag}" unless @tag.nil?
+      @sentence.freeze
+    end
+
+    def each(&block)
+      @sentence.each(&block)
+    end
+
+    def to_s
+      @sentence.join(" ")
+    end
+
+    def self.attr_word(key, value)
+      "=#{key}=#{value.nil? ? "" : value}"
+    end
+  end
+end

data/lib/routeros/response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RouterOS
+  # Represents a parsed RouterOS response
+  class Response
+    attr_reader :raw_sentences, :data, :tag
+
+    def initialize(sentences)
+      @raw_sentences = sentences
+      @tag = nil
+      @error = nil
+      @data = []
+
+      sentences.each do |sentence|
+        if sentence.include?("!re")
+          @data << Response.parse_data_sentence(sentence)
+        elsif sentence.include?("!done")
+          @tag = Response.parse_done_sentence(sentence)
+        elsif sentence.include?("!trap")
+          @error = Response.parse_error_sentence(sentence)
+        end
+      end
+    end
+
+    def ok?
+      @error.nil?
+    end
+
+    def error?
+      !ok?
+    end
+
+    def error_message
+      @error
+    end
+
+    def to_s
+      "(#{ok? ? "OK" : "ERROR"}) #{ok? ? data : error_message}"
+    end
+
+    def self.parse_data_sentence(sentence)
+      data_words = sentence[1..].reject { |word| word.start_with?(".") }
+      data_fields = data_words.map { |word| Response.parse_field(word) }
+      Hash[*data_fields.flatten]
+    end
+
+    def self.parse_done_sentence(sentence)
+      return nil unless sentence.size > 1
+
+      parsed = Response.parse_field(sentence.last)
+      parsed[1]
+    end
+
+    def self.parse_error_sentence(sentence)
+      parsed = Response.parse_field(sentence.last)
+      parsed[1]
+    end
+
+    def self.parse_field(word)
+      key, value = word[1..].split("=", 2)
+      [key.to_sym, value]
+    end
+  end
+end

data/lib/routeros/word_stream.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RouterOS
+  # Class used for the communication with the RouterOS device.
+  # This class abstracts the encoding and decoding of words.
+  # See more on: https://help.mikrotik.com/docs/display/ROS/API#API-APIwords
+  class WordStream
+    def initialize(stream)
+      @stream = stream
+    end
+
+    # writes an encoded word to the underlying stream
+    def write_word(word)
+      @stream.write(WordStream.encode_length(word.size) + word)
+    end
+
+    # reads a decodes a word from the underlying stream
+    def read_word
+      @stream.read(read_length)
+    end
+
+    # utility to encode the length
+    def self.encode_length(length)
+      case length
+      when 0..0x7F
+        lowest_bytes(length, 1)
+      when 0x80..0x3FFF
+        lowest_bytes(length | 0x8000, 2)
+      when 0x4000..0x1FFFFF
+        lowest_bytes(length | 0xC00000, 3)
+      when 0x200000..0xFFFFFFF
+        lowest_bytes(length | 0xE0000000, 4)
+      else
+        0xF0.chr + lowest_bytes(length, 4)
+      end
+    end
+
+    # utility to get only the lowest bytes of a given number
+    def self.lowest_bytes(num, size)
+      r = String.new
+
+      while r.length != size
+        shift = num >> (r.length * 8)
+        r = (shift & 0xFF).chr + r
+      end
+
+      r
+    end
+
+    private
+
+    # reads the length from the underlying stream
+    def read_length
+      length = @stream.readbyte
+      mask = 0xFF
+
+      if length & 0x80 == 0x00 # first bit is 0
+        byte_amount = 1
+      elsif length & 0xC0 == 0x80 # first bit is 1, second bit is 0
+        byte_amount = 2
+        mask = 0x7F
+      elsif length & 0xE0 == 0xC0 # first and second bits are 1, third bit is 0
+        byte_amount = 3
+        mask = 0x3F
+      elsif length & 0xF0 == 0xE0 # first, second and third bits are 1, fourth bit is 0
+        byte_amount = 4
+        mask = 0x1F
+      elsif length & 0xF8 == 0xF0 # first, second, third and fourth bits are 1, fifth is 0
+        length = @stream.readbyte
+        byte_amount = 3
+      end
+
+      length &= mask
+
+      (byte_amount - 1).times do
+        length <<= 8
+        length += @stream.readbyte
+      end
+
+      length
+    end
+  end
+end

data/sig/routeros/api.rbs

@@ -0,0 +1,6 @@
+module RouterOS
+  class API
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: routeros-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Barros
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-13 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- mcbarros@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/simple.rb
+- lib/routeros/api.rb
+- lib/routeros/request.rb
+- lib/routeros/response.rb
+- lib/routeros/word_stream.rb
+- sig/routeros/api.rbs
+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/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Ruby lib to access RouterOS API.
+test_files: []