uploadcare-rails 1.2.1 → 2.0.0

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'uploadcare/rails/api/rest/base'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        # A class that contains Webhook related methods for Uploadcare REST API
+        class WebhookApi < Base
+          class << self
+            # Returns a list (not paginated) of webhooks
+            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/webhooksList
+            # rubocop:disable Naming/AccessorMethodName
+            def get_webhooks
+              Uploadcare::Webhook.list
+            end
+            # rubocop:enable Naming/AccessorMethodName
+
+            # Create a webhook
+            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/webhookCreate
+            def create_webhook(target_url, event: 'file.uploaded', is_active: true)
+              options = { target_url: target_url, event: event, is_active: is_active }
+              Uploadcare::Webhook.create(**options)
+            end
+
+            # Updates a webhook
+            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/updateWebhook
+            def update_webhook(id, **options)
+              Uploadcare::Webhook.update(id, **options)
+            end
+
+            # Permanently deletes a webhook
+            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/webhookUnsubscribe
+            def delete_webhook(target_url)
+              Uploadcare::Webhook.delete(target_url)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Uploadcare::WebhookApi = Uploadcare::Rails::Api::Rest::WebhookApi

data/lib/uploadcare/rails/api/upload/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'uploadcare'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Upload
+        class Base; end
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/api/upload/upload_api.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'uploadcare/rails/api/upload/base'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Upload
+        # A client for general uploads
+        #
+        # @see https://uploadcare.com/api-refs/upload-api/#tag/Upload
+        class UploadApi < Base
+          class << self
+            # Uploads single files smaller. Supports small (less that 100 MB) and large single files.
+            #
+            # @see https://uploadcare.com/api-refs/upload-api/#operation/baseUpload
+            # @see https://uploadcare.com/api-refs/upload-api/#operation/multipartFileUploadStart
+            def upload_file(file, **options)
+              return upload(file, options) if file?(file) || file.is_a?(String)
+
+              raise TypeError, "The first argument must be a File or String (URL), #{file.class} given"
+            end
+
+            # Uploads several files smaller than 100MB.
+            #
+            # https://uploadcare.com/api-refs/upload-api/#operation/multipartFileUploadStart
+            def upload_files(files, **options)
+              return upload(files, options) if array_of_files?(files)
+
+              raise TypeError, 'The first argument must be an Array of File objects'
+            end
+
+            private
+
+            def array_of_files?(files)
+              files.is_a?(Array) && files.all? { |file| file?(file) }
+            end
+
+            def file?(object)
+              object.respond_to?(:path) && ::File.exist?(object.path)
+            end
+
+            def upload(files, options)
+              Uploadcare::Uploader.upload(files, **options)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Uploadcare::UploadApi = Uploadcare::Rails::Api::Upload::UploadApi

data/lib/uploadcare/rails/configuration.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Uploadcare
+  module Rails
+    # A class for storing config parameters
+    class Configuration
+      include Singleton
+
+      CONFIG_GLOBAL_PARAMS = %w[
+        public_key secret_key cache_files cache_expires_in cache_namespace cdn_hostname
+        store_files_after_save store_files_async
+        delete_files_after_destroy delete_files_async
+      ].freeze
+
+      WIDGET_PARAMS = %w[
+        public_key images_only preview_step crop image_shrink
+        clearable tabs input_accept_types preferred_types system_dialog multipart_min_size
+        preview_proxy cdn_base do_not_store audio_bits_per_second video_preferred_mime_types
+        video_bits_per_second camera_mirror_default live manual_start
+        locale locale_translations locale_pluralize
+      ].freeze
+
+      attr_accessor(*(CONFIG_GLOBAL_PARAMS + WIDGET_PARAMS).uniq)
+
+      def uploader_parameters
+        WIDGET_PARAMS.map do |param_name|
+          param_value = instance_variable_get("@#{param_name}")
+          next if param_value.nil?
+
+          param_value = handle_param_value(param_value)
+          "UPLOADCARE_#{param_name.upcase} = #{param_value};"
+        end.compact.join("\n")
+      end
+
+      def widget
+        OpenStruct.new(WIDGET_PARAMS.map { |param| [param, public_send(param)] }.to_h)
+      end
+
+      private
+
+      def handle_param_value(param_value)
+        case param_value
+        when Hash
+          param_value.deep_stringify_keys.to_json
+        when Array
+          "'#{param_value.join(' ')}'"
+        when TrueClass, FalseClass
+          param_value
+        else
+          "'#{param_value}'"
+        end
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/engine.rb

