huginn_signalspam_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5a315c48d41eb7af60378b335aca6e6f6f32239932e389b887e1a0d332362e7
+  data.tar.gz: e799126566da333e38f5bc4e367ceb4707fb9a2e6f232ef921f6d0747c0184f3
+SHA512:
+  metadata.gz: 9db56407490bb2078b7d29b6e8cb0abfc641e1de9a8237745bbed32b5935ee1bbb67d3efd27fa3d4fdc663bce765720578b6d0b16c6c66f04a1a11c7e43555e9
+  data.tar.gz: ccead12a9b098e656add74cc2661f80f155ddd5de660ae3da85f9d4e07dd431191a18c8f8c85ddc8a41710cdb4ae4905676cf069ee9eff170d57409e498432f4

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2024 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_signalspam_agent/signalspam_agent.rb

@@ -0,0 +1,129 @@
+module Agents
+  class SignalspamAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'never'
+
+    description do
+      <<-MD
+      The Signalspam Agent reports spam to signal-spam.fr.
+
+      `debug` is used for verbose mode.
+
+      `username` is mandatory for authentication.
+
+      `password` is mandatory for authentication.
+
+      `raw_email` is the content of the email in raw.
+
+      `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:
+
+          {
+            "report_status": "202"
+          }
+    MD
+
+    def default_options
+      {
+        'username' => '',
+        'password' => '',
+        'raw_email' => '',
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :username, type: :string
+    form_configurable :password, type: :string
+    form_configurable :raw_email, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    def validate_options
+      unless options['username'].present?
+        errors.add(:base, "username is a required field")
+      end
+
+      unless options['password'].present?
+        errors.add(:base, "password is a required field")
+      end
+
+      unless options['raw_email'].present?
+        errors.add(:base, "raw_email 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
+          report
+        end
+      end
+    end
+
+    def check
+      report
+    end
+
+    private
+
+    def set_credential(name, value)
+      c = user.user_credentials.find_or_initialize_by(credential_name: name)
+      c.credential_value = value
+      c.save!
+    end
+
+    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 report()
+
+      url = URI.parse('https://www.signal-spam.fr/api/signaler')
+      headers = {
+        'User-Agent' => 'Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/52.4.0'
+      }
+    
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = (url.scheme == 'https')
+    
+      request = Net::HTTP::Post.new(url.path, headers)
+      request.basic_auth(interpolated['username'], interpolated['password'])
+      request.set_form_data('message' => Base64.strict_encode64(interpolated['raw_email']))
+    
+      response = http.request(request)
+    
+      log_curl_output(response.code,response.body)
+
+      create_event :payload => { 'report_status' => response.code}
+
+    end
+  end
+end

data/lib/huginn_signalspam_agent.rb

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

data/spec/signalspam_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::SignalspamAgent do
+  before(:each) do
+    @valid_options = Agents::SignalspamAgent.new.default_options
+    @checker = Agents::SignalspamAgent.new(:name => "SignalspamAgent", :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_signalspam_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-08 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_signalspam_agent.rb
+- lib/huginn_signalspam_agent/signalspam_agent.rb
+- spec/signalspam_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_signalspam_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/signalspam_agent_spec.rb