mints 0.0.20 → 0.0.21

data/lib/user/content/assets.rb

@@ -1,11 +1,10 @@
 module Assets
+
+
     ##
     # == Assets
     #
 
-    def upload_asset(data)
-        return @client.raw("post", "/content/assets/upload", nil, data)
-    end
 
     # === Get asset link info.
     # Get information of an asset by url.
@@ -26,7 +25,7 @@ module Assets
     # Get information of an asset.
     #
     # ==== Parameters
-    # * +id+ - [Integer] Asset id.
+    # id:: (Integer) -- Asset id.
     #
     # ==== Example
     #     @data = @mints_user.download_asset(2)
@@ -34,65 +33,228 @@ module Assets
         return @client.raw("get", "/content/assets/download/#{id}")
     end
 
-    def edit_asset_size(data) #TODO: Not tested
-        return @client.raw("post", "/content/assets/editSize", nil, data)
+    # FIXME: Returns json invalid token
+    # def get_asset_thumbnails(id)
+    #    return @client.raw("get", "/content/assets/thumbnails/#{id}")
+    #end
+    
+    # === Get asset usage.
+    # Get usage of an asset.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    def get_asset_usage(options) #get, le mandas el asset id para saber donde lo has puesto 
+        return @client.raw("get", "/content/assets/usage", options)
     end
 
-    def upload_asset_variation(data) #FIXME: Call to a member function guessClientExtension() on null
-        return @client.raw("post", "/content/assets/uploadVariation", nil, data)
+    # === Get asset info.
+    # Get info of an asset. 
+    #TODO: Research if is an asset or many assets
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    def get_asset_info(options)
+        return @client.raw("get", "/content/assets/getAssetInfo", options)
     end
 
-    def create_asset_size(data) #FIXME: Trying to get property 'path' of non-object
-        return @client.raw("post", "/content/assets/createSize", nil, data)
+    # === Get asset doc types.
+    # Get doc types of assets.
+    def get_asset_doc_types
+        return @client.raw("get", "/content/assets/docTypes")
     end
 
-    def update_asset_variation(id, data) #TODO:
-        return @client.raw("post", "/content/assets/updateVariation/#{id}", nil, data)
+    # === Get asset public route.
+    # Get public route of assets.
+    def get_asset_public_route
+        return @client.raw("get", "/content/assets/publicRoute")
     end
-
-    def get_asset_sizes(id) #FIXME: wrong number of arguments (given 1, expected 0)
-        return @client.raw("get", "/content/assets/sizes/#{id}")
+    
+    # === Upload asset.
+    # Upload an asset. It can be images, documents and videos.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== First Example (with files)
+    #
+    #
+    # ==== Second Example (with urls)
+    #     data = {
+    #       "title": "asset title",
+    #       "description": "asset description",
+    #       "link": "https://link/example",
+    #       "url-type": "url-image",
+    #       "slug": "slug",
+    #       "type": "link",
+    #       "father_id": 1
+    #     }
+    #     @data = @mints_user.upload_asset(data.to_json)
+    #
+    # ==== Third Example (with video)
+    #     data = {
+    #       "title": "Video Title",
+    #       "fileType": "video/mp4",
+    #       "type": "video",
+    #       "slug": "video-slug",
+    #       "status": "not-uploaded",
+    #       "ext": "mp4",
+    #       "size": 29605264,
+    #       "access_token": "access_token",
+    #       "name": "Video Title",
+    #       "videoData": {
+    #         "id": 80313307,
+    #         "name": "Video Title",
+    #         "type": "video",
+    #         "created": "2021-10-19T19:18:17+00:00",
+    #         "updated": "2021-10-19T19:18:17+00:00",
+    #         "duration": 191.936133,
+    #         "hashed_id": "hashed_id",
+    #         "progress": 0.14285714285714285,
+    #         "status": "queued",
+    #         "thumbnail": {
+    #           "url": "https://www.example.com/img/img.jpg",
+    #           "width": 200,
+    #           "height": 120
+    #         },
+    #         "account_id": 1234567
+    #       }
+    #     }
+    #     @data = @mints_user.upload_asset(data.to_json)
+    def upload_asset(data) #TODO: Research a way to upload a File accross sdk
+        return @client.raw("post", "/content/assets/upload", nil, data)
     end
 
-    def get_original_asset(id) #FIXME: Doesn't return JSON
-        return @client.raw("get", "/content/assets/original/#{id}")
-    end
 
-    def get_asset_variation(id)
-        #FIXME: Id 1 and 4: Trying to get property 'path' of non-object
-        #FIXME: Id 2 and 3: File not found at path maybe doesnt exist
-        return @client.raw("get", "/content/assets/variation/#{id}")
-    end
+    ##
+    # == Sizes
+    #
 
