github_org_manager 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f040bda13816a4be56c79705bfc08b8ddc4103b912b0739f995fd39c8b9b4762
-  data.tar.gz: bfbc002654df01530548f3bbbf992d3b174ef7926729e1e08b4118627be24665
+  metadata.gz: 448927c5116bc5a19aa7eb3ede1e38fbf835014d385f1b3060958c18b72fb72d
+  data.tar.gz: dbae6b024e64729cefb7c424c8c994989ce40deeeab2a111fc457a2108d45fe7
 SHA512:
-  metadata.gz: 95727ac38a7088d1e3751af1f25b5c824376a1e84ce8235b1c21658bbab373133952ed84142ea082f6b6db78e087d2f7382f8b6ae021932215075b0efbb7f400
-  data.tar.gz: e94d42b5257c15ad21b7d2ef59f81f3b45f7f8ae41866864100c6964f6ca7db3e2105e20c4a3d527d4f90ec56ae1a61ee6bb44fc8777f563fcf217e651bdf2a1
+  metadata.gz: 5bfe6d464a78f395d4be6e6697b835c759bc7e940dfd8105be7ede6097783c1ef4493abb63ed8f2e83e822416e3d669b4b2041728661988ccb779b5d0182a91e
+  data.tar.gz: 3810347e3e5ee96b03ea119380b5016cff5b48da980efc6dd6c720955e409b91132d932eef0f19da48bfdf4f10531af15f9db345a96f2f7e1b0b149769201fca

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 ## [Unreleased]
 
+## [0.0.3] - 2022-02-18
+
+- Adds ability to limit scope to teams the current user is on
+- Exposes information on team membership, repos, and current user affiliations
+
 ## [0.0.2] - 2022-02-17
 
 - Fix old `CLIENT` reference from `0.0.1`
+
 ## [0.0.1] - 2022-02-17
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_org_manager (0.0.1)
+    github_org_manager (0.0.2)
       netrc (~> 0.11.0)
       octokit (~> 4.22.0)
 

data/README.md

