discogs-wrapper 1.0.0

data/spec/wrapper_spec.rb

@@ -0,0 +1,162 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe Discogs::Wrapper do
+
+  def mock_http_with_response(code="200", response=nil)
+    @http_request = mock(Net::HTTP)
+    @http_response = mock(Net::HTTPResponse, :code => code, :body => "")
+
+    unless response.nil?
+      @http_response_as_file = mock(StringIO, :read => response)
+      Zlib::GzipReader.should_receive(:new).and_return(@http_response_as_file)
+    end
+
+    # As of 04/09/2010 - The and_yield method is not working for me. I've removed
+    # this from the specs for now, but it's a little troubling because it used to
+    # work correctly... (replacement on line #21)
+    #@http_session = mock("HTTP Session")
+    #@http_session.should_receive(:request).and_return(@http_response)
+    #@http_request.should_receive(:start).and_yield(@http_session)
+
+    @http_request.should_receive(:start).and_return(@http_response)
+    Net::HTTP.should_receive(:new).and_return(@http_request)
+  end
+
+  before do
+    @user_agent = "some_app"
+    @wrapper = Discogs::Wrapper.new(@user_agent)
+    @release_id = "666666"
+    @artist_name = "Dark"
+    @label_name = "Monitor"
+    @search_term = "barry"
+  end
+
+  it "should have an user agent" do
+    @wrapper.user_agent.should == @user_agent
+  end
+
+  describe "requested URIs" do
+    before do
+      @uri = mock("uri", :host => "", :query => "", :path => "")
+    end
+
+    it "should generate the correct release URL to parse" do
+      mock_http_with_response "200", valid_release_xml
+      URI.should_receive(:parse).with("http://api.discogs.com/release/666666?f=xml").and_return(@uri)
+
+      @wrapper.get_release(@release_id)
+    end
+
+    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)
+
+      @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)
+
+      @wrapper.get_label(@label_name)
+    end
+
+    it "should generate the correct default search URL to parse" do
+      mock_http_with_response "200", valid_search_xml
+      URI.should_receive(:parse).with("http://api.discogs.com/search?f=xml&page=1&q=barry&type=all").and_return(@uri)
+
+      @wrapper.search(@search_term)
+    end
+
+    it "should generate the correct second-page search URL to parse" do
+      mock_http_with_response "200", valid_search_xml
+      URI.should_receive(:parse).with("http://api.discogs.com/search?f=xml&page=2&q=barry&type=all").and_return(@uri)
+
+      @wrapper.search(@search_term, :page => 2)
+    end
+
+    it "should generate the correct second-page artist search URL to parse" do
+      mock_http_with_response "200", valid_search_xml
+      URI.should_receive(:parse).with("http://api.discogs.com/search?f=xml&page=2&q=barry&type=artist").and_return(@uri)
+
+      @wrapper.search(@search_term, :page => 2, :type => :artist)
+    end
+
+    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)
+
+      @wrapper.get_artist("A very long band name")
+    end 
+
+  end
+
+  ## NOTE: See ./spec/wrapper_methods/*.rb for indepth tests on valid API requests.
+
+  describe "when requesting a release" do
+
+    it "should successfully return a Discogs::Release object" do
+      mock_http_with_response "200", valid_release_xml
+ 
+      @wrapper.get_release(@release_id).should be_instance_of(Discogs::Release)
+    end
+
+    it "should raise an exception if the release does not exist" do
+      mock_http_with_response "404"
+
+      lambda { @wrapper.get_release(@release_id) }.should raise_error(Discogs::UnknownResource)
+    end
+
+    it "should raise an exception if the server dies a horrible death" do
+      mock_http_with_response "500"
+
+      lambda { @wrapper.get_release(@release_id) }.should raise_error(Discogs::InternalServerError)
+    end
+
+  end
+
+  describe "when requesting an artist" do
+
+    it "should successfully return a Discogs::Artist object" do
+      mock_http_with_response "200", valid_artist_xml
+ 
+      @wrapper.get_artist(@artist_name).should be_instance_of(Discogs::Artist)
+    end
+
+    it "should raise an exception if the artist does not exist" do
+      mock_http_with_response "404"
+
+      lambda { @wrapper.get_artist(@artist_name) }.should raise_error(Discogs::UnknownResource)
+    end
+
+    it "should raise an exception if the server dies a horrible death" do
+      mock_http_with_response "500"
+
+      lambda { @wrapper.get_artist(@artist_name) }.should raise_error(Discogs::InternalServerError)
+    end
+
+  end
+
+  describe "when requesting a label" do
+
+    it "should successfully return a Discogs::Label object" do
+      mock_http_with_response "200", valid_label_xml
+ 
+      @wrapper.get_label(@label_name).should be_instance_of(Discogs::Label)
+    end
+
+    it "should raise an exception if the label does not exist" do
+      mock_http_with_response "404"
+
+      lambda { @wrapper.get_label(@label_name) }.should raise_error(Discogs::UnknownResource)
+    end
+
+    it "should raise an exception if the server dies a horrible death" do
+      mock_http_with_response "500"
+
+      lambda { @wrapper.get_label(@label_name) }.should raise_error(Discogs::InternalServerError)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: discogs-wrapper
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrew Buntine
+- Ed Hickey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-27 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Discogs::Wrapper is a full wrapper for the http://www.discogs.com API V2
+email: info@andrewbuntine.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/wrapper/resource_mappings.rb
+- lib/wrapper/wrapper.rb
+- lib/wrapper/resource.rb
+- lib/wrapper/resources/format.rb
+- lib/wrapper/resources/search.rb
+- lib/wrapper/resources/label_release.rb
+- lib/wrapper/resources/artist.rb
+- lib/wrapper/resources/release_artist.rb
+- lib/wrapper/resources/artist_release.rb
+- lib/wrapper/resources/release_label.rb
+- lib/wrapper/resources/generic_list.rb
+- lib/wrapper/resources/search_result.rb
+- lib/wrapper/resources/label.rb
+- lib/wrapper/resources/image.rb
+- lib/wrapper/resources/track.rb
+- lib/wrapper/resources/release.rb
+- lib/discogs.rb
+- Rakefile
+- README.markdown
+- discogs.gemspec
+- spec/wrapper_methods/get_release_spec.rb
+- spec/wrapper_methods/search_spec.rb
+- spec/wrapper_methods/get_artist_spec.rb
+- spec/wrapper_methods/get_label_spec.rb
+- spec/resource_spec.rb
+- spec/resources/label_spec.rb
+- spec/resources/generic_list_spec.rb
+- spec/resources/artist_release_spec.rb
+- spec/resources/artist_spec.rb
+- spec/resources/release_artist_spec.rb
+- spec/resources/search_spec.rb
+- spec/resources/label_release_spec.rb
+- spec/resources/release_label_spec.rb
+- spec/resources/release_spec.rb
+- spec/resources/search_result_spec.rb
+- spec/resources/image_spec.rb
+- spec/resources/track_spec.rb
+- spec/resources/format_spec.rb
+- spec/wrapper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.github.com/buntine/discogs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Discogs::Wrapper is a full wrapper for the http://www.discogs.com API V2
+test_files: 
+- spec/wrapper_methods/get_release_spec.rb
+- spec/wrapper_methods/search_spec.rb
+- spec/wrapper_methods/get_artist_spec.rb
+- spec/wrapper_methods/get_label_spec.rb
+- spec/resource_spec.rb
+- spec/resources/label_spec.rb
+- spec/resources/generic_list_spec.rb
+- spec/resources/artist_release_spec.rb
+- spec/resources/artist_spec.rb
+- spec/resources/release_artist_spec.rb
+- spec/resources/search_spec.rb
+- spec/resources/label_release_spec.rb
+- spec/resources/release_label_spec.rb
+- spec/resources/release_spec.rb
+- spec/resources/search_result_spec.rb
+- spec/resources/image_spec.rb
+- spec/resources/track_spec.rb
+- spec/resources/format_spec.rb
+- spec/wrapper_spec.rb
+- spec/spec_helper.rb