ampt 0.2.0.pre2 → 0.2.0.pre3

data/LICENSE

@@ -1,9 +1,10 @@
-Copyright (c) 2009 The Board of Trustees of the University of Illinois.  
+Copyright (c) 2009,2010 Association for Computing Machinery at University of
+Illinois Urbana-Champaign
 All rights reserved.
 
-Developed by: ACM@UIUC
+Developed by: Association for Computing Machinery
               University of Illinois at Urbana-Champaign
-              www.acm.uiuc.edu
+              http://www.acm.uiuc.edu
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to
@@ -16,10 +17,10 @@ furnished to do so, subject to the following conditions:
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimers in the
      documentation and/or other materials provided with the distribution.
-  3. Neither the names of ACM@UIUC, University of Illinois at Urbana-
-     Champaign, nor the names of its contributors may be used to endorse
-     or promote products derived from this Software without specific prior
-     written permission.
+  3. Neither the names of Association for Computing Machinery, University of
+     Illinois at Urbana-Champaign, nor the names of its contributors may be
+     used to endorse or promote products derived from this Software without
+     specific prior written permission.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

data/README.rdoc

@@ -1,21 +1,23 @@
 = ampt
 
-http://www.interhacktive.com/ampt
+Command-fu for amp.
 
 == DESCRIPTION:
 
-This is a command line client for the Acoustics Media Player (amp).
+A command line client for the Acoustics Media Player (amp).
 Amp is available here: http://www.github.com/avuserow/amp
 
 This is a work in progress.
 
 == FEATURES:
 
-* Control things from the command line!
-* Extremely scriptable!
+* Control amp from the command line!
+* Completely scriptable and reconfigurable.
 
 == SYNOPSIS:
 
+=== Usage:
+
     $ ampt --help
     Usage ampt [command] [options] [args]
 
@@ -57,6 +59,12 @@ This is a work in progress.
       25 songs queued for a total time of 2:13:51
       You have 20 songs queued for a total time of 1:49:20
 
+=== Scripting:
+
+See lib/ampt_cfg/default.rb to see how configurations work -- all of ampt's
+commands are written the same way you would write your own custom command or
+configuration.
+
 == REQUIREMENTS:
 
 * libopenssl bindings for ruby 
@@ -64,11 +72,11 @@ This is a work in progress.
 
 == INSTALL:
 
-    $ sudo gem install ampt
+    $ sudo gem install ampt --pre
 
 == TODO:
-* Add an option to change default flags of a command
-* Make aliases more powerful (eg, be able to handle options tacked on)
+* Fix error handling when getting invalid data from the server.
+* Write up a bit of documentation on writing configurations.
 
 == LICENSE:
 

data/Rakefile

@@ -12,7 +12,7 @@ begin
     gem.email = "rich@interhacktive.com"
     gem.homepage = "http://github.com/capslock/ampt"
     gem.authors = ["Rich"]
-    gem.add_dependency 'curb'
+    gem.add_dependency 'curb', '>= 0.6.2.0'
     gem.add_dependency 'trollop'
     gem.add_dependency 'json'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/ampt.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ampt}
-  s.version = "0.2.0.pre2"
+  s.version = "0.2.0.pre3"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rich"]
-  s.date = %q{2010-01-09}
+  s.date = %q{2010-01-10}
   s.default_executable = %q{ampt}
   s.description = %q{This is a command line client for the Acoustics Media Player (amp).}
   s.email = %q{rich@interhacktive.com}
