Shpotify rewrite #6

dkniffin · 2018-04-27T19:49:16Z

Why?

As noted in Libspotify no longer available #3, libspotify (previously, a large dependency of this project) was deprecated by Spotify a while back. That left this project pretty much unusable in it's previous version. So, in an effort to revive it, I've redesigned it from the ground up.

What changed?

The idea behind this new version of Maestro is very similar to what it was previously, and the usage is similar, but functionally, it's completely different. It is now a Sinatra app that heavily relies on shpotify, a cli tool for interacting with the Spotify desktop client.
The majority of this PR is deleting the old code, and setting up a basic Ruby project. It includes:
- app.rb, which is the actual app code
- A very minimal Gemfile to install Sinatra and a few dev dependencies
- Smashing Boxes' standard rubocop configs
- A readme with instructions for how to use the new app
- Some very basic tests (more to come in future PRs, hopefully)

jahammo2

How are you deploying this? Just going into a server and running the commands yourself? If so, any plans to set up some Ansible configs (not a criticism as to why they're not here yet, just curious)?

Or am I completely wrong and this is just running locally from one of our abandoned macbooks?

jahammo2 · 2018-05-01T15:38:36Z

README.md

+Once you've got a computer to run it on, you can install Maestro by running the following commands
+in a terminal:
+
+```sh


what does sh do?

It marks it as a shell script for syntax highlighting. Shell == bash for most cases

jahammo2

This isn't actually working yet, right? It doesn't look there's anything for actually playing music from Spotify. Or am I missing something?

jahammo2 · 2018-05-01T15:41:49Z

README.md

+- Autocomplete help text:
+  - Check "Show this command in the autocomplete list"
+  - Description: https://github.com/hnarayanan/shpotify
+  - Usage hint: [shpotify command]


Excellent, excellent documentation

jahammo2 · 2018-05-01T15:43:16Z

app.rb

+require "sinatra"
+require "json"
+
+HELP_TEXT = <<~HELP_TEXT.freeze


What's going on here?

The <<~HELP_TEXT part is making it a heredoc. The .freeze is because it's a constant, and with our Rubocop configs, we want to enforce that it doesn't change.

jahammo2 · 2018-05-01T15:43:48Z

app.rb

+  puts "# > spotify #{args}"
+  output = `./spotify.sh #{args}`
+  puts output
+  output = HELP_TEXT unless $?.success?


sinatra stuff?

Nope. The $? is the return value of the command being run via backticks above (./spotify.sh #{args}). More on that here and it returns a Process::Status, which responds to .success?

How is $? catching that? Or is that just some deep Ruby stuff? Or am I completely wrong and this is somehow shell scripts? At least that's what that stack overflow response seems to indicate. I've never seen shell scripts in a ruby file like this before.

Does adding a ? do anything? Can $ stand alone on its own? I ran echo $ and echo ? from my command line and nothing happened. Well, something happened but just what you'd expect.

Apologies for the question peppering but I always learn a lot from your and this is v fascinating to me

This is indeed a ruby file. $? automatically gets assigned by the backticks. This might help a bit: https://stackoverflow.com/a/18623297/1202488

? and $ don't do anything on their own. However, I think there are related variables like $#, but I don't remember what they do offhand

jahammo2 · 2018-05-01T15:44:33Z

app.rb

+end
+
+post "/maestro" do
+  output, success = spotify(params["text"])


oh that's cool

does output == success return true after they're defined?

nope. This is doing destructuring. So output will equal spotify(params["text"])[0] and success will equal spotify(params["text"])[1]

Ahhhhh, sweet. Is there a reason we haven't done this in any of our Rails apps thus far? Just not knowing that this was even possible is a valid answer

I know I've done it before, but I think it just doesn't show up that often. Not sure why

jahammo2 · 2018-05-01T15:45:38Z

spec/maestro_spec.rb

+require "rack/test"
+require "json"
+require "pry-byebug"
+require_relative "../app"


I guess this is one of the downfalls of Sinatra, no?

Somewhat. I don't see a huge problem with it, but I might refactor it at some point later. Rails does have a nice way of handling this, and I'm sure we could set it up similarly here.

jahammo2 · 2018-05-01T15:46:24Z

spec/maestro_spec.rb

+    let(:text) { "help" }
+
+    it "returns the usage text" do
+      expect(last_response).to be_ok


Where is last_response coming from?

It's a rack-test thing: https://github.com/rack-test/rack-test. It's basically the same as response in a normal request spec

And that's available in our Rails apps, right?

yep. It's a dependency of rspec-rails or something

dkniffin · 2018-05-01T15:57:21Z

This is actually working right now. The music playing part happens when we run the shell command via the ./spotify.sh #{args}. That spotify script is shpotify, which is a CLI tool for controlling your local Spotify.app

As for how we're deploying it, right now it's running on a mac mini, and it's all manual. It might be worth writing an ansible script (or maybe just a shell script) to do that, but for now it's manual

dkniffin · 2018-05-01T15:58:21Z

And the reason it's on a mac mini, instead of deployed to heroku or something is that we need to plug speakers into it. The cloud doesn't have a 3.5mm headphone jack, AFAIK

jahammo2 · 2018-05-02T10:19:54Z

bahahahah, I'll let you know if I hear the Cloud:registered: is adding that feature

* Add Spotify class * Improve regex capabilities * Restrict VALID_COMMANDS to public methods

* Implement restart, pause, quit, and toggle Fix case-sensitivity bug when playing by URI

dkniffin · 2018-06-25T15:30:34Z

Unless anyone sees any issues with it, I'm going to merge this PR around 2:00 this Friday (6/29)

dkniffin added 3 commits March 26, 2018 10:31

Rewrite maestro to use shpotify

c243681

Update README.md

e783cf9

Improve help text

29edc8a

dkniffin mentioned this pull request Apr 27, 2018

Developer key site updated #5

Closed

dkniffin added 2 commits April 27, 2018 15:55

Add travis configs

b4030a2

Update README.md

f3a6f2e

dkniffin force-pushed the shpotify-rewrite branch from 5d7b1ad to 48edd67 Compare April 29, 2018 15:24

Added help spec

b988738

dkniffin mentioned this pull request Apr 29, 2018

Return non-zero exit codes for invalid commands hnarayanan/shpotify#99

Closed

Added spec for invalid commands

54913b1

dkniffin force-pushed the shpotify-rewrite branch from 48edd67 to 54913b1 Compare April 30, 2018 17:40

Added rspec to travis configs

a9ef931

jahammo2 reviewed May 1, 2018

View reviewed changes

jahammo2 approved these changes May 1, 2018

View reviewed changes

TylerRockwell added 5 commits May 25, 2018 12:17

OO Spotify Class (#8)

a71a254

* Add Spotify class * Improve regex capabilities * Restrict VALID_COMMANDS to public methods

Add default args to Spotify#play

b177ac2

Vol command now displays current volume

ca833d6

Maestro Restart + URI Bug Fixes (#9)

25b01fc

* Implement restart, pause, quit, and toggle Fix case-sensitivity bug when playing by URI

Properly validate volume arguments (#11)

74c3808

dkniffin merged commit 73c79f3 into master Jun 29, 2018

dkniffin deleted the shpotify-rewrite branch June 29, 2018 18:07

dkniffin mentioned this pull request Jun 29, 2018

Libspotify no longer available #3

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Shpotify rewrite #6

Shpotify rewrite #6

dkniffin commented Apr 27, 2018 •

edited

Loading

jahammo2 left a comment •

edited

Loading

jahammo2 May 1, 2018

dkniffin May 1, 2018

jahammo2 May 2, 2018

jahammo2 left a comment

jahammo2 May 1, 2018

jahammo2 May 1, 2018

dkniffin May 1, 2018

jahammo2 May 2, 2018

jahammo2 May 1, 2018

dkniffin May 1, 2018 •

edited

Loading

jahammo2 May 2, 2018 •

edited

Loading

dkniffin May 2, 2018

jahammo2 May 1, 2018

jahammo2 May 1, 2018

dkniffin May 1, 2018

jahammo2 May 2, 2018

dkniffin May 2, 2018

jahammo2 May 1, 2018

dkniffin May 1, 2018

jahammo2 May 2, 2018

jahammo2 May 1, 2018

dkniffin May 1, 2018

jahammo2 May 2, 2018

dkniffin May 2, 2018

dkniffin commented May 1, 2018

dkniffin commented May 1, 2018

jahammo2 commented May 2, 2018

dkniffin commented Jun 25, 2018

Shpotify rewrite #6

Shpotify rewrite #6

Conversation

dkniffin commented Apr 27, 2018 • edited Loading

Why?

What changed?

jahammo2 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jahammo2 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkniffin May 1, 2018 • edited Loading

Choose a reason for hiding this comment

jahammo2 May 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkniffin commented May 1, 2018

dkniffin commented May 1, 2018

jahammo2 commented May 2, 2018

dkniffin commented Jun 25, 2018

dkniffin commented Apr 27, 2018 •

edited

Loading

jahammo2 left a comment •

edited

Loading

dkniffin May 1, 2018 •

edited

Loading

jahammo2 May 2, 2018 •

edited

Loading