huginn_github_autosync_fork_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d76b8b6b6b86db78987291102fa6a5b70a3544a1ea793db484ff010aee0e01c
+  data.tar.gz: ec82903745a80423cb94e441bf9e548f611d9e1151d7c13c759d2a658bf3df57
+SHA512:
+  metadata.gz: a2ebb6c5ff774b215b70d45fb180351c446e6fd69256c9f329147f93a6b7eaef995193e8b9834de75ab1643f65b6659cb5b37743b723be63f9b99dee2f069ebb
+  data.tar.gz: cc56b0d3e8f55bc986d46d9c5445c6a83fa23c1c96d060d7a96c1fe63cc92e2ef87221c73a0afca210e018aff399c4d049ec8d6d4c45c31b824f6d5f15f961e8

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_github_autosync_fork_agent/github_autosync_fork_agent.rb

@@ -0,0 +1,188 @@
+module Agents
+  class GithubAutosyncForkAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_12h'
+
+    description do
+      <<-MD
+      The Github Autosync Fork agent checks if a refresh is needed from the source.
+
+      `repository` for the wanted repository to check.
+
+      `token` is needed for queries.
+
+      `debug` is used for verbose mode.
+
+      `src_branch` is the branch's name for the source.
+
+      `tgt_branch` is the branch's name for the target.
+
+      `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:
+
+          {
+            "message": "Successfully fetched and fast-forwarded from upstream q9f:main.",
+            "merge_type": "fast-forward",
+            "base_branch": "q9f:main"
+          }
+    MD
+
+    def default_options
+      {
+        'repository' => '',
+        'src_branch' => 'master',
+        'tgt_branch' => 'master',
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'token' => ''
+      }
+    end
+
+    form_configurable :repository, type: :string
+    form_configurable :src_branch, type: :string
+    form_configurable :tgt_branch, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :token, type: :string
+    form_configurable :expected_receive_period_in_days, type: :string
+
+    def validate_options
+      unless options['repository'].present?
+        errors.add(:base, "repository is a required field")
+      end
+
+      unless options['src_branch'].present?
+        errors.add(:base, "src_branch is a required field")
+      end
+
+      unless options['tgt_branch'].present?
+        errors.add(:base, "tgt_branch 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
+      check_sync
+    end
+
+    private
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def get_repos_info
+      uri = URI.parse("https://api.github.com/repos/#{interpolated['repository']}")
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/vnd.github+json"
+      request["Authorization"] = "token #{interpolated['token']}"
+      request["X-Github-Api-Version"] = "2022-11-28"
+
+      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)
+
+      compare(payload)
+
+    end
+
+    def compare(repo_info)
+
+      uri = URI.parse("#{repo_info['parent']['url']}/compare/#{interpolated['src_branch']}...#{repo_info['owner']['login']}:#{interpolated['tgt_branch']}")
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/vnd.github+json"
+      request["Authorization"] = "token #{interpolated['token']}"
+      request["X-Github-Api-Version"] = "2022-11-28"
+
+      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)
+
+      trigger_sync(payload)
+
+    end
+
+    def trigger_sync(compare_result)
+
+      if compare_result['behind_by'] != 0
+
+        log "we are at #{compare_result['behind_by']} commit(s) behind"
+        uri = URI.parse("https://api.github.com/repos/#{interpolated['repository']}/merge-upstream")
+        request = Net::HTTP::Post.new(uri)
+        request["Accept"] = "application/vnd.github+json"
+        request["Authorization"] = "token #{interpolated['token']}"
+        request["X-Github-Api-Version"] = "2022-11-28"
+        request.body = JSON.dump({
+          "branch" => interpolated['tgt_branch']
+        })
+        
+        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)
+
+        create_event payload: payload
+      else
+        log "already up to date, nothing to sync"
+      end
+
+    end
+
+    def check_sync
+
+      get_repos_info
+
+    end
+  end
+end

data/lib/huginn_github_autosync_fork_agent.rb

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

data/spec/github_autosync_fork_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::GithubAutosyncForkAgent do
+  before(:each) do
+    @valid_options = Agents::GithubAutosyncForkAgent.new.default_options
+    @checker = Agents::GithubAutosyncForkAgent.new(:name => "GithubAutosyncForkAgent", :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_autosync_fork_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+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_autosync_fork_agent.rb
+- lib/huginn_github_autosync_fork_agent/github_autosync_fork_agent.rb
+- spec/github_autosync_fork_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_github_autosync_fork_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_autosync_fork_agent_spec.rb