Merge pull request #107 from sparkapi/FLEX-1553

FLEX-1553 extend Listing to include the new reorder single image service

Author: wlmcewen

lib/spark_api/models/listing.rb

@@ -191,7 +191,26 @@ def reorder_photos!(arguments={})
         results = connection.put "#{self.class.path}/#{self.Id}/photos", arguments
         true
       end
-      
+
+      def reorder_photo(photo_id, index)
+        unless Integer(index)
+          raise ArgumentError, "Photo reorder failed. '#{index}' is not a number."
+        end
+
+        begin
+          return reorder_photo!(photo_id, index)
+        rescue BadResourceRequest => e
+          SparkApi.logger.warn { "Failed to save resource #{self}: #{e.message}" }
+        rescue NotFound => e
+          SparkApi.logger.error { "Failed to save resource #{self}: #{e.message}" }
+        end
+        false
+      end
+      def reorder_photo!(photo_id, index)
+        connection.put "#{self.class.path}/#{self.Id}/photos/#{photo_id}", "Photos" => [{"Order"=>index}]
+        true
+      end
+
       def editable?(editable_settings = [])
         settings = Array(editable_settings)
         editable = attributes.include?("Permissions") && self.Permissions["Editable"] == true

spec/fixtures/listings/put_reorder_photo.json

@@ -0,0 +1,5 @@
+{
+  "D": {
+    "Photos": [{"Order" : "2"}]
+  }
+}

spec/fixtures/listings/reorder_photo.json

@@ -0,0 +1,20 @@
+{
+  "D": {
+    "Results": [
+        {
+            "Uri300": "http://photos.flexmls.com/fgo/20050505220032167405000000.jpg",
+            "ResourceUri": "/v1/listings/20050505200220759069000000/photos/20050505220032167405000000",
+            "Name": "Front",
+            "Primary": true,
+            "Uri800": "http://cdn.resize.flexmls.com/fgo/800x600/true/20050505220032167405000000-o.jpg",
+            "Id": "20050505220032167405000000",
+            "UriLarge": "http://photos.flexmls.com/fgo/20050505220032167405000000-o.jpg",
+            "Uri1024": "http://cdn.resize.flexmls.com/fgo/1024x768/true/20050505220032167405000000-o.jpg",
+            "Caption": "",
+            "Uri1280": "http://cdn.resize.flexmls.com/fgo/1280x1024/true/20050505220032167405000000-o.jpg",
+            "Uri640": "http://cdn.resize.flexmls.com/fgo/640x480/true/20050505220032167405000000-o.jpg",
+            "UriThumb": "http://photos.flexmls.com/fgo/20050505220032167405000000-t.jpg"
+        }
+    ]
+  }
+}

spec/unit/spark_api/models/listing_spec.rb

@@ -251,6 +251,23 @@
         l.errors.size.should eq(1)
       end
 
+      on_put_it "should reorder a photo" do
+        list_id = "20060725224713296297000000"
+        stub_api_get("/listings/#{list_id}", 'listings/with_photos.json')
+        stub_api_put("/listings/#{list_id}/photos/20110826220032167405000000", 'listings/put_reorder_photo.json', 'listings/reorder_photo.json')
+        l = Listing.find(list_id)
+        l.reorder_photo("20110826220032167405000000", "2")
+        l.photos.size.should eq(5)
+      end
+
+      on_put_it "should raise an exception when an index is not an Integer" do
+        list_id = "20060725224713296297000000"
+        stub_api_get("/listings/#{list_id}", 'listings/with_photos.json')
+        stub_api_put("/listings/#{list_id}/photos/2011082622003216740500000", 'listings/put_reorder_photo.json', 'listings/reorder_photo.json')
+        l = Listing.find(list_id)
+        expect{ l.reorder_photo("2011082622003216740500000", "asdf") }.to raise_error(ArgumentError)
+      end
+
       context "with pagination" do
         # This is really a bogus call, but we should make sure our
         # pagination collection impl still behaves sanely