spotify_rec 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '00749e0a49528b3d680597ee48924685869ab8963027609a951f0d8e1bd6bfd6'
+  data.tar.gz: ead9a411308f5234a5b4d1919201e0721f1191304a3e486e5f75e644db23fe1b
+SHA512:
+  metadata.gz: 88011906853f7d6e5e6e4fe650c5d474f0caa8534ee8ee590e7bd5178b48bf773a4b56c9d12f9fee97db0ce8affb8d7860a783330290ef4024c68e91a0aa43c7
+  data.tar.gz: cd0e528637accbbd6c8a15b6a6de7d58e8b21e04cabe9c73787c9fb8885db2056b27075a6fefd199be3a40924f050f53aec97be5e2bbe1d58d32684700d7dd39

data/bin/spotify_rec

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+# gems
+require 'rspotify'
+require 'optparse'
+require 'json'
+require 'tty-prompt'
+require 'terminal-table'
+require 'colorize'
+
+# files
+require_relative '../lib/user'
+require_relative '../lib/playlist'
+require_relative '../lib/login'
+require_relative '../lib/rec'
+require_relative '../lib/menu'
+require_relative '../lib/my_list'
+
+#modules
+include Login
+
+RSpotify.authenticate("712ff89a218a4e6dbe1f169e06f949b9", "e9e0517f405b4a01a1be8823126459b7")
+$prompt = TTY::Prompt.new
+
+VERSION = 1.0
+
+ARGV << '--run' if ARGV.empty?
+
+options = {}
+parser = OptionParser.new do |opts|
+    opts.banner = "Welcome to Spotify Recommendations! Usage: spotifyrec [options]".colorize(:light_green)
+
+    opts.on("-v", "--version", "Display the version") do
+        puts "Spotify Recommendations version #{VERSION}".colorize(:light_green)
+    end
+
+    opts.on("-h", "--help", "Display the help message") do
+        puts opts
+        exit
+    end
+
+    opts.on("-qGENRE", "--quick=GENRE", "Generate a quick recommendation with the chosen genre") do |genre|
+        recommendations = RSpotify::Recommendations.generate(limit: 5, seed_genres: [genre])
+        cleaned_recs = recommendations.tracks.map { |t| "#{t.name} by #{t.artists[0].name}" }
+        puts "》  RECOMMENDATIONS  《".colorize(:light_green)
+        cleaned_recs.each { |track| puts track }
+    end
+
+    opts.on("-r", "--run", "Run the application") do
+        Login::login
+    end
+end
+
+parser.parse!

data/lib/login.rb

