PHP Classes

Ajudaime API: Find people close to the user who needs help

Recommend this page to a friend!
  Info   View files Documentation   View files View files (151)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2020-04-05 (2 months ago) RSS 2.0 feedNot yet rated by the usersTotal: 44 This week: 1All time: 9,815 This week: 273Up
Version License PHP version Categories
ajudaime-api 1.0GNU General Publi...7.4PHP 5, Web services, Geography
Description Author

This package provides an API to find people close to the user who needs help.

The API can record needs of users with details like their location, as well list, update and remove those needs from the database on which those needs are recorded.

It can also manage donations by other users that address those needs.

Innovation Award
PHP Programming Innovation award nominee
April 2020
Number 5
Many people need help sometimes to solve urgent problems, so they need to let other people that can solve those problems know how they can be contacted to provide a solution.

This package provides an API to find close people that can find a solution. This allows to implement Web or mobile applications that can connect people with problems with people that can provide solutions.

Manuel Lemos
Name: Paulo Henrique is available for providing paid consulting. Contact Paulo Henrique .
Classes: 4 packages by
Country: Brazil Brazil
Age: 36
All time rank: 4031332 in Brazil Brazil
Week rank: 73 Up3 in Brazil Brazil Up
Innovation award
Innovation award
Nominee: 3x

Details

API Be The Hero

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.

Requirements

You must have installed Git, Docker, Docker-compose and Make before proceeding.

These ports must be available: - 8888 (api)

Installing

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.

Routes

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 folder image Files  
File Role Description
Files folder imagebin (2 files)
Files folder imageconfig (4 files, 2 directories)
Files folder imagephpdocker (2 directories)
Files folder imagepublic (1 file)
Files folder imagesrc (1 file, 11 directories)
Files folder imagetemplates (1 file)
Files folder imagetests (2 files, 4 directories)
Accessible without login Plain text file .env.dist Data Auxiliary data
Accessible without login Plain text file .env.test Data Auxiliary data
Accessible without login Plain text file .stack-symfony.yaml Data Auxiliary data
Accessible without login Plain text file .stack.yaml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file docker-compose.yml Data Auxiliary data
Accessible without login Plain text file index.php Aux. Auxiliary script
Accessible without login Plain text file Makefile Data Auxiliary data
Accessible without login Plain text file package-lock.json Data Auxiliary data
Accessible without login Plain text file phpunit.sh Data Auxiliary data
Accessible without login Plain text file phpunit.xml.dist Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Plain text file serverless.yml Data Auxiliary data
Accessible without login Plain text file template.yml Data Auxiliary data

  Files folder image Files  /  bin  
File Role Description
  Plain text file console Class Class source
  Accessible without login Plain text file phpunit Data Auxiliary data

  Files folder image Files  /  config  
File Role Description
Files folder imagepackages (11 files, 2 directories)
Files folder imageroutes (1 file, 1 directory)
  Plain text file bootstrap.php Class Class source
  Plain text file bundles.php Class Class source
  Accessible without login Plain text file routes.yaml Data Auxiliary data
  Accessible without login Plain text file services.yaml Data Auxiliary data

  Files folder image Files  /  config  /  packages  
File Role Description
Files folder imageprod (2 files)
Files folder imagetest (3 files)
  Accessible without login Plain text file cache.yaml Data Auxiliary data
  Accessible without login Plain text file doctrine.yaml Data Auxiliary data
  Accessible without login Plain text file doctrine_migrations.yaml Data Auxiliary data
  Accessible without login Plain text file framework.yaml Data Auxiliary data
  Accessible without login Plain text file knpu_oauth2_client.yaml Data Auxiliary data
  Accessible without login Plain text file nelmio_cors.yaml Data Auxiliary data
  Accessible without login Plain text file ramsey_uuid_doctrine.yaml Data Auxiliary data
  Accessible without login Plain text file routing.yaml Data Auxiliary data
  Accessible without login Plain text file security.yaml Data Auxiliary data
  Accessible without login Plain text file sensio_framework_extra.yaml Data Auxiliary data
  Accessible without login Plain text file validator.yaml Data Auxiliary data

  Files folder image Files  /  config  /  packages  /  prod  
