Add support for metadata parameter in resources Admin APIs

Author: RTLcoil

lib/cloudinary/api.rb

@@ -34,25 +34,25 @@ def self.resources(options={})
     type          = options[:type]
     uri           = "resources/#{resource_type}"
     uri           += "/#{type}" unless type.blank?
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :prefix, :tags, :context, :moderations, :direction, :start_at), options)
+    call_api(:get, uri, only(options, :next_cursor, :max_results, :prefix, :tags, :context, :moderations, :direction, :start_at, :metadata), options)
   end
 
   def self.resources_by_tag(tag, options={})
     resource_type = options[:resource_type] || "image"
     uri           = "resources/#{resource_type}/tags/#{tag}"
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction), options)
+    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction, :metadata), options)
   end
 
   def self.resources_by_moderation(kind, status, options={})
     resource_type = options[:resource_type] || "image"
     uri           = "resources/#{resource_type}/moderations/#{kind}/#{status}"
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction), options)
+    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction, :metadata), options)
   end
 
   def self.resources_by_context(key, value=nil, options={})
     resource_type = options[:resource_type] || "image"
     uri           = "resources/#{resource_type}/context"
-    params = only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction,:key,:value)
+    params = only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction, :key, :value, :metadata)
     params[:key] = key
     params[:value] = value
     call_api(:get, uri, params, options)

spec/api_spec.rb

@@ -11,22 +11,38 @@
   TEST_TRANSFOMATION = "c_scale,w_#{TEST_WIDTH}"
   PUBLIC_ID_BACKUP_1 = "#{prefix}backup_1#{Time.now.to_i}"
   PUBLIC_ID_BACKUP_2 = "#{prefix}backup_2#{Time.now.to_i}"
+  METADATA_EXTERNAL_ID = "#{prefix}_metadata_external_id_#{UNIQUE_TEST_ID}"
+  METADATA_DEFAULT_VALUE = "#{prefix}_metadata_default_value_#{UNIQUE_TEST_ID}"
+  UNIQUE_CONTEXT_KEY = "#{prefix}_context_key_#{UNIQUE_TEST_ID}"
+  UNIQUE_CONTEXT_VALUE = "#{prefix}_context_value_#{UNIQUE_TEST_ID}"
+  UNIQUE_CONTEXT = "#{UNIQUE_CONTEXT_KEY}=#{UNIQUE_CONTEXT_VALUE}"
+  UNIQUE_TEST_TAG_TO_ONE_IMAGE_ASSET = "#{prefix}_unique_tag_to_one_image_asset_#{UNIQUE_TEST_ID}"
 
   test_id_1 = "#{prefix}_1"
   test_id_2   = "#{prefix}_2"
   test_id_3   = "#{prefix}_3"
   test_key = "test_key_#{SUFFIX}"
-  before(:all) do
 
+  before(:all) do
     @api = Cloudinary::Api
+
+    @api.add_metadata_field(
+      :external_id => METADATA_EXTERNAL_ID,
+      :label => METADATA_EXTERNAL_ID,
+      :type => "string",
+      :default_value => METADATA_DEFAULT_VALUE
+    )
+
     Cloudinary::Uploader.upload(TEST_IMG, :public_id => test_id_1, :tags => [TEST_TAG, TIMESTAMP_TAG], :context => "key=value", :eager =>[:width =>TEST_WIDTH, :crop =>:scale])
     Cloudinary::Uploader.upload(TEST_IMG, :public_id => test_id_2, :tags => [TEST_TAG, TIMESTAMP_TAG], :context => "key=value", :eager =>[:width =>TEST_WIDTH, :crop =>:scale])
     Cloudinary::Uploader.upload(TEST_IMG, :public_id => test_id_3, :tags => [TEST_TAG, TIMESTAMP_TAG], :context => "key=value", :eager =>[:width =>TEST_WIDTH, :crop =>:scale])
     Cloudinary::Uploader.upload(TEST_IMG, :public_id => test_id_1, :tags => [TEST_TAG, TIMESTAMP_TAG], :context => "#{test_key}=test", :eager =>[:width =>TEST_WIDTH, :crop =>:scale])
     Cloudinary::Uploader.upload(TEST_IMG, :public_id => test_id_3, :tags => [TEST_TAG, TIMESTAMP_TAG], :context => "#{test_key}=tasty", :eager =>[:width =>TEST_WIDTH, :crop =>:scale])
+    Cloudinary::Uploader.upload(TEST_IMG, :tags => [UNIQUE_TEST_TAG_TO_ONE_IMAGE_ASSET, TEST_TAG, TIMESTAMP_TAG], :context => UNIQUE_CONTEXT, :moderation => :manual)
   end
 
   after(:all) do
+    @api.delete_metadata_field(METADATA_EXTERNAL_ID)
     # in addition to "cleanup" context
     unless Cloudinary.config.keep_test_products
       up = Cloudinary::Api.upload_presets max_results: 500
@@ -114,6 +130,58 @@
     @api.resources(:type=>"upload", :start_at=>start_at, :direction => "asc")
   end
 
+  describe "structured metadata" do
+    matcher :have_metadata do
+      match do |expected|
+        expect(expected["resources"]).to be_present
+
+        expected["resources"].each do |resource|
+          expect(resource).to have_key("metadata")
+        end
+      end
+
+      match_when_negated do |expected|
+        expect(expected["resources"]).to be_present
+
+        expected["resources"].each do |resource|
+          expect(resource).to_not have_key("metadata")
+        end
+      end
+    end
+
+    it "should return structured metadata in the response of the resources API response" do
+      result = @api.resources(:prefix => test_id_1, :type => "upload", :metadata => true)
+      expect(result).to have_metadata
+
+      result = @api.resources(:prefix => test_id_1, :type => "upload", :metadata => false)
+      expect(result).to_not have_metadata
+    end
+
+    it "should return structured metadata in the response of the resources by tag API" do
+      result = @api.resources_by_tag(UNIQUE_TEST_TAG_TO_ONE_IMAGE_ASSET, :metadata => true)
+      expect(result).to have_metadata
+
+      result = @api.resources_by_tag(UNIQUE_TEST_TAG_TO_ONE_IMAGE_ASSET, :metadata => false)
+      expect(result).to_not have_metadata
+    end
+
+    it "should return structured metadata in the response of the resources by context API" do
+      result = @api.resources_by_context(UNIQUE_CONTEXT_KEY, UNIQUE_CONTEXT_VALUE, :metadata => true)
+      expect(result).to have_metadata
+
+      result = @api.resources_by_context(UNIQUE_CONTEXT_KEY, UNIQUE_CONTEXT_VALUE, :metadata => false)
+      expect(result).to_not have_metadata
+    end
+
+    it "should return structured metadata in the response of the resources by moderation API" do
+      result = @api.resources_by_moderation(:manual, :pending, :metadata => true)
+      expect(result).to have_metadata
+
+      result = @api.resources_by_moderation(:manual, :pending, :metadata => false)
+      expect(result).to_not have_metadata
+    end
+  end
+
   describe ":direction" do
 
     it "should accept a string 'desc' and 'asc'" do