lily 0.1.2 → 0.1.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31936d7f315fe7d2358ed93ec0eb8af8ffb5a27b
-  data.tar.gz: a4ad3a375dd5694b4925f85a875a445e6bdecddd
+  metadata.gz: b9c20e3200112a22d65b821ed4f1252882b89242
+  data.tar.gz: c9eac958938d4546719eb6e03f76540af25a2199
 SHA512:
-  metadata.gz: bca9cd84da81ea082bae927e44296d8294e7690504f4307039bce785f6db6a91c484d9b88c33bb881f5e8453822d9500f679e0be1d2e9257b9e73f3b6e5266b2
-  data.tar.gz: bb25874c6f3e95bba58e9c0824847307f8215ab6f5aba7c875ffade510c15eeddbb7d4a7eb9e401b2ca6576780e9ff2abbf6c7d13ef431a2047944a3a0d83193
+  metadata.gz: 4c3c85ab8162ee4b64d94f42ce6a61c8440bdcb157ab20e8a7f6ec53a4f80eb22cbaa2f07c242db80d841b5eff31009234a742c1ecbff08abc4a492319658a7a
+  data.tar.gz: 8ec4c202e217f42d17a0e0386eebb403be8b0908b7a0d091415fae6edf0c30d92d0fef2a202032908e703f46d73c78eaacd272938b2a712a4bd028a40a94965c

data/README.md