@@ -1,28 +1,24 @@
+# frozen_string_literal: true
+
 require 'rails/engine'
-require 'uploadcare/rails/settings'
 
 module Uploadcare
   module Rails
+    # Rails engine that allows to extend default rails libraries
     class Engine < ::Rails::Engine
       initializer 'uploadcare-rails.load' do
-        # load actual rails extentions
-        # active record extention for stand-alone file models and models has files
-
-        ActiveSupport.on_load :active_record do
-          require 'uploadcare/rails/active_record/has_file'
-          require 'uploadcare/rails/active_record/has_group'
-        end
-
-        # JS options, widets from cdn etc
+        # Load extensions
+        # Extend action_view with widget_tag
         ActiveSupport.on_load :action_view do
-          require 'uploadcare/rails/action_view/include_tags'
-          require 'uploadcare/rails/action_view/uploader_tags'
-
-          # Simple Form helpers
-          require 'uploadcare/rails/simple_form/simple_form' if defined?(SimpleForm)
+          require 'uploadcare/rails/action_view/uploadcare_include_tags'
+          require 'uploadcare/rails/action_view/uploadcare_uploader_tags'
+        end
 
-          # Formastic helpers
-          require 'uploadcare/rails/formtastic/formtastic' if defined?(Formtastic)
+        # Load extensions for active_record
+        # Extend active_record with mount_uploadcare_file and mount_uploadcare_file_group methods
+        ActiveSupport.on_load :active_record do
+          require 'uploadcare/rails/active_record/mount_uploadcare_file'
+          require 'uploadcare/rails/active_record/mount_uploadcare_file_group'
         end
       end
     end

data/lib/uploadcare/rails/jobs/delete_file_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_job'
+
+module Uploadcare
+  module Rails
+    # A job deleting files from Uploadcare
+    class DeleteFileJob < ActiveJob::Base
+      def perform(file_uuid)
+        Uploadcare::FileApi.delete_file(file_uuid) if file_uuid
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/jobs/store_file_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_job'
+
+module Uploadcare
+  module Rails
+    # A job storing files to Uploadcare
+    class StoreFileJob < ActiveJob::Base
+      def perform(file_uuid)
+        Uploadcare::FileApi.store_file(file_uuid) if file_uuid
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/jobs/store_group_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_job'
+
+module Uploadcare
+  module Rails
+    # A job storing group files to Uploadcare
+    class StoreGroupJob < ActiveJob::Base
+      def perform(group_id)
+        Uploadcare::GroupApi.store_group(group_id) if group_id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Uploadcare
+  module Rails
+    module Objects
+      # A module that contains methods for attribute assignation and caching
+      module Loadable
+        extend ActiveSupport::Concern
+        include ::ActiveRecord::AttributeAssignment
+
+        class_methods do
+          def build_cache_key(key)
+            [uploadcare_configuration.cache_namespace, key].flatten.reject(&:blank?)
+          end
+
+          def uploadcare_configuration
+            Uploadcare::Rails.configuration
+          end
+        end
+
+        def update_attrs(new_attrs)
+          assign_attributes(new_attrs)
+          self
+        end
+
+        def cache_expires_in
+          uploadcare_configuration.cache_expires_in
+        end
+
+        def caching_enabled?
+          uploadcare_configuration.cache_files
+        end
+
+        def uploadcare_configuration
+          self.class.uploadcare_configuration
+        end
+
+        def cache_key
+          self.class.build_cache_key(cdn_url)
+        end
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/objects/file.rb

@@ -1,40 +1,60 @@
+# frozen_string_literal: true
+
+require 'uploadcare/rails/api/rest/file_api'
+require 'uploadcare/rails/transformations/image_transformations'
+require 'uploadcare/rails/objects/concerns/loadable'
+
 module Uploadcare
   module Rails
