spotify_cli 0.1.0

data/lib/dex/ui/terminal.rb

@@ -0,0 +1,18 @@
+require 'dex/ui'
+require 'io/console'
+
+module Dex
+  module UI
+    module Terminal
+      def self.width
+        if console = IO.console
+          console.winsize[1]
+        else
+          80
+        end
+      rescue Errno::EIO
+        80
+      end
+    end
+  end
+end

data/lib/dex/ui.rb

@@ -0,0 +1,83 @@
+module Dex
+  module UI
+    autoload :ANSI,           'dex/ui/ansi'
+    autoload :Glyph,          'dex/ui/glyph'
+    autoload :Color,          'dex/ui/color'
+    autoload :Box,            'dex/ui/box'
+    autoload :Frame,          'dex/ui/frame'
+    autoload :Progress,       'dex/ui/progress'
+    autoload :Prompt,         'dex/ui/prompt'
+    autoload :Terminal,       'dex/ui/terminal'
+    autoload :Formatter,      'dex/ui/formatter'
+    autoload :Spinner,        'dex/ui/spinner'
+
+    # TODO: this, better
+    SpinGroup = Spinner::SpinGroup
+
+    # TODO: test
+    def self.glyph(handle)
+      Dex::UI::Glyph.lookup(handle)
+    end
+
+    # TODO: test
+    def self.resolve_color(input)
+      case input
+      when Symbol
+        Dex::UI::Color.lookup(input)
+      else
+        input
+      end
+    end
+
+    def self.confirm(question)
+      Dex::UI::Prompt.confirm(question)
+    end
+
+    def self.ask(question, **kwargs)
+      Dex::UI::Prompt.ask(question, **kwargs)
+    end
+
+    def self.resolve_text(input)
+      return input if input.nil?
+      Dex::UI::Formatter.new(input).format
+    end
+
+    def self.fmt(input, enable_color: true)
+      Dex::UI::Formatter.new(input).format(enable_color: enable_color)
+    end
+
+    def self.frame(*args, &block)
+      Dex::UI::Frame.open(*args, &block)
+    end
+
+    def self.spinner(*args, &block)
+      Dex::UI::Spinner.spin(*args, &block)
+    end
+
+    def self.with_frame_color(color, &block)
+      Dex::UI::Frame.with_frame_color_override(color, &block)
+    end
+
+    def self.log_output_to(path)
+      if Dex::UI::StdoutRouter.duplicate_output_to
+        raise "multiple logs not allowed"
+      end
+      Dex::UI::StdoutRouter.duplicate_output_to = File.open(path, 'w')
+      yield
+    ensure
+      f = Dex::UI::StdoutRouter.duplicate_output_to
+      f.close
+      Dex::UI::StdoutRouter.duplicate_output_to = nil
+    end
+
+    def self.raw
+      prev = Thread.current[:no_dexui_frame_inset]
+      Thread.current[:no_dexui_frame_inset] = true
+      yield
+    ensure
+      Thread.current[:no_dexui_frame_inset] = prev
+    end
+  end
+end
+
+require 'dex/ui/stdout_router'

data/lib/helpers/doc.rb

