hearken 0.0.6 → 0.1.0

data/HISTORY.rdoc

@@ -1,3 +1,11 @@
+= 0.1.0
+
+* removed several dependencies - simple_scrobbler and thor
+* split hearken command into two
+* added 'love' command (to mark current track as loved)
+* added 'profile' command (to launch last.fm profile to see track history)
+* replaced 'flush' with an 'rm' command that can remove tracks matches criteria
+
 = 0.0.5
 
 * fixed 'recent' command - the library is sorted on file modification date

data/README.rdoc

@@ -24,17 +24,18 @@ Growl notification (as new tracks are played) will work but only if 'growlnotify
 
 == Indexing tracks
 
-    hearken index DIRECTORY
+    hearken_index DIRECTORY
 
-Will create a track index at ~/.hearken/music.  Note that this might take a while the first time you run it.
+Will create a track index at ~/.hearken/music.
 
-Subsequent runs will only query tags for new or modified files so should be fairly fast.
+Note that this will take a long time first time you run it if you have a large collection of music.  Subsequent
+runs will only query tags for new or modified files so will be very fast.
 
 The index can be regenerated while the console is running and reloaded using the 'reload' command.
 
 == Console
 
-    hearken console
+    hearken
 
 This enters an interactive prompt where you can start/stop the player, search and enqueue tracks.
 
@@ -62,7 +63,7 @@ Results will be displayed and the ids will be added to the clipboard (for conven
 
 Enqueues tracks with ids abc, abd, abe, abf, 123 and 456
 
-    start
+    play
 
 Starts the player
 
@@ -74,23 +75,28 @@ Stops the player
 
 Stops and restarts the player (which will kill the currently playing track)
 
+    love
+
+Tells last.fm that you love the current track (this will do nothing if last.fm is not configured or the player is
+stopped)
+
+    rm iver bon
+
+Removes any enqueued track with 'bon' and 'iver' in the track, artist or album name
+
     setup_scrobbling
 
 Runs through a wizard to configure scrobbling to last.fm
 
-	scrobbling on
+    scrobbling on
 
 Turns scrobbling on (has no effect if scrobbling has not been configured)
 
-	scrobbling off
+    scrobbling off
 
 Turns scrobbling off
 
 = Future plans for world domination
 
-* add a '-' command to remove tracks from queue
-* add a command to launch last.fm profile (for track history)
-* put some content on wiki to explain usage (especially use of track ranges '+ eft-z')
-* eliminate last.fm setup command once setup and add lastfm commands only when setup
 * Get working on linux
 * Get working on windows

data/bin/hearken

@@ -2,6 +2,6 @@
 
 $: << File.dirname(__FILE__)+'/../lib'
 
-require 'hearken/cli'
+require 'hearken/console'
 
-Hearken::Cli.start
+Hearken::Console.new.push

data/bin/hearken_index

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__)+'/../lib'
+
+require 'hearken/indexing'
+
+unless ARGV.size == 1
+  puts "usage: hearken_index path_to_directory_containing_music_collection"
+  exit
+end
+
+Hearken::Indexing::Indexer.new(ARGV.shift).execute

data/hearken.gemspec

@@ -24,12 +24,10 @@ EOF
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'thor', '~>0'
   s.add_dependency 'splat', '~>0'
   s.add_dependency 'shell_shock', '~>0'
-  s.add_dependency 'simple_scrobbler', '~> 0'
   s.add_dependency 'rainbow', '~> 1'
-  s.add_dependency 'ruby-growl', '~> 3.0'
+  s.add_dependency 'nokogiri', '~> 1'
 
   s.add_development_dependency 'rake', '~>0'
   s.add_development_dependency 'rspec', '~>2'

data/lib/hearken.rb

@@ -1,3 +1,3 @@
 module Hearken
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/lib/hearken/command/love.rb

@@ -0,0 +1,7 @@
+require 'hearken/command'
+
+class Hearken::Command::Love
+  include Hearken::Command
+  help 'sends love for the current track to last fm'
+  execute {|ignored| @player.love }
+end

data/lib/hearken/command/profile.rb

@@ -0,0 +1,7 @@
+require 'hearken/command'
+
+class Hearken::Command::Profile
+  include Hearken::Command
+  help 'launches last fm profile'
+  execute {|ignored| @player.profile }
+end

data/lib/hearken/command/remove.rb

@@ -0,0 +1,15 @@
+require 'hearken/command'
+
+class Hearken::Command::Remove
+  include Hearken::Command
+  usage '*<word>'
+  help 'removes all tracks that match the specified criteria - specifying no criteria will flush entire queue'
+  execute do |text|
+    @terms = text.split(/\W/)
+    ids = []
+    while track = @player.dequeue
+      ids << track.id unless @terms.all? {|term| track.search_string.include? term }
+    end
+    ids.each {|id| @player.enqueue id }
+  end
+end

data/lib/hearken/console.rb

@@ -1,5 +1,6 @@
 require 'shell_shock/context'
 
+require 'hearken'
 require 'hearken/player'
 require 'hearken/preferences'
 require 'hearken/command'
