github_bot 0.1.0

data/lib/github_bot/rails/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Only include in the context of a rails application
+return unless defined?(Rails)
+
+require 'octokit'
+
+module GithubBot
+  # Public: Railtie for injecting configuration of Octokit in a Rails environment
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      Octokit.configure { |c| c.api_endpoint = "https://#{ENV['GITHUB_HOST']}/api/v3/" } if ENV['GITHUB_HOST'].present?
+    end
+  end
+end

data/lib/github_bot/tasks/base.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module GithubBot
+  module Tasks
+    # Public: Base class for establishing tasks to be executed via a validator
+    class Base
+      # Public: Returns the validator associated to the task execution
+      attr_reader :validator
+
+      # Public: Initialize the task from a specific validator
+      #
+      # @param validator [GithubBot::Validator::Base] An instance of the validator that is asking for the task
+      def initialize(validator)
+        @validator = validator
+      end
+
+      private
+
+      # because tasks are executed by a validator, some methods are relayed across
+      # from the task back to the validator.  this override checks for that existence
+      def method_missing(method, *args, &block)
+        return super unless respond_to_missing?(method)
+
+        @validator.send(method, *args, &block)
+      end
+
+      # because tasks are executed by a validator, some methods are relayed across
+      # from the task back to the validator.  this override checks for that existence
+      def respond_to_missing?(method, *args)
+        @validator.respond_to?(method, *args)
+      end
+
+      # returns the github client api established either by the task or the validator
+      def client_api
+        # evaluate if the validator has defined the api and delegate accordingly
+        return validator.client_api if validator.respond_to?(:client_api)
+
+        ::GithubBot::Github::Client.instance
+      end
+    end
+  end
+end

