huginn_battlenet_version_checker_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee546189db3549b2dc875af8b9c71a7794d96ab4867d30e339e86f66678d8f70
+  data.tar.gz: aecc685786e3dc23e9b2a64d5766f08b6aeacc340d64ecf927f0593a922fdde8
+SHA512:
+  metadata.gz: aba21ba915827b56a1bfba833505d9afd13d0efbb634d81d2dac41e5f23abd719d7d0c251eece481f6e40d0638b9dba2a919e23d947aa9a48e98b0f2a75a334e
+  data.tar.gz: 908e235b41f3dd0e26eae86323a9b899917dc7d7d93bd7b899fc617b3b567b918f2cd15d61a0b177116b593bf00390ffa5328106d40b83bbb5ad5d266ffa944e

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2023 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_battlenet_version_checker_agent/battlenet_version_checker_agent.rb

@@ -0,0 +1,195 @@
+module Agents
+  class BattlenetVersionCheckerAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Battlenet Version Checker Agent checks if a new version is available for games and creates an event if found.
+
+      `debug` is used for verbose mode.
+
+      `diablo4` can be enabled to monitore new releases about this game.
+
+      `cod_mw2_wz2` can be enabled to monitore new releases about this game.
+
+      `agent` can be enabled to monitore new releases about this game.
+
+      `region` can be eu, us or kr.
+
+      `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:
+
+          {
+            "Region": "eu",
+            "BuildConfig": "849b3cbba08ee5a78173a8bed156909e",
+            "CDNConfig": "cf3e51475b3258e18fc53c115021381b",
+            "KeyRing": "",
+            "BuildId": "42016",
+            "VersionName": "1.0.2.42016",
+            "ProductConfig": "bb943b96ed03cafe783d31dc3d5ee155",
+            "Game": "Diablo IV"
+          }
+    MD
+
+    def default_options
+      {
+        'debug' => 'false',
+        'diablo4' => 'true',
+        'cod_mw2_wz2' => 'true',
+        'agent' => 'true',
+        'expected_receive_period_in_days' => '15',
+      }
+    end
+
+    form_configurable :debug, type: :boolean
+    form_configurable :diablo4, type: :boolean
+    form_configurable :cod_mw2_wz2, type: :boolean
+    form_configurable :agent, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :region, type: :array, values: ['eu', 'us', 'kr']
+    def validate_options
+      errors.add(:base, "region has invalid value: should be 'eu', 'us', 'kr'") if interpolated['type'].present? && !%w(en us kr).include?(interpolated['region'])
+
+      if options.has_key?('diablo4') && boolify(options['diablo4']).nil?
+        errors.add(:base, "if provided, diablo4 must be true or false")
+      end
+
+      if options.has_key?('cod_mw2_wz2') && boolify(options['cod_mw2_wz2']).nil?
+        errors.add(:base, "if provided, cod_mw2_wz2 must be true or false")
+      end
+
+      if options.has_key?('agent') && boolify(options['agent']).nil?
+        errors.add(:base, "if provided, agent 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
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def check
+      trigger_action
+    end
+
+    private
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def compare(payload,game)
+
+      payload = JSON.parse(payload)
+      if !memory[game]
+        payload.each do |result|
+          if result["Region"] == interpolated['region']
+            create_event payload: result
+          end
+        end
+        memory[game] = payload
+      else
+        result = payload.select { |entry| entry['Region'] == interpolated['region'] }
+        result_memory = memory[game].select { |entry| entry['Region'] == interpolated['region'] }
+        if result != result_memory
+          create_event payload: result[0]
+          memory[game] = payload
+        else
+          if interpolated['debug'] == 'true'
+            log "nothing to compare because same value"
+          end
+        end
+      end  
+
+    end
+
+    def get_version(game,real_name)
+
+      url = URI.parse("http://eu.patch.battle.net:1119/#{game}/versions")
+
+      response = Net::HTTP.get_response(url)
+
+      log_curl_output(response.code,response.body)
+
+      lines = response.body.split("\n")
+      results = []
+      
+      lines.each do |line|
+        next if line.start_with?("Region")
+        next if line.start_with?("## seqn")
+      
+        parts = line.split("|")
+        region = parts[0]
+        build_config = parts[1]
+        cdn_config = parts[2]
+        key_ring = parts[3]
+        build_id = parts[4]
+        version_name = parts[5]
+        product_config = parts[6]
+      
+        result = {
+          "Region" => region,
+          "BuildConfig" => build_config,
+          "CDNConfig" => cdn_config,
+          "KeyRing" => key_ring,
+          "BuildId" => build_id,
+          "VersionName" => version_name,
+          "ProductConfig" => product_config,
+          "Game" => real_name
+        }
+      
+        results << result
+      end
+      
+      json_data = results.to_json
+      
+      if interpolated['debug'] == 'true'
+        log json_data
+      end
+
+      compare(json_data,game)
+
+    end
+
+    def trigger_action
+
+      if interpolated['diablo4'] == 'true'
+        product_code = "fenris"
+        real_name = "Diablo IV"
+        get_version(product_code,real_name)
+      end
+      if interpolated['cod_mw2_wz2'] == 'true'
+        product_code = "auks"
+        real_name = "Call of Duty: MWII | WZ2.0"
+        get_version(product_code,real_name)
+      end
+      if interpolated['agent'] == 'true'
+        product_code = "agent"
+        real_name = "Battle.net Agent"
+        get_version(product_code,real_name)
+      end
+    end
+  end
+end

data/lib/huginn_battlenet_version_checker_agent.rb

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

data/spec/battlenet_version_checker_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::BattlenetVersionCheckerAgent do
+  before(:each) do
+    @valid_options = Agents::BattlenetVersionCheckerAgent.new.default_options
+    @checker = Agents::BattlenetVersionCheckerAgent.new(:name => "BattlenetVersionCheckerAgent", :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_battlenet_version_checker_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-11 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_battlenet_version_checker_agent.rb
+- lib/huginn_battlenet_version_checker_agent/battlenet_version_checker_agent.rb
+- spec/battlenet_version_checker_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_battlenet_version_checker_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/battlenet_version_checker_agent_spec.rb