spotify_rec 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 832dfdbb67807131538f45562b49208797c83e0b11604cbbaa72891af354daab
-  data.tar.gz: cc7abdbdc29cda735fb491e2eb30c35957dd60be465f30f9e253d6c4fe8f294a
+  metadata.gz: b08957a3d839195d0423afad8a933ebd1da0fe079dabdadfd2f37883b3a78c92
+  data.tar.gz: a8b1fe7c2d427c1a597505fed3e53b9f95a26f5bc591b7e535bbc74efac215a7
 SHA512:
-  metadata.gz: bc61791f2c2d5065b66010f991f5c625db257209562648f917f05832e8dcadb4545fe452e9c75eb30e9ff021a54e4e1be2dc97fd7f99bba0826cd65f5afb33fb
-  data.tar.gz: 528555fb05397d6d5106f724324d56da3e2eed96a003eed0a3ce9270640beba67f6dfb8d46724202007df0d6d059dab152945a396d2d82281523a3662f289a11
+  metadata.gz: c7a91d805bc0eae3619bee76b301736455b06959dfaa9ade5886f4e49e894726c12ad861b297a6546f73f29675d28367f832af666d10894f8d5e64ecb81c9241
+  data.tar.gz: ede7bc294c3b7faad5a5e4bd5e33dd0d9f59df4fbebec713ad36e8c9f1c22ad496f261cdd56355a94f23563fb8d9f5c0ed0a913c3b4cedf02cd621bf6f745146

data/lib/tutorial.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Contains methods to display tutorial screens
+module Tutorial
+  @prompt = TTY::Prompt.new
+
+  def start
+    system('clear')
+    puts '》  WELCOME TO SPOTIFY REC  《'.colorize(:light_green)
+    puts 'This tutorial will walk you through the basics to using the app.'
+    puts "There are 3 main areas that you'll need to understand:"
+    puts '- My List'
+    puts '- Recommendations'
+    puts '- Playlist'
+    puts
+    @prompt.keypress('Press any key to continue..')
+    my_list
+  end
+
+  def my_list
+    system('clear')
+    puts '》  MY LIST  《'.colorize(:light_green)
+    puts 'My List is the base that your recommendations are generated from. It can consist of'
+    puts "up to 5 of any 'items'. An item is either a track, artist or genre. You can add and remove"
+    puts 'items from my list, so make sure to change them up regularly to get a range of recommendations!'
+    puts "Searching for an item will return the top 5 results for your keywords, so if yours doesn't show"
+    puts 'up, try searching again with a more specific query!'
+    puts
+    @prompt.keypress('Press any key to continue..')
+    recommendations
+  end
+
+  def recommendations
+    system('clear')
+    puts '》  RECOMMENDATIONS  《'.colorize(:light_green)
+    puts 'As mentioned on the previous screen, recommendations are tracks, and are generated based on the'
+    puts "items in your list. You can select the amount you'd like to generate, and select any number of"
+    puts 'the recommendations to store in your playlist. Recommendations are capped at 10 per generate,'
+    puts 'but you can repeat the generate step as many times as you would like.'
+    puts
+    @prompt.keypress('Press any key to continue..')
+    playlist
+  end
+
+  def playlist
+    system('clear')
+    puts '》  PLAYLIST 《'.colorize(:light_green)
+    puts "Your playlist stores all of the recommendations you've chosen, but you can also manually add and"
+    puts "remove songs as well. This can all be done from the playlist menu. At any point you'd like to look"
+    puts 'at your playlist outside of Spotify Rec, you can export the contents to a file on your desktop.'
+    puts 'This file includes a link to each song on Spotify, so you can easily go and start listening!'
+    puts
+    @prompt.keypress('Press any key to return to finish..')
+    exit
+  end
+end

data/public/users.json

@@ -1 +1,47 @@
-[]
+[
+  {
+    "id": "1",
+    "username": "benahale",
+    "password": "password",
+    "playlist": [
+      {
+        "name": "44 More",
+        "id": "3e7Y6sfFlIdBMJhX7wpqVO",
+        "artist": "Logic"
+      },
+      {
+        "name": "Outnumbered",
+        "id": "6UjZ2Yx2g2a52XxiA8ONxZ",
+        "artist": "Dermot Kennedy"
+      }
+    ],
+    "mylist": [
+      {
+        "name": "Dermot Kennedy",
+        "id": "5KNNVgR6LBIABRIomyCwKJ",
+        "type": "artist"
+      },
+      {
+        "name": "MIDDLE CHILD",
+        "artist": "J. Cole",
+        "id": "2JvzF1RMd7lE3KmFlsyZD8",
+        "type": "track"
+      },
+      {
+        "name": "Pop",
+        "type": "genre"
+      },
+      {
+        "name": "Fool's Gold - Acoustic",
+        "artist": "Passenger",
+        "id": "4JPB2Kjr3lkMJFz4sZnt6G",
+        "type": "track"
+      },
+      {
+        "name": "Drake",
+        "id": "3TVXtAsR1Inumwj472S9r4",
+        "type": "artist"
+      }
+    ]
+  }
+]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotify_rec
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Ben Ahale
@@ -23,6 +23,7 @@ files:
 - lib/my_list.rb
 - lib/playlist.rb
 - lib/rec.rb
+- lib/tutorial.rb
 - lib/user.rb
 - public/users.json
 homepage: