hearken 0.0.1 → 0.0.2

data/lib/hearken/scrobbler.rb

@@ -0,0 +1,76 @@
+require 'splat'
+require 'simple_scrobbler'
+require 'hearken/debug'
+
+module Hearken
+  class Scrobbler
+    include Debug
+
+    def initialize preferences
+      @preferences = preferences
+      if preferences['lastfm']
+        debug "Configuring scrobbler with #{preferences['lastfm'].inspect}"
+        @scrobbler = SimpleScrobbler.new *%w{api_key secret user session_key}.map{|k| preferences['lastfm'][k]}
+      end
+    end
+
+    def scrobble track
+      return unless @scrobbler
+      debug "Scrobbling to last fm: #{track}"
+      send_to_scrobbler :submit, track
+    end
+
+    def update track
+      return unless @scrobbler
+      debug "Updating now listening with last fm: #{track}"
+      send_to_scrobbler :now_playing, track
+    end
+
+    def ask question
+      print question
+      gets.chomp
+    end
+
+    def setup
+      puts <<-EOF
+      Because of the way lastfm authentication works, setting up lastfm involves two steps:
+      Firstly, you need to register that you are developing an application. This will give you an api key and an associated 'secret'
+      Secondly, you need to gives your application access your lastfm account.  This will give a authenticated session.
+
+      Step 1. Logging in to your lastfm account and register an application
+      This will launch a browser.  You need to log in and fill out the API registration form
+      EOF
+      answer = ask 'Are you ready ? '
+      return unless answer.downcase.start_with? 'y'
+      "http://www.last.fm/api/account".to_launcher
+      preferences = {}
+      preferences['api_key'] = ask 'What is your API key ? '
+      preferences['secret'] = ask 'What is your secret ? '
+      puts <<-EOF
+      Now you've got you application details, you need to create an authentication session between your application and your lastfm account
+      Step 2. Authorising your application to access your lastfm account
+      This will launch another browser. You just need to give your application permission to access your account
+      EOF
+      preferences['user'] = ask 'What is your lastfm user name ? '
+      @scrobbler = SimpleScrobbler.new preferences['api_key'], preferences['secret'], preferences['user']
+      preferences['session_key'] = @scrobbler.fetch_session_key do |url|
+        url.to_launcher
+        ask 'Hit enter when you\'ve allowed your application access to your account'
+      end
+      @preferences['lastfm'] = preferences
+    end
+private
+    def send_to_scrobbler message, track
+      begin
+        debug %w{artist title time album track}.map {|k| "#{k}=#{track.send(k)}"}.join(',')
+        @scrobbler.send message, track.artist,
+          track.title,
+          :length => track.time,
+          :album => track.album,
+          :track_number => track.track
+      rescue Exception => e
+        puts "Failed to scrobble: #{e}"
+      end
+    end
+  end
+end

data/lib/hearken/tagged.rb

@@ -0,0 +1,15 @@
+module Hearken::Tagged
+  FILE_FIELDS = %w{path timestamp}
+  TAG_FIELDS = %w{album track title artist time date albumartist puid mbartistid mbalbumid mbalbumartistid asin}
+  FIELDS = FILE_FIELDS + TAG_FIELDS
+
+  attr_accessor *FIELDS.map {|field| field.to_sym }
+
+  def no_tag_fields?
+    TAG_FIELDS.select {|field| send field }.empty?
+  end
+
+  def to_a
+    FIELDS.map { |field| send field }
+  end
+end

data/lib/hearken/track.rb

@@ -0,0 +1,38 @@
+require 'hearken/tagged'
+require 'rainbow'
+
+class Hearken::Track
+  include Hearken::Tagged
+  attr_accessor :id, :started
+
+  def initialize id=nil
+    @id = id
+  end
+
+  def [] key
+    self.send key
+  end
+
+  def valid?
+    @track
+  end
+
+  def search_id
+    id.to_s 36
+  end
+
+  def duration
+  end
+
+  def search_string
+    "#{self.artist.to_s.downcase}#{self.album.to_s.downcase}#{self.title.to_s.downcase}"
+  end
+
+  def to_s
+    "#{my(:search_id,:white)}: #{my(:artist, :yellow)} - #{my(:album,:cyan)} - #{my(:track,:magenta)} #{my(:title,:green)} (#{my(:time,:white)})"
+  end
+
+  def my field, colour
+    self.send(field).to_s.foreground(colour)
+  end
+end

data/lib/hearken/version.rb

@@ -1,3 +1,3 @@
 module Hearken
-  VERSION = "0.0.1"
-end
+  VERSION = '0.0.2'
+end

data/spec/hearken/command/enqueue_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../../spec_helper'
+require 'hearken/command/enqueue'
+
+describe Hearken::Command::Enqueue do
+  extend ShellShock::CommandSpec
+
+  with_usage '*<id>'
+  with_help 'enqueues the list of songs with the specified ids'
+
+  before do
+    @player = stub('player')
+    @command = Hearken::Command::Enqueue.new @player
+  end
+
+  it 'should enqueue whatever is returned from the expander' do
+    expander = stub('expander')
+    Hearken::RangeExpander.should_receive(:new).and_return(expander)
+    expander.should_receive(:expand).with('some text').and_return([1,2,3])
+
+    [1,2,3].each {|id| @player.should_receive(:enqueue).with id}
+
+    @command.execute "some text"
+  end
+end

data/spec/hearken/command/list_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../../spec_helper'
+require 'hearken/command/list'
+
+describe Hearken::Command::List do
+  extend ShellShock::CommandSpec
+
+  with_help <<EOF
+lists the contents of the track queue
+these results can optionally be filtered by specified words
+when playing, approximate times for each track will be displayed
+EOF
+
+  before do
+    @player = stub('player')
+    @command = Hearken::Command::List.new @player
+  end
+
+  it 'should display nothing when there is no current track and nothing enqueued' do
+    @player.stub!(:current).and_return nil
+    @player.stub! :each
+    @command.execute ''
+  end
+
+  it 'should display queue contents with no times when there is no current track' do
+    track = stub 'track'
+    @player.stub!(:current).and_return nil
+    @player.stub!(:each).and_yield track
+    @command.should_receive(:puts).with track
+    @command.execute ''
+  end
+end

data/spec/hearken/command/reload_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../spec_helper'
+require 'hearken/command/reload'
+
+describe Hearken::Command::Reload do
+  extend ShellShock::CommandSpec
+
+  with_usage ''
+  with_help 'reloads the contents of the music library for fast searching'
+
+  before do
+    @library = stub('library')
+    @player = stub('player', :library => @library)
+    @command = Hearken::Command::Reload.new @player
+  end
+
+  it 'should reload the library' do
+    @library.should_receive(:reload)
+    @command.execute '123'
+  end
+end

data/spec/hearken/command/shuffle_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../../spec_helper'
+require 'hearken/command/shuffle'
+
+describe Hearken::Command::Shuffle do
+  extend ShellShock::CommandSpec
+
+  with_usage ''
+  with_help 'shuffles the current queue'
+
+  before do
+    @player = stub 'player'
+    @command = Hearken::Command::Shuffle.new @player
+  end
+
+  it 'should dequeue all tracks, shuffle then enqueue them' do
+    @player.should_receive(:dequeue).and_return(1)
+    @player.should_receive(:dequeue).and_return(2)
+    @player.should_receive(:dequeue).and_return(3)
+    @player.should_receive(:dequeue).and_return nil
+
+    @player.should_receive(:enqueue).with 3
+    @player.should_receive(:enqueue).with 2
+    @player.should_receive(:enqueue).with 1
+
+    @command.execute
+  end
+end

data/spec/hearken/player_spec.rb

@@ -0,0 +1,37 @@
+require_relative '../spec_helper'
+require 'hearken/player'
+
+describe Hearken::Player do
+  let(:preferences) { {} }
+  let(:player) { Hearken::Player.new preferences }
+
+  before do
+    scrobbler = mock 'scrobbler'
+    library = mock 'library'
+    Hearken::Scrobbler.stub!(:new).and_return scrobbler
+    Hearken::Library.stub!(:new).and_return library
+    library.stub! :reload
+  end
+
+  describe '#current' do
+    it 'should return current_track when player has pid and file is present' do
+      player.instance_eval { @pid = 1 }
+      hash = stub 'hash'
+      File.stub!(:exist?).with('current_song').and_return true
+      YAML.stub!(:load_file).with('current_song').and_return hash
+      player.current.should == hash
+    end
+
+    it 'should return nil when player has no pid and file is present' do
+      player.instance_eval { @pid = nil }
+      File.stub!(:exist?).with('current_song').and_return true
+      player.current.should == nil
+    end
+
+    it 'should return nil when has pid and file is not present' do
+      player.instance_eval { @pid = 1 }
+      File.stub!(:exist?).with('current_song').and_return false
+      player.current.should == nil
+    end
+  end
+end

