discogs-wrapper 1.0.0 → 1.1.0

data/README.markdown

@@ -13,6 +13,7 @@ ABOUT
 
   * Artists
   * Releases
+  * MasterReleases
   * Labels
   * Searching (all of the above)
 
@@ -24,17 +25,14 @@ INSTALLATION
 ------------
   You can install the library via Rubygems:
 
-    $ gem sources -a http://gems.github.com
-    $ sudo gem install buntine-discogs
+    $ sudo gem install discogs-wrapper
 
 USAGE
 -----
-  To use this library, you must supply a valid User-agent value. For example:
+  To use this library, you must supply the name of your application. For example:
 
     require 'discogs'
-    wrapper = Discogs::Wrapper.new("Mozilla/5.0 (X11; Linux i686; rv:6.0.2) Gecko/20100101 Firefox/6.0.2")
-
-  I suggest passing on your users User-agent.
+    wrapper = Discogs::Wrapper.new("My awesome web app")
 
   Accessing information is easy:
 

data/discogs.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   
   s.name = "discogs-wrapper"
-  s.version = "1.0.0"
-  s.date = "2011-09-27"
+  s.version = "1.1.0"
+  s.date = "2011-10-22"
   s.summary = "Discogs::Wrapper is a full wrapper for the http://www.discogs.com API V2"
   s.homepage = "http://www.github.com/buntine/discogs"
   s.email = "info@andrewbuntine.com"

data/lib/wrapper/resource.rb

@@ -76,4 +76,5 @@ class Discogs::Resource
 
 end
 
+# Load in all of the resource definitions.
 Dir[File.join(File.dirname(__FILE__), "resources", "*.rb")].each { |file| require file }

data/lib/wrapper/resource_mappings.rb

@@ -12,7 +12,7 @@ module Discogs::ResourceMappings
 
   module ClassMethods
 
-    # Helper method to map resource to element in API response.
+    # Helper method to map resource to an element in the API response.
     def map_to(*elements)
       self.class_eval <<-EOF
         def self.element_names
@@ -51,11 +51,7 @@ module Discogs::ResourceMappings
  private
 
   def find_resource_for_name(name, type=:singular)
-    method = if type == :singular
-      :element_names
-    else
-      :plural_element_names
-    end
+    method = (type == :singular) ? :element_names : :plural_element_names
 
     find_resource do |klass|
       klass.constants.find do |const|

data/lib/wrapper/resources/artist.rb

@@ -27,10 +27,10 @@ class Discogs::Artist < Discogs::Resource
 
  private
 
-  # Simple helper for filtering a particular type of release.
-  def filter_releases(type)
+  # Simple helper for filtering a particular role of release.
+  def filter_releases(role)
     self.releases.find_all do |release|
-      release.type == type
+      release.role == role
     end
   end
 

data/lib/wrapper/resources/artist_release.rb

@@ -6,12 +6,23 @@ class Discogs::Artist::Release < Discogs::Resource
 
   attr_accessor :id,
                 :status,
-                :type,
+                :role,
                 :title,
                 :artist,
                 :format,
                 :year,
                 :label,
-                :trackinfo
+                :thumb,
+                :trackinfo,
+                :main_release
+
+  # Will return either "master" or "release".
+  def release_type
+    if original_content =~ /^\<(\w+)\s/
+      $1
+    else
+      "release"
+    end
+  end
 
 end

data/lib/wrapper/resources/release.rb

@@ -5,12 +5,14 @@ class Discogs::Release < Discogs::Resource
   no_mapping
 
   attr_accessor :id,
+                :master_id,
                 :status,
                 :title,
                 :country,
                 :released,
                 :notes,
                 :images,
+                :videos,
                 :artists,
                 :extraartists,
                 :labels,

data/lib/wrapper/resources/release_artist.rb

@@ -1,6 +1,7 @@
 # Represents an release's artist in the Discogs API.
 
 require File.dirname(__FILE__) + "/track"
