dmap-ng 0.2.5

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jack Chen
+
+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,130 @@
+# dmap-ng
+
+dmap-ng is an improved version of the original dmap gem, rewritten from the ground up with a more detailed test suite and has awesome features like a DSL and supports a more extensive part of the DMAP protocol.
+
+## What is DMAP?
+
+DMAP stands for Digital Media Access Protocol which is the data serialisation format used in the [DAAP](http://en.wikipedia.org/wiki/Digital_Audio_Access_Protocol) protocol mainly used in iTunes for media sharing and remote control.
+
+## Why should I care?
+
+You should care if you want to write anything that interacts with iTunes/DAAP-compatible media server or a DAAP client.
+
+## What this currently being used for
+
+I wanted to write a gem that emulates an iTunes DJ server so the Remote.app on the iPhone/iTouch/iPad can interface with any app that has voting, so it was my Railscamp 7 project. I wrote this gem over the two days at Railscamp, using the tag list from jphasting's dmap gem but writing everything from scratch. It has enough tag support to get the Remote.app to show arbitrary data with the gem I'll upload once it's in a decent state named 'deejay'.
+
+## How to use
+
+Real easy. Check this out:
+
+This is a aply (playlists) entry.
+
+    playlists = DMAP.parse("aply\000\000\001\nmstt\000\000\000\004\000\000\000\310muty\000\000\000\001\000mtco\000\000\000\004\000\000\000\002mrco\000\000\000\004\000\000\000\002mlcl\000\000\000\325mlit\000\000\000_miid\000\000\000\004\000\000(Fmper\000\000\000\b\000\000\000\000\000\000\000{minm\000\000\000\005MusicaeSP\000\000\000\001\001mpco\000\000\000\004\000\000\000\000aePS\000\000\000\001\006meds\000\000\000\004\000\000\000\000mimc\000\000\000\004\000\000\000\002mlit\000\000\000fmiid\000\000\000\004\000\000()mper\000\000\000\b\000\000\000\000\000\000\004\322minm\000\000\000\tiTunes DJmpco\000\000\000\004\000\000\000\000aePS\000\000\000\001\002meds\000\000\000\004\000\000\000\000ceJI\000\000\000\004\000\000(,mimc\000\000\000\004\000\000\000\022")
+    
+would return:
+
+    aply[266]:
+      mstt[4]: 200
+      muty[1]: 0
+      mtco[4]: 2
+      mrco[4]: 2
+      mlcl[213]:
+        mlit[95]:
+          miid[4]: 10310
+          mper[8]: 123
+          minm[5]: "Music"
+          aeSP[1]: true
+          mpco[4]: 0
+          aePS[1]: 6
+          meds[4]: 0
+          mimc[4]: 2
+        mlit[102]:
+          miid[4]: 10281
+          mper[8]: 1234
+          minm[9]: "iTunes DJ"
+          mpco[4]: 0
+          aePS[1]: 2
+          meds[4]: 0
+          ceJI[4]: 10284
+          mimc[4]: 18
+
+      
+      
+Which is a `DMAP::Tag` object. You can access individual tags like this:
+
+    playlists.mstt # => 200
+    playlists.mlcl[1].minm # => "iTunes DJ"
+
+To build a DMAP structure, you do this:
+
+    DMAP.build do
+      mlit do # dmap.listingitem
+        mikd 2 # dmap.itemkind
+        asal "Aquarium" # daap.songalbum
+        asar "Naomi" # daap.songartist
+        miid 3123 # dmap.itemid
+        minm "Relax She Said" # dmap.itemname
+        mper 9013529250002063060 # dmap.persistentid
+        mcti 10386 # dmap.containeritemid
+        aeHV 0 # com.apple.itunes.has-video
+        asai 9013529250002063588 # daap.songalbumid
+        ceJV 2 # com.apple.itunes.jukebox-vote
+        ceJC 1 # com.apple.itunes.jukebox-client-vote
+      end
+    end
+    
+There is also a `#to_dsl` method on DMAP::Tag that returns a copy-pasta-able ruby code that goes inside the `DMAP.build` block.
+
+    puts playlists.to_dsl
+    
+which gives you this:
+    
+    aply do # daap.databaseplaylists
+      mstt 200 # dmap.status
+      muty 0 # dmap.updatetype
+      mtco 2 # dmap.specifiedtotalcount
+      mrco 2 # dmap.returnedcount
+      mlcl do # dmap.listing
+        mlit do # dmap.listingitem
+          miid 10310 # dmap.itemid
+          mper 123 # dmap.persistentid
+          minm "Music" # dmap.itemname
+          aeSP true # com.apple.itunes.smart-playlist
+          mpco 0 # dmap.parentcontainerid
+          aePS 6 # com.apple.itunes.special-playlist
+          meds 0 # dmap.editcommandssupported
+          mimc 2 # dmap.itemcount
+        end
+        mlit do # dmap.listingitem
+          miid 10281 # dmap.itemid
+          mper 1234 # dmap.persistentid
+          minm "iTunes DJ" # dmap.itemname
+          mpco 0 # dmap.parentcontainerid
+          aePS 2 # com.apple.itunes.special-playlist
+          meds 0 # dmap.editcommandssupported
+          ceJI 10284 # com.apple.itunes.jukebox-current
+          mimc 18 # dmap.itemcount
+        end
+      end
+    end
+    
+As you can see, it also puts in the tag definition at the end because I got tired of having to look up what a tag actually was.
+
+## Come across a new tag?
+
+Send me an email with a pcap dump of the entire process and I'll see what I can do.
+    
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Jack "chendo" Chen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dmap-ng"
+    gem.summary = %Q{An improved DMAP gem that allows easy building and parsing of DMAP structures}
+    gem.description = %Q{An improved DMAP gem that allows easy building and parsing of DMAP structures}
+    gem.email = "chendo@chendo.net"
+    gem.homepage = "http://github.com/chendo/dmap-ng"
+    gem.authors = ["Jack Chen"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files += Dir['lib/**/*.rb']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dmap-ng #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.5

data/dmap-ng.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dmap-ng}
+  s.version = "0.2.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jack Chen"]
+  s.date = %q{2010-04-19}
+  s.description = %q{An improved DMAP gem that allows easy building and parsing of DMAP structures}
+  s.email = %q{chendo@chendo.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "dmap-ng.gemspec",
+     "lib/debug_ext.rb",
+     "lib/dmap-ng.rb",
+     "lib/dmap.rb",
+     "lib/dmap/parser.rb",
+     "lib/dmap/tag.rb",
+     "lib/dmap/tag_builder.rb",
+     "lib/dmap/tag_definitions.rb",
+     "lib/true_false_ext.rb",
+     "spec/dmap_spec.rb",
+     "spec/dsl_spec.rb",
+     "spec/packet_dumps/connection_with_voting.dump",
+     "spec/parser_spec.rb",
+     "spec/selector_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/chendo/dmap-ng}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{An improved DMAP gem that allows easy building and parsing of DMAP structures}
+  s.test_files = [
+    "spec/dmap_spec.rb",
+     "spec/dsl_spec.rb",
+     "spec/parser_spec.rb",
+     "spec/selector_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/debug_ext.rb

@@ -0,0 +1,13 @@
+class Object
+  def tap(&block)
+    yield
+    block
+  end
+  
+  def tapp(prefix = nil, &block)
+    block ||= lambda { |x| x }
+    str = (ret = block[self]).is_a?(String) ? ret : ret.inspect
+    puts [prefix, str].compact.join(': ')
+    self
+  end
+end

data/lib/dmap-ng.rb

@@ -0,0 +1 @@
+require 'dmap'

data/lib/dmap.rb

@@ -0,0 +1,26 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+class DMAP
+  VERSION = '0.2.5'
+end
+
+Dir[File.dirname(__FILE__) + "/dmap/**.rb"].each { |f| require f }
+
+require 'true_false_ext'
+require 'debug_ext'
+
+class DMAP
+  class << self
+    def build(&block)
+      builder = TagBuilder.new
+      builder.instance_eval &block
+      r = builder.result
+      r.size == 1 ? r.first : r
+    end
+    
+    def parse(data)
+      Parser.parse(data).first
+    end
+  end
+end

data/lib/dmap/parser.rb

@@ -0,0 +1,44 @@
+class DMAP
+  class Parser
+    def self.parse(buffer)
+      buffer = StringIO.new(buffer)
+      
+      ret = []
+      while !buffer.eof?      
+        code = buffer.read(4).to_sym
+        
+        raise "Invalid tag code format while parsing" unless code.to_s =~ /^[a-z]{4}$/i
+          
+        length = buffer.read(4).unpack('N').first
+        data = buffer.read(length)
+    
+        definition = Tag.lookup(code)
+        
+        raise "No tag definition for #{code}, length: #{length}, data: #{data.inspect}" unless definition
+    
+        ret << if (type = definition.last) == :list
+          Tag.new(code, parse(data))
+        else
+          expected_length, pack_code = STATIC_LENGTH_TYPES[type]
+          value = case type
+          when :string
+            data
+          when :version
+            data.unpack(pack_code)
+          when :long
+            # Some types seem to be the wrong endian
+            # so there are endian hacks
+            data.reverse.unpack(pack_code).first
+          when :signed_integer
+            data.reverse.unpack(pack_code).first
+          else
+            data.unpack(pack_code).first
+          end
+          Tag.new(code, value)
+        end
+      end
+      
+      ret
+    end
+  end
+end

data/lib/dmap/tag.rb

@@ -0,0 +1,93 @@
+class DMAP
+  class Tag
+    class << self
+      def lookup(code)
+        TAGS[code]
+      end
+    end
+    
+    attr_accessor :code, :value, :tag, :type
+    
+    def initialize(code, value)
+      @code, @value = code, value
+      @tag, @type = lookup
+      
+      raise "Cannot have nil value in tag #{code}" if value.nil? && type != :list
+      raise "Unknown tag #{code}" if tag.nil?
+    end
+    
+    def to_dmap
+      data = case type
+      when :string
+        value
+      when :list
+        (value || []).inject('') { |mem, v| mem += v.to_dmap }
+      when :version
+        value.pack(pack_code)
+      when :long
+        # Some types seem to be the wrong endian
+        # so there are endian hacks
+        [value].pack('Q').reverse
+      when :signed_integer
+        [value].pack(pack_code).reverse
+      else
+        [value.to_i].pack(pack_code)
+      end
+      "#{code}#{[length].pack('N')}#{data}"
+    end
+    
+    # Could be optimised later down the track
+    def ==(obj)
+      self.to_dmap == obj.to_dmap
+    end
+    
+    def pack_code
+      @pack_code ||= STATIC_LENGTH_TYPES[type].last rescue raise("No pack code definition for #{code}")
+    end
+    
+    def length
+      @length ||= case type
+      when :string
+        value.length
+      when :list
+        (value || []).inject(0) { |mem, v| mem += v.length + 8 }
+      else
+        STATIC_LENGTH_TYPES[type].first
+      end
+    end
+
+    def lookup
+      self.class.lookup(code)
+    end
+    
+    def inspect(level = 0)
+      pad = ' ' * (level * 2)
+      case value
+      when Array
+        if value.any? { |e| e.is_a? Tag }
+          (["#{pad}#{code}[#{length}]:"] + value.map{ |v| v.inspect(level + 1) }).join("\n")
+        else
+          "#{pad}#{code}[#{length}]: #{value.inspect}"
+        end
+      else
+        "#{pad}#{code}[#{length}]: #{value.inspect}"
+      end
+    end
+    
+    def to_dsl(level = 0)
+      pad = ' ' * (level * 2)
+      case value
+      when Array
+        (["#{pad}#{code} do # #{@tag}"] + value.map{ |v| v.to_dsl(level + 1) } + ["#{pad}end"]).join("\n")
+      else
+        "#{pad}#{code} #{value.inspect} # #{@tag}"
+      end
+    end
+    
+    def method_missing(meth, *args)
+      return super unless self.class.lookup(meth)
+      return super unless value.is_a? Array
+      value.find { |v| v.code == meth }.value
+    end
+  end
+end