-    class File < Uploadcare::Api::File
-      def url(operations = nil)
-        cdn_url unless operations
-        cdn_url + prepared_operations(operations)
+    # A wrapper class for Uploadcare::File object.
+    # Allows caching loaded files and has methods for Rails model attributes
+    class File < Uploadcare::Entity::File
+      include Objects::Loadable
+
+      ATTR_ENTITIES = [:cdn_url].freeze
+
+      attr_entity(*superclass.entity_attributes + ATTR_ENTITIES)
+
+      def transform_url(transformations, transformator_class = Uploadcare::Rails::Transformations::ImageTransformations)
+        return if cdn_url.blank?
+
+        transformations_query = transformator_class.new(transformations).call if transformations.present?
+        [cdn_url, transformations_query].compact.join('-')
       end
 
-      def prepared_operations(operations)
-        Uploadcare::Rails::Operations.new(operations).to_s
+      def store
+        file_info = Uploadcare::FileApi.store_file(uuid).merge(cdn_url: cdn_url).to_h
+        ::Rails.cache.write(cache_key, file_info, expires_in: cache_expires_in) if caching_enabled?
+        update_attrs(file_info)
       end
 
-      # construct image tag for file
-      def image(operations = nil)
-        image_tag(url(operations))
+      def delete
+        Uploadcare::FileApi.delete_file(uuid)
       end
 
-      # override default to string method
-      # instead of string representation of object it will return simple cdn url of a file
       def to_s
         cdn_url
       end
 
-      def to_builder
-        marshal_dump
+      def load
+        file_info = if caching_enabled?
+                      ::Rails.cache.fetch(cache_key, expires_in: cache_expires_in) do
+                        request_file_info_from_api
+                      end
+                    else
+                      request_file_info_from_api
+                    end
+        update_attrs(file_info)
       end
 
-      def to_json
-        marshal_dump
+      def loaded?
+        datetime_uploaded.present?
       end
 
-      def as_json(_options = {})
-        marshal_dump
-      end
+      private
 
-      def marshal_dump
-        @table.stringify_keys
+      def request_file_info_from_api
+        Uploadcare::FileApi.get_file(uuid).merge(self).to_h
       end
     end
   end

data/lib/uploadcare/rails/objects/group.rb

@@ -1,81 +1,75 @@
+# frozen_string_literal: true
+
+require 'uploadcare/rails/api/rest/group_api'
+require 'uploadcare/rails/transformations/image_transformations'
+require 'uploadcare/rails/objects/concerns/loadable'
+
 module Uploadcare
   module Rails
-    class Group < Uploadcare::Api::Group
+    # A wrapper class that for Uploadcare::Group object.
+    # Allows caching loaded groups and has methods for Rails model attributes
+    class Group < Uploadcare::Entity::Group
+      include Objects::Loadable
+
+      attr_entity(*superclass.entity_attributes)
 
-      # warkaround to build images urls without API request
-      # builds array of image urls including operations
-      def urls(operations = nil)
-        (0..files_count.to_i - 1).to_a.map do |i|
-          [
-            @api.options[:static_url_base],
-            uuid,
-            'nth',
-            i,
-            Operations.new(operations).to_s
-          ].join('/')
+      def transform_file_urls(
+        transformations,
+        transformator_class = Uploadcare::Rails::Transformations::ImageTransformations
+      )
+        return if cdn_url.blank?
+
+        transformations_query = transformator_class.new(transformations).call if transformations.present?
+        map_file_urls do |index|
+          [group_file_url(index), transformations_query].compact.join('-')
         end
       end
 
-      def load_data
-        load_data! unless is_loaded?
-        self
+      def file_urls
+        map_file_urls do |index|
+          group_file_url(index)
+        end
       end
 
-      alias_method :load, :load_data
-
-      def load_data!
-        set_data(@api.get("/groups/#{ uuid }/"))
-        cache_data
-        self
+      def store
+        group_info = Uploadcare::GroupApi.store_group(id).to_h
+        ::Rails.cache.write(cache_key, group_info, expires_in: cache_expires_in) if caching_enabled?
+        update_attrs(group_info)
       end
 
-      alias_method :load!, :load_data!
-
-      def cache_data
-        return unless UPLOADCARE_SETTINGS.cache_groups
-        ::Rails.cache.write(cdn_url, marshal_dump)
-        self
+      def to_s
+        cdn_url
       end
 
-      def marshal_dump
-        table = @table.deep_dup.stringify_keys!
-
-        if table['files']
-          table['files'].map! do |file|
-            file.marshal_dump.stringify_keys
-          end
-        end
-
-        table
+      def load
+        group_info = if caching_enabled?
+                       ::Rails.cache.fetch(cache_key, expires_in: cache_expires_in) do
+                         request_group_info_from_api
+                       end
+                     else
+                       request_group_info_from_api
+                     end
+        update_attrs(group_info)
       end
 