@@ -27,8 +28,10 @@ module Hearken
       with :status, "'"
       with :restart, 'next'
       with :list, 'ls'
-      with :enqueue, '+'
-      with_all *%w{reload search start stop scrobbling shuffle setup_scrobbling recent flush}
+      with :enqueue, 'add'
+      with :remove, 'rm'
+      with :start, 'play'
+      with_all *%w{reload search stop scrobbling shuffle setup_scrobbling recent love profile}
     end
   end
 end

data/lib/hearken/player.rb

@@ -34,6 +34,14 @@ module Hearken
       end
     end
 
+    def love
+      @scrobbler.love current
+    end
+
+    def profile
+      @scrobbler.profile
+    end
+
     def current
       in_base_dir do
         (@pid and File.exist?('current_song')) ? YAML.load_file('current_song') : nil
@@ -65,6 +73,11 @@ module Hearken
 
     def start
       return if @pid
+      if @library.count == 0
+        puts 'Player can not be started with an empty library'
+        puts 'Please run "hearken_index" in another shell and then \'reload\''
+        return
+      end
       @pid = fork do
         player_pid = nil
         Signal.trap('TERM') do

data/lib/hearken/scrobbler.rb

@@ -1,9 +1,12 @@
 require 'splat'
-require 'simple_scrobbler'
+require 'hearken/simple_scrobbler'
 require 'hearken/debug'
 
+# Modified version of simple_scrobbler gem from https://github.com/threedaymonk/simple_scrobbler
 module Hearken
   class Scrobbler
+    API_KEY = '21f8c75ad38637220b20a03ad61219a4'
+    SECRET = 'ab77019c84eef8bc16bcfd5ba8db0c5d'
     include Debug
 
     def initialize preferences
@@ -14,14 +17,15 @@ module Hearken
       @scrobbler = nil
       if @preferences['lastfm'] and tf
         debug "Configuring scrobbler with #{@preferences['lastfm'].inspect}"
-        @scrobbler = SimpleScrobbler.new *%w{api_key secret user session_key}.map{|k| @preferences['lastfm'][k]}
+        user, session = *%w{user session_key}.map{|k| @preferences['lastfm'][k]}
+        @scrobbler = SimpleScrobbler.new API_KEY, SECRET, user, session
       end
     end
 
     def finished track
       return unless @scrobbler
       debug "Scrobbling to last fm: #{track}"
-      send_to_scrobbler :submit, track
+      send_to_scrobbler :scrobble, track
     end
 
     def started track
@@ -30,36 +34,29 @@ module Hearken
       send_to_scrobbler :now_playing, track
     end
 
+    def love track
+      return unless @scrobbler and track
+      debug "Sending love to last fm: #{track}"
+      send_to_scrobbler :love, track
+    end
+
+    def profile
+      return unless @scrobbler
+      @scrobbler.with_profile_url {|url| url.to_launcher }
+    end
+
     def ask question
       print question
       $stdin.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']
+      @scrobbler = SimpleScrobbler.new API_KEY, 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'
+        ask 'Please hit enter when you\'ve allowed this application access to your account'
       end
       @preferences['lastfm'] = preferences
     end
@@ -69,9 +66,10 @@ private
         debug %w{artist title time album track}.map {|k| "#{k}=#{track.send(k)}"}.join(',')
         @scrobbler.send message, track.artist,
           track.title,
-          :length => track.time,
+          :duration => track.time,
           :album => track.album,
-          :track_number => track.track
+          :trackNumber => track.track.to_i,
+          :timestamp => Time.now.to_i
       rescue Exception => e
         puts "Failed to scrobble: #{e}"
       end

data/lib/hearken/simple_scrobbler.rb

@@ -0,0 +1,94 @@
+require "net/http"
+require "digest/md5"
+require "uri"
+require "cgi"
+require 'nokogiri'
+require 'hearken/debug'
+
+module Hearken; end
+
+class Hearken::SimpleScrobbler
+  include Hearken::Debug
+
+  SCROBBLER_URL = 'http://ws.audioscrobbler.com/2.0/'
+
+  SubmissionError = Class.new(RuntimeError)
+  SessionError    = Class.new(RuntimeError)
+
+  def initialize api_key, secret, user, session_key=nil
+    @api_key     = api_key
+    @secret      = secret
+    @user        = user
+    @session_key = session_key
+  end
+
+  attr_reader :user, :api_key, :secret, :session_key
+
+  def session_key
+    @session_key or raise SessionError, "The session key must be set or fetched"
+  end
+
+  def fetch_session_key
+    doc = lfm :get, 'auth.gettoken'
+    request_token = doc.at('token').inner_text
+    yield "http://www.last.fm/api/auth/?api_key=#{api_key}&token=#{request_token}"
+    doc = lfm :get, 'auth.getsession', :token => request_token
+    @session_key = doc.at('key').inner_text
+    @user        = doc.at('name').inner_text
+    @session_key
+  end
+
+  def with_profile_url
+    yield "http://www.last.fm/user/#{user}" if user
+  end
+
+  # http://www.last.fm/api/show?service=443
+  def scrobble artist, title, params={}
+    lfm_track 'track.scrobble', artist, title, params
+  end
+
+  # See http://www.last.fm/api/show?service=454 for more details
+  def now_playing artist, title, params={}
+    lfm_track 'track.updateNowPlaying', artist, title, params
+  end
+
+  # http://www.last.fm/api/show?service=260
+  def love artist, title, params={}
+    lfm_track 'track.love', artist, title, params
+  end
+private
+  def lfm_track method, artist, title, params
+    doc = lfm :post, method, params.merge(:sk => session_key, :artist => artist, :track => title)
+    status = doc.at('lfm')['status']
+    raise SubmissionError, status unless status == 'ok'
+  end
+
+  def lfm get_or_post, method, parameters={}
+    p = signed_parameters parameters.merge :api_key => api_key, :method => method
+    debug p.inspect
+    xml = self.send get_or_post, SCROBBLER_URL, p
+    debug xml
+    Nokogiri::XML xml
+  end
+
+  def get url, parameters
+    query_string = sort_parameters(parameters).
+                   map{ |k, v| "#{k}=#{CGI.escape(v)}" }.
+                   join("&")
+    Net::HTTP.get_response(URI.parse(url + "?" + query_string)).body
+  end
+
+  def post url, parameters
+    Net::HTTP.post_form(URI.parse(url), parameters).body
+  end
+
+  def signed_parameters parameters
+    sorted    = sort_parameters parameters
+    signature = Digest::MD5.hexdigest(sorted.flatten.join + secret)
+    parameters.merge :api_sig => signature
+  end
+
+  def sort_parameters parameters
+    parameters.map{ |k, v| [k.to_s, v.to_s] }.sort
+  end
+end

metadata

@@ -1,122 +1,100 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hearken
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - Mark Ryall
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-07 00:00:00 +10:00
-default_executable: 
-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 
+date: 2011-09-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: splat
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70202662970320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0"
+      - !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 
+  version_requirements: *70202662970320
+- !ruby/object:Gem::Dependency
+  name: shell_shock
+  requirement: &70202662969820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0"
+      - !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 
+  version_requirements: *70202662969820
+- !ruby/object:Gem::Dependency
   name: rainbow
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70202662969360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: ruby-growl
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70202662969360
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70202662968900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70202662968900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70202662968440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *70202662968440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70202662967980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
-  version_requirements: *id008
-description: |
-  A command line tool to enqueue and play music tracks.
-  
+  prerelease: false
+  version_requirements: *70202662967980
+description: ! 'A command line tool to enqueue and play music tracks.
+
+
   This also extracts the tags from a collection of folders.
-  
-  This replaces and combines the functionality from a couple of other gems (audio_library and songbirdsh).
 
-email: 
+
+  This replaces and combines the functionality from a couple of other gems (audio_library
+  and songbirdsh).
+
+'
+email:
 - mark@ryall.name
-executables: 
+executables:
 - hearken
+- hearken_index
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - Gemfile
@@ -125,16 +103,18 @@ files:
 - README.rdoc
 - Rakefile
 - bin/hearken
+- bin/hearken_index
 - hearken.gemspec
 - lib/hearken.rb
-- lib/hearken/cli.rb
 - lib/hearken/colour.rb
 - lib/hearken/command.rb
 - lib/hearken/command/enqueue.rb
-- lib/hearken/command/flush.rb
 - lib/hearken/command/list.rb
+- lib/hearken/command/love.rb
+- lib/hearken/command/profile.rb
 - lib/hearken/command/recent.rb
 - lib/hearken/command/reload.rb
+- lib/hearken/command/remove.rb
 - lib/hearken/command/restart.rb
 - lib/hearken/command/scrobbling.rb
 - lib/hearken/command/search.rb
@@ -163,6 +143,7 @@ files:
 - lib/hearken/queue.rb
 - lib/hearken/range_expander.rb
 - lib/hearken/scrobbler.rb
+- lib/hearken/simple_scrobbler.rb
 - lib/hearken/tagged.rb
 - lib/hearken/track.rb
 - media/applause.mp3
@@ -174,35 +155,31 @@ files:
 - 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: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: hearken
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 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

data/lib/hearken/cli.rb

@@ -1,22 +0,0 @@
-require 'thor'
-
-require 'hearken'
-require 'hearken/indexing'
-require 'hearken/console'
-
-class Hearken::Cli < Thor
-  desc 'version', 'Prints the current version'
-  def version
-    puts "Current version is "+Hearken::VERSION
-  end
-
-  desc 'index DIRECTORY', 'Reindexes a music collection'
-  def index directory
-    Hearken::Indexing::Indexer.new(directory).execute
-  end
-
-  desc 'console', 'Enters console for queuing and playing tracks'
-  def console
-    Hearken::Console.new.push
-  end
-end

data/lib/hearken/command/flush.rb

@@ -1,7 +0,0 @@
-require 'hearken/command'
-
-class Hearken::Command::Flush
-  include Hearken::Command
-  help 'flushes the current queue'
-  execute {|ignored| loop { break unless @player.dequeue } }
-end