octokitted 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79ee296a98c30f97fd70b08cf0c5c4d907425bb03047c315796b48fc171f461f
-  data.tar.gz: 952ad085cde53de7abcae1be6292e2a4e3b9d72af876b772e67fa0013e37f734
+  metadata.gz: 0f1a1eec4292305ffb36ee14107f171a44eb4c4ec36b681ac1cbb43239fee2ca
+  data.tar.gz: f11e7f4e512223b975247f83720d6d9a465f5126e70e8928007c8be2e01fb350
 SHA512:
-  metadata.gz: 5e3e6310f04d682ffaeb5077e707cb11fd1c4a3ad691614798a775e09798cb52d6c42c99dd7577c6043593eb06e55ded2bfb0f1bb53421288000c63d2bf17609
-  data.tar.gz: 65780350c6e442466e07e83008b96a8ad49acea371c2de44b41a8a99b5dfce9c973febaecdf9a25fc057cc105c6d2a8d5d022cc31d978f31b371885369dd31f7
+  metadata.gz: 520b1c0f16cb7ff369e287eeebeb8c27efbca078ca31fc16825682dd4bc4cd30594532c63eaf76787af5245092fa5a092a7c71f1e0faa07ea1efc48503ec973a
+  data.tar.gz: f2b6bf07d1a3463b960daaa02aded2db981bb0640affb5b87afc78a3c7726040f907e915bb3e3c2796c404b35ec9c3d08c666e6347c8ba54dde612eaa7ec3014

data/lib/octokitted/git_plugin.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "git"
+
+class GitPlugin
+  attr_reader :login
+
+  # Initialize the class
+  def initialize(logger:, login:, token:)
+    @log = logger
+    @login = login
+    @token = token
+  end
+
+  # Removes / cleans up all repos that this class has cloned
+  # :param cloned_repos: An array of paths to cloned repos to remove
+  def remove_all_clones!(cloned_repos)
+    @log.debug("removing all cloned repos")
+    cloned_repos.each do |path|
+      @log.debug("removing cloned repo: #{path}")
+      FileUtils.rm_r(path)
+    end
+  end
+
+  # Removes a single cloned repo
+  # :param path: The path to the cloned repo to remove (String)
+  def remove_clone!(path)
+    @log.debug("removing cloned repo: #{path}")
+    FileUtils.rm_r(path)
+  end
+
+  # Clone a repository
+  # :param path: The relative path to clone the repo to - (default: ".")
+  # :param options: The options to pass to the Git.clone method (default: {} - https://rubydoc.info/gems/git/Git#clone-class_method)
+  # :return: Hash of the Git Object, and the path to the cloned repo
+  def clone(org:, repo:, path: ".", options: {})
+    @log.debug("cloning #{org}/#{repo}")
+    git_object = Git.clone("https://#{@token}@github.com/#{org}/#{repo}.git", repo, path:, log: @log, **options)
+
+    # configure the git environment
+    git_object.config("user.name", @login)
+    git_object.config("user.email", "#{@login}@github.com")
+
+    repo_path = File.join(path, repo)
+    return { git_object:, path: repo_path }
+  rescue StandardError => e
+    # Remove token from error to prevent token leak
+    raise e, e.message.gsub(@token, "REDACTED_TOKEN")
+  end
+end

data/lib/octokitted.rb

@@ -3,9 +3,11 @@
 require "octokit"
 require "logger"
 
+require_relative "octokitted/git_plugin"
+
 class Octokitted
   # A Octokitted class to interact with the GitHub API
-  attr_reader :login, :org, :repo, :org_and_repo, :client
+  attr_reader :login, :org, :repo, :org_and_repo, :octokit, :cloned_repos
 
   # Initialize the class
   # :param login: The login to use for GitHubAPI interactions (defaults to the owner of the token)
@@ -14,19 +16,22 @@ class Octokitted
   # :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)
+    @cloned_repos = []
     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
+    @octokit = setup_octokit_client
     @log = logger || setup_logger
     @org_and_repo = org_and_repo_hash[:org_and_repo]
+    @login = @octokit.login if @login.nil? # reset the login to the owner of the token if not provided
 
-    @login = @client.login if @login.nil? # reset the login to the owner of the token if not provided
+    # setup the git plugin
+    @git = GitPlugin.new(logger: @log, login: @login, token: @token)
 
     @log.debug("Octokitted initialized")
-    @log.debug("login: #{@client.login}")
+    @log.debug("login: #{@octokit.login}")
     @log.debug("org: #{@org}")
     @log.debug("repo: #{@repo}")
   end
@@ -51,6 +56,39 @@ class Octokitted
     @log.debug("updated org/repo: #{@org_and_repo}")
   end
 
+  # Clone the currently set owner/repo repository
+  # :param path: The relative path to clone the repo to - (default: ".")
+  # :param options: The options to pass (default: {} - https://rubydoc.info/gems/git/Git#clone-class_method)
+  # :return: The Git object to operate with
+  def clone(path: ".", options: {})
+    result = @git.clone(org: @org, repo: @repo, path:, options:)
+    @cloned_repos << result[:path]
+    return result[:git_object]
+  end
+
+  def remove_clone!(path)
+    valid = false
+
+    # check if the repo exists in the cloned_repos array
+    valid = true if @cloned_repos.include?(path)
+
+    # check if the repo exists in the cloned_repos array with a leading './'
+    if @cloned_repos.include?("./#{path}")
+      valid = true
+      path = "./#{path}" # update the path to include the relative path so the .delete method works
+    end
+
+    raise StandardError, "Not a cloned repository - path: #{path}" unless valid
+
+    @git.remove_clone!(path)
+    @cloned_repos.delete(path)
+  end
+
+  def remove_all_clones!
+    @git.remove_all_clones!(@cloned_repos)
+    @cloned_repos = []
+  end
+
   private
 
   # construct a logger for the class
@@ -88,7 +126,7 @@ class Octokitted
 
   # Setup an Octokit client
   # :return: An Octokit client
-  def setup_client
+  def setup_octokit_client
     Octokit::Client.new(
       access_token: @token,
       login: @login,

data/lib/version.rb

@@ -2,6 +2,6 @@
 
 module Octokitted
   module Version
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octokitted
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Grant Birkinbine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts