Adds methods to GHRepository to get the top ten referral paths and referrers via the API #1770

ihrigb · 2023-12-14T14:10:35Z

Description

Adds methods to GHRepository to get the top ten referral paths and referrers via the API.

References:

Before submitting a PR:

Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
Add JavaDocs and other comments explaining the behavior.
When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

Fill in the "Description" above with clear summary of the changes. This includes:
- If this PR fixes one or more issues, include "Fixes #" lines for each issue.
- Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
Enable "Allow edits from maintainers".

ihrigb · 2023-12-14T15:17:38Z

Maybe someone could help with tests here. I get No response could be served as there are no stub mappings in this WireMock instance..

Plus running mvn -D enable-ci clean install site does fail for me, even on the current main branch without my changes.

bitwiseman · 2024-01-05T00:26:52Z

What failure are you getting on main?

ihrigb · 2024-01-08T11:41:04Z

[INFO] Results:
[INFO]
[ERROR] Errors: 
[ERROR]   AppTest.notifications:1706 » GHIO Failed to set the custom verb
[ERROR]   AppTest.testCreateCommitComment:914 » GHIO Failed to set the custom verb
[ERROR]   AppTest.testCreateIssue:274 » GHIO Failed to set the custom verb
[ERROR]   AppTest.testPullRequestSearch:1451 » GHIO Failed to set the custom verb
[ERROR]   AppTest.testRepoCRUD:59 » GHIO Failed to set the custom verb
[ERROR]   AppTest.testRepoLabel:1582 » GHIO Failed to set the custom verb
[ERROR]   GHCheckRunBuilderTest.createCheckRunManyAnnotations:104 » GHIO Failed to set the custom verb
[ERROR]   GHCheckRunBuilderTest.updateCheckRun:192 » GHIO Failed to set the custom verb
[ERROR]   GHDiscussionTest.testGetAndEditDiscussion:119 » GHIO Failed to set the custom verb
[ERROR]   GHGistTest.lifecycleTest:54 » GHIO Failed to set the custom verb
[ERROR]   GHGistUpdaterTest.testGitUpdater:70 » GHIO Failed to set the custom verb
[ERROR]   GHIssueEventTest.testEventsForIssueRename:97 » GHIO Failed to set the custom verb
[ERROR]   GHIssueEventTest.testEventsForSingleIssue:33 » GHIO Failed to set the custom verb
[ERROR]   GHIssueEventTest.testIssueReviewRequestedEvent:80 » GHIO Failed to set the custom verb
[ERROR]   GHIssueTest.closeIssue:160 » GHIO Failed to set the custom verb
[ERROR]   GHIssueTest.removeLabels:260 » GHIO Failed to set the custom verb
[ERROR]   GHIssueTest.setAssignee:298 » GHIO Failed to set the custom verb
[ERROR]   GHIssueTest.setLabels:175 » GHIO Failed to set the custom verb
[ERROR]   GHMilestoneTest.testUnsetMilestone:91 » GHIO Failed to set the custom verb
[ERROR]   GHMilestoneTest.testUnsetMilestoneFromPullRequest:115 » GHIO Failed to set the custom verb
[ERROR]   GHMilestoneTest.testUpdateMilestone:59 » GHIO Failed to set the custom verb
[ERROR]   GHOrganizationTest.testEnableOrganizationProjects:495 » GHIO Failed to set the custom verb
[ERROR]   GHProjectCardTest.testArchiveCard:69 » GHIO Failed to set the custom verb
[ERROR]   GHProjectCardTest.testEditCardNote:55 » GHIO Failed to set the custom verb
[ERROR]   GHProjectColumnTest.testEditColumnName:51 » GHIO Failed to set the custom verb
[ERROR]   GHProjectTest.testEditProjectBody:71 » GHIO Failed to set the custom verb
[ERROR]   GHProjectTest.testEditProjectName:56 » GHIO Failed to set the custom verb
[ERROR]   GHProjectTest.testEditProjectState:86 » GHIO Failed to set the custom verb
[ERROR]   GHReleaseTest.testMakeLatestRelease:191 » GHIO Failed to set the custom verb
[ERROR]   GHReleaseTest.testUpdateRelease:130 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.archive:124 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.setDeleteBranchOnMerge:995 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.setMergeOptions:951 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.testGetRepositoryWithVisibility:432 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.testSearchPullRequests:1745 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.testSetPublic:303 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.testUpdateRepoActionVariable:1676 » GHIO Failed to set the custom verb
[ERROR]   GHRepositoryTest.testUpdateRepository:390 » GHIO Failed to set the custom verb
[ERROR]   GHTeamTest.testSetDescription:39 » GHIO Failed to set the custom verb
[ERROR]   GHTeamTest.testSetPrivacy:147 » GHIO Failed to set the custom verb
[ERROR]   GHTreeBuilderTest.testAdd:125->updateTree:187 » GHIO Failed to set the custom verb
[ERROR]   GHTreeBuilderTest.testDelete:149->updateTree:187 » GHIO Failed to set the custom verb
[ERROR]   GHTreeBuilderTest.testShaEntry:106->updateTree:187 » GHIO Failed to set the custom verb
[INFO]
[ERROR] Tests run: 458, Failures: 0, Errors: 43, Skipped: 25
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:56 min
[INFO] Finished at: 2024-01-08T12:40:18+01:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:3.2.3:test (default-test) on project github-api:
[ERROR]
[ERROR] Please refer to C:\SAPDevelop\opensource\github-api\target\surefire-reports for the individual test results.
[ERROR] Please refer to dump files (if any exist) [date].dump, [date]-jvmRun[N].dump and [date].dumpstream.
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