-      def to_json
-        marshal_dump
+      def loaded?
+        datetime_created.present?
       end
 
-      def as_json(_options = {})
-        marshal_dump
-      end
+      private
 
-      # override default to string method
-      # for group we just will return the uuid
-      def to_s
-        uuid
+      def request_group_info_from_api
+        Uploadcare::GroupApi.get_group(id).merge(self).to_h
       end
 
-      private
+      def group_file_url(index)
+        "#{cdn_url}nth/#{index}/"
+      end
 
-      def map_files(data)
-        data.stringify_keys!
-        data['files'].map! do |file|
-          if file.nil?
-            file
-          else
-            Uploadcare::Rails::File.new(@api, file['uuid'], file)
-          end
-        end
+      def map_file_urls(&block)
+        return [] unless block_given?
 
-        data
+        Array.new(files_count.to_i, &block)
       end
     end
   end

data/lib/uploadcare/rails/services/files_count_extractor.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Rails
+    # A class extracting the files count param of a file group from a group ID.
+    class FilesCountExtractor
+      class << self
+        def call(input_str)
+          input_str.split('~').last if input_str.present?
+        end
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/services/id_extractor.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Rails
+    # A class extracting an ID of an object from an URL.
+    class IdExtractor
+      class << self
+        # regex is an UUID-regex by default
+        def call(input_str, 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/)
+          input_str.match(regex).to_s
+        end
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/transformations/image_transformations.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'uploadcare/errors/type_error'
+
+module Uploadcare
+  module Rails
+    module Transformations
+      # A class for building image urls after image transformations.
+      class ImageTransformations
+        def initialize(options = {})
+          raise ArgumentError, "Options argument must be a Hash, #{options.class} is given?" unless options.is_a?(Hash)
+
+          @options = options.map { |k, v| [k.to_sym, v] }.to_h
+        end
+
+        def call
+          options_to_a.compact.join('-').squeeze('/').gsub(/\s/, '').presence
+        end
+
+        private
+
+        attr_reader :options
+
+        def options_to_a
+          options.map do |key, value|
+            "/#{key}/#{adjusted_value(value)}/"
+          end
+        end
+
+        def adjusted_value(value)
+          case value
+          when Hash
+            value.values.join('/')
+          when TrueClass, FalseClass, 'true', 'false'
+            nil
+          when Array
+            value.join(',')
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/uploadcare/rails/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Uploadcare
   module Rails
-    VERSION = '1.2.1'.freeze
+    VERSION = '2.0.0'
   end
 end

data/lib/uploadcare/rails.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'uploadcare/rails/version'
+
+module Uploadcare
+  module Rails
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/uploadcare-rails.rb

@@ -1,22 +1,33 @@
-require 'uploadcare'
+# frozen_string_literal: true
 
-require_relative 'uploadcare/rails/version'
-require_relative 'uploadcare/rails/engine'
-require_relative 'uploadcare/rails/settings'
-require_relative 'uploadcare/rails/operations'
-require_relative 'uploadcare/rails/objects/file'
-require_relative 'uploadcare/rails/objects/group'
+require 'uploadcare/rails/engine'
+require 'uploadcare/rails/configuration'
+require 'uploadcare/rails/objects/file'
+require 'uploadcare/rails/objects/group'
+require 'uploadcare/rails/api/rest/file_api'
+require 'uploadcare/rails/api/rest/group_api'
+require 'uploadcare/rails/api/rest/project_api'
+require 'uploadcare/rails/api/rest/webhook_api'
+require 'uploadcare/rails/api/rest/conversion_api'
+require 'uploadcare/rails/api/upload/upload_api'
 
 module Uploadcare
+  # A root module for the gem
   module Rails
-    DEFAULT_SETTINGS = {
-      widget_version: '3.x',
-      user_agent_environment: {
-        framework_name: 'Rails',
-        framework_version: ::Rails.version,
-        extension_name: 'UploadcareRails',
-        extension_version: Uploadcare::Rails::VERSION
-      }
-    }.freeze
+    module_function
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration
+    end
+
+    def initialize_config
+      @configuration = Uploadcare::Rails::Configuration.instance
+    end
+
+    initialize_config
   end
 end