bodunadebiyi / evangelizer Goto Github PK

#EVANGELIZER ##Summary This project interfaces with the GitHub API and fetches a users GitHub data. It fetches the numbers of repos a user has and determines the users Evangelical Status based on his/her number of repos.

• 5 - 10 repos (Junior Evangelist)
• 11 - 20 repos (Associate Evangelist)

• 21 repos (Senior Evangelist)

The src directory contains two files. The first file is a class that handles the custom Exceptions that are generated and the second file is a class that interfaces with the GitHub API, fetches and processes the users data and returns the users status.

##Usage

//create an instance and initialize
$username = "andela-badebiyi";
$evangelist = new EvangelistStatus($username); 

//fetch user status
try{
  $evangelist->getStatus();
}
catch(InvalidGitUserException $e){
  echo $e->errorMessage();
}

##Installation From your root directory run composer install. This would install all the necessary dependencies

##Requirements

• PHP
• PHPUnit

##Testing Move to your root directory in your terminal and run phpunit