pandora 0.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--tag authenticated:"Requires Authentication"
+--tag rate_limited:"Rate Limited"
+--markup markdown

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pandora.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+The Pandora Ruby Gem
+====================
+A Ruby wrapper for the Pandora public user feeds
+
+
+Installation
+------------
+    gem install pandora
+
+Documentation
+-------------
+[http://rdoc.info/gems/pandora](http://rdoc.info/gems/pandora)
+
+Usage
+-----
+This gem only works for public users. All users who did not set 'make my listening activity private'
+
+Usage Examples
+--------------
+    require "rubygems"
+    require "pandora"
+
+    # Initialize a new User
+    user = Pandora::User.new("joe")
+
+    # Get a user's bookmarked songs
+    songs = user.bookmarked_songs 	  # iterate over the songs array for each song
+
+	# Get a user's bookmarked artits
+	artists = user.bookmarked_artists # iterate over the artists array for each artist
+	
+	# Get a user's stations
+	stations = user.stations 		  # iterate over the stations array for each station
+	
+	# Get a user's station(now playing)
+	station = user.now_playing
+	
+	# Get a user's recent activity
+	items = user.recent_activity
+	
+TODO
+----
+* TESTS!!!
+
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = [ 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'authenticated:Requires Authentication',
+      '--tag', 'rate_limited:Rate Limited',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/pandora.rb

@@ -0,0 +1,5 @@
+require 'open-uri'
+require 'nokogiri'
+
+require 'pandora/request'
+require 'pandora/user'

data/lib/pandora/request.rb

@@ -0,0 +1,20 @@
+# = Pandora
+# Defines all the methods related to getting data from Pandora.
+#
+module Pandora
+  # The Request starts here with parsing the method call from 'user' and Nokogiri processing
+  # the XML file.
+  #
+  module Request
+    # The link to the Pandora XML files used throughout 
+    BASE_FEED = "http://feeds.pandora.com/feeds/people/" 
+    
+    # The 'user' can only be a public user on pandora, who hasn't set listening activity to private.
+    # The method comes from user requests. 
+    # [String, String]
+    #
+    def request(user, method)
+      doc = Nokogiri::XML(open("#{BASE_FEED}#{user}/#{method}.xml"))
+    end
+  end
+end

data/lib/pandora/user.rb

@@ -0,0 +1,177 @@
+module Pandora
+  # User class to get data for a particular user.
+  # == Initiating User
+  # user = Pandora::User.new("username")
+  # this 'user' defined will be used in examples to invoke methods below. 
+  # After the methods are invoked the results can be iterated over for each song, artist, staiton, item.
+  #
+  class User
+    
+    include Pandora::Request # Include the Request module to invoke Nokogiri.
+    
+    attr_accessor :user
+    
+    # Create a new user and make sure no whitespace, since it will be parsed as url in the request.
+    def initialize(user)
+      @user = user.strip
+    end
+    
+    # == Returns the Bookmarked Songs
+    # 
+    #    bookmarked_songs = user.bookmarked_songs
+    #
+    # will return the parameters below:
+    # === Parameters:
+    # title:: Name of the song
+    # link:: Link to the song
+    # description:: Description of the song and the artist
+    # date:: Date the song was bookmarked
+    # track:: Song name
+    # artist:: Artist name
+    # album:: Album name
+    # artwork:: Artwork of the album
+    # station:: Station link to the song
+    #  
+    def bookmarked_songs
+      doc = request(@user, "favorites")
+      songs = []
+      doc.xpath('//rss/channel/item').each do |node|
+        songs << { :title       => node.xpath('title').text,
+                   :link        => node.xpath('link').text,
+                   :description => node.xpath('description').text,
+                   :date        => node.xpath('pubDate').text,
+                   :track       => node.xpath('mm:Track/dc:title').text,
+                   :artist      => node.xpath('mm:Artist/dc:title').text,
+                   :album       => node.xpath('mm:Album/dc:title').text,
+                   :artwork     => node.xpath('pandora:albumArtUrl').text,
+                   :station     => node.xpath('pandora:stationLink').text }
+      end
+      songs
+    end
+    
+    # == Returns the Bookmarked Artists
+    # 
+    #    bookmarked_artists = user.bookmarked_artists
+    #
+    # will return the parameters below:
+    # === Parameters:
+    # title:: Name of the artist
+    # link:: Link to the artist
+    # description:: Description of the artist
+    # date:: Date the artist was bookmarked
+    # station:: Station link to the station
+    #
+    def bookmarked_artists
+      doc = request(@user, "favoriteartists")
+      artists = []
+      doc.xpath('//rss/channel/item').each do |node|
+        artists << { :title       => node.xpath('title').text,
+                     :link        => node.xpath('link').text,
+                     :description => node.xpath('description').text,
+                     :date        => node.xpath('pubDate').text,
+                     :artist      => node.xpath('mm:Artist/dc:title').text,
+                     :station     => node.xpath('pandora:stationLink').text }
+      end
+      artists
+    end
+    
+    # == Returns the Stations created
+    # 
+    #    stations = user.stations
+    #
+    # will return the parameters below:
+    # === Parameters:
+    # title:: Title of the station
+    # link:: Link to the station
+    # description:: Description of the station
+    # date:: Date the station was created
+    # artwork:: Artwork of the station
+    # songSeed_song:: Name of song used to create station
+    # songSeed_artist:: Name of the artist for the song used to create the station
+    # composerSeed:: Name of the composer used to create the station
+    # artistSeed:: Name of the artist used to create the station
+    #
+    def stations
+      doc = request(@user, "stations")
+      stations = []
+      doc.xpath('//rss/channel/item').each do |node|
+        stations << { :title       => node.xpath('title').text,
+                      :link        => node.xpath('link').text,
+                      :description => node.xpath('description').text,
+                      :date        => node.xpath('pubDate').text,
+                      :artwork     => node.xpath('pandora:stationAlbumArtImageUrl').text,
+                      :songSeed_song   => node.xpath('pandora:seeds/pandora:songSeed/pandora:song').text,
+                      :songSeed_artist => node.xpath('pandora:seeds/pandora:songSeed/pandora:artist').text,
+                      :composerSeed    => node.xpath('pandora:seeds/pandora:composerSeed/pandora:composer').text,
+                      :artistSeed      => node.xpath('pandora:seeds/pandora:artistSeed/pandora:artist') }
+      end
+      stations
+    end
+    
+    # == Returns the Station Now Playing
+    # 
+    #    now_playing = user.now_playing
+    #
+    # will return the parameters below:
+    # === Parameters:
+    # title:: Title of the station
+    # link:: Link to the station
+    # description:: Description of the station
+    # date:: Date the station was last played
+    # artwork:: Artwork of the station
+    # songSeed_song:: Name of song used to create station
+    # songSeed_artist:: Name of the artist for the song used to create the station
+    # composerSeed:: Name of the composer used to create the station
+    # artistSeed:: Name of the artist used to create the station
+    #
+    def now_playing
+      doc = request(@user, "nowplaying")
+      station = []
+      doc.xpath('//rss/channel/item').each do |node|
+        station << { :title       => node.xpath('title').text,
+                     :link        => node.xpath('link').text,
+                     :description => node.xpath('description').text,
+                     :date        => node.xpath('pubDate').text,
+                     :artwork     => node.xpath('pandora:stationAlbumArtImageUrl').text,
+                     :songSeed_song   => node.xpath('pandora:seeds/pandora:songSeed/pandora:song').text,
+                     :songSeed_artist => node.xpath('pandora:seeds/pandora:songSeed/pandora:artist').text,
+                     :composerSeed    => node.xpath('pandora:seeds/pandora:composerSeed/pandora:composer').text,
+                     :artistSeed      => node.xpath('pandora:seeds/pandora:artistSeed/pandora:artist') }
+      end
+      station
+    end
+    
+    # == Returns the Recent Activity
+    # 
+    #    recent_activity = user.recent_activity
+    #
+    # will return the parameters below:
+    # === Parameters:
+    # title:: Title of the item(song or artist)
+    # link:: Link to the item(song or artist)
+    # description:: Description of the song and the artist
+    # date:: Date the song was modified
+    # track:: Song name
+    # artist:: Artist name
+    # album:: Album name
+    # artwork:: Artwork of the item
+    # station:: Station link to the item
+    #
+    def recent_activity
+      doc = request(@user, "recentactivity")
+      items = []
+      doc.xpath('//rss/channel/item').each do |node|
+        items << { :title       => node.xpath('title').text,
+                   :link        => node.xpath('link').text,
+                   :description => node.xpath('description').text,
+                   :date        => node.xpath('pubDate').text,
+                   :track       => node.xpath('mm:Track/dc:title').text,
+                   :artist      => node.xpath('mm:Artist/dc:title').text,
+                   :album       => node.xpath('mm:Album/dc:title').text,
+                   :artwork     => node.xpath('pandora:albumArtUrl').text,
+                   :station     => node.xpath('pandora:stationLink').text }
+      end
+      items
+    end
+  end
+end

data/lib/pandora/version.rb

@@ -0,0 +1,3 @@
+module Pandora
+  VERSION = "0.1.0"
+end

data/pandora.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pandora/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pandora"
+  s.version     = Pandora::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Anil"]
+  s.homepage    = "http://github.com/anilv/pandora"
+  s.summary     = %q{Get Music data from Pandora}
+  s.description = %q{With a given username get user's favorite artists, songs. Also recent acitvity,
+                      current station and list of the user created stations.}
+  
+  s.add_runtime_dependency 'nokogiri','~> 1.4'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: pandora
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-27 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+description: |-
+  With a given username get user's favorite artists, songs. Also recent acitvity,
+                        current station and list of the user created stations.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- lib/pandora.rb
+- lib/pandora/request.rb
+- lib/pandora/user.rb
+- lib/pandora/version.rb
+- pandora.gemspec
+has_rdoc: true
+homepage: http://github.com/anilv/pandora
+licenses: []
+
+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: Get Music data from Pandora
+test_files: []
+