kschrader-mtv-music 0.1.1

data/README

@@ -0,0 +1,75 @@
+= mtv-music
+
+A Ruby wrapper for the MTV Music API.
+See http://developer.mtvnservices.com/ for more information about the API.
+
+== Example Usage
+
+=== Artists:
+
+  require 'mtv-music'
+  include MTV::Music
+  
+  artist = Artist.new("Radiohead")
+  
+  puts artist.name
+  puts artist.website
+  
+  puts '*' * 40
+  puts
+  
+  puts 'Videos'
+  artist.videos.each do |video|
+    puts "\t- %s" % video.title
+  end
+  
+=== Videos:
+
+  require 'mtv-music'
+  include MTV::Music
+  
+  video = Video.new("hznHivqrbHHZBZNXB") # Radiohead's "There There"
+  
+  puts video.title
+  puts video.artist.name
+  puts video.released_on
+  
+  # The MTV Music API makes it easy to embed videos into any webpage
+  puts video.embed_code
+  # <embed src="http://media.mtvnservices.com/mgid:uma:video:api.mtvnservices.com:202930" 
+  #        width="448" height="366" type="application/x-shockwave-flash" 
+  #        allowFullScreen="true" allowScriptAccess="always" flashvars="autoPlay=false" />
+
+
+== REQUIREMENTS:
+
+mtv-music has the following gem dependencies:
+
+* Hpricot >= 0.6
+* ActiveSupport >= 2.1.0
+* FlexMock >= 0.8.2
+
+== 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/lib/mtv-music.rb

@@ -0,0 +1,20 @@
+%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 'mtv-music/base'
+require 'mtv-music/version'
+
+require 'mtv-music/artist'
+require 'mtv-music/video'
+
+module MTV
+  module Music
+    API_VERSION = '1'
+    API_URL     = "http://api.mtvnservices.com/#{API_VERSION}/"
+    
+    MTV::Music::Base::connection = REST::Connection.new(API_URL, :rate_limit => 0.68)
+  end
+end

data/lib/mtv-music/artist.rb

@@ -0,0 +1,18 @@
+module MTV
+  module Music
+    class Artist < Base    
+      attribute :name,            String, :matcher => "author/name"
+      attribute :thumbnail_url,   String, :matcher => "media:thumbnail", :attribute => "url"
+    
+      def videos
+        xml = Video.fetch_and_parse(self.class.api_path(:videos, self.id))
+        return xml.search("entry/id").collect{|elem| Video.new(Video.fetch_and_parse(elem.inner_text))}
+      end
+      
+      def related
+        xml = Artist.fetch_and_parse(self.class.api_path(:related, self.id))
+        return xml.search("entry/id").collect{|elem| Artist.new(Artist.fetch_and_parse(elem.inner_text))}
+      end
+    end
+  end
+end

data/lib/mtv-music/base.rb

