itc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbb1fbc96993d0b0cb77574b931c1ea62d2dbee8
+  data.tar.gz: 5d5b693c549eb9e7e01ca6364ce6fc09569dd3a7
+SHA512:
+  metadata.gz: db27c20f1615babc9460ea5c33ee0412384190382b244fb58c6cc405bfc0766b27605c86311bbb82dee18d578db94af81cd34e0fe52099390aad0d726fa12cf7
+  data.tar.gz: 561aec5e3943d49608fd9ff6933c37a7c26da316f2f798b0a2a6ada4082bf877ee94d44425109d3ed86cecdeec9e46e427b2dfffb00a0782e735006b3f4feede

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014, Ragnar B. Johannsson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,74 @@
+## Itc
+
+Itc is an iTunes command line client. It indexes iTunes' Music Library XML file into a SQLite3 database for faster lookup and provides shell tab completion for metadata.
+
+
+### Installation
+
+Install the gem:
+
+    $ gem install itc
+
+Copy the tab completion definitions under `extra/completion/` to the appropriate paths for your system and shell.
+
+
+### Usage
+
+After installing, start by indexing the iTunes Music Library:
+
+    $ itc index
+
+This generates a SQLite3 database in `$HOME/.itc.db` which will act as a cache for the iTunes Music Library XML files. Rerun the index command after adding new content to iTunes. Alternatively, add it to crontab to keep things in sync. 
+
+After indexing you can start querying the library:
+
+    $ itc list artist
+
+will return a list of all artists in the library.
+
+    $ itc play artist=Daft\ Punk
+
+will start to play all songs and albums by Daft Punk in the Library.
+
+    $ itc play artist=Ibrahim\ Maalouf album=Wind
+
+will play the album Wind by Ibrahim Maalouf. Notice that if the tab completions are installed there is no need to laboriously spell out full names for the filters as they will tab complete just fine.
+
+Recognized filters for the **list** and **play** commands are `artist`, `album`, `song`, `year` and `genre`. 
+
+Following are all recognized commands:
+
+* **index** - (Re)index the music database
+* **list** - Search for tracks
+* **next** - Skip to next song
+* **pause** - Pause playing
+* **play** - Commence playing
+* **previous** - Go back one song
+* **status** - Show playing status, playlist position
+
+To gauge the position within the current album or playlist use the **status** command:
+
+    $ itc play artist=Emika album=DVA
+    $ itc next 
+    $ itc status
+       Emika - DVA - Hush (Interlude) feat. Michaela Srumova
+     ▶ Emika - DVA - Young Minds
+       Emika - DVA - She Beats
+       Emika - DVA - Filters
+       Emika - DVA - After The Fall
+       Emika - DVA - Sing To Me
+       Emika - DVA - Dem Worlds
+       Emika - DVA - Primary Colours
+       Emika - DVA - Sleep With My Enemies
+       Emika - DVA - Wicked Game
+       Emika - DVA - Fight For Your Love
+       Emika - DVA - Mouth To Mouth
+       Emika - DVA - Searching
+       Emika - DVA - Centuries
+       Emika - DVA - Criminal Gift
+    $
+
+
+### License
+
+BSD 2-Clause. See the LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/itc

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'itc'
+
+def usage(msg="")
+    puts "Error: #{msg}\n\n" unless msg == ""
+
+    puts <<-USAGE.gsub(/^    /, "")
+    Usage: itc <command> [filters...]
+
+    Commands:
+        help        - This message
+        index       - (Re)index the music database
+        list        - Search for tracks
+        next        - Next song
+        pause       - Pause playing
+        play        - Play
+        previous    - Previous song
+        status      - Playing status, playlist position
+
+    Filters (valid with play and list commands):
+        artist      - Artist name
+        album       - Album name
+        song        - Song name
+        year        - Release yeaar
+        genre       - Genre name
+
+    USAGE
+
+    exit msg == "" ? 0 : 1
+end
+
+usage "No command specified" if ARGV.size() < 1
+
+begin
+    cmd = ARGV.shift
+    filters = {}
+
+    usage if cmd == "help"
+
+    while action = ARGV.shift do
+        sp = action.split("=", 2)
+        filters[sp[0]] = sp.size() == 1 ? "" : sp[1]
+    end 
+
+    Command.execute cmd, filters
+rescue InvalidFilterNumberException => e
+    usage e.message
+rescue UnknownFilterException => e
+    usage "Unknown filter #{e.message}"
+rescue UnknownCommandException 
+    usage "Unknown command #{cmd}"
+end
+

data/extra/completion/zsh/_itc

