Skip to content

Some small tweaks, new tests and docs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 21, 2015

Conversation

lol768
Copy link
Collaborator

@lol768 lol768 commented Feb 20, 2015

I've made a couple of quick changes:

  • The deployments API has now been released so we don't need to send a special Accept header to use it anymore
  • I felt that the update method was a bit misleading/unclear. Per this page:

Once a deployment is created, it cannot be updated. Information relating to the success or failure of a deployment is handled through Deployment Statuses.

As a result, I've renamed it to updateStatus to try and prevent confusion.

  • I've added a few more doc blocks and links to GitHub's dev docs. Nothing too major.
  • Added a new function for getting all of the deployment status updates for a given deployment.

As for the tests:

  • In the spirit of the other tests, these work by mocking the API client and expecting certain functions to be called.
  • I haven't added any functional tests since they appear to be disabled in the PHPUnit config file and I'm not familiar enough with the project to understand if these are required or not (they're not present for some other APIs).

In terms of documentation:

  • I've added a markdown file for the API and linked it from the main list.

Thanks for your existing work on this, the existing code was nice to work with. Hopefully this can be pulled into knplabs/php-github-api soon.

@lol768 lol768 changed the title Some small tweaks and new tests Some small tweaks, new tests and docs Feb 20, 2015
@ericduran
Copy link
Owner

👍 💯

ericduran added a commit that referenced this pull request Feb 21, 2015
Some small tweaks, new tests and docs
@ericduran ericduran merged commit 53f042d into ericduran:deploymentapi Feb 21, 2015
@lol768
Copy link
Collaborator Author

lol768 commented Feb 22, 2015

Thanks for fixing up those tests - totally slipped my mind that the short array syntax is only relatively recent.

lol768 pushed a commit that referenced this pull request Mar 4, 2015
lol768 pushed a commit that referenced this pull request Mar 4, 2015
Unit tests added for Github\Api\Search
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants