huginn_write_file_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b434746e20b48093166aadb1257e188ec494e1f3d2dc90a69b10bb8ae6004fc
+  data.tar.gz: fd64ad8c653293c5a1a3e8f4b83850e695c8aa4b61db387f327b4500d903b0de
+SHA512:
+  metadata.gz: 827b688767597431db0952926ef62ca257d2d6d84fca0e8cb07bb0147d9bad2ebcab0baa7c4c9227c4b30db913d5380663575323d94b0ecb74b3cfc992027c6a
+  data.tar.gz: e5b84679eea50f45525e705e3d195e35ceb55e439b236170ce631ba630f821f0b6b26f599e870a864ca8778ba5402243223b984a93bda93def53a53033e708dc

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2025 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_write_file_agent/write_file_agent.rb

@@ -0,0 +1,176 @@
+module Agents
+  class WriteFileAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The FileWriterAgent writes files to the filesystem with specified parameters.
+  
+      This agent can be used to generate files at specific locations with defined content,
+      permissions, and ownership.
+  
+      `path` - The full path where the file should be written
+      `content` - The content of the file to write
+      `mode` - The file permissions (e.g., "0644", "0755")
+      `owner` - The file owner (in "user:group" format)
+      `expected_receive_period_in_days` - How many days can pass without receiving an event before this agent is considered inactive
+      `debug` - Debug mode (true/false), displays additional information in logs
+      MD
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "status": "success",
+            "path": "/tmp/huginn_output.txt",
+            "size": 15,
+            "mode": "0644",
+            "owner": "huginn:huginn",
+            "timestamp": 1745522629
+          }
+
+    MD
+
+    def default_options
+      {
+        'path' => '/tmp/huginn_output.txt',
+        'content' => 'Default content',
+        'mode' => '0644',
+        'owner' => 'huginn:huginn',
+        'expected_receive_period_in_days' => '10',
+        'debug' => 'false'
+      }
+    end
+
+    form_configurable :path, type: :string
+    form_configurable :content, type: :text
+    form_configurable :mode, type: :string
+    form_configurable :owner, type: :string
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :debug, type: :boolean
+    def validate_options
+#      errors.add(:base, "type has invalid value: should be 'generate'") if interpolated['type'].present? && !%w(generate).include?(interpolated['type'])
+
+      unless options['path'].present?
+        errors.add(:base, "path is a required field")
+      end
+
+      unless options['mode'].present?
+        errors.add(:base, "mode is a required field")
+      end
+
+      unless options['owner'].present?
+        errors.add(:base, "owner 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
+          write_file
+        end
+      end
+    end
+
+    def check
+      write_file
+    end
+
+    private
+
+
+    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 push_model(model)
+#
+#      log_curl_output(response.code,response.body)
+#
+#    end
+
+    def write_file
+      begin
+        log "Attempting to write file at #{interpolated['path']}" if boolify(interpolated['debug'])
+        
+        # Check if parent directory exists, create if not
+        dir = File.dirname(interpolated['path'])
+        unless File.directory?(dir)
+          FileUtils.mkdir_p(dir)
+#          log "Created parent directory: #{dir}" if boolify(interpolated['debug'])
+        end
+        
+        # Write content to file
+        File.write(interpolated['path'], interpolated['content'])
+        log "File successfully written: #{interpolated['path']}" if boolify(interpolated['debug'])
+        
+        # Convert mode to integer (from octal string)
+        mode_int = interpolated['mode'].to_i(8)
+        File.chmod(mode_int, interpolated['path'])
+#        log "Permissions applied: #{interpolated['mode']}" if boolify(interpolated['debug'])
+        
+        # Change ownership
+        user, group = interpolated['owner'].split(':')
+        user_id = Etc.getpwnam(user).uid
+        group_id = Etc.getgrnam(group).gid
+        File.chown(user_id, group_id, interpolated['path'])
+#        log "Ownership changed: #{interpolated['owner']}" if boolify(interpolated['debug'])
+        
+        # Create output event
+        create_event(payload: {
+          'status' => 'success',
+          'path' => interpolated['path'],
+          'size' => File.size(interpolated['path']),
+          'mode' => interpolated['mode'],
+          'owner' => interpolated['owner'],
+          'timestamp' => Time.now.to_i
+        })
+        
+      rescue => e
+        error_message = "Error writing file: #{e.message}"
+#        log error_message, :error
+        
+        create_event(payload: {
+          'status' => 'error',
+          'path' => interpolated['path'],
+          'error' => error_message,
+          'timestamp' => Time.now.to_i
+        })
+      end
+    end
+  
+    def is_positive_integer?(string)
+      begin
+        value = Integer(string)
+        return value > 0
+      rescue
+        return false
+      end
+    end
+  end
+end

data/lib/huginn_write_file_agent.rb

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

data/spec/write_file_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::WriteFileAgent do
+  before(:each) do
+    @valid_options = Agents::WriteFileAgent.new.default_options
+    @checker = Agents::WriteFileAgent.new(:name => "WriteFileAgent", :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_write_file_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-24 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_write_file_agent.rb
+- lib/huginn_write_file_agent/write_file_agent.rb
+- spec/write_file_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_write_file_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/write_file_agent_spec.rb