shellify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dc23ed10c36ddf92d2881d109271119d606b8ea380183a1d277353f13693f16
+  data.tar.gz: d66f3374654de5851cf5565a4c2c1ede72971c80a223a2748cc8af6d2f25daf7
+SHA512:
+  metadata.gz: 32d3d1b078e5fe7fa1877cefed381104ce05df8ac2d72b3a23ef984ebba6efac5a3e37e2f6de70c5ece2495dd16cec8228a6db385235d43a67309d78da0a0f6e
+  data.tar.gz: 8d80c7a94c9ebc89408236324e3b2f6f2f10f3ce15bb26b88a012ac9ac5d91eb6e9f198553f34646e1f43d92341a35e81f3103b04c77ce64abd4d8e513e803cd

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Derek Povah <http://derekpovah.com>
+
+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.

data/README.md

@@ -0,0 +1,56 @@
+Shellify
+========
+
+Use Spotify from the command line
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```bash
+$ gem install shellify
+```
+
+#### Setup
+
+1. Create a Spotify application in the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard).
+1. Get your Spotify OAUTH `access_token` and `refresh_token`. (Shelilfy currently doesn't currently implement a two way OAUTH flow, but Spotify has [sample apps](https://github.com/spotify/web-api-auth-examples) that you can use  to get your initial keys. Shellify will handle exchanging refresh tokens for access tokens after initial setup.)
+1. Create two json files in `~/.config/shellify`
+    `config.json`
+    ```json
+    {
+      "client_id": "xxxxxxxxxxxxxxxx",
+      "client_secret": "xxxxxxxxxxxxxxx"
+    }
+    ```
+
+    `spotify_user.json`
+    ```json
+    {
+      "id": "spotify_user_id",
+      "token": "xxxxxxxxxxxxxxx",
+      "refresh_token": "xxxxxxxxxxxxxxx"
+    }
+    ```
+
+Commands
+--------
+
+```
+$ shellify
+  Now Playing:
+  3 Libras - A Perfect Circle - 02:24/03:39 - ♥
+```
+
+See `shellify help` for a full list of commands.
+
+RSpotify
+--------
+
+Shellify is basically a just a wrapper for [RSpotify](https://github.com/guilhermesad/rspotify) and wouldn't be possible (without significantly more effort) thanks to the work that's already been done over there.
+
+License
+-------
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/shellify

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'shellify'
+
+begin
+  Shellify::Cli.new.run
+rescue Interrupt
+  exit 1
+end

data/lib/shellify/cli.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'commander'
+require 'shellify/utils'
+
+module Shellify
+  class Cli
+    include Commander::Methods
+    include Shellify::Utils
+
+    def initialize
+      $VERBOSE = nil # Suppress warnings from RSpotify's rest-client implementation by default
+      @config = Shellify::Config.new
+      @user = Shellify::User.new(@config.config_dir)
+    end
+
+    def run
+      program :name, 'Shellify'
+      program :version, Shellify::VERSION
+      program :description, 'Use Spotify from the command line'
+
+      command :devices do |c|
+        c.description = 'List available playback devices'
+        c.action do
+          devices = @user.devices
+          devices.each do |device|
+            puts "  #{device.name}#{" - \e[1m𝅘𝅥𝅮\e[22m" if device.is_active}"
+          end
+        end
+      end
+
+      command :playing do |c|
+        c.description = 'List information about the current song'
+        c.action do
+          return puts "  Nothing playing" unless @user.player.playing?
+
+          print_current_song
+        end
+      end
+
+      command :volume do |c|
+        c.description = 'Set the volume of the current playback device'
+        c.action do |args, options|
+          @user.player.volume(args[0])
+        end
+      end
+
+      command :like do |c|
+        c.description = 'Save the current song to your library'
+        c.action do
+          @user.save_tracks!([@user.player.currently_playing])
+        end
+      end
+
+      command :unlike do |c|
+        c.description = 'Remove the current song from your library'
+        c.action do
+          @user.remove_tracks!([@user.player.currently_playing])
+        end
+      end
+
+      command :playlists do |c|
+        c.description = 'List your playlists'
+        c.action do
+          @user.playlists.each do |playlist|
+            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.action do |args, options|
+          return puts "  Nothing playing" unless @user.player.playing?
+
+          playlist = @user.playlists.find { |p| p.name == args[0] }
+          return puts "  Playlist not found" unless playlist
+
+          playlist.add_tracks!([@user.player.currently_playing])
+        end
+      end
+
+      command :remove do |c|
+        c.description = 'Remove the currently playing song from the provided playlist'
+        c.action do |args, options|
+          return puts "  Nothing playing" unless @user.player.playing?
+
+          playlist = @user.playlists.find { |p| p.name == args[0] }
+          return puts "  Playlist not found" unless playlist
+
+          playlist.remove_tracks!([@user.player.currently_playing])
+        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)
+          end
+        end
+      end
+
+      command :next do |c|
+        c.description = 'Skip to the next song in the queue'
+        c.action do
+          @user.player.next
+          print_current_song
+        end
+      end
+
+      command :previous do |c|
+        c.description = 'Skip the the previous song in the queue'
+        c.action do
+          @user.player.previous
+          print_current_song
+        end
+      end
+
+      command :restart do |c|
+        c.description = 'Restart the currently playing song'
+        c.action do
+          @user.player.seek 0
+          print_current_song
+        end
+      end
+
+      command :seek do |c|
+        c.description = 'Seek to the specified time in the current song'
+        c.action do |args, option|
+          @user.player.seek(time_to_ms(args[0]))
+          print_current_song
+        end
+      end
+
+      default_command :playing
+      alias_command :pause, :play
+      alias_command :back, :previous
+      alias_command :skip, :next
+
+      run!
+    end
+
+    private
+
+    def print_current_song
+      playing = @user.player.currently_playing
+      puts '  Now Playing:'
+      puts "  #{playing.name} - #{playing.artists.first.name} - "\
+           "#{duration_to_s(@user.player.progress)}/#{duration_to_s(playing.duration_ms)}"\
+           "#{" - ♥" if @user.saved_tracks?([playing]).first}"
+    end
+
+    def exit_with_message(message, code = 1)
+      puts message
+      exit code
+    end
+  end
+end

data/lib/shellify/config.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Shellify
+  class Config
+    attr_reader :client_id, :client_secret, :config_dir
+
+    CONFIG_DIR = ENV['HOME'] + '/.config/shellify'
+    CONFIG_FILE = CONFIG_DIR + '/config.json'
+
+    def initialize
+      @config_dir = CONFIG_DIR
+      @config_file = CONFIG_FILE
+      create_config_file
+      load_config
+      RSpotify.authenticate(@client_id, @client_secret)
+    end
+
+    private
+
+    def load_config
+      JSON.parse(File.read(CONFIG_FILE)).each_pair { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+    def create_config_file
+      return if File.exists?(CONFIG_FILE)
+
+      FileUtils.mkdir_p(CONFIG_DIR)
+      FileUtils.touch(CONFIG_FILE)
+      write_default_config
+    end
+
+    def write_default_config
+      File.open(CONFIG_FILE, 'w') do |file|
+      file.write(JSON.pretty_generate({client_id: '', client_secret: ''}))
+      end
+    end
+  end
+end

data/lib/shellify/user.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Shellify
+  class User < RSpotify::User
+
+    USER_FILE = '/spotify_user.json'
+
+    def initialize(config_dir)
+      @config_dir = config_dir
+      create_user_file
+      @spotify_user = load_persisted_user
+      super({
+        'credentials' => {
+          'token' => @spotify_user.token,
+          'refresh_token' => @spotify_user.refresh_token,
+          'access_refresh_callback' => access_refresh_callback,
+        },
+        'id' => @spotify_user.id,
+      })
+    end
+
+    private
+
+    def load_persisted_user
+      OpenStruct.new(JSON.parse(File.read(@config_dir + USER_FILE)))
+    end
+
+    def persist_user(access_token)
+      @spotify_user.token = access_token
+
+      File.open(@config_dir + USER_FILE, 'w') do |file|
+        file.write(JSON.pretty_generate(@spotify_user.to_h))
+      end
+    end
+
+    def access_refresh_callback
+      Proc.new do |new_access_token, _token_lifetime|
+        persist_user(new_access_token)
+      end
+    end
+
+    def create_user_file
+      return if File.exists?(@config_dir + USER_FILE)
+
+      FileUtils.mkdir_p(CONFIG_DIR)
+      FileUtils.touch(@config_dir + USER_FILE)
+    end
+  end
+end

data/lib/shellify/utils.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Shellify
+  module Utils
+    def duration_to_s(duration)
+      secs, _millis = duration.divmod(1000)
+      mins, secs = secs.divmod(60)
+      hours, mins = mins.divmod(60)
+      hours = nil if hours.zero?
+      [hours, mins, secs].compact.map { |s| s.to_s.rjust(2, '0') }.join(':')
+    end
+
+    def time_to_ms(time)
+      time.split(':').map { |a| a.to_i }.inject(0) { |a, b| a * 60 + b} * 1000
+    end
+  end
+end

data/lib/shellify/version.rb

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

data/lib/shellify.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+require 'rspotify'
+require 'shellify/version'
+
+module Shellify
+  autoload :Cli,     'shellify/cli'
+  autoload :Config,  'shellify/config'
+  autoload :User,    'shellify/user'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: shellify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Derek Povah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
+  name: rspotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+description: 
+email:
+- derek@derekpovah.com
+executables:
+- shellify
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/shellify
+- lib/shellify.rb
+- lib/shellify/cli.rb
+- lib/shellify/config.rb
+- lib/shellify/user.rb
+- lib/shellify/utils.rb
+- lib/shellify/version.rb
+homepage: https://github.com/derekpovah/shellify
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/derekpovah/shellify
+  source_code_uri: https://github.com/derekpovah/shellify
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Use Spotify from the command line
+test_files: []