lastfm-path-finder 1.0.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "lastfm"
+gem "rspec", "2.11"
+gem "spork"
+gem "vcr"
+gem "webmock"
+gem "redis-objects"
+gem 'rspec-redis_helper'
+gem "settingslogic"
+gem "commander"
+gem "jeweler"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 David J. Brenes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,15 @@
+This project is the implementation of a conversation between César Alvarez Doval and myself, a program which finds a path between two (apparently) unrelated artists.
+
+== How to use it?
+
+First, donwolad this repository and install the dependant gems:
+
+ gem install bundler
+
+and then:
+
+ bundle install
+
+and then run the command:
+
+ ./lastfm-path-finder.rb "Pink Floyd" "Franz Ferdinand"

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/config/settings.example.yml

@@ -0,0 +1,3 @@
+lastfm:
+  api_key: --API KEY HERE --
+  api_secret: --API SECRET HERE --

data/lastfm-path-finder.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'lib/lastfm_path_finder'
+
+program :version, "1.0"
+program :description, 'Finding paths between artists in Lastfm since 1888'
+
+default_command :find
+
+command :find do |c|
+  c.syntax = 'lastfm-path-finder find [options]'
+  c.summary = 'Find paths between two artists'
+  c.description = 'Find paths between two artists in Last.fm'
+  c.example 'Search the path between Pink Floyd and Franz Ferdinand', 'lastfm-path-finder find "Pink Floyd" "Franz Ferdinand"'
+  c.action do |args, options|
+
+    from_name = args.first || ask("One artist: ")
+    to_name = args[1] || ask("Another artist: ")
+
+    from = LastfmPathFinder::Artist.new(:name => from_name)
+    to = LastfmPathFinder::Artist.new(:name => to_name)
+    path = LastfmPathFinder::Finder.find from, to
+
+    if path.found?
+      say "Path found! #{path.artists.values.join(" --> ")}"
+    else
+      say "No path found"
+    end
+  end
+end
+

data/lib/lastfm_path_finder/artist.rb

@@ -0,0 +1,42 @@
+require 'active_support/core_ext'
+class LastfmPathFinder::Artist
+
+  include Redis::Objects
+  
+  attr_accessor :id
+
+  value :name
+  sorted_set :related_artists
+
+  def initialize params
+    params.symbolize_keys!
+    self.id = params [:id] || (params[:name]).parameterize
+    self.name = params[:name]
+  end
+
+  alias_method :related_artists_without_lastfm, :related_artists
+
+  def related_artists
+    related = related_artists_without_lastfm
+    related.blank? ? related_artists_in_lastfm : related
+  end
+    
+  def related_artists_in_lastfm
+    artists = LastfmPathFinder::Settings.lastfm_api.artist.get_similar(self.name.value)
+    related_artists_without_lastfm.clear
+    artists.each do |artist|
+      related_artists_without_lastfm[artist["name"]] = artist["match"].to_f
+    end
+    related_artists_without_lastfm
+  end
+
+  def self.find_in_lastfm name
+    begin
+      LastfmPathFinder::Artist.new(LastfmPathFinder::Settings.lastfm_api.artist.get_info(name))
+    rescue Lastfm::ApiError => e    
+      nil  
+    end
+    
+  end
+
+end

data/lib/lastfm_path_finder/finder.rb

