octokitted 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b33a0fe5db207ed7676f1cacab5d10eda78112d2ff4e952574eab3890975dc3f
+  data.tar.gz: f8cee9a0d5b35409ad84fef1ee75f696eb9f597133b5333ef757eed628f20767
+SHA512:
+  metadata.gz: '0210854b5aa9fe12a2e1038167d74e9924064ed60a7c5c84ac9ee433e637f9e2b317e121b3b0aa64e08a8cec702fd96c28708ea6c6bb85923361d292fc0e8cf6'
+  data.tar.gz: b43739ead97c4ee9ea4b8fdd7bf99e2866bd633bae311bdaf0be29f5a8ca9bc1b4d6bf38f9f0d4fe0e115149c247b626631c42a390db44565b1f1bdbdb3b8dbd

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Grant Birkinbine
+
+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/README.md

@@ -0,0 +1,5 @@
+# octokitted
+
+[![test](https://github.com/GrantBirki/octokitted/actions/workflows/test.yml/badge.svg)](https://github.com/GrantBirki/octokitted/actions/workflows/test.yml) [![lint](https://github.com/GrantBirki/octokitted/actions/workflows/lint.yml/badge.svg)](https://github.com/GrantBirki/octokitted/actions/workflows/lint.yml) [![CodeQL](https://github.com/GrantBirki/octokitted/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/GrantBirki/octokitted/actions/workflows/codeql-analysis.yml)
+
+A self-hydrating version of Octokit for usage in CI systems - like GitHub Actions!

data/lib/octokitted.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "octokit"
+require "logger"
+
+class Octokitted
+  # A Octokitted class to interact with the GitHub API
+  attr_reader :login, :org, :repo, :org_and_repo, :client
+
+  # Initialize the class
+  # :param login: The login to use for GitHubAPI interactions (defaults to the owner of the token)
+  # :param org: The org to use with the Octokitted class
+  # :param repo: The repo to interact with with the Octokitted class
+  # :param token: The token to use to authenticate with the GitHub API
+  # :param logger: The logger to use for logging
+  def initialize(login: nil, org: nil, repo: nil, token: nil, logger: nil)
+    org_and_repo_hash = fetch_org_and_repo
+    @login = login
+    @org = org || org_and_repo_hash[:org]
+    @repo = repo || org_and_repo_hash[:repo]
+    @token = token || fetch_token
+    @client = setup_client
+    @log = logger || setup_logger
+    @org_and_repo = org_and_repo_hash[:org_and_repo]
+
+    @log.debug("Octokitted initialized")
+    @log.debug("login: #{@client.login}")
+    @log.debug("org: #{@org}")
+    @log.debug("repo: #{@repo}")
+  end
+
+  # Setter method for the repo instance variable
+  # :param repo: The repo to set
+  # :return: the new org/repo
+  # Example: gh.repo = "test"
+  def repo=(repo)
+    @repo = repo
+    @org_and_repo = "#{@org}/#{@repo}"
+    @log.debug("updated org/repo: #{@org_and_repo}")
+  end
+
+  # Setter method for the org instance variable
+  # :param org: The org to set
+  # :return: the new org/repo
+  # Example: gh.org = "test"
+  def org=(org)
+    @org = org
+    @org_and_repo = "#{@org}/#{@repo}"
+    @log.debug("updated org/repo: #{@org_and_repo}")
+  end
+
+  private
+
+  # construct a logger for the class
+  def setup_logger
+    $stdout.sync = true # don't buffer - flush immediately
+    Logger.new($stdout, level: ENV.fetch("LOG_LEVEL", "INFO").upcase)
+  end
+
+  # Fetch the org and repo from the environment
+  # :return: A hash containing the org and repo, and the org and repo separately
+  def fetch_org_and_repo
+    org_and_repo = ENV.fetch("GITHUB_REPOSITORY", nil)
+    org = nil
+    repo = nil
+
+    org = org_and_repo.split("/").first unless org_and_repo.nil?
+    repo = org_and_repo.split("/").last unless org_and_repo.nil?
+
+    return { org_and_repo:, org:, repo: }
+  end
+
+  # fetch the GitHub token from the environment
+  # :return: The GitHub token
+  def fetch_token
+    # first try to use the OCTOKIT_ACCESS_TOKEN env var if it exists
+    token = ENV.fetch("OCTOKIT_ACCESS_TOKEN", nil) # if running in actions
+    return token unless token.nil?
+
+    # next try to use the GITHUB_TOKEN env var if it exists
+    token = ENV.fetch("GITHUB_TOKEN", nil) # if running in actions
+    return token unless token.nil?
+
+    raise "No GitHub token found"
+  end
+
+  # Setup an Octokit client
+  # :return: An Octokit client
+  def setup_client
+    Octokit::Client.new(
+      access_token: @token,
+      login: @login,
+      page_size: ENV.fetch("OCTOKIT_PER_PAGE", 100)&.to_i,
+      auto_paginate: ENV.fetch("OCTOKIT_AUTO_PAGINATE", true)
+    )
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Octokitted
+  module Version
+    VERSION = "0.0.1"
+  end
+end

data/octokitted.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "octokitted"
+  spec.version       = Octokitted::Version::VERSION
+  spec.authors       = ["Grant Birkinbine"]
+  spec.email         = "grant.birkinbine@gmail.com"
+  spec.license       = "MIT"
+
+  spec.summary       = "A self-hydrating version of Octokit for usage in CI systems - like GitHub Actions!"
+  spec.description   = <<~SPEC_DESC
+    A self-hydrating version of Octokit for usage in CI systems - like GitHub Actions!
+  SPEC_DESC
+
+  spec.homepage = "https://github.com/grantbirki/octokitted"
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/grantbirki/octokitted",
+    "documentation_uri" => "https://github.com/grantbirki/octokitted",
+    "bug_tracker_uri" => "https://github.com/grantbirki/octokitted/issues"
+  }
+
+  spec.add_dependency "git", "~> 1.18"
+  spec.add_dependency "octokit", "~> 7.1"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.files = %w[LICENSE README.md octokitted.gemspec]
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: octokitted
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Grant Birkinbine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: 'A self-hydrating version of Octokit for usage in CI systems - like GitHub
+  Actions!
+
+  '
+email: grant.birkinbine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/octokitted.rb
+- lib/octokitted/git_plugin.rb
+- lib/version.rb
+- octokitted.gemspec
+homepage: https://github.com/grantbirki/octokitted
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/grantbirki/octokitted
+  documentation_uri: https://github.com/grantbirki/octokitted
+  bug_tracker_uri: https://github.com/grantbirki/octokitted/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: A self-hydrating version of Octokit for usage in CI systems - like GitHub
+  Actions!
+test_files: []