kbl 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73abc7025129ec8803f02d292b4c2de0f0fb9f9d
-  data.tar.gz: 994c849b5b69b728d069909f3e0823fa1b251240
+  metadata.gz: 7675c0becfd84f2bc39016316d19c9cca200daeb
+  data.tar.gz: f3df0ab1a649a300f7ac996f342160cd47f34aa9
 SHA512:
-  metadata.gz: ad74dea81d0e2264bf620a123164ceb167d3b909877c151588491a3417bc2e9e71db201e4364a512ff1de2a1de8bfd634ade4a79909ff9dc2722b1c34d25973a
-  data.tar.gz: d1720e1506bb0f198d7037e355cf3e2d97edd99603a7e90986328303ad4ab0348c4f9e554ce34e436bb8b1ad049703401045fe0619657f6444c4f885e96db9bf
+  metadata.gz: a405a118a81a11dcf0a564fe3060358e117bd2d643a72013430ffb95ea69c6cf198f16f2ca31f34ee8b871112965bb3fe0dda9a26333bba877e6b9bff06b2e32
+  data.tar.gz: de489185b4a7ce05520c8b0f4959c207d37f4886eba8b198095923584188a19a143fdf6763ef27ee15fe92ca0d86b193f61d51a9548f6dc3512147434b1c6943

data/README.md

