discogs-wrapper 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 452ba1fcbd498273e0b9f108f6e5b7aee3a702ae0a319ccfec159e9970209bcb
-  data.tar.gz: 552d70e54152bafd4c09e08d8552c99efe718bea936e634b8fbaefc7df55b20b
+  metadata.gz: 798cfa307567b4f7357cc2f4885bce6bdb6fc5e6958b3283aa94e4df30eba47b
+  data.tar.gz: 65bf1b0b0a6289676ce068458bf059797348e3aa133a16371c75ab5946453762
 SHA512:
-  metadata.gz: 0e0449729d5e7b79b6e7f067fa4cbe3cbc0b9fa9f8f7cdfc3a3b384b14f7f0e6614b2fb66efd56cddc5a1505d1b542e02952d7a0b176e48cb5496bbd1266bf99
-  data.tar.gz: 95b4ebf0d2bc534520b18d7a0b4babb04e444f99ec2eda73ba258a926225018f385af94c876d3f1d6b1da81f89e8ecc03991eb0e5957b901fb36889a0e19e365
+  metadata.gz: 5ff421201fc13851d304be663edf3b944e2b7c89c695fd5e6646b7be8760cbe37055cb697db21324d12b20688c4fa77a00faf82a7a319d18218b72ae5a5114cd
+  data.tar.gz: 3e81877b8f07e3a455fd233f3ca61210832b7c37be6d903d3ea449486e5edb8bbe136c432186a5cf619149f5f51b185ffa6b336a1819ac013c3170b4ae0888fb

data/README.markdown

@@ -52,6 +52,8 @@ USAGE
   To use this library, you must supply the name of your application. For example:
 
 ```ruby
+require "discogs"
+
 wrapper = Discogs::Wrapper.new("My awesome web app")
 ```
 
@@ -92,11 +94,19 @@ search.results.first.id              # => 691078
 
   Many of the API endpoints return further URLs that will yield specific data. To cater for this, the library provides a "raw" method that accepts a valid API URL. For example:
 
-    sts_records       = wrapper.get_label(9800)
-    sts_releases      = wrapper.raw(sts_records.releases_url)
-    first_sts_release = wrapper.raw(sts_releases.releases[1].resource_url)
+```ruby
+sts_records       = wrapper.get_label(9800)
+sts_releases      = wrapper.raw(sts_records.releases_url)
+first_sts_release = wrapper.raw(sts_releases.releases[1].resource_url)
+
+first_sts_release.title  # => "I'll Nostra Tempo De La Vita / Having The Time Of Your Life"
+```
 
-    first_sts_release.title  # => "I'll Nostra Tempo De La Vita / Having The Time Of Your Life"
+  You can also add optional querystring overrides to raw calls:
+
+```ruby
+sombre = wrapper.raw("https://api.discogs.com/database/search?q=Sombre+Records&per_page=50&type=release", {"page" => 2})
+```
 
   You can see all implemented methods on [this projects RDoc page](http://rdoc.info/github/buntine/discogs/master/frames).
 

data/lib/discogs.rb

@@ -15,6 +15,7 @@ module Discogs; end
 class Discogs::UnknownResource < StandardError; end
 class Discogs::InternalServerError < StandardError; end
 class Discogs::AuthenticationError < StandardError; end
+class Discogs::RateLimitError < StandardError; end
 
 # Loading sequence.
 require File.dirname(__FILE__) + "/wrapper/wrapper"

data/lib/wrapper/wrapper.rb

@@ -680,7 +680,7 @@ class Discogs::Wrapper
   #   * +AUD+
   #   * +JPY+
   def get_fee(price, currency="USD")
-    query_and_build "marketplace/fee/#{price}/#{currency}"
+    query_and_build "marketplace/fee/#{CGI.escape(price)}/#{currency}"
   end
 
   # Retrieve an image by filename.
@@ -718,9 +718,9 @@ class Discogs::Wrapper
   #
   # @param [String (Required)] API endpoint
   # @return [Hash] API response
-  def raw(url)
+  def raw(url, additional_params={})
     uri    = URI.parse(url)
-    params = CGI.parse(uri.query.to_s)
+    params = CGI.parse(uri.query.to_s).merge(additional_params)
 
     query_and_build uri.path, params
   end
@@ -745,6 +745,7 @@ class Discogs::Wrapper
 
     raise_unknown_resource(path) if response.code == "404"
     raise_authentication_error(path) if response.code == "401"
+    raise_rate_limit_error(path) if response.code == "429"
     raise_internal_server_error if response.code == "500"
 
     # Unzip the response data, or just read it in directly
@@ -797,7 +798,7 @@ class Discogs::Wrapper
     parameters    = {:f => output_format}.merge(params)
     querystring   = "?" + URI.encode_www_form(prepare_hash(parameters))
 
-    URI.parse(File.join(@@root_host, [URI.escape(path), querystring].join))
+    URI.parse(File.join(@@root_host, [path, querystring].join))
   end
 
   # Stringifies keys and sorts.
@@ -813,7 +814,7 @@ class Discogs::Wrapper
 
   # Replaces known conflicting keys with safe names in a nested hash structure.
   def sanitize_hash(hash)
-    conflicts = {"count" => "total"}
+    conflicts = {"count" => "total", "type_" => "type"}
     result = {}
 
     for k, v in hash
@@ -833,6 +834,8 @@ class Discogs::Wrapper
 
       if v.is_a?(Hash)
         result[k] = sanitize_hash(result[k])
+      elsif v.is_a?(Array)
+        result[k] = v.map { |o| o.is_a?(Hash) ? sanitize_hash(o) : o }
       end
     end
 
@@ -843,6 +846,10 @@ class Discogs::Wrapper
     raise Discogs::UnknownResource, "Unknown Discogs resource: #{path}"
   end
 
+  def raise_rate_limit_error(path="")
+    raise Discogs::RateLimitError, "Rate limit exceeded: #{path}"
+  end
+
   def raise_internal_server_error
     raise Discogs::InternalServerError, "The API server cannot complete the request"
   end

data/spec/wrapper_spec.rb

@@ -146,6 +146,18 @@ describe Discogs::Wrapper do
       @wrapper.raw("https://api.discogs.com/artists/1000")
     end
 
+    it "should generate the correct URL to parse when given raw URL and additional params" do
+      @search_uri = double("uri")
+
+      allow(@search_uri).to receive_messages(:host => "api.discogs.com", :query => "q=Sombre+Records&per_page=50&type=release&page=12&new=true", :path => "database/search")
+
+      mock_http_with_response "200", read_sample("search_results")
+      URI.should_receive(:parse).with("https://api.discogs.com/database/search?q=Sombre+Records&per_page=50&type=release&page=11").and_return(@search_uri)
+      URI.should_receive(:parse).with("https://api.discogs.com/database/search?f=json&new=true&page=12&per_page=50&q=Sombre+Records&type=release").and_return(@uri)
+
+      @wrapper.raw("https://api.discogs.com/database/search?q=Sombre+Records&per_page=50&type=release&page=11", {"page" => 12, "new" => true})
+    end
+
   end
 
   ## NOTE: See ./spec/wrapper_methods/*.rb for indepth tests on valid API requests.
@@ -247,4 +259,13 @@ describe Discogs::Wrapper do
 
   end
 
+  describe "when exceeding rate limit" do
+
+    it "should raise an exception if the rate limit is exceeded" do
+      mock_http_with_response "429"
+
+      lambda { @wrapper.get_master(@master_id) }.should raise_error(Discogs::RateLimitError)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discogs-wrapper
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Andrew Buntine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry