bassnode-discogs 0.3.2

data/lib/wrapper/wrapper.rb

@@ -0,0 +1,109 @@
+# Core API wrapper class.
+
+require 'uri'
+require 'net/http'
+require 'rexml/document'
+require 'zlib'
+require 'stringio'
+
+require File.dirname(__FILE__) + "/resource"
+
+class Discogs::Wrapper
+
+  @@root_host = "http://www.discogs.com"
+
+  attr_reader :api_key
+
+  def initialize(api_key=nil)
+    @api_key = api_key
+  end
+
+  def get_release(id)
+    query_and_build "release/#{id}", Discogs::Release
+  end
+
+  def get_artist(name)
+    query_and_build "artist/#{name}", Discogs::Artist
+  end
+
+  def get_label(name)
+    query_and_build "label/#{name}", Discogs::Label
+  end
+
+  def search(term, options={})
+    opts = { :type => :all, :page => 1 }.merge(options)
+    params = { :q => term, :type => opts[:type], :page => opts[:page] }
+
+    data = query_api("search", params)
+    resource = Discogs::Search.new(data)
+
+    resource.build_with_resp!
+  end
+
+ private
+
+  def query_and_build(path, klass)
+    data = query_api(path)
+    resource = klass.send(:new, data)
+    resource.build!
+  end
+
+  # Queries the API and handles the response.
+  def query_api(path, params={})
+    response = make_request(path, params)
+
+    raise_unknown_resource(path) if response.code == "404"
+    raise_invalid_api_key if response.code == "400"
+    raise_internal_server_error if response.code == "500"
+
+    # Unzip the response data, or just read it in directly
+    # if the API responds without gzipping.
+    response_body = nil
+    begin
+        inflated_data = Zlib::GzipReader.new(StringIO.new(response.body))
+        response_body = inflated_data.read
+    rescue Zlib::GzipFile::Error
+        response_body = response.body
+    end
+    
+    response_body
+  end
+
+  # Generates a HTTP request and returns the response.
+  def make_request(path, params={})
+    uri = build_uri(path, params)
+
+    request = Net::HTTP::Get.new(uri.path + "?" + uri.query)
+    request.add_field("Accept-Encoding", "gzip,deflate")
+
+    Net::HTTP.new(uri.host).start do |http|
+      http.request(request)
+    end
+  end
+
+  def build_uri(path, params={})
+    parameters = { :f => "xml", :api_key => @api_key }.merge(params)
+    querystring = "?" + parameters.map { |key, value| "#{key}=#{value}" }.sort.join("&")
+
+    URI.parse(File.join(@@root_host, sanitize_path(path, querystring)))
+  end
+
+  def sanitize_path(*path_parts)
+    clean_path = path_parts.map { |part| part.gsub(/\s/, '+') }
+
+    clean_path.join
+  end
+
+  def raise_invalid_api_key
+    raise Discogs::InvalidAPIKey, "Invalid API key: #{@api_key}"
+  end
+
+  def raise_unknown_resource(path='')
+    raise Discogs::UnknownResource, "Unknown Discogs resource: #{path}"
+  end
+
+  def raise_internal_server_error
+    raise Discogs::InternalServerError, "The remote server cannot complete the request"
+  end
+
+end

data/spec/resource_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe Discogs::Resource do
+
+  before do
+    @resource = Discogs::Resource.new(sample_valid_binary)
+  end
+
+  it "should have a default element name" do
+    Discogs::Resource.element_names.should == [ :resource ]
+  end
+
+  it "should have a default plural element name" do
+    Discogs::Resource.plural_element_names.should == [ :resources ]
+  end
+
+  it "should have an original_content method" do
+    @resource.original_content.should == sample_valid_binary
+  end
+
+  it "should be able to build the content"
+
+  it "should remove the <resp> element by default"
+
+  it "should leave the <resp> element if told to"
+
+end

