squeezer-ruby 0.1.1 → 0.2.0

data/.autotest

@@ -0,0 +1,14 @@
+require "autotest/timestamp"
+require 'autotest/growl' if RUBY_PLATFORM.to_s.include?("darwin")
+require 'autotest/fsevent' if RUBY_PLATFORM.to_s.include?("darwin")
+
+# adds exceptions from .gitignore file, please modify exceptions there!
+imported_exceptions =  IO.readlines('.gitignore').inject([]) do |acc, line|
+  acc << line.strip if line.to_s[0] != '#' && line.strip != ''; acc
+end
+
+Autotest.add_hook :initialize do |autotest|
+  imported_exceptions.each do |exception|
+    autotest.add_exception(exception)
+  end
+end

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 ._*
 Gemfile.lock
 coverage/*
@@ -6,3 +7,4 @@ test.rb
 .yardoc
 .bundle
 .AppleDouble
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--drb

data/README.mkd

@@ -10,7 +10,7 @@ This project is in it's early stages, it is not finished by any means.
 It also lacks proper error handling and documentation.
 Most of the critical refactor points have been marked with a 'todo' comment.
 
-- active record like search methods and model relations (database chained search engine?)
+- active record like search methods and model relations (database, chained search engine?)
 - playlist handling
 - add convenience methods
 - add some more sugar
@@ -30,10 +30,14 @@ General:
 	  config.port = 9090
 	end
 
-	client = Squeezer::Client.new
-
-	puts client.version
+	# execute block and close the connection when done
+	Squeezer.open do |client|
+	  puts client.version
+	  puts Track.total
+	end
 
+	# or start a client and call exit manually
+	client = Squeezer::Client.new
 	client.players.each do |id, player|
 	  puts "Name: #{player.name}"
 	  puts "Model: #{player.model}"
@@ -41,10 +45,9 @@ General:
 	  puts "Volume: #{player.volume}"
   
 	  player.on! if player.off?
+	
 	  player.volume = "+40"
 	end
-
-	puts client.total_artists
 	
 	client.artists.each do |artist|
 	  puts artist.name
@@ -59,8 +62,28 @@ Models:
   
 	  puts Player.find_by_name("living room").ip
 	  puts Player.find_by_ip("192.168.1.1").name
+	  
+	  Artist.all.each do |artist|
+	     puts artist.name
+	  end
+
+	  puts Album.total
 	end
 
+Testing
+-------
+Run all tests:
+
+	rake tests:run
+
+Start Spork DRb server, for faster testing:
+
+	rake tests:spork
+	
+Run a continuous testing environment with autotest (configure .autotest for your own needs):
+
+	rake tests:autotest
+
 Copyright
 ---------
 Copyright (c) 2011 Daniël van Hoesel.

data/Rakefile

@@ -17,3 +17,20 @@ namespace :doc do
     ]
   end
 end
+
+namespace :tests do
+  desc "Run Spork DRb server, for faster tests"
+  task :spork do |task|
+    sh "spork"
+  end
+
+  desc "Run a continuous testing environment"
+  task :autotest do |task|
+    sh "autotest"
+  end
+  
+  desc "Run all tests"
+  task :run do |task|
+    Rake::Task[:spec].execute
+  end
+end

data/lib/squeezer.rb

@@ -3,12 +3,12 @@ require 'uri'
 require File.expand_path('../squeezer/core_extentions', __FILE__)
 require File.expand_path('../squeezer/configuration', __FILE__)
 require File.expand_path('../squeezer/api', __FILE__)
-require File.expand_path('../squeezer/client', __FILE__)
 require File.expand_path('../squeezer/models', __FILE__)
+require File.expand_path('../squeezer/client', __FILE__)
 
 module Squeezer
   extend Configuration
-    
+  
   # Alias for Squeezer::Client.new
   #
   # @return [Squeezer::Client]
@@ -22,4 +22,13 @@ module Squeezer
     client.send(method, *args, &block)
   end
   
-end
+  # Convenience method to execute client calls in a block.
+  # The connection closes automatically at the end of the block.
+  def self.open(&block)
+    client.instance_eval(&block)
+    Squeezer.exit
+  end
+  
+end
+
+include Squeezer::Models if $DEBUG

data/lib/squeezer/client.rb

@@ -1,7 +1,9 @@
 module Squeezer
   class Client < API
     Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
-        
+    
+    include Squeezer::Models
+       
     include Squeezer::Client::Database
     include Squeezer::Client::General
     include Squeezer::Client::Players

data/lib/squeezer/client/database.rb

@@ -2,48 +2,69 @@ module Squeezer
   class Client
     module Database
       
+      # TODO do we really need this methods?
+      # can't we just use the model's class methods?
+      
       # doesn't include 'Various Artists'
       def total_artists
-        count(:artists)
+        Models::Artist.total
       end
       
       def total_albums
-        count(:albums)
+        Models::Album.total
       end
       
-      def total_songs
-        count(:songs)
+      def total_tracks
+        Models::Track.total
       end
       
       def total_genres
-        count(:genres)
+        Models::Genre.total
       end
       
-      def count(entity)
-        raise "unknown entity" unless %w{artists albums songs genres}.include?(entity.to_s)
-        cmd("info total #{entity.to_s} ?").to_i
+      def artists
+        Models::Artist.all
       end
       
-      # TODO this is ugly, refactor!
-      def artists
-        Models::Model.entities(Models::Artist, extract_data([:id, :artist, :textkey], cmd("artists 0 #{total_artists + 1} charset:utf8 tags:s")))
+      def albums
+        Models::Album.all
+      end
+      
+      def tracks
+        Models::Track.all
+      end
+      
+      def genres
+        Models::Genre.all
+      end
+      
+      def rescan!
+        cmd("rescan")
+      end
+      
+      def scanning?
+        cmd("rescan ?").to_boolean
       end
 
-      private
+      # "The "abortscan" command causes Squeezebox Server to cancel a running scan. 
+      # Please note that after stopping a scan this way you'll have to fully rescan 
+      # your music collection to get consistent data."
+      def abortscan!
+        cmd("abortscan")
+      end
 
-      # TODO optimize this, attributes have to be in the correct order for the regex to match, which is stupid
-      def extract_data(attributes, data)  
-        result = Array.new
-        data.scan Regexp.new(attributes.map{|a| "#{a.to_s}%3A([^\s]+)" }.join(" ")) do |match|
-          record = Hash.new
-          match.each_with_index do |field, index|
-            record[attributes[index]] = URI.unescape(field)
-          end
-          result << record
-        end
-        result.size == 1 ? result.first : result
+      # The "wipecache" command allows the caller to have the Squeezebox Server rescan 
+      # its music library, reloading the music file information. This differs from the 
+      # "rescan!" command in that it first clears the tag database. During a rescan 
+      # triggered by "wipecache!", "rescan?" returns true.
+      def wipecache!
+        cmd("wipecache")
       end
 
+      # TODO format the return data better and make it useful
+      def rescan_progress
+        extract_hash_from_data(cmd("rescanprogress"))
+      end
     end
   end
 end

data/lib/squeezer/client/utils.rb

@@ -1,7 +1,16 @@
 module Squeezer
   class Client
     module Utils
+      private
       
+        # update regex to play nice with : chars
+        def extract_hash_from_data(data)
+          record = Hash.new
+          data.scan(/([^\s]+)%3A([^\s]+)/) do |match|
+            record[match[0].to_sym] = URI.unescape(match[1])
+          end
+          record
+        end
     end
   end
 end

data/lib/squeezer/configuration.rb

@@ -6,8 +6,8 @@ module Squeezer
     # An array of valid keys in the options hash when configuring an {Squeezer::API}
     VALID_OPTIONS_KEYS = [:server, :port].freeze
 
-    # By default, don't set an server
-    DEFAULT_SERVER = nil.freeze
+    # By default, set localhost as the server
+    DEFAULT_SERVER = "127.0.0.1".freeze
 
     # The port where the CLI interface is running on
     #

data/lib/squeezer/connection.rb

@@ -14,18 +14,7 @@ module Squeezer
     private
     
     def cmd(command, options={})
-      # TODO raise exceptions instead of returning false
-      response = connection.cmd(command)
-      puts response if options == :debug
-      return false if response.nil?
-      return true if response.strip.eql?(command)
-      result = response.gsub(command.gsub('?', '').strip, '').strip
-      result.force_encoding("UTF-8") unless /^1\.8/ === RUBY_VERSION
-      result
-    end
-    
-    def connection
-      Connection.retrieve_connection
+      Connection.exec(command, options)
     end
     
     class << self
@@ -34,13 +23,30 @@ module Squeezer
         @connection = nil
       end
       
+      def exec(command, options={})
+        # TODO raise exceptions instead of returning false
+        response = retrieve_connection.cmd(command)
+        puts response if options == :debug
+        return false if response.nil?
+        return true if response.strip.eql?(command)
+        result = response.gsub(command.gsub('?', '').strip, '').strip
+        result.force_encoding("UTF-8") unless /^1\.8/ === RUBY_VERSION
+        result
+      end
+      
       def retrieve_connection
         @connection ||= open_connection
       end
       
-      def open_connection
-        # do authentication and stuff
-        Net::Telnet.new("Host" => Squeezer.server, "Port" => Squeezer.port, "Telnetmode" => false, "Prompt" => /\n/)
+      def open_connection  
+        # TODO do authentication and stuff
+        # TODO fix the timeout if we receive a large ammount of data 
+        # TODO add error handling when the host is unavailable
+        begin
+          Net::Telnet.new("Host" => Squeezer.server, "Port" => Squeezer.port, "Telnetmode" => false, "Prompt" => /\n/)
+        rescue
+          raise "connection failed"
+        end
       end
     end
     

data/lib/squeezer/models.rb

@@ -1,21 +1,24 @@
 module Squeezer
   module Models
   
-    class Model < API
-    
-      def self.entities(model, data)
-        result = Array.new
-        return result if data.nil?
-        data.each do |record|
-          entity = model.send(:new)
-          record.each do |attribute, value|
-            entity.send("#{attribute}=", value)
+    class Model < API  
+      
+      # update regex to play nice with : chars
+      def self.extract_records(data)
+        records = Array.new
+        record = Hash.new
+        data.scan(/([^\s]+)%3A([^\s]+)/) do |match|
+          if match[0] == "id"
+            records << record unless record.empty?
+            record = {:id => URI.unescape(match[1])}
           end
-          result << entity
+          record[match[0].to_sym] = URI.unescape(match[1]) unless record.empty?
         end
-        result
+        record.delete(:count)
+        records << record unless record.empty?
+        records
       end
-                
+    
     end
   
     Dir[File.expand_path('../models/*.rb', __FILE__)].each{|f| require f}

data/lib/squeezer/models/album.rb

@@ -0,0 +1,34 @@
+module Squeezer
+  module Models
+    
+    class Album < Model
+      attr_reader :id, :name
+      
+      def initialize(record)
+        unless record.nil?
+          @id = record[:id] if record.key?(:id)
+          @name = record[:title] if record.key?(:title)
+          @discs = record[:disccount] if record.key?(:disccount)
+        end
+      end
+      
+      def discs
+        @discs.nil? ? 1 : @discs.to_i
+      end
+            
+      def self.total
+        Connection.exec("info total albums ?").to_i
+      end
+      
+      def self.all
+        results = Array.new
+        Model.extract_records(Connection.exec("albums 0 #{total} charset:utf8 tags:tqs")).each do |record|
+          results << Album.new(record)
+        end
+        results
+      end
+      
+    end
+    
+  end
+end

data/lib/squeezer/models/artist.rb

@@ -1,8 +1,28 @@
 module Squeezer
   module Models
+    
     class Artist < Model
-      attr_accessor :id, :artist, :textkey
-      alias :name :artist
+      attr_accessor :id, :name
+      
+      def initialize(record)
+        unless record.nil?
+          @id = record[:id] if record.key?(:id)
+          @name = record[:artist] if record.key?(:artist)
+        end
+      end
+            
+      def self.total
+        Connection.exec("info total artists ?").to_i
+      end
+      
+      def self.all
+        results = Array.new
+        Model.extract_records(Connection.exec("artists 0 #{total + 1} charset:utf8 tags:s")).each do |record|
+          results << Artist.new(record)
+        end
+        results
+      end
     end
+    
   end
 end

data/lib/squeezer/models/genre.rb

@@ -0,0 +1,28 @@
+module Squeezer
+  module Models
+    
+    class Genre < Model
+      attr_accessor :id, :name
+      
+      def initialize(record)
+        unless record.nil?
+          @id = record[:id] if record.key?(:id)
+          @name = record[:genre] if record.key?(:genre)
+        end
+      end
+            
+      def self.total
+        Connection.exec("info total genres ?").to_i
+      end
+
+      def self.all
+        results = Array.new
+        Model.extract_records(Connection.exec("genres 0 #{total} charset:utf8 tags:s")).each do |record|
+          results << Genre.new(record)
+        end
+        results
+      end
+    end
+    
+  end
+end