]> git.r.bdr.sh - rbdr/lyricli.rb/blob - lib/lyricli/sources/arguments.rb
Adds some documentation
[rbdr/lyricli.rb] / lib / lyricli / sources / arguments.rb
1 module Lyricli
2 module Sources
3 class Arguments
4
5 class << self
6 attr_accessor :name
7 end
8
9 @name = "arguments"
10
11 # The enable method should run all of the tasks needed to validate
12 # the source. In the case of Rdio it has to authenticate with OAuth.
13 def self.enable
14 # Nothing to do.
15 end
16
17 # Instantiates everything it needs to run.
18 def initialize
19 # Nothing to do.
20 end
21
22 # The current_track method should return the name of the current
23 # artist and song.
24 # @return [Hash] A hash containing the current `:song` and `:artist`.
25 def current_track
26 artist = ARGV[0]
27 song = ARGV[1]
28 {artist: artist, song: song}
29 end
30
31 # The reset method resets any configurations it may have
32 def self.reset
33 # Reset Code
34 end
35 end
36 end
37 end