File Role Description
  Accessible without login Plain text file doctrine.yaml Data Auxiliary data
  Accessible without login Plain text file routing.yaml Data Auxiliary data

  Files folder image Files  /  config  /  packages  /  test  
File Role Description
  Accessible without login Plain text file dama_doctrine_test_bundle.yaml Data Auxiliary data
  Accessible without login Plain text file framework.yaml Data Auxiliary data
  Accessible without login Plain text file validator.yaml Data Auxiliary data

  Files folder image Files  /  config  /  routes  
File Role Description
Files folder imagedev (1 file)
  Accessible without login Plain text file annotations.yaml Data Auxiliary data

  Files folder image Files  /  config  /  routes  /  dev  
File Role Description
  Accessible without login Plain text file framework.yaml Data Auxiliary data

  Files folder image Files  /  phpdocker  
File Role Description
Files folder imagenginx (2 files)
Files folder imagephp-fpm (2 files)

  Files folder image Files  /  phpdocker  /  nginx  
File Role Description
  Accessible without login Plain text file Dockerfile Data Auxiliary data
  Accessible without login Plain text file nginx.conf Data Auxiliary data

  Files folder image Files  /  phpdocker  /  php-fpm  
File Role Description
  Accessible without login Plain text file Dockerfile Data Auxiliary data
  Accessible without login Plain text file php-ini-overrides.ini Data Auxiliary data

  Files folder image Files  /  public  
File Role Description
  Accessible without login Plain text file index.php Example Example script

  Files folder image Files  /  src  
File Role Description
Files folder imageController (7 files)
Files folder imageDataFixtures (2 files)
Files folder imageEntity (6 files, 2 directories)
Files folder imageEventListener (1 file)
Files folder imageEventSubscriber (1 file)
Files folder imageMigrations (6 files)
Files folder imageRepository (1 file, 2 directories)
Files folder imageSecurity (3 files)
Files folder imageServices (5 directories)
Files folder imageUtils (5 directories)
Files folder imageValidator (1 directory)
  Plain text file Kernel.php Class Class source

  Files folder image Files  /  src  /  Controller  
File Role Description
  Plain text file APIController.php Class Class source
  Plain text file DonationController.php Class Class source
  Plain text file GoogleController.php Class Class source
  Plain text file NeedController.php Class Class source
  Plain text file RegisterController.php Class Class source
  Plain text file TalkController.php Class Class source
  Plain text file UserController.php Class Class source

  Files folder image Files  /  src  /  DataFixtures  
File Role Description
  Plain text file AppFixtures.php Class Class source
  Plain text file UserFixture.php Class Class source

  Files folder image Files  /  src  /  Entity  
File Role Description
Files folder imageInterfaces (7 files)
Files folder imageTraits (1 file)
  Plain text file ApiToken.php Class Class source
  Plain text file Donation.php Class Class source
  Plain text file ModelBase.php Class Class source
  Plain text file Need.php Class Class source
  Plain text file Talks.php Class Class source
  Plain text file User.php Class Class source

  Files folder image Files  /  src  /  Entity  /  Interfaces  
File Role Description
  Plain text file ApiTokenInterface.php Class Class source
  Plain text file DonationInterface.php Class Class source
  Plain text file ModelInterface.php Class Class source
  Plain text file NeedInterface.php Class Class source
  Plain text file SimpleTimeInterface.php Class Class source
  Plain text file TalkInterface.php Class Class source
  Plain text file UsuarioInterface.php Class Class source

  Files folder image Files  /  src  /  Entity  /  Traits  
File Role Description
  Plain text file SimpleTime.php Class Class source

  Files folder image Files  /  src  /  EventListener  
File Role Description
  Plain text file ExceptionListener.php Class Class source

  Files folder image Files  /  src  /  EventSubscriber  
File Role Description
  Plain text file BeforeActionSubscriber.php Class Class source

  Files folder image Files  /  src  /  Migrations  
File Role Description
  Plain text file Version20191109133802.php Class Class source
  Plain text file Version20191209133...uid_by_postgres.php Class Class source
  Plain text file Version20191222142...pi_tokens_table.php Class Class source
  Plain text file Version20191222212...ted_at_to_users.php Class Class source
  Plain text file Version20191222213...eleted_at_users.php Class Class source
  Plain text file Version20191225130...column_to_users.php Class Class source

  Files folder image Files  /  src  /  Repository  