+require File.dirname(__FILE__) + "/master_release"
 
 class Discogs::Release::Artist < Discogs::Resource
 
@@ -16,3 +17,5 @@ end
 
 # Define other classes that also replicate this structure.
 class Discogs::Release::Track::Artist < Discogs::Release::Artist; end
+class Discogs::MasterRelease::Artist < Discogs::Release::Artist; end
+class Discogs::MasterRelease::Track::Artist < Discogs::Release::Artist; end

data/lib/wrapper/resources/track.rb

@@ -1,6 +1,7 @@
 # Represents a track in the Discogs API.
 
 require File.dirname(__FILE__) + "/release"
+require File.dirname(__FILE__) + "/master_release"
 
 class Discogs::Release::Track < Discogs::Resource
 
@@ -13,3 +14,6 @@ class Discogs::Release::Track < Discogs::Resource
                 :extraartists
 
 end
+
+# Define other classes that also replicate this structure.
+class Discogs::MasterRelease::Track < Discogs::Release::Track; end

data/lib/wrapper/wrapper.rb

@@ -12,22 +12,26 @@ class Discogs::Wrapper
 
   @@root_host = "http://api.discogs.com"
 
-  attr_reader :user_agent
+  attr_reader :app_name
 
-  def initialize(user_agent=nil)
-    @user_agent = user_agent
+  def initialize(app_name=nil)
+    @app_name = app_name
   end
 
   def get_release(id)
     query_and_build "release/#{id}", Discogs::Release
   end
 
+  def get_master_release(id)
+    query_and_build "master/#{id}", Discogs::MasterRelease
+  end
+
   def get_artist(name)
-    query_and_build "artist/#{name}", Discogs::Artist
+    query_and_build "artist/#{name}", Discogs::Artist, {:releases => 1}
   end
 
   def get_label(name)
-    query_and_build "label/#{name}", Discogs::Label
+    query_and_build "label/#{name}", Discogs::Label, {:releases => 1}
   end
 
   def search(term, options={})
@@ -42,8 +46,8 @@ class Discogs::Wrapper
 
  private
 
-  def query_and_build(path, klass)
-    data = query_api(path)
+  def query_and_build(path, klass, params={})
+    data = query_api(path, params)
     resource = klass.send(:new, data)
     resource.build!
   end
@@ -73,8 +77,9 @@ class Discogs::Wrapper
     uri = build_uri(path, params)
 
     request = Net::HTTP::Get.new(uri.path + "?" + uri.query)
+    request.add_field("Accept", "application/xml")
     request.add_field("Accept-Encoding", "gzip,deflate")
-    request.add_field("User-Agent", @user_agent)
+    request.add_field("User-Agent", @app_name)
 
     Net::HTTP.new(uri.host).start do |http|
       http.request(request)

data/spec/resources/artist_release_spec.rb

@@ -26,8 +26,8 @@ describe Discogs::Artist::Release do
       @artist_release.status.should == "Accepted"
     end
 
-    it "should have a type attribute" do
-      @artist_release.type.should == "Main"
+    it "should have a role attribute" do
+      @artist_release.role.should == "Main"
     end
 
     it "should have a title attribute" do

data/spec/spec_helper.rb

@@ -6,6 +6,10 @@ def valid_release_xml
   read_sample "valid_release.xml"
 end
 
+def valid_master_release_xml
+  read_sample "valid_master_release.xml"
+end
+
 def valid_artist_xml
   read_sample "valid_artist.xml"
 end

data/spec/wrapper_methods/get_artist_spec.rb

@@ -94,6 +94,22 @@ describe Discogs::Wrapper do
         @artist.releases[0].id.should == "1805661"
       end
 
+      it "should have a type for the first release" do
+        @artist.releases[0].release_type.should == "release"
+      end
+
+      it "should have a type for the second release" do
+        @artist.releases[1].release_type.should == "master"
+      end
+
+      it "should have a main release for the second release" do
+        @artist.releases[1].main_release.should == "12345"
+      end
+
+      it "should have a thumb for the second release" do
+        @artist.releases[1].thumb.should == "http://images"
+      end
+
       it "should have a year for the first release" do
         @artist.releases[0].year.should == "1991"
       end

