shellify 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b457f8f07a6f855b4cbb3a2839df79780b49760ad264247b6225cb5fe7d0be3
-  data.tar.gz: 5e96c98b637eccc3f1fc4e24808baf60db90deca6eb061810a5db7bddc2d14ce
+  metadata.gz: f62fa09eb7f90e2bc486320a18dc252ffb8a751a6d67e72ce3fb5a149e1965ef
+  data.tar.gz: b9cb6abde7095e6b5f2e358e6962897dbb797b3e90823bfb8c3422b1bacf7766
 SHA512:
-  metadata.gz: bd69fbf66ede7b711ca6d5c24d568272f73ee2cc4303e8a4900dac5f525118e96e9c2e9f1de69e8dad4cf9268d4da103cfc07d9454e5e6c87fab7622135d7ae6
-  data.tar.gz: f162600a265e3e6167caf78480eb9d640a1089a93c6de8deb9739b9e9ea13b639cbc617157eec14cb468cf027a5f40a083957dd651a314346f839aa53c9df162
+  metadata.gz: cd101fc048837d34a1db93c0c36c8ebb3270ea2779628f154309d58837f4d0666ba673b53c954d4b6ca06ee7efdf30fa214f8e561c70a391d1dfc35dba0926fc
+  data.tar.gz: c2fa18b6cebc2eff9ca4406576ba24efb98d77fbfd015ee9d1312b84ac98a4dd7ce0ce0d18f6dd7cf458f8ee32d92514a23734b3ec618d84bc2de83a9533ab9d

data/lib/shellify/cli.rb

@@ -22,8 +22,8 @@ module Shellify
       command :configure do |c|
         c.description = 'Set the Spotify client_id and client_secret'
         c.action do
-          client_id = ask("Spotify Client ID: ")
-          client_secret = ask("Spotify Client Secret: ") { |q| q.echo = '*' }
+          client_id = ask('Spotify Client ID: ')
+          client_secret = ask('Spotify Client Secret: ') { |q| q.echo = '*' }
           @config.client_id = client_id
           @config.client_secret = client_secret
           @config.save!
@@ -58,15 +58,15 @@ module Shellify
       command :playing do |c|
         c.description = 'List information about the current song'
         c.action do
-          return puts "  Nothing playing" unless @user.player.playing?
+          return puts '  Nothing playing' unless @user.player.playing?
 
-          print_current_song
+          print_currently_playing
         end
       end
 
       command :volume do |c|
         c.description = 'Set the volume of the current playback device'
-        c.action do |args, options|
+        c.action do |args, _options|
           @user.player.volume(args[0])
         end
       end
@@ -91,52 +91,73 @@ module Shellify
         c.description = 'List your playlists'
         c.action do
           @user.playlists.each do |playlist|
-            puts "  #{playlist.name} - #{playlist.owner.display_name}#{" - Collaborative" if playlist.collaborative}"
+            puts "  #{playlist.name} - #{playlist.owner.display_name}#{' - Collaborative' if playlist.collaborative}"
           end
         end
       end
 
       command :add do |c|
-        c.description = 'Add the current song to the provided playlist'
+        c.description = 'Add the current song or album to the provided playlist'
+        c.option '-a', '--album'
         c.action do |args, options|
-          return puts "  Nothing playing" unless @user.player.playing?
+          return puts '  Nothing playing' unless @user.player.playing?
 
           exit_with_message(local_track_message, 0) if track_is_local?(playing)
           playlist = @user.playlists.find { |p| p.name == args[0] }
-          return puts "  Playlist not found" unless playlist
-          exit_with_message(add_to_collaborative_playlist_message, 0) if playlist.owner != @user
+          return puts '  Playlist not found' unless playlist
+
+          exit_with_message(add_to_collaborative_playlist_message, 0) if playlist.owner.id != @user.id
+
+          item = options.album ? playing.album.tracks : [playing]
+          playlist.add_tracks!(item)
+        end
+      end
 
-          playlist.add_tracks!([playing])
+      command :queue do |c|
+        c.description = 'List the next songs in the queue'
+        c.action do
+          items = @user.player.next_up
+          exit_with_message('  Nothing in the queue', 0) if items.empty?
+          items.each.with_index(1) do |item, i|
+            case item.type
+            when 'episode'
+              puts "  #{i.to_s.rjust(items.size.to_s.size, ' ')} - #{item.name} - #{item.show.name}"
+            when 'track'
+              puts "  #{i.to_s.rjust(items.size.to_s.size, ' ')} - #{item.name} - "\
+                   "#{item.artists.map(&:name).join(', ')}"
+            end
+          end
         end
       end
 
       command :remove do |c|
-        c.description = 'Remove the currently playing song from the provided playlist'
+        c.description = 'Remove the currently playing song or album from the provided playlist'
+        c.option '-a', '--album'
         c.action do |args, options|
