Recommend this page to a friend! |
Download |
Info | Documentation | Files | Install with Composer | Download | Reputation | Support forum | Blog | Links |
Ratings | Unique User Downloads | Download Rankings | ||||
Not yet rated by the users | Total: 55 | All time: 10,592 This week: 455 |
Version | License | PHP version | Categories | |||
ajudaime-api 1.0.0 | GNU General Publi... | 7.4 | PHP 5, Web services, Geography |
Description | Author | |||||||||||||||||||||||
This package provides an API to find people close to the user who needs help. Innovation Award |
|
A simple API to control donations to people who need.
This API use elasticsearch using that ` https: // github.com / phzao / Ajudaime-db
`
Ps. This API was made on 2 days and is there is no unit tests for routes yet.
You must have installed Git, Docker, Docker-compose and Make before proceeding.
These ports must be available: - 8888 (api)
After cloning the repository you must run:
make up
The whole process can take a while, it depends on your computer.
After finish, just access the url, to register a user and start using:
`` http://localhost:8888/google-authenticate ``
Note.: This installation must be done only once.
Open Routes
GET - http://localhost:8888/public/donations/{user_id}/user -> Show donations by user.
GET - http://localhost:8888/public/donations/{status}/status -> Show donations by status.
GET - http://localhost:8888/public/needs/{user_id}/user -> Show needs by user.
GET - http://localhost:8888/public/needs -> List all needs not canceled.
Private Routes
POST - http://localhost:8888/api/v1/needs
PUT - http://localhost:8888/api/v1/needs/{uuid}
DELETE - http://localhost:8888/api/v1/needs/{uuid}
GET - http://localhost:8888/api/v1/needs/{uuid} -> show details
PUT - http://localhost:8888/api/v1/donations/{uuid}/done -> did by a helper
PUT - http://localhost:8888/api/v1/donations/{uuid}/cancel -> did by a helper
PUT - http://localhost:8888/api/v1/donations/{uuid}/confirm -> did by who needs help
POST - http://localhost:8888/api/v1/donations
POST - http://localhost:8888/api/v1/talks/{donation_id}
PUT - http://localhost:8888/api/v1/users
Files (151) |
File | Role | Description | ||
---|---|---|---|---|
bin (2 files) | ||||
config (4 files, 2 directories) | ||||
phpdocker (2 directories) | ||||
public (1 file) | ||||
src (1 file, 11 directories) | ||||
templates (1 file) | ||||
tests (2 files, 4 directories) | ||||
.env.dist | Data | Auxiliary data | ||
.env.test | Data | Auxiliary data | ||
.stack-symfony.yaml | Data | Auxiliary data | ||
.stack.yaml | Data | Auxiliary data | ||
composer.json | Data | Auxiliary data | ||
composer.lock | Data | Auxiliary data | ||
docker-compose.yml | Data | Auxiliary data | ||
index.php | Aux. | Auxiliary script | ||
Makefile | Data | Auxiliary data | ||
package-lock.json | Data | Auxiliary data | ||
phpunit.sh | Data | Auxiliary data | ||
phpunit.xml.dist | Data | Auxiliary data | ||
README.md | Doc. | Documentation | ||
serverless.yml | Data | Auxiliary data | ||
template.yml | Data | Auxiliary data |
Files (151) | / | config |
File | Role | Description | ||
---|---|---|---|---|
packages (11 files, 2 directories) | ||||
routes (1 file, 1 directory) | ||||
bootstrap.php | Class | Class source | ||
bundles.php | Class | Class source | ||
routes.yaml | Data | Auxiliary data | ||
services.yaml | Data | Auxiliary data |
Files (151) | / | config | / | packages |
File | Role | Description | ||
---|---|---|---|---|
prod (2 files) | ||||
test (3 files) | ||||
cache.yaml | Data | Auxiliary data | ||
doctrine.yaml | Data | Auxiliary data | ||
doctrine_migrations.yaml | Data | Auxiliary data | ||
framework.yaml | Data | Auxiliary data | ||
knpu_oauth2_client.yaml | Data | Auxiliary data | ||
nelmio_cors.yaml | Data | Auxiliary data | ||
ramsey_uuid_doctrine.yaml | Data | Auxiliary data | ||
routing.yaml | Data | Auxiliary data | ||
security.yaml | Data | Auxiliary data | ||
sensio_framework_extra.yaml | Data | Auxiliary data | ||
validator.yaml | Data | Auxiliary data |
Files (151) | / | config | / | packages | / | prod |
File | Role | Description |
---|---|---|
doctrine.yaml | Data | Auxiliary data |
routing.yaml | Data | Auxiliary data |
Files (151) | / | config | / | packages | / | test |
File | Role | Description |
---|---|---|
dama_doctrine_test_bundle.yaml | Data | Auxiliary data |
framework.yaml | Data | Auxiliary data |
validator.yaml | Data | Auxiliary data |
Files (151) | / | config | / | routes |
File | Role | Description | ||
---|---|---|---|---|
dev (1 file) | ||||
annotations.yaml | Data | Auxiliary data |
Files (151) | / | phpdocker | / | nginx |
File | Role | Description |
---|---|---|
Dockerfile | Data | Auxiliary data |
nginx.conf | Data | Auxiliary data |
Files (151) | / | phpdocker | / | php-fpm |
File | Role | Description |
---|---|---|
Dockerfile | Data | Auxiliary data |
php-ini-overrides.ini | Data | Auxiliary data |
Files (151) | / | src |
File | Role | Description | ||
---|---|---|---|---|
Controller (7 files) | ||||
DataFixtures (2 files) | ||||
Entity (6 files, 2 directories) | ||||
EventListener (1 file) | ||||
EventSubscriber (1 file) | ||||
Migrations (6 files) | ||||
Repository (1 file, 2 directories) | ||||
Security (3 files) | ||||
Services (5 directories) | ||||
Utils (5 directories) | ||||
Validator (1 directory) | ||||
Kernel.php | Class | Class source |
Files (151) | / | src | / | Controller |
File | Role | Description |
---|---|---|
APIController.php | Class | Class source |
DonationController.php | Class | Class source |
GoogleController.php | Class | Class source |
NeedController.php | Class | Class source |
RegisterController.php | Class | Class source |
TalkController.php | Class | Class source |
UserController.php | Class | Class source |
Files (151) | / | src | / | DataFixtures |
File | Role | Description |
---|---|---|
AppFixtures.php | Class | Class source |
UserFixture.php | Class | Class source |
Files (151) | / | src | / | Entity |
File | Role | Description | ||
---|---|---|---|---|
Interfaces (7 files) | ||||
Traits (1 file) | ||||
ApiToken.php | Class | Class source | ||
Donation.php | Class | Class source | ||
ModelBase.php | Class | Class source | ||
Need.php | Class | Class source | ||
Talks.php | Class | Class source | ||
User.php | Class | Class source |
Files (151) | / | src | / | Entity | / | Interfaces |
File | Role | Description |
---|---|---|
ApiTokenInterface.php | Class | Class source |
DonationInterface.php | Class | Class source |
ModelInterface.php | Class | Class source |
NeedInterface.php | Class | Class source |
SimpleTimeInterface.php | Class | Class source |
TalkInterface.php | Class | Class source |
UsuarioInterface.php | Class | Class source |
Files (151) | / | src | / | EventSubscriber |
File | Role | Description |
---|---|---|
BeforeActionSubscriber.php | Class | Class source |
Files (151) | / | src | / | Migrations |
File | Role | Description |
---|---|---|
Version20191109133802.php | Class | Class source |
Version20191209133...uid_by_postgres.php | Class | Class source |
Version20191222142...pi_tokens_table.php | Class | Class source |
Version20191222212...ted_at_to_users.php | Class | Class source |
Version20191222213...eleted_at_users.php | Class | Class source |
Version20191225130...column_to_users.php | Class | Class source |
Files (151) | / | src | / | Repository |
File | Role | Description | ||
---|---|---|---|---|
ElasticSearch (2 files) | ||||
Interfaces (8 files) | ||||
BaseRepository.php | Class | Class source |
Files (151) | / | src | / | Repository | / | ElasticSearch |
File | Role | Description |
---|---|---|
ElasticSearchRepository.php | Class | Class source |
ElasticSearchRepositoryInterface.php | Class | Class source |
Files (151) | / | src | / | Repository | / | Interfaces |
File | Role | Description |
---|---|---|
ApiTokenRepositoryInterface.php | Class | Class source |
BaseRepositoryInterface.php | Class | Class source |
CategoryRepositoryInterface.php | Class | Class source |
CreditCardRepositoryInterface.php | Class | Class source |
EarnRepositoryInterface.php | Class | Class source |
ExpenseRepositoryInterface.php | Class | Class source |
PlaceRepositoryInterface.php | Class | Class source |
UserRepositoryInterface.php | Class | Class source |
Files (151) | / | src | / | Security |
File | Role | Description |
---|---|---|
GoogleAuthenticator.php | Class | Class source |
TokenAuthenticator.php | Class | Class source |
UserProvider.php | Class | Class source |
Files (151) | / | src | / | Services |
File | Role | Description | ||
---|---|---|---|---|
Entity (5 files, 1 directory) | ||||
External (2 directories) | ||||
Log (1 file, 1 directory) | ||||
Login (2 files) | ||||
Validation (2 files) |
Files (151) | / | src | / | Services | / | Entity |
File | Role | Description | ||
---|---|---|---|---|
Interfaces (5 files) | ||||
ApiTokenService.php | Class | Class source | ||
DonationService.php | Class | Class source | ||
NeedService.php | Class | Class source | ||
TalkService.php | Class | Class source | ||
UserService.php | Class | Class source |
Files (151) | / | src | / | Services | / | Entity | / | Interfaces |
File | Role | Description |
---|---|---|
ApiTokenServiceInterface.php | Class | Class source |
DonationServiceInterface.php | Class | Class source |
NeedServiceInterface.php | Class | Class source |
TalkServiceInterface.php | Class | Class source |
UserServiceInterface.php | Class | Class source |
Files (151) | / | src | / | Services | / | External | / |
File | Role | Description |
---|---|---|
GoogleAuthenticateService.php | Class | Class source |
GoogleCheckServiceInterface.php | Class | Class source |
Files (151) | / | src | / | Services | / | External | / | Slack |
File | Role | Description |
---|---|---|
SlackApproval.php | Class | Class source |
SlackService.php | Class | Class source |
SlackServiceInterface.php | Class | Class source |
SlackTemplateInterface.php | Class | Class source |
Files (151) | / | src | / | Services | / | Log |
File | Role | Description | ||
---|---|---|---|---|
Interfaces (1 file) | ||||
LoggerService.php | Class | Class source |
Files (151) | / | src | / | Services | / | Log | / | Interfaces |
File | Role | Description |
---|---|---|
LoggerServiceInterface.php | Class | Class source |
Files (151) | / | src | / | Services | / | Login |
File | Role | Description |
---|---|---|
LoginService.php | Class | Class source |
LoginServiceInterface.php | Class | Class source |
Files (151) | / | src | / | Services | / | Validation |
File | Role | Description |
---|---|---|
ValidateModelInterface.php | Class | Class source |
ValidationService.php | Class | Class source |
Files (151) | / | src | / | Utils |
File | Role | Description | ||
---|---|---|---|---|
Datetime (1 file, 1 directory) | ||||
ElasticSearch (2 files) | ||||
Enums (1 file) | ||||
Generators (4 files) | ||||
HandleErrors (1 file) |
Files (151) | / | src | / | Utils | / | Datetime |
File | Role | Description | ||
---|---|---|---|---|
Interfaces (1 file) | ||||
DatetimeCheckService.php | Class | Class source |
Files (151) | / | src | / | Utils | / | Datetime | / | Interfaces |
File | Role | Description |
---|---|---|
DatetimeCheckServiceInterface.php | Class | Class source |
Files (151) | / | src | / | Utils | / | ElasticSearch |
File | Role | Description |
---|---|---|
ElasticSearchQueries.php | Class | Class source |
ElasticSearchQueriesInterface.php | Class | Class source |
Files (151) | / | src | / | Utils | / | Generators |
File | Role | Description |
---|---|---|
Bin2HexGenerate.php | Class | Class source |
GenerateDataToSaveInterface.php | Class | Class source |
GenerateUserDemo.php | Class | Class source |
TokenGeneratorInterface.php | Class | Class source |
Files (151) | / | src | / | Validator | / | Constraints |
File | Role | Description |
---|---|---|
LatitudeNumber.php | Class | Class source |
LatitudeNumberValidator.php | Class | Class source |
LongitudeNumber.php | Class | Class source |
LongitudeNumberValidator.php | Class | Class source |
Files (151) | / | tests |
File | Role | Description | ||
---|---|---|---|---|
Controller (1 file) | ||||
Entity (1 file, 1 directory) | ||||
Services (3 directories) | ||||
Utils (4 directories) | ||||
bootstrap.php | Class | Class source | ||
CleanElasticSearch.php | Class | Class source |
Files (151) | / | tests | / | Controller |
File | Role | Description |
---|---|---|
RegisterControllerTest.php | Class | Class source |
Files (151) | / | tests | / | Services |
File | Role | Description | ||
---|---|---|---|---|
Entity (10 files) | ||||
Login (2 files) | ||||
Validation (2 files) |
Files (151) | / | tests | / | Services | / | Entity |
File | Role | Description |
---|---|---|
CategoryServiceTest.php | Class | Class source |
CreditCardServiceTest.php | Class | Class source |
EarnServiceTest.php | Class | Class source |
LoadCategoryService.php | Class | Class source |
LoadCreditCardService.php | Class | Class source |
LoadEarnService.php | Class | Class source |
LoadPlaceService.php | Class | Class source |
LoadUserService.php | Class | Class source |
PlaceServiceTest.php | Class | Class source |
UserServiceTest.php | Class | Class source |
Files (151) | / | tests | / | Services | / | Login |
File | Role | Description |
---|---|---|
LoadLoginService.php | Class | Class source |
LoginServiceTest.php | Class | Class source |
Files (151) | / | tests | / | Services | / | Validation |
File | Role | Description |
---|---|---|
LoadValidationService.php | Class | Class source |
ValidationServiceTest.php | Class | Class source |
Files (151) | / | tests | / | Utils |
File | Role | Description | ||
---|---|---|---|---|
Datetime (1 file) | ||||
Enums (1 file) | ||||
Generators (2 files) | ||||
HandleErrors (1 file) |
Files (151) | / | tests | / | Utils | / | Datetime |
File | Role | Description |
---|---|---|
DatetimeCheckServiceTest.php | Class | Class source |
Files (151) | / | tests | / | Utils | / | Generators |
File | Role | Description |
---|---|---|
Bin2HexGenerateTest.php | Class | Class source |
GenerateUserDemoTest.php | Class | Class source |
Files (151) | / | tests | / | Utils | / | HandleErrors |
File | Role | Description |
---|---|---|
ErrorMessageTest.php | Class | Class source |
The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page. |
Install with Composer |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.