uploadcare-rails 3.4.2 → 3.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3752eab2d238aab90af10d0bea8e9c7a14c3aba55909529a27c9c1e20cfb60d
-  data.tar.gz: a49e6107cb976f4c38fe5f7dc7f92a637e25e1c3ef14fb794aa3ecd730fef1e9
+  metadata.gz: 84a1955833b6989dafad0bcd3bbfd9186c84f619f75949aa972e007f480b7483
+  data.tar.gz: e2a813f07691e21d11877e6cc5926dbd03b8ddeca5d7bc6e86445316ba71fe12
 SHA512:
-  metadata.gz: '09a704803fdf183ed4a0656ad2e33f18b6586cba8cd8112041c3cd35ee1d8220afe04d870d18faafa32fed468c3593e8a34f0a1f6cc1c788b96556589c7c83e1'
-  data.tar.gz: 79f55a729a8989feff52dca3db695edf6f410f23a60df6dbeff883b7d17a8b705c948e8427deb2a32f698df936c540f946125971b357320c9c657623a76fb5d3
+  metadata.gz: 5e4192606fb0d70db16c9ac22da5bf44bd42fc2b2b597fbb8445e4f8e9479d03aa523474ef456e48530192807c548c556ad7137d4e0e652d79981dd1173b857c
+  data.tar.gz: d9d15fd8e45b9dcc557a216fcba5947b7b33f2b3adbdb7e4009f06a1056b86eb15c1bd0a6e9f9911a86da031eb4844d4f59e0cb1e1edd3ef4d5fee4e35f7c73c

data/CHANGELOG.md

@@ -4,9 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based now on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 3.4.4 — 2024-11-07
+
+### Added
+
+* Add mongoid support for `mount_uploadcare_file` and `mount_uploadcare_file_group` methods.
+
+### Breaking Changes
+
+* Drop support for Rails 6.1x in line with the currently supported Rails versions: https://rubyonrails.org/maintenance
+
+## 3.4.3 — 2024-06-01
+
+### Added
+
+* For `Uploadcare::ConversionApi` added `get_document_conversion_formats_info` method to get the possible document conversion formats.
+
 ## 3.4.2 — 2024-05-11
 
 ### Added
+
 * Added API support for `AWS Rekognition Moderation` Add-On.
 
 ## 3.4.1 — 2024-03-24

data/Gemfile

@@ -7,8 +7,12 @@ gemspec
 
 gem 'http-parser', '~> 1.2', '>= 1.2.3'
 gem 'rake', '~> 13.0.6'
-gem 'rspec', '~> 3.12'
-gem 'rspec-rails', '>= 5.1'
-gem 'rubocop', '~> 1.48'
-gem 'vcr', '~> 6.1'
-gem 'webmock', '~> 3.18'
+
+group :test do
+  gem 'mongoid', '~> 9', require: false
+  gem 'rspec', '~> 3.12'
+  gem 'rspec-rails', '>= 5.1'
+  gem 'rubocop', '~> 1.48'
+  gem 'vcr', '~> 6.1'
+  gem 'webmock', '~> 3.18'
+end

data/README.md

