huginn_github_autocommit_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb623009f09d1a7d4360101c50d62f85273c7ff07a55391a0daa5c362f832e14
+  data.tar.gz: f9b9e84d26bdff6f718203b9d196172d36bea1b8c7dda2b6de99208b5452c105
+SHA512:
+  metadata.gz: 6d5d238102609b5f7349f4d0025ca882bfd9cc02b9677d317b50dad33413ad1370d5c64d2dea46b1de8d467536a054fff02e5f6d22ad66ab3bdfd32de3cd295f
+  data.tar.gz: 36ad7d07350a0c00f3649efe8f6c5832295b12fc2a238f26cadc9413ec1273241bd1103d19b60fee6fbd8dcf8e3aeb3274b554c547c4a69a66ffa1efc3705a36

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2023 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_autocommit_agent/github_autocommit_agent.rb

@@ -0,0 +1,273 @@
+module Agents
+  class GithubAutocommitAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Github autocommit agent updates content for repositories and creates an event if wanted.
+
+      `repository` is the name of the repository.
+
+      `version` is the version wanted.
+
+      `commit_message` is the message in the commit.
+
+      `committer_name` is the name of the committer.
+
+      `committer_email` is the email of the committer.
+
+      `token` is needed for authentication
+
+      `rules` is needed to know information about the target repository.
+
+      `emit_events` is for creating an event.
+
+      `debug` to add 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:
+
+          {
+              "content": {
+                "name": "Dockerfile",
+                "path": "Dockerfile",
+                "sha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "size": 541,
+                "url": "https://api.github.com/repos/hihouhou/docker-test/contents/Dockerfile?ref=master",
+                "html_url": "https://github.com/hihouhou/docker-test/blob/master/Dockerfile",
+                "git_url": "https://api.github.com/repos/hihouhou/docker-test/git/blobs/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "download_url": "https://raw.githubusercontent.com/hihouhou/docker-test/master/Dockerfile",
+                "type": "file",
+                "_links": {
+                  "self": "https://api.github.com/repos/hihouhou/docker-test/contents/Dockerfile?ref=master",
+                  "git": "https://api.github.com/repos/hihouhou/docker-test/git/blobs/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                  "html": "https://github.com/hihouhou/docker-test/blob/master/Dockerfile"
+                }
+              },
+              "commit": {
+                "sha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "node_id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "url": "https://api.github.com/repos/hihouhou/docker-test/git/commits/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "html_url": "https://github.com/hihouhou/docker-test/commit/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "author": {
+                  "name": "XXXXXXXX",
+                  "email": "XXXXXXXXXXXXXXXXXXXXX",
+                  "date": "2023-10-12T23:42:46Z"
+                },
+                "committer": {
+                  "name": "XXXXXXXX",
+                  "email": "XXXXXXXXXXXXXXXXXXXXX",
+                  "date": "2023-10-12T23:42:46Z"
+                },
+                "tree": {
+                  "sha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                  "url": "https://api.github.com/repos/hihouhou/docker-test/git/trees/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+                },
+                "message": "my commit message",
+                "parents": [
+                  {
+                    "sha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                    "url": "https://api.github.com/repos/hihouhou/docker-test/git/commits/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+                    "html_url": "https://github.com/hihouhou/docker-test/commit/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+                  }
+                ],
+                "verification": {
+                  "verified": false,
+                  "reason": "unsigned",
+                  "signature": null,
+                  "payload": null
+                }
+              }
+          }
+    MD
+
+    def default_options
+      {
+        'repository' => '',
+        'version' => '',
+        'commit_message' => '',
+        'committer_name' => '',
+        'committer_email' => '',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '2',
+        'token' => '',
+        'rules' => '[{name: "", owner: "", my_repository: "", pattern: "", file: "" }'
+      }
+    end
+
+    form_configurable :repository, type: :string
+    form_configurable :version, type: :string
+    form_configurable :commit_message, type: :string
+    form_configurable :committer_name, type: :string
+    form_configurable :committer_email, type: :string
+    form_configurable :token, type: :string
+    form_configurable :rules, type: :string
+    form_configurable :emit_events, type: :boolean
+    form_configurable :debug, type: :boolean
+    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['version'].present?
+        errors.add(:base, "version is a required field")
+      end
+
+      unless options['commit_message'].present?
+        errors.add(:base, "commit_message is a required field")
+      end
+
+      unless options['committer_name'].present?
+        errors.add(:base, "committer_name is a required field")
+      end
+
+      unless options['committer_email'].present?
+        errors.add(:base, "committer_email is a required field")
+      end
+
+
+      unless options['token'].present?
+        errors.add(:base, "token is a required field")
+      end
+#
+#      if options[:type] == :array && (options[:values].blank? || !options[:values].is_a?(Array))
+#        raise ArgumentError.new('When using :array as :type you need to provide the :values as an Array')
+#      end
+
+      if options.has_key?('add_release_details') && boolify(options['add_release_details']).nil?
+        errors.add(:base, "if provided, add_release_details must be true or false")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      if options.has_key?('emit_events') && boolify(options['emit_events']).nil?
+        errors.add(:base, "if provided, emit_events 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
+          commit
+        end
+      end
+    end
+
+    def check
+      commit
+    end
+
+    private
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def update_content(owner,repository,filepath,content,sha)
+      encoded_content = Base64.strict_encode64(content)
+
+      uri = URI.parse("https://api.github.com/repos/#{owner}/#{repository}/contents/#{filepath}")
+      request = Net::HTTP::Put.new(uri)
+      request["Content-Type"] = "application/json"
+      request["Accept"] = "application/vnd.github+json"
+      request["Authorization"] = "token #{interpolated['token']}"
+      request["X-Github-Api-Version"] = "2022-11-28"
+      request.body = JSON.dump({
+        "message" => "#{interpolated['commit_message']}",
+        "committer" => {
+          "name" => "#{interpolated['committer_name']}",
+          "email" => "#{interpolated['committer_email']}"
+        },
+        "content" => "#{encoded_content}",
+        "sha" => "#{sha}"
+      })
+      
+      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)
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: response.body
+      end    
+    end    
+    
+    def commit
+      to_apply = {}
+      JSON.parse(interpolated['rules']).each do | rule |
+        if interpolated['repository'] == rule['name']
+          to_apply = rule
+          if interpolated['debug'] == 'true'
+            log "found"
+          end
+        else
+          if interpolated['debug'] == 'true'
+            log "not found"
+          end
+        end
+      end
+
+      uri = URI.parse("https://api.github.com/repos/#{to_apply['owner']}/#{to_apply['my_repository']}/contents/#{to_apply['file']}")
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = "token #{interpolated['token']}"
+#      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)
+      
+      data = JSON.parse(response.body)
+      file_content_base64 = data['content']
+      sha = data['sha']
+      
+      file_content = Base64.decode64(file_content_base64)
+      current_version = file_content.match(/^ENV #{to_apply['pattern']} (.*)/)
+      if current_version && current_version[1] >= interpolated['version']
+        log "The current version is already greater than or equal to the given version. No replacement necessary."
+      else
+        file_content.gsub!(/^ENV #{to_apply['pattern']}.*/, "ENV #{to_apply['pattern']} #{interpolated['version']}")
+        update_content(to_apply['owner'],to_apply['my_repository'],to_apply['file'],file_content,sha)
+#        log file_content
+      end
+    end    
+  end
+end

data/lib/huginn_github_autocommit_agent.rb

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

data/spec/github_autocommit_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::GithubAutocommitAgent do
+  before(:each) do
+    @valid_options = Agents::GithubAutocommitAgent.new.default_options
+    @checker = Agents::GithubAutocommitAgent.new(:name => "GithubAutocommitAgent", :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_autocommit_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-13 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_autocommit_agent.rb
+- lib/huginn_github_autocommit_agent/github_autocommit_agent.rb
+- spec/github_autocommit_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_github_autocommit_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_autocommit_agent_spec.rb