@@ -0,0 +1,119 @@
+class LastfmPathFinder::Finder
+
+  # This method finds a way between the two artists. How?
+  # 0) We ensure that we don't already have a path for these artists
+  # 1) We get the related to From
+  # 2) We check if To is in this related list
+  # 3) If it's not, we get the related to To
+  # 4) We check if From is in this list
+  # 5) We check if both related lists share (at least, one artist)
+  # 6) We update the score tables and try in a recursive way to find a way between any pair of nodes of the relateds lists
+  def self.find from, to, options = {}
+
+    default_options = {max_length: 7, threshold: 0.4}
+    options.merge! default_options
+
+    currently_included = options[:currently_included] || []
+    currently_included = currently_included.dup
+
+    # 0)
+
+    path = LastfmPathFinder::Path.new from, to
+    return path if path.found?
+
+    currently_included.push from.name.value
+    currently_included.push to.name.value
+
+    # 1)
+    related_from = from.related_artists
+
+    # 2)
+    if related_from.member?(to.name.value)
+      score = related_from.score(to.name.value)
+      path = LastfmPathFinder::Path.new from, to
+      path.score = score
+      path.artists << from.name.value
+      path.artists << to.name.value
+      return path
+    end
+
+    # 3)
+    related_to = to.related_artists
+
+    # 4)
+    if related_from.member?(from.name.value)
+      score = related_to.score(from.name.value)
+      path = LastfmPathFinder::Path.new from, to
+      path.score = score
+      path.artists << from.name.value
+      path.artists << to.name.value
+      return path
+    end
+
+    # 5)
+    related_from_members = related_from.members
+    related_to_members = related_to.members
+
+    # We create an array of shared relates were we are gonna insert those artists present on both lists
+    # with an score wquals to the product of both scores, so we can find the most related to both artists
+    shared_relate = []
+    related_from_members.each do |name|
+
+      if related_to.member? name
+        score = related_from.score(name)
+        other_score = related_to.score(name)
+        shared_relate << {:name => name, :score => score*other_score}
+      end
+
+    end
+
+    # Now we get the first one and return a path with these three nodes
+    unless shared_relate.blank?
+      shared_contact = shared_relate.sort_by{|r|r[:score]}.last
+
+      path = LastfmPathFinder::Path.new from, to
+      path.score = shared_contact[:score]
+
+      path.artists << from.name.value
+      path.artists << shared_contact[:name]
+      path.artists << to.name.value
+
+      return path
+    end
+
+    #6)
+
+    # If the path is too long we don't look for longer paths
+
+    return path if currently_included.size > (options[:max_length]-2)
+
+    # We store the artists for the score
+    related_from_members.reverse!
+    related_to_members.reverse!
+
+    (related_from_members - currently_included).reject{|from_name|related_from.score(from_name) < options[:threshold] }.each do |from_name|
+
+      from_score = related_from.score(from_name)
+
+      (related_to_members - currently_included).reject{|to_name|related_to.score(to_name) < options[:threshold] }.each do |to_name|
+
+        to_score = related_to.score(to_name)
+
+        path = self.find(LastfmPathFinder::Artist.new(:name => from_name), LastfmPathFinder::Artist.new(:name => to_name), options.merge(currently_included: currently_included))
+        if path.found?
+          new_path = LastfmPathFinder::Path.new from, to
+          new_path.score = path.score * from_score * to_score
+          new_path.artists << from.name.value
+          path.artists.each {|a| new_path.artists << a }
+          new_path.artists << to.name.value
+          return new_path
+        end
+
+      end
+    end
+
+    path
+
+  end
+
+end

data/lib/lastfm_path_finder/path.rb

@@ -0,0 +1,22 @@
+class LastfmPathFinder::Path
+
+  include Redis::Objects
+
+  attr_accessor :id
+  attr_accessor :artist_from, :artist_to
+
+  list :artists
+  value :score
+
+  def initialize from, to
+    self.artist_from = from
+    self.artist_to = to
+    self.id = "#{artist_from.id}_#{artist_to.id}"
+  end
+
+  def found?
+    !artists.values.empty?
+  end
+
+
+end

data/lib/lastfm_path_finder/settings.rb

@@ -0,0 +1,14 @@
+require 'settingslogic'
+require 'lastfm'
+
+class LastfmPathFinder::Settings < Settingslogic
+  source "config/settings.yml"
+  
+  def self.lastfm_api
+    @@lastfm ||= Lastfm.new(self["lastfm"]["api_key"], self["lastfm"]["api_secret"])
+  end  
+
+  def self.redis_connection
+    Redis.current ||= Redis.new self["redis"]
+  end
+end

data/lib/lastfm_path_finder.rb

@@ -0,0 +1,12 @@
+module LastfmPathFinder
+  require 'rubygems'
+  require 'lastfm'
+  require 'redis'
+  require 'redis/objects'
+
+  require_relative 'lastfm_path_finder/settings'
+  Settings.redis_connection
+  require_relative 'lastfm_path_finder/artist'
+  require_relative 'lastfm_path_finder/path'
+  require_relative 'lastfm_path_finder/finder'
+end

data/spec/models/artist.rb

@@ -0,0 +1,45 @@
+require 'lib/lastfm_path_finder'
+
+describe LastfmPathFinder::Artist do
+
+  it "should have no data when not requested to LastFM" do
+    artist = LastfmPathFinder::Artist.new(:id => "pink-floyd")
+    artist.name.should be_nil
+  end
+  it "gets data for existing artists from Last.FM" do
+
+    VCR.use_cassette('lastfm', :record => :new_episodes) do
+      artist = LastfmPathFinder::Artist.find_in_lastfm "pink floyd"
+      artist.should_not be_nil
+      artist.id.should be_eql("pink-floyd")
+      artist.name.should == "Pink Floyd"
+    end
+
+  end  
+
+  it "handles non-existing artists when retrieving info from Last.FM" do
+    
+    VCR.use_cassette('lastfm', :record => :new_episodes) do
+      artist = LastfmPathFinder::Artist.find_in_lastfm "who is pink?"
+      artist.should be_nil
+    end
+    
+  end
+
+  it "gets data about related artists on LastFM" do
+
+    VCR.use_cassette('lastfm', :record => :new_episodes) do
+      artist = LastfmPathFinder::Artist.new :name => "pink floyd"
+      related = artist.related_artists
+      related.should_not be_nil
+
+      related.members.last.should be_eql("David Gilmour")
+      related.score("David Gilmour").should be_eql(1.0)
+      related.members[-2].should be_eql("Roger Waters")
+      related.score("Roger Waters").should be_eql(0.778598)
+    end
+
+  end
+
+
+end

