Break out CheckIfDead class into a separate GitHub repo
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	kaldari
	Jul 12 2016, 5:27 PM

Description

The CheckIfDead class could be useful to lots of open source developers, but in order for that to happen, it needs to be broken out into a separate repo and then included in the IABot repo via Composer or a similar mechanism.

In the process, we should probably break the checkDeadlinks() function into smaller testable pieces and add a convenience function for testing individual URLs (that is called something like 'isDeadLink' rather than 'checkDeadLink', which is ambiguous).

Finally, a README needs to be written with some basic documentation.

Existing code is here: https://github.com/cyberpower678/Cyberbot_II/blob/master/IABot/checkIfDead.php

Also, make this a composer package. This task does not include refactoring Cyberbot code to use the new library.

Related Objects
Search...

Status	Assigned	Task
Resolved	Cyberpower678	T120433 Migrate dead external links to archives
Resolved	Cyberpower678	T141347 Create and test v1.2 of InternetArchiveBot (tracking)
Resolved	• Niharika	T140388 Get IABot to use new CheckIfDead package
Resolved	• Niharika	T140135 Break out CheckIfDead class into a separate GitHub repo

Event Timeline

kaldari created this task.Jul 12 2016, 5:27 PM

Restricted Application added subscribers: Zppix, Aklapper. · View Herald TranscriptJul 12 2016, 5:27 PM

kaldari moved this task from New & TBD Tickets to Needs Discussion on the Community-Tech board.Jul 12 2016, 5:27 PM

kaldari added a subscriber: Cyberpower678.

kaldari updated the task description. (Show Details)Jul 14 2016, 5:40 PM

kaldari updated the task description. (Show Details)Jul 14 2016, 5:42 PM

See https://www.mediawiki.org/wiki/Manual:Developing_libraries for some tips on creating a library

kaldari mentioned this in T140388: Get IABot to use new CheckIfDead package.Jul 14 2016, 5:43 PM

• DannyH triaged this task as Medium priority.Jul 14 2016, 5:44 PM

• DannyH set the point value for this task to 5.

• DannyH moved this task from Needs Discussion to Up Next on the Community-Tech board.

• Niharika claimed this task.Jul 19 2016, 4:33 PM

• Niharika edited projects, added Community-Tech-Sprint; removed Community-Tech.

• Niharika moved this task from Ready to In Development on the Community-Tech-Sprint board.

• DannyH added a parent task: T120433: Migrate dead external links to archives.Jul 19 2016, 6:15 PM

kaldari claimed this task.Jul 28 2016, 5:17 PM

kaldari added a subscriber: • Niharika.

• DannyH added a subtask: T140388: Get IABot to use new CheckIfDead package.Aug 1 2016, 6:38 PM

• DannyH removed a subtask: T140388: Get IABot to use new CheckIfDead package.

• DannyH added a parent task: T140388: Get IABot to use new CheckIfDead package.

• DannyH removed a parent task: T120433: Migrate dead external links to archives.Aug 1 2016, 6:42 PM

kaldari reassigned this task from kaldari to • Niharika.Aug 1 2016, 8:12 PM

• Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Aug 3 2016, 12:23 AM

I did one more code review pass:
https://github.com/Niharika29/DeadlinkChecker/commit/b54e9506bfa630475856630bdce57ffedca88fb2

kaldari moved this task from Needs Review/Feedback to In Development on the Community-Tech-Sprint board.Aug 3 2016, 2:23 AM

kaldari closed this task as Resolved.Aug 3 2016, 10:11 PM

We're also going to do the Packagist packaging as part of this ticket.

• Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Aug 4 2016, 9:58 PM

• Niharika moved this task from Needs Review/Feedback to In Development on the Community-Tech-Sprint board.Aug 9 2016, 5:51 PM

I've updated the code to remove all the error array instances. The return format now is:

[ 'url1' => true, 'url2' => false ]

I've updated the tests accordingly.

Looking into the Packagist bit now.

You only removed the bits that return the error correct? The curl error codes are still part of the checks though, right?

In T140135#2539654, @Cyberpower678 wrote:

You only removed the bits that return the error correct? The curl error codes are still part of the checks though, right?

Correct.

Live on Packagist now: https://packagist.org/packages/niharika29/deadlinkchecker

• Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Aug 15 2016, 9:57 AM

Looks good, but I'm still concerned about requiring PHP 5.6. Tool Labs only runs 5.5 and current versions of HHVM are mostly based on PHP 5.5 (from my understanding). I haven't tried building this in Vagrant yet, but I'm not sure if it would or not. Is there anything keeping us from using PHP 5.5 besides requiring a less up-to-date version of phpunit?

Do we need this class on tool labs?

We (as in IABot) don't, but other people might. For example, this would be a nice class for citation bot to use or even CopyPatrol.

As far as I can tell this class is fully operational on PHP 5.5 and only requires 5.6 for PHPUnit, which can easily be remedied by dowloading PHPUnit-old.