dacpclient 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a91f6ef4321ce83e0cabc85493552ebf7961756
-  data.tar.gz: c032e8102b42801e7fa220861ecefb5b306f0550
+  metadata.gz: ef5304a1a170b2d08364485ca254ff1f2607fba3
+  data.tar.gz: f7369e5cc191eae00af1a9b02e4e276069385496
 SHA512:
-  metadata.gz: 352cf3561c859d1bf52deb7a3fb33d036245282e6610e72871f11863055afebd3fb41ff630fdb887c3f52573bf3ead3fbcf9fc7163ca0b6882391d9addf65ec6
-  data.tar.gz: e78e5bad668a556c7d583702c23798a75b2df288bfb8358c9e750047685963bfbbc3380f9c2df6c12fb9236a3b5c2bb65f9b8bd5ebc6950a9c3801754cac72f6
+  metadata.gz: 6c8b74aac51cfa281f8201e52b49044ec1009bfca8fed4252c5d2da9dc9abeaba0bf3e755605900f30f1f521885d54c9e4614741fcaee4dffdcbc73b4165331e
+  data.tar.gz: e4204cd25fd0223c49b59dddfc032f91714827478ba3c6ca6692037b0ba83e15c771ea03aea0d96546704f34889230a44ef583b244d727f49d1426ba7d4094be

data/.rubocop.yml

@@ -3,5 +3,7 @@ MethodLength:
   Enabled: false
 Documentation:
   Enabled: false
-ConstantName:
+ClassVars:
+  Enabled: false
+ClassLength:
   Enabled: false

data/Gemfile

@@ -2,12 +2,3 @@
 gemspec
 
 source 'https://rubygems.org'
-
-group :test do
-  gem 'pry'
-  gem 'minitest', '~> 5.0.6'
-  # gem 'coveralls', require: false
-  gem 'rake'
-  gem 'rubocop', '~> 0.11.1'
-  gem 'simplecov', :require => false
-end

data/README.md

@@ -5,6 +5,8 @@
 A DACP (iTunes Remote protocol) client written in the wonderful Ruby language.
 You can use this for controlling iTunes. It uses the same protocol as the iTunes remote iOS app.
 
