yahoo-music 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2008-08-07
+
+* Initial release

data/License.txt

@@ -0,0 +1,20 @@
+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.

data/Manifest.txt

@@ -0,0 +1,33 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+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
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+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

data/README.txt

@@ -0,0 +1,85 @@
+= 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.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,75 @@
+require 'yahoo-music/version'
+
+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"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+ ['hpricot',        '>= 0.6'],
+ ['activesupport',  '>= 2.1.0'],
+ ['flexmock',       '>= 0.8.2']
+] # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "mattt"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Yahoo::Music::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'yahoo-music documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/rest.rb

@@ -0,0 +1,48 @@
+# 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']
+			@app_id   = args['app_id']
+		end
+
+		def get(resource, args = nil)
+			request(resource, "get", args)
+		end
+
+		def post(resource, args = nil)
+			request(resource, "post", args)
+		end
+
+		def request(resource, method = "get", args = nil)
+			url = URI.join(@base_url, resource)
+
+			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
+						
+			case method
+			when "get"
+				req = Net::HTTP::Get.new(url.request_uri)
+			when "post"
+				req = Net::HTTP::Post.new(url.request_uri)
+			end
+
+			if @username and @password
+				req.basic_auth(@username, @password)
+			end
+
+			http = Net::HTTP.new(url.host, url.port)
+			http.use_ssl = (url.port == 443)
+
+			res = http.start() { |conn| conn.request(req) }
+			res.body
+		end
+	end
+end

data/lib/yahoo-music.rb

@@ -0,0 +1,29 @@
+%w{rubygems cgi hpricot activesupport}.each { |x| require x }
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rest'
+require 'yahoo-music/base'
+require 'yahoo-music/version'
+
+require 'yahoo-music/artist'
+require 'yahoo-music/category'
+require 'yahoo-music/release'
+require 'yahoo-music/review'
+require 'yahoo-music/track'
+require 'yahoo-music/video'
+
+module Yahoo
+  module Music
+    LOCALE      = "us"
+    API_URL     = "http://#{LOCALE}.music.yahooapis.com/"
+    API_VERSION = 'v1'
+    
+    class << self
+      def app_id=(_id)
+        Yahoo::Music::Base::connection = REST::Connection.new(API_URL, 'app_id' => _id)
+      end
+    end
+  end
+end

data/lib/yahoo-music/artist.rb

@@ -0,0 +1,31 @@
+# <Artist
+#         catzillaID = xs:int
+#         flags = xs:int
+#         hotzillaID = xs:int
+#         id = xs:string
+#         name = xs:string
+#         rating = xs:int
+#         salesGenreCode = xs:int
+#         sortName = xs:string
+#         trackCount = xs:int
+#         website = xs:string
+#         >
+# 
+#     Content: 
+#         Image*, Category*, Releases?, TopTracks?, TopSimilarArtists?, RadioStations?, Events?, Fans?, NewsArticles?, ReleaseReviews?, ShortBio?, FullBio?, ItemInfo?, Video*
+# </Artist>
+
+module Yahoo
+  module Music
+    class Artist < Base      
+      attribute :id,          Integer
+      attribute :name,        String
+      attribute :sort_name,   String, :matcher => "sortName"
+      attribute :website,     String
+      
+      attribute :releases,    Release
+      attribute :categories,  Category
+      attribute :videos,      Video
+    end
+  end
+end

data/lib/yahoo-music/base.rb

