dacpclient 0.2.11 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf81a474e862f6f8c2bde6e929bc29a693b701df
-  data.tar.gz: dfaa5045aded28a3ab95474c938759c1e371af78
+  metadata.gz: 0168ee84709980d66f477982404c0d5cddbb2f92
+  data.tar.gz: e105474bc17e7127c0d0f9427219152df7a83d0f
 SHA512:
-  metadata.gz: af0b53555a31b9ad99cc4e3b334607520fa3a9225bd0da7c155abd9b919ba0fcea4cf43bc2949bf056b5969c77595eb14d8ca79ca9df557e3ffe2c998cce0cf8
-  data.tar.gz: a16eb079d959501146eeb3aadb8607c1233ff6f9fa1e94df2455995a09796da1d1fd1a146372deed65047e158a076e44936fa47489b7244477e1043f4c786f62
+  metadata.gz: 508242daaf50dacc3c003d4e0d033ea0ed06df405dae77ce27d2ab34e3d0199e10a77143a1ab7b0fb1214b210873f5b1c29708616dcba7562109c984142064cc
+  data.tar.gz: f2f2dfd1c2238ae09d217ce4128032bbb174ef2e027042d687c5b8a6c8869ac1493002ee42f6df3dde07274f747fc450064f83da8b43155295d5c725c36e77ae

data/Gemfile

@@ -3,4 +3,4 @@ gemspec
 source 'https://rubygems.org'
 
 gem 'minitest', '~> 5.3.1'
-gem 'rubocop', '~> 0.20.0'
+gem 'rubocop', '~> 0.21.0'

data/README.md

@@ -5,7 +5,7 @@
 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.
