itunes 0.2.0 → 0.3.0

data/README.md

@@ -0,0 +1,77 @@
+# iTunes
+A Ruby wrapper around the iTunes API that lets you search for any sort of data that is available on the iTunes store.
+
+## Example Response
+
+    {
+      "artistId" : 954266,
+      "artistName" : "Green Day",
+      "artistViewUrl" : "http://itunes.apple.com/us/artist/green-day/id954266?uo=4",
+      "artworkUrl100" : "http://a1.phobos.apple.com/us/r1000/049/Features/1e/17/05/dj.rpihtiig.100x100-75.jpg",
+      "artworkUrl30" : "http://a1.phobos.apple.com/us/r1000/049/Features/1e/17/05/dj.rpihtiig.30x30-50.jpg",
+      "artworkUrl60" : "http://a1.phobos.apple.com/us/r1000/049/Features/1e/17/05/dj.rpihtiig.60x60-50.jpg",
+      "collectionCensoredName" : "Dookie",
+      "collectionExplicitness" : "explicit",
+      "collectionId" : 5132583,
+      "collectionName" : "Dookie",
+      "collectionPrice" : 9.99,
+      "collectionViewUrl" : "http://itunes.apple.com/us/album/she/id5132583?i=5132563&uo=4",
+      "contentAdvisoryRating" : null,
+      "country" : "USA",
+      "currency" : "USD",
+      "discCount" : 1,
+      "discNumber" : 1,
+      "kind" : "song",
+      "previewUrl" : "http://a1.phobos.apple.com/us/r1000/027/Music/0e/86/7a/mzm.wchstext.aac.p.m4a",
+      "primaryGenreName" : "Alternative",
+      "releaseDate" : "2003-04-22 07:00:00 Etc/GMT",
+      "trackCensoredName" : "She",
+      "trackCount" : 15,
+      "trackExplicitness" : "notExplicit",
+      "trackId" : 5132563,
+      "trackName" : "She",
+      "trackNumber" : 8,
+      "trackPrice" : 1.29,
+      "trackTimeMillis" : 134293,
+      "trackViewUrl" : "http://itunes.apple.com/us/album/she/id5132583?i=5132563&uo=4",
+      "wrapperType" : "track"
+    }
+
+## Available Methods
+   - movie
+   - podcast
+   - music
+   - music_video
+   - audiobook
+   - short_film
+   - tv_show
+   - all
+
+## Using the iTunes gem
+
+    require 'itunes'
+    
+    >> itunes = ITunes.new
+    >> songs = itunes.music('green day she')
+    => {"result_count" => 15, "results" => [...]}
+    >> songs['results'].each do |song|
+    >>   puts "#{song['trackName']} - #{song['artistName']} (#{song['collectionName']})"
+    >> end
+    => She - Green Day (Dookie)
+    => She - Green Day (Dookie)
+    => She - Green Day (Dookie)
+    => She - Green Day (Dookie)
+    => She - Green Day (Dookie)
+    => ...
+    >> iron_man = ITunes.movie('iron man 2')
+    => {"result_count" => 1, "results" => [...]}
+    => ...
+    >> foo_fighters = ITunes.music('foo fighters everlong', :limit => 1)
+    => {"result_count" => 1, "results" => [{ "trackName" => "Everlong", ... }]}
+
+## Upcoming Features
+
+- A better DSL.
+
+## Copyright
+Copyright © 2010 Garrett Bjerkhoel. See [MIT-LICENSE](http://github.com/dewski/itunes/blob/master/MIT-LICENSE) for details.

data/lib/itunes.rb

@@ -5,6 +5,8 @@ class ITunes
 
   base_uri 'ax.phobos.apple.com.edgesuite.net/WebObjects/MZStoreServices.woa/wa/ws'
   format :json
+  
+  attr_accessor :limit
 
   def method_missing(name, *args)
     methods = %q{movie podcast music music_video audiobook short_film tv_show all}
@@ -12,6 +14,8 @@ class ITunes
     if methods.include?(name.to_s)
       camelcase = name.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
       camelcase[0] = camelcase[0].chr.downcase
+      
+      @limit = args[1].delete(:limit) unless args[1].nil? # will return nil if there is no limit
 
       request(args.first, camelcase)
     else
@@ -19,48 +23,51 @@ class ITunes
     end
   end
   
+  def initialize(limit=nil)
+    @limit = limit
+  end
+  
   # So you don't have to create an instance if you don't need to
-  def self.music(terms)
-    self.new.music(terms)
+  def self.music(terms, opts=nil)
+    self.new.music(terms, opts)
   end
   
-  def self.podcast(terms)
-    self.new.podcast(terms)
+  def self.podcast(terms, opts=nil)
+    self.new.podcast(terms, opts)
   end
   
-  def self.movie(terms)
-    self.new.movie(terms)
+  def self.movie(terms, opts=nil)
+    self.new.movie(terms, opts)
   end
   
-  def self.music_video(terms)
-    self.new.music_video(terms)
+  def self.music_video(terms, opts=nil)
+    self.new.music_video(terms, opts)
   end
   
-  def self.audiobook(terms)
-    self.new.audiobook(terms)
+  def self.audiobook(terms, opts=nil)
+    self.new.audiobook(terms, opts)
   end
   
-  def self.short_film(terms)
-    self.new.short_film(terms)
+  def self.short_film(terms, opts=nil)
+    self.new.short_film(terms, opts)
   end
   
-  def self.tv_show(terms)
-    self.new.tv_show(terms)
+  def self.tv_show(terms, opts=nil)
+    self.new.tv_show(terms, opts)
   end
   
-  def self.all(terms)
-    self.new.all(terms)
+  def self.all(terms, opts=nil)
+    self.new.all(terms, opts)
   end
 
   private
     def request(term, media='all')
       raise ArgumentError, 'you need to search for something, provide a term.' if term.nil?
-
-      self.class.get('Search', {
-        :query => {
-          :term => term,
-          :media => media
-        }
-      })
+      
+      # 
+      query = { :term => term, :media => media }
+      query.merge!({ :limit => @limit }) unless @limit.nil? or @limit == 0
+      
+      self.class.get('Search', { :query => query })
     end
 end

data/lib/itunes/version.rb

@@ -1,3 +1,3 @@
 class ITunes
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: itunes
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Garrett Bjerkhoel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 -07:00
+date: 2010-10-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,8 +40,10 @@ extensions: []
 
 extra_rdoc_files: 
 - MIT-LICENSE
+- README.md
 files: 
 - MIT-LICENSE
+- README.md
 - lib/itunes.rb
 - lib/itunes/version.rb
 has_rdoc: true
@@ -73,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: itunes
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3