Weekly Music Contest

Rationale

MB Music Contest API. This Rails Application will serve all the logic to manage a employees's weekly music contest platform.

Requirements

The application uses:

• ruby 2.6.3 (a ruby manager like rvm is useful here)
• Rails 5.2
• bundler gem (gem install bundler)
• git (recommended)
• Postgres database

Setup

Once you meet the requirements in the previous section,

Download the code

• Download the repo (using git)

  $ git clone [email protected]:romera94/MusicContest.git

• Download the repo through browser (https://github.com/romera94/MusicContest/archive/master.zip) and unzip it.

Environment variables

The configuration is performed through environment variables.

To setup the environment variables so they can point to your (postgres) database account, run:

$ export SPOTIFY_CLIENT_SECRET=<your_spotify_client_secret_here>
$ export SPOTIFY_CLIENT_ID=<your_spotify_client_id_here>
$ export DB_NAME=<your_database_name_here>
$ export DB_USER=<your_db_user_here>
$ export DB_PASS=<your_db_password_here>

Run the setup script

the setup script will,

• check some requirements
• install all the required gems
• install the database schema and a initial data dump
• run tests

to start, run:

$ cd MusicContest
$ bin/setup
$ rails s

Now you can reach the API through your browser or an app like 'Postman' in

http://localhost:3000

Endpoint List

The list of endpoints, payloads and methods is:

Application Endpoints:

GET        /current_contest
   return codes:
   -- 200: ok

GET        /current_contest_songs
   return codes:
   -- 200: ok

POST       /delete_song
   payload:
   {
	"song": {
		"participant_id": integer (must exist),
		"spotify_url": "https://spotify.com/...<id>..."
	}
   }
   returns codes:
    -- 450: the participant does not exists
    -- 450: the song does not exists
    -- 453: the participant does not own the submitted song

POST       /submit_song
   payload:
   {
	"song": {
		"participant_id": integer (must exist),
		"spotify_url": "https://spotify.com/...<id>..."
	}
   }
   returns codes:
    -- 450: the participant does not exists
    -- 451: the song was already submitted to other contest
    -- 452: maximum allowed songs for that participant have already been submitted  

GET        /current_contest_ranking
   incomplete

POST       /vote_song
   incomplete

POST       /change_vote
   incomplete

Usual/Default REST endpoints (standard payloads and return codes)

GET        /song_covers
POST       /song_covers
  sample payload:
  {
	 "song_cover": {
	 	"file_path": "/files/file1.jpeg",
	 	"file_type": "jpeg",
	 	"file_url": "https://s3.amazonws.com/"
	 }
  }

GET        /song_covers/:id
PATCH      /song_covers/:id
PUT        /song_covers/:id
DELETE     /song_covers/:id

GET        /songs
POST       /songs
  sample payload:
  {	
	"song": {
	"spotify_id": "id2", 
	"spotify_url": "url2", 
	"spotify_title": "title2",
	"spotify_artist": "artist2", 
	"spotify_length": 40, 
	"spotify_album": "album1",
	"contest_id": 1,
	"submitby_user_id":1
	}
  }
GET        /songs/:id
PATCH      /songs/:id
PUT        /songs/:id
DELETE     /songs/:id

GET        /participants
POST       /participants
  sample payload:
  {
    "participant": {
        "name": "name1",
        "surname": "surname1"
    }
  }
GET        /participants/:id
PATCH      /participants/:id
PUT        /participants/:id
DELETE     /participants/:id

GET        /music_contests
POST       /music_contests
  sample payload:
  {
    "music_contest": {
        "contest_status": "finished",
        "topic": "topic6",
        "winner_user_id": null,
        "start_date": "2019-08-01",
        "end_date": "2019-09-01"
    }
  }
GET        /music_contests/:id
PATCH      /music_contests/:id
PUT        /music_contests/:id
DELETE     /music_contests/:id

GET        /contest_song_participant_votes
POST       /contest_song_participant_votes
  sample payload:
  {  
    "contest_song_participant_vote": {
        "participant_id": 1,
        "song_id": 1
    }
  }
GET        /contest_song_participant_votes/:id
PATCH      /contest_song_participant_votes/:id
PUT        /contest_song_participant_votes/:id
DELETE     /contest_song_participant_votes/:id

HTTP response return codes

Code: 448 - Contest does not exists 

Code: 449 - Contest's Participant does not exists 

Code: 450 - Song does not exists 

Code: 451 - Song was already submitted

Code: 452 - Maximum number of allowed songs already submitted
  
Code: 453 - The participant can not delete this song (not its owner)

Code: 454 - Error authenticating / connecting to the Spotify's API

Code: 455 - Error parsing the provided Spotify's Track URI

Design

The internal database structure design is as follows:

License

Registered under MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.