+You can control iTunes by connecting and entering a pin. 
 
 Look at the [bin/dacpclient](https://github.com/jurriaan/ruby-dacpclient/blob/master/bin/dacpclient) file for an example client.
 
@@ -29,33 +29,25 @@ Or install it yourself using:
 
 See [bin/dacpclient](https://github.com/jurriaan/ruby-dacpclient/blob/master/bin/dacpclient)
 
-    Usage: dacpclient [command]
+    DACPClient v0.3.0
     (c) 2014 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
+    DACPClient commands:
+      dacpclient help            # Display all possible commands
+      dacpclient help [COMMAND]  # Describe available commands or one specific command
+      dacpclient hostname        # Set the hostname
+      dacpclient next            # Go to next item
+      dacpclient pause           # Pause Playing
+      dacpclient play            # Start playing
+      dacpclient play_playlist   # Plays a playlist
+      dacpclient playlists       # Show the playlists
+      dacpclient playpause       # Toggle Playing
+      dacpclient prev            # Go to previous item
+      dacpclient status          # Shows the status of the DACP server
+      dacpclient stop            # Stop playing
+      dacpclient upnext          # Show what's up next
+      dacpclient version         # Show DACPClient Version
+      dacpclient volume          # Get or set volume
 
 ## Contributing
 

data/bin/dacpclient

@@ -6,11 +6,13 @@ require 'socket'
 require 'yaml'
 require 'fileutils'
 require 'io/console'
+require 'fuzzy_match'
 require 'thor'
 
 # This is the CLI DACP Client. Normally installed as `dacpclient`
 class CLIClient < Thor
-  package_name :dacpclient
+  package_name 'DACPClient'
+
   include Thor::Actions
   def initialize(*)
     @config = {}
@@ -59,21 +61,6 @@ class CLIClient < Thor
     show_status
   end
 
-  desc :home_sharing, 'Setup Home Sharing (Not fully functional)'
-  def home_sharing
-    puts 'Setting up Home Sharing. Saving Home Sharing GUID to ' + config_file
-    puts "\nPlease enter your Apple ID credentials:"
-    email = ask('Apple ID (e-mail address):').strip
-    password = ask('Password:')
-    guid = @client.setup_home_sharing(email, password)
-    @config['appleid'] = email
-    @config['hsgid'] = guid
-    save_config
-    puts "\n\n"
-    puts "Got your Home Sharing GUID (#{guid}). Logging in.."
-    login
-  end
-
   desc :hostname, 'Set the hostname'
   def hostname
     @config['host'] = ask('Please enter a new hostname to connect to:').strip
@@ -125,13 +112,29 @@ class CLIClient < Thor
     playlist_items = @client.playlists
     puts 'Playlists:'
     puts '----------'
+    count = 0
+    num = Math.log10(playlist_items.length).floor + 1
     playlist_items.each do |playlist|
-      print '  ' unless playlist.base_playlist?
+      printf("%#{num}d. ", count += 1) unless playlist.base_playlist?
+
       puts "#{playlist.name} (#{playlist.count})"
     end
     puts
   end
 
+  desc :play_playlist, 'Plays a playlist'
+  def play_playlist(playlist)
+    login
+    playlists = @client.playlists
+    if playlist =~ /^\d+$/
+      playlist = playlists[playlist.to_i]
+    else
+      fz = FuzzyMatch.new(playlists, read: :name)
+      playlist = fz.find(playlist)
+    end
+    @client.playspec(playlist)
+  end
+
   desc :upnext, 'Show what\'s up next'
   def upnext
     login
@@ -183,7 +186,17 @@ class CLIClient < Thor
     puts "DACPClient v#{DACPClient::VERSION}"
     puts "using DMAPParser v#{DMAPParser::VERSION}"
     print 'DACPClient and DMAPParser are Copyright (c) '
-    puts "#{Time.now.year} Jurriaan Pruis"
+    puts "#{Time.now.year} Jurriaan Pruis <email@jurriaanpruis.nl>"
+  end
+
+  default_task :banner
+
+  desc :help, 'Display all possible commands'
+  def banner
+    puts "DACPClient v#{DACPClient::VERSION}"
+    puts "(c) #{Time.now.year} Jurriaan Pruis <email@jurriaanpruis.nl>"
+    puts
+    help
   end
 
   private

data/dacpclient.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'plist', '~> 3.1.0'
   spec.add_runtime_dependency 'dmapparser', '~> 0.1.0'
   spec.add_runtime_dependency 'thor', '~> 0.19.1'
+  spec.add_runtime_dependency 'fuzzy_match', '~> 2.0.4'
 
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'redcarpet'

data/lib/dacpclient/browser.rb

@@ -39,7 +39,7 @@ module DACPClient
 
     private
 
-    def node_resolver(node, resolved)
+    def node_resolver(_node, resolved)
       devices << Device.new(get_device_host(resolved), resolved.port,
                             resolved.text_record)
 

data/lib/dacpclient/client.rb

@@ -11,6 +11,8 @@ require 'dacpclient/version'
 require 'dacpclient/model'
 require 'dacpclient/models/status'
 require 'dacpclient/models/pair_info'
+require 'dacpclient/models/database'
+require 'dacpclient/models/databases'
 require 'dacpclient/models/playlist'
 require 'dacpclient/models/playlists'
 require 'dacpclient/models/play_queue_item'
@@ -23,9 +25,6 @@ module DACPClient
     attr_writer :guid
     attr_reader :name, :host, :port, :session_id
 
-    HOME_SHARING_HOST = 'https://homesharing.itunes.apple.com'.freeze
-    HOME_SHARING_PATH = '/WebObjects/MZHomeSharing.woa/wa/getShareIdentifiers'.freeze
-
     DEFAULT_HEADERS = {
       'Viewer-Only-Client' => '1',
       'Accept-Encoding' => 'gzip',
@@ -56,19 +55,6 @@ module DACPClient
     alias_method :next, :nextitem
     alias_method :speakers, :getspeakers
 
-    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 guid
       return @guid unless @guid.nil?
       d = Digest::SHA2.hexdigest(@name)
@@ -156,6 +142,19 @@ module DACPClient
       set_property('dmcp.volume', volume)
     end
 
+    def cue(command, query, index = 0)
+      do_action(:cue, command: command, query: query, index: index)
+    end
+
+    def playspec(playlist, db = default_db)
+      dbspec = "'dmap.persistentid:0x#{db.persistent_id.to_s(16)}'"
+      cspec = "'dmap.persistentid:0x#{playlist.persistent_id.to_s(16)}'"
+      # don't worry about playing item's from playlists yet..
+      # container-item-spec='dmap.containeritemid:%s'
+      do_action(:playspec, database_spec: dbspec,
+                           container_spec: cspec)
+    end
+
     def repeat
       response = do_action(:getproperty, properties: 'dacp.repeatstate')
       response[:carp]
@@ -198,16 +197,25 @@ module DACPClient
     end
 
     def databases
-      do_action('databases', clean_url: true)
+      meta = %w(dmap.itemname dmap.itemcount dmap.itemid dmap.persistentid
+                daap.baseplaylist com.apple.itunes.special-playlist
+                com.apple.itunes.smart-playlist com.apple.itunes.saved-genius
+                dmap.parentcontainerid dmap.editcommandssupported).join(',')
+      do_action('databases', clean_url: true, meta: meta, model: Databases)
     end
 
     def playlists(db = default_db)
-      do_action("databases/#{db.miid}/containers", clean_url: true,
-                                                   model: Playlists).items
+      meta = %w(dmap.itemname dmap.itemcount dmap.itemid dmap.persistentid
+                daap.baseplaylist com.apple.itunes.special-playlist
+                com.apple.itunes.smart-playlist com.apple.itunes.saved-genius
+                dmap.parentcontainerid dmap.editcommandssupported).join(',')
+      do_action("databases/#{db.item_id}/containers", clean_url: true,
+                                                      meta: meta,
+                                                      model: Playlists).items
     end
 
     def default_db
-      databases.mlcl.to_a.find { |item| item.mdbk == 1 }
+      databases.items.find { |item| item.default_db == 1 }
     end
 
     def default_playlist(db = default_db)
@@ -269,14 +277,17 @@ module DACPClient
       do_action(:setproperty, property => value)
     end
 
-    def do_action(action, clean_url: false, model: nil, **params)
+    def do_action(action, params = {})
+      clean_url = params.delete(:clean_url) || false
+      model = params.delete(:model)
+
       action = '/' + action.to_s
       unless @session_id.nil?
         params['session-id'] = @session_id.to_s
         action = '/ctrl-int/1' + action unless clean_url
       end
       params['hsgid'] = @hsgid unless @hsgid.nil?
-
+      params = filter_param_keys(params)
       result = @client.get do |request|
         request.options.params_encoder = Faraday::FlatterParamsEncoder
         request.url action
@@ -287,6 +298,10 @@ module DACPClient
       parse_result result, model
     end
 
+    def filter_param_keys(params)
+      Hash[ params.map { |k, v| [k.to_s.tr('_', '-'), v] }]
+    end
+
     def parse_result(result, model)
       if !result.success?
         fail DACPForbiddenError, result

data/lib/dacpclient/faraday/gzip.rb

@@ -9,7 +9,7 @@ module FaradayMiddleware
     ACCEPT_ENCODING = 'Accept-Encoding'.freeze
     ENCODINGS = 'gzip,deflate'.freeze
 
-    def initialize(app, options = nil)
+    def initialize(app)
       @app = app
     end
 

data/lib/dacpclient/model.rb

@@ -38,6 +38,10 @@ module DACPClient
       end.to_dmap
     end
 
+    def respond_to?(method)
+      dmap_attributes.key?(method)
+    end
+
     def method_missing(method, *args, &block)
       if method.to_s =~ /(.*)\=$/ &&
          dmap_attributes.key?(Regexp.last_match[1].to_sym)

data/lib/dacpclient/models/database.rb

@@ -0,0 +1,11 @@
+module DACPClient
+  class Database < Model
+    dmap_tag :mlit
+    dmap_attribute :item_id, :miid
+    dmap_attribute :name, :minm
+    dmap_attribute :count, :mimc
+    dmap_attribute :container_count, :mctc
+    dmap_attribute :default_db, :mdbk
+    dmap_attribute :persistent_id, :mper
+  end
+end

data/lib/dacpclient/models/databases.rb

@@ -0,0 +1,10 @@
+module DACPClient
+  class Databases < Model
+    dmap_tag :avdb
+    dmap_attribute :status, :mstt
+    dmap_attribute :update_type, :myty
+    dmap_attribute :container_count, :mtco
+    dmap_attribute :returned_count, :mrco
+    dmap_container :items, :mlcl, DACPClient::Database
+  end
+end

data/lib/dacpclient/models/playlist.rb

@@ -5,5 +5,6 @@ module DACPClient
     dmap_attribute :name, :minm
     dmap_attribute :base_playlist, :abpl
     dmap_attribute :count, :mimc
+    dmap_attribute :persistent_id, :mper
   end
 end

data/lib/dacpclient/version.rb

@@ -1,4 +1,4 @@
 # The DACPClient module
 module DACPClient
-  VERSION = '0.2.11'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dacpclient
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.3.0
 platform: ruby
 authors:
 - Jurriaan Pruis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: fuzzy_match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.4
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +174,8 @@ files:
 - lib/dacpclient/faraday/flatter_params_encoder.rb
 - lib/dacpclient/faraday/gzip.rb
 - lib/dacpclient/model.rb
+- lib/dacpclient/models/database.rb
+- lib/dacpclient/models/databases.rb
 - lib/dacpclient/models/pair_info.rb
 - lib/dacpclient/models/play_queue.rb
 - lib/dacpclient/models/play_queue_item.rb