@@ -0,0 +1,53 @@
+#compdef itc
+
+local context state state_descr line expl list_item
+local -a commands
+local -A opt_args
+
+function _itc_list {
+    local i filters=""
+    for i in {2..$#line}; do
+        if [[ ! $line[$i] == $list_item* ]]; then
+            filters="${filters}$line[$i] "
+        fi
+    done
+
+    local cmd item IFS=$'\n'
+    cmd="itc list $filters $list_item"
+    for item in $(eval ${cmd}); do
+        compadd $expl[@] -- $item
+    done
+
+    return 0
+}
+
+_arguments '1:command:->cmds' '*:filter:->filters' && ret=0
+
+case "$state" in
+    (cmds)
+        commands=(
+            'list:Search for tracks' \
+            'status:Show playing status, playlist position' \
+            'play:Play' \
+            'index:(Re)index the music database' \
+            'next:Next song' \
+            'previous:Previous song' \
+            'pause:Pause playing')
+        _describe 'values' commands
+        ;;
+    (filters)
+        case "$line[1]" in
+            (play)
+                ;&
+            (list)
+                _values -w 'option' \
+                    'artist[Artist name]:artist:{list_item=artist _itc_list}' \
+                    'album[Album name]:album:{list_item=album _itc_list}' \
+                    'song[Song name]:song:{list_item=song _itc_list}' \
+                    'genre[Genre name]:genre:{list_item=genre _itc_list}' \
+                    'year[Release year]:year:{list_item=year _itc_list}'
+                ;;
+        esac
+        ;;
+esac
+

data/itc.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'itc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "itc"
+  spec.version       = Itc::VERSION
+  spec.authors       = ["Ragnar B. Johannsson"]
+  spec.email         = ["ragnar@igo.is"]
+  spec.summary       = %q{iTunes CLI}
+  spec.description   = %q{iTunes CLI with tab completions}
+  spec.homepage      = "https://github.com/ragnar-johannsson/itc"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "sqlite3", "~> 1.3"
+  spec.add_runtime_dependency "htmlentities", "~> 4.3"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/itc.rb

@@ -0,0 +1,8 @@
+require 'itc/version'
+
+module Itc
+    require 'itc/musiclib'
+    require 'itc/database'
+    require 'itc/player'
+    require 'itc/command'
+end

data/lib/itc/command.rb

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+class Command
+    def self.execute(action, filters)
+        db = Database.new
+        player = Player.new
+        xml = ENV["HOME"] + "/Music/iTunes/iTunes Music Library.xml"
+
+        supported_filters = ("artist" "album" "song" "genre" "year")
+        filters.keys.each do |filter|
+            raise UnknownFilterException, filter unless supported_filters.include? filter
+        end
+
+        case action
+        when "index"
+            db.reindex MusicLibrary.new(xml)
+        when "list"
+            raise InvalidFilterNumberException, "No filter specified" if filters.empty?
+            puts db.list(filters).collect { |f| f.last }
+        when "play"
+            player.play filters.empty? ? {} : db.list_ids(filters)
+        when "pause"
+            player.pause
+        when "next"
+            player.next
+        when "previous", "prev"
+            player.previous
+        when "status"
+            if player.state == "stopped"
+                puts "iTunes is #{player.state}\n"
+                return
+            end
+
+            curr_song = player.current_track
+            state_icon = player.state == "playing" ? "▶" : "‖"
+            playlist = player.current_playlist_tracks.split(", ")
+            db.list_by_ids(playlist.size < 1000 ? playlist : [curr_song]).collect do |track|
+                printf " %s %s - %s - %s\n", track[0].to_s == curr_song ? state_icon : " ",
+                track[1], track[2], track[3]
+            end
+        else
+            raise UnknownCommandException
+        end
+    end
+end
+
+class InvalidFilterNumberException < StandardError; end
+class UnknownFilterException < StandardError; end
+class UnknownCommandException < StandardError; end

data/lib/itc/database.rb

@@ -0,0 +1,83 @@
+# coding: utf-8
+
+require 'sqlite3'
+
+class Database
+    def initialize
+        @db = SQLite3::Database.new(ENV["HOME"] + "/.itc.db")
+    end
+
+    def reset
+        @db.execute_batch <<-SQL
+            drop index if exists tracks_artist_index;
+            drop index if exists tracks_album_index;
+            drop index if exists tracks_song_index;
+            drop index if exists tracks_genre_index;
+            drop index if exists tracks_year_index;
+            drop table if exists tracks;
+
+            create table tracks (
+                track_id        INTEGER PRIMARY KEY,
+                artist          VARCHAR DEFAULT NULL,
+                album           VARCHAR DEFAULT NULL,
+                song            VARCHAR DEFAULT NULL,
+                genre           VARCHAR DEFAULT NULL,
+                year            VARCHAR DEFAULT NULL,
+                disc_number     INTEGER DEFAULT NULL,
+                track_number    INTEGER DEFAULT NULL
+            );
+
+            create index tracks_artist_index on tracks (artist);
+            create index tracks_album_index on tracks (album);
+            create index tracks_song_index on tracks (song);
+            create index tracks_genre_index on tracks (genre);
+            create index tracks_year_index on tracks (year);
+        SQL
+    end
+
+    def add_tracks(tracks)
+        @db.transaction do |db|
+            db.prepare("insert into tracks values (?, ?, ?, ?, ?, ?, ?, ?)") do |stmt|
+                tracks.each do |t|
+                    stmt.execute t[:track_id].to_i, t[:artist], t[:album], t[:name],
+                    t[:genre], t[:year], t[:disc_number].to_i, t[:track_number].to_i
+                end
+            end
+        end
+    end
+
+    def reindex(music)
+        reset
+        add_tracks music.tracks
+    end
+
+    def list(filters)
+        c = filters.keys.collect { |k| "#{k} like \"%#{filters[k]}%\"" }
+        condition = c.empty? ? "" : "where #{c.join(' and ')}"
+        fields = filters.keys.join(",")
+        @db.execute <<-SQL
+            select distinct #{fields} from tracks #{condition} order by artist, album, disc_number, track_number
+        SQL
+    end
+
+    def list_ids(filters)
+        c = filters.keys.collect { |k| "#{k} like \"%#{filters[k]}%\"" }
+        condition = c.empty? ? "" : "where #{c.join(' and ')}"
+        @db.execute <<-SQL
+            select track_id from tracks #{condition} order by artist, album, disc_number, track_number
+        SQL
+    end
+
+    def list_by_ids(ids)
+        c = ids.collect { |i| "track_id = #{i}" }
+        condition = c.empty? ? "" : "where #{c.join(' or ')}"
+        @db.execute <<-SQL
+            select
+                track_id, artist, album, song
+            from
+                tracks #{condition}
+            order by
+                artist, album, disc_number, track_number
+        SQL
+    end
+end

data/lib/itc/musiclib.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+require 'htmlentities'
+
+class MusicLibrary 
+    attr_accessor :file, :tracks
+
+    def initialize(file)
+        @file = file
+        @tracks = []
+
+        parse_xml
+    end
+
+    def parse_xml
+        entities = HTMLEntities.new
+        in_tracks = false
+        track = {}
+
+        IO.foreach(File.expand_path(@file)) do |line|
+            line = line.force_encoding("UTF-8")
+
+            if line =~ /^\t<key>Tracks<\/key>$/
+                in_tracks = true
+                next
+            end
+
+            if in_tracks then
+                if line =~ /^\t\t\t<key>(.*)<\/key><(date|integer|string)>(.*)<\/.*>$/
+                    key = $1.downcase.split.join("_").intern
+                    track[key] = entities.decode($3.to_s)
+                    next
+                elsif line =~ /^\t\t<\/dict>$/ then
+                    @tracks.push(track.dup)
+                    track.clear
+                    next
+                elsif in_tracks && line =~ /^\t<\/dict>$/
+                    in_tracks = false
+                    next
+                else
+                    next
+                end
+            end
+        end
+    end
+end

data/lib/itc/player.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+
+class Player
+    def execute(script)
+        `osascript -e '#{script}'`.gsub(/\n$/, "")
+    end
+
+    def play(tracks)
+        if tracks.empty?
+            execute 'tell application "iTunes" to play'
+        else
+            tracks = tracks.collect {|track| "database ID is #{track}"}
+            execute <<-SCRIPT
+                set pName to "itc"
+                tell application "iTunes"
+                    if not ((name of playlists) contains pName) then
+                        set itcPlaylist to make new playlist with properties {name:pName}
+                    else
+                        set itcPlaylist to playlist pName
+                        delete every track of itcPlaylist
+                    end if
+
+                    duplicate (every track whose #{
+                        tracks.join(" or ")
+                    }) to itcPlaylist
+
+                    play itcPlaylist
+                end tell
+            SCRIPT
+        end
+    end
+
+    def pause
+        execute 'tell application "iTunes" to pause'
+    end
+
+    def next
+        execute 'tell application "iTunes" to next track'
+    end
+
+    def previous
+        execute 'tell application "iTunes" to previous track'
+    end
+
+    def state
+        execute 'tell application "iTunes" to return player state'
+    end
+
+    def current_track
+        execute 'tell application "iTunes" to return database ID of current track'
+    end
+
+    def current_playlist_tracks
+        execute <<-SCRIPT
+            tell application "iTunes"
+                return database ID of tracks of current playlist
+            end tell
+        SCRIPT
+    end
+end

data/lib/itc/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: itc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ragnar B. Johannsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: iTunes CLI with tab completions
+email:
+- ragnar@igo.is
+executables:
+- itc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/itc
+- extra/completion/zsh/_itc
+- itc.gemspec
+- lib/itc.rb
+- lib/itc/command.rb
+- lib/itc/database.rb
+- lib/itc/musiclib.rb
+- lib/itc/player.rb
+- lib/itc/version.rb
+homepage: https://github.com/ragnar-johannsson/itc
+licenses:
+- BSD
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: iTunes CLI
+test_files: []