imagekitio 1.0.10 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a2428b4fd13858eb5789ebb281e06c9c26ee27b9d005f13eccde8766cae28a
-  data.tar.gz: ba2dff578f285e9fc847e4cdcb941a4a0764387280122ff7e391b7b66de38b97
+  metadata.gz: f16b0137caabb312f3f4dea41a5558075f6ee24032b733fd4ce986807f695fbf
+  data.tar.gz: 50bc622d4cd9042275cbb1c21920fb371f28ba046fcbd76b74099b288a74227a
 SHA512:
-  metadata.gz: b2b9203c579831c6c127a480100f16ee88b90aab79d5a6e2f0a50dbf2d5908fcbcabdbbeb8adff2d8f99aedf5ca0cdcbbee76c4989a81cb64d1b717827c5cfd9
-  data.tar.gz: 79641251a3cb02c69d999b8c3cc3237e59748abca67f3ba00807d8e2ef938fe52bc743e00bdec3191515b350d33f7e35bdc94bba593453f52a2448d3cf8fd64e
+  metadata.gz: e73e581e5709d7ac0de28d6ca9276fea1931b47a1e88595a67fcdb51ee654deed3e6b3aac208198432385c5e2f64c3ea765f366033dd678017fc9fda73d80933
+  data.tar.gz: 0aad82e39f813c480edfeffaf10401bf90aa935b09cc313ddd48a05dc4f51b666074d1e28033398255a807ed40a0f2ac4d42d4b9bfa3571cdc2e706b70f0a846

data/README.md

