README

Back Country Buddy - RestAPI

About this Api

This API allows the user to query endpoints to create, update, retrieve and destroy information related to Users, Tours, and Plans.

Versions

• Ruby 2.5.3

• Rails 5.2.4.3

Table of Contents

1. About The Project
   • Built With
   • Schema
2. Getting Started
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgements

About The Application

Endpoints and example queries are listed below.

After logging in with AuthO all request must include Auth token in the header parameter authorization.

Users:

Example JSON response for the User resource:

{
    "data": {
        "id": "5",
        "type": "user",
        "attributes": {
            "user_name": "sampleuser",
            "email_address": "[email protected]",
            "emergency_contact_name": "My Momma",
            "emergency_number": "911"
        }
    }
}

• Create a user This endpoint can be used to create a user. The following attributes should be passed as query parameters. user_name, email_address, emergency_contact_name, emergency_number

POST /api/private/v1/user/

• Get one user

GET /api/private/v1/user/#{email_address}

• Update a user This endpoint can be used to update any of the user attributes. Attributes should be entered as query parameters

PATCH /api/private/v1/user/#{id}

• Delete a user This endpoint can be used to delete a user. The user is found by ID.

PATCH /api/private/v1/user/#{id}

Tours:

Example JSON response for the Tour resource:

{
    "data": {
        "id": "5",
        "type": "tour",
        "attributes": {
            "date": "2020-05-01",
            "location": "Mt. Ebert",
            "creator_id": 6,
            "complete": "false"
        }
    }
}

• Create a tour This endpoint can be used to create a tour. The following attributes should be passed as query parameters. date, location, creator_id, complete

POST /api/private/v1/user/:user_id/tour

• Get all tours associated with a user. The following attributes should be passed as query parameters.
• user_id

GET /api/private/v1/tour

• or you can use this without passing the query params

GET /api/private/v1/user/:user_id/tour

• Get one tour

GET /api/private/v1/tour/:id

• Update a tour This endpoint can be used to update any of the tour attributes. Attributes should be entered as query parameters

PATCH /api/private/v1/tour/:id

• Delete a tour This endpoint can be used to delete a tour. The user is found by ID.

PATCH /api/private/v1/tour/:id

Plans:

Example JSON response for the Plan resource:

{
    "data": {
        "id": "5",
        "type": "plan",
        "attributes": {
            "hazard_weather": "string",
            "hazard_avalanche": "string",
            "hazard_summary": "string",
            "route_preview": "string",
            "route_avalanche": "string",
            "emergency_plan": "string",
            "debrief_conditions": "string",
            "debrief_decisions": "string",
            "debrief_plan": "string"
        }
    }
}

• Create a plan This endpoint can be used to create a plan. The following attributes should be passed as query parameters. :hazard_weather, :hazard_avalanche, :hazard_summary, :route_preview, :route_alternative, :emergency_plan, :debrief_conditions, :debrief_decisions, :debrief_plan

POST /api/private/v1/user/:user_id/tour/tour_id/plan

• Get one plan

GET /api/private/v1/plan/:id

• Update a plan This endpoint can be used to update any of the plan attributes. Attributes should be entered as query parameters

PATCH /api/private/v1/plan/:id

• Delete a plan This endpoint can be used to delete a plan. The user is found by ID.

PATCH /api/private/v1/plan/:id

TourUser:

Example JSON response for the TourUser resource:

{
    "data": {
        "id": "5",
        "type": "tour_user",
        "attributes": {
            "tour_id": "1",
            "user_id": "1"
        }
    }
}

• Create a tour_user This endpoint can be used to create a tour_user. The following attributes should be passed as query parameters. email_address, tour_id

POST /api/private/v1/tour_user

• Get all users associated with a tour. The following attributes should be passed as query parameters. user_id

GET /api/private/v1/tour_user

Built With

• Ruby on Rails
• RSpec
• JSONAPI
• CircleCI
• Heroku

Schema

See the open issues for a list of proposed features (and known issues).

Getting Started

Installation

2. Fork and Clone the repo

   git clone [https://github.com/Back-Country-Buddy/Rest-API/]
   

3. Install gems -- For list of Gems see here

   bundle install
   

4. Setup the database:

   Run rake db:{drop,create,migrate,seed} 
   

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/Back-Country-Buddy/Rest-API/

Acknowledgements

• Img Shields
• MIT Open Source License
• GitHub Pages