Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nejdetkadir/google-keep-api

Google Keep API with Ruby on Rails
https://github.com/nejdetkadir/google-keep-api

api clone-api google-keep google-keep-api rails-api ruby-on-rails-6

Last synced: 20 days ago
JSON representation

Google Keep API with Ruby on Rails

Host: GitHub
URL: https://github.com/nejdetkadir/google-keep-api
Owner: nejdetkadir
License: gpl-3.0
Created: 2021-11-02T10:59:00.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2021-11-03T20:49:56.000Z (about 3 years ago)
Last Synced: 2024-12-27T05:10:33.733Z (about 1 month ago)
Topics: api, clone-api, google-keep, google-keep-api, rails-api, ruby-on-rails-6
Language: Ruby
Homepage: https://google-keep-api-app.herokuapp.com
Size: 264 KB
Stars: 12
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Codacy Badge](https://app.codacy.com/project/badge/Grade/f644447a7b3442479e485f1821c45ab8)](https://www.codacy.com/gh/nejdetkadir/google-keep-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nejdetkadir/google-keep-api&utm_campaign=Badge_Grade)

# Google Keep API

![logo](docs/logo.png)

[Google Keep API](https://google-keep-api-app.herokuapp.com) with Ruby on Rails

## Database Schema

![database](docs/database.png)

## API Endpoints

### Authentication

| Route | HTTP Verb | Request Body | Header Body | Description |

| --- | --- | --- | --- | --- |

| /users | `POST` | ```{user: {email: "[email protected]", password: "mypass", password_confirmation: "mypass", fullname: "şevo"}}``` | Empty | Returns authentication bearer token on header |

| /users/sign_in | `POST` | ```{user: {email: "[email protected]", password: "mypass"}}``` | Empty | Returns authentication bearer token on header |

| /users/sign_out | `DELETE` | Empty  | Authentication: Bearer Token | Returns sign out message |

### Colors

| Route | HTTP Verb | Request Body | Header Body | Description |

| --- | --- | --- | --- | --- |

| /colors | `GET` | Empty | Authentication: Bearer Token | Returns user's colors |

| /colors | `POST` | ```{color: {color: "hexcode-or-rgb-or-etc"}}``` | Authentication: Bearer Token | Returns created resource or error messages |

| /colors/:id | `GET` | Empty  | Authentication: Bearer Token | Returns resource |

| /colors/:id | `PATCH` | ```{color: {color: "#fff"}}```  | Authentication: Bearer Token | Returns updated resource or error messages |

| /colors/:id | `PUT` | ```{color: {color: "#fff"}}``` | Authentication: Bearer Token | Returns updated resource or error messages |

| /colors/:id | `DELETE` | Empty  | Authentication: Bearer Token | Returns status of destroying |

### Labels

| Route | HTTP Verb | Request Body | Header Body | Description |

| --- | --- | --- | --- | --- |

| /labels | `GET` | Empty | Authentication: Bearer Token | Returns user's labels |

| /labels | `POST` | ```{label: {name: "Business"}}``` | Authentication: Bearer Token | Returns created resource or error messages |

| /labels/:id | `GET` | Empty  | Authentication: Bearer Token | Returns resource |

| /labels/:id | `PATCH` | ```{label: {name: "Birthday"}}```  | Authentication: Bearer Token | Returns updated resource or error messages |

| /labels/:id | `PUT` | ```{label: {name: "Car"}}``` | Authentication: Bearer Token | Returns updated resource or error messages |

| /labels/:id | `DELETE` | Empty  | Authentication: Bearer Token | Returns status of destroying |

### Notes

| Route | HTTP Verb | Request Body | Header Body | Description |

| --- | --- | --- | --- | --- |

| /notes | `GET` | Empty | Authentication: Bearer Token | Returns user's notes |

| /notes?status=normal | `GET` | Empty | Authentication: Bearer Token | Returns user's normal notes |

| /notes?status=archived | `GET` | Empty | Authentication: Bearer Token | Returns user's archived notes |

| /notes?status=deleted | `GET` | Empty | Authentication: Bearer Token | Returns user's deleted notes |

| /notes | `POST` | ```{label: {name: "Business"}}``` | Authentication: Bearer Token | Returns created resource or error messages |

| /notes/:id | `GET` | Empty  | Authentication: Bearer Token | Returns resource |

| /notes/:id | `PATCH` | ```{label: {name: "Birthday"}}```  | Authentication: Bearer Token | Returns updated resource or error messages |

| /notes/:id | `PUT` | ```{label: {name: "Car"}}``` | Authentication: Bearer Token | Returns updated resource or error messages |

| /notes/:id | `DELETE` | Empty  | Authentication: Bearer Token | Returns status of destroying |

### Images of Note

| Route | HTTP Verb | Request Body | Header Body | Description |

| --- | --- | --- | --- | --- |

| /notes/:note_id/images | `GET` | Empty | Authentication: Bearer Token | Returns user's images of note |

| /notes/:note_id/images | `POST` | ```{image: {image: Image File}}``` | Authentication: Bearer Token | Returns created resource or error messages |

| /notes/:note_id/images/:id | `DELETE` | Empty  | Authentication: Bearer Token | Returns status of destroying |

### Todos of Note

| Route | HTTP Verb | Request Body | Header Body | Description |

| --- | --- | --- | --- | --- |

| /notes/:note_id/todos | `GET` | Empty | Authentication: Bearer Token | Returns user's todos of note |

| /notes/:note_id/todos | `POST` | ```{todo: {content: "Create a CV", status: 0, sequence: 0}}``` | Authentication: Bearer Token | Returns created resource or error messages |

| /notes/:note_id/todos/:id | `GET` | Empty | Authentication: Bearer Token | Returns resource |

| /notes/:note_id/todos/:id | `PATCH` | ```{todo: {sequence: 1}}``` | Authentication: Bearer Token | Returns updated resource or error messages |

| /notes/:note_id/todos/:id | `PUT` | ```{todo: {sequence: 2}}``` | Authentication: Bearer Token | Returns updated resource or error messages |

| /notes/:note_id/todos/:id | `DELETE` | Empty  | Authentication: Bearer Token | Returns status of destroying |

### Collaborators of Note

| Route | HTTP Verb | Request Body | Header Body | Description |

| --- | --- | --- | --- | --- |

| /notes/:note_id/collaborators | `GET` | Empty | Authentication: Bearer Token | Returns user's collaborators of note |

| /notes/:note_id/collaborators | `POST` | ```{collaborator: {email: "[email protected]"}}``` | Authentication: Bearer Token | Returns created resource or error messages |

| /notes/:note_id/collaborators/:id | `DELETE` | Empty  | Authentication: Bearer Token | Returns status of destroying |

# Installation

## Prerequisites

- [Ruby](https://rvm.io/)

- [NodeJS (>=10.x)](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)

- [PostgreSQL](https://www.postgresql.org/download/)

- [ImageMagick](https://imagemagick.org/) `sudo apt-get install imagemagick libmagickcore-dev libmagickwand-dev`

## Installation

- Install GEM dependencies:

  ```bash

  bundle install

  ```

- Create database, migrate tables and run the seed data:

  ```bash

  rails db:create

  rails db:migrate

  rails db:seed

  ```

- If you are setting up again, when you already have previous databases:

  ```bash

  rails db:reset

  ```

- For dropping database

  ```bash

  rails db:drop

  ``` 

# LICENSE

```

GNU GENERAL PUBLIC LICENSE Version 3

```