+
+    #FIXME: Double get asset sizes method!
+    # === Get asset sizes.
+    # Get a collection of sizes of an asset.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.    
     def get_asset_sizes(options)
         return @client.raw("get", "/content/assets/getSizes", options)
     end
 
-    def get_asset_usage(options)
-        return @client.raw("get", "/content/assets/usage", options)
+    # === Get asset sizes.
+    # Get sizes of an asset.
+    #
+    # ==== Parameters
+    # id:: (Integer) Asset id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_asset_sizes(2)
+    def get_asset_sizes(id) #FIXME: wrong number of arguments (given 1, expected 0)
+        return @client.raw("get", "/content/assets/sizes/#{id}")
     end
 
-    def delete_asset_variation #TODO: Not tested
-        return @client.raw("get", "/content/assets/deleteVariation")
+    # === Create asset size.
+    # Create an asset size by data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "aspectRadio": "custom",
+    #       "assetId": 23,
+    #       "drawPosData": {
+    #         "pos": {
+    #           "sx": 100,
+    #           "sy": 100,
+    #           "swidth": 200,
+    #           "sheight": 200
+    #         }
+    #       },
+    #       "width": 100,
+    #       "height": 100,
+    #       "slug": "fuji_size_slug",
+    #       "title": "fuji_size",
+    #       "variationId": "original"
+    #    }
+    #    @data = @mints_user.create_asset_size(data.to_json)
+    def create_asset_size(data)
+        return @client.raw("post", "/content/assets/createSize", nil, data)
+    end
+
+    # === Edit asset size.
+    # Edit an asset size.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    def edit_asset_size(data) #TODO: Not tested
+        return @client.raw("post", "/content/assets/editSize", nil, data)
     end
 
+    # === Delete asset size.
     def delete_asset_size #TODO: Not tested
-        return @client.raw("get", "/content/assets/deleteSize")
+        return @client.raw("get", "/content/assets/deleteSize") #DELETE OR GET?
     end
 
-    def get_asset_info(options)
-        return @client.raw("get", "/content/assets/getAssetInfo", options)
+
+    ##
+    # == Variations
+    #
+
+
+    # === Get asset variation.
+    # Get variation of an asset.
+    #
+    # ==== Parameters
+    # id:: (Integer) Asset variation id. #TODO: Research if is an asset id or an variation id
+    #
+    # ==== Example
+    #     @data = @mints_user.get_asset_sizes(2)
+    def get_asset_variation(id)
+        #FIXME: Id 1 and 4: Trying to get property 'path' of non-object maybe json convertion is bad
+        #FIXME: Id 2 and 3: File not found at path maybe doesnt exist
+        return @client.raw("get", "/content/assets/variation/#{id}")
     end
 
+    # === Generate asset variation.
+    # Create an asset variation of an existing asset.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
     def generate_asset_variation(data) #FIXME: Trying to get property 'width' of non-object
         return @client.raw("post", "/content/assets/generateAssetVariations", nil, data)
     end
 
-    def get_asset_doc_types
-        return @client.raw("get", "/content/assets/docTypes")
+    # === Upload asset variation.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    def upload_asset_variation(data) #FIXME: Call to a member function guessClientExtension() on null
+        return @client.raw("post", "/content/assets/uploadVariation", nil, data)
     end
 
-    def get_asset_public_route
-        return @client.raw("get", "/content/assets/publicRoute")
+    # === Update asset variation.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    def update_asset_variation(id, data) #TODO:
+        return @client.raw("post", "/content/assets/updateVariation/#{id}", nil, data)
+    end
+
+    # === Delete asset variation.
+    def delete_asset_variation #TODO: Not tested
+        return @client.raw("get", "/content/assets/deleteVariation") #DELETE OR GET?
     end
+
+    
+
+    
+
+    # === Get original asset.
+    #
+    # ==== Parameters
+    # id:: (Integer) Asset id.
+    def get_original_asset(id) #FIXME: Doesn't return JSON
+        return @client.raw("get", "/content/assets/original/#{id}")
+    end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - Ruben Gomez Garcia, Omar Mora, Luis Payan, Oscar Castillo
@@ -124,8 +124,10 @@ files:
 - lib/generators/mints_config.yml.erb
 - lib/generators/mints_contact_controller.rb
 - lib/generators/mints_files_generator.rb
+- lib/generators/mints_link.rb
 - lib/generators/mints_public_controller.rb
 - lib/generators/mints_user_controller.rb
+- lib/generators/short_link_controller.rb
 - lib/mints.rb
 - lib/mints/controllers/admin_base_controller.rb
 - lib/mints/controllers/base_api_controller.rb