@@ -0,0 +1,147 @@
+module Yahoo
+  module Music
+    class Base
+      class << self
+        attr_accessor   :attributes, :associations
+        cattr_accessor  :connection
+        
+        def attribute(*args)
+          @attributes   ||= {}
+          @associations ||= []
+          
+          options = args.extract_options!
+          name, type = args
+          class_eval %(attr_accessor :#{name})
+          @attributes[name] = options.update({:type => type})
+          
+          if Yahoo::Music::Base.subclasses.include?(type.inspect)
+            @associations << name
+            
+            # Define plural and singular association methods
+            define_method("#{name}".pluralize.to_sym) do
+              value = instance_variable_get("@#{name}") || query_association_by_id(name, self.id)
+              instance_variable_set("@#{name}", value)
+              return value
+            end
+            
+            define_method("#{name}".singularize.to_sym) do
+              value = instance_variable_get("@#{name}") || query_association_by_id(name, self.id)
+              value = value.first
+              instance_variable_set("@#{name}", value)
+              return value
+            end
+          end
+          
+          if options[:type] == Boolean
+            define_method("#{name}?".to_sym) do
+              value = instance_variable_get("@#{name}")
+              return value
+            end
+          end
+        end
+        
+        def attributes
+          @attributes || {}
+        end
+        
+        def associations
+          @associations || []
+        end
+        
+        def name_with_demodulization
+          self.name_without_demodulization.demodulize        
+        end
+        
+        alias_method_chain :name, :demodulization
+
+        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
+        
+        def api_path(service, resource, method, *args)
+          response_type = method.nil? ? :item : :list
+          parameters = [service, API_VERSION, response_type, resource, method, *args].compact
+          return parameters.collect!{|param| CGI::escape(param.to_s).downcase}.join('/')
+        end
+        
+        # Search by a parameter for a specific service
+        # Ex. Artist.search(term)
+        # options[:search_mode]
+        def search(*args)
+          options = args.extract_options!
+          xml = fetch_and_parse(api_path(self.name, nil, :search, options[:search_mode] || :all, args.join(',')), options)
+          return xml.search(self.name).collect{|elem| self.new(elem)}
+        end
+      end
+            
+      def initialize(xml)
+        raise ArgumentError unless xml.kind_of?(Hpricot)
+                
+        self.class.attributes.each do |attribute, options|
+          value = xml.attributes[options[:matcher] || attribute.to_s]
+          begin
+            if options[:type] == Integer
+              value = value.to_i
+            elsif options[:type] == Float
+              value = value.to_f
+            elsif options[:type] == Date
+              value = Date.parse(value) rescue nil
+            elsif options[:type] == Boolean
+              value = !! value.to_i.nonzero?
+            elsif self.class.associations.include?(attribute)
+              klass = options[:type]
+              value = xml.search(klass.name).collect{|elem| klass.new(elem)}
+              value = nil if value.empty?
+            end
+          ensure
+            self.instance_variable_set("@#{attribute}", value)
+          end     
+        end        
+      end
+      
+      def initialize_with_polymorphism(arg)
+        case arg
+        when String
+          initialize_without_polymorphism(query_by_string(arg))
+        when Integer
+          initialize_without_polymorphism(query_by_id(arg))
+        when Hpricot
+          initialize_without_polymorphism(arg)
+        end
+      end
+     
+      alias_method_chain :initialize, :polymorphism
+      
+    protected
+      def query_by_id(id)
+        xml = self.class.fetch_and_parse(self.class.api_path(self.class.name, nil, nil, id))
+        return xml.at(self.class.name)
+      end
+      
+      def query_by_string(string)
+        xml = self.class.fetch_and_parse(self.class.api_path(self.class.name, nil, :search, :all, string ))
+        return xml.at(self.class.name)
+      end   
+      
+      def query_association_by_id(association, id)
+        klass = "yahoo/music/#{association.to_s.singularize}".camelize.constantize
+        xml = self.query_by_id(id).search(klass.name)
+        return xml.collect{|elem| klass.new(elem)}
+      end   
+    end
+  
+    class YahooWebServiceError < StandardError; end
+  
+    class Artist    < Base; end
+    class Category  < Base; end
+    class Image     < Base; end
+    class Release   < Base; end
+    class Review     < Base; end
+    class Track     < Base; end
+    class Video     < Base; end
+  end
+end
+
+class Boolean; end