@@ -13,11 +13,14 @@ ImageKit gem for Ruby on Rails that allows you to use real-time [image resizing]
 Table of contents -
  * [Installation](#Installation)
  * [Initialization](#Initialization)
+    - [CarrierWave](#Carrierwave-config)
+    - [ActiveStorage](#ActiveStorage-config)
  * [URL Generation](#URL-generation)
  * [File Upload](#File-Upload)
  * [File Management](#File-Management)
  * [Utility Functions](#Utility-functions)
  * [Sample applications](#Sample-Application)
+ * [Upgrade to 2.0.0](#Upgrade)
  * [Support](#Support)
  * [Links](#Links)
 
@@ -45,17 +48,21 @@ $ gem install imagekitio
 
 ## Initialization
 
-Add this configuration to `config/environments/development.rb` and `config/environments/production.rb`
-
+Create a new file `config/initializers/imagekitio.rb` then add the configuration.
 ```ruby
-config.imagekit={
-  private_key: "<your-private-key>",
-  public_key: "<your-public-key>",
-  url_endpoint: "<endpoint-url>"
-}
+ImageKitIo.configure do |config|
+  if Rails.env.development?
+    config.public_key = 'your_public_api_key'
+    config.private_key = 'your_private_api_key'
+    config.url_endpoint = 'https://ik.imagekit.io/your_imagekit_id/'
+  end
+  config.service = :carrierwave
+  #config.service = :active_storage
+  #config.constants.MISSING_PRIVATE_KEY = 'custom error message'
+end
 ```
-
-You can create a carrierwave uploader in order to attach pictures to your database objects as their attributes. To upload images without designating them as database attributes, skip to [this section](https://github.com/imagekit-developer/imagekit-ruby#file-upload).
+#### CarrierWave
+You can create a CarrierWave uploader to attach pictures to your database objects as their attributes. Skip to [this section](https://github.com/imagekit-developer/imagekit-ruby#file-upload) to upload images without designating them as database attributes. Make sure to add service `:carrierwave` as shown in [initialization section](#initialization).
 
 ```bash
 rails g uploader <Uploading_attribute_name>
@@ -66,8 +73,8 @@ rails g uploader Avatar
 
 After that, you need to edit your generated uploader and make the following changes:
 ```ruby
-# Set store as imagekit_store
-storage :imagekit_store
+# include this module inside the top of the uploader class
+include ImageKitIo::CarrierWave
 
 # If you want to add uploading options, then create this method inside the uploader file as an example
 
@@ -103,14 +110,52 @@ Get image url:
 # To get the original image url, use
 @employee.avatar.url
 
+# To get the file metadata
+@employee.avatar.metadata
+
+
 # And to get transformed url use
 # options is a transformation options
 @employee.avatar.url_with(options)
 ```
 
+#### ActiveStorage
+
+Once you [install](https://guides.rubyonrails.org/active_storage_overview.html#setup) the active_storage gem, then any model can have the attachment using `has_one_attached` or `has_many_attached` like below:
+
+```ruby
+class Employee < ApplicationRecord
+  has_one_attached :avatar
+end
+```
+
+Get image url:
+```ruby
+# If @employee is an object of your model that has data.
+
+# To get the original image url, use
+@employee.avatar.url
+```
+
+Now, let's configure active_storage as a service for the imagekitio. 
+
+First add `:active_storage` in initializer file.
+
+```ruby
+config.service = :active_storage
+``` 
+
+Then add the imagekitio service in the `storage.yml` file:
+
+```ruby
+imagekitio:
+    service: ImageKitIo
+```
+
+
 ## Usage
 
-You can use this Ruby SDK for three different kinds of methods - URL generation, file upload, and file management.
+You can use this Ruby SDK for three different methods - URL generation, file upload, and file management.
 
 The usage of the SDK has been explained below.
 
@@ -126,21 +171,21 @@ about paths with different kinds of origins.
 
 
 ```ruby
+imagekitio = ImageKitIo.client
 image_url = imagekitio.url({
     path: "/default-image.jpg",
     url_endpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
-    transformation: [{height: "300", width: "400"}]
+    transformation: [{height: "300", width: "400", raw: "ar-4-3,q-40"}]
 })
 ```
 
 The result in a URL like
 ```
-https://ik.imagekit.io/your_imagekit_id/endpoint/tr:h-300,w-400/default-image.jpg
+https://ik.imagekit.io/your_imagekit_id/endpoint/tr:h-300,w-400,ar-4-3,q-40/default-image.jpg
 ```
 
 **2.Using full image URL**
-This method allows you to add transformation parameters to an existing, complete URL that is already mapped to ImageKit
-using `src` parameter. This method should be used if you have the complete image URL mapped to ImageKit stored in your
+This method allows you to add transformation parameters to an existing, complete URL already mapped to ImageKit using the `src` parameter. This method should be used if you have the complete image URL mapped to ImageKit stored in your
 database.
 
 
@@ -167,7 +212,7 @@ The `.url()` method accepts the following parameters
 | src                     | Conditional. This is the complete URL of an image already mapped to ImageKit. For example, `https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation.                                                                                                                                                                                                                                                                                                                                            |
 | transformation          | Optional. An array of objects specifying the transformation to be applied in the URL. The transformation name and the value should be specified as a key-value pair in the object. Different steps of a [chained transformation](https://docs.imagekit.io/features/image-transformations/chained-transformations) can be specified as different objects of the array. The complete list of supported transformations in the SDK and some examples of using them are given later. If you use a transformation name that is not specified in the SDK, it gets applied as it is in the URL. |
 | transformation_position | Optional. The default value is `path` that places the transformation string as a path parameter in the URL. It can also be specified as `query`, which adds the transformation string as the query parameter `tr` in the URL. If you use `src` parameter to create the URL, then the transformation string is always added as a query parameter.                                                                                                                                                                                                                                                  |
-| query_parameters        | Optional. These are the other query parameters that you want to add to the final URL. These can be any query parameters and not necessarily related to ImageKit. Especially useful if you want to add some versioning parameter to your URLs.                                                                                                                                                                                                                                                                                                                                            |
+| query_parameters        | Optional. These are the other query parameters that you want to add to the final URL. These can be any query parameters and not necessarily related to ImageKit. Especially useful if you want to add some versioning parameters to your URLs.                                                                                                                                                                                                                                                                                                                                            |
 | signed                  | Optional. Boolean. Default is `false`. If set to `true`, the SDK generates a signed image URL adding the image signature to the image URL. This can only be used if you are creating the URL with the `url_endpoint` and `path` parameters and not with the `src` parameter.                                                                                                                                                                                                                                                                                                             |
 | expire_seconds          | Optional. Integer. Meant to be used along with the `signed` parameter to specify the time in seconds from now when the URL should expire. If specified, the URL contains the expiry timestamp in the URL, and the image signature is modified accordingly.                                                                                                                                                                                                                                                                                                                                 |
 
@@ -243,8 +288,10 @@ https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400/default-image.jpg?v=123&i
 
 The complete list of transformations supported and their usage in ImageKit can be found [here](https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations).
 The SDK gives a name to each transformation parameter, making the code simpler, making the code simpler, and readable.
-If a transformation is supported in ImageKit, but a name for it cannot be found in the table below, then use the
-transformation code from ImageKit docs as the name when using the `url` function.
+
+If a transformation is supported in ImageKit, but a name for it cannot be found in the table below, then use the transformation code from ImageKit docs as the name when using the `url` function.
+
+If you want to generate transformations in your application and add them to the URL as it is, use the `raw` parameter.
 
 | Supported Transformation Name | Translates to parameter |
 |-------------------------------|-------------------------|
@@ -304,6 +351,7 @@ transformation code from ImageKit docs as the name when using the `url` function
 | effectContrast | e-contrast |
 | effectGray | e-grayscale |
 | original | orig |
+| raw | `replaced by the parameter value` |
 
 ## File Upload
 This method can be used to directly upload images to your ImageKit Media Library without giving it the designation of an attribute of any database object.
@@ -319,9 +367,11 @@ Simple usage
 
 ```ruby
 imagekitio.upload_file(
-    file = "<url|base_64|binary>", # required
-    file_name= "my_file_name.jpg",  # required
-    options= {response_fields: 'isPrivateFile, tags', tags: %w[abc def], use_unique_file_name: true,}
+    file: "<url|base_64|binary>", # required
+    file_name: "my_file_name.jpg",  # required
+    response_fields: 'isPrivateFile, tags',
+    tags: %w[abc def],
+    use_unique_file_name: true
 )
 
 ```
@@ -342,26 +392,35 @@ in the [documentation here](https://docs.imagekit.io/api-reference/media-api/lis
 correct values to get the results.
 
 ```ruby
-imagekitio.list_files({skip: 0, limit: 5})
+imagekitio.list_files(
+    skip: 0,
+    limit: 5
+)
 ```
 **2. Get File Details**
 Accepts the file ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/get-file-details)
 
 ```ruby
-imagekitio.get_file_details(file_id)
+imagekitio.get_file_details(
+    file_id: '598821f949c0a938d57563bd'
+)
 ```
 
 **3. Get File Metadata**
 Accepts the file ID and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files)
 ```ruby
-imagekit.get_file_metadata(file_id)
+imagekit.get_file_metadata(
+    file_id: '598821f949c0a938d57563bd'
+)
 ```
 
 **3. Get File Metadata from remote url**
 Accepts the remote file url and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-from-remote-url)
 
 ```ruby
-imagekit.get_remote_file_url_metadata(remote_file_url)
+imagekit.get_remote_file_url_metadata(
+    remote_file_url: "https://ik.imagekit.io/demo/tr:w-100/default-image.jpg"
+)
 ```
 
 **4. Update File Details**
@@ -370,50 +429,230 @@ The first argument to the `update_field_details` method is the file ID, and a se
 parameters to be updated.
 
 ```ruby
-imagekitio.update_file_details(file_id, {
+imagekitio.update_file_details(
+    file_id: '598821f949c0a938d57563bd',
     tags: ["image_tag"],
     custom_coordinates: "10,10,100, 100"
-})
+)
 ```
 
-**6. Delete file**
+**5. Copy File**
+
+Copy file from one path to another path using the source file path and the destination path as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/copy-file)
+
+```ruby
+imagekitio.copy_file(
+    source_file_path: '/path/to/file.jpg',
+    destination_path: '/folder/to/copy/into'
+)
+```
+
+**6. Move File**
+
+Move file from one folder to another folder using the source file path and destination path as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/move-file)
+
+```ruby
+imagekitio.move_file(
+    source_file_path: '/path/to/file.jpg',
+    destination_path: '/folder/to/move/into/'
+)
+```
+
+**7. Rename File**
+
+Rename file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/rename-file)
+
+```ruby
+imagekitio.rename_file(
+    file_path: '/path/to/old-file-name.jpg',
+    new_file_name: 'new-file-name.jpg',
+    purge_cache: true #optional
+)
+```
+
+**8. Delete file**
 Delete a file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/delete-file). The method accepts the file ID of the file that has to be deleted.
 
 ```ruby
-imagekitio.delete_file(file_id)
+imagekitio.delete_file(
+    file_id: '598821f949c0a938d57563bd'
+)
 ```
 
-**6. Bulk File Delete by IDs**
+**9. Bulk File Delete by IDs**
 Delete a file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/delete-files-bulk). The method accepts a list of file IDs of files that has to be
 deleted.
 
 ```ruby
-imagekitio.bulk_file_delete(["file_id1", "file_id2"])
+imagekitio.delete_bulk_files(
+    file_ids: ["598821f949c0a938d57563bd", "598821f949c0a938d57543bd"]
+)
 ```
 
-**6. Purge Cache**
-Programmatically issue a cache clear request as pet the [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache).
+**10. Purge Cache**
+Programmatically issue a clear cache request as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache).
 Accepts the full URL of the file for which the cache has to be cleared.
 
 ```ruby
-imagekitio.purge_file_cache(full_url)
+imagekitio.purge_file_cache(
+    file_url: 'https://ik.imagekit.io/demo/logo-white_SJwqB4Nfe.png'
+)
 ```
-**7. Purge Cache Status**
+**11. Purge Cache Status**
 
-Get the purge cache request status using the request ID returned when a purge cache request gets submitted as pet the
+Get the purge cache request status using the request ID returned when a purge cache request gets submitted as per the
 [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache-status)
 
 ```ruby
-imagekitio.get_purge_file_cache_status(cache_request_id)
+imagekitio.purge_file_cache_status(
+    request_id: '598821f949c0a938d57543bd'
+)
+```
+
+**12. Add Bulk Tags**
+
+Add multiple tags on multiple files using an array of file ids and an array of tags as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/add-tags-bulk)
+
+```ruby
+imagekitio.add_bulk_tags(
+    file_ids: ['598821f949c0a938d57543bd', '598921f949c0a938d57543bd'],
+    tags: ['custom_tags', 'image', 'favourite']
+)
+``` 
+
+**13. Delete Bulk Tags**
+
+Remove multiple tags from multiple files using an array of file ids and an array of tags as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/remove-tags-bulk)
+
+```ruby
+imagekitio.delete_bulk_tags(
+    file_ids: ['598821f949c0a938d57543bd', '598921f949c0a938d57543bd'],
+    tags: ['custom_tags', 'image']
+)
+```
+
+**14. Delete Bulk Ai Tags**
+
+Delete bulk ai tags as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/remove-aitags-bulk)
+
+```ruby
+imagekitio.delete_bulk_ai_tags(
+    file_ids: ['598821f949c0a938d57543bd', '598921f949c0a938d57543bd'],
+    ai_tags: ['custom_ai_tags']
+)
+```
+
+**15. Create Folder**
+
+Create folder as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/create-folder)
+
+```ruby
+imagekitio.create_folder(
+    folder_name: 'new_folder',
+    parent_folder_path: 'source/folder/path' #optional
+)
+```
+
+
+**16. Copy Folder**
+
+Copy folder as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/copy-folder)
+
+```ruby
+imagekitio.copy_folder(
+    source_folder_path: '/folder/to/copy',
+    destination_path: '/folder/to/copy/into'
+)
+```
+
+**17. Move Folder**
+
+Move folder as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/move-folder)
+
+```ruby
+imagekitio.move_folder(
+    source_folder_path: '/folder/to/move',
+    destination_path: '/folder/to/move/into/'
+)
+```
+
+**18. Delete Folder**
+
+Delete folder as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/delete-folder)
+
+```ruby
+imagekitio.delete_folder(
+    folder_path: 'folder/to/delete'
+)
 ```
 