@@ -16,3 +16,55 @@ gem install lily-*gem # Install the gem
 
 lily init # Initialize :)
 ```
+
+## Usage
+
+What's a CLI without usage docs? A bad one. Below you'll find out how Lily can be used. Keep in mind, you can reference every command Lily has with `lily help`
+
+### Initializing
+Initializing Lily is very easy. Just run `lily init`, log in with LastFM, and you're set.
+
+### Scrobbling
+Lily's scrobbling feature is very useful, particularly for scrobbling things that can't be scrobbled automatically. For example, when you listen to a vinyl, a CD, that song you really like on the radio, or just something that bugged out and didn't scrobble. Here's how you do that:
+
+#### Scrobbling Songs
+Lily can simply and easily scrobble any individual song for you, assuming you just finished listening to it.
+
+**Syntax:** `lily scrobble song (<song> <artist>) [<album>]`
+
+**Examples:**
+
+```bash
+lily scrobble song "Here Comes the Sun" "The Beatles" # scrobbles Here Comes the Sun from Abbey Road, the most popular album it is on
+
+lily scrobble song "Here Comes the Sun" "The Beatles" "The Beatles Ballads" # if you're a hipster, you can optionally specify the exact album you're listening to the song on
+```
+
+#### Scrobbling Albums
+Scrobbling albums with Lily is really awesome. If the `--live` flag is not included, Lily will automatically start your album in the past, as if you just finished listening to the whole thing, and then scrobble the album track by track, just like you listened to it. On the other hand, if the `--live` flag *is* included, it will scrobble tracks in the future, as if you just started listening to the whole album.
+
+**Syntax:** `lily scrobble album (<album> <artist> | <eponymous album>) [--live]`
+
+**Examples:**
+
+```bash
+lily scrobble album "The Beatles" "The White Album" # scrobble the white album by its unofficial fan name
+lily scrobble album "The Beatles" # scrobble album by its officially eponymous name, and save a few keystrokes
+```
+
+### Loving and Unloving
+Lily can love and unlove songs and albums for you as well. The syntax to this is very similar to the syntax for scrobbling songs and albums, just with `love` or `unlove` instead of `scrobble`.
+
+**Syntax for songs:** `lily (love | unlove) song (<song> <artist>) [<album>]`
+
+**Syntax for albums:** `lily (love | unlove) album (<album> <artist> | <eponymous album>)`
+
+**Examples:**
+
+```bash
+lily love album "The Beatles"
+lily unlove album "The Beatles" "Abbey Road"
+
+lily love song "Here Comes the Sun" "The Beatles" "The Beatles Ballads"
+lily unlove song "Here Comes the Sun" "The Beatles"
+```

data/bin/lily

@@ -3,5 +3,5 @@ lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require 'lily'
-lily = Lily.new(*ARGV.map(&:downcase))
+lily = Lily.new(*ARGV.map(&:downcase)) # fix this later
 lily.run

data/lib/lily.rb

@@ -14,6 +14,7 @@ class Lily
       "private" => "85fbaa6644c31d879c3e004fbddb82bf"
     }
     @lily_json = self.get_lily_json
+    @api_url = "http://ws.audioscrobbler.com/2.0/"
     @token ||= self.token
   end
 
@@ -34,9 +35,7 @@ class Lily
     params = params.sort_by { |key, value| key }
     params.each do |key, value|
       path_arr.push("#{key}=" + URI.encode(value.to_s))
-      if (key != "format")
-        sig_str += key + value.to_s
-      end
+      sig_str += key + value.to_s if (key != "format")
     end
     sig_str += @keys.private
     sig = Digest::MD5.hexdigest(sig_str)
@@ -44,6 +43,17 @@ class Lily
     path = path_arr.join("&")
     return path
   end
+  
+  def get_album_info(album, artist)
+    url = "#{@api_url}?method=album.getinfo&api_key=#{@keys.public}&artist=#{URI.encode(artist)}&album=#{URI.encode(album)}&format=json"
+    res = JSON.parse(HTTP.get(url))
+    
+    begin
+      res.album
+    rescue
+      puts "Album does not exist."
+    end
+  end
 
   def token
     url = "http://ws.audioscrobbler.com/2.0/?method=auth.getToken&api_key=#{@keys.public}&api_sig=#{@keys.private}&format=json"
@@ -56,6 +66,7 @@ class Lily
     lastfmURL = "http://www.last.fm/api/auth/?api_key=#{@keys.public}&token=#{@token}"
     print "Press Enter once you've given access..."
     Launchy.open(lastfmURL)
+    STDIN.gets
   end
 
   def session_key
@@ -70,25 +81,170 @@ class Lily
   end
 
   def scrobble
-    # http://www.last.fm/api/show/track.scrobble
-    track, artist = @args[0], @args[1]
-
-    url = "http://ws.audioscrobbler.com/2.0/"
+    # last.fm/api/show/track.scrobble
+    command = @args.shift
     timestamp = Time.now.utc.to_i # UTC time since unix epoch in seconds
 
-    body = self.format_params({
-      "artist" => artist,
-      "method" => "track.scrobble",
-      "sk" => @lily_json.session_key,
-      "timestamp" => timestamp,
-      "track" => track,
-      "api_key" => @keys.public,
-      "format" => "json"
-    })
+    if command == "song"
+      # song
+      track, artist = @args[0], @args[1]
 
-    res = HTTP.post(url, :body => body)
+      if @args[2] then album = @args[2] end # album name is optional
 
-    puts "#{track} by #{artist} has been scrobbled"
+      body = self.format_params({
+        "artist" => artist,
+        "method" => "track.scrobble",
+        "sk" => @lily_json.session_key,
+        "timestamp" => timestamp,
+        "track" => track,
+        "api_key" => @keys.public,
+        "format" => "json",
+        "album" => album
+      })
+
+      res = HTTP.post(@api_url, :body => body)
+
+      puts "#{track} by #{artist} has been scrobbled."
+    elsif command == "album"
+      # album
+
+      # we got eponymous albums covered :)
+      if @args[1] == nil then album, artist = @args[0], @args[0] else album, artist = @args[0], @args[1] end
+
+      album_info = get_album_info(album, artist)
+      album_length = 0
+      
+      # get full length of album in seconds
+      album_info.tracks.track.each do |track|
+        album_length += track.duration.to_i
+      end
+        
+      puts "Whole album length: #{album_length} seconds."
+        
+      # set time when album should have started (a.k.a. album length ago), or if the '--live' option is specified then just start it right now
+      if @args[-1] == "--live" then time = timestamp else time = timestamp - album_length end
+
+      puts "Scrobbling your album starting at " + Time.at(time).utc.strftime("%I:%M:%S %p") + " UTC"
+        
+      # begin scrobbling
+      album_info.tracks.track.each do |track|
+        time += track.duration.to_i
+        
+        # scrobble track
+        body = self.format_params({
+          "artist" => track.artist.name,
+          "method" => "track.scrobble",
+          "sk" => @lily_json.session_key,
+          "timestamp" => time,
+          "track" => track.name,
+          "api_key" => @keys.public,
+          "format" => "json",
+          "album" => album_info.name
+        })
+
+        res = HTTP.post(@api_url, :body => body)
+      end
+
+      puts "#{album} by #{artist} has been scrobbled."
+    else
+      puts "huh"
+    end
+  end
+
+  def love
+    # last.fm/api/show/track.love
+    command = @args.shift
+
+    if command == "song"
+      track, artist = @args[0], @args[1]
+      if @args[2] then album = @args[2] end # album name is optional
+
+      body = self.format_params({
+        "track" => track,
+        "artist" => artist,
+        "method" => "track.love",
+        "sk" => @lily_json.session_key,
+        "api_key" => @keys.public,
+        "format" => "json",
+        "album" => album
+      })
+
+      res = HTTP.post(@api_url, :body => body)
+
+      puts "#{track} by #{artist} has been loved ♥"
+    elsif command == "album"
+      # we've got you covered, eponymous albums
+      if @args[1] == nil then album, artist = @args[0], @args[0] else album, artist = @args[0], @args[1] end
+
+      album_info = get_album_info(album, artist)
+      album_length = 0
+
+      album_info.tracks.track.each do |track|
+        body = self.format_params({
+          "track" => track.name,
+          "artist" => artist,
+          "method" => "track.love",
+          "sk" => @lily_json.session_key,
+          "api_key" => @keys.public,
+          "format" => "json",
+          "album" => album
+        })
+
+        res = HTTP.post(@api_url, :body => body)
+      end
+
+      puts "#{album} by #{artist} has been loved ♥"
+    else
+      puts "huh"
+    end
+  end
+
+  def unlove
+    # last.fm/api/show/track.unlove
+    command = @args.shift
+
+    if command == "song"
+      track, artist = @args[0], @args[1]
+      if @args[2] then album = @args[2] end # album name is optional
+
+      body = self.format_params({
+        "track" => track,
+        "artist" => artist,
+        "method" => "track.unlove",
+        "sk" => @lily_json.session_key,
+        "api_key" => @keys.public,
+        "format" => "json",
+        "album" => album
+      })
+
+      res = HTTP.post(@api_url, :body => body)
+
+      puts "#{track} by #{artist} has been unloved :("
+    elsif command == "album"
+      # we've got you covered, eponymous albums
+      if @args[1] == nil then album, artist = @args[0], @args[0] else album, artist = @args[0], @args[1] end
+
+      album_info = get_album_info(album, artist)
+      album_length = 0
+
+      album_info.tracks.track.each do |track|
+        body = self.format_params({
+          "track" => track.name,
+          "artist" => artist,
+          "method" => "track.unlove",
+          "sk" => @lily_json.session_key,
+          "api_key" => @keys.public,
+          "format" => "json",
+          "album" => album
+        })
+
+        res = HTTP.post(@api_url, :body => body)
+      end
+
+      puts "#{album} by #{artist} has been unloved :("
+    else
+      puts "huh"
+    end
   end
 
   def run
@@ -97,19 +253,29 @@ class Lily
     case first
     when 'scrobble' then self.scrobble
     when 'init' then self.init
+    when 'love' then self.love
+    when 'unlove' then self.unlove
     else self.help
     end
   end
 
   def help
-    puts "no"
+    puts """
+    Lily, the Last.fm CLI.
+
+    Usage:
+        lily init
+        lily help
+        lily (scrobble | love | unlove) song (<song> <artist>) [<album>]
+        lily (love | unlove) album (<album> <artist> | <eponymous album>)
+        lily scrobble album (<album> <artist> | <eponymous album>) [--live]
+    """
   end
 
   def init
     auth
-    STDIN.gets # wow, hack
     session_key
-    puts "Initialized successfully"
+    puts "Initialized ~/.lily.json successfully"
   end
 
   def version

data/lib/lily/version.rb

@@ -1,4 +1,4 @@
 module Version
-  LITERAL = '0.1.2'
+  LITERAL = '0.1.31'
   STRING  = "lily v#{LITERAL}"
 end

data/lily.gemspec

@@ -2,12 +2,11 @@
 require File.expand_path('../lib/lily/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Josh Trommel']
+  gem.authors       = ['Josh Trommel', 'Ethan Arterberry']
   gem.email         = ['joshtrommel@gmail.com']
   gem.description   = 'A simple Last.fm client'
   gem.summary       = 'Last.fm\'s website is trash, and having a client for it is nice.'
   gem.homepage      = 'https://github.com/trmml/lily'
-
   gem.files         = `git ls-files`.split($\)
   gem.executables   = ['lily']
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lily
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.31
 platform: ruby
 authors:
 - Josh Trommel
+- Ethan Arterberry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler