v1.0.0 (#29)

New features:
* Add a CLI option --config for config filename
* Add support for GitHub Enterprise repos

Maintenance:
* Use slim linter
* Update docs

Author: dshevtsov

.github/workflows/linter.yml

@@ -42,7 +42,8 @@ jobs:
       # Run Linter against code base #
       ################################
       - name: Lint Code Base
-        uses: github/super-linter@v4
+        uses: github/super-linter/slim@v4
         env:
-          VALIDATE_ALL_CODEBASE: false
           DEFAULT_BRANCH: main
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_GITLEAKS: false

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsup_github (0.5.0)
+    whatsup_github (1.0.0)
       netrc (~> 0.11)
       octokit (~> 6.0)
       thor (~> 1.2)
@@ -91,6 +91,7 @@ GEM
     thor (1.2.1)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
 
 DEPENDENCIES

README.md

@@ -9,6 +9,22 @@ One pull request sources one data entity.
 All filtering parameters are set in a configuration file, except dates.
 _Since_ date is set as a CLI argument and the _till_ date is always the moment when the command is run.
 
+## CLI
+
+```console
+Commands:
+  whatsup_github help [COMMAND]  # Describe available commands or one specific command
+  whatsup_github since DATE      # Filters pull requests since the specified date till now. Default: last 7 days.
+  whatsup_github version         # Current version of the gem
+
+Usage:
+  whatsup_github since DATE
+
+Options:
+  [--config=CONFIG]  # Relative path to the configuration file.
+                     # Default: .whatsup.yml
+```
+
 ## What's generated
 
 A resulting YAML file `tmp/whats-new.yml` is generated from GitHub data.
@@ -38,7 +54,7 @@ Set as a list of `labels` in `.whatsup.yml`. There are two types of labels in co
 
 ### `versions`
 
-Any GitHub label that starts from a digit followed by a period like in regex `\d\.`.
+Any GitHub label that starts from a digit followed by a period like in regular expression `\d\.`.
 Examples: `2.3.x`, `1.0.3-msi`, `2.x`
 
 ### `date`
@@ -59,7 +75,7 @@ Merge commit SHA of the pull request.
 
 ### `membership`
 
-Memebership of the contributor in a configured organization.
+Membership of the contributor in a configured organization.
 
 ### `labels`
 
@@ -91,7 +107,13 @@ bundle
 
 ## Configuration
 
-The configuration file [`.whatsup.yml`](lib/template/.whatsup.yml) will be created automatically after first run unless it's already there.
+The default configuration file [`.whatsup.yml`](lib/template/.whatsup.yml) will be created automatically after first run unless it's already there.
+
+To use non-default location or name of the file, use the --config option. Example:
+
+```shell
+whatsup_github since 'apr 9' --config 'configs/whatsup_bp.yml'
+```
 
 ## Authentication
 
@@ -109,8 +131,20 @@ Example:
 
 ```config
 machine api.github.com
-  login dshevtsov
+  login mypubliclogin
+  password y9o6YvEoa7IukRWUFdnkpuxNjJ3uwiDQp4zkAdU0
+```
+
+Example with GitHub Enterprise:
+
+```config
+machine api.github.com
+  login mypubliclogin
   password y9o6YvEoa7IukRWUFdnkpuxNjJ3uwiDQp4zkAdU0
+
+machine git.enterprise.example.com
+  login myenterpriselogin
+  password GtH7yhvEoa7Iuksdo&TFuxNjJ3uwiDQhjbiu8&yhJhG
 ```
 
 ### With an environment variable
@@ -202,7 +236,7 @@ The tests use the root `.whatsup.yml` file to read configuration.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dshevtsov/whatsup_github. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

lib/template/.whatsup.yml

@@ -1,7 +1,11 @@
 # Parameters for a GitHub search query
 base_branch: master
 
+# Set hostname to read repos at GitHub Enterprise
+# enterprise: <hostname>
+
 # The list of repositories to scan for pull requests
+# For repos at GitHub Enterprise, add a prefix 'enterprise:'. Example: enterprise:magento/devdocs.
 repos:
   - magento/devdocs
 

lib/whatsup_github/cli.rb

@@ -7,7 +7,11 @@ module WhatsupGithub
   # CLI options
   class CLI < Thor
     desc 'since DATE', 'Filters pull requests since the specified date till now. Default: last 7 days.'
+    option :config,
+           desc: 'Relative path to the configuration file.',
+           default: '.whatsup.yml'
     def since(date = Date.today - 7)
+      WhatsupGithub::Config.filename = options[:config]
       runner = WhatsupGithub::Runner.new(Date.parse(date.to_s))
       runner.run
     end

lib/whatsup_github/config_reader.rb

@@ -11,8 +11,14 @@ class Config
 
     include Singleton
 
+    @@filename = ''
+
+    def self.filename=(filename)
+      @@filename = filename
+    end
+
     def initialize
-      @file = '.whatsup.yml'
+      @file = @@filename
       @config = {}
     end
 
@@ -64,6 +70,10 @@ def membership
     def magic_word
       read['magic_word']
     end
+
+    def enterprise
+      read['enterprise']
+    end
   end
 end
 

lib/whatsup_github/enterprise_client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+# Client authorization
+module WhatsupGithub
+  # Create a singleton object for EnterpriseClient.
+  # Authorize with a GitHub Enterprise token from $WHATSUP_ENTERPRISE_ACCESS_TOKEN if available
+  # Otherwise, use credentials from ~/.netrc
+  class EnterpriseClient < Client
+    include Singleton
+
+    WHATSUP_ENTERPRISE_ACCESS_TOKEN = ENV['WHATSUP_ENTERPRISE_ACCESS_TOKEN']
+    private_constant :WHATSUP_ENTERPRISE_ACCESS_TOKEN
+
+    @@hostname = ''
+
+    def self.host=(hostname)
+      abort "ERROR: Set value for 'enterprise' in the whatsup_github configuration" if hostname.nil?
+      @@hostname = hostname
+    end
+
+    def initialize
+      Octokit.configure do |c|
+        c.api_endpoint = "https://#{@@hostname}/api/v3/"
+      end
+      @client =
+        if WHATSUP_ENTERPRISE_ACCESS_TOKEN
+          Octokit::Client.new(access_token: WHATSUP_ENTERPRISE_ACCESS_TOKEN)
+        elsif File.exist? "#{ENV['HOME']}/.netrc"
+          Octokit::Client.new(netrc: true)
+        end
+    end
+  end
+end

lib/whatsup_github/pulls.rb

@@ -3,6 +3,7 @@
 require 'octokit'
 require_relative 'config_reader'
 require_relative 'client'
+require_relative 'enterprise_client'
 
 module WhatsupGithub
   # Gets issues found on GitHub by query
@@ -24,10 +25,6 @@ def data
 
     private
 
-    # def access_token
-    #   credentials.dig 'github_token'
-    # end
-
     def configuration
       Config.instance
     end
@@ -48,25 +45,46 @@ def base_branch
       configuration.base_branch
     end
 
-    # Authorize with a GitHub token from $WHATSUP_GITHUB_ACCESS_TOKEN if available
-    # Otherwise, use credentials from ~/.netrc
-    # Otherwise, continue as a Guest
     def client
       Client.instance
     end
 
+    def enterprise_client
+      WhatsupGithub::EnterpriseClient.host = configuration.enterprise
+      EnterpriseClient.instance
+    end
+
     def search_issues(label)
       auto_paginate
-      query = "repo:#{repo} label:\"#{label}\" merged:>=#{since} base:#{base_branch} is:pull-request"
-      puts "Searching on GitHub by query #{query}"
-      client.search_issues(query)
+      call_query query(label)
     end
 
     def search_issues_with_magic_word(label)
       auto_paginate
-      query = "repo:#{repo} label:\"#{label}\" merged:>=#{since} base:#{base_branch} \"#{magic_word}\" in:body is:pull-request"
+      call_query query_with_magic_word(label)
+    end
+
+    def call_query(query)
       puts "Searching on GitHub by query #{query}"
-      client.search_issues(query)
+      if repo.start_with? 'enterprise:'
+        enterprise_client.search_issues(
+          enterprise_query(query)
+        )
+      else
+        client.search_issues(query)
+      end
+    end
+
+    def enterprise_query(query)
+      query.gsub('enterprise:', '')
+    end
+
+    def query(label)
+      "repo:#{repo} label:\"#{label}\" merged:>=#{since} base:#{base_branch} is:pull-request"
+    end
+
+    def query_with_magic_word(label)
+      query(label) + " \"#{magic_word}\" in:body"
     end
 
     def auto_paginate

lib/whatsup_github/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhatsupGithub
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 end