@@ -333,6 +333,8 @@ document.addEventListener('turbo:before-cache', function() {
 When you mount either Uploadcare File or Group to an attribute, this attribute is getting wrapped with
 a Uploadcare object. This feature adds some useful methods to the attribute.
 
+Note: Supports ActiveRecord, ActiveModel and Mongoid models.
+
 #### Uploadcare File
 
 Say, you have such model in your Rails app:

data/lib/uploadcare/rails/api/rest/conversion_api.rb

@@ -21,6 +21,12 @@ module Uploadcare
               Uploadcare::VideoConverter.status(token)
             end
 
+            # Conversion formats info
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Conversion/operation/documentConvertInfo
+            def get_document_conversion_formats_info(uuid)
+              Uploadcare::DocumentConverter.info(uuid)
+            end
+
             # Converts documents
             # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/documentConvert
             def convert_document(document_params, options = {})

data/lib/uploadcare/rails/engine.rb

@@ -20,6 +20,13 @@ module Uploadcare
           require 'uploadcare/rails/active_record/mount_uploadcare_file'
           require 'uploadcare/rails/active_record/mount_uploadcare_file_group'
         end
+
+        # Load extensions for mongoid
+        # Extend mongoid with mount_uploadcare_file and mount_uploadcare_file_group methods
+        ActiveSupport.on_load :mongoid do
+          require 'uploadcare/rails/mongoid/mount_uploadcare_file'
+          require 'uploadcare/rails/mongoid/mount_uploadcare_file_group'
+        end
       end
     end
   end

data/lib/uploadcare/rails/mongoid/mount_uploadcare_file.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'mongoid'
+require 'active_support/concern'
+require 'uploadcare/rails/services/id_extractor'
+require 'uploadcare/rails/jobs/delete_file_job'
+require 'uploadcare/rails/jobs/store_file_job'
+require 'uploadcare/rails/objects/file'
+
+module Uploadcare
+  module Rails
+    module Mongoid
+      # A module containing Mongoid extension. Allows using uploadcare file methods in Mongoid models
+      module MountUploadcareFile
+        extend ActiveSupport::Concern
+
+        def build_uploadcare_file(attribute)
+          cdn_url = read_attribute(attribute).to_s
+          return if cdn_url.empty?
+
+          uuid = IdExtractor.call(cdn_url)
+          cache_key = File.build_cache_key(cdn_url)
+          default_attributes = { cdn_url: cdn_url, uuid: uuid.presence }
+          file_attributes = ::Rails.cache.read(cache_key).presence || default_attributes
+          Uploadcare::Rails::File.new(file_attributes)
+        end
+
+        class_methods do
+          # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          def mount_uploadcare_file(attribute)
+            define_method attribute do
+              build_uploadcare_file(attribute)
+            end
+
+            define_method "uploadcare_store_#{attribute}!" do |store_job = StoreFileJob|
+              file_uuid = public_send(attribute)&.uuid
+              return unless file_uuid
+              return store_job.perform_later(file_uuid) if Uploadcare::Rails.configuration.store_files_async
+
+              Uploadcare::FileApi.store_file(file_uuid)
+            end
+
+            define_method "uploadcare_delete_#{attribute}!" do |delete_job = DeleteFileJob|
+              file_uuid = public_send(attribute)&.uuid
+              return unless file_uuid
+              return delete_job.perform_later(file_uuid) if Uploadcare::Rails.configuration.delete_files_async
+
+              Uploadcare::FileApi.delete_file(file_uuid)
+            end
+
+            unless Uploadcare::Rails.configuration.do_not_store
+              set_callback(:save, :after, :"uploadcare_store_#{attribute}!", if: :"#{attribute}_changed?")
+            end
+
+            return unless Uploadcare::Rails.configuration.delete_files_after_destroy
+
+            set_callback(:destroy, :after, :"uploadcare_delete_#{attribute}!")
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        end
+      end
+    end
+  end
+end
+
+Mongoid::Document.include Uploadcare::Rails::Mongoid::MountUploadcareFile

data/lib/uploadcare/rails/mongoid/mount_uploadcare_file_group.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'mongoid'
+require 'active_support/concern'
+require 'uploadcare/rails/services/id_extractor'
+require 'uploadcare/rails/services/files_count_extractor'
+require 'uploadcare/rails/jobs/store_group_job'
+require 'uploadcare/rails/objects/group'
+
+module Uploadcare
+  module Rails
+    module Mongoid
+      # A module containing Mongoid extension. Allows to use uploadcare group methods in Rails models
+      module MountUploadcareFileGroup
+        extend ActiveSupport::Concern
+
+        GROUP_ID_REGEX = /\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b~\d+/.freeze
+
+        def build_uploadcare_file_group(attribute)
+          cdn_url = read_attribute(attribute).to_s
+          return if cdn_url.empty?
+
+          group_id = IdExtractor.call(cdn_url, GROUP_ID_REGEX).presence
+          cache_key = Group.build_cache_key(cdn_url)
+          files_count = FilesCountExtractor.call(group_id)
+          default_attributes = { cdn_url: cdn_url, id: group_id, files_count: files_count }
+          file_attributes = ::Rails.cache.read(cache_key).presence || default_attributes
+          Uploadcare::Rails::Group.new(file_attributes)
+        end
+
+        class_methods do
+          # rubocop:disable Metrics/MethodLength
+          def mount_uploadcare_file_group(attribute)
+            define_singleton_method "has_uploadcare_file_group_for_#{attribute}?" do
+              true
+            end
+
+            define_method attribute do
+              build_uploadcare_file_group attribute
+            end
+
+            define_method "uploadcare_store_#{attribute}!" do |store_job = StoreGroupJob|
+              group_id = public_send(attribute)&.id
+              return unless group_id
+              return store_job.perform_later(group_id) if Uploadcare::Rails.configuration.store_files_async
+
+              Uploadcare::GroupApi.store_group(group_id)
+            end
+
+            return if Uploadcare::Rails.configuration.do_not_store
+
+            set_callback :save, :after, :"uploadcare_store_#{attribute}!"
+          end
+          # rubocop:enable Metrics/MethodLength
+        end
+      end
+    end
+  end
+end
+
+Mongoid::Document.include Uploadcare::Rails::Mongoid::MountUploadcareFileGroup

data/lib/uploadcare/rails/objects/concerns/loadable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_record'
+require 'active_model'
 
 module Uploadcare
   module Rails
@@ -8,7 +8,7 @@ module Uploadcare
       # A module that contains methods for attribute assignation and caching
       module Loadable
         extend ActiveSupport::Concern
-        include ::ActiveRecord::AttributeAssignment
+        include ActiveModel::AttributeAssignment
 
         class_methods do
           def build_cache_key(key)

data/lib/uploadcare/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Uploadcare
   module Rails
-    VERSION = '3.4.2'
+    VERSION = '3.4.4'
   end
 end

data/uploadcare-rails.gemspec

@@ -44,5 +44,5 @@ Gem::Specification.new do |gem|
 
   gem.version = Uploadcare::Rails::VERSION
   gem.add_dependency 'rails', '>= 6'
-  gem.add_dependency 'uploadcare-ruby', '>= 4.4.1'
+  gem.add_dependency 'uploadcare-ruby', '>= 4.4.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-rails
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 3.4.4
 platform: ruby
 authors:
 - "@dmitrijivanchenko (Dmitrij Ivanchenko), @T0mbery (Andrey Aksenov)"
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-19 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 4.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 4.4.2
 description: |
   Rails API client (based on uploadcare-ruby) that handles uploads
   and further operations with files by wrapping Uploadcare Upload and REST APIs.
@@ -79,6 +79,8 @@ files:
 - lib/uploadcare/rails/jobs/delete_file_job.rb
 - lib/uploadcare/rails/jobs/store_file_job.rb
 - lib/uploadcare/rails/jobs/store_group_job.rb
+- lib/uploadcare/rails/mongoid/mount_uploadcare_file.rb
+- lib/uploadcare/rails/mongoid/mount_uploadcare_file_group.rb
 - lib/uploadcare/rails/objects/concerns/loadable.rb
 - lib/uploadcare/rails/objects/file.rb
 - lib/uploadcare/rails/objects/group.rb