discogs-wrapper 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe2e0b555db6b6594e278c843c7f3f6d8b0a4cd1
-  data.tar.gz: e11044282bf2d59bfb2bae694abbdbdb5d5684c0
+  metadata.gz: ae13ebef40ffcfb33e23eae6023cc0f53e2415d0
+  data.tar.gz: 089c0a08632d61a606ffe83d64c5e1e92c2c4179
 SHA512:
-  metadata.gz: d9c291ac7fcd4aef06b7585fd5bd6f52d92dacb67fd7ec80c80baefd13b1b894e98a393720afe6e0a87d50f37840e2a53ae65fb4256e5acb81bdde91977818f8
-  data.tar.gz: 82685658025abeb2b4588b8023942252a51c96989540a96e06a1b387bbdf5788cdc0bbb76a5b3c99dd84acf3cdc6adc8cfb5c2a1dacd9a330e891beff0312ea1
+  metadata.gz: 2e193879c585f4418a3c3c0c3bd7e4bf587d52bd5dfffd73c64f12bfc7dd6229a3f10e77ca29f6ec3b6ddcf994fe77902c413a9337031a481db8b6e3d44a29f5
+  data.tar.gz: 2e6f5a9fb1cb72a75eee77c0f006a07869b5df0d5926835a050af43f56e9d6de23ff6f760c0e806412f8f68561a90223440a726be30f32ce2890fe07b196ca5d

data/lib/discogs.rb

@@ -4,8 +4,7 @@
 ##   
 ##   This library provides full access to the Discogs.com API v2.0
 ##
-##   Please file all bug reports at http://www.github.com/buntine/discogs, or
-##   email me at info@andrewbuntine.com.
+##   Please file all bug reports at https://www.github.com/buntine/discogs.
 ##
 ##   Enjoy!
 

data/lib/wrapper/wrapper.rb

@@ -2,7 +2,7 @@
 
 require 'hashie'
 require 'json'
-require 'net/http'
+require 'httparty'
 require 'stringio'
 require 'uri'
 require 'cgi'
@@ -116,7 +116,7 @@ class Discogs::Wrapper
   # @macro uses_pagination
   # @return [Hash] the user with provided username
   def get_user_collection(username, pagination={})
-    get_user_folder_releases(username, 0)
+    get_user_folder_releases(username, 0, pagination)
   end
 
   # Retrieve a list of user-defined collection notes fields. These fields are available on every release in the collection.
@@ -488,7 +488,7 @@ class Discogs::Wrapper
   #     * +No Cover+
   #   @option data [Float (Required)] :price The price of the item (in the seller's currency).
   #   @option data [String (Optional)] :comments Any remarks about the item that will be displayed to buyers.
-  #   @option data [Boolean (Optional)] :allow_buffers (false) Whether or not to allow buyers to make offers on the item. Defaults to +false+.
+  #   @option data [Boolean (Optional)] :allow_offers (false) Whether or not to allow buyers to make offers on the item. Defaults to +false+.
   #   @option data [String (Optional)] :status (+For Sale+) The status of the listing. Defaults to For Sale. Must *EXACTLY* match one of:
   #     * +For Sale+ - the listing is ready to be shown on the Marketplace
   #     * +Draft+ - the listing is not ready for public display
@@ -701,6 +701,12 @@ class Discogs::Wrapper
     end
   end
 
+  # Perform a search.
+  #
+  # @macro need_auth
+  #
+  # @param [String (Required)] term to search.
+  # @return [Hash] search results
   def search(term, params={})
     authenticated? do
       parameters = {:q => term}.merge(params)
@@ -708,6 +714,10 @@ class Discogs::Wrapper
     end
   end
 
+  # Fetch response from API using a fully-qualified URL.
+  #
+  # @param [String (Required)] API endpoint
+  # @return [Hash] API response
   def raw(url)
     uri    = URI.parse(url)
     params = CGI.parse(uri.query.to_s)