ihrigb · 2024-02-06T09:14:13Z

@bitwiseman ?

ihrigb · 2024-03-04T14:06:46Z

@bitwiseman ping again

bitwiseman · 2024-03-08T00:22:51Z

@ihrigb
To make the tests run locally, run this:

mvn -B clean install -D enable-ci "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"

I understand this differs from what is in CONTRIBUTING.md. I'm working on updating the build and the instructions to remove the need for that extra argument.

ihrigb · 2024-03-08T14:11:20Z

In that case, the build is fine.

bitwiseman · 2024-06-20T03:17:19Z

@ihrigb
It looks like there are still some CI failures. Please update this PR.

…referrer

ihrigb · 2024-06-21T12:18:03Z

@bitwiseman should be good now...

codecov · 2024-06-23T19:18:15Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.87%. Comparing base (e8c6beb) to head (a6decf5).

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1770      +/-   ##
============================================
+ Coverage     80.79%   80.87%   +0.07%     
- Complexity     2417     2430      +13     
============================================
  Files           233      236       +3     
  Lines          7264     7294      +30     
  Branches        398      398              
============================================
+ Hits           5869     5899      +30     
  Misses         1148     1148              
  Partials        247      247

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

bitwiseman · 2024-06-23T19:41:46Z

@ihrigb
Sorry, code coverage reporting was broken for a bit. Now it is working, please address items in the report.

ihrigb · 2024-07-01T08:00:44Z

@bitwiseman can you please grant me access to hub4j-test-org?

…referrer

ihrigb · 2024-07-01T12:41:15Z

@bitwiseman finally ready to merge.

bitwiseman · 2024-07-01T17:13:05Z

You got reasonable tests without needing test-org access. Thanks for sticking with this!

ihrigb · 2024-07-01T18:32:39Z

You got reasonable tests without needing test-org access. Thanks for sticking with this!

Is that preferrable over using the test org?

bitwiseman · 2024-07-02T00:55:55Z

No, test org is generally better for future test support, but wanted to get your change into this release.

ihrigb · 2024-07-03T16:34:58Z

@bitwiseman I did get the invitation mail for the test org, but seems like the invitation itself does no longer exist.

bitwiseman · 2024-07-03T16:38:54Z

@ihrigb
Resent invitation, so you have it for what ever your next PR is.

ihrigb · 2024-07-03T16:44:58Z