@@ -0,0 +1,140 @@
+module MTV
+  module Music
+    class Base
+      class << self
+        
+        cattr_accessor   :attributes
+        cattr_accessor  :connection
+        
+        def attribute(*args)
+          @attributes   ||= {}
+          
+          options = args.extract_options!
+          name, type = args
+          class_eval %(attr_accessor :#{name})
+          @attributes[name] = options.update({:type => type})
+        end
+        
+        def attributes
+          @attributes || {}
+        end
+        
+        def name_with_demodulization
+          self.name_without_demodulization.demodulize        
+        end
+        
+        alias_method_chain :name, :demodulization
+
+        def fetch_and_parse(resource, options = {})
+          return Hpricot::XML(connection.get(resource, options))
+        end
+        
+        def api_path(method, id = nil)
+          parameters = [self.name, id, method].compact
+          return parameters.collect!{|param| CGI::escape(param.to_s).downcase}.join('/')
+        end
+        
+        # Generic Feed Parameters
+        
+        # feed-format     Specifies the format of the feed to be returned.        
+        #                 value:    atom, mrss           
+        #                 example:  ?feed-format=mrss
+        # max-results     Limit the maximum number of results. The default value is 25. The maximum value is 100  
+        #                 value:    25, 1-100   
+        #                 example:  ?max-results=25
+        # start-index     Choose the first result to display in the returns. The first return is 1.
+        #                 When used with the max-results parameter, multiple pages of results can be created.  
+        #                 value:    1, %d       
+        #                 example:  ?start-index=26
+        # date            Limit the returns to date range specified.              
+        #                 value:    MMDDYYYY-MMDDYYYY 
+        #                 example:  ?date=01011980-12311989 
+        # sort            Specifies the sort order for returns.                   
+        #                 value:    relevance, date_ascending, date_descending 
+        #                 example:  ?sort=date_ascending
+        def search(term, options = {})
+          options = options.update({:term => term})
+          case date = options[:date]
+          when Range
+            options[:date] = "%s-%s" % [date.first, date.last].collect{|d| d.strftime("%m%d%Y")}
+          when Time
+            options[:date] = "%s-%s" % [date, Time.now].collect{|d| d.strftime("%m%d%Y")}
+          end
+          
+          xml = fetch_and_parse(api_path(:search), options)
+          results = xml.search(:entry).collect{|elem| self.new(fetch_and_parse((elem/'id').inner_text))}
+          return results.delete_if{|e| e.uri.blank?}
+        end
+      end
+      
+      attr_accessor :id, :uri
+            
+      def initialize(xml)
+        raise ArgumentError unless xml.kind_of?(Hpricot)
+        
+        if xml.at(:uri).inner_text == "http://api.mtvnservices.com/1/"
+          raise MTVNetworkServiceError, xml.at(:title).inner_text, xml.at(:content).inner_text
+        end
+        
+        @uri = xml.at(:id).inner_text
+        @id  = @uri.split('/').last
+        
+        self.class.attributes.each do |attribute, options|
+          element = xml.search(options[:matcher]).first
+          next if element.nil?
+          value = options[:attribute] ? element.attributes[options[:attribute]] : element.inner_text# rescue nil
+          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
+            end
+          ensure
+            self.instance_variable_set("@#{attribute}", value)
+          end     
+        end        
+        
+      end
+      
+      def initialize_with_polymorphism(arg)
+        case arg
+        when String
+          if arg =~ /http:\/\//
+            initialize_without_polymorphism(query_by_uri(arg))
+          else
+            initialize_without_polymorphism(query_by_string(arg))
+          end
+        when Hpricot
+          initialize_without_polymorphism(arg)
+        end
+      end
+     
+      alias_method_chain :initialize, :polymorphism
+      
+    protected
+      
+      def query_by_string(string)
+        xml = self.class.fetch_and_parse(self.class.api_path(nil, string.gsub(/\s+/, '_')))
+        return xml.at(:entry)
+      end   
+      
+      def query_by_uri(uri)
+        xml = self.class.fetch_and_parse(uri)
+        return xml.at(:entry)
+      end
+      
+      def query_association_by_id(association, id)
+        klass = "mtv/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 MTVNetworkServiceError < StandardError; end
+  
+    class Artist    < Base; end
+    class Video     < Base; end
+  end
+end

data/lib/mtv-music/version.rb

@@ -0,0 +1,11 @@
+module MTV
+  module Music
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/lib/mtv-music/video.rb

@@ -0,0 +1,68 @@
+module MTV
+  module Music
+    class Video < Base    
+      attribute :media_uri,     String, :matcher => "media:content", :attribute => "url"
+      attribute :artist_uri,    String, :matcher => "author/uri"
+      attribute :title,         String, :matcher => "media:title"
+      attribute :description,   String, :matcher => "media:description"
+      attribute :director,      String, :matcher => "media:credit[@role^='director']"
+      attribute :released_on,   Date,   :matcher => "published"
+      attribute :updated_on,    Date,   :matcher => "updated"
+      
+      # <embed src="http://media.mtvnservices.com/mgid:uma:video:api.mtvnservices.com:235854"
+      #        width="448" height="366" type="application/x-shockwave-flash"
+      #        allowFullScreen="true" allowScriptAccess="always" flashvars="autoPlay=false" />
+      def embed_code(options = {})
+        options.update({
+          :src    => @media_uri,
+          :type   => "application/x-shockwave-flash",
+          :width  => "448",
+          :height => "366",
+          :allowFullScreen   => "true",
+          :allowScriptAccess => "always",
+          :flashvars         => "autoPlay=false"})
+        tag(:embed, options)
+      end
+      
+      def artist
+        Artist.new(@artist_uri)
+      end
+      
+      alias_method :to_html, :embed_code
+      
+      class << self
+        # Workaround for case-sensitivity for Video aliases
+        def api_path(method, id = nil)
+          parameters = [self.name.downcase, id, method].compact
+          return parameters.collect!{|param| CGI::escape(param.to_s)}.join('/')
+        end
+      end
+    
+      # Taken from ActionView#TagHelper
+      def tag(name, options = nil, open = false, escape = true)
+        "<#{name}#{tag_options(options, escape) if options}#{open ? ">" : " />"}"
+      end
+
+      def tag_options(options, escape = true)
+        unless options.blank?
+         attrs = []
+         if escape
+           options.each do |key, value|
+             next unless value
+             key = key.to_s
+             value = Set.new(%w(disabled readonly multiple)).include?(key) ? key : escape_once(value)
+             attrs << %(#{key}="#{value}")
+           end
+         else
+           attrs = options.map { |key, value| %(#{key}="#{value}") }
+         end
+         " #{attrs.sort * ' '}" unless attrs.empty?
+        end
+      end
+
+      def escape_once(html)
+        html.to_s.gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| ERB::Util::HTML_ESCAPE[special] }
+      end
+    end
+  end
+end

data/lib/rest.rb

@@ -0,0 +1,60 @@
+# Ported from John Nunemaker's Scrobbler Gem (http://scrobbler.rubyforge.org/)
+
+require 'net/https'
+require 'activesupport'
+
+module REST
+	class Connection
+		def initialize(base_url, options = {})
+			@base_url = base_url
+			@username = options[:username]
+			@password = options[:password]
+			
+			@rate_limit   = options[:rate_limit].to_f
+			@lock_expiry  = Time.now.to_f
+		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 = {})
+			url = URI.join(@base_url, resource)
+
+			unless args.empty?
+				# TODO: What about keys without value?
+				url.query = args.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v.to_s)] }.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) }
+			puts url
+			res.body
+		end
+			
+		def request_with_rate_limiting(*args)
+	    sleep @lock_expiry - Time.now.to_f rescue ArgumentError
+	    @lock_expiry = Time.now.to_f + @rate_limit
+	    request_without_rate_limiting(*args)
+	  end
+	  
+		alias_method_chain :request, :rate_limiting
+	end
+end

