robut-rdio 0.1.0 → 0.1.2

data/lib/server/server.rb

@@ -34,6 +34,14 @@ class Robut::Plugin::Rdio
 
       # The domain associated with +token+. Defaults to localhost.
       attr_accessor :domain
+
+      # A callback set by to Robut plugin so the server can talk to it
+      attr_accessor :reply_callback
+      
+      # A callback for Hipchat Chat room to set the state of the robut
+      attr_accessor :state_callback
+      
+      attr_accessor :last_played_track
     end
     self.queue = []
     self.command = []
@@ -64,7 +72,34 @@ END
       self.class.command = []
       command.to_json
     end
+    
+    # Make an announcement into the Hipchat channel
+    get '/announcement/:message' do
+      self.announce! URI.unescape(params[:message].to_s)
+    end
 
+    # Make a now playing announcmenet into the Hipchat channel
+    get '/now_playing/:title' do
+      track_title = URI.unescape(params[:title].to_s)
+      
+      if self.track_is_not_the_same_as_last? track_title
+        self.state! "is now playing: #{track_title}"
+        self.class.last_played_track = track_title
+      end
+    end
+    
+    def state!(message)
+      self.class.state_callback.call(message) if self.class.state_callback
+    end
+    
+    def announce!(message)
+      self.class.reply_callback.call(message) if self.class.reply_callback
+    end
+    
+    def track_is_not_the_same_as_last? current_track
+      self.class.last_played_track != current_track
+    end
+    
     # start the server if ruby file executed directly
     run! if app_file == $0
   end

data/plugin-tester.rb

@@ -16,7 +16,7 @@ def @plugin.nick
   return 'dj'
 end
 
-def @plugin.reply(msg)
+def @plugin.reply(msg, to = nil)
   puts msg
 end
 

data/robut-rdio.gemspec

@@ -5,27 +5,27 @@
 
 Gem::Specification.new do |s|
   s.name = "robut-rdio"
-  s.version = "0.1.0"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Pearson"]
-  s.date = "2011-11-10"
+  s.date = "2011-12-08"
   s.description = ""
   s.email = "ampearson@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.md",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".rspec",
     ".rvmrc",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
+    "Guardfile",
     "LICENSE.txt",
     "README.md",
-    "README.rdoc",
     "Rakefile",
     "VERSION",
     "lib/robut-rdio.rb",
@@ -33,6 +33,12 @@ Gem::Specification.new do |s|
     "lib/server/public/css/style.css",
     "lib/server/public/css/style_after.css",
     "lib/server/public/images/background.png",
+    "lib/server/public/images/buffering.png",
+    "lib/server/public/images/circle-east.png",
+    "lib/server/public/images/circle-pause.png",
+    "lib/server/public/images/circle-play.png",
+    "lib/server/public/images/circle-stop.png",
+    "lib/server/public/images/disconnected.png",
     "lib/server/public/images/no-album.png",
     "lib/server/public/index.html",
     "lib/server/public/js/libs/dd_belatedpng.js",
@@ -44,8 +50,11 @@ Gem::Specification.new do |s|
     "lib/tasks/shell.rake",
     "plugin-tester.rb",
     "robut-rdio.gemspec",
+    "spec/integration/robut-rdio_spec.rb",
     "spec/robut-rdio_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/server_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/shared_examples.rb"
   ]
   s.homepage = "http://github.com/radamant/robut-rdio"
   s.licenses = ["MIT"]
