GithubHelp home page GithubHelp logo

rebelweb / mapping_service Goto Github PK

View Code? Open in Web Editor NEW
0.0 0.0 0.0 2.29 MB

A small Grape API to handle geocoding calls for multiple providers

License: MIT License

Ruby 93.22% Dockerfile 0.18% CSS 0.32% HTML 5.48% JavaScript 0.81%

mapping_service's People

Contributors

rebelweb avatar

Watchers

 avatar

mapping_service's Issues

Add Rack Attack

Implement the Rack Attack gem to allow for overall rate limiting of requests. This should be configurable using environment variables and the environment variables should be documented in the README.

Geocode Responses - Cache Management

The application uses a mongo to cache and reserve responses when duplicate queries are made to the service. We need a way to manage these cached responses. This includes bulk removal, single response removal, searching, etc. We should include endpoints protected by Admin API Keys as well as rake tasks to perform these actions.

Create API Key Model

An API Key is needed to control access and limit the number of requests per user

  • Create Mongo backed model with fields for general and admin permissions
  • Create Endpoints to manage API Keys
  • Create Rake Task to create the initial admin key

Add Authentication to API Endpoints

Implement authentication for all API endpoints, using checking of an API Key.

  • Create an Authentication Mechanism
  • Allow to be disabled/enabled by Environment variable
  • Document new Environment Variable in README

Update README

The README needs update with new options and information about related services (mongo & redis). The formatting for options needs to be improved as well as the number of options continues to grow.

Gracefully Handle Errors from Providers (i.e. Here, Google)

The API should handle limits from a provider without causing errors. We need to build in error handling when getting bad info from the provider, so the user gets a response from a different provider or gets a friendly error message. Common Errors could be service unavailable or rate limited.

Create Puma Config File

A puma config is needed to optimize the implementation for Grape. Create a puma config and include options for processes, threads, ports, etc. Be sure to update the docker file to use the new config file.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.