data/mtv-music.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name     = "mtv-music"
+  s.version  = "0.1.1"
+  s.date     = "2008-11-13"
+  s.summary  = "A Ruby wrapper for the MTV Music API."
+  s.email    = "kurt@karmalab.org"
+  s.homepage = "http://github.com/kschrader/mtv-music/"
+  s.description = "A Ruby wrapper for the MTV Music API.
+                   See http://developer.mtvnservices.com/ for more information about the API."
+  s.authors  = ["Mattt Thompson", "Kurt Schrader"]
+  
+  s.files    = [
+		"README", 
+		"mtv-music.gemspec", 
+		"lib/mtv-music.rb",
+		"lib/rest.rb",
+		"lib/mtv-music/base.rb",
+		"lib/mtv-music/artist.rb",
+		"lib/mtv-music/video.rb",
+		"lib/mtv-music/version.rb"
+	]
+  s.test_files = [
+    "test/test_helper.rb",
+    "test/test_mtv_music_artist.rb",
+    "test/test_mtv_music_video.rb"
+  ]
+  
+  s.add_dependency("hpricot",       ["> 0.6"])
+  s.add_dependency("activesupport", ["> 2.1.0"])
+  s.add_dependency("flexmock",      ["> 0.8.2"])
+  
+  s.has_rdoc = false
+  s.rdoc_options = ["--main", "README"]
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+gem 'flexmock'
+
+require 'test/unit'
+require 'flexmock/test_unit'
+require File.dirname(__FILE__) + '/../lib/mtv-music'
+
+include MTV::Music
+
+def fixture(_filename)
+  File.open(File.dirname(__FILE__) + '/fixtures/%s.xml' % _filename ).read
+end