@@ -58,35 +67,44 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<robut>, [">= 0"])
-      s.add_development_dependency(%q<thin>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_runtime_dependency(%q<rdio>, ["= 0.0.91"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
+      s.add_runtime_dependency(%q<thin>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<rdio>, ["= 0.0.91"])
-      s.add_development_dependency(%q<sinatra>, [">= 0"])
       s.add_development_dependency(%q<highline>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
     else
       s.add_dependency(%q<robut>, [">= 0"])
+      s.add_dependency(%q<rdio>, ["= 0.0.91"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
       s.add_dependency(%q<thin>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rdio>, ["= 0.0.91"])
-      s.add_dependency(%q<sinatra>, [">= 0"])
       s.add_dependency(%q<highline>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
     end
   else
     s.add_dependency(%q<robut>, [">= 0"])
+    s.add_dependency(%q<rdio>, ["= 0.0.91"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
     s.add_dependency(%q<thin>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rdio>, ["= 0.0.91"])
-    s.add_dependency(%q<sinatra>, [">= 0"])
     s.add_dependency(%q<highline>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
   end
 end
 

data/spec/integration/robut-rdio_spec.rb

@@ -0,0 +1,119 @@
+require_relative '../spec_helper'
+
+# Wherein we test legacy code, and hopefully refactor and remove this file
+describe "RobutRdio Super Integration Test" do
+ 
+  let(:plugin) do 
+    plugin = Robut::Plugin::Rdio.new(nil) 
+
+    def plugin.nick
+      "dj"
+    end
+
+    plugin.stub(:reply){ |msg| @reply = msg }
+
+    plugin
+  end
+
+  def say(msg)
+    plugin.handle(Time.now, 'foo bar', msg)
+  end
+
+  it 'should set up a callback for the Server on startup' do
+    say('boo')
+    Robut::Plugin::Rdio::Server.reply_callback.should_not be_nil
+  end
+
+  describe "searching for tracks" do
+
+    it 'should make an rdio search' do
+      stub_search('neil young', ['harvest', 'after the gold rush'])
+      say('@dj find neil young')
+      @reply.should == "result: harvest\nresult: after the gold rush\n"
+    end
+
+    def stub_search(mock_query, results)
+      plugin.stub(:search).with(mock_query) { results }
+      results.each do |result|
+        plugin.stub(:format_result).with(result, anything()) { "result: #{result}" }
+      end
+    end
+
+    
+  end
+
+  describe 'queuing tracks' do
+
+    describe 'when there is a search result' do
+      before do
+        plugin.stub(:result_at) { |i| i.to_s }
+        plugin.stub(:queue) { |result| @queued = result }
+        plugin.stub(:has_results?) { true }
+        plugin.stub(:has_result?) { true }
+      end
+
+      it 'should queue the track at the given position with "play <number>"' do
+        say '@dj play 1'
+        @queued.should == '1'
+
+        say '@dj 8'
+        @queued.should == '8'
+      end
+
+    end
+
+    describe 'when there are no search results' do
+      before do
+        plugin.stub(:has_results?) { false }
+      end
+
+      it 'should say there are no results' do
+        say '@dj play 9'
+        @reply.should == "I don't have any search results"
+      end
+    end
+
+    describe 'when there are results but not at the requested index' do
+      before do
+        plugin.stub(:has_results?) { true }
+        plugin.stub(:has_result?).with(5) { false }
+      end
+      it 'should say the result does not exist' do
+        say '@dj play 5'
+        @reply.should == "I don't have that result"
+      end
+    end
+  end
+
+  describe "I'm feeling lucky play/search" do
+  
+  end
+  describe 'running commands' do
+    before do
+      plugin.stub(:run_command) { |command| @command = command }
+    end
+
+    %w{play unpause pause next restart back clear}.each do |command|
+      it "should run #{command}" do
+        say("@dj #{command}")
+        @command.should == command
+      end
+    end
+  end
+
+  describe 'skipping an album' do
+    before do
+      plugin.stub(:run_command) { |command| @command = command }
+    end
+    it "should run next_album for `next album`" do
+      say("@dj next album")
+      @command.should == "next_album"
+    end
+
+    it "should run next_album for `skip album`" do
+      say("@dj skip album")
+      @command.should == "next_album"
+    end
+  end
+
+end

data/spec/robut-rdio_spec.rb

@@ -1,101 +1,244 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-# Wherein we test legacy code, and hopefully refactor and remove this file
-describe "RobutRdio Super Integration Test" do
-  let(:plugin) do plugin = Robut::Plugin::Rdio.new(nil) 
-  def plugin.nick
-    "dj"
-  end
-
-
-  plugin.stub(:reply){|msg|
-    @reply = msg
+describe Robut::Plugin::Rdio do
+  
+  subject { 
+    connection = double("connection")
+    connection.stub_chain(:config, :nick) { "dj" }
+    connection.stub(:store).and_return(store)
+    connection.stub(:reply).and_return(nil)
+    Robut::Plugin::Rdio.new connection 
   }
-
-  plugin
-  end
-
-  def say(msg)
-    plugin.handle(Time.now, 'foo bar', msg)
-  end
-
-  describe "searching for tracks" do
-
-
-    it 'should make an rdio search' do
-      stub_search('neil young', ['harvest', 'after the gold rush'])
-      say('@dj find neil young')
-      @reply.should == "result: harvest\nresult: after the gold rush\n"
-    end
-
-    def stub_search(mock_query, results)
-      plugin.stub(:search).with(['', mock_query]){results}
-      results.each do |result|
-        plugin.stub(:format_result).with(result, anything()){"result: #{result}"}
-      end
+  
+  let(:sender) { "sender" }
+  
+  let!(:store) { {} }
+  
+  let(:time) { Time.now }
+  
+  describe "#usage" do
+    
+    # Though it is acceptable for the plugin to return a String here,
+    # it is important that we return an Enumerable list of instruction examples
+    # as we have so many different commands.
+    it "should return a list of commands on how to use the plugin" do
+      subject.usage.should be_kind_of(Enumerable)
     end
-
     
   end
-
-  describe 'queuing tracks' do
-
-    describe 'when there is a search result' do
-      before do
-        plugin.stub(:result_at){|i| i.to_s}
-        plugin.stub(:queue){|result| @queued = result}
-        plugin.stub(:has_results?){true}
-        plugin.stub(:has_result?){true}
+  
+  describe "Routing Methods" do 
+    
+    describe "#play?", :method => :play? do
+      
+      it_should_behave_like "a routing method"
+
+      let(:valid_requests) do
+        [ 
+          # play keyword
+          "play 0",
+          "play 999999", 
+          [ "play", "0" ], 
+          # result keyword
+          "result1", 
+          "result 1", 
+          [ "result 0"],
+          # multiple tracks
+          "play 1, 2, 3",
+          "play 1 2 3",
+          "play 1 - 3",
+          "play 1-3",
+          # all tracks
+          "play all"
+        ]
       end
 
-      it 'should queue the track at the given position with "play <number>"' do
-        say '@dj play 1'
-        @queued.should == '1'
-
-        say '@dj 8'
-        @queued.should == '8'
+      let(:invalid_requests) do
+        [ 
+          "play Abba", 
+          "play ",
+          [ "play", "three-eleven" ]
+        ]
       end
 
     end
-
-    describe 'when there are no search results' do
-      before do
-        plugin.stub(:has_results?){false}
+    
+    describe "search?", :method => :search? do
+      
+      it_should_behave_like "a routing method"
+      
+      let(:valid_requests) do
+        [ 
+          "find the beatles", 
+          "do you have any grey poupon", 
+          [ "find", "breeders" ], 
+          "do you have Weezer", 
+          "find finding nemo"
+        ]
       end
 
-      it 'should say there are no results' do
-        say '@dj play 9'
-        @reply.should == "I don't have any search results"
+      let(:invalid_requests) do
+        [ 
+          "play Abba", 
+          "play ",
+          [ "play", "three-eleven" ]
+        ]
       end
+      
     end
-
-    describe 'when there are results but not at the requested index' do
-      before do
-        plugin.stub(:has_results?){true}
-        plugin.stub(:has_result?).with(5){false}
+    
+    describe "#search_and_play?", :method => :search_and_play? do
+      
+      it_should_behave_like "a routing method"
+      
+      let(:valid_requests) do
+        [ 
+          "play the beatles", 
+          [ "play", "breeders" ], 
+          "play doh re me ...", 
+          "play me a song mister piano man"
+        ]
       end
-      it 'should say the result does not exist' do
-        say '@dj play 5'
-        @reply.should == "I don't have that result"
+    
+      let(:invalid_requests) do
+        [ 
+          "play",
+          "find this and play it for me", 
+          " play even with that space at the start",
+          [ "plato", "first", "album" ]
+        ]
       end
+      
     end
+    
+    describe "#command?", :method => :command? do
+      
+      it_should_behave_like "a routing method"
+      
+      let(:valid_requests) do
+        [ 
+          "play", 
+          "pause",
+          "unpause",
+          "next",
+          "restart",
+          "back",
+          "clear",
+          [ "play" ]
+        ]
+      end
+    
+      let(:invalid_requests) do
+        [ 
+          " play",
+          "play       ",
+          "player",
+          "play-pause",
+          "clearing house"
+        ]
+      end
+      
+    end
+    
   end
-
-  describe "I'm feeling lucky play/search" do
   
-  end
-
-  describe 'running commands' do
-    before do
-      plugin.stub(:run_command){|command| @command = command}
+  describe "#handle" do
+    
+    it "should create a communication channel with the music server" do
+      
+      subject.should_receive(:establish_server_callbacks!).and_return(nil)
+      subject.handle(time,"","")
+      
     end
 
-    %w{play unpause pause next restart back clear}.each do |command|
-      it "should run #{command}" do
-        say("@dj #{command}")
-        @command.should == command
+    context "when not sent to the agent" do
+
+      let(:message) { "This message does not mention the dj" }
+      
+      it "should perform no action" do
+        
+        subject.should_not_receive(:play?)
+        subject.handle(time,sender,message)
+        
       end
+      
     end
+    
+    context "when sent to the agent" do
+      
+      context "when it is a play request" do
+        
+        let(:message) { "@dj play 0" }
+        
+        it_should_behave_like "a successfully routed action", 
+          :route => :play?, :action => :play_result, :parameters => 0
+        
+      end
+      
+      context "when it is a multiple play request" do
+        
+        let(:message) { "@dj play 1, 4 5-7" }
+        
+        it_should_behave_like "a successfully routed action",
+          :route => :play?, :action => :play_result, :parameters => [1,4,5,6,7]
+        
+      end
+      
+      context "when it is a search and play request" do
+        
+        let(:message) { "@dj play the misfits" }
+
+        context "when the search returns a result" do
+          
+          it_should_behave_like "a successfully routed action", 
+            :route => :search_and_play?, :action => :search_and_play_result, 
+              :parameters => "the misfits", :returning => true
+          
+        end
+        
+        context "when the search result does not return a result" do
+
+          before :each do 
+            subject.should_receive(:reply).with("I couldn't find 'the misfits' on Rdio.")
+          end
+
+          it_should_behave_like "a successfully routed action", 
+            :route => :search_and_play?, :action => :search_and_play_result, :parameters => "the misfits"
+          
+        end
+        
+      end
+      
+      context "when it is a search request" do
+        
+        let(:message) { "@dj find the partridge family" }
+        
+        it_should_behave_like "a successfully routed action",
+          :route => :search?, :action => :find, :parameters => "the partridge family"
+        
+      end
+      
+      context "when it is a skip album request" do
+        
+        let(:message) { "skip album @dj" }
+        
+        it_should_behave_like "a successfully routed action",
+          :route => :skip_album?, :action => :run_command, :parameters => "next_album"
+        
+      end
+      
+      context "when it is command" do
+        
+        let(:message) { "@dj pause" }
+        
+        it_should_behave_like "a successfully routed action",
+          :route => :command?, :action => :run_command, :parameters => "pause"
+        
+      end
+      
+    end
+    
+    
   end
-
+  
 end