github-lister-core 0.1.0

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/github-lister-core.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'github-lister-core/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = 'github-lister-core'
+    spec.version       = GithubListerCore::VERSION
+    spec.authors       = ['Tim Gurney aka Wolf']
+    spec.email         = ['wolf@tgwolf.com']
+
+    spec.summary       = 'Provide a simple, fast and, clean way to extract repository information from GitHub.'
+    spec.description   = 'The aim of the gem is to provide a simple, fast and, clean way to extra repository information from GitHub. It comes with a number of methods but it is intentionally limited to repository based information.'
+    spec.homepage      = 'https://github.com/DevelopersToolbox/github-lister-core'
+    spec.license       = 'MIT'
+
+    spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/DevelopersToolbox/github-lister-core'
+    spec.metadata['changelog_uri'] = 'https://github.com/DevelopersToolbox/github-lister-core/blob/master/CHANGELOG.md'
+
+    # Specify which files should be added to the gem when it is released.
+    # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
+    spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+        `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
+
+    spec.bindir        = 'exe'
+    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ['lib']
+
+    spec.add_development_dependency 'bundler', '~> 2'
+    spec.add_development_dependency 'octokit', '~> 4'
+    spec.add_development_dependency 'parallel', '~> 1.2'
+    spec.add_development_dependency 'rake', '~> 12'
+    spec.add_development_dependency 'reek', '~> 6'
+    spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'rubocop', '~> 1.11.0'
+
+    spec.add_runtime_dependency 'octokit', '~> 4'
+    spec.add_runtime_dependency 'parallel', '~> 1.2'
+end

data/lib/github-lister-core/client.rb

@@ -0,0 +1,27 @@
+#
+# This code handles the creation of the github client with or without an auth token
+#
+# This class smells of :reek:UtilityFunction
+class GithubListerCore
+    class << self
+        #
+        # Everything from here is private
+        #
+
+        private
+
+        #
+        # Initialise the client and set auto_paginate to true
+        #
+        def init_client(options = {})
+            token = get_option(options, :token)
+            client = if token
+                         Octokit::Client.new(:access_token => token)
+                     else
+                         Octokit::Client.new
+                     end
+            client.auto_paginate = true
+            client
+        end
+    end
+end

data/lib/github-lister-core/errors.rb

@@ -0,0 +1,76 @@
+#
+# Define our own errors
+#
+class GithubListerCore
+    #
+    # Catch all - something bad happened but we don't know what
+    #
+    class UnknownError < StandardError
+        def initialize
+            super('Something bad happen!')
+        end
+    end
+
+    #
+    # User supplied an invalid token (instead of a missing token)
+    #
+    class InvalidTokenError < StandardError
+        def initialize
+            super('Invalid Token')
+        end
+    end
+
+    #
+    # User didn't supply a token but one was expected
+    #
+    class MissingTokenError < StandardError
+        def initialize
+            super('Missing Token - Please refer to https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token#creating-a-token')
+        end
+    end
+
+    #
+    # Github rate limited us!
+    #
+    class TooManyRequests < StandardError
+        def initialize
+            super('Too Many Requests')
+        end
+    end
+
+    #
+    # Generic 'not found' for users / orgs etc
+    #
+    class NotFoundError < StandardError
+        def initialize
+            super('Entity Not Found')
+        end
+    end
+
+    #
+    # Docs to go here
+    #
+    class MissingOrganisationError < StandardError
+        def initialize
+            super('org_name MUST be passed as an option')
+        end
+    end
+
+    #
+    # Docs to go here
+    #
+    class InvalidOptionsHashError < StandardError
+        def initialize
+            super('Options must be passed as a hash')
+        end
+    end
+
+    #
+    # Must be string or array!
+    #
+    class InvalidParameterError < StandardError
+        def initialize
+            super('Value must be a string or an array')
+        end
+    end
+end

data/lib/github-lister-core/languages.rb

@@ -0,0 +1,28 @@
+#
+# Add topics to each repository
+#
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        #
+        # Extra the topics slug from the payload and return it
+        #
+        def languages_private(client, repo)
+            function_wrapper(client, 'languages', repo)
+        end
+
+        #
+        # Add topics to each repo
+        #
+        # This method smells of :reek:FeatureEnvy
+        def add_languages_private(client, repos)
+            (repo_list ||= []) << Parallel.each(repos, :in_threads => repos.count) { |repo| repo[:languages] = languages_internal(client, repo[:full_name]) }
+            repo_list.flatten
+        end
+    end
+end

data/lib/github-lister-core/organisations.rb

@@ -0,0 +1,62 @@
+#
+# Pull information specific to organisations (org repos are in repos.rb)
+#
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        # rubocop:disable Metrics/MethodLength
+        def get_org_list(options)
+            org_param = get_option(options, [:org_name, :org])
+
+            raise MissingOrganisationError.new unless org_param
+
+            case org_param
+            when Array
+                orgs = org_param
+            when String
+                orgs = convert_to_array(org_param)
+            else
+                raise InvalidParameterError.new
+            end
+            orgs
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        #
+        # Get a list of organisations that a user is a member of
+        #
+        # This method smells of :reek:DuplicateMethodCall
+
+        def org_repos_from_github(client, org)
+            function_wrapper(client, 'organization_repositories', org)
+        end
+
+        def org_repos_in_parallel(client, orgs)
+            (repos ||= []) << Parallel.map(orgs, :in_threads => orgs.count) { |org| org_repos_from_github(client, org) }
+            clean_from_parallel(repos, :full_name)
+        end
+
+        # Get the org list for a list of users
+        def org_membership_from_github(client, org)
+            function_wrapper(client, 'organizations', org)
+        end
+
+        def org_membership_in_parallel(client, users)
+            (orgs ||= []) << Parallel.map(users, :in_threads => users.count) { |user| org_membership_from_github(client, user) }
+            clean_from_parallel(orgs, :login)
+        end
+
+        def org_membership_private(client, users)
+            org_membership_in_parallel(client, users)
+        end
+
+        def org_membership_slugs_private(client, users)
+            org_membership_in_parallel(client, users).map { |hash| hash[:login] }.compact
+        end
+    end
+end

data/lib/github-lister-core/preview.rb

@@ -0,0 +1,11 @@
+#
+# Octokit has a missing PREVIEW type
+#
+class GithubListerCore
+    #
+    # Missing from Octokit
+    #
+    PREVIEW_TYPES = {
+        :visibility => 'application/vnd.github.nebula-preview+json'
+    }.freeze
+end

data/lib/github-lister-core/releases.rb

@@ -0,0 +1,53 @@
+#
+# This class
+#
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        def latest_release_private(client, repo)
+            begin
+                release = function_wrapper(client, 'latest_release', repo)
+            # rubocop:disable Lint/SuppressedException
+            rescue NotFoundError => _exception
+            end
+            # rubocop:enable Lint/SuppressedException
+            release || []
+        end
+
+        #
+        # Add topics to each repo
+        #
+        # This method smells of :reek:FeatureEnvy
+        def add_latest_release(client, repos)
+            (repo_list ||= []) << Parallel.each(repos, :in_threads => repos.count) { |repo| repo[:latest_release] = latest_release_private(client, repo[:full_name]) }
+            repo_list.flatten
+        end
+
+        #
+        # All releases
+        #
+        def releases_private(client, repo)
+            begin
+                releases = function_wrapper(client, 'releases', repo)
+            # rubocop:disable Lint/SuppressedException
+            rescue NotFoundError => _exception
+            end
+            # rubocop:enable Lint/SuppressedException
+            releases || []
+        end
+
+        #
+        # Add topics to each repo
+        #
+        # This method smells of :reek:FeatureEnvy
+        def add_releases(client, repos)
+            (repo_list ||= []) << Parallel.each(repos, :in_threads => repos.count) { |repo| repo[:releases] = releases_private(client, repo[:full_name]) }
+            repo_list.flatten
+        end
+    end
+end

data/lib/github-lister-core/repos.rb

@@ -0,0 +1,92 @@
+#
+# Pull information specific to respositories
+#
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        ########################################################################
+        # User Owned Repositories                                              #
+        ########################################################################
+
+        def user_repos_from_github(client, user)
+            function_wrapper(client, 'repositories', user, { :type => 'owner', :accept => PREVIEW_TYPES[:visibility] })
+        end
+
+        def user_repos_in_parallel(client, users)
+            (repos ||= []) << Parallel.map(users, :in_threads => users.count) { |user| user_repos_from_github(client, user) }
+            clean_from_parallel(repos, :full_name)
+        end
+
+        def user_repos_private(client, options, users)
+            repos = user_repos_in_parallel(client, users)
+            add_additional_info(client, options, repos)
+        end
+
+        def user_repo_slugs_private(client, users)
+            repos = user_repos_in_parallel(client, users)
+            repos.map { |hash| hash[:full_name] }.compact
+        end
+
+        ########################################################################
+        # Organisation Owned Repositories                                      #
+        ########################################################################
+
+        def org_repos_from_github(client, org)
+            function_wrapper(client, 'organization_repositories', org)
+        end
+
+        def org_repos_in_parallel(client, orgs)
+            (repos ||= []) << Parallel.map(orgs, :in_threads => orgs.count) { |org| org_repos_from_github(client, org) }
+            clean_from_parallel(repos, :full_name)
+        end
+
+        def org_repos_private(client, options, orgs)
+            repos = org_repos_in_parallel(client, orgs)
+            add_additional_info(client, options, repos)
+        end
+
+        def org_repo_slugs_private(client, orgs)
+            repos = org_repos_in_parallel(client, orgs)
+            repos.map { |hash| hash[:full_name] }.compact
+        end
+
+        ########################################################################
+        # Organisation Owned Repositories for ALL Organsations users are a     #
+        # member of                                                            #
+        ########################################################################
+
+        def org_members_repos_private(client, options, users)
+            orgs = org_membership_slugs_private(client, users)
+            repos = org_repos_in_parallel(client, orgs)
+            add_additional_info(client, options, repos)
+        end
+
+        def org_members_repo_slugs_private(client, users)
+            orgs = org_membership_slugs_private(client, users)
+            repos = org_repos_in_parallel(client, orgs)
+            repos.map { |hash| hash[:full_name] }.compact
+        end
+
+        #
+        # Generate a slub list of repos for all organisations that a user is a member of
+        #
+        def all_repos_private(client, options, users)
+            repos = user_repos_private(client, options, users) + org_repos_for_user_private(client, options, users)
+            repos.flatten.sort_by { |repo| repo[:full_name].downcase }
+        end
+
+        #
+        # Get a list of ALL repos that a user has access to (This is both personal and via organisations)
+        # If the user is authenticated and a member of the org it will list private + public
+        #
+        def all_repo_slugs_private(client, users)
+            repos = user_repo_slugs_private(client, users) + org_members_repo_slugs_private(client, users)
+            repos.flatten.sort
+        end
+    end
+end

data/lib/github-lister-core/topics.rb

@@ -0,0 +1,29 @@
+#
+# Add topics to each repository
+#
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        #
+        # Extra the topics slug from the payload and return it
+        #
+        def topics_private(client, repo)
+            topics = function_wrapper(client, 'topics', repo, { :accept => Octokit::Preview::PREVIEW_TYPES[:topics] })
+            topics[:names]
+        end
+
+        #
+        # Add topics to each repo
+        #
+        # This method smells of :reek:FeatureEnvy
+        def add_topics_private(client, repos)
+            (repo_list ||= []) << Parallel.each(repos, :in_threads => repos.count) { |repo| repo[:topics] = topics_private(client, repo[:full_name]) }
+            repo_list.flatten
+        end
+    end
+end

data/lib/github-lister-core/users.rb

@@ -0,0 +1,46 @@
+#
+# Handle anything specific to the user
+#
+# This class smells of :reek:InstanceVariableAssumption
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        def authed_user_in_array(users, authed)
+            users.select { |user| user.downcase == authed.login.downcase } != []
+        end
+
+        def process_user_list(user_list, authed)
+            user_list = convert_to_array(user_list)
+
+            return user_list unless authed
+
+            if authed_user_in_array(user_list, authed)
+                user_list.delete_if { |user| user.downcase == authed.login.downcase }
+                user_list.append(authed)
+            end
+            user_list
+        end
+
+        #
+        # Users can be a string (comma separated) or an array nothing else
+        #
+        def get_user_list(client, options)
+            user_list = get_option(options, [:user, :username])
+            authed = client.user if client.user_authenticated?
+
+            return convert_to_array(authed) unless user_list
+
+            case user_list
+            when Array, String
+                process_user_list(user_list, authed)
+            else
+                raise InvalidParameterError.new
+            end
+        end
+    end
+end

data/lib/github-lister-core/utils.rb

@@ -0,0 +1,75 @@
+#
+# Handle anything specific to the user
+#
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        def clean_from_parallel(item, sorted = nil)
+            return [] if item.nil?
+
+            item = item.flatten.map(&:to_h).uniq
+            item = item.sort_by { |repo| repo[sorted].downcase } if sorted
+            item
+        end
+
+        def convert_to_array(item)
+            case item
+            when Sawyer::Resource
+                [].append(item)
+            when Array
+                item
+            when String
+                item.split(',').map(&:strip).uniq.sort
+            else
+                []
+            end
+        end
+
+        def validate_options(options)
+            raise InvalidOptionsHashError.new unless options.is_a?(Hash)
+        end
+
+        def look_for_option_from_array(options, names)
+            names.each { |name| return options[name] if options.key?(name) }
+            nil
+        end
+
+        def get_option(options, names)
+            return nil unless options
+            return nil unless options.is_a?(Hash)
+
+            case names
+            when Array
+                value = look_for_option_from_array(options, names)
+            when String, Symbol
+                value = options[names] if options.key?(names)
+            end
+            value || nil
+        end
+
+        def flag_set?(options, option)
+            value = get_option(options, option)
+
+            return false unless value
+
+            return false unless value == true
+
+            true
+        end
+
+        def add_additional_info(client, options, repos)
+            return repos if flag_set?(options, :use_slugs)
+
+            repos = add_topics_private(client, repos) if flag_set?(options, :add_topics)
+            repos = add_latest_release_private(client, repos) if flag_set?(options, :add_latest_release)
+            repos = add_releases_private(client, repos) if flag_set?(options, :add_releases)
+            repos = add_languages_private(client, repos) if flag_set?(options, :add_languages)
+            repos
+        end
+    end
+end

data/lib/github-lister-core/version.rb

@@ -0,0 +1,3 @@
+class GithubListerCore
+    VERSION = '0.1.0'.freeze
+end

data/lib/github-lister-core/wrapper.rb

@@ -0,0 +1,32 @@
+#
+# This class store the main processing wrapper which talks to the API and handles all the exceptions
+#
+# This class smells of :reek:InstanceVariableAssumption
+class GithubListerCore
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        # rubocop:disable Metrics/MethodLength
+        def function_wrapper(client, function, *param)
+            begin
+                results = client.send(function, *param)
+            rescue Octokit::Unauthorized
+                raise InvalidTokenError.new if client.user_authenticated?
+
+                raise MissingTokenError.new
+            rescue Octokit::NotFound
+                raise NotFoundError.new
+            rescue Octokit::TooManyRequests
+                raise TooManyRequests.new
+            rescue StandardError
+                raise UnknownError.new
+            end
+            results || []
+        end
+    end
+    # rubocop:enable Metrics/MethodLength
+end