@@ -720,9 +730,13 @@ class Discogs::Wrapper
   def query_and_build(path, params={}, method=:get, body=nil)
     parameters = {:f => "json"}.merge(params)
     data = query_api(path, params, method, body)
-    hash = JSON.parse(data)
 
-    Hashie::Mash.new(hash)
+    if data != ""
+      hash = JSON.parse(data)
+      Hashie::Mash.new(hash)
+    else
+      Hashie::Mash.new
+    end
   end
 
   # Queries the API and handles the response.
@@ -732,25 +746,25 @@ class Discogs::Wrapper
     raise_unknown_resource(path) if response.code == "404"
     raise_authentication_error(path) if response.code == "401"
     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))
+      inflated_data = Zlib::GzipReader.new(StringIO.new(response.body.to_s))
       response_body = inflated_data.read
     rescue Zlib::GzipFile::Error
       response_body = response.body
     end
 
-    response_body
+    response_body.to_s
   end
 
   # Generates a HTTP request and returns the response.
   def make_request(path, params, method, body)
     full_params   = params.merge(auth_params)
     uri           = build_uri(path, full_params)
-    formatted     = "#{uri.path}?#{uri.query}"
+    formatted     = "#{uri.path}?#{uri.query}" 
     output_format = full_params.fetch(:f, "json")
     headers       = {"Accept"          => "application/#{output_format}",
                      "Accept-Encoding" => "gzip,deflate",
@@ -764,17 +778,8 @@ class Discogs::Wrapper
         @access_token.send(method, formatted, headers)
       end
     else
-      # All non-authenticated endpoints are GET.
-      request = Net::HTTP::Get.new(formatted)
-
-      headers.each do |h, v|
-        request.add_field(h, v)
-      end
-
-      Net::HTTP.start(uri.host, uri.port,
-        :use_ssl => uri.scheme == 'https') do |http|
-        http.request(request)
-      end
+     # All non-authenticated endpoints are GET.
+      HTTParty.get(uri, headers: headers)
     end
   end
 

data/spec/spec_helper.rb

@@ -28,3 +28,12 @@ def sample_invalid_data
     </resp> 
   EOF
 end
+
+def mock_httparty(sample)
+  @http_response = double(HTTParty::Response)
+  @http_request = class_double(HTTParty).as_stubbed_const
+
+  allow(@http_response).to receive_messages(:code => "200", :body => read_sample(sample))
+
+  @http_request.should_receive(:get).and_return(@http_response)
+end

data/spec/wrapper_methods/add_release_to_user_wantlist_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe Discogs::Wrapper do
 
   before do
-    @oauth_access_token = mock(OAuth::AccessToken)
-    @wrapper = Discogs::Wrapper.new("some_user_agent", @oauth_access_token)
+    @oauth_access_token = double(OAuth::AccessToken)
+    @wrapper = Discogs::Wrapper.new("some_user_agent", :access_token => @oauth_access_token)
 
     @username = "abuntine"
     @release_id = "1"
@@ -13,10 +13,16 @@ describe Discogs::Wrapper do
   describe ".add_release_to_user_wantlist" do
 
     before do
-      @oauth_response = mock(OAuth::AccessToken, :code => "200", :body => read_sample("wantlist_release"))
-      @oauth_response_as_file = mock(StringIO, :read => read_sample("wantlist_release"))
-      Zlib::GzipReader.should_receive(:new).and_return(@oauth_response_as_file)
-      @oauth_access_token.should_receive(:put).and_return(@oauth_response)
+      @oauth_response = double(OAuth::AccessToken)
+      
+      allow(@oauth_response).to receive_messages(:code => "200", :body => read_sample("wantlist_release"))
+
+      @oauth_response_as_file = double(StringIO)
+      
+      allow(@oauth_response_as_file).to receive_messages(:read => read_sample("wantlist_release"))
+
+      expect(Zlib::GzipReader).to receive(:new).and_return(@oauth_response_as_file)
+      expect(@oauth_access_token).to receive(:put).and_return(@oauth_response)
 
       @wantlist_release = @wrapper.add_release_to_user_wantlist(@username, @release_id)
     end
@@ -24,15 +30,15 @@ describe Discogs::Wrapper do
     describe "when calling simple wantlist release attributes" do
 
       it "should have an id" do
-        @wantlist_release.id.should == 1
+        expect(@wantlist_release.id).to eq(1)
       end
 
       it "should have a rating" do
-        @wantlist_release.rating.should == 0
+        expect(@wantlist_release.rating).to eq(0)
       end
 
       it "should have some basic information" do
-        @wantlist_release.basic_information.title.should == "Stockholm"
+        expect(@wantlist_release.basic_information.title).to eq("Stockholm")
       end
 
     end

data/spec/wrapper_methods/edit_release_in_user_wantlist_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe Discogs::Wrapper do
 
   before do
-    @oauth_access_token = mock(OAuth::AccessToken)
-    @wrapper = Discogs::Wrapper.new("some_user_agent", @oauth_access_token)
+    @oauth_access_token = double(OAuth::AccessToken)
+    @wrapper = Discogs::Wrapper.new("some_user_agent", :access_token => @oauth_access_token)
 
     @username = "abuntine"
     @release_id = "1"
@@ -13,10 +13,16 @@ describe Discogs::Wrapper do
   describe ".edit_release_in_user_wantlist" do
 
     before do
-      @oauth_response = mock(OAuth::AccessToken, :code => "200", :body => read_sample("wantlist_release"))
-      @oauth_response_as_file = mock(StringIO, :read => read_sample("wantlist_release"))
-      Zlib::GzipReader.should_receive(:new).and_return(@oauth_response_as_file)
-      @oauth_access_token.should_receive(:post).and_return(@oauth_response)
+      @oauth_response = double(OAuth::AccessToken)
+      
+      allow(@oauth_response).to receive_messages(:code => "200", :body => read_sample("wantlist_release"))
+
+      @oauth_response_as_file = double(StringIO)
+      
+      allow(@oauth_response_as_file).to receive_messages(:read => read_sample("wantlist_release"))
+
+      expect(Zlib::GzipReader).to receive(:new).and_return(@oauth_response_as_file)
+      expect(@oauth_access_token).to receive(:post).and_return(@oauth_response)
 
       @wantlist_release = @wrapper.edit_release_in_user_wantlist(@username, @release_id, {:notes => "This is a note"})
     end
@@ -24,11 +30,11 @@ describe Discogs::Wrapper do
     describe "when calling simple wantlist release attributes" do
 
       it "should have an id" do
-        @wantlist_release.id.should == 1
+        expect(@wantlist_release.id).to eq(1)
       end
 
       it "should have a some notes" do
-        @wantlist_release.notes.should == "This is a note"
+        expect(@wantlist_release.notes).to eq("This is a note")
       end
 
     end

data/spec/wrapper_methods/edit_user_spec.rb

@@ -3,18 +3,25 @@ require 'spec_helper'
 describe Discogs::Wrapper do
 
   before do
-    @oauth_access_token = mock(OAuth::AccessToken)
-    @wrapper = Discogs::Wrapper.new("some_user_agent", @oauth_access_token)
+    @oauth_access_token = double(OAuth::AccessToken)
+    @wrapper = Discogs::Wrapper.new("some_user_agent", :access_token => @oauth_access_token)
+
     @username = "abuntine"
   end
 
   describe ".edit_user" do
 
     before do
-      @oauth_response = mock(OAuth::AccessToken, :code => "200", :body => read_sample("user_profile"))
-      @oauth_response_as_file = mock(StringIO, :read => read_sample("user_profile"))
-      Zlib::GzipReader.should_receive(:new).and_return(@oauth_response_as_file)
-      @oauth_access_token.should_receive(:post).and_return(@oauth_response)
+      @oauth_response = double(OAuth::AccessToken)
+      
+      allow(@oauth_response).to receive_messages(:code => "200", :body => read_sample("user_profile"))
+
+      @oauth_response_as_file = double(StringIO)
+      
+      allow(@oauth_response_as_file).to receive_messages(:read => read_sample("user_profile"))
+
+      expect(Zlib::GzipReader).to receive(:new).and_return(@oauth_response_as_file)
+      expect(@oauth_access_token).to receive(:post).and_return(@oauth_response)
 
       @user_profile = @wrapper.edit_user(@username, {:profile => "This is a new profile"})
     end
@@ -22,11 +29,11 @@ describe Discogs::Wrapper do
     describe "when calling simple user profile attributes" do
 
       it "should have a username" do
-        @user_profile.username.should == "abuntine"
+        expect(@user_profile.username).to eq("abuntine")
       end
 
       it "should have a new profile" do
-        @user_profile.profile.should == "This is a new profile"
+        expect(@user_profile.profile).to eq("This is a new profile")
       end
 
     end

data/spec/wrapper_methods/get_artist_releases_spec.rb

@@ -10,12 +10,7 @@ describe Discogs::Wrapper do
   describe ".get_artists_releases" do
 
     before do
-      @http_request = mock(Net::HTTP)
-      @http_response = mock(Net::HTTPResponse, :code => "200", :body => read_sample("artist_releases"))
-      @http_response_as_file = mock(StringIO, :read => read_sample("artist_releases"))
-      Zlib::GzipReader.should_receive(:new).and_return(@http_response_as_file)
-      @http_request.should_receive(:start).and_return(@http_response)
-      Net::HTTP.should_receive(:new).and_return(@http_request)
+      mock_httparty("artist_releases")
 
       @artist_releases = @wrapper.get_artist_releases(@artist_id)
     end
@@ -23,23 +18,23 @@ describe Discogs::Wrapper do
     describe "when calling simple releases attributes" do
 
       it "should have 37 releases per page" do
-        @artist_releases.releases.length.should == 37
+        expect(@artist_releases.releases.length).to eq(37)
       end
 
       it "should have 37 releases total" do
-        @artist_releases.pagination.items.should == 37
+        expect(@artist_releases.pagination.items).to eq(37)
       end
 
       it "should have a first release with a title" do
-        @artist_releases.releases.first.title.should == "Frost And Fire"
+        expect(@artist_releases.releases.first.title).to eq("Frost And Fire")
       end
 
       it "should have a first release with a type" do
-        @artist_releases.releases.first.type.should == "master"
+        expect(@artist_releases.releases.first.type).to eq("master")
       end
 
       it "should not have a bogus attribute" do
-        @artist_releases.bogus_attr.should be_nil
+        expect(@artist_releases.bogus_attr).to be_nil
       end
 
     end

data/spec/wrapper_methods/get_artist_spec.rb

@@ -10,12 +10,7 @@ describe Discogs::Wrapper do
   describe ".get_artist" do
 
     before do
-      @http_request = mock(Net::HTTP)
-      @http_response = mock(Net::HTTPResponse, :code => "200", :body => read_sample("artist"))
-      @http_response_as_file = mock(StringIO, :read => read_sample("artist"))
-      Zlib::GzipReader.should_receive(:new).and_return(@http_response_as_file)
-      @http_request.should_receive(:start).and_return(@http_response)
-      Net::HTTP.should_receive(:new).and_return(@http_request)
+      mock_httparty("artist")
 
       @artist = @wrapper.get_artist(@artist_id)
     end
@@ -39,7 +34,7 @@ describe Discogs::Wrapper do
       end
 
       it "should have one or more members" do
-        @artist.members.should be_instance_of(Array)
+        @artist.members.should be_instance_of(Hashie::Array)
         @artist.members[0].name.should == "Greg Lindstrom"
       end
 
@@ -52,13 +47,13 @@ describe Discogs::Wrapper do
     describe "when calling complex artist attributes" do
 
       it "should have a traversible list of URLs" do
-        @artist.urls.should be_instance_of(Array)
+        @artist.urls.should be_instance_of(Hashie::Array)
         @artist.urls[0].should == "http://www.truemetal.org/cirithungol"
         @artist.urls[1].should == "http://www.myspace.com/cirithungol"
       end
 
       it "should have a traversible list of images" do
-        @artist.images.should be_instance_of(Array)
+        @artist.images.should be_instance_of(Hashie::Array)
       end
 
       it "should have specifications for each image" do

data/spec/wrapper_methods/get_identity_spec.rb

@@ -3,17 +3,23 @@ require 'spec_helper'
 describe Discogs::Wrapper do
 
   before do
-    @oauth_access_token = mock(OAuth::AccessToken)
-    @wrapper = Discogs::Wrapper.new("some_user_agent", @oauth_access_token)
+    @oauth_access_token = double(OAuth::AccessToken)
+    @wrapper = Discogs::Wrapper.new("some_user_agent", :access_token => @oauth_access_token)
   end
 
   describe ".get_identity" do
 
     before do
-      @oauth_response = mock(OAuth::AccessToken, :code => "200", :body => read_sample("identity"))
-      @oauth_response_as_file = mock(StringIO, :read => read_sample("identity"))
-      Zlib::GzipReader.should_receive(:new).and_return(@oauth_response_as_file)
-      @oauth_access_token.should_receive(:get).and_return(@oauth_response)
+      @oauth_response = double(OAuth::AccessToken)
+      
+      allow(@oauth_response).to receive_messages(:code => "200", :body => read_sample("identity"))
+
+      @oauth_response_as_file = double(StringIO)
+      
+      allow(@oauth_response_as_file).to receive_messages(:read => read_sample("identity"))
+
+      expect(Zlib::GzipReader).to receive(:new).and_return(@oauth_response_as_file)
+      expect(@oauth_access_token).to receive(:get).and_return(@oauth_response)
 
       @identity = @wrapper.get_identity
     end
@@ -21,11 +27,11 @@ describe Discogs::Wrapper do
     describe "when calling simple identity attributes" do
 
       it "should have a username" do
-        @identity.username.should == "example"
+        expect(@identity.username).to eq("example")
       end
 
       it "should have a consumer_name" do
-        @identity.consumer_name.should == "Your Application Name"
+        expect(@identity.consumer_name).to eq("Your Application Name")
       end
 
     end

data/spec/wrapper_methods/get_label_releases_spec.rb

@@ -10,12 +10,7 @@ describe Discogs::Wrapper do
   describe ".get_labels_releases" do
 
     before do
-      @http_request = mock(Net::HTTP)
-      @http_response = mock(Net::HTTPResponse, :code => "200", :body => read_sample("label_releases"))
-      @http_response_as_file = mock(StringIO, :read => read_sample("label_releases"))
-      Zlib::GzipReader.should_receive(:new).and_return(@http_response_as_file)
-      @http_request.should_receive(:start).and_return(@http_response)
-      Net::HTTP.should_receive(:new).and_return(@http_request)
+      mock_httparty("label_releases")
 
       @label_releases = @wrapper.get_label_releases(@label_id)
     end
@@ -23,23 +18,23 @@ describe Discogs::Wrapper do
     describe "when calling simple releases attributes" do
 
       it "should have 8 releases per page" do
-        @label_releases.releases.length.should == 8
+        expect(@label_releases.releases.length).to eq(8)
       end
 
       it "should have 8 releases total" do
-        @label_releases.pagination.items.should == 8
+        expect(@label_releases.pagination.items).to eq(8)
       end
 
       it "should have a first release with a Cat No" do
-        @label_releases.releases.first.catno.should == "SSS 001"
+        expect(@label_releases.releases.first.catno).to eq("SSS 001")
       end
 
       it "should have a first release with a status" do
-        @label_releases.releases.first.status.should == "Accepted"
+        expect(@label_releases.releases.first.status).to eq("Accepted")
       end
 
       it "should not have a bogus attribute" do
-      	@label_releases.bogus_attribute.should be_nil
+        expect(@label_releases.bogus_attribute).to be_nil
       end
 
     end