data/spec/wrapper_methods/get_release_spec.rb

@@ -30,6 +30,10 @@ describe Discogs::Wrapper do
         @release.id.should == "666666"
       end
 
+      it "should have a master_id attribute" do
+        @release.master_id.should == "6111"
+      end
+
       it "should have one or more extra artists" do
         @release.extraartists.should be_instance_of(Array)
         @release.extraartists[0].should be_instance_of(Discogs::Release::Artist)
@@ -55,6 +59,12 @@ describe Discogs::Wrapper do
         @release.images[0].should be_instance_of(Discogs::Image)
       end
 
+      it "should have one or more videos" do
+        @release.videos.should be_instance_of(Array)
+        @release.videos[0].should be_instance_of(Discogs::Video)
+      end
+
+
     end
 
     describe "when calling complex release attributes" do
@@ -72,6 +82,15 @@ describe Discogs::Wrapper do
         end
       end
 
+      it "should have specifications for each video" do
+        specs = [ [ '334', 'true', 'http://www.youtube.com/watch?v=QVdDhOnoR8k' ], [ '350', 'true', 'http://www.youtube.com/watch?v=QVdDhOnoR7k' ] ]
+        @release.videos.each_with_index do |video, index|
+          video.duration.should == specs[index][0]
+          video.embed.should == specs[index][1]
+          video.uri.should == specs[index][2]
+        end
+      end
+
       it "should have a traversible list of styles" do
         @release.styles.should be_instance_of(Array)
         @release.styles[0].should == "Black Metal"

data/spec/wrapper_spec.rb

@@ -23,8 +23,8 @@ describe Discogs::Wrapper do
   end
 
   before do
-    @user_agent = "some_app"
-    @wrapper = Discogs::Wrapper.new(@user_agent)
+    @app_name = "some_app"
+    @wrapper = Discogs::Wrapper.new(@app_name)
     @release_id = "666666"
     @artist_name = "Dark"
     @label_name = "Monitor"
@@ -32,7 +32,7 @@ describe Discogs::Wrapper do
   end
 
   it "should have an user agent" do
-    @wrapper.user_agent.should == @user_agent
+    @wrapper.app_name.should == @app_name
   end
 
   describe "requested URIs" do
@@ -49,14 +49,14 @@ describe Discogs::Wrapper do
 
     it "should generate the correct artist URL to parse" do
       mock_http_with_response "200", valid_artist_xml
-      URI.should_receive(:parse).with("http://api.discogs.com/artist/Dark?f=xml").and_return(@uri)
+      URI.should_receive(:parse).with("http://api.discogs.com/artist/Dark?f=xml&releases=1").and_return(@uri)
 
       @wrapper.get_artist(@artist_name)
     end
 
     it "should generate the correct label URL to parse" do
       mock_http_with_response "200", valid_label_xml
-      URI.should_receive(:parse).with("http://api.discogs.com/label/Monitor?f=xml").and_return(@uri)
+      URI.should_receive(:parse).with("http://api.discogs.com/label/Monitor?f=xml&releases=1").and_return(@uri)
 
       @wrapper.get_label(@label_name)
     end
@@ -84,7 +84,7 @@ describe Discogs::Wrapper do
 
     it "should sanitize the path correctly" do
       mock_http_with_response "200", valid_artist_xml
-      URI.should_receive(:parse).with("http://api.discogs.com/artist/A+very+long+band+name?f=xml").and_return(@uri)
+      URI.should_receive(:parse).with("http://api.discogs.com/artist/A+very+long+band+name?f=xml&releases=1").and_return(@uri)
 
       @wrapper.get_artist("A very long band name")
     end 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: discogs-wrapper
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Andrew Buntine
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-27 00:00:00 +10:00
+date: 2011-10-22 00:00:00 +11:00
 default_executable: 
 dependencies: []