data/spec/hearken/range_expander_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../spec_helper'
+require 'hearken/range_expander'
+
+describe Hearken::RangeExpander do
+  before do
+    @expander = Hearken::RangeExpander.new
+  end
+
+  it 'should expand single values' do
+    @expander.expand('123').should == [1371]
+  end
+
+  it 'should expand multiple values separated by any non digit' do
+    @expander.expand("123 \t 456  , 789 ").should == [1371, 5370, 9369]
+  end
+
+  it 'should expand a fully specified range' do
+    @expander.expand(" 456-45i ").should == (5370..5382).to_a
+  end
+
+  it 'should expand an abbreviated range' do
+    @expander.expand(" 456-i ").should == (5370..5382).to_a
+  end
+
+  it 'should expand ids for a range' do
+    @expander.expand_to_ids(" s-z ").should == %w{s t u v w x y z}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'bundler/setup'
+require 'rspec'
+require 'shell_shock/command_spec'

metadata

@@ -2,7 +2,7 @@
 name: hearken
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mark Ryall
@@ -10,10 +10,86 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-04 00:00:00 +10:00
+date: 2011-07-05 00:00:00 +10:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: splat
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shell_shock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: simple_scrobbler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2"
+  type: :development
+  version_requirements: *id007
 description: |
   A command line tool to enqueue and play music tracks.
   
@@ -23,19 +99,65 @@ description: |
 
 email: 
 - mark@ryall.name
-executables: []
-
+executables: 
+- hearken
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rvmrc
 - Gemfile
+- README.rdoc
 - Rakefile
+- bin/hearken
 - hearken.gemspec
 - lib/hearken.rb
+- lib/hearken/cli.rb
+- lib/hearken/command.rb
+- lib/hearken/command/enqueue.rb
+- lib/hearken/command/flush.rb
+- lib/hearken/command/list.rb
+- lib/hearken/command/recent.rb
+- lib/hearken/command/reload.rb
+- lib/hearken/command/restart.rb
+- lib/hearken/command/scrobbling.rb
+- lib/hearken/command/search.rb
+- lib/hearken/command/setup_scrobbling.rb
+- lib/hearken/command/show_properties.rb
+- lib/hearken/command/shuffle.rb
+- lib/hearken/command/start.rb
+- lib/hearken/command/status.rb
+- lib/hearken/command/stop.rb
+- lib/hearken/console.rb
+- lib/hearken/debug.rb
+- lib/hearken/indexing.rb
+- lib/hearken/indexing/audio_traverser.rb
+- lib/hearken/indexing/executor.rb
+- lib/hearken/indexing/ffmpeg_file.rb
+- lib/hearken/indexing/file.rb
+- lib/hearken/indexing/indexer.rb
+- lib/hearken/indexing/parser.rb
+- lib/hearken/indexing/persistant_traverser.rb
+- lib/hearken/indexing/persisted_traverser.rb
+- lib/hearken/library.rb
+- lib/hearken/player.rb
+- lib/hearken/preferences.rb
+- lib/hearken/queue.rb
+- lib/hearken/range_expander.rb
+- lib/hearken/scrobbler.rb
+- lib/hearken/tagged.rb
+- lib/hearken/track.rb
 - lib/hearken/version.rb
+- media/applause.mp3
+- spec/hearken/command/enqueue_spec.rb
+- spec/hearken/command/list_spec.rb
+- spec/hearken/command/reload_spec.rb
+- spec/hearken/command/shuffle_spec.rb
+- spec/hearken/player_spec.rb
+- spec/hearken/range_expander_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/markryall/hearken
 licenses: []
@@ -64,5 +186,11 @@ rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: command line music player
-test_files: []
-
+test_files: 
+- spec/hearken/command/enqueue_spec.rb
+- spec/hearken/command/list_spec.rb
+- spec/hearken/command/reload_spec.rb
+- spec/hearken/command/shuffle_spec.rb
+- spec/hearken/player_spec.rb
+- spec/hearken/range_expander_spec.rb
+- spec/spec_helper.rb