data/spec/models/path.rb

@@ -0,0 +1,49 @@
+require 'lib/lastfm_path_finder'
+
+describe LastfmPathFinder::Path do
+
+  let(:from) {LastfmPathFinder::Artist.new(:name => from_name)}
+  let(:to) {LastfmPathFinder::Artist.new(:name => to_name)}
+  let(:path) do
+    VCR.use_cassette('lastfm', :record => :new_episodes) do
+      LastfmPathFinder::Finder.find from, to
+    end
+  end
+
+  context "when there's a direct path between artists" do
+
+    let(:from_name) {"Pink Floyd"}
+    let(:to_name) {"David Gilmour"}
+
+    subject { path }
+    it { should be_found }
+    it { path.artists.count.should be_eql(2) }
+
+  end
+
+  context "when two artists share a common related artist" do
+
+    let(:from_name) {"Pink Floyd"}
+    let(:to_name) {"B.B. King & Eric Clapton"}
+
+    subject { path }
+    it { should be_found }
+    it { path.artists.count.should be_eql(3) }
+    it { path.artists.values.should == (["Pink Floyd","Eric Clapton","B.B. King & Eric Clapton"]) }
+
+  end
+
+
+  context "when two artists not share a common related artist" do
+
+    let(:from_name) {"Pink Floyd"}
+    let(:to_name) {"The Sunday Drivers"}
+
+    subject { path }
+    it { should be_found }
+    it { path.artists.count.should be_eql(7) }
+    it { path.artists.values.should == ( ["Pink Floyd", "David Gilmour", "Nick Mason", "Serú Girán", "Ismael Serrano", "Quique González", "The Sunday Drivers"]) }
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require "bundler/setup"
+require 'spork'
+require 'rspec'
+require 'rspec-redis_helper'
+#uncomment the following line to use spork with the debugger
+#require 'spork/ext/ruby-debug'
+
+Spork.prefork do
+
+  require 'vcr'
+
+  VCR.configure do |c|
+    c.allow_http_connections_when_no_cassette = true
+    c.cassette_library_dir = 'spec/vcr'
+    c.hook_into :webmock # or :fakeweb
+  end
+
+
+  RSpec.configure do |spec|
+    spec.include RSpec::RedisHelper
+
+    # slightly modified from RSpec::RedisHelper gem site https://github.com/mlanett/rspec-redis_helper
+    spec.around(:each) do |example|
+      with_clean_redis do
+        example.run
+      end
+    end
+  end
+
+end
+
+Spork.each_run do
+  # This code will be run each time you run your specs.
+end
+
+# --- Instructions ---
+# Sort the contents of this file into a Spork.prefork and a Spork.each_run
+# block.
+#
+# The Spork.prefork block is run only once when the spork server is started.
+# You typically want to place most of your (slow) initializer code in here, in
+# particular, require'ing any 3rd-party gems that you don't normally modify
+# during development.
+#
+# The Spork.each_run block is run each time you run your specs.  In case you
+# need to load files that tend to change during development, require them here.
+# With Rails, your application modules are loaded automatically, so sometimes
+# this block can remain empty.
+#
+# Note: You can modify files loaded *from* the Spork.each_run block without
+# restarting the spork server.  However, this file itself will not be reloaded,
+# so if you change any of the code inside the each_run block, you still need to
+# restart the server.  In general, if you have non-trivial code in this file,
+# it's advisable to move it into a separate file so you can easily edit it
+# without restarting spork.  (For example, with RSpec, you could move
+# non-trivial code into a file spec/support/my_helper.rb, making sure that the
+# spec/support/* files are require'd from inside the each_run block.)
+#
+# Any code that is left outside the two blocks will be run during preforking
+# *and* during each_run -- that's probably not what you want.
+#
+# These instructions should self-destruct in 10 seconds.  If they don't, feel
+# free to delete them.
+
+
+
+
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: lastfm-path-finder
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- David J. Brenes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: lastfm
+  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 
+  name: redis-objects
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: settingslogic
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: commander
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Gem for finding paths between artists in Last.fm
+email: davidjbrenes@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+files: 
+- Gemfile
+- README
+- VERSION
+- config/settings.example.yml
+- lastfm-path-finder.rb
+- lib/lastfm_path_finder.rb
+- lib/lastfm_path_finder/artist.rb
+- lib/lastfm_path_finder/finder.rb
+- lib/lastfm_path_finder/path.rb
+- lib/lastfm_path_finder/settings.rb
+- spec/models/artist.rb
+- spec/models/path.rb
+- spec/spec_helper.rb
+- LICENSE.txt
+has_rdoc: true
+homepage: http://github.com/brenes/lastfm-path-finder
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Finding paths between artists in Lastfm since 1888
+test_files: []
+