+**19. Bulk Job Status**
+
+Get the bulk job status as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/copy-move-folder-status)
+
+```ruby
+imagekitio.bulk_job_status(
+    job_id: '5e21880d5efe355febd4cccd'
+)
+```
+
+**20. Create Custom Metadata Fields**
+
+Create custom metadata fields as per the [API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field)
+
+```ruby
+
+imagekitio.create_custom_metadata_field(
+    name: 'price',
+    label: 'price_label',
+    schema: {
+      'type': 'Number',
+      'minValue': 100,
+      'maxValue': 300
+    }
+)
+```
+
+**21. Get Custom Metadata Fields**
+
+Get the custom metadata fields as per the [API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/get-custom-metadata-field)
+
+```ruby
+imagekitio.get_custom_metadata_fields(
+   include_deleted: true #optional
+)
+```
+
+**22. Update Custom Metadata Fields**
+
+Update custom metadata fields as per the [API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/update-custom-metadata-field)
+
+```ruby
+imagekitio.update_custom_metadata_field(
+    id: '5e21880d5efe355febd4bccd', #field_id
+    label: 'custom-price', #Either label or schema or both should be given
+    schema: nil
+)
+```
+
+**23. Delete Custom Metadata Fields**
+
+Delete custom metadata fields as per the [API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/delete-custom-metadata-field)
+
+```ruby
+imagekitio.delete_custom_metadata_field(
+    id: '5e21880d5efe355febd4bccd' #field_id
+)
+```
+
+
 ## Utility functions
 
 We have included the following commonly used utility functions in this package.
 
 **Authentication parameter generation**
 