data/spec/resources/artist_release_spec.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Artist::Release do
+
+  it "should map to release" do
+    Discogs::Artist::Release.element_names.should == [ :release ]
+  end
+
+  it "should map to plural releases" do
+    Discogs::Artist::Release.plural_element_names.should == [ :releases ]
+  end
+
+  describe "when asking for artist-release information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_artist_release.xml"))
+      @artist_release = Discogs::Artist::Release.new(data)
+      @artist_release.build!
+    end
+
+    it "should have a ID attribute" do
+      @artist_release.id.should == "999333"
+    end
+
+    it "should have a status attribute" do
+      @artist_release.status.should == "Accepted"
+    end
+
+    it "should have a type attribute" do
+      @artist_release.type.should == "Main"
+    end
+
+    it "should have a title attribute" do
+      @artist_release.title.should == "Temple of the Underworld"
+    end
+
+    it "should have a format attribute" do
+      @artist_release.format.should == "LP"
+    end
+ 
+    it "should have a label attribute" do
+      @artist_release.label.should == "Monitor Records"
+    end
+ 
+    it "should have a year attribute" do
+      @artist_release.year.should == "1992"
+    end
+ 
+    it "should have a trackinfo attribute" do
+      @artist_release.trackinfo.should be_nil
+    end
+
+    it "should have an artist attribute" do
+      @artist_release.artist.should == "ArtIst"
+    end
+ 
+  end
+
+end

data/spec/resources/artist_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Artist do
+
+  it "should map to empty array" do
+    Discogs::Artist.element_names.should == []
+  end
+
+  it "should map plural to empty array" do
+    Discogs::Artist.plural_element_names.should == []
+  end
+
+  ## See ./spec/wrapper_methods/get_artist_spec.rb for extensive tests of this class.
+
+end

data/spec/resources/format_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Release::Format do
+
+  it "should map to format" do
+    Discogs::Release::Format.element_names.should == [ :format ]
+  end
+
+  it "should map to plural formats" do
+    Discogs::Release::Format.plural_element_names.should == [ :formats ]
+  end
+
+  describe "when asking for format information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_format.xml"))
+      @format = Discogs::Release::Format.new(data)
+      @format.build!
+    end
+
+    it "should have a name attribute" do
+      @format.name.should == "CD"
+    end
+
+    it "should have a quantity attribute" do
+      @format.qty.should == "1"
+    end
+
+    it "should have an array of descriptions" do
+      @format.descriptions.should be_instance_of(Array)
+    end
+
+    it "should have built each description" do
+      @format.descriptions[0].should == "Album"
+      @format.descriptions[1].should == "Digipak"
+      @format.descriptions[9].should be_nil
+    end
+
+  end
+
+end

data/spec/resources/generic_list_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::GenericList do
+
+  it "should map to all generic lists" do
+    Discogs::GenericList.element_names.should be_instance_of(Array)
+
+    Discogs::GenericList.element_names.include?(:aliases).should be_true
+    Discogs::GenericList.element_names.include?(:urls).should be_true
+  end
+
+  it "should map to plural lists" do
+    Discogs::GenericList.plural_element_names.should == [ :lists ]
+  end
+
+  describe "when asking for description information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_description_list.xml"))
+      @descriptions = Discogs::GenericList.new(data)
+    end
+
+    it "should return an array on build" do
+      @descriptions.build!.should be_instance_of(Array)
+    end
+
+    it "should have access to the items after build" do
+      @descriptions.build!
+
+      @descriptions[0].should == "Album"
+      @descriptions[1].should == "LP"
+      @descriptions[2].should == "33 rpm"
+    end
+
+    it "should return nil on unknown index" do
+      @descriptions[9].should be_nil
+    end
+ 
+  end
+
+  describe "when asking for genre information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_genre_list.xml"))
+      @genres = Discogs::GenericList.new(data)
+    end
+
+    it "should return an array on build" do
+      @genres.build!.should be_instance_of(Array)
+    end
+
+    it "should have access to the items after build" do
+      @genres.build!
+
+      @genres[0].should == "Heavy Metal"
+      @genres[1].should == "Neofolk"
+      @genres[2].should == "Medieval folk"
+    end
+
+    it "should return nil on unknown index" do
+      @genres[9].should be_nil
+    end
+ 
+  end
+
+end