@@ -42,6 +42,20 @@ end
 puts kbl.to_kbl #=> the KBL source code (in XML)
 ```
 
+### CLI Tool
+
+This gem provides a CLI tool `kbl` that simplifies playlist importing / dumping via Song IDs (pathname).
+
+Usage:
+
+```txt
+# Import KKBOX Songs from a list of IDs through [FILENAME] or STDIN.
+kbl import [INPUT_FILE or STDIN]
+
+# Dump meta data of KKBOX songs from your local KKBOX client database.
+kbl dump [INPUT_FILE or STDIN] [-o=OUTPUT_FILE or STDOUT] [-f=tsv]
+```
+
 ## Required Song Meta Data
 
 To generate a working KBL file, the following data for every song must be provided.
@@ -94,24 +108,4 @@ Can exist multiple times across multiple playlists.
 
 ## License
 
-The MIT License (MIT)
-
-Copyright (c) 2014 Yu-Cheng Chuang
-
-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.
+The MIT License (MIT). See LICENSE.txt.

data/bin/kbl

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'kbl'
+require 'kbl/cli'
+
+KBL::CLI.start(ARGV)

data/kbl.gemspec

@@ -5,7 +5,7 @@ require 'kbl/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "kbl"
-  spec.version       = Kbl::VERSION
+  spec.version       = KBL::VERSION
   spec.authors       = ["Yu-Cheng Chuang"]
   spec.email         = ["ducksteven@gmail.com"]
   spec.summary       = %q{KKBOX Playlist Builder}
@@ -14,11 +14,13 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = %w(kbl)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'nokogiri', '~> 1.6.1'
+  spec.add_dependency 'thor', '~> 0.19.1'
+  spec.add_dependency 'sqlite3',  '~> 1.3.9'
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/lib/kbl/cli.rb

@@ -0,0 +1,170 @@
+require 'thor'
+require 'readline'
+require 'sqlite3'
+require 'csv'
+
+module KBL
+  class CLI < Thor
+    class MetaData < Struct.new(:song_id, :song_name, :artist_id, :artist_name, :album_id, :album_name)
+      def to_a
+        [
+          self.song_id,
+          self.song_name,
+          self.artist_id,
+          self.artist_name,
+          self.album_id,
+          self.album_name
+        ]
+      end
+
+      def to_tsv
+        to_a.join "\t"
+      end
+    end
+
+    desc "import [INPUT_FILE or STDIN]", "Import KKBOX Songs from a list of IDs through [FILENAME] or STDIN."
+    long_desc <<-EOS
+      Given a list of KKBOX Song IDs (pathname), import them to your KKBOX client's
+      Temporary Playlist, by brute-forcely `open`ing a bunch of
+      `kkbox://play_song_xxxx` URLs.
+
+      This will affect your current Temporary Playlist and make "now playing"
+      song to the last song in the list.
+    EOS
+
+    option :yes, :type => :boolean, :default => false, :aliases => :y,
+                 :desc => "Skip warning for overriding KKBOX now playing."
+
+    def import(filename=nil)
+      input = open_file(filename) || STDIN
+
+      ids = input.readlines
+      ids.each(&:chomp!).keep_if {|id| id.match(/\d+/) }#.delete("")
+
+      if ids.empty?
+        puts "No songs to import. Exit."
+        exit 2
+      end
+
+      if !options[:yes]
+        puts "\e[1;31mThis will import #{ids.size} songs into KKBOX and play the last song.\e[m"
+
+        while answer = Readline.readline("Continue? [Y/n] ", false)
+          case answer.downcase
+          when 'n', 'no'
+            puts "Cancelled."
+            exit 3
+          when 'y', 'yes', ''
+            break # stop asking and continue importing
+          else
+            puts "Please answer 'y' or 'n', or hit enter for 'y'."
+          end
+        end
+      end
+
+      puts "Importing..."
+
+      system "open #{ids.map { |id| "kkbox://play_song_#{id}" }.join(' ')}"
+    end
+
+    desc "dump [INPUT_FILE or STDIN] [-o=OUTPUT_FILE or STDOUT] [-f=tsv]",
+         "Dump meta data of KKBOX songs from your local KKBOX client database."
+    long_desc <<-EOS
+      Given a list of KKBOX Song IDs (pathname), find their meta data from your
+      KKBOX client's local database, and if found, export them to the file
+      set in --output option, or the STDOUT stream if not given.
+
+      If you have multiple accounts logged in to KKBOX client,
+      it will look into all of them.
+
+      The output contains the following fields:
+
+      name: Song Title
+
+      pathname: Song ID
+
+      artist: Artist Name
+
+      artist_id: Artist ID
+
+      album: Album Name
+
+      album_id: Album ID
+
+      For tabular format like TSV and CSV, these columns will be printed
+      in the above order.
+    EOS
+
+    option :format, :type => :string, :default => "tsv", :aliases => :f,
+            :desc => "Format of output data.",
+            :banner => "tsv"
+
+    option :output, :type => :string, :default => nil, :aliases => :o,
+            :desc => "The output file to write. Uses STDOUT if absent.",
+            :banner => "OUTPUT_FILE"
+
+    def dump(input_filename=nil)
+      input = open_file(input_filename) || STDIN
+
+      if output_filename = options[:output]
+        output = open_file(output_filename, 'w')
+        if output.nil?
+          puts "Cannot open file #{output_filename} for output."
+          exit 1
+        end
+      else
+        output = STDOUT
+      end
+
+      ids = input.readlines
+      ids.each(&:chomp!).keep_if {|id| id.match(/\d+/) }#.delete("")
+
+      if ids.empty?
+        puts "No songs to export. Exit."
+        exit 2
+      end
+
+      meta_data = {}
+
+      db_files = Dir.glob(File.expand_path("~/Library/Application Support/KKBOX/*/Playlists2.db"))
+
+      db_files.each do |db_file|
+        db = SQLite3::Database.new db_file
+
+        sql = <<-SQL
+          SELECT song_id, song_name, artist_id, artist_name, album_id, album_name
+          FROM song_tracks
+          WHERE song_id IN (#{ids.map {|id|"'#{id}'"}.join(',')});
+        SQL
+
+        db.execute(sql) do |row|
+          data = MetaData.new(*row)
+
+          meta_data[data.song_id] = data
+        end
+      end
+
+      ids.each do |id|
+        if data = meta_data[id]
+          output.puts data.send(:"to_#{options[:format]}")
+        else
+          STDERR.puts "ID Not Found: #{id}"
+        end
+      end
+    end
+
+    private
+    def open_file(filename, mode='r')
+      if filename
+        begin
+          input = File.open(filename, mode)
+        rescue Errno::ENOENT => e
+          puts "Cannot Open File #{filename} in #{mode} mode"
+          exit 1
+        end
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/kbl/package.rb

@@ -0,0 +1,27 @@
+module KBL
+  class Package
+    include KBL::Serializable::Package
+
+    attr_reader :kkbox_version, :version, :description, :date, :playlists
+
+    def initialize(&block)
+      @date = Time.now
+      @playlists = []
+      @kkbox_version = "04000016"
+
+      block.call(self) if block_given?
+    end
+
+    def add_playlist(&block)
+      playlist = Playlist.new
+      playlist.id = @playlists.size + 1
+      block.call(playlist)
+
+      @playlists << playlist
+    end
+
+    def total_songs
+      @playlists.map { |playlist| playlist.songs.size }.reduce(:+)
+    end
+  end
+end

data/lib/kbl/playlist.rb

@@ -0,0 +1,21 @@
+module KBL
+  class Playlist
+    include KBL::Serializable::Playlist
+
+    attr_reader :songs
+    attr_accessor :name, :description, :id
+
+    def initialize(&block)
+      @songs = []
+
+      block.call(self) if block_given?
+    end
+
+    def add_song(&block)
+      song = Song.new
+      block.call(song)
+
+      @songs << song
+    end
+  end
+end

data/lib/kbl/serializable/package.rb

@@ -0,0 +1,37 @@
+module KBL::Serializable
+  module Package
+    def to_kbl
+      to_kbl_node.to_xml({
+        :encoding => 'UTF-8',
+        :indent => 2,
+        :indent_text => " "
+      }).gsub(/<(.+)\/>/, '<\1></\1>')
+    end
+
+    def to_kbl_node
+      doc = Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
+        <utf-8_data><kkbox_package></kkbox_package></utf-8_data>
+      XML
+
+      package_node = doc.css("kkbox_package").first
+
+      package_node << "<kkbox_ver>#{self.kkbox_version}</kkbox_ver>"
+
+      @playlists.each do |playlist|
+        package_node << playlist.to_kbl_node
+      end
+
+      package_node << Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).root
+        <package>
+          <ver>1.0</ver>
+          <descr>包裝說明</descr>
+          <packdate>#{ self.date.strftime("%Y%m%d%H%M%S") }</packdate>
+          <playlistcnt>#{ self.playlists.size }</playlistcnt>
+          <songcnt>#{ self.total_songs }</songcnt>
+        </package>
+      XML
+
+      doc.root
+    end
+  end
+end

