@@ -1,4 +1,3 @@ -== 0.0.1 2008-08-06 +== 0.1.0 2008-08-07 -* 1 major enhancement: - * Initial release +* Initial release \ No newline at end of file History.txt @@ -1,4 +1,4 @@ -Copyright (c) 2008 FIXME full name +Copyright (c) 2008 Mattt Thompson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the License.txt @@ -6,7 +6,15 @@ README.txt Rakefile config/hoe.rb config/requirements.rb +lib/rest.rb lib/yahoo-music.rb +lib/yahoo-music/base.rb +lib/yahoo-music/artist.rb +lib/yahoo-music/category.rb +lib/yahoo-music/release.rb +lib/yahoo-music/review.rb +lib/yahoo-music/track.rb +lib/yahoo-music/video.rb lib/yahoo-music/version.rb script/console script/destroy @@ -17,9 +25,9 @@ tasks/deployment.rake tasks/environment.rake tasks/website.rake test/test_helper.rb -test/test_yahoo-music.rb -website/index.html -website/index.txt -website/javascripts/rounded_corners_lite.inc.js -website/stylesheets/screen.css -website/template.html.erb +test/fixtures/artist.xml +test/fixtures/categories.xml +test/fixtures/release.xml +test/test_yahoo_music_artist.rb +test/test_yahoo_music_release.rb +website/index.txt \ No newline at end of file Manifest.txt @@ -1,7 +0,0 @@ - -For more information on yahoo-music, see http://yahoo-music.rubyforge.org - -NOTE: Change this information in PostInstall.txt -You can also delete it if you don't want it. - - PostInstall.txt @@ -1,32 +1,69 @@ = yahoo-music -* FIX (url) +A Ruby wrapper for the Yahoo! Music APIs. + +== Example Usage + +=== Artists: + + require 'yahoo-music' + include Yahoo::Music + Yahoo::Music.app_id = [Your App ID Here] + + artist = Artist.new("Ben Folds Five") + + puts artist.name + puts artist.website + + puts '*' * 40 + puts + + puts 'Releases' + artist.releases.each do |release| + puts "\t- %s" % release.title + end + +=== Releases & Tracks: + + require 'yahoo-music' + include Yahoo::Music + Yahoo::Music.app_id = [Your App ID Here] + + album = Album.search("The White Album").first + + puts album.title + puts album.artist + puts "Release Date:" + album.released_on.strftime("%m/%d/%Y") + + puts '*' * 40 + puts + + puts 'Tracks' + artist.tracks.each_with_index do |track, i| + puts "\t%d %s \t%2d:%2d" % [i, track.title, track.duration / 60, track.duration % 60] + end -== DESCRIPTION: -FIX (describe your package) - -== FEATURES/PROBLEMS: - -* FIX (list of features or problems) - -== SYNOPSIS: +== REQUIREMENTS: - FIX (code sample of usage) +To use this library, you must have a valid Yahoo! App ID. +You can get one at http://developer.yahoo.com/wsregapp/ -== REQUIREMENTS: +Additionally, yahoo-music has the following gem dependencies: -* FIX (list of requirements) +* Hpricot >= 0.6 +* ActiveSupport >= 2.1.0 +* FlexMock >= 0.8.2 == INSTALL: -* FIX (sudo gem install, anything else) +* sudo gem install yahoo-music == LICENSE: (The MIT License) -Copyright (c) 2008 FIXME full name +Copyright (c) 2008 Mattt Thompson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the README.txt @@ -1,8 +1,8 @@ require 'yahoo-music/version' -AUTHOR = 'FIXME full name' # can also be an array of Authors -EMAIL = "FIXME email" -DESCRIPTION = "description of gem" +AUTHOR = "Mattt Thompson" +EMAIL = "mail@matttthompson.com" +DESCRIPTION = "yahoo-music is a wrapper to the Y! Music REST APIs" GEM_NAME = 'yahoo-music' # what ppl will type to install your gem RUBYFORGE_PROJECT = 'yahoo-music' # The unix name for your project HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org" @@ -15,7 +15,7 @@ EXTRA_DEPENDENCIES = [ @config_file = "~/.rubyforge/user-config.yml" @config = nil -RUBYFORGE_USERNAME = "unknown" +RUBYFORGE_USERNAME = "mattt" def rubyforge_username unless @config begin config/hoe.rb @@ -1,11 +1,14 @@ +# Ported from John Nunemaker's Scrobbler Gem (http://scrobbler.rubyforge.org/) + require 'net/https' module REST class Connection def initialize(base_url, args = {}) @base_url = base_url - @username = args[:username] - @password = args[:password] + @username = args['username'] + @password = args['password'] + @app_id = args['app_id'] end def get(resource, args = nil) @@ -19,13 +22,11 @@ module REST def request(resource, method = "get", args = nil) url = URI.join(@base_url, resource) - if args + if args = args.update('appid' => @app_id) # TODO: What about keys without value? url.query = args.map { |k,v| "%s=%s" % [URI.encode(k), URI.encode(v)] }.join("&") end - - pp (@base_url + url.request_uri).squeeze('/') - + case method when "get" req = Net::HTTP::Get.new(url.request_uri) lib/rest.rb @@ -19,6 +19,11 @@ module Yahoo LOCALE = "us" API_URL = "http://#{LOCALE}.music.yahooapis.com/" API_VERSION = 'v1' - APP_ID = "25BJGafV34GnIar0alwCNe6VkJfrSe4.FKqHZlzwM73lP5aCWu4K48eUEVszu3dI7aPcTwc-" + + class << self + def app_id=(_id) + Yahoo::Music::Base::connection = REST::Connection.new(API_URL, 'app_id' => _id) + end + end end end \ No newline at end of file lib/yahoo-music.rb @@ -2,7 +2,8 @@ module Yahoo module Music class Base class << self - attr_accessor :attributes, :associations + attr_accessor :attributes, :associations + cattr_accessor :connection def attribute(*args) @attributes ||= {} @@ -52,13 +53,9 @@ module Yahoo end alias_method_chain :name, :demodulization - - def connection - @connection ||= REST::Connection.new(API_URL) - end - - def fetch_and_parse(resource, options = {}) - options = options.update({'appid' => APP_ID}) + + def fetch_and_parse(resource, options = {}) + raise YahooWebServiceError, "No App ID specified" if connection.nil? options = options.update({'response' => self.associations.join(',')}) if self.associations.any? return Hpricot::XML(connection.get(resource, options)) end @@ -135,6 +132,8 @@ module Yahoo end end + class YahooWebServiceError < StandardError; end + class Artist < Base; end class Category < Base; end class Image < Base; end lib/yahoo-music/base.rb @@ -2,8 +2,8 @@ module Yahoo module Music module VERSION #:nodoc: MAJOR = 0 - MINOR = 0 - TINY = 1 + MINOR = 1 + TINY = 0 STRING = [MAJOR, MINOR, TINY].join('.') end lib/yahoo-music/version.rb @@ -17,7 +17,7 @@ require 'syntax/convertors/html' require 'erb' require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb" -version = Yahoo-music::VERSION::STRING +version = Yahoo::Music::VERSION::STRING download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}" def rubyforge_project_id script/txt2html @@ -1,11 +1,113 @@ -<html> - <head> - <meta http-equiv="Content-type" content="text/html; charset=utf-8"> - <title>yahoo-music</title> - - </head> - <body id="body"> - This page has not yet been created for RubyGem <code>yahoo-music</code> - To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file. - </body> -</html> \ No newline at end of file +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" +"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" /> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title> + = yahoo-music + </title> + <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script> +<style> + +</style> + <script type="text/javascript"> + window.onload = function() { + settings = { + tl: { radius: 10 }, + tr: { radius: 10 }, + bl: { radius: 10 }, + br: { radius: 10 }, + antiAlias: true, + autoPad: true, + validTags: ["div"] + } + var versionBox = new curvyCorners(settings, document.getElementById("version")); + versionBox.applyCornersToAll(); + } + </script> +</head> +<body> +<div id="main"> + + <h1>= yahoo-music</h1> + <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/yahoo-music"; return false'> + Get Version + <a href="http://rubyforge.org/projects/yahoo-music" class="numbers">0.1.0</a> + </div> + A Ruby wrapper for the Yahoo! Music APIs. +== Example Usage +=== Artists: +require ‘yahoo-music’ +include Yahoo::Music +Yahoo::Music.app_id = [Your App ID Here] +artist = Artist.new(“Ben Folds Five”) +puts artist.name +puts artist.website +puts ‘*’ * 40 +puts +puts ‘Releases’ +artist.releases.each do |release| +puts “\t- %s” % release.title +end +=== Releases & Tracks: + + require ‘yahoo-music’ + include Yahoo::Music + Yahoo::Music.app_id = [Your App ID Here] + + album = Album.search(“The White Album”).first + + puts album.title + puts album.artist + puts “Release Date:” + album.released_on.strftime(“m/d/%Y”) + + puts ‘*’ * 40 + puts + + puts ‘Tracks’ + artist.tracks.each_with_index do |track, i| + puts “\td %s \t2d:%2d” % [i, track.title, track.duration / 60, track.duration % 60] + end +== REQUIREMENTS: +To use this library, you must have a valid Yahoo! App ID. +You can get one at http://developer.yahoo.com/wsregapp/ +Additionally, yahoo-music has the following gem dependencies: +<ul> + <li>Hpricot >= 0.6</li> + <li>ActiveSupport >= 2.1.0</li> + <li>FlexMock >= 0.8.2</li> +</ul> +== INSTALL: +<ul> + <li>sudo gem install yahoo-music</li> +</ul> +== LICENSE: +(The MIT License) +Copyright © 2008 Mattt Thompson +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. + + <a href="FIXME email">FIXME full name</a>, 7th August 2008 + Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> + +</div> + + + +</body> +</html> website/index.html @@ -1,83 +1,85 @@ -h1. yahoo music - -h1. → 'yahoo-music' - - -h2. What - - -h2. Installing - -<pre syntax="ruby">sudo gem install yahoo-music</pre> - -h2. The basics - - -h2. Demonstration of usage - - - -h2. Forum - -"http://groups.google.com/group/yahoo-music":http://groups.google.com/group/yahoo-music - -TODO - create Google Group - yahoo-music - -h2. How to submit patches - -Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above. - -TODO - pick SVN or Git instructions - -The trunk repository is <code>svn://rubyforge.org/var/svn/yahoo-music/trunk</code> for anonymous access. - -OOOORRRR - -You can fetch the source from either: - -<% if rubyforge_project_id %> - -* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %> - -<pre>git clone git://rubyforge.org/yahoo-music.git</pre> - -<% else %> - -* rubyforge: MISSING IN ACTION - -TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code> -yet to refresh your local rubyforge data with this projects' id information. - -When you do this, this message will magically disappear! - -Or you can hack website/index.txt and make it all go away!! - -<% end %> - -* github: "http://github.com/GITHUB_USERNAME/yahoo-music/tree/master":http://github.com/GITHUB_USERNAME/yahoo-music/tree/master - -<pre>git clone git://github.com/GITHUB_USERNAME/yahoo-music.git</pre> - - -TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects. - - -* gitorious: "git://gitorious.org/yahoo-music/mainline.git":git://gitorious.org/yahoo-music/mainline.git - -<pre>git clone git://gitorious.org/yahoo-music/mainline.git</pre> - -h3. Build and test instructions - -<pre>cd yahoo-music -rake test -rake install_gem</pre> - - -h2. License - -This code is free to use under the terms of the MIT license. - -h2. Contact - -Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/yahoo-music - += yahoo-music + +A Ruby wrapper for the Yahoo! Music APIs. + +== Example Usage + +=== Artists: + + require 'yahoo-music' + include Yahoo::Music + Yahoo::Music.app_id = [Your App ID Here] + + artist = Artist.new("Ben Folds Five") + + puts artist.name + puts artist.website + + puts '*' * 40 + puts + + puts 'Releases' + artist.releases.each do |release| + puts "\t- %s" % release.title + end + +=== Releases & Tracks: + + require 'yahoo-music' + include Yahoo::Music + Yahoo::Music.app_id = [Your App ID Here] + + album = Album.search("The White Album").first + + puts album.title + puts album.artist + puts "Release Date:" + album.released_on.strftime("%m/%d/%Y") + + puts '*' * 40 + puts + + puts 'Tracks' + artist.tracks.each_with_index do |track, i| + puts "\t%d %s \t%2d:%2d" % [i, track.title, track.duration / 60, track.duration % 60] + end + + +== REQUIREMENTS: + +To use this library, you must have a valid Yahoo! App ID. +You can get one at http://developer.yahoo.com/wsregapp/ + +Additionally, yahoo-music has the following gem dependencies: + +* Hpricot >= 0.6 +* ActiveSupport >= 2.1.0 +* FlexMock >= 0.8.2 + +== INSTALL: + +* sudo gem install yahoo-music + +== LICENSE: + +(The MIT License) + +Copyright (c) 2008 Mattt Thompson + +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. \ No newline at end of file website/index.txt b671360fe867b01a4578dee17a7b1307607b3603 Mattt Thompson mail@matttthompson.com http://github.com/mattt/yahoo-music/commit/c1849b7e8024a4629ee218d18a38688cab90fd1e c1849b7e8024a4629ee218d18a38688cab90fd1e

2008-08-07T17:48:57-07:00

Preparation for first Gem version 9cdf0c8408ea79d5f560442de97aba9b86d1a2a5 Mattt Thompson mail@matttthompson.com