Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 1.48 KB

README.md

File metadata and controls

73 lines (54 loc) · 1.48 KB
Raw

Link Shortener API

README

The intention of this code is to create an API used to shorten URL's.

The API takes one or two arguments: the URL we want to shorten (required) and the slug (optional).

The API has the option to activate or desactivate the short url. At the moment of creation the short url is active, you call the update method to deactivate the url. (Take a look at the Give it a try! section).

Installation Instruction

  1. Make sure you have rails 6 installed:
rails -v
  • if not installed run: sudo gem install rails
  1. Run the following command to install required gems:
bundle install
  1. Run migrations to create table (I didnt include any seeds)
rails db:migrate
  1. Now you are ready to go! just start the rails web server:
rails s

Tests

The code uses the RSpec testing framework, to run the test use the following command:

rspec

Give it a try!

The API can be tested usingn the command line using the following curl requests:

CREATE

curl -d 'original_url=http://www.google.com&slug=myslug' http://localhost:3000/v1/links/

UPDATE:

curl -X PUT -d 'status=true' http://localhost:3000/v1/links/7

SHOW

curl http://localhost:3000/v1/links/8

INDEX

curl http://localhost:3000/v1/links/

DELETE

curl -X DELETE http://localhost:3000/v1/links/4

Future Enhancements:

  • Add Regular expression to validate URL.
  • Increment the number of test cases.
  • Limit the number of chars in the slug?