data/lib/kbl/serializable/playlist.rb

@@ -0,0 +1,24 @@
+require 'nokogiri'
+
+module KBL::Serializable
+  module Playlist
+    def to_kbl_node
+      node = Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
+        <playlist>
+          <playlist_id>#{ self.id }</playlist_id>
+          <playlist_name>#{ self.name }</playlist_name>
+          <playlist_descr>#{ self.description }</playlist_descr>
+          <playlist_data></playlist_data>
+        </playlist>
+      XML
+
+      data_node = node.css("playlist_data").first
+
+      @songs.each do |song|
+        data_node << song.to_kbl_node
+      end
+
+      node.root
+    end
+  end
+end

data/lib/kbl/serializable/song.rb

@@ -0,0 +1,26 @@
+require 'nokogiri'
+
+module KBL::Serializable
+  module Song
+    def to_kbl_node
+      doc = Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
+        <song_data>
+          <song_name>#{ self.name }</song_name>
+          <song_artist>#{ self.artist }</song_artist>
+          <song_album>#{ self.album }</song_album>
+          <song_genre>#{ self.genre }</song_genre>
+          <song_preference>#{ self.preference }</song_preference>
+          <song_playcnt>#{ self.play_count }</song_playcnt>
+          <song_pathname>#{ self.pathname }</song_pathname>
+          <song_type>#{ self.type }</song_type>
+          <song_lyricsexist>#{ self.has_lyrics }</song_lyricsexist>
+          <song_artist_id>#{ self.artist_id }</song_artist_id>
+          <song_album_id>#{ self.album_id }</song_album_id>
+          <song_song_idx>#{ self.song_index }</song_song_idx>
+        </song_data>
+      XML
+
+      doc.root
+    end
+  end
+end

data/lib/kbl/song.rb

@@ -0,0 +1,9 @@
+module KBL
+  class Song
+    include KBL::Serializable::Song
+
+    attr_accessor :name, :artist, :album, :genre, :preference,
+                :play_count, :pathname, :type, :has_lyrics,
+                :artist_id, :album_id, :song_index
+  end
+end

data/lib/kbl/version.rb

@@ -1,3 +1,3 @@
-module Kbl
-  VERSION = "0.0.1"
+module KBL
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kbl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Yu-Cheng Chuang
@@ -24,6 +24,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +83,8 @@ dependencies:
 description: Building KKBOX Playlist and serialize to KBL format.
 email:
 - ducksteven@gmail.com
-executables: []
+executables:
+- kbl
 extensions: []
 extra_rdoc_files: []
 files:
@@ -64,8 +93,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/kbl
 - kbl.gemspec
 - lib/kbl.rb
+- lib/kbl/cli.rb
+- lib/kbl/package.rb
+- lib/kbl/playlist.rb
+- lib/kbl/serializable/package.rb
+- lib/kbl/serializable/playlist.rb
+- lib/kbl/serializable/song.rb
+- lib/kbl/song.rb
 - lib/kbl/version.rb
 homepage: ''
 licenses: