mirror of
				https://github.com/sitelease/sugar-cube-client.git
				synced 2025-10-31 12:02:30 +01:00 
			
		
		
		
	Compare commits
	
		
			1 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 27972b95c7 | 
| @ -1,4 +1,4 @@ | |||||||
| The Suger Cube Client (formerly gitea.php) is released with MIT License: | The Sugar Cube Client (formerly gitea.php) is released with MIT License: | ||||||
|  |  | ||||||
| Copyright © 2018 - 2019 SAB International | Copyright © 2018 - 2019 SAB International | ||||||
| Copyright © 2020 siteLease Web Solutions | Copyright © 2020 siteLease Web Solutions | ||||||
|  | |||||||
| @ -1,10 +1,10 @@ | |||||||
| The Suger Cube Client, a Gitea API client for PHP | The Sugar Cube Client, a Gitea API client for PHP | ||||||
| ======== | ======== | ||||||
|  |  | ||||||
| The Suger Cube Client allows you to send and recieve data from Gitea's RESTful API using object-oriented PHP. | The Sugar Cube Client allows you to send and recieve data from Gitea's RESTful API using object-oriented PHP. | ||||||
|  |  | ||||||
| ### How does it work? | ### How does it work? | ||||||
| Under the hood, Suger Cube uses the [Guzzle Library](http://docs.guzzlephp.org/en/stable/) to make and send requests to [Gitea's RESTful API](https://try.gitea.io/api/swagger) routes. It then converts the returned JSON response data into PHP objects which you can use to easily query the data. | Under the hood, Sugar Cube uses the [Guzzle Library](http://docs.guzzlephp.org/en/stable/) to make and send requests to [Gitea's RESTful API](https://try.gitea.io/api/swagger) routes. It then converts the returned JSON response data into PHP objects which you can use to easily query the data. | ||||||
|  |  | ||||||
| ### Real world Example | ### Real world Example | ||||||
| To see how Sugar Cube can be used in a real world application please refer to [Acapella's code base](https://github.com/sitelease/acappella) (e.g. [line 39](https://github.com/sitelease/acappella/blob/1.0.0/src/Application/GiteaRepositoryManager.php#L39) of GiteaRepositoryManager.php). | To see how Sugar Cube can be used in a real world application please refer to [Acapella's code base](https://github.com/sitelease/acappella) (e.g. [line 39](https://github.com/sitelease/acappella/blob/1.0.0/src/Application/GiteaRepositoryManager.php#L39) of GiteaRepositoryManager.php). | ||||||
| @ -13,7 +13,7 @@ To see how Sugar Cube can be used in a real world application please refer to [A | |||||||
| - [ ] Add Example code to the README | - [ ] Add Example code to the README | ||||||
| - [ ] Create PHPUnit tests for each API requester | - [ ] Create PHPUnit tests for each API requester | ||||||
| - [ ] Create more API requesters for Gitea's API routes | - [ ] Create more API requesters for Gitea's API routes | ||||||
| - [ ] Submit the Suger Cube composer package to Packagist | - [ ] Submit the Sugar Cube composer package to Packagist | ||||||
|  |  | ||||||
| ### Credits | ### Credits | ||||||
| * First thank you goes out to the folks over on the [Gitea.php](https://github.com/sab-international/gitea.php) project. Your Model and Push Event objects provided the foundation of this project. | * First thank you goes out to the folks over on the [Gitea.php](https://github.com/sab-international/gitea.php) project. Your Model and Push Event objects provided the foundation of this project. | ||||||
|  | |||||||
| @ -1,7 +1,7 @@ | |||||||
| { | { | ||||||
|   "name": "sitelease/suger-cube-client", |   "name": "sitelease/sugar-cube-client", | ||||||
|   "description": "Suger Cube Client", |   "description": "A sweet Gitea API client for PHP", | ||||||
|   "homepage": "https://github.com/sitelease/suger-cube-client", |   "homepage": "https://github.com/sitelease/sugar-cube-client", | ||||||
|   "type": "library", |   "type": "library", | ||||||
|   "license": "MIT", |   "license": "MIT", | ||||||
|   "authors": [ |   "authors": [ | ||||||
| @ -17,7 +17,7 @@ | |||||||
|     "client", |     "client", | ||||||
|     "git", |     "git", | ||||||
|     "gitea", |     "gitea", | ||||||
|     "suger", |     "sugar", | ||||||
|     "scm", |     "scm", | ||||||
|     "vcs" |     "vcs" | ||||||
|   ], |   ], | ||||||
| @ -33,7 +33,7 @@ | |||||||
|     "phpunit/phpunit": "^8.1.2" |     "phpunit/phpunit": "^8.1.2" | ||||||
|   }, |   }, | ||||||
|   "support": { |   "support": { | ||||||
|     "docs": "https://github.com/sitelease/suger-cube-client", |     "docs": "https://github.com/sitelease/sugar-cube-client", | ||||||
|     "issues": "https://github.com/sitelease/suger-cube-client/issues" |     "issues": "https://github.com/sitelease/sugar-cube-client/issues" | ||||||
|   } |   } | ||||||
| } | } | ||||||
|  | |||||||
		Reference in New Issue
	
	Block a user
	