argus-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b30a47739574ce10ff19e938e82785da1ae44087b77d6b11f82ba37bafda6e1c
+  data.tar.gz: 23051f5382d53c7dba8e94088f45a9c87659ed88d1fb51e2cb71de6876bc7967
+SHA512:
+  metadata.gz: f921326e1dd91f574c3204262e72c8c2d2ea5b4c114c7f6e7b00761fa936e7a9bffee89bd5662b962b8f85eb82c7b729315455c81414b1aea48a226469388f61
+  data.tar.gz: 1c3cd225c88ee62f586e228123675e7a6e43f5a7fdac3212d98305693e3c5a3409f6f0e1943f877d21d923159508a03a5162ea3ef2f014a20c335ea4d4de6b38

data/.yardopts

@@ -0,0 +1,5 @@
+--readme README.md
+--title 'Argus Ruby Documentation'
+--charset utf-8
+--markup markdown
+'lib/**/*.rb' - 'README.md' 'LICENSE'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kelechi Onyekwere
+
+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,45 @@
+# ARGUS Ruby Client 
+
+This is the official Ruby library for the [ARGUS Engine](https://github.com/Khelechy/argus), this library helps Ruby developers and applications seamlessly integrate to the ARGUS Engine, authentication and event listening.
+
+### Install via Gem
+
+```sh
+    gem install argus-ruby
+```
+You can use Bundler to add Argus Ruby to your project
+
+```sh
+    bundle add 'argus-ruby'
+```
+
+### Usage -
+
+```ruby
+
+   require 'argus'
+```
+
+Have a class to define the fucntion to be called when you receive an Argus Event
+
+```ruby
+    class Testsub
+        def on_event(argus_event)
+            puts "#{argus_event.Action}"
+            puts "#{argus_event.ActionDescription}"
+            puts "#{argus_event.Name}"
+            puts "#{argus_event.Timestamp}"
+        end
+    end
+```
+
+Finally use argus like so,
+
+```ruby
+    subscriber = Testsub.new
+
+    argus = Argus.new("testuser", "testpassword") // Optionally you can pass the host and port, and auth credentials inclusive.
+
+    argus.subscribe(subscriber, :on_event)
+    argus.connect
+```

data/lib/argus.rb

@@ -0,0 +1,68 @@
+
+require 'socket'
+require 'json'
+require 'ostruct'
+
+require_relative 'helpers/helpers'
+require_relative 'handlers/eventbus'
+
+class Argus 
+
+  def initialize(username = "", password = "", host = "", port = 0)
+    @username = username
+    @password = password
+    @host = host.empty? ? "127.0.0.1" : host
+    @port = port == 0 ? 1337 : port
+
+    @socket = nil
+
+    @event_bus = EventBus.new
+  end
+
+  def connect
+
+    @socket = TCPSocket.open(@host, @port)
+
+    send_auth_data()
+
+    loop do
+      data = @socket.readpartial(1024)
+
+      if !data.nil? && !data.empty?
+
+        if Helpers.is_json_string(data)
+          publish_argus_data(data)
+        else
+          puts "Received: #{data}"
+        end
+
+      end
+    end
+
+  rescue EOFError
+    puts "Connection closed by server"
+
+  rescue StandardError => e
+    puts "Error receiving data: #{e.message}"
+
+  puts "Socket closed"
+  @socket.close
+  end
+
+  def subscribe(subscriber, method_name)
+    @event_bus.subscribe(subscriber, method_name)
+  end
+
+  private
+
+  def publish_argus_data(data)
+    argus_event = JSON.parse(data, object_class: OpenStruct)
+    @event_bus.publish(argus_event)
+  end
+
+
+  def send_auth_data()
+    connectionString = "<ArgusAuth>#{@username}:#{@password}</ArgusAuth>"
+    @socket.puts(connectionString)
+  end
+end

data/lib/handlers/eventbus.rb

@@ -0,0 +1,18 @@
+
+class EventBus
+    ARGUSEVENTNAME = "argus.event.received"
+
+    def initialize
+        @subscribers = Hash.new{|h,k| h[k] = []}
+    end
+
+    def subscribe(subscriber, method_name)
+        @subscribers[ARGUSEVENTNAME] << [subscriber, method_name]
+    end
+
+    def publish(data = nil)
+        @subscribers[ARGUSEVENTNAME].each do |subscriber, method_name|
+            subscriber.send(method_name, data) if subscriber.respond_to?(method_name)
+        end
+    end
+end

data/lib/helpers/helpers.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+class Helpers
+
+    def self.is_json_string(str)
+        begin
+            JSON.parse(str)
+            return true
+          rescue JSON::ParserError => e
+            return false
+          end
+    end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: argus-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kelechi Onyekwere
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-24 00:00:00.000000000 Z
+dependencies: []
+description: "This is the official Ruby library for the ARGUS Engine, \nthis library
+  helps Ruby developers and applications seamlessly integrate to the ARGUS Engine,
+  authentication and event listening.\n"
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- lib/argus.rb
+- lib/handlers/eventbus.rb
+- lib/helpers/helpers.rb
+homepage: https://github.com/khelechy/argus-ruby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/khelechy/argus-ruby
+  bug_tracker_uri: https://github.com/khelechy/argus-ruby/issues
+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: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Argus Ruby client library
+test_files: []