-In case you are looking to implement client-side file upload, you are going to need a `token`, `expiry` timestamp, and a valid `signature` for that upload. The SDK provides a simple method that you can use in your code to generate these authentication parameters for you.
+If you are looking to implement client-side file upload, you will need a `token`, `expiry` timestamp, and a valid `signature` for that upload. The SDK provides a simple method that you can use in your code to generate these authentication parameters for you.
 
 _Note: The Private API Key should never be exposed in any client-side code. You must always generate these authentication parameters on the server-side_
 
@@ -439,7 +678,7 @@ value of an image in the response. You can use this value to find a duplicate ne
 the distance between the two images.
 
 
-This SDK exposes the `phash_distance` function to calculate the distance between two pHash value. It accepts two pHash hexadecimal
+This SDK exposes the `phash_distance` function to calculate the distance between two pHash values. It accepts two pHash hexadecimal
 strings and returns a numeric value indicative of the level of difference between the two images.
 
 ```ruby
@@ -468,52 +707,23 @@ imagekitio.phash_distance('a4a65595ac94518b', '7838873e791f8400')
 ```
 
 ## Sample Application
-There are two sample apps:
-* [Rails application using Carrierwave](#Instructions-for-rails-application)
-* [Plain ruby application](#Instructions-for-ruby-application)
+There are three sample apps:
 
-### Instructions for a rails application
-This is under [samples/rails_app](https://github.com/imagekit-developer/imagekit-ruby/blob/master/samples/rails_app) directory. Follow the instructions below to set up a rails application.
+* Rails application using Carrierwave
+* Rails application using ActiveStorage
+* Plain ruby application
 
-**1. Clone git repository**
-```bash
-git clone `https://github.com/imagekit-developer/imagekit-gem
-```
-**2. Go to sample project directory**
-```bash
-cd sample/rails_app
-```
-**3. Write imagekit configuration in `config/environments/development.rb`**
-```ruby
-config.imagekit={
-  private_key: "<your-private-key>",
-  public_key: "<your-public-key>",
-  url_endpoint: "<endpoint-url>"
-}
-```
-**4. Install dependency**
-```ruby
-bundle install
-```
-This sample project is using the Sqlite3 database. If you are getting `sqlite3` gem installation error, then install sqlite3 first, then again run `bundle install`.
+Please see the sample applications in [here](https://github.com/imagekit-samples/quickstart).
 
-**5. Migrate the database**
-```ruby
-bundle exec rake db:migrate
-```
+## Upgrade to 2.0.0
 
-**6. Run your application**
-```ruby
-rails s
-```
-It will run on your default rails port [3000].
-Sample Application URL: http://localhost:3000/posts/
+If you are upgrading to 2.0.0 from version 1.x, make the following changes  in your application:
 
-### Instructions for ruby application
-Run following command under [samples/ruby_app](https://github.com/imagekit-developer/imagekit-ruby/blob/master/samples/ruby_app) directory
-```ruby
-ruby app.rb
-```
+- Remove config from environment file to initializer file as described [here](#Initialization).
+- Include `ImageKitIo::CarrierWave` in uploader class(for Carrierwave).
+- Remove `storage :imagekit_store` config from uploader.
+- Rename class `ImageKit::ImageKitClient` to `ImageKitIo::Client`
+- Rename class `ImageKitIo::ImageKitRequest` to `ImageKitIo::Request`
 
 ## Support
 For any feedback or to report any issues or general implementation support, please reach out to [support@imagekit.io](mailto:support@imagekit.io)
@@ -523,4 +733,4 @@ For any feedback or to report any issues or general implementation support, plea
 -   [Main website](https://imagekit.io)
 
 ## License
-Released under the MIT license.
+Released under the MIT license.

data/Rakefile

@@ -8,7 +8,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Imagekit::Sdk'
+  rdoc.title    = 'ImageKitIo::Sdk'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/lib/active_storage/active_storage.rb

@@ -0,0 +1,2 @@
+require_relative './service/ik_file'
+require_relative './service/image_kit_io_service'

data/lib/active_storage/service/ik_file.rb

@@ -0,0 +1,111 @@
+module ImageKiIo
+  module ActiveStorage
+    class IKFile
+      attr_accessor :identifier
+
+      def initialize(identifier)
+        @identifier = identifier
+        @imagekit = ImageKitIo.client
+      end
+
+      def url
+        identifier['url']
+      end
+
+      def delete
+        begin
+          @imagekit.delete_file(file_id: file_id)
+        rescue
+          file_id
+        end
+      end
+
+      def file_type
+        identifier['fileType']
+      end
+
+      def thumbnail_url
+        identifier['thumbnail']
+      end
+
+      def filename
+        identifier['name']
+      end
+
+      def size
+        identifier['size']
+      end
+
+      def path
+        identifier['filePath']
+      end
+
+      def height
+        identifier['height']
+      end
+
+      def width
+        identifier['width']
+      end
+
+      def file_id
+        identifier['fileId']
+      end
+
+      def exist?
+        details = @imagekit.get_file_details(file_id: file_id)
+        return false if details[:error].present?
+
+        true
+      end
+
+      def type
+        identifier['type']
+      end
+
+      def tags
+        identifier['tags']
+      end
+
+      def ai_tags
+        identifier['AITags']
+      end
+
+      def is_private?
+        identifier['isPrivateFile']
+      end
+
+      def custom_coordinates
+        identifier['customCoordinates']
+      end
+
+      def mime
+        identifier['mime']
+      end
+
+      def alpha?
+        identifier['hasAlpha']
+      end
+
+      def custom_metadata
+        identifier['customMetadata']
+      end
+
+      def embedded_metadata
+        identifier['embeddedMetadata']
+      end
+
+      def created_at
+        identifier['createdAt']
+      end
+
+      def updated_at
+        identifier['updatedAt']
+      end
+
+      def extension_status
+        identifier['extensionStatus']
+      end
+    end
+  end
+end