github-lister-core 0.1.0

data/lib/github-lister-core.rb

@@ -0,0 +1,113 @@
+#
+# Require the external gems
+#
+require 'json'
+require 'octokit'
+require 'parallel'
+
+#
+# Require the internal components
+#
+require_relative 'github-lister-core/client'
+require_relative 'github-lister-core/errors'
+require_relative 'github-lister-core/languages'
+require_relative 'github-lister-core/organisations'
+require_relative 'github-lister-core/preview'
+require_relative 'github-lister-core/releases'
+require_relative 'github-lister-core/repos'
+require_relative 'github-lister-core/topics'
+require_relative 'github-lister-core/users'
+require_relative 'github-lister-core/utils'
+require_relative 'github-lister-core/version'
+require_relative 'github-lister-core/wrapper'
+
+#
+# This is the main class
+#
+# This class smells of :reek:RepeatedConditional
+class GithubListerCore
+    class << self
+        #
+        # stuff goes here
+        #
+        def user_repos(options = {})
+            validate_options(options)
+            client = init_client(options)
+            users = get_user_list(client, options)
+
+            if flag_set?(options, :use_slugs)
+                user_repo_slugs_private(client, options, users)
+            else
+                user_repos_private(client, options, users)
+            end
+        end
+
+        #
+        # Get a list of repos got a given organisation
+        # If the user is authenticated and a member of the org it will list private + public
+        #
+        def org_repos(options = {})
+            validate_options(options)
+            client = init_client(options)
+            orgs = get_org_list(options)
+
+            if flag_set?(options, :use_slugs)
+                org_repo_slugs_private(client, orgs).to_json
+            else
+                org_repos_private(client, options, orgs).to_json
+            end
+        end
+
+        #
+        # Get a list of repos for ALL organisations that a user is a member of
+        # If the user is authenticated and a member of the org it will list private + public
+        #
+        def org_members_repos(options = {})
+            validate_options(options)
+            client = init_client(options)
+            users = get_user_list(client, options)
+
+            if flag_set?(options, :use_slugs)
+                org_members_repo_slugs_private(client, users).to_json
+            else
+                org_members_repos_private(client, options, users).to_json
+            end
+        end
+
+        #
+        # Generate a slub list of repos for all organisations that a user is a member of
+        #
+        def all_repos(options = {})
+            validate_options(options)
+            client = init_client(options)
+            user = get_user_list(client, options)
+
+            if flag_set?(options, :use_slugs)
+                all_repo_slugs_private(client, user).to_json
+            else
+                all_repos_private(client, options, user).to_json
+            end
+        end
+
+        #
+        # These are the public wrappers which return json encoded objects.
+        #
+
+        def org_membership(options = {})
+            validate_options(options)
+            client = init_client(options)
+            users = get_user_list(client, options)
+
+            if flag_set?(options, :use_slugs)
+                org_membership_slugs_private(client, users).to_json
+            else
+                org_membership_private(client, users).to_json
+            end
+        end
+    end
+end
+
+#
+# Add an alias because the name is long
+#
+GLC = GithubListerCore

data/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: true

data/testing/get-raw.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+#
+# This is a very simply testing script to allow for testing of local changes without having to install the gem locally
+#
+
+require 'json'
+
+$LOAD_PATH.unshift('./lib')
+
+require 'bundler/setup'
+require 'github-lister-core'
+
+config = {}
+
+def count_results(results)
+    puts JSON.parse(results).size
+end
+
+def display_results(results)
+    puts JSON.pretty_generate(JSON.parse(results))
+end
+
+count_results(GithubListerCore.user_repos(config))
+display_results(GithubListerCore.user_repos(config))
+
+count_results(GithubListerCore.org_repos(config))
+display_results(GithubListerCore.org_repos(config))
+
+count_results(GithubListerCore.org_members_repos(config))
+display_results(GithubListerCore.org_members_repos(config))
+
+count_results(GithubListerCore.all_repos(config))
+display_results(GithubListerCore.all_repos(config))
+
+count_results(GithubListerCore.org_membership(config))
+display_results(GithubListerCore.org_membership(config))

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: github-lister-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Gurney aka Wolf
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+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.
+email:
+- wolf@tgwolf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/ask_question.md"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/SECURITY.md"
+- ".github/SUPPORT.md"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION.txt
+- bin/console
+- bin/setup
+- github-lister-core.gemspec
+- lib/github-lister-core.rb
+- lib/github-lister-core/client.rb
+- lib/github-lister-core/errors.rb
+- lib/github-lister-core/languages.rb
+- lib/github-lister-core/organisations.rb
+- lib/github-lister-core/preview.rb
+- lib/github-lister-core/releases.rb
+- lib/github-lister-core/repos.rb
+- lib/github-lister-core/topics.rb
+- lib/github-lister-core/users.rb
+- lib/github-lister-core/utils.rb
+- lib/github-lister-core/version.rb
+- lib/github-lister-core/wrapper.rb
+- stale.yml
+- testing/get-raw.rb
+homepage: https://github.com/DevelopersToolbox/github-lister-core
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DevelopersToolbox/github-lister-core
+  source_code_uri: https://github.com/DevelopersToolbox/github-lister-core
+  changelog_uri: https://github.com/DevelopersToolbox/github-lister-core/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Provide a simple, fast and, clean way to extract repository information from
+  GitHub.
+test_files: []