huginn_github_check_topic_agent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1336cd7bfbbdc6c0bfc717b32c3a325323b4b9d77d50569811c38ffb27f62f09
+  data.tar.gz: c82e913a141d0d48aefaf402a77b64b33eb9d3f4ee030e7717a73fac5f01ae2f
+SHA512:
+  metadata.gz: 9f83a28ba0425dc0026ebbc7d9a933735629ed7a9eefb6411484c52f06567bf20206ff89f88626dc6c4d113e1c4e8e2fc0a23ffaefae3163570f566c53b6efe6
+  data.tar.gz: bc77b1b26d024b0fc0001ac45b6681d52af5d008f74fd02c419f4ce1b8e8300b559670294299be0a364cc2894180b67f87a4525b6cf6eab5aa5f9a2ab932f8cc

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_github_check_topic_agent/github_check_topic_agent.rb

@@ -0,0 +1,181 @@
+module Agents
+  class GithubCheckTopicAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Github Check Topic agent agent checks if topics are present and creates an event if they are missing.
+
+      `owner` is the owner to check.
+
+      `wanted_topic` is the wanted topics list.
+
+      `regex_filter_name` is used to filter repositories with regex ( for example `^huginn_`).
+
+      `token` is mandatory for the queries .
+
+      `debug` for more verbosity .
+
+      `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:
+
+          {
+            "repository_name": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "url": "https://github.com/XXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "missing_topics": "huginn, huginn-agent"
+          }
+    MD
+
+    def default_options
+      {
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'token' => '',
+        'owner' => '',
+        'wanted_topic' => '',
+        'regex_filter_name' => ''
+      }
+    end
+
+    form_configurable :token, type: :string
+    form_configurable :owner, type: :string
+    form_configurable :regex_filter_name, type: :string
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :wanted_topic, type: :string
+
+    def validate_options
+      unless options['token'].present?
+        errors.add(:base, "token is a required field")
+      end
+
+      unless options['owner'].present?
+        errors.add(:base, "owner is a required field")
+      end
+
+      unless options['wanted_topic'].present?
+        errors.add(:base, "wanted_topic 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
+      fetch
+    end
+
+    private
+
+    def parse(payload)
+      payload.each do |repository|
+        if repository['name'].match(interpolated['regex_filter_name'])
+          missing_topic = []
+          if interpolated['debug'] == 'true'
+            log "#{repository['name']} found"
+          end
+          topics_array = interpolated['wanted_topic'].split(" ")
+          topics_array.each do |topic|
+            found = 'false'
+            repository['topics'].each do |topicbis|
+              if interpolated['debug'] == 'true'
+                log "topic #{topic} topicbis #{topicbis}"
+              end
+              if topic == topicbis
+                found = 'true' 
+              end
+            end
+            if interpolated['debug'] == 'true'
+              if found == 'false'
+                log "topic not present"
+              end
+            end
+            if found == 'false'
+              missing_topic.push(topic)
+            end
+          end
+          if !missing_topic.empty?
+            log "topic not present -> #{missing_topic}"
+            create_event :payload => { "repository_name" => "#{repository['name']}", "url" => "#{repository['html_url']}", "missing_topics" => "#{missing_topic.join(", ")}" }
+#            repository['url']
+          end
+        end
+      end
+    end    
+
+    def get_next(url)
+      uri = URI.parse(url)
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = interpolated['token']
+      request["Accept"] = "application/vnd.github.mercy-preview+json"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+    
+      log "fetch notification request status : #{response.code}"
+    
+      payload = JSON.parse(response.body)
+
+      if interpolated['debug'] == 'true'
+        log payload
+      end
+      parse(payload)
+    end    
+    
+    def fetch
+      uri = URI.parse("https://api.github.com/users/#{interpolated['owner']}/repos?per_page=100")
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = interpolated['token']
+      request["Accept"] = "application/vnd.github.mercy-preview+json"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+    
+      log "fetch notification request status : #{response.code}"
+    
+      payload = JSON.parse(response.body)
+
+      if interpolated['debug'] == 'true'
+        log payload
+      end
+      parse(payload)
+
+      if interpolated['debug'] == 'true' && response.to_hash['link'].present?
+        log " link -> #{response.to_hash['link']}"
+      end
+
+      if response['link'].present?
+        URI.extract(response['link'], ['http', 'https']).each do |url|
+          get_next(url)
+        end
+      end
+    end    
+  end
+end

data/lib/huginn_github_check_topic_agent.rb

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

data/spec/github_check_topic_agent_spec.rb

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