huginn_steam_news_app_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a353ffbf4f0ca25525964a5b1a4dabf6257fe93643b087fd7423f36b11abd589
+  data.tar.gz: d3f5ba4513458827c56e5c72f873b8173f2b08ac40ec6f973b0f9a374efcddd9
+SHA512:
+  metadata.gz: 5e06eaeabdf933ff3e0d4c25fbffa4fa7a4f10d4d2ff7cba40a889f7a4f4b345944c80e5da901df9956ca4f3e549240198b662bfab1a8481a04ec7ce38927347
+  data.tar.gz: ab980c296b54a435a0933b27223a90ac6b51ccc5b9c3095b8b9ee87599ea6c9ac456a0f2711d7611f4e4f83dc713a8aa8c4b8f3516492988286680576775f44e

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_steam_news_app_agent/steam_news_app_agent.rb

@@ -0,0 +1,170 @@
+module Agents
+  class SteamNewsAppAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description <<-MD
+      The Steam News App Agent interacts with the API from Callisto for checking news from an app.
+
+      The `debug` option is for adding.
+
+      The `app_id` option the id of the app.
+
+      The `limit` options is for limiting the results.
+
+      The `max_length` options is for limiting the length.
+
+      Set `expected_update_period_in_days` to the maximum amount of time that you'd expect to pass between Events being created by this Agent.
+
+    MD
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "gid": "5623338145768332949",
+            "title": "Patch 0.212.9",
+            "url": "https://steamstore-a.akamaihd.net/news/externalpost/steam_community_announcements/5623338145768332949",
+            "is_external_url": true,
+            "author": "IronMontilyet",
+            "contents": "Before the holiday season truly kicks off we have a few more bugs that we wanted to address! In this patch you can expect some adjustments to various crafting recipes, further fishing fixes, as well as tweaks to several Mistlands enemies. We also found a way to optimise the game to make your RAM a w...",
+            "feedlabel": "Community Announcements",
+            "date": 1671526854,
+            "feedname": "steam_community_announcements",
+            "feed_type": 1,
+            "appid": 892970,
+            "tags": [
+              "patchnotes"
+            ]
+          }
+    MD
+
+    def default_options
+      {
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'app_id' => '',
+        'language' => 'en',
+        'limit' => '',
+        'max_length' => '',
+        'community_announcements_only' => 'true',
+        'patchnotes_only' => 'true'
+      }
+    end
+
+    form_configurable :debug, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :app_id, type: :string
+    form_configurable :language, type: :string
+    form_configurable :limit, type: :string
+    form_configurable :max_length, type: :string
+    form_configurable :patchnotes_only, type: :boolean
+    form_configurable :community_announcements_only, type: :boolean
+    def validate_options
+      unless options['app_id'].present?
+        errors.add(:base, "app_id is a required field")
+      end
+      unless options['language'].present?
+        errors.add(:base, "language is a required field")
+      end
+      unless options['limit'].present?
+        errors.add(:base, "limit is a required field")
+      end
+      unless options['max_length'].present?
+        errors.add(:base, "max_length is a required field")
+      end
+      if options.has_key?('patchnotes_only') && boolify(options['patchnotes_only']).nil?
+        errors.add(:base, "if provided, patchnotes_only must be true or false")
+      end
+
+      if options.has_key?('community_announcements_only') && boolify(options['community_announcements_only']).nil?
+        errors.add(:base, "if provided, community_announcements_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
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def check
+      query_steam
+    end
+
+    private
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def query_steam()
+      url = URI("https://api.steampowered.com/ISteamNews/GetNewsForApp/v2/")
+      params = { :appid => interpolated['app_id'], :count => interpolated['limit'], :maxlength => interpolated['max_length'] , :language => interpolated['language']}
+      url.query = URI.encode_www_form(params)
+      
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      request = Net::HTTP::Get.new(url)
+      response = http.request(request)
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+
+      if payload != memory['last_status']
+        payload['appnews']['newsitems'].each do | item |
+          found = false
+          if interpolated['debug'] == 'true'
+            log item
+            log "found is #{found}"
+          end
+          if !memory['last_status'].nil? and memory['last_status']['appnews']['newsitems'].present?
+            last_status = memory['last_status']
+            last_status['appnews']['newsitems'].each do | itembis|
+              if item == itembis
+                found = true
+              end
+              if interpolated['debug'] == 'true'
+                log "found is #{found}"
+              end
+            end
+          end
+#          if found == false && (interpolated['patchnotes_only'] == 'false' || ( !item['tags'].nil? && item['tags'].include?("patchnotes") && interpolated['patchnotes_only'] == 'true'))
+          if found == false && (interpolated['community_announcements_only'] == 'false' || (interpolated['community_announcements_only'] == 'true' && item['feed_type'] == 1)) && (interpolated['patchnotes_only'] == 'false' || ( !item['tags'].nil? && item['tags'].include?("patchnotes") && interpolated['patchnotes_only'] == 'true'))
+            if interpolated['debug'] == 'true'
+              log "event created"
+            end
+            create_event payload: item
+          else
+            if interpolated['debug'] == 'true'
+              log "event not created"
+            end
+          end
+        end
+        memory['last_status'] = payload
+      else
+        if interpolated['debug'] == 'true'
+          log "no diff"
+        end
+      end
+    end
+  end
+end

data/lib/huginn_steam_news_app_agent.rb

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

data/spec/steam_news_app_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::SteamNewsAppAgent do
+  before(:each) do
+    @valid_options = Agents::SteamNewsAppAgent.new.default_options
+    @checker = Agents::SteamNewsAppAgent.new(:name => "SteamNewsAppAgent", :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_news_app_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-12 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_news_app_agent.rb
+- lib/huginn_steam_news_app_agent/steam_news_app_agent.rb
+- spec/steam_news_app_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_steam_news_app_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_news_app_agent_spec.rb