data/test/test_mtv_music_artist.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestMTVMusicArtist < Test::Unit::TestCase  
+  def test_artist_initialization_from_alias
+    flexmock(Artist).should_receive(:fetch_and_parse).
+      once.with("artist/radiohead").
+      and_return(Hpricot::XML(fixture(:radiohead)))
+    
+    assert_nothing_raised do
+      @artist = Artist.new("Radiohead")
+    end
+  end
+  
+  def test_artist_initialization_from_alias_with_whitespace
+    flexmock(Artist).should_receive(:fetch_and_parse).
+      once.with("artist/nine_inch_nails").
+      and_return(Hpricot::XML(fixture(:nine_inch_nails)))
+    
+    assert_nothing_raised do
+      @artist = Artist.new("Nine Inch Nails")
+    end
+  end 
+  
+  def test_artist_no_such_alias_error
+    flexmock(Artist).should_receive(:fetch_and_parse).
+      once.with("artist/sailing_three_tuesdays").
+      and_return(Hpricot::XML(fixture(:sailing_three_tuesdays)))
+    
+    assert_raise MTVNetworkServiceError do
+      @artist = Artist.new("Sailing Three Tuesdays")
+    end
+  end 
+  
+  def test_artist_class_attributes_and_associations
+    flexmock(Artist).should_receive(:fetch_and_parse).
+      once.with("artist/radiohead").
+      and_return(Hpricot::XML(fixture(:radiohead)))
+      
+    assert_nothing_raised do
+      @artist = Artist.new("Radiohead")
+    end
+    
+    assert ! Artist.attributes.empty?
+    Artist.attributes.keys.each do |attribute|
+      assert_respond_to @artist, attribute
+    end
+  end
+  
+  def test_artist_instance_variables
+    flexmock(Artist).should_receive(:fetch_and_parse).
+      once.with("artist/radiohead").
+      and_return(Hpricot::XML(fixture(:radiohead)))
+      
+    assert_nothing_raised do
+      @artist = Artist.new("Radiohead")
+    end
+    
+    assert_equal @artist.id,    "radiohead"
+    assert_equal @artist.uri,   "http://api.mtvnservices.com/1/artist/radiohead/"
+    assert_equal @artist.name,  "Radiohead"
+  end
+end

data/test/test_mtv_music_video.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestYahooMusicRelease < Test::Unit::TestCase
+  def test_video_initialization_from_alias
+    flexmock(Video).should_receive(:fetch_and_parse).
+      once.with("video/hznHivqrbHHZBZNXB").
+      and_return(Hpricot::XML(fixture(:there_there)))
+    
+    assert_nothing_raised do
+      @video = Video.new("hznHivqrbHHZBZNXB")
+    end
+  end
+  
+  def test_artist_nonexistent_id_error
+    flexmock(Video).should_receive(:fetch_and_parse).
+      once.with("video/nil").
+      and_return(Hpricot::XML(fixture(:nil_video)))
+    
+    assert_raise MTVNetworkServiceError do
+      @artist = Video.new("nil")
+    end
+  end 
+  
+  def test_video_class_attributes_and_associations
+    flexmock(Video).should_receive(:fetch_and_parse).
+      once.with("video/hznHivqrbHHZBZNXB").
+      and_return(Hpricot::XML(fixture(:there_there)))
+    
+    assert_nothing_raised do
+      @video = Video.new("hznHivqrbHHZBZNXB")
+    end
+    
+    assert ! Video.attributes.empty?
+    Video.attributes.keys.each do |attribute|
+      assert_respond_to @video, attribute
+    end
+  end
+  
+  def test_video_instance_variables
+    flexmock(Video).should_receive(:fetch_and_parse).
+      once.with("video/hznHivqrbHHZBZNXB").
+      and_return(Hpricot::XML(fixture(:there_there)))
+    
+    assert_nothing_raised do
+      @video = Video.new("hznHivqrbHHZBZNXB")
+    end
+    
+    assert_equal @video.id,       "hznHivqrbHHZDPSP"
+    assert_equal @video.title,    "There There"
+    assert_equal @video.director, "Chris Hopewell"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: kschrader-mtv-music
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Mattt Thompson
+- Kurt Schrader
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.8.2
+    version: 
+description: A Ruby wrapper for the MTV Music API. See http://developer.mtvnservices.com/ for more information about the API.
+email: kurt@karmalab.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- mtv-music.gemspec
+- lib/mtv-music.rb
+- lib/rest.rb
+- lib/mtv-music/base.rb
+- lib/mtv-music/artist.rb
+- lib/mtv-music/video.rb
+- lib/mtv-music/version.rb
+has_rdoc: false
+homepage: http://github.com/kschrader/mtv-music/
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby wrapper for the MTV Music API.
+test_files: 
+- test/test_helper.rb
+- test/test_mtv_music_artist.rb
+- test/test_mtv_music_video.rb