kbl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73abc7025129ec8803f02d292b4c2de0f0fb9f9d
+  data.tar.gz: 994c849b5b69b728d069909f3e0823fa1b251240
+SHA512:
+  metadata.gz: ad74dea81d0e2264bf620a123164ceb167d3b909877c151588491a3417bc2e9e71db201e4364a512ff1de2a1de8bfd634ade4a79909ff9dc2722b1c34d25973a
+  data.tar.gz: d1720e1506bb0f198d7037e355cf3e2d97edd99603a7e90986328303ad4ab0348c4f9e554ce34e436bb8b1ad049703401045fe0619657f6444c4f885e96db9bf

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kbl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yu-Cheng Chuang
+
+MIT License
+
+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,117 @@
+# KKBOX Playlist Library (KBL) Generator
+
+A simple gem to generate KKBOX Playlist Library (KBL) files.
+
+:warning: **[WARNING]** This program is made by reverse-engineering the KBL files. It does not guarantee that the generated KBL files is fully-compatible with KKBOX client. Use it AT YOUR OWN RISK!.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kbl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kbl
+
+## Usage
+
+**Important**: Read **Required Song Meta Data** section before you start generating a KBL file.
+
+```rb
+kbl = KBL::Package.new do |package|
+  package.add_playlist do |playlist|
+    playlist.name = "Playlist A"
+    playlist.description = "A Sample Playlist"
+
+    playlist.add_song do |song|
+      song.name      = "君の知らない物語"
+      song.pathname  = "3665602"
+      song.artist    = "Supercell"
+      song.artist_id = "197227"
+      song.album     = "Today Is A Beautiful Day"
+      song.album_id  = "314546"
+    end
+  end
+end
+
+puts kbl.to_kbl #=> the KBL source code (in XML)
+```
+
+## Required Song Meta Data
+
+To generate a working KBL file, the following data for every song must be provided.
+
+* **pathname** - The Song ID
+* **album_id** - The Album ID
+* **artist_id** - The Artist ID
+
+If there is only `pathname`, the User Interface will work in strange behavior, if these songs has never been played in your KKBOX client, or was removed from your KKBOX client library before.
+
+Additionally, add these data to avoid blank name, album and artist names, when importing unknown songs to the KKBOX client:
+
+* **name** - The name of that song.
+* **album** - The album name.
+* **artist** - The artist name.
+
+## Glossary
+
+### Package
+
+A package of KBL.
+
+Can contain multiple playlists, which will be imported as individual playlists when the KBL file is imported to KKBOX client.
+
+### Playlist
+
+A playlist entry containing one or more songs.
+
+It is recommended to assign name for it so that when importing, it will be showed up in the playlists sidebar.
+
+### Song
+
+A song entry.
+
+Can exist multiple times across multiple playlists.
+
+## Contributing
+
+1. Fork it ( http://github.com/chitsaou/kbl-generator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Make a CLI tool for generating KBL files.
+* Scraping meta data from KKBOX client database from given Song IDs.
+* A workflow for how to build a KBL file from Song IDs.
+
+## 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.

data/Rakefile

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

data/kbl.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kbl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kbl"
+  spec.version       = Kbl::VERSION
+  spec.authors       = ["Yu-Cheng Chuang"]
+  spec.email         = ["ducksteven@gmail.com"]
+  spec.summary       = %q{KKBOX Playlist Builder}
+  spec.description   = %q{Building KKBOX Playlist and serialize to KBL format.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_dependency 'nokogiri', '~> 1.6.1'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/kbl.rb

@@ -0,0 +1,13 @@
+require "kbl/version"
+
+module KBL
+  autoload :Package,  "kbl/package"
+  autoload :Playlist, "kbl/playlist"
+  autoload :Song,     "kbl/song"
+
+  module Serializable
+    autoload :Package,  "kbl/serializable/package"
+    autoload :Playlist, "kbl/serializable/playlist"
+    autoload :Song,     "kbl/serializable/song"
+  end
+end

data/lib/kbl/version.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: kbl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yu-Cheng Chuang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Building KKBOX Playlist and serialize to KBL format.
+email:
+- ducksteven@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kbl.gemspec
+- lib/kbl.rb
+- lib/kbl/version.rb
+homepage: ''
+licenses:
+- MIT
+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: KKBOX Playlist Builder
+test_files: []