@@ -47,16 +47,16 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<curb>, [">= 0"])
+      s.add_runtime_dependency(%q<curb>, [">= 0.6.2.0"])
       s.add_runtime_dependency(%q<trollop>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
     else
-      s.add_dependency(%q<curb>, [">= 0"])
+      s.add_dependency(%q<curb>, [">= 0.6.2.0"])
       s.add_dependency(%q<trollop>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
     end
   else
-    s.add_dependency(%q<curb>, [">= 0"])
+    s.add_dependency(%q<curb>, [">= 0.6.2.0"])
     s.add_dependency(%q<trollop>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
   end

data/bin/ampt

@@ -3,7 +3,7 @@ require 'ampt'
 
 # You CAN specify configs over here... or you can just load them from your .amptrc.
 Ampt.init do
-  load_config "#{ENV['HOME']}/.amptrc"
   load_config 'ampt_cfg/default.rb'
+  load_config "#{ENV['HOME']}/.amptrc"
 end
 

data/lib/ampt.rb

@@ -2,17 +2,25 @@ require 'rubygems'
 require 'trollop'
 
 module Ampt
-    VERSION = '0.2.0.pre2'
+    VERSION = '0.2.0.pre3'
     # This is the module that holds the API for the current music player. Defined in
     # ampt_api/acoustics.rb
     module API
     end
 
+    # Raised if an invalid command is encountered.
+    class InvalidCommand < StandardError
+        attr :cmd
+        def initialize(cmd)
+            @cmd = cmd
+        end
+    end
+
     # The typical entry point for an Ampt app. Configures a new instance of ampt
     # using the specified block, and runs that configuration.
-    def self.init args = ARGV.dup, *a, &b
-        @c = Config.new(*a, &b)
-        @c.run(args)
+    def self.init args = ARGV, *a, &b
+        c = Config.new(*a, &b)
+        c.run(args)
     end
 
     # Class to hold all of the user-defined functions and variables
@@ -37,17 +45,10 @@ module Ampt
             @alias    = {}
             @default  = nil
             @api      = nil
+            @base_url = nil
             cloaker(&b).bind(self).call(*a) if b
         end
 
-        def extras s, *a, &b
-            @extras.send(s, *a, &b)
-        end
-
-        def user
-            @extras
-        end
-
         # Specify a file path from which to load the config from. If a relative path 
         # is provided, the path is taken as relative to the Ampt library directory.
         def load_config file
@@ -64,22 +65,24 @@ module Ampt
                 File.open(name, 'r') do |f|
                     # Create a new copy of the User module for holding our
                     # user-defined methods and variables.
-                    unless @extras
-                        @extras = User.dup
-                        @extras.parent_config = self
+                    unless @__user
+                        @__user = User.dup
+                        @__user.parent_config = self
                     end
                     # Read in the configuration file.
-                    @extras.module_eval(f.read)
+                    @__user.module_eval(f.read)
                 end
             rescue Errno::ENOENT => e
             end
+            @base_url ||= "https://www-s.acm.uiuc.edu/acoustics"
             # If the user has configured an API, try to require it in.
             # Otherwise, use the default acoustics API.
             if @api
                 begin
                     require @api
-                rescue
+                rescue Exception => e
                     $stderr.puts "Couldn't load API #{@api}"
+                    $stderr.puts e.message
                     exit
                 end
             else
@@ -91,11 +94,8 @@ module Ampt
             end
         end
 
-        # Select an API to use. Defaults to the acoustics API. The path should
-        # be an absolute path.
-        def api path
-            @api = path
-        end
+        # Holds on to user config data
+        attr_reader :__user
 
         # Alias a command. Takes a hash of 'new command' => 'previous command'.
         def alias_cmd cmd
@@ -107,6 +107,21 @@ module Ampt
             @default = cmd
         end
 
+        # Select an API to use. Defaults to the acoustics API. The path should
+        # be an absolute path.
+        def api api
+            @api = api
+        end
+
+        # Base URL of music player
+        def base_url url = nil
+            if url.nil?
+                @base_url
+            else
+                @base_url = url
+            end
+        end
+
         # Define a new Ampt command. Must specify a name, and a block containing
         # the configuration for the command.
         # The configuration should contain one or more desc and opt's, plus an on_run
@@ -123,8 +138,7 @@ module Ampt
 
         # Run the config. Usually not called manually.
         def run args
-            Trollop::options args, [@commands, @alias] do |cmds, *a|
-                commands, aliases = cmds
+            Trollop::options args, @commands, @alias do |commands, aliases|
                 banner "Usage ampt [command] [options] [args]"
                 banner "\nCommands include:\n"
                 # Print out a nice listing of each command
@@ -138,18 +152,27 @@ module Ampt
             end
             cmd = args.shift
             # Try to figure out if it's an alias or a command or nothing or invalid
-            if @commands[cmd]
-                @commands[cmd].run(args)
-            elsif @alias[cmd]
-                begin
-                    cmd, *a = @alias[cmd].split(' ')
-                    args = a + args
-                end until @alias[cmd].nil?
-                @commands[cmd].run(ARGV)
-            elsif cmd.nil? and not @default.nil?
-                @commands[@default].run(ARGV)
+            begin
+                if @alias[cmd]
+                    # Go down through the chain of aliases to find the original command.
+                    # A command could be aliased to itself
+                    begin
+                        cmd, *a = @alias[cmd].split(' ')
+                        args = a + args
+                    end until @alias[cmd].nil? or cmd == @alias[cmd].split(' ').first
+                    unless @commands[cmd]
+                        raise InvalidCommand.new(cmd)
+                    end
+                elsif cmd.nil? and (@default.nil? or @commands[@default].nil?)
+                    raise InvalidCommand.new(cmd)
+                elsif @commands[cmd].nil?
+                    raise InvalidCommand.new(cmd)
+                end
+            rescue InvalidCommand => e
+                Trollop::die "#{e.cmd} is not an ampt command" if e.cmd
+                Trollop::die "No command specified, and no default is set"
             else
-                Trollop::die "#{cmd} is not an ampt command"
+                @commands[cmd].run(args)
             end
         end
 
@@ -179,8 +202,9 @@ module Ampt
             @conflicts = []
             @depends   = []
             @on_run    = lambda {}
+            @config    = config
             (class << self; self; end).instance_eval do
-                include config.user
+                include config.__user
             end
             cloaker(&b).bind(self).call
         end
@@ -226,8 +250,8 @@ module Ampt
         # Executed when a command is run. Usually not called manually.
         def run args
             opts = Trollop::options args,
-                [@name, @desc, @arg, @opts, @conflicts, @depends] do |params, *args|
-                name, description, arg, opts, conflicts, depends = params
+                @name, @desc, @arg, @opts, @conflicts, @depends do |*params|
+                name, description, arg, opts, conflicts, depends = *params
                 banner "ampt #{name}#{arg.join(' ')}: #{description.join " "}"
                 banner ""
                 # Parse each of the specified opts
@@ -244,8 +268,9 @@ module Ampt
                     depends(*d)
                 end
             end
+            @base_url = @config.base_url
             # Call the on_run block with the options and arguments.
-            @on_run.call(opts, ARGV)
+            @on_run.call(opts, args)
         end
 
         # Provide a description for the command. If called with no arguments,

data/lib/ampt_api/acoustics.rb

@@ -5,29 +5,23 @@ require 'uri'
 module Ampt
     # Provides the API for Acoustics
     module API
-        # The base url which all of our requests will be relative to.
-        BASEURL = "https://www-s.acm.uiuc.edu/acoustics"
-
         # Request the player's status. gets the session first so we can tell
         # whether or not we can skip the current song, which songs are ours, etc.
         def status
-            auth do
-                player_status req
-            end
+            auth
+            player_status req
         end
 
         # Unvotes a song. Takes a song_id (string)
         def unvote song_id
-            auth do
-                player_status req 'unvote', 'song_id' => song_id
-            end
+            auth
+            player_status req 'unvote', 'song_id' => song_id
         end
 
         # Votes up a song. Takes a song_id (string)
         def vote song_id
-            auth do
-                player_status req 'vote', 'song_id' => song_id
-            end
+            auth
+            player_status req 'vote', 'song_id' => song_id
         end
 
         # Searches the database for the specified value in the given field.
@@ -52,30 +46,26 @@ module Ampt
 
         # Sets the volume to the specified level. level should be a string.
         def volume level
-            auth do
-                player_status req 'volume', 'value' => level
-            end
+            auth
+            player_status req 'volume', 'value' => level
         end
 
         # Start the player.
         def start
-            auth do
-                player_status req 'start'
-            end
+            auth
+            player_status req 'start'
         end
 
         # Skip the current song. Will probably fail horribly if you aren't allowed to skip.
         def skip
-            auth do
-                player_status req 'skip'
-            end
+            auth
+            player_status req 'skip'
         end
 
         # Stop the player.
         def stop
-            auth do
-                player_status req 'stop'
-            end
+            auth
+            player_status req 'stop'
         end
 
         # takes field => value pair of what to list. Only one of the given pairs is used.
@@ -102,11 +92,11 @@ module Ampt
                     "#{URI::escape key}=#{URI::escape value}"
                     end
                 end
-                c.url = "#{BASEURL}/json.pl?mode=#{mode};" + param_str.join(';')
+                c.url = "#{@base_url}/json.pl?mode=#{mode};" + param_str.join(';')
             elsif mode
-                c.url = "#{BASEURL}/json.pl?mode=#{mode};"
+                c.url = "#{@base_url}/json.pl?mode=#{mode};"
             else
-                c.url = "#{BASEURL}/json.pl"
+                c.url = "#{@base_url}/json.pl"
             end
             c.perform
             c.body_str
@@ -135,12 +125,12 @@ module Ampt
         end
 
         # Perform an authenticated request
-        def auth &b
+        def auth
             unless @sess
                 c = Curl::Easy.new
                 c.http_auth_types = Curl::CURLAUTH_GSSNEGOTIATE
                 c.userpwd = ":"
-                c.url = "#{BASEURL}/www-data/auth/"
+                c.url = "#{@base_url}/www-data/auth/"
                 c.perform
                 sessid = c.header_str[/CGISESSID=(.+);/]
                 if sessid.nil?
@@ -149,7 +139,6 @@ module Ampt
                 end
                 @sess = sessid.chop
             end
-            (yield) if b
         end
     end
 end

data/lib/ampt_cfg/default.rb

@@ -1,18 +1,18 @@
 require 'tempfile'
 
-def colorize(text, color_code)
-  if @no_colorize
-      text
-  else
+def color(text, color_code)
+  if @color
       "#{color_code}#{text}\e[0m"
+  else
+      text
   end
 end
 
-def red(text); colorize(text, "\e[31m"); end
-def green(text); colorize(text, "\e[32m"); end
-def bold(text); colorize(text, "\e[1m"); end
-def under(text); colorize(text, "\e[4m"); end
-def bggreen(text); colorize(text, "\e[42m"); end
+def red(text); color(text, "\e[31m"); end
+def green(text); color(text, "\e[32m"); end
+def bold(text); color(text, "\e[1m"); end
+def under(text); color(text, "\e[4m"); end
+def bggreen(text); color(text, "\e[42m"); end
 
 def pp_song song, options={:title => true, :artist => true, :album => false, :track => false}
     song_id = song.song_id
@@ -96,12 +96,9 @@ default 'status'
 
 command 'status' do 
     desc "Prints the currently playing song and playlist."
-    opt :colorize, "Colorize the output", :short => '-c', :default => true
-    opt :no_colorize, "Disable color"
+    opt :color, "Toggle colors", :short => '-c', :default => true
     on_run do |opts, args|
-        if opts[:no_colorize]
-          @no_colorize = true
-        end
+        @color = opts[:color]
         st = status
         puts bold("Now Playing:") + "\n"
         begin
@@ -250,13 +247,10 @@ command 'search' do
     opt :title, "Search by title", :type => :string
     opt :path, "Search by path", :type => :string
     opt :any, "Search by any parameter. This is the default", :type => :string
-    opt :colorize, "Colorize the output", :short => '-c', :default => true
-    opt :no_colorize, "Disable color"
+    opt :color, "Toggle colors", :short => '-c', :default => true
     conflicts :artist, :album, :title, :path, :any
     on_run do |opts, args|
-        if opts[:no_colorize]
-            @no_colorize = true
-        end
+        @color = opts[:color]
         if opts[:artist_given]||opts[:album_given]||opts[:title_given]
             list_of = {}
             list_of[:artist] = opts[:artist]
@@ -332,13 +326,10 @@ command 'list' do
     opt :artist, "List by artist", :type => :string
     opt :album, "List by album", :type => :string
     opt :title, "List by title", :type => :string
-    opt :colorize, "Colorize the output", :short => '-c', :default => true
-    opt :no_colorize, "Disable color"
+    opt :color, "Toggle colors", :short => '-c', :default => true
     conflicts :artist, :album, :title
     on_run do |opts, args|
-        if opts[:no_colorize]
-            @no_colorize = true
-        end
+        @color = opts[:color]
         if not (opts[:artist_given]||opts[:album_given]||opts[:title_given])
             die "You must specify one of the options"
         else
@@ -358,13 +349,10 @@ end
 command 'show' do
     desc 'Show more info about a song. Takes a song id as the single ' +
         'parameter.'
-    opt :colorize, "Colorize the output", :short => '-c', :default => true
-    opt :no_colorize, "Disable color"
+    opt :color, "Toggle colors", :short => '-c', :default => true
     arg 'song_id'
     on_run do |opts,args|
-        if opts[:no_colorize]
-            @no_colorize = true
-        end
+        @color = opts[:color]
         (die "Not enough arguments") unless args[0]
         song_id = args[0]
         song = (list 'song_id' => song_id)[0]
@@ -382,13 +370,10 @@ end
 alias_cmd 'rand' => 'random'
 command 'random' do
     desc 'Get [num] random songs. Defaults to 20.'
-    opt :colorize, "Colorize the output", :short => '-c', :default => true
-    opt :no_colorize, "Disable color"
+    opt :color, "Toggle colors", :short => '-c', :default => true
     arg 'num'
     on_run do |opts,args|
-        if opts[:no_colorize]
-            @no_colorize = true
-        end
+        @color = opts[:color]
         puts "#{args[0]||20} random songs:"
         pp_songs_full random args[0]
     end
@@ -396,13 +381,10 @@ end
 
 command 'new' do
     desc 'Get [num] newest songs. Defaults to 50.'
-    opt :colorize, "Colorize the output", :short => '-c', :default => true
-    opt :no_colorize, "Disable color"
+    opt :color, "Toggle colors", :short => '-c', :default => true
     arg 'num'
     on_run do |opts,args|
-        if opts[:no_colorize]
-            @no_colorize = true
-        end
+        @color = opts[:color]
         puts "#{args[0]||'50'} newest songs:"
         pp_songs_full recent args[0]
     end
@@ -410,13 +392,10 @@ end
 
 command 'history' do
     desc 'Get [num] last-played songs. Defaults to 25.'
-    opt :colorize, "Colorize the output", :short => '-c', :default => true
-    opt :no_colorize, "Disable color"
+    opt :color, "Toggle colors", :short => '-c', :default => true
     arg 'num'
     on_run do |opts,args|
-        if opts[:no_colorize]
-            @no_colorize = true
-        end
+        @color = opts[:color]
         puts "#{args[0]||'25'} last-played:"
         pp_songs_full history(args[0]), :show_all_voters => true
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ampt
 version: !ruby/object:Gem::Version 
-  version: 0.2.0.pre2
+  version: 0.2.0.pre3
 platform: ruby
 authors: 
 - Rich
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-09 00:00:00 -06:00
+date: 2010-01-10 00:00:00 -06:00
 default_executable: ampt
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.6.2.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: trollop