Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rvvergara/fazebuk-api
Fazebuk API - A Facebook Clone backend API
https://github.com/rvvergara/fazebuk-api
Last synced: 18 days ago
JSON representation
Fazebuk API - A Facebook Clone backend API
- Host: GitHub
- URL: https://github.com/rvvergara/fazebuk-api
- Owner: rvvergara
- Created: 2019-08-26T06:51:54.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T01:42:05.000Z (24 days ago)
- Last Synced: 2024-10-21T05:06:09.989Z (24 days ago)
- Language: Ruby
- Size: 1.08 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fazebuk-api -> JSON API Facebook Clone
[](https://github.com/RichardLitt/standard-readme)
> JSON API app built using Ruby on Rails
> App generated using [this](https://github.com/rvvergara/rails-templates/tree/master/api_template) custom Rails Template
Version 1 Features:
- User account creation and update
- Token authentication using `devise` and `jwt`
- Request authorization using `pundit`
- Database search using `pg_search`
- Model and request specs using `rspec-rails` and `factory_bot_rails`
Pipeline:
- Login using facebook -> thru omniauth
## Background
Previously I co-worked on a [project](https://github.com/dipto0321/facialbook) that built a full-stack Rails [Facebook clone](https://facials.herokuapp.com/). While that was fun to build, there were lots of limitations posed by my skills in working with JavaScript on Rails. Further, I wanted to utilize the power of React but didn't want to put all logic for Rails and React in one huge application. For this reason I decided to create a shadow application that splits the front and backend.
## Table of Contents
- [fazebuk-api](#fazebuk-api)
- [Table of Contents](#table-of-contents)
- [Technologies used](#main-technologies-used)
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Main Technologies used
- Ruby on Rails
- PostgreSQL
- Devise
- JWT
- Koala
- Pundit
- Jbuilder
- PG Search (for search capability)
- RSpec
- FactoryBot
## Install
Follow these steps:
- clone this repo
- `cd fazebuk-api`
- `bundle`
**Set up credentials**
In the terminal run:
```
$ EDITOR=" --wait" rails credentials:edit
```
it will open up a `.credentials.yml`. In this file include the ff lines:
```ruby
db:
username:
password:
```
Save and close file. The following message should be shown in the terminal after saving and closing:
```
New credentials encrypted and saved.
```
**Set up database**
Run:
```
$ rails db:setup
```
## Usage
```
rails s
```
Goto `localhost:3000`
Use either `httpie` on the terminal or Postman to do requests
**Endpoints (all examples use httpie)**
1. User Creation
```bash
$ http POST :3000/v1/users user:='{"username":"john123", "email":"[email protected]", "first_name":"John", "last_name":"Doe", "password":"password", "password_confirmation":"password"}'
```
2. User data update
```bash
# assuming username is john123
$ http PUT :3000/v1/users/john123 user:='{"first_name":"Johnny the Great"}'
```
3. Deleting user
```bash
# assuming username is john123
$ http DELETE :3000/v1/users/john123
```
4. Signing in a user through email and password
```bash
# assuming user email is [email protected] and password is 'password'
$ http POST :3000/v1/sessions [email protected] password=password
```
5. Signing in a user through Facebook/User creation (if user doesn't exist yet)
```bash
# for this to work we should have a Facebook access_token
$ http GET :3000/v1/auth/facebook?access_token=
### Friendship endpoints
```
6. Sending a friend request
```bash
# assuming you are logged in and has a token generated from signing in
# assuming username of user to send request to is 'mildred'
$ http POST :3000/v1/friendships?friend_requested=mildred "Authorization: Bearer "
```
7. Cancelling a friend request
```bash
# assuming you are logged in as the same user that sent mildred a request
# you can get the friendship_id thru the rails console
$ http DELETE :3000/v1/friendships/ "Authorization: Bearer "
```
8. Confirming a friend request
```bash
# assuming now you are logged on as mildred
$ http PUT :3000/v1/friendships/ "Authorization: Bearer "
```
9. Rejecting a friend request
```bash
# still assuming mildred is logged on
$ http DELETE :3000/v1/friendships/ "Authorization: Bearer "
```
10. Checking a user's list of friends
```bash
# friends are listed 10 each per page
# to check first 10 friends either include query parameter '?page=' or simply
$ http GET :3000/v1/users//friends "Authorization: Bearer "
# to check next 10 friends (on page 2)
$ http GET :3000/v1/users//friends?page=2 "Authorization: Bearer "
```
11. Checking your mutual friends with another user
```bash
# assuming you wanna see your mutual friends with mildred
# mutual friends are listed 10 per page. you can either specify page=1
# but to check succeeding mutual friends you must specify which page
$ http GET :3000/v1/users/mildred/mutual_friends?page= "Authorization: Bearer "
```
12. Viewing your newsfeed posts
```bash
# assuming you are logged on and have a token
# if page param isn't included then request will go to page 1
$ http GET :3000/v1/newsfeed_posts?page= "Authorization: Bearer "
```
13. Viewing a user's timeline posts
```bash
# assuming you are logged on and have a token
# assuming you want to see timeline posts of rachel
# if page param isnt included then response will default to page 1
$ http GET :3000/v1/users/rachel/timeline_posts?page= "Authorization: Bearer "
```
14. Posting on your or another user's timeline
```bash
# assuming you're logged on and have a token
# assuming you are posting on kobe's timeline
$ http POST :3000/v1/posts post:='{"postable"="kobe", "content":"Nice shot!"}' "Authorization: Bearer "
# in the frontend if you wish to post on your newsfeed just input above your own username in the postable param
```
15. Updating your post
```bash
# assuming you are logged on and have a token
# assuming you posted on jill's timeline and you are updating that post
$ http PUT :3000/v1/posts/ post:='{"postable": "jill", "content": "This is an updated content"}' "Authorization: Bearer "
```
16. Deleting your post
```bash
# assuming you are logged on and have a token
# assuming you are the owner of the post (if not the response will be an error)
$ http DELETE :3000/v1/posts/ "Authorization: Bearer "
```
## Maintainer
[Ryan](https://github.com/rvvergara)
## Contributing
[Ryan](https://github.com/rvvergara)
PRs accepted.
## License
MIT © 2019 Ryan Vergara