huginn_discord_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc8454c86e155a8f225ddd14b9423e6e71adaded850546c683ce88a8a3f98624
+  data.tar.gz: dc89f166d45a8f0806b9be632080d708071dd0ec38d433af3b40514c29a7d456
+SHA512:
+  metadata.gz: e4e0d67a0f26872efcdfc114020e16fe45aebbb24db7c491254a3e2dd4e118ee0739909b5aa2bd6ef2e5c328a0bc3867a0211c7eceed5c47990b7128618a5785
+  data.tar.gz: 6746d69579ac0ddf6f6f07fa45566267be0b9b660628e171c986d1183ec293c5a16da3318afc87f78e9f75a7354e73c95e3906d8ce04efd2a3c82c82cc35d70e

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 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_discord_agent/discord_agent.rb

@@ -0,0 +1,170 @@
+module Agents
+  class DiscordAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+
+    description <<-MD
+      The Discord Agent interacts with Discord API for sending message for example.
+
+      The `type` can be like sending a message.
+
+      The `content` is needed for sending a message.
+
+      The `channel_id` is needed for sending a message to a specific channel.
+
+      The `emit_events` can create event if wanted.
+
+      The `bot_token` is needed for the authentication.
+
+      The `debug` can add verbosity.
+
+      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:
+
+          {
+            "id": "XXXXXXXXXXXXXXXXXXX",
+            "type": 0,
+            "content": "XXXXXXXXXXXXXXXXXX",
+            "channel_id": "XXXXXXXXXXXXXXXXXX",
+            "author": {
+              "id": "XXXXXXXXXXXXXXXXXX",
+              "username": "XXXXXX",
+              "avatar": null,
+              "avatar_decoration": null,
+              "discriminator": "XXXX",
+              "public_flags": 0,
+              "bot": true
+            },
+            "attachments": [],
+            "embeds": [],
+            "mentions": [],
+            "mention_roles": [],
+            "pinned": false,
+            "mention_everyone": false,
+            "tts": false,
+            "timestamp": "2023-01-11T13:53:48.308000+00:00",
+            "edited_timestamp": null,
+            "flags": 0,
+            "components": [],
+            "referenced_message": null
+          }
+    MD
+
+    def default_options
+      {
+        'content' => '',
+        'type' => 'send_message',
+        'bot_token' => '',
+        'debug' => 'false',
+        'channel_id' => '',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '7'
+      }
+    end
+
+    form_configurable :content, type: :string
+    form_configurable :type, type: :array, values: ['send_message']
+    form_configurable :bot_token, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :channel_id, type: :string
+    form_configurable :emit_events, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'send_message'") if interpolated['type'].present? && !%w(send_message).include?(interpolated['type'])
+
+      unless options['channel_id'].present? || !['send_message'].include?(options['type'])
+        errors.add(:base, "channel_id is a required field")
+      end
+
+      if options.has_key?('emit_events') && boolify(options['emit_events']).nil?
+        errors.add(:base, "if provided, emit_events must be true or false")
+      end
+
+      unless options['content'].present? || !['send_message'].include?(options['type'])
+        errors.add(:base, "content is a required field")
+      end
+
+      unless options['bot_token'].present? || !['send_message'].include?(options['type'])
+        errors.add(:base, "bot_token is a required field")
+      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 receive(incoming_events)
+      incoming_events.each do |event|
+        interpolate_with(event) do
+          log event
+          trigger_action
+        end
+      end
+    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 send_message()
+
+      message = { content: interpolated['content'] }.to_json
+      
+      # Build the HTTP request to send the message
+      uri = URI("https://discordapp.com/api/v6/channels/#{interpolated['channel_id']}/messages")
+      req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+      req['Authorization'] = "Bot #{interpolated['bot_token']}"
+      req.body = message
+      
+      # Send the request and print the response
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: response.body
+      end
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "send_message"
+        send_message()
+      else
+        log "Error: type has an invalid value (#{type})"
+      end
+    end
+  end
+end

data/lib/huginn_discord_agent.rb

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

data/spec/discord_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::DiscordAgent do
+  before(:each) do
+    @valid_options = Agents::DiscordAgent.new.default_options
+    @checker = Agents::DiscordAgent.new(:name => "DiscordAgent", :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_discord_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_discord_agent.rb
+- lib/huginn_discord_agent/discord_agent.rb
+- spec/discord_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_discord_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/discord_agent_spec.rb