Rulesets (#1181) ;)
Thanks!

ihrigb added 3 commits December 14, 2023 15:02

Add methods to get the referral and referrer metrics

099b27f

Add links

8032876

Apply code style

28b67f9

ihrigb changed the title ~~Dev referrer~~ Adds methods to GHRepository to get the top ten referral paths and referrers via the API Dec 14, 2023

Merge branch 'main' into dev-referrer

0329691

ihrigb and others added 4 commits April 15, 2024 10:28

Add methods to get the referral and referrer metrics

dced813

Add links

f1c665e

Apply code style

30e55d0

Merge branch 'main' into dev-referrer

ab6f3bd

bitwiseman added the work-abandoned There hasn't been any activity on the PR in a while. Another contributor might want to pick it up. label Jun 20, 2024

ihrigb added 10 commits June 21, 2024 11:58

Merge branch 'main' into dev-referrer

5e77328

Fix link tags

a899a65

Merge branch 'dev-referrer' of github.com:ihrigb/github-api into dev-…

b22b80a

…referrer

Fix javadocs

db2217e

Make this work

00a1a19

Fix format

e769f56

Enhance test coverage

330c1f2

Use hamcrest matchers

161d359

Clear formatting

6da779f

Add javadoc to test classes

8318caf

Avoid pagination when not required

195ebd3

bitwiseman force-pushed the dev-referrer branch from 8c33a70 to 195ebd3 Compare June 22, 2024 05:11

bitwiseman removed the work-abandoned There hasn't been any activity on the PR in a while. Another contributor might want to pick it up. label Jun 22, 2024

bitwiseman added 3 commits June 22, 2024 09:27

Merge branch 'main' into dev-referrer

e17fa48

Merge branch 'main' into dev-referrer

0a43f4c

Merge branch 'main' into dev-referrer

a052587

bitwiseman and others added 3 commits June 23, 2024 12:41

Merge branch 'main' into dev-referrer

833b077

Merge branch 'main' into dev-referrer

6e6e01d

Merge branch 'main' into dev-referrer

b1dd7f6

ihrigb added 4 commits July 1, 2024 10:25

Add testcases for methods

47ac86e

Merge branch 'dev-referrer' of github.com:ihrigb/github-api into dev-…

18430ee

…referrer

Add javadoc to test methods

47a7b82

Use java.util.Arrays

a6decf5

bitwiseman approved these changes Jul 1, 2024

View reviewed changes

bitwiseman merged commit 3e478c2 into hub4j:main Jul 1, 2024
12 checks passed

ihrigb deleted the dev-referrer branch July 1, 2024 18:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds methods to GHRepository to get the top ten referral paths and referrers via the API #1770

Adds methods to GHRepository to get the top ten referral paths and referrers via the API #1770

ihrigb commented Dec 14, 2023 •

edited

Loading

ihrigb commented Dec 14, 2023 •

edited

Loading

bitwiseman commented Jan 5, 2024

ihrigb commented Jan 8, 2024

ihrigb commented Feb 6, 2024

ihrigb commented Mar 4, 2024

bitwiseman commented Mar 8, 2024

ihrigb commented Mar 8, 2024

bitwiseman commented Jun 20, 2024

ihrigb commented Jun 21, 2024

codecov bot commented Jun 23, 2024 •

edited

Loading

bitwiseman commented Jun 23, 2024

ihrigb commented Jul 1, 2024 •

edited

Loading

ihrigb commented Jul 1, 2024

bitwiseman commented Jul 1, 2024

ihrigb commented Jul 1, 2024

bitwiseman commented Jul 2, 2024

ihrigb commented Jul 3, 2024

bitwiseman commented Jul 3, 2024

ihrigb commented Jul 3, 2024

Adds methods to GHRepository to get the top ten referral paths and referrers via the API #1770

Adds methods to GHRepository to get the top ten referral paths and referrers via the API #1770

Conversation

ihrigb commented Dec 14, 2023 • edited Loading

Description

Before submitting a PR:

When creating a PR:

ihrigb commented Dec 14, 2023 • edited Loading

bitwiseman commented Jan 5, 2024

ihrigb commented Jan 8, 2024

ihrigb commented Feb 6, 2024

ihrigb commented Mar 4, 2024

bitwiseman commented Mar 8, 2024

ihrigb commented Mar 8, 2024

bitwiseman commented Jun 20, 2024

ihrigb commented Jun 21, 2024

codecov bot commented Jun 23, 2024 • edited Loading

Codecov Report

bitwiseman commented Jun 23, 2024

ihrigb commented Jul 1, 2024 • edited Loading

ihrigb commented Jul 1, 2024

bitwiseman commented Jul 1, 2024

ihrigb commented Jul 1, 2024

bitwiseman commented Jul 2, 2024

ihrigb commented Jul 3, 2024

bitwiseman commented Jul 3, 2024

ihrigb commented Jul 3, 2024

ihrigb commented Dec 14, 2023 •

edited

Loading

ihrigb commented Dec 14, 2023 •

edited

Loading

codecov bot commented Jun 23, 2024 •

edited

Loading

ihrigb commented Jul 1, 2024 •

edited

Loading