File Role Description
Files folder imageElasticSearch (2 files)
Files folder imageInterfaces (8 files)
  Plain text file BaseRepository.php Class Class source

  Files folder image Files  /  src  /  Repository  /  ElasticSearch  
File Role Description
  Plain text file ElasticSearchRepository.php Class Class source
  Plain text file ElasticSearchRepositoryInterface.php Class Class source

  Files folder image Files  /  src  /  Repository  /  Interfaces  
File Role Description
  Plain text file ApiTokenRepositoryInterface.php Class Class source
  Plain text file BaseRepositoryInterface.php Class Class source
  Plain text file CategoryRepositoryInterface.php Class Class source
  Plain text file CreditCardRepositoryInterface.php Class Class source
  Plain text file EarnRepositoryInterface.php Class Class source
  Plain text file ExpenseRepositoryInterface.php Class Class source
  Plain text file PlaceRepositoryInterface.php Class Class source
  Plain text file UserRepositoryInterface.php Class Class source

  Files folder image Files  /  src  /  Security  
File Role Description
  Plain text file GoogleAuthenticator.php Class Class source
  Plain text file TokenAuthenticator.php Class Class source
  Plain text file UserProvider.php Class Class source

  Files folder image Files  /  src  /  Services  
File Role Description
Files folder imageEntity (5 files, 1 directory)
Files folder imageExternal (2 directories)
Files folder imageLog (1 file, 1 directory)
Files folder imageLogin (2 files)
Files folder imageValidation (2 files)

  Files folder image Files  /  src  /  Services  /  Entity  
File Role Description
Files folder imageInterfaces (5 files)
  Plain text file ApiTokenService.php Class Class source
  Plain text file DonationService.php Class Class source
  Plain text file NeedService.php Class Class source
  Plain text file TalkService.php Class Class source
  Plain text file UserService.php Class Class source

  Files folder image Files  /  src  /  Services  /  Entity  /  Interfaces  
File Role Description
  Plain text file ApiTokenServiceInterface.php Class Class source
  Plain text file DonationServiceInterface.php Class Class source
  Plain text file NeedServiceInterface.php Class Class source
  Plain text file TalkServiceInterface.php Class Class source
  Plain text file UserServiceInterface.php Class Class source

  Files folder image Files  /  src  /  Services  /  External  
File Role Description
Files folder imageGoogle (2 files)
Files folder imageSlack (4 files)

  Files folder image Files  /  src  /  Services  /  External  /  Google  
File Role Description
  Plain text file GoogleAuthenticateService.php Class Class source
  Plain text file GoogleCheckServiceInterface.php Class Class source

  Files folder image Files  /  src  /  Services  /  External  /  Slack  
File Role Description
  Plain text file SlackApproval.php Class Class source
  Plain text file SlackService.php Class Class source
  Plain text file SlackServiceInterface.php Class Class source
  Plain text file SlackTemplateInterface.php Class Class source

  Files folder image Files  /  src  /  Services  /  Log  
File Role Description
Files folder imageInterfaces (1 file)
  Plain text file LoggerService.php Class Class source

  Files folder image Files  /  src  /  Services  /  Log  /  Interfaces  
File Role Description
  Plain text file LoggerServiceInterface.php Class Class source

  Files folder image Files  /  src  /  Services  /  Login  
File Role Description
  Plain text file LoginService.php Class Class source
  Plain text file LoginServiceInterface.php Class Class source

  Files folder image Files  /  src  /  Services  /  Validation  
File Role Description
  Plain text file ValidateModelInterface.php Class Class source
  Plain text file ValidationService.php Class Class source

  Files folder image Files  /  src  /  Utils  
File Role Description
Files folder imageDatetime (1 file, 1 directory)
Files folder imageElasticSearch (2 files)
Files folder imageEnums (1 file)
Files folder imageGenerators (4 files)
Files folder imageHandleErrors (1 file)

  Files folder image Files  /  src  /  Utils  /  Datetime  
File Role Description
Files folder imageInterfaces (1 file)
  Plain text file DatetimeCheckService.php Class Class source

  Files folder image Files  /  src  /  Utils  /  Datetime  /  Interfaces  
File Role Description
  Plain text file DatetimeCheckServiceInterface.php Class Class source

  Files folder image Files  /  src  /  Utils  /  ElasticSearch  
File Role Description
  Plain text file ElasticSearchQueries.php Class Class source
  Plain text file ElasticSearchQueriesInterface.php Class Class source

  Files folder image Files  /  src  /  Utils  /  Enums  
File Role Description
  Plain text file GeneralTypes.php Class Class source

  Files folder image Files  /  src  /  Utils  /  Generators  
File Role Description
  Plain text file Bin2HexGenerate.php Class Class source
  Plain text file GenerateDataToSaveInterface.php Class Class source
  Plain text file GenerateUserDemo.php Class Class source
  Plain text file TokenGeneratorInterface.php Class Class source

  Files folder image Files  /  src  /  Utils  /  HandleErrors  
File Role Description
  Plain text file ErrorMessage.php Class Class source

  Files folder image Files  /  src  /  Validator  
File Role Description
Files folder imageConstraints (4 files)

  Files folder image Files  /  src  /  Validator  /  Constraints  
File Role Description
  Plain text file LatitudeNumber.php Class Class source
  Plain text file LatitudeNumberValidator.php Class Class source
  Plain text file LongitudeNumber.php Class Class source
  Plain text file LongitudeNumberValidator.php Class Class source

  Files folder image Files  /  templates  
File Role Description
  Accessible without login Plain text file base.html.twig Data Auxiliary data

  Files folder image Files  /  tests  
File Role Description
Files folder imageController (1 file)
Files folder imageEntity (1 file, 1 directory)
Files folder imageServices (3 directories)
Files folder imageUtils (4 directories)
  Plain text file bootstrap.php Class Class source
  Plain text file CleanElasticSearch.php Class Class source

  Files folder image Files  /  tests  /  Controller  
File Role Description
  Plain text file RegisterControllerTest.php Class Class source

  Files folder image Files  /  tests  /  Entity  
File Role Description
Files folder imageTraits (1 file)
  Plain text file UserTest.php Class Class source

  Files folder image Files  /  tests  /  Entity  /  Traits  
File Role Description
  Plain text file SimpleTimeTest.php Class Class source

  Files folder image Files  /  tests  /  Services  
File Role Description
Files folder imageEntity (10 files)
Files folder imageLogin (2 files)
Files folder imageValidation (2 files)

  Files folder image Files  /  tests  /  Services  /  Entity  
File Role Description
  Plain text file CategoryServiceTest.php Class Class source
  Plain text file CreditCardServiceTest.php Class Class source
  Plain text file EarnServiceTest.php Class Class source
  Plain text file LoadCategoryService.php Class Class source
  Plain text file LoadCreditCardService.php Class Class source
  Plain text file LoadEarnService.php Class Class source
  Plain text file LoadPlaceService.php Class Class source
  Plain text file LoadUserService.php Class Class source
  Plain text file PlaceServiceTest.php Class Class source
  Plain text file UserServiceTest.php Class Class source

  Files folder image Files  /  tests  /  Services  /  Login  
File Role Description
  Plain text file LoadLoginService.php Class Class source
  Plain text file LoginServiceTest.php Class Class source

  Files folder image Files  /  tests  /  Services  /  Validation  
File Role Description
  Plain text file LoadValidationService.php Class Class source
  Plain text file ValidationServiceTest.php Class Class source

  Files folder image Files  /  tests  /  Utils  
File Role Description
Files folder imageDatetime (1 file)
Files folder imageEnums (1 file)
Files folder imageGenerators (2 files)
Files folder imageHandleErrors (1 file)

  Files folder image Files  /  tests  /  Utils  /  Datetime  
File Role Description
  Plain text file DatetimeCheckServiceTest.php Class Class source

  Files folder image Files  /  tests  /  Utils  /  Enums  
File Role Description
  Plain text file GeneralTypesTest.php Class Class source

  Files folder image Files  /  tests  /  Utils  /  Generators  
File Role Description
  Plain text file Bin2HexGenerateTest.php Class Class source
  Plain text file GenerateUserDemoTest.php Class Class source

  Files folder image Files  /  tests  /  Utils  /  HandleErrors  
File Role Description
  Plain text file ErrorMessageTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:44
This week:1
All time:9,815
This week:273Up

For more information send a message to info at phpclasses dot org.