-          return puts "  Nothing playing" unless @user.player.playing?
+          return puts '  Nothing playing' unless @user.player.playing?
 
           exit_with_message(local_track_message, 0) if track_is_local?(playing)
           playlist = @user.playlists.find { |p| p.name == args[0] }
-          return puts "  Playlist not found" unless playlist
-          exit_with_message(add_to_collaborative_playlist_message, 0) if playlist.owner != @user
+          return puts '  Playlist not found' unless playlist
+
+          exit_with_message(add_to_collaborative_playlist_message, 0) if playlist.owner.id != @user.id
 
-          playlist.remove_tracks!([playing])
+          item = options.album ? playing.album.tracks : [playing]
+          playlist.remove_tracks!(item)
         end
       end
 
       command :play do |c|
         c.description = 'Play or Pause on the currently playing device'
         c.action do
-          begin
-            if @user.player.playing?
-              @user.player.pause
-            else
-              @user.player.play
-              print_current_song
-            end
-          rescue RestClient::NotFound
-            @user.player.play(@user.devices.first.id)
+          if @user.player.playing?
+            @user.player.pause
+          else
+            @user.player.play
+            print_currently_playing
           end
+        rescue RestClient::NotFound
+          @user.player.play(@user.devices.first.id)
         end
       end
 
@@ -144,7 +165,7 @@ module Shellify
         c.description = 'Skip to the next song in the queue'
         c.action do
           @user.player.next
-          print_current_song
+          print_currently_playing
         end
       end
 
@@ -152,7 +173,7 @@ module Shellify
         c.description = 'Skip the the previous song in the queue'
         c.action do
           @user.player.previous
-          print_current_song
+          print_currently_playing
         end
       end
 
@@ -160,15 +181,15 @@ module Shellify
         c.description = 'Restart the currently playing song'
         c.action do
           @user.player.seek 0
-          print_current_song
+          print_currently_playing
         end
       end
 
       command :seek do |c|
         c.description = 'Seek to the specified time in the current song'
-        c.action do |args, option|
+        c.action do |args, _option|
           @user.player.seek(time_to_ms(args[0]))
-          print_current_song
+          print_currently_playing
         end
       end
 
@@ -191,20 +212,28 @@ module Shellify
     end
 
     def add_to_collaborative_playlist_message
-      " Shellify can't perform this action for collaborative playlists you don't own"
+      "  Shellify can't perform this action for collaborative playlists you don't own"
     end
 
     def track_is_local?(track)
       track.uri.split(':')[1] == 'local'
     end
 
-    def print_current_song
-      puts '  Now Playing:'
-      puts "  #{playing.name} - #{playing.artists.first.name} - "\
-           "#{duration_to_s(@user.player.progress)}/#{duration_to_s(playing.duration_ms)}"\
-           "#{" - ♥" if !track_is_local?(playing) && @user.saved_tracks?([playing]).first}"\
-           "#{" - local" if track_is_local?(playing)}"
+    def current_song
+      puts "Now Playing - #{duration_to_s(@user.player.progress)}/#{duration_to_s(playing.duration_ms)}"\
+           "#{' - ♥' if !track_is_local?(playing) && @user.saved_tracks?([playing]).first}"\
+           "#{' - local' if track_is_local?(playing)}\n"\
+           "  #{playing.name}\n"\
+           "  #{playing.album.name}\n"\
+           "  #{playing.artists.map(&:name).join(', ')}"
+    end
 
+    def print_currently_playing
+      if playing.nil?
+        puts "Now Playing - Podcast - #{duration_to_s(@user.player.progress)}"
+      else
+        current_song
+      end
     end
 
     def exit_with_message(message, code = 1)

data/lib/shellify/config.rb

@@ -4,8 +4,8 @@ module Shellify
   class Config
     attr_accessor :client_id, :client_secret, :config_dir
 
-    CONFIG_DIR = ENV['HOME'] + '/.config/shellify'
-    CONFIG_FILE = CONFIG_DIR + '/config.json'
+    CONFIG_DIR = "#{ENV['HOME']}/.config/shellify"
+    CONFIG_FILE = "#{CONFIG_DIR}/config.json"
     SPOTIFY_AUTHORIZATION_SCOPES = %w[
       user-read-playback-state
       user-modify-playback-state
@@ -31,16 +31,16 @@ module Shellify
 
     def save!
       File.open(CONFIG_FILE, 'w') do |file|
-        file.write(JSON.pretty_generate({client_id: @client_id, client_secret: @client_secret}))
+        file.write(JSON.pretty_generate({ client_id: @client_id, client_secret: @client_secret }))
       end
     end
 
     private
 
     def load_config
-      return unless File.exists?(CONFIG_FILE)
+      return unless File.exist?(CONFIG_FILE)
 
-      JSON.parse(File.read(CONFIG_FILE)).each_pair { |k,v| instance_variable_set("@#{k}", v) }
+      JSON.parse(File.read(CONFIG_FILE)).each_pair { |k, v| instance_variable_set("@#{k}", v) }
     end
   end
 end

data/lib/shellify/oauth_callback_handler.rb

@@ -25,7 +25,7 @@ module Shellify
       begin
         tokens = fetch_tokens(params['code'])
       rescue RestClient::Exception => e
-        body = "Spotify didn't like that\n" + e.response
+        body = "Spotify didn't like that\n#{e.response}"
       end
 
       @client.puts headers(body.length)
@@ -41,7 +41,7 @@ module Shellify
     def headers(content_length)
       [
         'HTTP/1.1 200 Ok',
-        "date: #{Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S GMT")}",
+        "date: #{Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')}",
         'server: ruby',
         "Content-Length: #{content_length}",
         '',
