huginn_whois_agent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66cc6a9fb69f94cd777760df8bb1ef033bd9a24c3e56b904c9c5c3f4cc3a17d7
+  data.tar.gz: 6ac504f240755923d90b43479c1329159a37c72a83b5d7d559ca919dc1cea22c
+SHA512:
+  metadata.gz: 761bd601f27f5de4e4cb3d4c84d67497f93a8f6749b73bb404713dd275acaaff702c2b23e39fdeb1213c672cb1b0c29d9c26c24b9a479400771f64a15951432f
+  data.tar.gz: d7ee0ab60eb678ed1b3cfcd8cacd9417870015945f2933c59bd34523550b41b7f8a39931f616f76c6aa4caedf4cdf706ff217333988d84f74c40fe63114677cc

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2022 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_whois_agent/whois_agent.rb

@@ -0,0 +1,150 @@
+require 'whois-parser'
+
+module Agents
+  class WhoisAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Whois Agent is used to check a domain's status.
+
+      `type` can be registered / available
+
+      `domain` is the checked domain.
+
+      `debug` is used to verbose mode.
+
+      `timeout` is the timeout limit, the client raises a Timeout::Error exception.
+
+      `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:
+
+          {
+            "domain": "google.com",
+            "registered": "true"
+          }
+    MD
+
+    def default_options
+      {
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'domain' => '',
+        'timeout' => '5',
+        'type' => 'registered',
+        'changes_only' => 'true'
+      }
+    end
+
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :domain, type: :string
+    form_configurable :timeout, type: :number
+    form_configurable :changes_only, type: :boolean
+    form_configurable :debug, type: :boolean
+    form_configurable :type, type: :array, values: ['registered', 'available']
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'registered' 'available'") if interpolated['type'].present? && !%w(registered available).include?(interpolated['type'])
+
+      if options.has_key?('changes_only') && boolify(options['changes_only']).nil?
+        errors.add(:base, "if provided, changes_only must be true or false")
+      end
+
+      unless options['domain'].present?
+        errors.add(:base, "domain is a required field")
+      end
+
+      unless options['timeout'].present?
+        errors.add(:base, "timeout 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 check
+      trigger_action
+    end
+
+    private
+
+    def whois_check()
+      whois = Whois::Client.new(:timeout => interpolated['timeout'].to_i)
+      record = whois.lookup(interpolated['domain'])
+      parser = record.parser
+
+      if interpolated['debug'] == 'true'
+        log "parser :"
+        log parser.inspect()
+      end
+
+      return parser
+    end
+
+    def is_registered()
+
+      parser =  whois_check()
+      if interpolated['debug'] == 'true'
+        log "registered is #{parser.registered?}"
+      end
+      if interpolated['changes_only'] == 'true'
+        if parser.registered? != memory['is_registered']
+          create_event :payload => { 'domain' => "#{interpolated['domain']}", 'registered' => "#{parser.registered?}" }
+          memory['is_registered'] = parser.registered?
+        end
+      else
+        create_event :payload => { 'domain' => "#{interpolated['domain']}", 'registered' => "#{parser.registered?}" }
+        if parser.registered? != memory['is_registered']
+          memory['is_registered'] = parser.registered?
+        end
+      end
+    end
+
+    def is_available()
+
+      parser =  whois_check()
+      if interpolated['debug'] == 'true'
+        log "available is #{parser.available?}"
+      end
+
+      if interpolated['changes_only'] == 'true'
+        if parser.available? != memory['is_available']
+          create_event :payload => { 'domain' => "#{interpolated['domain']}", 'available' => "#{parser.available?}" }
+          memory['is_available'] = parser.available?
+        end
+      else
+        create_event :payload => { 'domain' => "#{interpolated['domain']}", 'available' => "#{parser.available?}" }
+        if parser.available? != memory['is_available']
+          memory['is_available'] = parser.available?
+        end
+      end
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "registered"
+        is_registered()
+      when "available"
+        is_available()
+      else
+        log "Error: type has an invalid value (#{type})"
+      end
+    end
+  end
+end

data/lib/huginn_whois_agent.rb

@@ -0,0 +1,5 @@
+require 'huginn_agent'
+require 'whois-parser'
+
+#HuginnAgent.load 'huginn_whois_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_whois_agent/whois_agent'

data/spec/whois_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::WhoisAgent do
+  before(:each) do
+    @valid_options = Agents::WhoisAgent.new.default_options
+    @checker = Agents::WhoisAgent.new(:name => "WhoisAgent", :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_whois_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-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_whois_agent.rb
+- lib/huginn_whois_agent/whois_agent.rb
+- spec/whois_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_whois_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/whois_agent_spec.rb