discogs-wrapper 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db8498b9648d42f56633fb27c6d14c4acb2bc7ae
-  data.tar.gz: dc3423bfadd46bcb985095afd9f4aea47f338f06
+  metadata.gz: 4654ad8d85f69444831ce09b6c2960ba2e598fed
+  data.tar.gz: fa37e9987c31c5763df41d822c0b3c08929b29e6
 SHA512:
-  metadata.gz: afeef272acdae1b28b4e49e2c1ca50a2be7986404f07b8faa0d3466e025d505272d2d597b87902434af37335ca232d5c1796f71cbe78aeb5312cddbf209000ac
-  data.tar.gz: 19ff741fff62b78442a0abd8e93e4716a1310a08eac8b27cc08a6524418a9b67a13c6e94da54f4f2b2555949b568fddfddec53173d05b27a3f098d124740c1fc
+  metadata.gz: 9b54ec185f2dcf2415721a7b88008f5a8a1c20860e8af6e456614ccb246855618cea55ca332744266bd14ccdb96cdd4c7aa5eadf9204d4c41bb8f8c979c12215
+  data.tar.gz: b1d6c9e76a7f988429386fae10ae74ee7c8140555058c2c0c9c5beee4c734fbfff42dd03425cbb2493da7506e2c09bfa7f9816381ec297777f2bc273f34b3abe

data/lib/wrapper/wrapper.rb

@@ -733,7 +733,7 @@ class Discogs::Wrapper
 
     if data != ""
       hash = JSON.parse(data)
-      Hashie::Mash.new(hash)
+      Hashie::Mash.new(sanitize_hash(hash))
     else
       Hashie::Mash.new
     end
@@ -793,13 +793,41 @@ class Discogs::Wrapper
 
   # Stringifies keys and sorts.
   def prepare_hash(h)
+    result = Hash[
+      h.map do |k, v|
+        [k.to_s, v]
+      end
+    ]
+
+    result.sort
+  end
+
+  # Replaces known conflicting keys with safe names in a nested hash structure.
+  def sanitize_hash(hash)
+    conflicts = {"count" => "total"}
     result = {}
 
-    h.each do |k, v|
-      result[k.to_s] = v
+    for k, v in hash
+      safe_name = conflicts[k]
+
+      if safe_name
+        # BC: Temporary set original key for backwards-compatibility.
+        warn "[DEPRECATED]: The key '#{k}' has been replaced with '#{safe_name}'. When accessing, please use the latter. This message will be removed in the next major release."
+        result[k] = v
+        # End BC
+
+        result[safe_name] = v
+        k = safe_name
+      else
+        result[k] = v
+      end
+
+      if v.is_a?(Hash)
+        result[k] = sanitize_hash(result[k])
+      end
     end
 
-    result.sort
+    result
   end
 
   def raise_unknown_resource(path="")

data/spec/wrapper_methods/get_release_spec.rb

@@ -30,6 +30,15 @@ describe Discogs::Wrapper do
         expect(@release.master_id).to eq(5427)
       end
 
+      it "should have a community/rating attribute" do
+        expect(@release.community.rating).to be_instance_of(Hashie::Mash)
+      end
+
+      it "should have sanitized the rating count attribute" do
+        expect(@release.community.rating.total).to eq(91) 
+        expect(@release.community.rating.count).to eq(2 + 1) # Original method - count returns number of key/value pairs. Plus one to be removed after backwards-compatibility fix has been removed.
+      end
+
       it "should have one or more extra artists" do
         expect(@release.extraartists).to be_instance_of(Hashie::Array)
         expect(@release.extraartists[0].id).to eq(239)

data/spec/wrapper_methods/get_user_folder_spec.rb

@@ -22,7 +22,12 @@ describe Discogs::Wrapper do
         expect(@user_folder.name).to eq("Uncategorized")
       end
 
-      it "should have a count" do
+      it "should have sanitized count" do
+        expect(@user_folder.total).to eq(20)
+        expect(@user_folder.count).to eq(4 + 1) # Plus one to be removed after backwards-compatibility fix has been removed.
+      end
+
+      it "should have a backwards-compatible count" do
         expect(@user_folder[:count]).to eq(20)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discogs-wrapper
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Andrew Buntine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-04 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry