cxspxr/react-shortener

:link: Rails API & React URL Shortener

📮 Rails API for URL Shortening 📤

What I'm gonna use:

• Rails API 5.2.1

• MySQL2

• RSpec for testing

• Shoulda Matchers for simplier RSpec testing

• Faker

• Heroku for deployment & development

• Husky to manage GIT hooks & to run RSpec test on pre-commit & pre-push

• Rack::Attack to prevent DOS

• Rack CORS for Cross-Origin Resource Sharing

• Memcached/Dalli for requests throttling

• Geocoder to track locations

---

Development

Use rails s and curl for HTTP requests.

---

Deployment

This might be deployed as an isolated API as it is shown here (this exactly route returns the current number of links for base62 encoding). Along with a frontend like this (git for it) served with some http server. Just don't forget to respect the CORS as it is shown here.

On the other hand it could be deployed as a part of monolithic system as it is shown here (react branch of this repo) with a Puma for http serving.

---

Project Structure

app/

You may know the app/ structure since it's pretty default. It's the home to models, controllers, validators, exception handlers etc.

Controllers

There are three controllers which are interesting for us:

• application_controller with module dependencies;
• links_controller handles store-ing, get-ing, count-ing for the Link model;
• redirect_controller with a single method to redirect and store the Redirect itself (i.e. it's location) using the Geocoder;

Models

• Link to store :url and :shortened;
• Redirect to store :location and :time;

A single Link has many Redirects. A single Redirect belongs to one Link.

Validators

• Base62Validator to validate :base62 shortening;
• UrlValidator to validate :url formatting;

config/

• initializers/rack_attack.rb to configure Rack::Attack;

• environments/*.rb to manage heroku production and local environments (development and testing);

spec/

This is for RSpec with Shoulda Matchers & Faker testing.

I belive that everything is backed by tests by now.

Specific files

.branch-ignore is used by me to manage branch-specific .gitignore using Husky and .gitignore.<branch-name> files.

/.*|(other)/ folders & files are pretty default

react-shortener's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Detected empty commit - aborting git push

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update dependency faker to v1.9.6
• Update dependency mysql2 to v0.5.6
• Update dependency rack-attack to v5.4.2
• Update dependency bootsnap to v1.18.3
• Update dependency database_cleaner to v1.99.0
• Update dependency figaro to v1.2.0
• Update dependency rack-cors to v1.1.1
• Update dependency rspec-rails to v3.9.1
• Update dependency shoulda-matchers to v4.5.1
• Update dependency spring to v2.1.1
• Update dependency byebug to v11
• Update dependency database_cleaner to v2
• Update dependency faker to v3
• Update dependency husky to v9
• Update dependency rack-attack to v6
• Update dependency rack-cors to v2
• Update dependency rails to v7
• Update dependency rspec-rails to v6
• Update dependency ruby to v3
• Update dependency shoulda-matchers to v6
• Update dependency spring to v4
• Update npm to v10
• 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update dependency puma to v5 [SECURITY]
• Update Node.js to v10.24.1
• Update dependency husky to v1.3.1

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

• Update dependency geocoder to v1.6.1 [SECURITY]
• Update dependency dalli to v3 [SECURITY]

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency rails to v5.2.8.1
• Update dependency listen to '>= 3.0.5', '< 3.9.1'
• Update dependency ruby to v2.7.8
• Update dependency spring-watcher-listen to '~> 2.1.0'
• Update npm to v6.14.18
• Update Node.js to v20
• Update dependency factory_bot_rails to v6
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

bundler

Gemfile

• ruby 2.5.1
• rails '~> 5.2.1'
• mysql2 '>= 0.4.4', '< 0.6.0'
• puma '~> 3.11'
• geocoder undefined
• rack-cors undefined
• dalli undefined
• memcachier undefined
• rack-attack undefined
• figaro undefined
• bootsnap '>= 1.1.0'
• byebug undefined
• rspec-rails '~> 3.5'
• faker undefined
• listen '>= 3.0.5', '< 3.2'
• spring undefined
• spring-watcher-listen '~> 2.0.0'
• factory_bot_rails '~> 4.0'
• shoulda-matchers '~> 4.0'
• database_cleaner undefined

npm

package.json

• husky 1.0.1
• node 10.21.0
• npm 6.4.1

ruby-version

.ruby-version

---

• Check this box to trigger a request for Renovate to run again on this repository