data/spec/resources/image_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Image do
+
+  it "should map to image" do
+    Discogs::Image.element_names.should == [ :image ]
+  end
+
+  it "should map to plural images" do
+    Discogs::Image.plural_element_names.should == [ :images ]
+  end
+
+  describe "when asking for image information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_image.xml"))
+      @image = Discogs::Image.new(data)
+      @image.build!
+    end
+
+    it "should have a type attribute" do
+      @image.type.should == "primary"
+    end
+
+    it "should have a width attribute" do
+      @image.width.should == "600"
+    end
+
+    it "should have a height attribute" do
+      @image.height.should == "595"
+    end
+ 
+    it "should have a uri attribute" do
+      @image.uri.should == "http://www.discogs.com/image/R-666-1222413500.jpeg"
+    end
+ 
+    it "should have a uri150 attribute" do
+      @image.uri150.should == "http://www.discogs.com/image/R-150-666-1222413500.jpeg"
+    end
+ 
+  end
+
+end

data/spec/resources/label_release_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Label::Release do
+
+  it "should map to release" do
+    Discogs::Label::Release.element_names.should == [ :release ]
+  end
+
+  it "should map to plural releases" do
+    Discogs::Label::Release.plural_element_names.should == [ :releases ]
+  end
+
+  describe "when asking for label-release information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_label_release.xml"))
+      @label_release = Discogs::Label::Release.new(data)
+      @label_release.build!
+    end
+
+    it "should have a ID attribute" do
+      @label_release.id.should == "116322"
+    end
+
+    it "should have a status attribute" do
+      @label_release.status.should == "Accepted"
+    end
+
+    it "should have a catno attribute" do
+      @label_release.catno.should == "SMB09"
+    end
+
+    it "should have an artist attribute" do
+      @label_release.artist.should == "Morrior"
+    end
+
+    it "should have a title attribute" do
+      @label_release.title.should == "Death Metal Session"
+    end
+
+    it "should have a format attribute" do
+      @label_release.format.should == "12\""
+    end
+ 
+    it "should have a year attribute" do
+      @label_release.year.should == "1991"
+    end
+ 
+    it "should have a trackinfo attribute" do
+      @label_release.trackinfo.should == "Side A, track 4"
+    end
+ 
+  end
+
+end

data/spec/resources/label_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Label do
+
+  it "should map to empty array" do
+    Discogs::Label.element_names.should == []
+  end
+
+  it "should map plural to empty array" do
+    Discogs::Label.plural_element_names.should == []
+  end
+
+  ## See ./spec/wrapper_methods/get_label_spec.rb for extensive tests of this class.
+
+end

data/spec/resources/release_artist_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Release::Artist do
+
+  it "should map to artist" do
+    Discogs::Release::Artist.element_names.should == [ :artist ]
+  end
+
+  it "should map to plural artists and extraartists" do
+    Discogs::Release::Artist.plural_element_names.should == [ :artists, :extraartists ]
+  end
+
+  describe "when asking for release-artist information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_release_artist.xml"))
+      @release_artist = Discogs::Release::Artist.new(data)
+      @release_artist.build!
+    end
+
+    it "should have a name attribute" do
+      @release_artist.name.should == "Master's Hammer"
+    end
+
+    it "should have a role attribute" do
+      @release_artist.role.should == "Shrieks"
+    end
+
+    it "should have a join attribute" do
+      @release_artist.join.should == "Relatives"
+    end
+
+    it "should have an anv attribute" do
+      @release_artist.anv.should == "wtf?"
+    end
+
+    it "should have a tracks attribute" do
+      @release_artist.tracks.should == "1,2,4"
+    end
+ 
+  end
+
+end