@@ -51,7 +51,7 @@ module Shellify
 
     def fetch_tokens(code)
       headers = {
-        'Authorization': "Basic " + Base64.strict_encode64("#{@config.client_id}:#{@config.client_secret}"),
+        'Authorization': 'Basic ' + Base64.strict_encode64("#{@config.client_id}:#{@config.client_secret}"),
       }
 
       params = {
@@ -62,7 +62,7 @@ module Shellify
         code: code,
       }
 
-      JSON.parse(RestClient.post("https://accounts.spotify.com/api/token", params, headers))
+      JSON.parse(RestClient.post('https://accounts.spotify.com/api/token', params, headers))
     end
   end
 end

data/lib/shellify/rspotify_patch.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RSpotify
+  class Player
+    def next_up
+      url = 'me/player/queue'
+      response = User.oauth_get(@user.id, url)
+      return response if RSpotify.raw_response
+
+      response['queue'].map do |item|
+        type_class = RSpotify.const_get(item['type'].capitalize)
+        type_class.new item
+      end
+    end
+
+    def currently_playing
+      url = 'me/player/currently-playing'
+      response = User.oauth_get(@user.id, url)
+      return response if RSpotify.raw_response
+
+      type_class = RSpotify.const_get(response['currently_playing_type'].capitalize)
+      type_class.new response['item'] unless response['item'].nil?
+    end
+  end
+end

data/lib/shellify/user.rb

@@ -28,25 +28,25 @@ module Shellify
 
     def save!
       File.open(@user_file_path, 'w') do |file|
-        file.write(JSON.pretty_generate({id: @id, token: @token, refresh_token: @refresh_token}))
+        file.write(JSON.pretty_generate({ id: @id, token: @token, refresh_token: @refresh_token }))
       end
     end
 
     private
 
     def load_persisted_user
-      JSON.parse(File.read(@user_file_path)).each_pair { |k,v| instance_variable_set("@#{k}", v) }
+      JSON.parse(File.read(@user_file_path)).each_pair { |k, v| instance_variable_set("@#{k}", v) }
     end
 
     def access_refresh_callback
-      Proc.new do |new_access_token, _token_lifetime|
+      proc do |new_access_token, _token_lifetime|
         @token = new_access_token
         save!
       end
     end
 
     def create_user_file
-      return if File.exists?(@user_file_path)
+      return if File.exist?(@user_file_path)
 
       FileUtils.mkdir_p(@config_dir)
       FileUtils.touch(@user_file_path)
@@ -56,7 +56,7 @@ module Shellify
       return unless File.zero?(@user_file_path)
 
       File.open(@user_file_path, 'w') do |file|
-        file.write(JSON.pretty_generate({id: '', token: '', refresh_token: '',}))
+        file.write(JSON.pretty_generate({ id: '', token: '', refresh_token: '' }))
       end
     end
   end

data/lib/shellify/utils.rb

@@ -14,7 +14,7 @@ module Shellify
     end
 
     def time_to_ms(time)
-      time.split(':').map { |a| a.to_i }.inject(0) { |a, b| a * 60 + b} * 1000
+      time.split(':').map(&:to_i).inject(0) { |a, b| a * 60 + b } * 1000
     end
 
     def generate_oauth_url

data/lib/shellify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shellify
-  VERSION = '1.1.2'
+  VERSION = '1.3.0'
 end

data/lib/shellify.rb

@@ -3,6 +3,7 @@
 require 'fileutils'
 require 'json'
 require 'rspotify'
+require 'shellify/rspotify_patch'
 require 'shellify/version'
 
 module Shellify

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellify
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Derek Povah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -81,6 +81,7 @@ files:
 - lib/shellify/cli.rb
 - lib/shellify/config.rb
 - lib/shellify/oauth_callback_handler.rb
+- lib/shellify/rspotify_patch.rb
 - lib/shellify/user.rb
 - lib/shellify/utils.rb
 - lib/shellify/version.rb
@@ -99,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: Use Spotify from the command line