huginn_github_received_events_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76b54d8b9c96db57aafa090f428b4b6185ab1f21531d0c25d07b81b64686288a
+  data.tar.gz: 70bd1e0211045a9008b58f8a369bf9cc83f9ffb8ad5b4da904db4baa0736af5a
+SHA512:
+  metadata.gz: d65c02d18af68f4f9c42a62bff5da5cdca9352554b1abe6e8cce895be55209757daa0024fba1cbbd7fb5ed2b7bcbec0454b93a44e882cabeff3f231e1c7d5ba4
+  data.tar.gz: f6c11679823ad279c080edaea2b64f36dd07b9f44fe29dc3d45e5c8125162d22e5a7880304238aea00c3e0cd11f819b752061043e77b30a87f8ca54bea14162c

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 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_received_events_agent/github_received_events_agent.rb

@@ -0,0 +1,167 @@
+module Agents
+  class GithubReceivedEventsAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Github notification agent fetches notifications and creates an event by notification.
+
+      `username` for the wanted username.
+
+      `token` If you are authenticated as the given user, you will see private events.
+
+      `debug` is used for verbose mode.
+
+      The `changes only` option causes the Agent to report an event only when the status changes. If set to false, an event will be created for every check.  If set to true, an event will only be created when the status changes (like if your site goes from 200 to 500).
+
+      `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:
+
+          {
+            "id": "XXXXXXXXXXX",
+            "type": "WatchEvent",
+            "actor": {
+              "id": XXXXXX,
+              "login": "XXXXXX",
+              "display_login": "XXXXXX",
+              "gravatar_id": "",
+              "url": "https://api.github.com/users/XXXXXX",
+              "avatar_url": "https://avatars.githubusercontent.com/u/XXXXXX?"
+            },
+            "repo": {
+              "id": 76460706,
+              "name": "hihouhou/docker-sslscan",
+              "url": "https://api.github.com/repos/hihouhou/docker-sslscan"
+            },
+            "payload": {
+              "action": "started"
+            },
+            "public": true,
+            "created_at": "2020-10-06T08:55:11Z"
+          }
+    MD
+
+    def default_options
+      {
+        'username' => '',
+        'debug' => 'false',
+        'changes_only' => 'true',
+        'expected_receive_period_in_days' => '2',
+        'token' => ''
+      }
+    end
+
+    form_configurable :username, type: :string
+    form_configurable :changes_only, type: :boolean
+    form_configurable :debug, type: :boolean
+    form_configurable :token, type: :string
+    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
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      unless options['token'].present?
+        errors.add(:base, "token is a required field")
+      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 log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def fetch
+      uri = URI.parse("https://api.github.com/users/hihouhou/received_events")
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = "#{interpolated['token']}"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+    
+      payload = JSON.parse(response.body)
+
+      if interpolated['changes_only'] == 'true' && !payload.empty?
+        if payload != memory['last_status']
+          if payload
+            payload.each do |event|
+              found = false
+              if interpolated['debug'] == 'true'
+                log "found is #{found}!"
+                log event
+              end
+              if !memory['last_status'].nil? && !memory['last_status'].empty?
+                last_status = memory['last_status']
+                last_status.each do |eventbis|
+                  if event == eventbis
+                    found = true
+                  end
+                  if interpolated['debug'] == 'true'
+                    log "found is #{found}!"
+                  end
+                end
+              end
+              if found == false
+                if interpolated['debug'] == 'true'
+                  log "found is #{found}! so event created"
+                  log event
+                end
+                create_event payload: event
+              end
+            end
+          end
+        else
+          log "no diff"
+        end
+        memory['last_status'] = payload
+      else
+        if !payload.empty?
+          create_event payload: payload
+          if payload != memory['last_status']
+            memory['last_status'] = payload
+          end
+        end
+      end
+    end    
+  end
+end

data/lib/huginn_github_received_events_agent.rb

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

data/spec/github_received_events_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::GithubReceivedEventsAgent do
+  before(:each) do
+    @valid_options = Agents::GithubReceivedEventsAgent.new.default_options
+    @checker = Agents::GithubReceivedEventsAgent.new(:name => "GithubReceivedEventsAgent", :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_received_events_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-11-22 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_received_events_agent.rb
+- lib/huginn_github_received_events_agent/github_received_events_agent.rb
+- spec/github_received_events_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_github_received_events_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_received_events_agent_spec.rb