data/lib/github_bot/validator/base.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module GithubBot
+  module Validator
+    # Public: Base class for validators to extend to provide helpful
+    # methods for interactions with GitHub
+    class Base
+      class << self
+        # Public: Validation method that every consumer will need to override
+        def validate; end
+      end
+
+      # Public: Initializes an instance of the validator
+      def initialize
+        @feedback = []
+        @check = nil
+      end
+
+      # Public: Provide feedback to be generated upon completion of the check run
+      # see https://docs.github.com/en/rest/reference/checks#create-a-check-run for additional
+      # details on available parameters for the 'annotations' item
+      def feedback(path:, start_line: 0, end_line: 0, annotation_level:, message:, **opts)
+        @feedback << {
+          path: path,
+          start_line: start_line,
+          end_line: end_line,
+          annotation_level: annotation_level,
+          message: message,
+          **opts
+        }
+      end
+
+      # Public: Moves the check run into the in progress status
+      def in_progress(**opts)
+        raise StandardError, 'check run has not been established' unless @check
+
+        defaults = {
+          output: {
+            title: "#{@check.name} validation is in progress...",
+            summary: 'We\'re currently validating this request. Please stand by.'
+          }
+        }
+
+        @check.in_progress!(defaults.deep_merge(opts))
+      end
+
+      # Public: Block for execution logic that is the be evaluated and finalized
+      # within the GitHub check run content
+      def check_run(name:, **_opts)
+        # queue request for processing
+        @check = client_api.create_check_run(
+          name: name,
+          output: {
+            title: "#{name} validation has been queued...",
+            summary: "We're awaiting processing."
+          }
+        )
+
+        yield if block_given?
+
+        if @feedback.empty?
+          @check.complete!(
+            output: {
+              title: "#{name} validation is complete...",
+              summary: "#{name} validation passed!"
+            }
+          )
+
+        else
+          # because limitation of 50 checks per API call execution, break up annotations
+          # https://developer.github.com/v3/checks/runs/
+          @feedback.each_slice(50).to_a.each do |annotations|
+            @check.action_required!(
+              output: {
+                title: "#{name} validation is complete...",
+                summary: "#{name} validation determined there are changes that need attention.",
+                annotations: annotations
+              }
+            )
+          end
+        end
+      rescue StandardError => e
+        Rails.logger.error message: 'Error occurred during check run', exception: e
+        @check.action_required!(
+          output: {
+            title: "#{name} validation failed...",
+            summary: "# Message\n```\n#{e.message}\n```\n# Exception\n```\n#{e.backtrace.join("\n")}\n```"
+          }
+        )
+      end
+
+      # Public: Return all files from request.
+      def files
+        client_api.files
+      end
+
+      # Public: Return the modified files from request.
+      def modified_files
+        client_api.modified_files
+      end
+
+      # Public: Validates the file extension for the provided file
+      #
+      # @param file [Sawyer::Resource] The file to evaluate
+      # @param extension [String] The extension type to evaluate
+      def validate_file_extension(file, extension)
+        return if File.extname(file.filename) == ".#{extension}"
+
+        feedback(
+          path: file.filename,
+          annotation_level: 'failure',
+          message: "File suffix is incorrect, please use '.#{extension}'"
+        )
+      end
+
+      # Public: Loads the yaml of the file provided
+      #
+      # @param file [Sawyer::Resource] The file to load
+      def load_yaml(file)
+        YAML.safe_load(client_api.file_content(file)).with_indifferent_access
+      rescue StandardError => e
+        feedback(
+          path: file.filename,
+          annotation_level: 'failure',
+          message: 'Malformed yaml content'\
+                   "exception: #{e.message}"
+        )
+
+        {}
+      end
+
+      # Public: Validates for the provided file at a given hash point that the
+      # required and allowed fields are met
+      #
+      # @param file [Sawyer::Resource] The file for reference that is being evaluated
+      # @param ident [String/Symbol] The text identifier for the hash being evaluated
+      # @param hash [Hash] The hash to review keys
+      # @param required_fields [Array] An array of required elements
+      # @param allowed_fields [Array] An array of allowed fields
+      def validate_fields(file:, ident:, hash:, required_fields:, allowed_fields:, **opts)
+        unless hash
+          feedback(
+            path: file.filename,
+            annotation_level: 'failure',
+            message: 'Element is empty or nil'
+          )
+
+          return
+        end
+
+        validate_required_fields(
+          file: file,
+          ident: ident,
+          hash: hash,
+          required_fields: required_fields,
+          **opts
+        )
+        validate_allowed_fields(
+          file: file,
+          ident: ident,
+          hash: hash,
+          allowed_fields: allowed_fields,
+          **opts
+        )
+      end
+
+      # Public: Validates for the provided file at a given hash point that the
+      # required fields are met
+      #
+      # @param file [Sawyer::Resource] The file for reference that is being evaluated
+      # @param ident [String/Symbol] The text identifier for the hash being evaluated
+      # @param hash [Hash] The hash to review keys
+      # @param required_fields [Array] An array of required elements
+      def validate_required_fields(file:, ident:, hash:, required_fields:, **_opts)
+        unless hash
+          feedback(
+            path: file.filename,
+            annotation_level: 'failure',
+            message: "#{ident}: Element is empty or nil"
+          )
+
+          return
+        end
+
+        required_fields.each do |key|
+          next unless hash[key].nil?
+
+          feedback(
+            path: file.filename,
+            annotation_level: 'failure',
+            message: "#{ident}: Missing required element '#{key}'"
+          )
+        end
+      end
+
+      # Public: Validates for the provided file at a given hash point that the
+      # allowed fields are met
+      #
+      # @param file [Sawyer::Resource] The file for reference that is being evaluated
+      # @param ident [String/Symbol] The text identifier for the hash being evaluated
+      # @param hash [Hash] The hash to review keys
+      # @param allowed_fields [Array] An array of allowed fields
+      def validate_allowed_fields(file:, ident:, hash:, allowed_fields:, **_opts)
+        unless hash
+          feedback(
+            path: file.filename,
+            annotation_level: 'failure',
+            message: "#{ident}: Element is empty or nil"
+          )
+
+          return
+        end
+
+        hash.keys&.each do |key|
+          unless allowed_fields.include?(key)
+            feedback(
+              path: file.filename,
+              annotation_level: 'failure',
+              message: "#{ident}: Key '#{key}' not in the allowed fields [#{allowed_fields.join(', ')}]"
+            )
+          end
+        end
+      end
+
+      private
+
+      def client_api
+        ::GithubBot::Github::Client.instance
+      end
+    end
+  end
+end

data/lib/github_bot/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module GithubBot
+  VERSION = '0.1.0'
+
+  # version module
+  module Version
+    MAJOR, MINOR, PATCH, *BUILD = VERSION.split '.'
+    NUMBERS = [MAJOR, MINOR, PATCH, *BUILD].freeze
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: github_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Howdeshell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: 'A rubygem designed to assist in the creation of GitHub bot applications.
+
+  '
+email:
+- greg.howdeshell@gmail.com
+executables:
+- bundle-audit
+- bundler-audit
+- rails
+- rake
+- rspec
+- rubocop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
+- ".github/workflows/cd.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
+- Gemfile
+- LICENSE
+- NOTICE
+- README.md
+- Rakefile
+- app/controllers/github_bot/application_controller.rb
+- app/controllers/github_bot/concerns/response.rb
+- app/controllers/github_bot/webhooks/github_controller.rb
+- app/helpers/github_bot/github_request_helper.rb
+- bin/bundle-audit
+- bin/bundler-audit
+- bin/rails
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- config/routes.rb
+- github_bot.gemspec
+- lib/github_bot.rb
+- lib/github_bot/engine.rb
+- lib/github_bot/github/check_run.rb
+- lib/github_bot/github/client.rb
+- lib/github_bot/github/payload.rb
+- lib/github_bot/rails/railtie.rb
+- lib/github_bot/tasks/base.rb
+- lib/github_bot/validator/base.rb
+- lib/github_bot/version.rb
+homepage: https://github.com/cerner/github_bot-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A rubygem designed to assist in the creation of GitHub bot applications.
+test_files: []