+You can control iTunes by connecting and entering a pin, or with Home Sharing. DACPClient supports both methods.
+
 Look at the [bin/dacpclient](https://github.com/jurriaan/ruby-dacpclient/blob/master/bin/dacpclient) file for an example client.
 
 ## Installation
@@ -25,8 +27,30 @@ Or install it yourself using:
 
 See [bin/dacpclient](https://github.com/jurriaan/ruby-dacpclient/blob/master/bin/dacpclient)
 
+    Usage: dacpclient [command]
+    (c) 2013 Jurriaan Pruis <email@jurriaanpruis.nl>
+
+    Where command is one of the following:
+    status
+    status_ticker
+    home_sharing
+    play
+    pause
+    playpause
+    next
+    prev
+    databases
+    playqueue
+    upnext
+    stop
+    debug
+    usage
+    previous
+    help
+
 ## Todo
 
+- Use bonjour
 - Add tests
 - Add more tagdefinitions
 - Documentation

data/Rakefile

@@ -19,4 +19,4 @@ task :rubocop do
   fail unless cli.run(args) == 0
 end
 
-task default: :test
+task default: :test

data/bin/dacpclient

@@ -1,13 +1,25 @@
 #!/usr/bin/env ruby
-
 require 'dacpclient'
-require 'english'
+require 'English'
 require 'socket'
+require 'yaml'
+require 'yaml/dbm'
+require 'fileutils'
+require 'io/console'
 
 # This is the CLI DACP Client. Normally installed as `dacpclient`
 class CLIClient
   def initialize
-    @client = DACPClient::Client.new("CLIClient (#{Socket.gethostname})", 'localhost', 3689)
+    @config = {}
+    @config['client_name'] ||= "DACPClient (#{Socket.gethostname})"
+    load_config
+
+    @client = DACPClient::Client.new(@config['client_name'], 'localhost', 3689)
+    if @config['guid'].nil? || @config['guid'] !~ /^[a-f0-9]{16}$/
+      @config['guid'] = @client.get_guid
+      save_config
+    end
+    @client.guid = @config['guid']
     @login = false
   end
 
@@ -64,6 +76,23 @@ class CLIClient
     end
   end
 
+  def home_sharing
+    puts "Setting up Home Sharing. Saving Home Sharing GUID to ~/.dacpclient/config.yml"
+    puts "\nPlease enter your Apple ID credentials:"
+    print "Apple ID (e-mail address): "
+    email = $stdin.gets.strip
+    print "Password: "
+    password = $stdin.noecho(&:gets).chomp
+    guid = @client.setup_home_sharing(email, password)
+    password = nil
+    @config['appleid'] = email
+    @config['hsgid'] = guid
+    save_config
+    puts "\n\n"
+    puts "Got your Home Sharing GUID (#{guid}). Logging in.."
+    login
+  end
+
   def play
     login
     @client.play
@@ -101,7 +130,7 @@ class CLIClient
 
   def upnext
     login
-    items = @client.list_queue.mlcl.select { |item| item.type.tag == 'mlit' }
+    items = @client.list_queue.mlcl.to_a.select {|i| i.type.tag == 'mlit' }
     puts 'Up next:'
     puts '--------'
     puts
@@ -140,7 +169,13 @@ class CLIClient
   private
 
   def login
-    @client.login unless @login
+    return if @login
+    @client.hsgid = @config['hsgid']
+    if @client.hsgid.nil?
+      @client.pair_and_login
+    else
+      @client.login
+    end
     @login = true
   end
 
@@ -165,7 +200,27 @@ class CLIClient
       end
     end
   end
+
+  def config_dir
+    File.join(ENV['HOME'], '.dacpclient')
+  end
+
+  def load_config
+    FileUtils.mkdir_p(config_dir)
+    config_file = File.join(config_dir,'config.yml')
+    if File.exists? config_file
+      @config.merge! YAML.load_file(config_file)
+    else
+      save_config
+    end
+  end
+
+  def save_config
+    File.open(File.join(config_dir,'config.yml'), 'w') do |out|
+      YAML.dump(@config, out)
+    end
+  end
 end
 
 cli = CLIClient.new
-cli.parse_arguments(Array(ARGV))
+cli.parse_arguments(Array(ARGV))

data/dacpclient.gemspec

@@ -20,10 +20,15 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md', 'LICENSE']
 
   spec.add_runtime_dependency 'dnssd', '~> 2.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.8.8'
+  spec.add_runtime_dependency 'plist', '~> 3.1.0'
 
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'redcarpet'
   spec.add_development_dependency 'github-markup'
+  spec.add_development_dependency 'minitest', '~> 5.2.0'
+  spec.add_development_dependency 'rubocop', '~> 0.15.0'
+  spec.add_development_dependency 'rake'
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 end

data/lib/dacpclient/bonjour.rb

@@ -0,0 +1,43 @@
+module DACPClient
+  # The Client class handles communication with the server
+  class Bonjour
+    SERVICE_NAME = '_daap._tcp'.freeze
+    DOMAIN = 'local'.freeze
+
+    def browse
+      servers = []
+
+      begin
+        timeout(3) do
+          DNSSD.browse!(SERVICE_NAME, DOMAIN) do |node|
+            ip, port = nil
+
+            resolver = DNSSD::Service.new
+            resolver.resolve(node) do |resolved|
+              ip = get_ip(resolved.target)
+              port = resolved.port
+
+              break unless resolved.flags.more_coming?
+            end
+
+            servers << { name: node.name, ip: ip, port: port, node: node }
+
+            break unless node.flags.more_coming?
+          end
+        end
+
+      rescue Timeout::Error
+        return []
+      end
+
+      servers
+    end
+
+    private
+
+    def get_ip(target)
+      info = Socket.getaddrinfo(target, nil, Socket::AF_INET)
+      info[0][2]
+    end
+  end
+end

data/lib/dacpclient/client.rb

@@ -1,51 +1,89 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup(:default)
+require 'faraday'
 require 'digest'
 require 'net/http'
+require 'uri'
+require 'cgi'
+require 'plist'
 require 'dacpclient/pairingserver'
 require 'dacpclient/dmapparser'
 require 'dacpclient/dmapbuilder'
-require 'uri'
-require 'cgi'
+require 'dacpclient/bonjour'
 
 module DACPClient
   # The Client class handles communication with the server
   class Client
+    attr_accessor :guid, :hsgid
+    attr_reader :name, :host, :port, :session_id
+
+    HOME_SHARING_HOST = 'https://homesharing.itunes.apple.com'
+    HOME_SHARING_PATH = '/WebObjects/MZHomeSharing.woa/wa/getShareIdentifiers'
+
+    DEFAULT_HEADERS = {
+      'Viewer-Only-Client' => '1',
+      # 'Accept-Encoding' => 'gzip',
+      'Connection' => 'keep-alive',
+      'User-Agent' => 'Remote/2.0'
+    }.freeze
 
     def initialize(name, host = 'localhost', port = 3689)
       @client = Net::HTTP.new(host, port)
       @name = name
       @host = host
       @port = port
-      @service = nil
+
       @session_id = nil
+      @hsgid = nil
       @mediarevision = 1
+      @uri = URI::HTTP.build(host: @host, port: @port)
+      @client = Faraday.new(url: @uri.to_s)
+    end
+
+    def setup_home_sharing(user, password)
+      hs_client = Faraday.new(url: HOME_SHARING_HOST)
+      result = hs_client.post do |request|
+        request.url HOME_SHARING_PATH
+        request.headers['Content-Type'] = 'text/xml'
+        request.headers.merge!(DEFAULT_HEADERS)
+        request.body = { 'appleId' => user, 'guid' => 'empty',
+                         'password' => password }.to_plist
+      end
+      response = Plist.parse_xml(result.body)
+      @hsgid = response['sgid']
+    end
+
+    def get_guid
+      return @guid unless @guid.nil?
+      d = Digest::SHA2.hexdigest(@name)
+      d[0..15]
     end
 
     def pair(pin)
-      pairingserver = PairingServer.new(@name, '0.0.0.0', 1024)
+      pairingserver = PairingServer.new(self, '0.0.0.0', 1024)
       pairingserver.pin = pin
       pairingserver.start
     end
 
-    def self.get_guid(name)
-       d = Digest::SHA2.hexdigest(name)
-       d[0..15]
-    end
-
     def serverinfo
-      do_action('server-info')
+      do_action('server-info', {}, true)
     end
 
-    def login(pin = nil)
-      pairing_guid = '0x' + Client.get_guid(@name)
-      response = do_action(:login, { 'pairing-guid' => pairing_guid })
+    def login
+      response = nil
+      if @hsgid.nil?
+        pairing_guid = '0x' + get_guid
+        response = do_action(:login, 'pairing-guid' => pairing_guid)
+      else
+        response = do_action(:login, 'hasFP' => '1')
+      end
       @session_id = response[:mlid]
       response
+    end
+
+    def pair_and_login(pin = nil)
+      login
     rescue DACPForbiddenError => e
       pin = 4.times.map { Random.rand(10) } if pin.nil?
-      warn "#{e.result.message} error: Cannot login, starting pairing process"
+      warn "#{e.result.status} error: Cannot login, starting pairing process"
       warn "Pincode: #{pin}"
       pair(pin)
       retry
@@ -71,16 +109,29 @@ module DACPClient
       do_action(:pause)
     end
 
+    def track_length
+      response = do_action(:getproperty, properties: 'dacp.playingtime')
+      response['cast']
+    end
+
     def seek(ms)
       do_action(:setproperty, 'dacp.playingtime' => ms)
     end
 
+    def get_position
+      response = do_action(:getproperty, properties: 'dacp.playingtime')
+      response['cast'] - response['cant']
+    end
+
+    alias_method :position, :get_position
+    alias_method :position=, :seek
+
     def status(wait = false)
       revision = wait ? @mediarevision : 1
       result = do_action(:playstatusupdate, 'revision-number' => revision)
       @mediarevision = result[:cmsr]
       result
-    rescue Net::ReadTimeout => e
+    rescue Faraday::Error::TimeoutError => e
       if wait
         retry
       else
@@ -96,6 +147,8 @@ module DACPClient
       do_action(:previtem)
     end
 
+    alias_method :previous, :prev
+
     def get_volume
       response = do_action(:getproperty, properties: 'dmcp.volume')
       response[:cmvo]
@@ -105,6 +158,9 @@ module DACPClient
       do_action(:setproperty, 'dmcp.volume' => volume)
     end
 
+    alias_method :volume, :get_volume
+    alias_method :volume=, :set_volume
+
     def get_repeat
       response = do_action(:getproperty, properties: 'dacp.repeatstate')
       response[:carp]
@@ -123,25 +179,31 @@ module DACPClient
       do_action(:setproperty, 'dmcp.volume' => volume)
     end
 
+    def getspeakers
+      do_action(:getspeakers)
+    end
+
     def ctrl_int
-      do_action('ctrl-int', {}, false)
+      do_action('ctrl-int', {}, true)
     end
 
     def logout
-      do_action(:logout, {}, false)
+      do_action(:logout)
+      @mediarevision = 1
+      @session_id = nil
     end
 
     def queue(id)
-      do_action('playqueue-edit', { command: 'add',
-                                    query: "\'dmap.itemid:#{id}\'" })
+      do_action('playqueue-edit', command: 'add',
+                                  query: "\'dmap.itemid:#{id}\'")
     end
 
     def clear_queue
-      do_action('playqueue-edit', { command: 'clear' })
+      do_action('playqueue-edit', command: 'clear')
     end
 
     def list_queue
-      do_action('playqueue-contents', {})
+      do_action('playqueue-contents')
     end
 
     def databases
@@ -153,7 +215,7 @@ module DACPClient
     end
 
     def default_db
-      databases[:mlcl].to_a.find {|item| item.mdbk == 1}
+      databases[:mlcl].to_a.find { |item| item.mdbk == 1 }
     end
 
     def default_playlist(db)
@@ -166,7 +228,7 @@ module DACPClient
     end
 
     def now_playing_artwork(width = 320, height = 320)
-      do_action(:nowplayingartwork, { mw: width, mh: height })
+      do_action(:nowplayingartwork, mw: width, mh: height)
     end
 
     def search(db, container, search, type = nil)
@@ -180,17 +242,19 @@ module DACPClient
       }
       queries = []
       type = types.keys if type.nil?
-      Array(type).each do  |t|
+      Array(type).each do |t|
         queries << "'#{types[t]}:#{search}'"
       end
-      # @http.get("/databases/1/containers/1/items?query='daap.songartist:#{escaped_pattern}','daap.songalbum:#{escaped_pattern}','dmap.itemname:#{escaped_pattern}','daap.songgenre:#{escaped_pattern}','daap.songcomposer:#{escaped_pattern}'").body
-      #queries.push(words.map { |v| "\'dmap.itemname:*#{v}*\'" }.join('+'))
-      # queries.push(words.map{|v| "\'daap.songartist:*#{v}*\'"}.join('+'))
+
       q = queries.join(',')
-      meta = 'dmap.itemname,dmap.itemid,daap.songartist,daap.songalbumartist,daap.songalbum,com.apple.itunes.cloud-id,dmap.containeritemid,com.apple.itunes.has-video,com.apple.itunes.itms-songid,com.apple.itunes.extended-media-kind,dmap.downloadstatus,daap.songdisabled'
+      meta  = %w(dmap.itemname dmap.itemid daap.songartist daap.songalbumartist
+                 daap.songalbum com.apple.itunes.cloud-id dmap.containeritemid
+                 com.apple.itunes.has-video com.apple.itunes.itms-songid
+                 com.apple.itunes.extended-media-kind dmap.downloadstatus
+                 daap.songdisabled).join(',')
 
       url = "databases/#{db}/containers/#{container}/items"
-      do_action(url, { type: 'music', sort: 'album', query: q, meta: meta},
+      do_action(url, { type: 'music', sort: 'album', query: q, meta: meta },
                 true)
     end
 
@@ -202,28 +266,23 @@ module DACPClient
         params['session-id'] = @session_id
         action = '/ctrl-int/1' + action unless cleanurl
       end
-      params = params.map { |k,v| "#{k}=#{v}" }.join('&')
-      uri = URI::HTTP.build({ host: @host, port: @port, path: action,
-                              query: params })
-      req = Net::HTTP::Get.new(uri.request_uri)
-      req.add_field('Viewer-Only-Client', '1')
-      res = Net::HTTP.new(uri.host, uri.port).start do |http|
-        http.read_timeout = 1000
-        http.request(req)
-      end
-      if res.kind_of?(Net::HTTPServiceUnavailable) ||
-         res.kind_of?(Net::HTTPForbidden)
-        raise DACPForbiddenError.new(res)
-      elsif !res.kind_of?(Net::HTTPSuccess)
-        warn 'No succes!'
-        warn res
-        return nil
+      params['hsgid'] = @hsgid unless @hsgid.nil?
+      result = @client.get do |request|
+        request.url action
+        request.params = params
+        request.headers.merge!(DEFAULT_HEADERS)
       end
 
-      if res['Content-Type'] == 'application/x-dmap-tagged'
-        DMAPParser::Parser.parse(res.body)
+      parse_result result
+    end
+
+    def parse_result(result)
+      if !result.success?
+        fail DACPForbiddenError, result
+      elsif result.headers['Content-Type'] == 'application/x-dmap-tagged'
+        DMAPParser.parse(result.body)
       else
-        res.body
+        result.body
       end
     end
   end
@@ -232,8 +291,8 @@ module DACPClient
   # service unavailable
   class DACPForbiddenError < StandardError
     attr_reader :result
-    def initialize(res)
-      @result = res
+    def initialize(result)
+      @result = result
     end
   end
 end

data/lib/dacpclient/dmapbuilder.rb

@@ -11,31 +11,33 @@ module DACPClient
       new.send(method, *args, &block)
     end
 
-    def method_missing(method, *args, &block)
-      if method.to_s.length != 4 ||
-        (tag = DMAPParser::Types.find { |a| a.tag.to_s == method.to_s }).nil?
-        return super
+    def build_container(tag , &block)
+      unless tag.type == :container
+        fail "Tag #{method} is not a container type"
+      end
+      @dmap_stack << TagContainer.new(tag)
+      instance_eval(&block)
+      if @dmap_stack.length > 1
+        @dmap_stack.last.value << @dmap_stack.pop
+      else
+        return @result = @dmap_stack.pop
       end
+    end
+
+    def method_missing(method, *args, &block)
+      tag = TagDefinition[method]
+      return super if tag.nil?
+
       if block_given?
-        if tag.type == :container
-          @dmap_stack << DMAPParser::TagContainer.new(tag)
-          instance_eval(&block)
-          if @dmap_stack.length > 1
-            @dmap_stack.last.value << @dmap_stack.pop
-          else
-            return @result = @dmap_stack.pop
-          end
-        else
-          raise "Tag #{method} is not a container type"
-        end
+        build_container(tag, &block)
       else
         if @dmap_stack.length > 0
           args = args.size > 1 ? args : args.first
-          @dmap_stack.last.value << DMAPParser::Tag.new(tag, args)
+          @dmap_stack.last.value << Tag.new(tag, args)
         else
-          raise 'Cannot build DMAP without a valid container'
+          fail 'Cannot build DMAP without a valid container'
         end
       end
     end
   end
-end
+end

data/lib/dacpclient/dmapconverter.rb

@@ -2,6 +2,10 @@ module DACPClient
   # The DMAPConverter class converts between binary and ruby formats
   class DMAPConverter
     class << self
+      def date_to_bin(data)
+        int_to_bin(value.to_i)
+      end
+
       def bin_to_byte(data)
         data.unpack('C').first
       end
@@ -27,15 +31,15 @@ module DACPClient
       end
 
       def bin_to_hex(data)
-        data.bytes.reduce('') { |a, e| a += sprintf('%02X', e) }
+        data.bytes.reduce('') { |a, e| a + sprintf('%02X', e) }
+      end
+
+      def bin_to_date(data)
+        Time.at(bin_to_int(data))
       end
 
       def bool_to_bin(data)
-        if data.true?
-          "\x01"
-        else
-          "\x00"
-        end
+        (data ? 1 : 0).chr
       end
 
       def int_to_bin(data)
@@ -61,6 +65,55 @@ module DACPClient
       def hex_to_bin(data)
         [data].pack 'H*'
       end
+
+      def decode_unknown(data)
+        if data =~ /[^\x20-\x7e]/ # non-readable characters
+          if data.bytesize == 1
+            return DMAPConverter.bin_to_byte(data)
+          elsif data.bytesize == 2
+            return DMAPConverter.bin_to_short(data)
+          elsif data.bytesize == 4
+            return DMAPConverter.bin_to_int(data)
+          elsif data.bytesize == 8
+            return DMAPConverter.bin_to_long(data)
+          end
+        end
+        data
+      end
+
+      def bin_to_string(data)
+        data
+      end
+      alias_method :string_to_bin, :bin_to_string
+
+      alias_method :uint16_to_bin, :short_to_bin
+      alias_method :uint32_to_bin, :int_to_bin
+      alias_method :uint64_to_bin, :long_to_bin
+
+      alias_method :bin_to_uint16, :bin_to_short
+      alias_method :bin_to_uint32, :bin_to_int
+      alias_method :bin_to_uint64, :bin_to_long
+      alias_method :bin_to_unknown, :decode_unknown
+
+      def decode(type, data)
+        decode_method = ('bin_to_' + type.to_s).to_sym
+        if respond_to? decode_method
+          send(decode_method, data)
+        else
+          warn "Decoder: Unknown type #{type}"
+          decode_unknown(data)
+        end
+      end
+
+      def encode(type, data)
+        encode_method = (type.to_s + '_to_bin').to_sym
+        if respond_to? encode_method
+          send(encode_method, data)
+        else
+          warn "Encoder: Unknown type #{type}"
+          data
+        end
+      end
     end
   end
-end
+end