@@ -10,6 +10,12 @@ manager = GithubOrgManager::Manager.new(
   # more accurately read from for now.
   org_name: "<YOUR_ORG_HERE>",
 
+  # If you would like to limit this to only teams that the
+  # "logged in" user currently belongs to, set this to
+  # true and all downloads and updates will be scoped as
+  # such.
+  team_only: true,
+
   # Directory where your code typically is, defaults to
   # `~/dev` and ensures it exists
   dev_home: "<WHERE_YOUR_CODE_LIVES>",
@@ -45,11 +51,15 @@ gem 'github_org_manager'
 
 And then execute:
 
-    $ bundle install
+```sh
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install github_org_manager
+```sh
+$ gem install github_org_manager
+```
 
 ## Development
 
@@ -59,7 +69,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/github_org_manager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/github_org_manager/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/baweaver/github_org_manager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/baweaver/github_org_manager/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/github_org_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GithubOrgManager
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/github_org_manager.rb

@@ -6,6 +6,9 @@ require "octokit"
 require "netrc"
 
 module GithubOrgManager
+  # Manages an organization in GitHub, currently in a
+  # READONLY fashion for syncing purposes.
+  #
   class Manager
     # Where your development files are stored
     DEV_HOME = File.join(Dir.home, "dev")
@@ -16,23 +19,29 @@ module GithubOrgManager
     # ( https://github.com/octokit/octokit.rb#using-a-netrc-file )
     OCTOKIT_PARAMS = { netrc: true }
 
-    attr_reader :dev_home, :org_name, :repos, :repo_paths
+    attr_reader :client, :dev_home, :org_name, :username
 
     # Creates a new Manager
     #
     # @param org_name: [String]
-    #   Organization to pull data from
+    #   Organization to pull data from.
+    #
+    # @param team_only: [Boolean]
+    #   Scope all data to only teams in the organization
+    #   you belong to, meaning all syncing applies only to
+    #   teams you're specifically on.
     #
     # @param dev_home: [String]
-    #   Where development files and repos live on your machine
+    #   Where development files and repos live on your machine.
     #
     # @param octokit_params [Hash<Symbol, Any>]
-    #   Params passed through to Octokit::Client constructor
+    #   Params passed through to `Octokit::Client` constructor.
     #
     # @param &octokit_configuration [Proc]
-    #   Configuration block passed to Octokit.configure
+    #   Configuration block passed to `Octokit.configure`.
     def initialize(
       org_name:,
+      team_only: false,
       dev_home: DEV_HOME,
       octokit_params: OCTOKIT_PARAMS,
       &octokit_configuration
@@ -42,26 +51,118 @@ module GithubOrgManager
 
       @dev_home = path_name
       @org_name = org_name
-      @org_path = File.join(path_name, org_name)
+      @org_path = File.join(@dev_home, org_name)
+
+      @client   = get_client(octokit_params:, &octokit_configuration)
+      @username = client.user[:login]
+      @team_only = team_only
+    end
+
+    # Repositories in the organization the Manager is targeting. These
+    # values can be scoped to only ones owned by the username specified
+    # to Octokit with the `team_only` option.
+    #
+    # @return [Hash<String, String>]
+    #   Mapping of repo name to repo URL
+    def repos
+      @repos ||= @team_only ? my_repos : team_repos
+    end
 
-      @client = client(octokit_params:, &octokit_configuration)
+    # File paths of all repos currently in scope for your organization.
+    #
+    # @return [Hash<String, String>]
+    #   Mapping of repo name to repo file path.
+    def repo_paths
+      @repo_paths ||= repos.to_h do |repo_name, _repo_url|
+        [repo_name, File.join(@org_path, repo_name)]
+      end
+    end
 
-      @repos = @client.org_repos(@org_name).to_h do |repo_data|
+    # All unscoped repos belonging to an organization.
+    #
+    # @return [Hash<String, String>]
+    #   Mapping of repo name to repo URL.
+    def all_repos
+      @all_repos ||= client.org_repos(@org_name).to_h do |repo_data|
         [repo_data[:name], repo_data[:html_url]]
       end
+    end
 
-      @repo_paths = @repos.to_h do |repo_name, _repo_url|
-        [repo_name, File.join(@org_path, repo_name)]
+    # Repos that the current user in Octokit is a member of a team.
+    # of that manages that repo.
+    #
+    # @return [Hash<String, String>]
+    #   Mapping of repo name to repo URL.
+    def my_repos
+      @my_repos ||= all_repos.select do |name, _|
+        my_repo_names.include?(name)
+      end
+    end
+
+    # Gets teams under the current organization.
+    #
+    # @return [Hash<String, Numeric>]
+    #   Mapping of team name to team id.
+    def org_teams
+      @org_teams ||= client.org_teams(@org_name).to_h do
+        [_1[:name], _1[:id]]
+      end
+    end
+
+    # Repos that each team manages, may have overlaps.
+    #
+    # @return [Hash<String, Array<String>>]
+    #   Mapping of team name to a collection of repo names
+    #   that they manage.
+    def team_repos
+      @team_repos ||= org_teams.to_h do |name, id|
+        [name, client.team_repos(id).map { _1[:name] }]
+      end
+    end
+
+    # Members that belong to each team.
+    #
+    # @return [Hash<String, Array<String>>]
+    #   Mapping of team name to a collection of all of its
+    #   members.
+    def team_members
+      @team_members ||= org_teams.to_h do |name, id|
+        [name, client.team_members(id).map { _1[:login] }]
       end
     end
 
+    # Teams that the current logged in user belongs to.
+    #
+    # @return [Set<String>]
+    #   Names of teams.
+    def my_teams
+      @my_teams ||= team_members
+        .select { |_, members| members.include?(@username) }
+        .keys
+        .then { Set.new(_1) }
+    end
+
+    # Repos that the current logged in user has authority over.
+    #
+    # @return [Set<String>]
+    #   Names of repos.
+    def my_repo_names
+      @my_repo_names ||= team_repos
+        .select { |name, _| my_teams.include?(name) }
+        .values
+        .flatten
+        .then { Set.new(_1) }
+    end
+
     # Make sure that every repo in the organization exists on this
-    # machine.
+    # machine. Scoped to team if `team_only` is on.
+    #
+    # @return [void]
     def ensure_repo_directories_exist!
       Dir.mkdir(@org_path) unless Dir.exist?(@org_path)
 
       Dir.chdir(@org_path) do
-        @repos.each do |name, html_url|
+        repos.each do |name, html_url|
           `git clone "#{html_url}"` unless Dir.exist?(@repo_paths[name])
         end
       end
@@ -69,15 +170,21 @@ module GithubOrgManager
       true
     end
 
-    # Update all repos
+    # Update all repos, scoped to team if `team_only` is on.
+    #
+    # TODO: While there is a Ruby Git gem I've had some difficulty
+    # in getting it to work properly, hence plain old system commands
+    # instead for the time being.
+    #
+    # @return [void]
     def update_repos!
       # Hard to update repos which don't exist on the computer, make sure that
       # we have them all already downloaded, or do so
       ensure_repo_directories_exist!
 
-      puts "📦 Updating #{@repo_paths.size} repos: \n"
+      puts "📦 Updating #{repo_paths.size} repos: \n"
 
-      @repo_paths.each do |name, path|
+      repo_paths.each do |name, path|
         Dir.chdir(path) do
           main_branch = `basename $(git symbolic-ref refs/remotes/origin/HEAD)` || "main"
           current_branch = `git rev-parse --abbrev-ref HEAD`
@@ -106,7 +213,25 @@ module GithubOrgManager
       true
     end
 
-    def client(octokit_params:, &configuration)
+    # If for whatever reason you need to unset all the cached
+    # instance variables for refreshing data.
+    #
+    # @return [void]
+    def clear_cache!
+      @repos = nil
+      @repo_paths = nil
+      @all_repos = nil
+      @my_repos = nil
+      @org_teams = nil
+      @team_repos = nil
+      @team_members = nil
+      @my_teams = nil
+      @my_repo_names = nil
+
+      true
+    end
+
+    private def get_client(octokit_params: OCTOKIT_PARAMS, &configuration)
       return @client if defined?(@client)
 
       Octokit.configure(&configuration) if block_given?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_org_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit