How mofc-endhunger/freshtrak-registration-api works
Freshtrak Registration API exposes selected pre-registration data and account operations. The main workflow is an API client creating or managing a user, household, or reservation; reservation creation also checks event availability and can synchronize with PantryTrak. Facebook callbacks and guest authentication provide account entry points, while SMS and email routes expose communications endpoints. The graph keeps these product areas distinct. Some controller and integration implementations are unsampled, so links not established by the excerpts or README are omitted.
Main entry points: routes.rb HTTP Routes · auth_callbacks_controller.rb Facebook Callback · reservations_controller.rb Reservation API · twilio_controller.rb Communications Routes
Components 23
Registration API
- HTTP Routes
config/routes.rb - API Base
app/controllers/api/base_controller.rb - User API
app/controllers/api/users_controller.rb - Household API
app/controllers/api/households_controller.rb - Reservation API
app/controllers/api/reservations_controller.rb
Identity and Access
- Facebook Callback
app/controllers/auth_callbacks_controller.rb - Guest Authentication
app/controllers/guest_authentications_controller.rb - Authentication Records
app/models/authentication.rb - Auth Serializer
app/serializers/authentication_serializer.rb
Registration Data
- Reservation Creation
app/services/create_reservation.rb - Users
app/models/user.rb - Households
app/models/household.rb - Reservations
app/models/reservation.rb - MySQL Database
External Integrations
- Facebook Verification
app/lib/facebook_api.rb - Event Availability
app/lib/pantry_finder_api.rb - PantryTrak Client
app/lib/pantry_trak/client.rb - Communications Routes
app/controllers/twilio_controller.rb - SMS Sender
app/lib/twilio/sms.rb - Email Sender
app/lib/twilio/email.rb - PantryTrak Service
Other components
- API Client
Connections 21
- API Client → HTTP Routes: sends requests
config/routes.rb - HTTP Routes → Household API: routes to
config/routes.rb - HTTP Routes → Reservation API: routes to
config/routes.rb - HTTP Routes → User API: routes to
config/routes.rb - HTTP Routes → Facebook Callback: routes to
config/routes.rb - HTTP Routes → Guest Authentication: routes to
config/routes.rb - HTTP Routes → Communications Routes: routes to
config/routes.rb - Household API → Households: creates and updates
app/controllers/api/households_controller.rb - Facebook Callback → Facebook Verification: verifies token
app/controllers/auth_callbacks_controller.rb - Facebook Callback → Authentication Records: creates or finds
app/controllers/auth_callbacks_controller.rb - Facebook Callback → Auth Serializer: serializes response
app/controllers/auth_callbacks_controller.rb - Facebook → Facebook Callback: submits callback
- Households → MySQL Database: persists
- Reservations → MySQL Database: persists
- Users → MySQL Database: persists
- Reservation API → Reservation Creation: creates reservation
- Reservation Creation → Event Availability: checks availability
- Reservation API → PantryTrak Client: synchronizes
- PantryTrak Client → PantryTrak Service: sends requests
- Communications Routes → SMS Sender: dispatches SMS
- Communications Routes → Email Sender: dispatches email