data/spec/resources/release_label_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Release::Label do
+
+  it "should map to label" do
+    Discogs::Release::Label.element_names.should == [ :label ]
+  end
+
+  it "should map to plural labels" do
+    Discogs::Release::Label.plural_element_names.should == [ :labels ]
+  end
+
+  describe "when asking for release-label information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_release_label.xml"))
+      @release_label = Discogs::Release::Label.new(data)
+      @release_label.build!
+    end
+
+    it "should have a name attribute" do
+      @release_label.name.should == "Toxic Diffusion"
+    end
+
+    it "should have a catno attribute" do
+      @release_label.catno.should == "clp89"
+    end
+ 
+  end
+
+end

data/spec/resources/release_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Release do
+
+  it "should map to empty array" do
+    Discogs::Release.element_names.should == []
+  end
+
+  it "should map plural to empty array" do
+    Discogs::Release.plural_element_names.should == []
+  end
+
+  ## See ./spec/wrapper_methods/get_release_spec.rb for extensive tests of this class.
+
+end

data/spec/resources/search_result_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Search::Result do
+
+  it "should map to result" do
+    Discogs::Search::Result.element_names.should == [ :result ]
+  end
+
+  it "should map to plural exactresults and searchresults" do
+    Discogs::Search::Result.plural_element_names.should == [ :exactresults, :searchresults ]
+  end
+
+  describe "when asking for search result information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_search_result.xml"))
+      @search_result = Discogs::Search::Result.new(data)
+      @search_result.build!
+    end
+
+    it "should have a number attribute" do
+      @search_result.num.should == "2"
+    end
+
+    it "should have a type attribute" do
+      @search_result.type.should == "artist"
+    end
+
+    it "should have a title attribute" do
+      @search_result.title.should == "Karin Slaughter"
+    end
+
+    it "should have a uri attribute" do
+      @search_result.uri.should == "http://www.discogs.com/artist/Karin+Slaughter"
+    end
+
+    it "should have a summary attribute" do
+      @search_result.summary.should == "Karin Slaughter Karin Slaughter"
+    end
+
+    it "should have a anv attribute" do
+      @search_result.anv.should == "Slaughter"
+    end
+
+  end
+
+end

data/spec/resources/search_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Search do
+
+  it "should map to empty array" do
+    Discogs::Search.element_names.should == []
+  end
+
+  it "should map plural to empty array" do
+    Discogs::Search.plural_element_names.should == []
+  end
+
+  ## See ./spec/wrapper_methods/search_spec.rb for extensive tests of this class.
+
+end

data/spec/resources/track_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Discogs::Release::Track do
+
+  it "should map to track" do
+    Discogs::Release::Track.element_names.should == [ :track ]
+  end
+
+  it "should map to plural tracklist" do
+    Discogs::Release::Track.plural_element_names.should == [ :tracklist ]
+  end
+
+  describe "when asking for track information" do
+
+    before do
+      data = File.read(File.join(File.dirname(__FILE__), "..", "samples", "valid_track.xml"))
+      @track = Discogs::Release::Track.new(data)
+      @track.build!
+    end
+
+    it "should have a title attribute" do
+      @track.title.should == "A dark forest spreads all around"
+    end
+
+    it "should have a duration attribute" do
+      @track.duration.should == "7:31"
+    end
+
+    it "should have a position attribute" do
+      @track.position.should == "2"
+    end
+
+    it "should have an array of artists" do
+      @track.artists.should be_instance_of(Array)
+    end
+
+    it "should have an array of extra artists" do
+      @track.extraartists.should be_instance_of(Array)
+    end
+
+    it "should have built each artist" do
+      @track.artists[0].should be_instance_of(Discogs::Release::Track::Artist)
+
+      @track.artists[0].name.should == "Master's Hammer"
+    end
+ 
+    it "should have built each extra artist" do
+      @track.extraartists[0].should be_instance_of(Discogs::Release::Track::Artist)
+
+      @track.extraartists[0].name.should == "Root"
+      @track.extraartists[0].role.should == "Imagery"
+    end
+
+  end
+
+end