idiomag 0.1.0

data/History

@@ -0,0 +1,2 @@
+0.1.0 - 19/11/2008
+			* Initial release

data/LICENSE

@@ -0,0 +1,9 @@
+(The MIT License)
+
+Copyright © 2008 Jonathan Rudenberg
+
+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.rdoc

@@ -0,0 +1,151 @@
+= idiomag
+
+idiomag is a wrapper for the idiomag APIs (http://www.idiomag.com/api).
+
+All calls require a API key.
+
+
+== API Key
+  Idiomag::Base.api_key = 'foo'
+  
+== Prefetching
+
+By default the gem will lazily load data as it is requested.
+
+All resources support <tt>get</tt> like this:
+
+  articles.get(:latest, :featured)
+
+== Articles
+
+  articles = Idiomag::Articles.new
+
+  puts "latest articles:"
+  articles.latest.each {|article| puts "#{article[:title]} on #{article[:date].strftime('%A')}"}
+  puts "\n\n"
+
+  puts "featured articles:"
+  articles.featured.each {|article| puts "#{article[:title]} on #{article[:date].strftime('%A')}"}
+
+== Artist
+
+  artist = Idiomag::Artist.new('Anberlin')
+  artist.get(:info, :tags, :articles, :photos, :videos, :tracks)
+
+  puts "#{artist.name}'s URLs:"
+  artist.links.each {|link| puts link}
+  puts "\n\n"
+
+  puts "#{artist.name}'s related artists:"
+  artist.related.each {|name,link| puts "#{name}: #{link}"}
+  puts "\n\n"
+
+  puts "#{artist.name}'s tags:"
+  artist.tags.each {|tag,value| puts "#{tag} = #{value}"}
+  puts "\n\n"
+
+  puts "#{artist.name}'s recent articles:"
+  artist.articles.each {|article| puts "#{article[:title]} on #{article[:date].strftime('%A')}"}
+  puts "\n\n"
+
+  puts "#{artist.name}'s photos:"
+  artist.photos.each {|photo| puts photo[:url]}
+  puts "\n\n"
+
+  puts "#{artist.name}'s videos:"
+  artist.videos.each {|video| puts "#{video[:title]} - #{video[:location]}"}
+  puts "\n\n"
+
+  puts "#{artist.name}'s tracks:"
+  artist.tracks.each {|track| puts "#{track[:title]} - #{track[:location]}"}
+
+== Tag
+A tag is a music genre, such as Indie, Jazz or Emo. Tags can be either symbols or strings.
+
+<tt>Idiomag::Tag.list</tt> will return an array of valid tags.
+
+  tag = Idiomag::Tag.new(:alternative_rock)
+  tag.get(:artists, :articles, :photos, :videos, :tracks)
+
+  puts "artists for #{tag.name}:"
+  tag.artists.each {|name,value| puts "#{name}: #{value}"}
+  puts "\n\n"
+
+  puts "recent articles for #{tag.name}:"
+  tag.articles.each {|article| puts "#{article[:title]} on #{article[:date].strftime('%A')}"}
+  puts "\n\n"
+
+  puts "photos for #{tag.name}:"
+  tag.photos.each {|photo| puts photo[:url]}
+  puts "\n\n"
+
+  puts "videos for #{tag.name}:"
+  tag.videos.each {|video| puts "#{video[:title]} - #{video[:location]}"}
+  puts "\n\n"
+
+  puts "tracks for #{tag.name}:"
+  tag.tracks.each {|track| puts "#{track[:title]} - #{track[:location]}"}
+
+== User
+Gets info on an idiomag user.
+
+  user = Idiomag::User.new('Titanous')
+  user.get(:info, :articles, :loved_articles, :photos, :videos, :tracks)
+
+  puts "#{user.name}'s info:"
+  puts "email hash: #{user.email}"
+  puts "profile url: #{user.url}"
+  puts "\n"
+
+  puts "#{user.name}'s tags:"
+  user.tags.each {|tag,value| puts "#{tag} = #{value}"}
+  puts "\n"
+
+  puts "#{user.name}'s artists:"
+  user.artists.each {|name,value| puts "#{name}: #{value}"}
+  puts "\n\n"
+
+  puts "#{user.name}'s recent articles:"
+  user.articles.each {|article| puts "#{article[:title]} on #{article[:date].strftime('%A')}"}
+  puts "\n\n"
+
+  puts "#{user.name}'s loved articles:"
+  user.loved_articles.each {|article| puts "#{article[:title]} on #{article[:date].strftime('%A')}"}
+  puts "\n\n"
+
+  puts "#{user.name}'s photos:"
+  user.photos.each {|photo| puts photo[:url]}
+  puts "\n\n"
+
+  puts "#{user.name}'s videos:"
+  user.videos.each {|video| puts "#{video[:title]} - #{video[:location]}"}
+  puts "\n\n"
+
+  puts "#{user.name}'s tracks:"
+  user.tracks.each {|track| puts "#{track[:title]} - #{track[:location]}"}
+  
+== Recommendation
+Provides recommendations based on a list of artists. This list of artists can be provided as either an apml url, an array, or a site such as last.fm
+
+  recommendation = Idiomag::Recommendation.new(:network => :lastfm, :user => 'titanous')
+  recommendation.get(:articles, :artists)
+
+  puts "recommended artists:"
+  recommendation.artists.each {|name,value| puts "#{name}: #{value}"}
+  puts "\n\n"
+
+  puts "recommended articles:"
+  recommendation.articles.each {|article| puts "#{article[:title]} on #{article[:date].strftime('%A')}"}
+
+=== Lookup types
+==== Network
+  Idiomag::Recommendation.new(:network => :lastfm, :user => 'titanous')
+
+Supported networks:
+  [:lastfm, :mog, :ilike, :mystrands, :projectplaylist, :imeem, :pandora, :bebo, :myspace, :songza]
+
+==== APML
+  Idiomag::Recommendation.new(:apml => 'http://research.sun.com:8080/AttentionProfile/apml/music/titanous')
+
+==== Artist List
+  Idiomag::Recommendation.new(:artists => ['Relient K', 'Anberlin'])

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+require 'spec/rake/spectask'
+
+WEBSITE_PATH = 'titanous@rubyforge.org:/var/www/gforge-projects/idiomag'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = 'idiomag'
+    s.summary = 'wrapper for the idiomag api'
+    s.description = 'wrapper for the idiomag api'
+    s.email = 'jon335@gmail.com'
+    s.homepage = 'http://idiomag.rubyforge.org'
+    s.authors = ['Jonathan Rudenberg']
+    s.add_dependency('httparty', '>= 0.2.2')
+    s.rubyforge_project = 'idiomag'
+    s.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'spec/**/*'].to_a
+    s.has_rdoc = true
+    s.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'idiomag', '--main', 'README.rdoc']
+    s.extra_rdoc_files = ['README.rdoc']
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'idiomag'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Run all specs with rcov'
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+  t.rcov_opts = ['--exclude', 'spec']
+  t.verbose = true
+end
+
+task :default => :rcov
+
+desc 'Upload website files to rubyforge'
+task :website do
+  sh %{rsync -av website/ #{WEBSITE_PATH}}
+  Rake::Task['website_docs'].invoke
+end
+
+task :website_docs do
+  Rake::Task['rdoc'].invoke
+  sh %{rsync -av doc/ #{WEBSITE_PATH}/docs}
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+major: 0
+minor: 1
+patch: 0

data/lib/idiomag.rb

@@ -0,0 +1,17 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+gem 'httparty', '>= 0.2.2'
+require 'httparty'
+
+require 'time'
+
+require 'idiomag/base'
+require 'idiomag/helpers'
+require 'idiomag/parser'
+require 'idiomag/rest'
+require 'idiomag/artist'
+require 'idiomag/articles'
+require 'idiomag/tag'
+require 'idiomag/user'
+require 'idiomag/recommendation'

data/lib/idiomag/articles.rb

@@ -0,0 +1,48 @@
+module Idiomag
+  class Articles
+      def get(*args)
+        args.each do |action|
+          case action
+          when :latest
+            get_latest
+          when :featured
+            get_featured
+          else
+            raise ArgumentError
+          end
+        end
+      end
+
+      def respond_to?(method)
+        case method
+        when :featured,:latest
+          true
+        else
+          super
+        end
+      end
+
+      def method_missing(method, *args)  
+        case method
+        when :latest
+          get_latest if @latest.nil?
+          @latest
+        when :featured
+          get_featured if @featured.nil?
+          @featured
+        else
+          super
+        end
+      end
+
+      private
+
+        def get_latest
+          @latest = Parser.parse_articles(REST.fetch('articles/latest'))
+        end
+        
+        def get_featured
+          @featured = Parser.parse_articles(REST.fetch('articles/featured'))
+        end
+  end
+end

data/lib/idiomag/artist.rb

@@ -0,0 +1,103 @@
+module Idiomag
+  class Artist
+    
+    def initialize(artist)
+      raise ArgumentError if artist.blank?
+      @artist = artist
+    end
+    
+    def get(*args)
+      args.each do |action|
+        case action
+        when :info
+          get_info
+        when :tags
+          get_tags
+        when :articles
+          get_articles
+        when :photos
+          get_photos
+        when :videos
+          get_videos
+        when :playlist, :tracks
+          get_playlist
+        else
+          raise ArgumentError
+        end
+      end
+    end
+    
+    def respond_to?(method)
+      case method
+      when :links,:related,:tags,:articles,:photos,:videos,:playlist,:tracks,:name
+        true
+      else
+        super
+      end
+    end
+    
+    def method_missing(method, *args)  
+      case method
+      when :name
+        @artist
+      when :links
+        get_info if @links.nil?
+        @links
+      when :related
+        get_info if @related.nil?
+        @related
+      when :tags
+        get_tags if @tags.nil?
+        @tags
+      when :articles
+        get_articles if @articles.nil?
+        @articles
+      when :photos
+        get_photos if @photos.nil?
+        @photos
+      when :videos
+        get_videos if @videos.nil?
+        @videos
+      when :playlist, :tracks
+        get_playlist if @playlist.nil?
+        @playlist
+      else
+        super
+      end
+    end
+    
+    private
+    
+      def get_info
+        info_data = REST.fetch('artist/info', :artist => @artist)
+        @links = info_data['links']['url']
+      
+        @related = {}
+        info_data['related']['artist'].each {|a| @related[a['name']] = a['links']['url'][0] }
+      end
+    
+      def get_tags
+        tag_data = REST.fetch('artist/tags', :artist => @artist)
+      
+        @tags = {}
+        tag_data['profile']['tag'].each {|t| @tags[t['name']] = t['value']}
+        @tags.keys_to_sym!
+      end
+    
+      def get_articles
+        @articles = Parser.parse_articles(REST.fetch('artist/articles', :artist => @artist))
+      end
+    
+      def get_photos
+        @photos = Parser.parse_photos(REST.fetch('artist/photos', :artist => @artist))
+      end
+    
+      def get_videos
+        @videos = Parser.parse_videos(REST.fetch('artist/videos', :artist => @artist))
+      end
+    
+      def get_playlist
+        @playlist = Parser.parse_playlist(REST.fetch('artist/playlist', :artist => @artist))
+      end
+  end
+end

data/lib/idiomag/base.rb

@@ -0,0 +1,9 @@
+module Idiomag
+  API_URL = 'http://www.idiomag.com/api/'
+  
+  class Base
+    class << self
+      attr_accessor :api_key
+    end
+  end
+end

data/lib/idiomag/helpers.rb

@@ -0,0 +1,26 @@
+class Hash #:nodoc:  
+  def keys_to_sym!
+    return Hash.keys_to_sym(self)
+  end
+
+  def rename_key!(old_key, new_key)
+    return Hash.rename_key(self, old_key, new_key)
+  end
+
+  private
+    def self.keys_to_sym(hsh)
+      hsh.each_key do |k|
+        if k =~ /-/
+          hsh[k.to_s.downcase] = hsh.delete(k)
+        else
+          hsh[k.to_s.downcase.gsub(/ /, '_').to_sym] = hsh.delete(k)
+        end
+      end
+      return hsh
+    end
+    
+    def self.rename_key(hsh, old_key, new_key)
+      hsh[new_key.to_s] = hsh.delete(old_key.to_s)
+      return hsh
+    end
+end

data/lib/idiomag/parser.rb

@@ -0,0 +1,32 @@
+module Idiomag
+  class Parser
+    class << self
+      def parse_articles(article_data)
+        articles = article_data['articles']
+        articles.each do |a|
+          a.rename_key!('sourceUrl', 'source_url')
+          a.keys_to_sym!
+          a[:date] = Time.parse(a[:date])
+        end
+      end
+    
+      def parse_photos(photo_data)
+        photos = photo_data['photos']
+        photos.each do |p|
+          p.keys_to_sym!
+          p[:date] = Time.parse(p[:date])
+        end
+      end
+    
+      def parse_videos(video_data)    
+        videos = video_data['tracks']
+        videos.each {|v| v.keys_to_sym!}
+      end
+    
+      def parse_playlist(playlist_data)
+        playlist = playlist_data['tracks']
+        playlist.each {|v| v.keys_to_sym!}
+      end
+    end
+  end
+end