huginn_ntfy_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 228e3a303e8e299a566995a3f9be2c428cb3ab2abb00e42f49a9e09f1bc02afa
+  data.tar.gz: 192aa95902a9e8b28ec97deee26907381f443e6cacdaa214d18b21825afb2fbc
+SHA512:
+  metadata.gz: 9b0768fd027dcd1968911ba7b5e05601be9759911f5532a8b1e2d9bee545d0bb60519a5dd9bccb45d8a9c412d207052f7b1b1f4d6285fb519bd4c40ebb998898
+  data.tar.gz: 33b951940143e4fcaec740cef75ebb081b9aa82d1a0d81e33803f010f73c6d57b27bd6210ea46f327fb5719056ea2556b26cd5e8afd069c223a0f134f12486bb

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_ntfy_agent/ntfy_agent.rb

@@ -0,0 +1,202 @@
+module Agents
+  class NtfyAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description <<-MD
+      The Ntfy Agent interacts with a Ntfy server via its API can publish messages.
+
+      The `type` can be like pubish.
+
+      The `topic` is required to publish a message.
+
+      The `message` is a Message body; set to triggered if empty or not passed
+
+      The `title` is a Message title
+
+      The `tags` is a list of tags that may or not map to emojis
+
+      The `priority` (one of: 1, 2, 3, 4, or 5) Message priority with 1=min, 3=default and 5=max
+
+      The `actions`is a JSON array 	(see action buttons) Custom user action buttons for notifications
+
+      The `click` is an URL ,a Website opened when notification is clicked
+
+      The `attach` is an URL of an attachment, see attach via URL
+
+      The `delay` is Timestamp or duration for delayed delivery (30min, 9am).
+      
+      The `email` is an e-mail address for e-mail notifications
+
+
+    MD
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "id": "XXXXXXXXXXXX",
+            "time": 1674661199,
+            "event": "message",
+            "topic": "test1",
+            "message": "Backup successful part2"
+          }
+    MD
+
+    def default_options
+      {
+        'debug' => 'false',
+        'emit_events' => 'true',
+        'changes_only' => 'true',
+        'server' => 'https://ntfy.sh',
+        'user' => '',
+        'password' => '',
+        'topic' => '',
+        'message' => '',
+        'title' => '',
+        'tags' => '',
+        'priority' => '3',
+        'click' => '',
+        'attach' => '',
+        'delay' => '',
+        'actions' => '',
+        'expected_receive_period_in_days' => '2',
+        'type' => 'publish'
+      }
+    end
+
+    form_configurable :changes_only, type: :boolean
+    form_configurable :emit_events, type: :boolean
+    form_configurable :debug, type: :boolean
+    form_configurable :server, type: :string
+    form_configurable :user, type: :string
+    form_configurable :password, type: :string
+    form_configurable :topic, type: :string
+    form_configurable :message, type: :string
+    form_configurable :title, type: :string
+    form_configurable :tags, type: :string
+    form_configurable :priority, type: :string
+    form_configurable :click, type: :string
+    form_configurable :attach, type: :string
+    form_configurable :delay, type: :string
+    form_configurable :actions, type: :string
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :type, type: :array, values: ['publish', 'subscribe']
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'publish' 'subscribe'") if interpolated['type'].present? && !%w(publish subscribe).include?(interpolated['type'])
+
+      unless options['topic'].present? || !['publish' 'subscribe'].include?(options['type'])
+        errors.add(:base, "topic is a required field")
+      end
+
+      unless options['server'].present? || !['publish' 'subscribe'].include?(options['type'])
+        errors.add(:base, "server is a required field")
+      end
+
+      unless options['message'].present? || !['publish'].include?(options['type'])
+        errors.add(:base, "message 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
+
+      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['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 subscribe
+
+      uri = URI.parse("#{interpolated['server']}/#{interpolated['topic']}/json?since=10m&poll=1")
+      response = Net::HTTP.get_response(uri)
+
+      log_curl_output(response.code,response.body)
+
+      if !response.body.empty?
+        data_lines = response.body.split("\n")
+        data_lines.map do |line|
+          create_event payload: JSON.parse(line)
+        end
+      end
+
+    end
+
+    def publish
+
+      data = {}
+      data["topic"] = interpolated['topic'] if interpolated['topic'].present?
+      data["message"] = interpolated['message'] if interpolated['message'].present?
+      data["title"] = interpolated['title'] if interpolated['title'].present?
+      data["tags"] = interpolated['tags'].split(" ") if interpolated['tags'].present?
+      data["priority"] = interpolated['priority'].to_i if interpolated['priority'].present?
+      data["attach"] = interpolated['attach'] if interpolated['attach'].present?
+      data["delay"] = interpolated['delay'] if interpolated['delay'].present?
+      data["click"] = interpolated['click'] if interpolated['click'].present?
+      data["actions"] = interpolated['actions'] if interpolated['actions'].present?
+
+      if interpolated['debug'] == 'true'
+        log "data"
+        log data
+      end
+
+      url = URI.parse(interpolated['server'])
+      response = HTTParty.post(url, body: data.to_json)
+
+      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 "publish"
+        publish()
+      when "subscribe"
+        subscribe()
+      else
+        log "Error: type has an invalid value (#{type})"
+      end
+    end
+  end
+end

data/lib/huginn_ntfy_agent.rb

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

data/spec/ntfy_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::NtfyAgent do
+  before(:each) do
+    @valid_options = Agents::NtfyAgent.new.default_options
+    @checker = Agents::NtfyAgent.new(:name => "NtfyAgent", :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_ntfy_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_ntfy_agent.rb
+- lib/huginn_ntfy_agent/ntfy_agent.rb
+- spec/ntfy_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_ntfy_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/ntfy_agent_spec.rb