mibfb-collab / message_in_a_bottle_backend Goto Github PK

Need to add the following columns to table:

• title (CharField)
• location (CharField)

README Examples

• The quickstart app name will be problematic for our endpoints, based on how Django builds routes. This needs to be renamed to api before we accrue any more technical debt
• The Static Files directory that was auto-created floods the app with a bunch of additional JavaScript and CSS files that are not needed for the REST framework. We should remove these to slim down the infrastructure to what is actually needed for our purposes.

• Overall
• Setup instructions
• Collaborators
• Tools used
• Deployed page
• Technologies used
• How to use
• Endpoints
• Sample requests/responses
• Special Thanks
• Learning goals
• Schema

README Examples

• Create starter test collection for currently deployed endpoints
• Create environment variable JSON files to dynamically toggle between dev vs prod during testing

Note, this will be an ongoing exercise as we add additional endpoints.

Final Cleanup Checklist:

• Change radius back to 25 in MapService module:

  # services.py
  
      def get_stories(lat, long, stories):
          url = MapService.base_urls()['radius']
          params = {
              'key': MapService.api_key()
          }
          data = {
              'origin': {
                  'latLng': {
                      'lat': float(lat),
                      'lng': float(long)
                  }
              },
              'options': {
                  'maxMatches': 100,
                  'radius': 50,
                  'units': 'm'
              },
              'remoteDataList': stories
          }
          response = requests.post(url, params=params, data=json.dumps(data, indent=1))
          return response.json()

• Clean up CORS_ALLOWED_ORIGINS in settings.py

Return a dictionary of city/state as key with total stories as value, so users can search for stories by city/state

• error handling for no stories in that radius
• error handling for no lat & long provided
• error handling for invalid lat & long provided

• send user current location to mapquest and grab city,state that coordinates are within.
• Add city,state to input_location for stories serializer

Placeholder issue to track any final test cleanup for Postman collection:

• Correct env vars for Dev
• Correct env vars for Prod
• 100% passing suite with multiple runner iterations in both environments

Endpoint to create new story in database

• Deploy to Heroku
• Configure CircleCI Builds
• Configure CircleCI Automated Deploy:
  • Add Marla's API key to Circle ENV VARS
  • Change Heroku App Name and update Circle ENV VAR
  • Update local git remotes per new App Name

• refactor and connect code to appropriately call methods in views and facades as needed for mapquest endpoints.

• Hit mapquest endpoint for distance in miles from user current location to story lat & long
• extract distance in miles from response

Refactor existing JSON responses to conform to JSON 1.0 Spec

Originally posted by @matt-kragen in #22 (comment)

• GET /stories/<id:pk>
  • should have a type key and attributes dict to nest individual table columns
• POST /stories
  • should have a type key and attributes dict to nest individual table columns

Set up config.yml to enter virtual environment to run pytest on Circle CI

Passing in valid lat/lon can still result in an 'Impossible Route'. Need to error handle for this in view.

Endpoint to update a story within the database

Note: current placeholder is a PUT request (from following original tutorial), which will require a couple refactors:

• Update CORS_ALLOWED_METHODS in settings.py
• Update APIView method call in views.py to be a PATCH (vs PUT)

Add and populate initial configuration files

Justin has pulled down main and is able to view all stories that have been added in the last few days, regardless of the mileage from his house. My main (which references the same endpoint) is no longer able to view any of these stories. I am able to post and view my own stories still, but do not have access to any Justin posts. Justin's main does not have access to any stories I post.

Request:

Response:
{"data":{"input_location":"This is a temporary location!","stories":[{"id":"91","type":"story","attributes":{"title":"This is a test","distance_in_miles":0,"latitude":40.337408,"longitude":-104.9460736}}]}}

The response is copy and pasted since the view screenshot on my dev tools cut half of it off. The response is only the story I posted while experimenting with this issue.

README Examples

Endpoint to get directions to an individual Story.

• Create 'test' endpoint GET /api/v1/test with a very basic response for testing CORS
• Ensure allowed HTTP request methods permit fetch calls from FE are properly configured.

Resource

• Create a model validation:
  • -90 <= latitude <= 90
  • -180 <= longitude <= 180
  • must validate latitude and longitude fall within those ranges before saving to database or will break calls to Mapquest API
• Reseed DB to remove invalid data

Configure application to deploy passing builds via Travis CI || Circle CI

Half of the functions in StorySerializer pass self, and half don't. As a team, we should comb back through in our final refactoring to ensure consistency one way or the other.

Note, pycodestyle may help make the call on this for convention.. but based on my research, it's the most Pythonic way to always pass self as the first arg to any function

See Python docs:

Often, the first argument of a method is called self. This is nothing more than a convention: the name self has absolutely no special meaning to Python. Note, however, that by not following the convention your code may be less readable to other Python programmers, and it is also conceivable that a class browser program might be written that relies upon such a convention.

Walk through architecture from the ground up

Looks like a VCR equivalent exists.. need to investigate how this can integrate into our current test suite, to stub the remaining external API calls.

• Add API key to .env
• Add API key as ENV VAR to CircleCI
• Add API key as CONFIG VAR to Heroku
• Add requests package to requirements.txt
• Hit radius search endpoint
• Test response values

Best practice would be to stub these out, if we can.

Starting with test_services module, and will refactor test_requests module similarly, if enough time prior to code freeze.

Endpoint to delete a story

• error handling for edge case: /api/v1/stories?latitude=&longitude=

• Set database character limit for message to 1,000
• Add timestamps to model and serializer

• GET /api/v1/stories/<int:pk>
• POST /api/v1/stories
• DELETE /api/v1/stores/<int:pk>

Currently using Postman to test our middleware, but we need to backfill request tests in pytest, so we can run the full suite inclusive of model and request specs.

Might be able to leverage the built in APIRequestFactory module from DRF

Additional resource

Endpoint for all stories within database by input coordinates (user's lat/long from current location)

Endpoint to retrieve an individual story

• Badges:

  • Update top level badges to reference the correct repo
  • Add Circle build badge

• How to / Project Configs:

  • Ensure all references to Rails projects are removed
  • Ensure all steps taken to set up and configure project are clearly listed (reference BE Python Docs thread from Slack)

• JSON contracts:

  • Double check request / response, query params, etc.
  • Add edge cases / sad paths

• Database Schema:

  • Update screenshot

  [example link]()

  See LucidChart for schema diagram

• Create service method
• Add model method to find applicable story in database
• Hit directions endpoint
• Test response values