huginn_steam_check_server_per_ip_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0be97d7edab5d5fcb9c3bbe93921c0ccdb05627ddb8722624fdeb0a611faef25
+  data.tar.gz: 03dcf60967fe44c8981fb4c833f5f92925d1aaa5c0a08caf0711fe120a1a8c16
+SHA512:
+  metadata.gz: aebb2f89ec97502c00149230461d5f9ce755fcb8ad76e8f7ffbb83d6255dbac879badee4e1a652b485e8bc735d6ab12dbb01057dc3a55ea182501b6df2dd1d72
+  data.tar.gz: 68ad46983e03a097e4c90a920cd273e111bb4d3b6b68e586a330d321cac0df60031d1dc80fa7a60847332bd7bab6106afd3e4f14ac672121410de608578d01a6

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2021 Nicolas Germain
+
+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/lib/huginn_steam_check_server_per_ip_agent/steam_check_server_per_ip_agent.rb

@@ -0,0 +1,149 @@
+module Agents
+  class SteamCheckServerPerIpAgent < Agent
+    include FormConfigurable
+
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule "never"
+
+    description do
+      <<-MD
+      The huginn catalog agent checks available server per ip.
+
+      `debug` is used to verbose mode.
+
+      `changes_only` is only used to emit event about a currency's change.
+
+      `ip` is the ip wanted for checking.
+
+      `expected_receive_period_in_days` is used to determine if the Agent is working. Set it to the maximum number of days
+      that you anticipate passing without this Agent receiving an incoming Event.
+      MD
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "addr": "XXX.XXX.XXX.XXX:2457",
+            "gmsindex": -1,
+            "appid": 892970,
+            "gamedir": "valheim",
+            "region": -1,
+            "secure": false,
+            "lan": false,
+            "gameport": 2456,
+            "specport": 0
+          }
+    MD
+
+    def default_options
+      {
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'ip' => '',
+        'changes_only' => 'true'
+      }
+    end
+
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :ip, type: :string
+    form_configurable :changes_only, type: :boolean
+    form_configurable :debug, type: :boolean
+
+    def validate_options
+      if options.has_key?('changes_only') && boolify(options['changes_only']).nil?
+        errors.add(:base, "if provided, changes_only must be true or false")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      unless options['expected_receive_period_in_days'].present? && options['expected_receive_period_in_days'].to_i > 0
+        errors.add(:base, "Please provide 'expected_receive_period_in_days' to indicate how many days can pass before this Agent is considered to be not working")
+      end
+
+      unless options['ip'].present? && options['ip'].to_i > 0
+        errors.add(:base, "Please provide 'ip' to indicate the server adress before this Agent is considered to be not working")
+      end
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def check
+      fetch
+    end
+
+    private
+
+    def set_credential(name, value)
+      c = user.user_credentials.find_or_initialize_by(credential_name: name)
+      c.credential_value = value
+      c.save!
+    end
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "request status : #{code}"
+        log "body"
+        log body
+      end
+
+    end
+
+    def fetch
+      uri = URI.parse("https://api.steampowered.com/ISteamApps/GetServersAtAddress/v0001?addr=#{interpolated['ip']}")
+      response = Net::HTTP.get_response(uri)
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+
+      if interpolated['changes_only'] == 'true'
+        if payload != memory['last_status']
+          payload['response']['servers'].each do |servers|
+            found = false
+            if !memory['last_status'].nil? and memory['last_status'].present?
+              last_status = memory['last_status']
+              if interpolated['debug'] == 'true'
+                log "servers"
+                log servers
+              end
+              last_status['response']['servers'].each do |serversbis|
+                if servers == serversbis
+                  found = true
+                end
+                if interpolated['debug'] == 'true'
+                  log "serversbis"
+                  log serversbis
+                  log "found is #{found}!"
+                end
+              end
+            end
+            if found == false
+              if interpolated['debug'] == 'true'
+                log "found is #{found}! so event created"
+                log servers
+              end
+              create_event payload: servers
+            end
+          end
+          memory['last_status'] = payload
+        else
+          log "no diff"
+        end
+      else
+        create_event payload: payload['response']['servers']
+        if payload != memory['last_status']
+          memory['last_status'] = payload
+        end
+      end
+    end
+  end
+end

data/lib/huginn_steam_check_server_per_ip_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_steam_check_server_per_ip_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_steam_check_server_per_ip_agent/steam_check_server_per_ip_agent'

data/spec/steam_check_server_per_ip_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::SteamCheckServerPerIpAgent do
+  before(:each) do
+    @valid_options = Agents::SteamCheckServerPerIpAgent.new.default_options
+    @checker = Agents::SteamCheckServerPerIpAgent.new(:name => "SteamCheckServerPerIpAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  pending "add specs here"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_steam_check_server_per_ip_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- ngermain@hihouhou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_steam_check_server_per_ip_agent.rb
+- lib/huginn_steam_check_server_per_ip_agent/steam_check_server_per_ip_agent.rb
+- spec/steam_check_server_per_ip_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_steam_check_server_per_ip_agent
+licenses:
+- MIT
+metadata: {}
+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.3.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/steam_check_server_per_ip_agent_spec.rb