PHPackages ibonly/naija-emoji - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ibonly/naija-emoji ActiveLibrary[Utility & Helpers](/categories/utility) ibonly/naija-emoji ================== 15[1 PRs](https://github.com/andela-iadeniyi/emojinaija/pulls)PHP Since Dec 3Pushed 10y ago1 watchersCompare [ Source](https://github.com/andela-iadeniyi/emojinaija)[ Packagist](https://packagist.org/packages/ibonly/naija-emoji)[ RSS](/packages/ibonly-naija-emoji/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependenciesVersions (2)Used By (0) emojinaija ========== [](#emojinaija) [![Build Status](https://camo.githubusercontent.com/ade67b467d4b93121ed940231ab0d2f760c52b076cd0c39f76b57d031c02fe71/68747470733a2f2f7472617669732d63692e6f72672f616e64656c612d696164656e6979692f656d6f6a696e61696a612e737667)](https://travis-ci.org/andela-iadeniyi/emojinaija)[![License](https://camo.githubusercontent.com/e498eead712d82d9ee1af0a4850acd2e46ea48c48fb9ce5a3d2ab64f28f95b34/687474703a2f2f696d672e736869656c64732e696f2f3a6c6963656e73652d6d69742d626c75652e737667)](https://github.com/andela-iadeniyi/emojinaija/blob/master/LICENCE)[![Quality Score](https://camo.githubusercontent.com/f09c30a7e46b195b67d5bb000312a3224338ad9b617ede55aa9b3bf82204dfcd/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f616e64656c612d696164656e6979692f656d6f6a696e61696a612e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/andela-iadeniyi/emojinaija)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/c514be7ec4900ff27e50cdabf1dc6f5c039033fe59eb5d3320d66edb2eabe1ef/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f616e64656c612d696164656e6979692f656d6f6a696e61696a612f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/andela-iadeniyi/emojinaija/?branch=master)[![Code Climate](https://camo.githubusercontent.com/31e8abbd5b2e441beb5f65abe4c654eb99af704a83839ca69b650245c8f8c56e/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f616e64656c612d696164656e6979692f656d6f6a696e61696a612f6261646765732f6770612e737667)](https://codeclimate.com/github/andela-iadeniyi/emojinaija)[![Test Coverage](https://camo.githubusercontent.com/b4f8c2a584c5811b467189875c17ed0264959107df5977e2f653812846ed9d74/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f616e64656c612d696164656e6979692f656d6f6a696e61696a612f6261646765732f636f7665726167652e737667)](https://codeclimate.com/github/andela-iadeniyi/emojinaija/coverage) Emojinaija is a restful API service that provide access for emoji management. Just link to the [emojinaija](https://emojinaija.herokuapp.com/). Installation ------------ [](#installation) [PHP](https://php.net) 5.5+ and [Composer](https://getcomposer.org) are required. Via Composer ``` $ composer require ibonly/naija-emoji $ composer install ``` Usage ----- [](#usage) ### API ENDPOINT [](#api-endpoint) ``` EndPoint Public Access POST /auth/Login TRUE GET /auth/Logout FALSE POST /emojis FALSE GET /emojis/ TRUE GET /emojis/{id} TRUE POST /emojis/{id} FALSE PATCH /emojis/{id} FALSE PUT /emojis/{id} FALSE DELETE /emojis/{id} FALSE ``` ### API FUNCTIONALITY [](#api-functionality) ``` EndPoint Functionality POST /auth/login Logs a user in GET /auth/logout Logs a user out GET /emojis List all the created emojis. GET /emojis/{id} Gets a single emoji POST /emojis Create a new emoji PUT /emojis/{id} Updates an emoji PATCH /emojis/{id} Partially updates an emoji DELETE /emojis/{id} Deletes a single emoji ``` Methods accessible to the public -------------------------------- [](#methods-accessible-to-the-public) \####Single emoji retrieval REQUEST: ``` GET https://emojinaija.herokuapp.com/emoji/1 HEADER: {"Content-Type": "application/json"} ``` RESPONSE MESSAGE: If emoji with id of 1 exist: ``` HEADER: {"status": 200} BODY: [ { "id": 1, "name": "lips", "char": "�" "keyword": [ "lips", "parts", "body", "kiss" ], "category": "human", "date_created": "2015-11-19 22:37:08", "date_modified": "2015-10-19 22:37:08", "created_by": "foo" } ] ``` RESPONSE MESSAGE: If emoji of id 1 is not found ``` HEADER: {"status": 404} BODY: { "message": "Not Found" } ``` - Retrieve all emoji REQUEST: ``` HEADER: GET https://emojinaija.herokuapp.com/emojis HEADER: {"Content-Type": "application/json"} ``` RESPONSE MESSAGE: Get all emoji: ``` HEADER: {"status": 200} BODY: If there are saved resources [ { "id": 3, "name": "Olopa", "char": "👮", "keywords": [ "man", "police", "human" ], "category": "Peoples", "date_created": "2015-11-25 09:30:19", "date_modified": "2015-11-25 09:35:00", "created_by": "foo" }, { "id": 4, "name": "nose", "char": "👃", "keywords": [ "human parts", "nose", "body" ], "category": "human", "date_created": "2015-11-26 09:09:46", "date_modified": "2015-11-26 09:09:46", "created_by": "foo" }, { "id": 5, "name": "Prof", "char": "👴", "keywords": [ "Human", "People" ], "category": "Human", "date_created": "2015-11-26 15:32:19", "date_modified": "2015-11-26 15:32:19", "created_by": "foo" } ] ``` RESPONSE MESSAGE: If no emoji found: ``` HEADER: {"status": 404} BODY: { "message": "Not Found" } ``` - In order to access private methods, Registration is required and a token will be generated for the registered user when logged in. The token generated will be used to access private API. - Registration REQUEST: ``` POST https://emojinaija.herokuapp.com/register HEADER: {"Content-Type": "application/json"} BODY: { "username": your_preferred_username, "password": your_preferred_password } ``` RESPONSE MESSAGE: ``` HEADER: {"status": 200} BODY: { "username": "ogeni", "message": "Registration Successful. Please Login to generate your token" } ``` - Login authentication REQUEST: ``` POST https://emojinaija.herokuapp.com/auth/login HEADER: {"Content-Type": "application/json"} BODY: { "username": your_username, "password": your_password } ``` RESPONSE MESSAGE: ``` HEADER: {"status": 200} BODY: { "username": "user", "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJpc3" } ``` - Logout REQUEST: ``` GET https://emojinaija.herokuapp.com/auth/logout HEADER: { "Content-Type": "application/json", "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJpc3" } ``` RESPONSE MESSAGE: ``` HEADER: {"status": 200} BODY: { "message": "Logged out Successfully" } ``` - Creating new emoji REQUEST: ``` POST https://emojinaija.herokuapp.com/emojis HEADER: { "Content-Type": "application/json", "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJpc3" } BODY: { "name": "Horse", "char" : "🐎" "keyword": "Animal, Horse, Farm, Esin", "category": "Animal" } ``` RESPONSE MESSAGE: ``` HEADER: {"status": 200} BODY: { "id": 9, "name": "Horse", "char" : "🐎" "keyword": [ "Animal", "Horse", "Farm", "Esin" ], "category": "Animal", "date_created": "2015-11-26 15:32:19", "date_modified": "2015-11-26 15:32:19", "created_by": "foo" } ``` - Updating emojis REQUEST: ``` PUT https://emojinaija.herokuapp.com/emojis/9 PATCH https://emojinaija.herokuapp.com/emojis/9 HEADER: { "Content-Type": "application/json", "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJpc3" } BODY: { "keyword": "Animal, Horse, Farm, Esin, Zoo", } ``` RESPONSE MESSAGE: ``` HEADER: {"status": 200} BODY: { "Message" => "Emoji Updated Successfully" } ``` - Delete an emojis REQUEST: ``` DELETE https://emojinaija.herokuapp.com/emojis/9 HEADER: { "Content-Type": "application/json", "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJpc3" } ``` RESPONSE MESSAGE: ``` HEADER: {"status": 200} BODY: { "Message" => "Emoji Deleted" } ``` Testing ------- [](#testing) ``` $ vendor/bin/phpunit test ``` Contributing ------------ [](#contributing) To contribute and extend the scope of this package, Please check out [CONTRIBUTING](CONTRIBUTING.md) file for detailed contribution guidelines. Credits ------- [](#credits) Emojinaija is created and maintained by `Ibraheem ADENIYI`. ### Health Score 20 — LowBetter than 14% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community7 Small or concentrated contributor base Maturity43 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/4028d0b1999062969f9d9784052f850751f879e3a8d5adcfe0e7933025db6612?d=identicon)[andela-iadeniyi](/maintainers/andela-iadeniyi) --- Top Contributors [![ibonly](https://avatars.githubusercontent.com/u/7251019?v=4)](https://github.com/ibonly "ibonly (43 commits)") ### Embed Badge ![Health badge](/badges/ibonly-naija-emoji/health.svg) ``` [![Health](https://phpackages.com/badges/ibonly-naija-emoji/health.svg)](https://phpackages.com/packages/ibonly-naija-emoji) ``` ### Alternatives [daijie/aria2 talk with aria2 726.8k](/packages/daijie-aria2) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)