@@ -0,0 +1,62 @@
+module MethodAddedHook
+  private
+
+  def method_added(meth)
+    method_added_hook(meth)
+    super
+  end
+
+  def singleton_method_added(meth)
+    method_added_hook(meth)
+    super
+  end
+
+  def method_added_hook(meth)
+    @@__last_defined_doc__ ||= nil
+    return if !defined?(@@__last_defined_doc__) || @@__last_defined_doc__.nil?
+    @@__class_docs__ ||= {}
+    @@__class_docs__[self.to_s] ||= {}
+
+    @@__class_docs__[self.to_s][meth] = @@__last_defined_doc__
+    @@__last_defined_doc__ = nil
+  end
+end
+
+class Module
+  private
+  prepend MethodAddedHook
+
+  def doc(str, meth = nil)
+    return @@__class_docs__[self.to_s][meth] = str if meth
+    @@__last_defined_doc__ = str
+  end
+
+  def defdoc(str, meth, &block)
+    @@__class_docs__[self.to_s][meth] = str
+    define_method(meth, &block)
+  end
+end
+
+module Kernel
+  def get_doc(klass, meth)
+    docs = klass.class_variable_get(:@@__class_docs__)
+    docs[self.to_s][meth.to_sym] if docs && docs[self.to_s]
+  end
+end
+
+
+class String
+  # The following methods is taken from activesupport
+  #
+  # https://github.com/rails/rails/blob/d66e7835bea9505f7003e5038aa19b6ea95ceea1/activesupport/lib/active_support/core_ext/string/strip.rb
+  #
+  # All credit for this method goes to the original authors.
+  # The code is used under the MIT license.
+  #
+  # Strips indentation by removing the amount of leading whitespace in the least indented
+  # non-empty line in the whole string
+  #
+  def strip_heredoc
+    self.gsub(/^#{self.scan(/^[ \t]*(?=\S)/).min}/, "".freeze)
+  end
+end

data/lib/spotify_cli/api.rb

@@ -0,0 +1,182 @@
+require 'spotify_cli/app'
+require 'helpers/doc'
+
+module SpotifyCli
+  class Api
+    PLAY = "▶"
+    STOP = "◼"
+
+    SPOTIFY_SEARCH_API = "https://api.spotify.com/v1/search"
+
+    class << self
+      doc <<-EOF
+      Changes to the next song
+
+      {{bold:Usage:}}
+        {{command:spotify next}}
+      EOF
+      def next
+        puts "Playing next song"
+        SpotifyCli::App.next!
+      end
+
+      doc <<-EOF
+      Changes to the previous song
+
+      {{bold:Usage:}}
+        {{command:spotify previous}}
+      EOF
+      def previous
+        puts "Playing previous song"
+        SpotifyCli::App.prev!
+      end
+
+      doc <<-EOF
+      Sets the position in the song
+
+      {{bold:Usage:}}
+        {{command:spotify set_pos 60}}
+      EOF
+      def set_pos
+        puts "Setting position to #{ARGV[1]}"
+        SpotifyCli::App.set_pos!(ARGV[1])
+      end
+
+      doc <<-EOF
+      Replays the current song
+
+      {{bold:Usage:}}
+        {{command:spotify replay}}
+      EOF
+      def replay
+        puts "Restarting song"
+        SpotifyCli::App.replay!
+      end
+      
+      doc <<-EOF
+      Play/Pause the current song, or play a specified artist,
+      track, album, or uri
+      
+      {{bold:Usage:}}
+        {{command:spotify play artist [name]}}
+        {{command:spotify play track [name]}}
+        {{command:spotify play album [name]}}
+        {{command:spotify play uri [spotify uri]}}
+      EOF
+      def play_pause
+        args = ARGV[1..-1]
+
+        if args.empty?
+          # no specifying paremeter, this is a standard play/pause
+          SpotifyCli::App.play_pause!
+          status
+          return
+        end
+
+        arg = args.shift
+        type = arg == 'song' ? 'track' : arg
+
+        Dex::UI.frame("Searching for #{type}", timing: false) do
+          play_uri = case type
+          when 'album', 'artist', 'track'
+            results = search_and_play(type: type, query: args.join(' '))
+            results.first
+          when 'uri'
+            args.first
+          end
+          puts "Results found, playing"
+          SpotifyCli::App.play_uri!(play_uri)
+          sleep 0.05 # Give time for the app to switch otherwise status may be stale
+        end
+
+        status
+      end
+
+      doc <<-EOF
+      Pause/stop the current song
+
+      {{bold:Usage:}}
+        {{command:spotify pause}}
+        {{command:spotify stop}}
+      EOF
+      def pause
+        SpotifyCli::App.pause!
+        status
+      end
+
+      doc <<-EOF
+      Show the current song
+
+      {{bold:Usage:}}
+        {{command:spotify status}}
+      EOF
+      def status
+        stat = SpotifyCli::App.status
+
+        time = "#{stat[:position]} / #{stat[:duration]}"
+        state_sym = case stat[:state]
+        when 'playing'
+          PLAY
+        else
+          STOP
+        end
+        # 3 for padding around time, and symbol, and space for the symbol, 2 for frame
+        width = Dex::UI::Terminal.width - time.size - 5
+
+        Dex::UI.frame(stat[:track], timing: false) do
+          puts Dex::UI.resolve_text([
+            "{{bold:Artist:}} #{stat[:artist]}",
+            "{{bold:Album:}} #{stat[:album]}",
+          ].join("\n"))
+          puts [
+            Dex::UI::Progress.progress(stat[:percent_done], width),
+            state_sym,
+            time
+          ].join(' ')
+        end
+      end
+
+      doc <<-EOF
+      Display Help
+
+      {{bold:Usage:}}
+       {{command:spotify}}
+       {{command:spotify help}}
+      EOF
+      def help(mappings)
+        Dex::UI.frame('Spotify CLI', timing: false) do
+          puts "CLI interface for Spotify"
+        end
+
+        mappings.group_by { |_,v| v }.each do |k, v|
+          v.reject! { |mapping| mapping.first == k.to_s }
+          doc = get_doc(self.class, k.to_s).strip_heredoc
+
+          Dex::UI.frame(k, timing: false) do
+            puts puts Dex::UI.resolve_text(doc)
+            next if v.empty?
+            puts Dex::UI.resolve_text("{{bold:Aliases:}}")
+            v.each { |mapping| puts Dex::UI.resolve_text(" - {{info:#{mapping.first}}}") }
+          end
+        end
+      end
+
+      private
+
+      def search_and_play(args)
+        type = args[:type]
+        type2 = args[:type2] || type
+        query = args[:query]
+        limit = args[:limit] || 1
+        puts "Searching #{type}s for: #{query}";
+
+        curl_cmd = <<-EOF
+        curl -s -G #{SPOTIFY_SEARCH_API} --data-urlencode "q=#{query}" -d "type=#{type}&limit=#{limit}&offset=0" -H "Accept: application/json" \
+        | grep -E -o "spotify:#{type2}:[a-zA-Z0-9]+" -m #{limit}
+        EOF
+
+        `#{curl_cmd}`.strip.split("\n")
+      end
+    end
+  end
+end

data/lib/spotify_cli/app.rb

@@ -0,0 +1,101 @@
+module SpotifyCli
+  class App
+    def self.state
+      oascript('tell application "Spotify" to player state as string')
+    end
+
+    def self.status
+      artist = oascript('tell application "Spotify" to artist of current track as string')
+      album = oascript('tell application "Spotify" to album of current track as string')
+      track = oascript('tell application "Spotify" to name of current track as string')
+      duration = oascript(<<-EOF)
+        tell application "Spotify"
+        set durSec to (duration of current track / 1000) as text
+        set tM to (round (durSec / 60) rounding down) as text
+        if length of ((durSec mod 60 div 1) as text) is greater than 1 then
+            set tS to (durSec mod 60 div 1) as text
+        else
+            set tS to ("0" & (durSec mod 60 div 1)) as text
+        end if
+        set myTime to tM as text & ":" & tS as text
+        end tell
+        return myTime
+      EOF
+      position = oascript(<<-EOF)
+        tell application "Spotify"
+        set pos to player position
+        set nM to (round (pos / 60) rounding down) as text
+        if length of ((round (pos mod 60) rounding down) as text) is greater than 1 then
+            set nS to (round (pos mod 60) rounding down) as text
+        else
+            set nS to ("0" & (round (pos mod 60) rounding down)) as text
+        end if
+        set nowAt to nM as text & ":" & nS as text
+        end tell
+        return nowAt
+      EOF
+
+      {
+        state: state,
+        artist: artist,
+        album: album,
+        track: track,
+        duration: duration,
+        position: position,
+        percent_done: percent_done(position, duration)
+      }
+    end
+
+    def self.play_pause!
+      oascript('tell application "Spotify" to playpause')
+    end
+
+    def self.pause!
+      oascript('tell application "Spotify" to pause')
+    end
+
+    def self.play_uri!(uri)
+      oascript("tell application \"Spotify\" to play track \"#{uri}\"")
+    end
+
+    def self.next!
+      oascript('tell application "Spotify" to next track')
+    end
+
+    def self.set_pos!(pos)
+      oascript("tell application \"Spotify\" to set player position to #{pos}")
+    end
+
+    def self.previous!
+      oascript(<<-EOF)
+      tell application "Spotify"
+          set player position to 0
+          previous track
+      end tell
+      EOF
+    end
+
+    def self.replay!
+      oascript('tell application "Spotify" to set player position to 0')
+    end
+
+    def self.percent_done(position, duration)
+      seconds = ->(parts) do
+        acc = 0
+        multiplier = 1
+        while part = parts.shift
+          acc += part.to_f * multiplier
+          multiplier *= 60
+        end
+        acc
+      end
+      pos_parts = position.split(':').reverse
+      dur_parts = duration.split(':').reverse
+      seconds.call(pos_parts) / seconds.call(dur_parts)
+    end
+
+    def self.oascript(command)
+      `osascript -e '#{command}'`.strip
+    end
+  end
+end

data/lib/spotify_cli/version.rb

@@ -0,0 +1,3 @@
+module SpotifyCli
+  VERSION = "0.1.0"
+end

data/lib/spotify_cli.rb

@@ -0,0 +1,38 @@
+require 'spotify_cli/version'
+require 'dex/ui'
+require 'spotify_cli/api'
+
+module SpotifyCli
+  def self.call(args)
+    mappings = {
+      'next' => :next,
+      'n' => :next,
+      'previous' => :previous,
+      'pr' => :previous,
+      'set_pos' => :set_pos,
+      'pos' => :set_pos,
+      'replay' => :replay,
+      'rep' => :replay,
+      'restart' => :replay,
+      'pause' => :pause,
+      'stop' => :pause,
+      'play' => :play_pause,
+      'p' => :play_pause,
+      'play_pause' => :play_pause,
+      'status' => :status,
+      's' => :status,
+      'help' => :help
+    }
+
+    if args.empty?
+      SpotifyCli::Api.status
+    else
+      mapping = mappings[args.first]
+      if mapping.nil? || mapping == :help
+        SpotifyCli::Api.help(mappings)
+      else
+        SpotifyCli::Api.send(mapping)
+      end
+    end
+  end
+end

data/spotify_cli.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spotify_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spotify_cli"
+  spec.version       = SpotifyCli::VERSION
+  spec.authors       = ["Julian Nadeau"]
+  spec.email         = ["julian@jnadeau.ca"]
+  spec.license       = "MIT"
+
+  spec.summary       = "Spotify Application wrapper for control via command line"
+  spec.description   = "Allow control of Spotify using a pretty UI interface. Intentionally simple."
+  spec.homepage      = "https://github.com/jules2689/spotify_cli"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ['spotify']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: spotify_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Nadeau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Allow control of Spotify using a pretty UI interface. Intentionally simple.
+email:
+- julian@jnadeau.ca
+executables:
+- spotify
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/spotify
+- lib/dex/ui.rb
+- lib/dex/ui/README.md
+- lib/dex/ui/ansi.rb
+- lib/dex/ui/box.rb
+- lib/dex/ui/color.rb
+- lib/dex/ui/formatter.rb
+- lib/dex/ui/frame.rb
+- lib/dex/ui/glyph.rb
+- lib/dex/ui/progress.rb
+- lib/dex/ui/prompt.rb
+- lib/dex/ui/spinner.rb
+- lib/dex/ui/stdout_router.rb
+- lib/dex/ui/terminal.rb
+- lib/helpers/doc.rb
+- lib/spotify_cli.rb
+- lib/spotify_cli/.DS_Store
+- lib/spotify_cli/api.rb
+- lib/spotify_cli/app.rb
+- lib/spotify_cli/version.rb
+- spotify_cli.gemspec
+homepage: https://github.com/jules2689/spotify_cli
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Spotify Application wrapper for control via command line
+test_files: []