@@ -0,0 +1,117 @@
+require_relative 'menu'
+
+module Login
+
+  def user
+    return @user
+  end
+
+  def userdata
+    path = File.join(File.dirname(File.dirname(File.absolute_path(__FILE__))))
+    userfile = "#{path}/public/users.json"
+    return userfile
+  end
+
+  def clear
+    system("clear")
+  end
+
+  def initial_login
+    clear
+    puts "               ;;;;;;;;;;;;;;;;;;; 
+               ;;;;;;;;;;;;;;;;;;;
+               ;                 ;
+               ;                 ;
+               ;                 ;
+               ;                 ;
+               ;                 ;
+               ;                 ;
+           ,;;;;;            ,;;;;;
+           ;;;;;;            ;;;;;;
+           `;;;;'            `;;;;'
+           ".colorize(:light_green)
+    puts "》  Welcome to the Spotify Recommendations App!  《".colorize(:light_green)
+    puts
+    return $prompt.select("Are you a new or returning user? \n", %w(New Returning))
+  end
+
+  def load_data
+    file = File.read(userdata)
+    return JSON.parse(file)
+  end
+
+  def gen_uid
+    return load_data.length + 1
+  end
+
+  def store_user
+    data = load_data
+    user_details = {
+      "id" => "#{@user.uid}",
+      "username" => @user.username,
+      "password" => @user.password,
+      "playlist" => @user.playlist,
+      "mylist" => @user.mylist
+    }
+    data << user_details
+    File.open(userdata,"w") do |f|
+      f.puts JSON.pretty_generate(data)
+    end
+    puts "You're now registered! Logging you in..".colorize(:light_green)
+    sleep(1)
+    @menu = Menu.new(@user)
+    @menu.menu_router
+  end
+
+  def new_user
+    system("clear")
+    puts "Welcome! Please register for an account to continue.".colorize(:light_green)
+    username = $prompt.ask("Username >") { |u| u.validate(/\A[0-9a-zA-Z'-]*\z/, "Username must only contain letters and numbers")}
+    password = $prompt.mask("Password >")
+    @user = User.new(username, password, gen_uid)
+    @user_playlist = Playlist.new(@user)
+    store_user
+  end
+
+  def returning_user
+    system("clear")
+    puts "Welcome back! Please login to continue.".colorize(:light_green)
+    username = $prompt.ask("Username >")
+    password= $prompt.mask("Password >")
+    authenticate(username, password)
+  end
+
+  def authenticate(username, password)
+    data = load_data
+    auth = false
+    data.each do |hash|
+      if hash["username"].downcase == username.downcase
+        if hash["password"] == password
+          auth = true
+          @user = User.new(username, password, hash["id"], hash["playlist"], hash["mylist"])
+          @user_playlist = Playlist.new(@user)
+          puts "Success! Logging you in..".colorize(:light_green)
+          sleep(1)
+          @menu = Menu.new(@user)
+          @menu.menu_router
+        end
+      end
+    end
+    unless auth
+      puts "Incorrect username or password!".colorize(:red)
+      sleep(1)
+      returning_user
+    end
+  end
+
+  def login
+    new_returning = initial_login.downcase
+    if new_returning == "new"
+      new_user
+    end
+    if new_returning == "returning"
+      returning_user
+    end
+  end
+
+end

data/lib/menu.rb

@@ -0,0 +1,67 @@
+class Menu
+
+  def initialize(user)
+    @user = user
+    @prompt = prompt = TTY::Prompt.new
+    @playlist = Playlist.new(@user)
+  end
+
+  def display_menu
+    system("clear")
+    return @prompt.select("》  MAIN MENU  《\n".colorize(:light_green), (["My List", "Recommendations", "Playlist", "Account Details", "Exit"]))
+  end
+
+  def my_list
+    system("clear")
+    selection = @prompt.select("》  MY LIST  《\n".colorize(:light_green), (["Display", "Add", "Remove", "Back"]))
+    mylist = MyList.new(@user)
+    case selection
+      when "Display"
+        mylist.list
+      when "Add"
+        mylist.add_to_list
+      when "Remove"
+        mylist.remove_from_list
+      when "Back"
+        menu_router
+    end
+  end
+
+  def account_details
+    system("clear")
+    selection = @prompt.select("》  ACCOUNT MENU  《 \n".colorize(:light_green), (["View Details", "Change Username", "Change Password", "Delete Account", "Back"]))
+    case selection
+      when "View Details"
+        @user.details
+      when "Change Username"
+        username = @prompt.ask("Please enter your new username >") { |u| u.validate(/\A[0-9a-zA-Z'-]*\z/, "Username must only contain letters and numbers")}
+        @user.change_username(username)
+      when "Change Password"
+        password = @prompt.ask("Please enter your new password >")
+        @user.change_password(password)
+      when "Delete Account"
+        @user.delete_account
+      when "Back"
+        menu_router
+    end
+  end
+
+  def menu_router
+    selection = display_menu
+    case selection
+      when "My List"
+        system("clear")
+        my_list
+      when "Recommendations"
+        recommendation = Rec.new(@user)
+        recommendation.amount_of_suggestions
+      when "Playlist"
+        @playlist.menu
+      when "Account Details"
+        account_details
+      when "Exit"
+        exit
+    end
+  end
+
+end

data/lib/my_list.rb

@@ -0,0 +1,137 @@
+class MyList
+
+  def initialize(user)
+    @user = user
+    @mylist = user.mylist
+    @menu = Menu.new(@user)
+  end
+
+  def separator
+    puts "----------------------------------------"
+  end
+
+  def list
+    unless @mylist.empty?
+      rows = @mylist.map do |hash|
+        if hash["type"] == "track" || hash["type"] == "album"
+          ["#{hash["name"]} by #{hash["artist"]}", hash["type"].capitalize]
+        else
+          [hash["name"], hash["type"].capitalize]
+        end
+      end
+      table = Terminal::Table.new :headings => ['Item', 'Type'], :rows => rows
+      puts table
+      $prompt.keypress("Press any key to return to the previous menu..")
+      @menu.my_list
+    else
+      empty_list
+    end
+  end
+
+  def empty_list
+    puts "Oh no! Your list is currently empty!".colorize(:light_red)
+    puts "Add up to 5 items to your list. An item can be a song, artist or genre.".colorize(:light_red)
+    separator
+    $prompt.keypress("Press any key to return to the previous menu..")
+    @menu.my_list
+  end
+
+  def add_to_list
+    if @mylist.length >= 5
+      puts "Oh no! You've reached maximum capacity in your list! You won't be able to add another item until you remove an existing one.".colorize(:light_red)
+      puts "You can do this by heading back to the previous menu, and selecting 'Remove'".colorize(:light_red)
+      $prompt.keypress("Press any key to return to the previous menu..")
+      @menu.my_list
+    end
+    selection = $prompt.select("Which type would you like to add?".colorize(:light_green), (["Song", "Artist", "Genre", "Back"]))
+    case selection
+      when "Song"
+        search_song
+      when "Artist"
+        search_artist
+      when "Genre"
+        store_genre
+      when "Back"
+      @menu.my_list
+    end
+  end
+
+  def remove_from_list
+    empty_list if @mylist.length <= 0
+    item_names = @mylist.map { |item| item["name"] }
+    item_names << "Back"
+    selection = $prompt.select("Which item would you like to remove?".colorize(:light_green), (item_names))
+    @menu.my_list if selection == "Back"
+    @mylist.each_with_index do |item, index|
+      @mylist.delete_at(index) if item["name"] == selection
+    end
+    update_file
+  end
+
+  def search_song
+    song_query = $prompt.ask("What is the name of the song?".colorize(:light_green))
+    tracks = RSpotify::Track.search(song_query, limit: 5)
+    cleaned_results = []
+    tracks.each { |t| cleaned_results << "#{t.name} by #{t.artists[0].name}" }
+    system("clear")
+    cleaned_results << "Back"
+    selection = $prompt.select("Please select one of the search results:", (cleaned_results)).split(" by ")
+    add_to_list if selection[0] == "Back"
+    store_song(selection)
+  end
+
+  def store_song(details)
+    track = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
+    song_details = {
+    "name" => track.name,
+    "artist" => track.artists[0].name,
+    "id" => track.id,
+    "type" => "track"
+    }
+    @mylist << song_details
+    update_file
+  end
+
+  def search_artist
+    artist_query = $prompt.ask("What is the name of the artist?".colorize(:light_green))
+    artists = RSpotify::Artist.search(artist_query, limit: 5)
+    cleaned_results = []
+    artists.each { |a| cleaned_results << "#{a.name}" }
+    system("clear")
+    selection = $prompt.select("Please select one of the search results:", (cleaned_results))
+    store_artist(selection)
+  end
+
+  def store_artist(details)
+    artist = RSpotify::Artist.search("#{details}", limit: 1).first
+    artist_details = {
+    "name" => artist.name,
+    "id" => artist.id,
+    "type" => "artist"
+    }
+    @mylist << artist_details
+    update_file
+  end
+
+  def store_genre
+    genres = RSpotify::Recommendations.available_genre_seeds
+    genre = $prompt.select("Which genre would you like to add to your list?".colorize(:light_green), genres, filter: true)
+    genre_details = {
+      "name" => genre.capitalize,
+      "type" => "genre"
+    }
+    @mylist << genre_details
+    update_file
+  end
+
+  def update_file
+    updated_data = Login.load_data.each { |user| user["mylist"] = @mylist if user["id"] == @user.uid.to_s }
+    File.open(userdata,"w") do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    puts "Sweet! Your list has been updated!".colorize(:light_green)
+    $prompt.keypress("Press any key to return to the previous menu..")
+    @menu.my_list
+  end
+
+end

data/lib/playlist.rb

@@ -0,0 +1,112 @@
+class Playlist
+
+  attr_reader :tracks
+
+  def initialize(user)
+    @playlist = user.playlist
+    @user = user
+  end
+
+  def list
+    rows = @playlist.map { |track| [track["name"], track["artist"]] }
+    table = Terminal::Table.new :headings => ['Track', 'Artist'], :rows => rows
+    puts table
+  end
+
+  def remove
+    empty if @playlist.length <= 0
+    item_names = @playlist.map { |item| "#{item["name"]} by #{item["artist"]}" }
+    item_names << "Back"
+    selection = $prompt.select("Which track would you like to remove?", (item_names)).split(" by ")
+    menu if selection == "Back"
+    @playlist.each_with_index do |item, index|
+      @user.playlist.delete_at(index) if item["name"] == selection[0]
+    end
+    update_playlist
+  end
+
+  def empty
+    puts "Oh no! Your playlist is currently empty!"
+    puts "You can add songs manually from the previous menu, or generate recommendations and add those!"
+    separator
+    $prompt.keypress("Press any key to return to the previous menu..")
+    Menu::my_list
+  end
+
+  def add
+    song_query = $prompt.ask("What is the name of the song?")
+    tracks = RSpotify::Track.search(song_query, limit: 5)
+    cleaned_results = []
+    tracks.each { |t| cleaned_results << "#{t.name} by #{t.artists[0].name}" }
+    system("clear")
+    cleaned_results << "Back"
+    selection = $prompt.select("Please select one of the search results:", (cleaned_results)).split(" by ")
+    menu if selection[0] == "Back"
+    store(selection)
+  end
+
+  def store(details)
+    track = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
+    song_details = {
+    "name" => track.name,
+    "id" => track.id,
+    "artist" => track.artists[0].name
+    }
+    @playlist << song_details
+    update_playlist
+  end
+
+  def update_playlist
+    updated_data = Login.load_data.each { |user| user["playlist"] = @playlist if user["id"] == @user.uid.to_s }
+    File.open((Login::userdata),"w") do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    puts "Sweet! Your playlist has been updated!"
+    $prompt.keypress("Press any key to return to the previous menu..")
+    menu
+  end
+
+  def export_to_file
+    path = File.join(File.dirname(File.dirname(File.absolute_path(__FILE__))))
+    playlist_file = "#{path}/playlist.md"
+    File.open(playlist_file,"w") do |f|
+      f.puts("# #{@user.username}'s Playlist")
+      @playlist.each { |track| f.puts("1. #{track["name"]} by #{track["artist"]} || [Listen on Spotify](https://open.spotify.com/track/#{track["id"]})") }
+    end
+    system("cp #{playlist_file} ~/Desktop/playlist.md")
+    puts "Exported playlist to your Desktop!"
+    sleep(2)
+    system("clear")
+  end
+
+  def keypress_playlist
+    $prompt.keypress("Press any key to return to the previous menu..")
+  end
+
+  def menu
+    system("clear")
+    selection = $prompt.select("》  PLAYLIST  《", (["Display", "Add", "Remove", "Export To File", "Back"]))
+    case selection
+      when "Display"
+        puts "》  PLAYLIST  《"
+        list
+        keypress_playlist
+        menu
+      when "Add"
+        add
+        keypress_playlist
+        menu
+      when "Remove"
+        remove
+        menu
+      when "Export To File"
+        export_to_file
+        keypress_playlist
+        menu
+      when "Back"
+        @menu = Menu.new(@user)
+        @menu.menu_router
+    end
+  end
+
+end

data/lib/rec.rb

@@ -0,0 +1,65 @@
+class Rec
+
+  def initialize(user)
+    @user_list = user.mylist
+    @user = user
+  end
+
+  def sort_my_list
+    @tracks = []
+    @artists = []
+    @genres = []
+    @user_list.each do |item|
+      @tracks << item["id"] if item["type"] == "track"
+      @artists << item["id"] if item["type"] == "artist"
+      @genres << item["name"].downcase if item["type"] == "genre"
+    end
+  end
+
+  def update_file
+    updated_data = Login.load_data.each { |user| user["playlist"] = @user.playlist if user["id"] == @user.uid.to_s }
+    File.open(userdata,"w") do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    puts "Sweet! Your list has been updated!".colorize(:light_green)
+    $prompt.keypress("Press any key to return to the previous menu..")
+    menu = Menu.new(@user)
+    menu.menu_router
+  end
+
+  def clean_recommendations(selections)
+    selections.each do |track|
+      details = track.split(" by ")
+      song = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
+      song_details = {
+        "name" => song.name,
+        "id" => song.id,
+        "artist" => song.artists[0].name }
+      @user.playlist << song_details
+    end
+    update_file
+  end
+
+  def recommend(num)
+    system("clear")
+    sort_my_list
+    recommendations = RSpotify::Recommendations.generate(limit: num, seed_artists: @artists, seed_genres: @genres, seed_tracks: @tracks)
+    cleaned_recs = recommendations.tracks.map { |t| "#{t.name} by #{t.artists[0].name}" }
+    puts "》  RECOMMENDATIONS  《".colorize(:light_green)
+    puts "Select the recommendations you want to add to your playlist!"
+    selections = $prompt.multi_select("Hit enter with none selected to skip.", cleaned_recs)
+    clean_recommendations(selections)
+  end
+
+  def amount_of_suggestions
+    system("clear")
+    puts "》  RECOMMENDATIONS  《"
+    amount = $prompt.ask("How many recommendations would you like to generate?".colorize(:light_green)) do |q|
+      q.in '1-10'
+      q.messages[:range?] = "Number must be between 1 and 10"
+    end
+    recommend(amount.to_i)
+  end
+
+
+end

data/lib/run.rb

@@ -0,0 +1,47 @@
+require 'rspotify'
+require 'optparse'
+require 'json'
+require 'tty-prompt'
+require 'terminal-table'
+require 'colorize'
+require_relative 'user'
+require_relative 'playlist'
+require_relative 'login'
+require_relative 'rec'
+require_relative 'menu'
+require_relative 'my_list'
+include Login
+
+RSpotify.authenticate("712ff89a218a4e6dbe1f169e06f949b9", "e9e0517f405b4a01a1be8823126459b7")
+$prompt = TTY::Prompt.new
+
+VERSION = 1.0
+
+ARGV << '--run' if ARGV.empty?
+
+options = {}
+parser = OptionParser.new do |opts|
+    opts.banner = "Welcome to Spotify Recommendations! Usage: spotifyrec [options]".colorize(:light_green)
+
+    opts.on("-v", "--version", "Display the version") do
+        puts "Spotify Recommendations version #{VERSION}".colorize(:light_green)
+    end
+
+    opts.on("-h", "--help", "Display the help message") do
+        puts opts
+        exit
+    end
+
+    opts.on("-qGENRE", "--quick=GENRE", "Generate a quick recommendation with the chosen genre") do |genre|
+        recommendations = RSpotify::Recommendations.generate(limit: 5, seed_genres: [genre])
+        cleaned_recs = recommendations.tracks.map { |t| "#{t.name} by #{t.artists[0].name}" }
+        puts "》  RECOMMENDATIONS  《".colorize(:light_green)
+        cleaned_recs.each { |track| puts track }
+    end
+
+    opts.on("-r", "--run", "Run the application") do
+        Login::login
+    end
+end
+
+parser.parse!

data/lib/user.rb

@@ -0,0 +1,69 @@
+class User
+
+  attr_reader :username, :password, :uid
+  attr_accessor :playlist, :mylist
+
+  def initialize(username, password, uid, playlist=[], mylist=[])
+    @username = username
+    @password = password
+    @playlist = playlist
+    @uid = uid
+    @mylist = mylist
+  end
+
+  def details
+    puts "Username: #{@username.colorize(:light_green)}"
+    puts "Password: #{@password.colorize(:light_green)}"
+    puts "User ID: #{@uid.to_s.colorize(:light_green)}"
+    $prompt.keypress("Press any key to continue..")
+    menu = Menu.new(Login::user)
+    menu.account_details
+  end
+
+  def change_username(new_name)
+    updated_data = Login.load_data.each { |user| user["username"] = new_name if user["id"] == Login::user.uid.to_s }
+    File.open((Login::userdata),"w") do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    @username = new_name
+    puts "Success! Your new username is #{Login::user.username}".colorize(:light_green)
+    $prompt.keypress("Press any key to continue..")
+    menu = Menu.new(Login::user)
+    menu.account_details
+  end
+
+  def change_password(new_password)
+    updated_data = Login.load_data.each { |user| user["password"] = new_password if user["id"] == Login::user.uid.to_s }
+    File.open((Login::userdata),"w") do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    @password = new_password
+    puts "Success! Your password has been changed.".colorize(:light_green)
+    $prompt.keypress("Press any key to continue..")
+    menu = Menu.new(Login::user)
+    menu.account_details
+  end
+
+  def delete_from_file
+    updated_data = []
+    Login.load_data.each { |user| updated_data << user unless user["id"] == Login::user.uid.to_s }
+    File.open((Login::userdata),"w") do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    puts "Your account has been deleted. The program will now exit.".colorize(:light_red)
+    $prompt.keypress("Press any key to continue..")
+    exit
+  end
+  
+
+  def delete_account
+    puts "Woah there! Deleting your account is serious business, and cannot be undone.".colorize(:light_red)
+    selection = $prompt.yes?("Are you sure you want to delete your account?").colorize(:light_red)
+    unless selection
+      menu = Menu.new(Login::user)
+    else
+      delete_from_file
+    end
+  end
+
+end

data/public/users.json

@@ -0,0 +1,13 @@
+[
+  {
+    "id": "1",
+    "username": "benahale",
+    "password": "Tsurani7",
+    "playlist": [
+
+    ],
+    "mylist": [
+
+    ]
+  }
+]

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: spotify_rec
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Ben Ahale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-28 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables:
+- spotify_rec
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/spotify_rec
+- lib/login.rb
+- lib/menu.rb
+- lib/my_list.rb
+- lib/playlist.rb
+- lib/rec.rb
+- lib/run.rb
+- lib/user.rb
+- public/users.json
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- public
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Spotify Rec generates track recommendations based upon a user defined list
+  of items
+test_files: []