uploadcare-rails 1.2.1 → 2.0.0

data/spec/tmp/config/initializers/uploadcare.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Uncomment this string in case of using locales for locale_translations parameter
+# I18n.load_path += Dir[Rails.root.join('config', 'locales', '*.{rb,yml}').to_s]
+
+Uploadcare::Rails.configure do |config|
+  # Sets your Uploadcare public key.
+  config.public_key = ENV.fetch('UPLOADCARE_PUBLIC_KEY', 'demopublickey')
+  # config.secret_key = ENV.fetch('UPLOADCARE_SECRET_KEY', 'demosecretkey')
+
+  # Stores files to Uploadcare servers after object save.
+  config.store_files_after_save = true
+
+  # Deletes files from Uploadcare servers after object destroy.
+  config.delete_files_after_destroy = true
+
+  # Sets caching for Uploadcare files
+  config.cache_namespace = 'uploadcare'
+  config.cache_files = true
+  config.cache_expires_in = 1.day
+
+  # These options enables ActiveJob background jobs to perform operations in background.
+  # Options work if only the option 'do_not_store' is disabled (false) and
+  # the option 'delete_files_after_destroy' is enabled (true).
+  config.store_files_async = true
+  config.delete_files_async = true
+
+  # If true, only image files are allowed to be uploaded.
+  # config.images_only = false
+
+  # If true, the preview step is present after selecting files.
+  # Otherwise, the file uploader dialog closes when the selection is complete.
+  # config.preview_step = false
+
+  # Defines the file uploader manual crop behavior (see https://uploadcare.com/docs/uploads/file-uploader/#crop-option).
+  # When uploading images, your users can select a crop area.
+  # This option does not force your file uploader to accept images only.
+  # The option also works in the multi-file mode since version 2.3.0.
+  # config.crop = 'disabled'
+
+  # Saves traffic and storage space by resizing images on a client before uploading.
+  # See the detailed option description for details. Using the client-side resize does not force the images only option.
+  # config.image_shrink = '800x600'
+
+  # Allows user to remove uploaded files from the file uploader.
+  # Please note that those files are not deleted from your account.
+  # config.clearable = true
+
+  # Allows you to define which upload sources you want to use with the file uploader.
+  # The value is represented by a space-separated ordered list of upload source names.
+  # See https://uploadcare.com/docs/uploads/file-uploader/#upload-sources for details.
+  # config.tabs = %w[url file facebook]
+
+  # Sets the accept attribute for the file uploader dialog.
+  # If the images only option is disabled, the value is empty.
+  # Otherwise, the default value is image/*.
+  # null means accept should be kept empty regardless of the images only value.
+  # For other possible values, see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input#attr-accept
+  # Note, this is not a replacement for
+  # our file validation (see https://uploadcare.com/docs/file-uploader-api/file-validation/)
+  # because your users will still be able to choose any file via drag&drop or from URL.
+  # config.input_accept_types = %w[image/*]
+
+  # Defines the list of preferred MIME types.
+  # The list should be ordered and contain space-separated MIME types.
+  # Common parts can be marked with asterisks: image/* application/vnd.openxmlformats-officedocument.*.
+  # If no MIME types match the criteria or preferred types are not set, default formats are used.
+  # Keep in mind that some cloud services can export data in different formats.
+  # For example, Google document can be exported as Word document, PDF or plain text.
+  # config.preferred_types = %w[image/* application/vnd.openxmlformats-officedocument.*]
+
+  # Forces a system-native file picking dialog to show up instead of our file uploader.
+  # That makes the file uploader behavior as close as possible to the generic <input type="file">.
+  # Native behavior is achieved at the expense of support for uploading content
+  # from social media and cloud storage, manual crop, and preview step.
+  # Multi-file selection would still work.
+  # The option does not work in old browser versions: the dialog falls back to the file uploader.
+  # config.system_dialog = false
+
+  # This option sets the file size threshold for multipart uploading.
+  # The value ranges from 10485760 (10 MB), which is default, up to 104857600 (100 MB).
+  # If a file size hits the threshold, it gets uploaded in four parallel chunks by 5 MB.
+  # Multipart upload makes large file uploading faster.
+  # Files go directly to a storage, bypassing our upload servers,
+  # and they're quickly available for further use. All files below the threshold get uploaded in one piece.
+  # Note: Multipart upload works with local sources only (files and camera).
+  # config.multipart_min_size = 10485760
+
+  # Available locales currently are:
+  # ar az ca cs da de el en es et fr he it ja ko lv nb nl pl pt ro ru sk sr sv tr uk vi zhTW zh
+  config.locale = 'en'
+
+  # Sets custom localization options. See https://uploadcare.com/docs/uploads/file-uploader/#localization
+  # config.locale_translations = {}
+
+  # Defines pluralization options. See https://uploadcare.com/docs/uploads/file-uploader/#pluralization
+  # config.locale_pluralize = {}
+
+  # The option can be used with Authenticated URLs. Defines your proxy backend URL.
+  # See https://uploadcare.com/docs/security/secure-delivery/#proxy-backend.
+  # config.preview_proxy = 'https://domain.com/preview?'
+
+  # If true, inputs on your page are initialized automatically, see the article for details -
+  # https://uploadcare.com/docs/file-uploader-api/widget-initialization/
+  config.live = true
+
+  # If true, input initialization is invoked manually.
+  # See https://uploadcare.com/docs/file-uploader-api/widget-initialization/).
+  config.manual_start = false
+
+  # Defines your schema and CDN domain.
+  # Can be changed to one of the predefined values (https://uploadcare.com/docs/delivery/cdn/) or your custom CNAME.
+  # config.cdn_base = 'https://ucarecdn.com/'
+  config.cdn_hostname = 'ucarecdn.com'
+
+  # Forces files uploaded with a file uploader not to be stored.
+  # See https://uploadcare.com/docs/uploads/storage/#storing-uploaded-files.
+  # For instance, you might want to turn this on when automatic file storing is enabled in your project,
+  # but you do not want to store files uploaded with a particular file uploader.
+  # config.do_not_store = false
+
+  # Allows you to adjust the quality of an audio recorded via the file uploader Camera Tab.
+  # Refer the link to learn more - https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder.
+  # config.audio_bits_per_second = 1
+
+  # Allows you to specify the MIME types.
+  # The first supported by the browser will be used as an option of
+  # video stream captured via the file uploader Camera Tab.
+  # Refer the link to learn more - https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder.
+  # config.video_preferred_mime_types = []
+
+  # Allows you to adjust the quality of a video stream captured via the file uploader Camera Tab.
+  # Refer the link to learn more - https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder.
+  # config.video_bits_per_second = 1
+
+  # Allows you to set the default state of image/video mirorring in the camera tab.
+  # config.camera_mirror_default = true
+end

data/spec/uploadcare/rails/action_view/uploadcare_uploader_tags_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/action_view/uploadcare_uploader_tags'
+
+describe Uploadcare::Rails::ActionView::UploadcareUploaderTags, type: :helper do
+  it 'includes a hidden field' do
+    tag = uploadcare_uploader_field(:post, :title)
+
+    [
+      '<input',
+      'role="uploadcare-uploader"',
+      'type="hidden"',
+      'name="post[title]"',
+      'id="post_title"',
+      '/>'
+    ].each do |fragment|
+      expect(tag).to include(fragment)
+    end
+  end
+
+  it 'includes a hidden field tag' do
+    tag = uploadcare_uploader_field_tag(:title)
+
+    [
+      '<input',
+      'role="uploadcare-uploader"',
+      'type="hidden"',
+      'name="title"',
+      'id="title"',
+      '/>'
+    ].each do |fragment|
+      expect(tag).to include(fragment)
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include Uploadcare::Rails::ActionView::UploadcareUploaderTags, type: :helper
+end

data/spec/uploadcare/rails/action_view/uploadcare_widget_tags_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/action_view/uploadcare_include_tags'
+
+describe Uploadcare::Rails::ActionView::UploadcareWidgetTags, type: :helper do
+  let(:global_variables) { 'UPLOADCARE_PUBLIC_KEY = demopublickey;' }
+
+  before do
+    allow(Uploadcare::Rails).to receive_message_chain(:configuration, :uploader_parameters)
+      .and_return(global_variables)
+    allow(Uploadcare::Rails).to receive_message_chain(:configuration, :cdn_hostname).and_return('ucarecdn.com')
+  end
+
+  context 'when including a widget' do
+    context 'and checking available bundles' do
+      %w[full default api ie8 lang.en].each do |bundle|
+        %w[3 3.x 2 1].each do |version|
+          [true, false].each do |min|
+            it "includes a widget from cdn with params: vesrion = #{version}, bundle = #{bundle} and min = #{min}" do
+              tag = uploadcare_include_tag(version: version, bundle: bundle, min: min)
+
+              expect(tag).to match(
+                [
+                  '<script src="https://ucarecdn.com/libs/widget/',
+                  version,
+                  "/uploadcare#{bundle == 'default' ? '' : ".#{bundle}"}#{min ? '.min' : ''}.js\"></script>"
+                ].join
+              )
+            end
+          end
+        end
+      end
+
+      context 'and checking global variables' do
+        it 'includes global variables' do
+          expect(uploadcare_include_tag).to match(global_variables)
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include Uploadcare::Rails::ActionView::UploadcareWidgetTags, type: :helper
+end

data/spec/uploadcare/rails/active_record/mount_uploadcare_file_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/active_record/mount_uploadcare_file'
+require 'uploadcare/rails/active_record/mount_uploadcare_file_group'
+
+describe Uploadcare::Rails::ActiveRecord::MountUploadcareFile do
+  before do
+    allow(Uploadcare::Rails).to receive(:configuration).and_return(OpenStruct.new)
+    stub_const 'Post', Class.new
+    Post.class_eval do
+      include Uploadcare::Rails::ActiveRecord::MountUploadcareFile
+      extend ActiveModel::Callbacks
+
+      define_model_callbacks :save, only: :after
+
+      def initialize
+        @picture = ''
+      end
+
+      mount_uploadcare_file :picture
+    end
+  end
+
+  context 'when checking mount file methods availability' do
+    it 'checks that a model instance responds to mount file methods', :aggregate_failures do
+      post = Post.new
+      %i[uploadcare_store_picture! uploadcare_delete_picture!].each do |method|
+        expect(post).to respond_to(method)
+      end
+    end
+  end
+end

data/spec/uploadcare/rails/active_record/mount_uploadcare_group_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/active_record/mount_uploadcare_file'
+require 'uploadcare/rails/active_record/mount_uploadcare_file_group'
+
+describe Uploadcare::Rails::ActiveRecord::MountUploadcareFileGroup do
+  before do
+    allow(Uploadcare::Rails).to receive(:configuration).and_return(OpenStruct.new)
+    stub_const 'Post', Class.new
+    Post.class_eval do
+      include Uploadcare::Rails::ActiveRecord::MountUploadcareFileGroup
+      extend ActiveModel::Callbacks
+
+      define_model_callbacks :save, only: :after
+
+      def initialize
+        @gallery = ''
+      end
+
+      mount_uploadcare_file_group :gallery
+    end
+  end
+
+  context 'when checking mount file group methods availability' do
+    it 'checks that a model instance responds to mount file group methods', :aggregate_failures do
+      post = Post.new
+      expect(post).to respond_to(:uploadcare_store_gallery!)
+      expect(Post).to respond_to(:has_uploadcare_file_group_for_gallery?)
+    end
+  end
+end

data/spec/uploadcare/rails/api/rest/conversion_api_spec.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/api/rest/conversion_api'
+
+# These specs include specs from uploadcare-ruby to check proper work with different rails versions.
+# They probably will be moved to the uploadcare-ruby gem in future releases.
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        RSpec.describe ConversionApi do
+          subject { Uploadcare::ConversionApi }
+
+          context 'when checking methods' do
+            it 'responds to expected REST methods' do
+              %i[convert_video get_video_conversion_status convert_document get_document_conversion_status].each do |m|
+                expect(subject).to respond_to(m)
+              end
+            end
+          end
+
+          context 'when sending requests', :aggregate_failures do
+            context 'and when converting a video' do
+              let(:uuid) { '169d4bf8-206d-4fa1-8aca-a3aaa73c5cf5' }
+
+              context 'and when request is succeeded' do
+                it 'converts a video' do
+                  VCR.use_cassette('conversion_api_convert_video') do
+                    params = {
+                      uuid: uuid,
+                      size: { resize_mode: 'change_ratio', width: '600', height: '400' },
+                      quality: 'best',
+                      format: 'ogg',
+                      cut: { start_time: '0:0:0.0', length: '0:0:1.0' },
+                      thumbs: { N: 2, number: 1 }
+                    }
+                    response = subject.convert_video(params, store: false)
+                    expect(response).to be_success
+                    expect(response.success[:problems]).to be_empty
+                  end
+                end
+
+                it 'gets a video conversion job status' do
+                  VCR.use_cassette('conversion_api_get_video_conversion_status') do
+                    token = '913632082'
+                    response = subject.get_video_conversion_status(token)
+                    expect(response).to be_success
+                    expect(response.success[:error]).to be_nil
+                  end
+                end
+              end
+
+              context 'and when request is failed' do
+                it 'raises a conversion error' do
+                  VCR.use_cassette('conversion_api_convert_video_with_error') do
+                    params = {
+                      uuid: uuid,
+                      size: { resize_mode: 'change_ratio' }
+                    }
+                    expect(subject.convert_video(params, store: false)).to be_failure
+                  end
+                end
+              end
+            end
+
+            context 'and when converting a document' do
+              let(:uuid) { '86c54d9a-3453-4b12-8dcc-49883ae8f084' }
+
+              context 'and when request is succeeded' do
+                it 'converts a document' do
+                  VCR.use_cassette('conversion_api_convert_document') do
+                    params = {
+                      uuid: '86c54d9a-3453-4b12-8dcc-49883ae8f084',
+                      format: 'pdf'
+                    }
+                    response = subject.convert_document(params, store: false)
+                    expect(response).to be_success
+                    expect(response.success[:problems]).to be_empty
+                  end
+                end
+
+                it 'gets a document conversion job status' do
+                  VCR.use_cassette('conversion_api_get_document_conversion_status') do
+                    token = '21201727'
+                    response = subject.get_document_conversion_status(token)
+                    expect(response).to be_success
+                    expect(response.success[:error]).to be_nil
+                  end
+                end
+              end
+
+              context 'and when request is failed' do
+                it 'raises a conversion error' do
+                  VCR.use_cassette('conversion_api_convert_document_with_error') do
+                    params = {
+                      uuid: uuid,
+                      format: 'jpg'
+                    }
+                    expect(subject.convert_document(params, store: false)).to be_failure
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/uploadcare/rails/api/rest/file_api_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/api/rest/file_api'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        RSpec.describe FileApi do
+          subject { Uploadcare::FileApi }
+
+          context 'when checking methods' do
+            it 'responds to expected REST methods' do
+              %i[get_files get_file copy_file delete_file store_file].each do |method|
+                expect(subject).to respond_to(method)
+              end
+            end
+          end
+
+          context 'when sending requests' do
+            it 'gets file info' do
+              VCR.use_cassette('file_api_get_file') do
+                uuid = '5ae54c37-754c-4982-8de4-3f242a88ce17'
+                file = subject.get_file(uuid)
+                expect(file.uuid).to eq(uuid)
+              end
+            end
+
+            it 'gets files info', :aggregate_failures do
+              VCR.use_cassette('file_api_get_files') do
+                response = subject.get_files
+                %w[next previous total per_page results].each do |key|
+                  expect(response).to have_key(key)
+                end
+                expect(response['results']).not_to be_empty
+              end
+            end
+
+            it 'copies a file' do
+              VCR.use_cassette('file_api_copy_file') do
+                uuid = 'd43e8281-a42a-4f30-9fee-4a166998d15a'
+                response = subject.copy_file(uuid, store: false)
+                expect(response['uuid']).not_to be_nil
+                expect(response['uuid']).not_to eq(uuid)
+              end
+            end
+
+            it 'stores a file' do
+              VCR.use_cassette('file_api_store_file') do
+                uuid = '5ae54c37-754c-4982-8de4-3f242a88ce17'
+                response = subject.store_file(uuid)
+                expect(response['uuid']).to eq uuid
+              end
+            end
+
+            it 'deletes a file' do
+              VCR.use_cassette('file_api_delete_file') do
+                uuid = '5ae54c37-754c-4982-8de4-3f242a88ce17'
+                response = subject.delete_file(uuid)
+                expect(response['uuid']).to eq uuid
+              end
+            end
+
+            it 'stores a batch of files' do
+              VCR.use_cassette('file_api_store_files') do
+                uuid = '64215d18-1356-42cb-ab8c-7542290b6e1b'
+                response = subject.store_files([uuid])
+                expect(response['result'].first['uuid']).to eq uuid
+              end
+            end
+
+            it 'stores a batch of files' do
+              VCR.use_cassette('file_api_delete_files') do
+                uuid = '37d70281-cc30-4c59-b8d6-e11c472dec40'
+                response = subject.delete_files([uuid])
+                expect(response['result'].first['uuid']).to eq uuid
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/uploadcare/rails/api/rest/group_api_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/api/rest/group_api'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        RSpec.describe GroupApi do
+          subject { Uploadcare::GroupApi }
+
+          context 'when checking methods' do
+            it 'responds to expected REST methods' do
+              %i[get_groups get_group store_group create_group].each do |method|
+                expect(subject).to respond_to(method)
+              end
+            end
+          end
+
+          context 'when sending requests' do
+            it 'gets group info' do
+              VCR.use_cassette('group_api_get_group') do
+                uuid = '8b1362ed-b477-4a15-819a-2c6bb497d8bd~3'
+                response = subject.get_group(uuid)
+                expect(response['id']).to eq(uuid)
+              end
+            end
+
+            it 'gets groups info', :aggregate_failures do
+              VCR.use_cassette('group_api_get_groups') do
+                response = subject.get_groups
+                %w[next previous total per_page results].each do |key|
+                  expect(response).to have_key(key)
+                end
+                expect(response['results']).not_to be_empty
+              end
+            end
+
+            it 'stores a group' do
+              VCR.use_cassette('group_api_store_group') do
+                uuid = 'aeaeeb8d-43bc-444d-954f-a171fd872e58~2'
+                response = subject.store_group(uuid)
+                expect(response['id']).to eq(uuid)
+              end
+            end
+
+            it 'creates a group' do
+              VCR.use_cassette('group_api_create_group') do
+                file_ids = %w[f55fcc80-58c1-42eb-9e8f-54d500296d38 4a6ef027-d4cd-49be-a383-8cdbe503aa03]
+
+                response = subject.create_group(file_ids.map { |f| "#{f}/resize/x600" })
+                expect(response['files'].map { |f| f['file_id'] }).to contain_exactly(*file_ids)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/uploadcare/rails/api/rest/project_api_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/api/rest/project_api'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        RSpec.describe ProjectApi do
+          subject { Uploadcare::ProjectApi }
+
+          context 'when checking methods' do
+            it 'responds to expected REST methods' do
+              expect(subject).to respond_to('get_project')
+            end
+          end
+
+          context 'when sending requests', :aggregate_failures do
+            it 'gets project info' do
+              VCR.use_cassette('project_api_get_project') do
+                response = subject.get_project
+                %w[collaborators name pub_key autostore_enabled].each do |key|
+                  expect(response).to have_key(key)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/uploadcare/rails/api/rest/webhook_api_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'uploadcare/rails/api/rest/webhook_api'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        RSpec.describe WebhookApi do
+          subject { Uploadcare::WebhookApi }
+
+          context 'when checking methods' do
+            it 'responds to expected REST methods' do
+              %i[get_webhooks create_webhook update_webhook delete_webhook].each do |method|
+                expect(subject).to respond_to(method)
+              end
+            end
+          end
+
+          context 'when sending requests', :aggregate_failures do
+            it 'gets webhooks info' do
+              VCR.use_cassette('webhook_api_get_webhooks') do
+                response = subject.get_webhooks
+                expect(response).not_to be_empty
+              end
+            end
+
+            it 'creates a webhook', :aggregate_failures do
+              VCR.use_cassette('webhook_api_create_webhook') do
+                response = subject.create_webhook('https://ucarecdn.com/3542c513-5cf4-4adb-97b0-bfa7fbd31fb5/11.png')
+                %w[id created updated event target_url project is_active].each do |key|
+                  expect(response).to have_key(key)
+                end
+              end
+            end
+
+            it 'updates a webhook', :aggregate_failures do
+              VCR.use_cassette('webhook_api_update_webhook') do
+                new_target_url = 'https://ucarecdn.com/3542c513-5cf4-4adb-97b0-bfa7fbd31fb5/11.png'
+                response = subject.update_webhook('811134', target_url: new_target_url, is_active: false)
+                expect(response['target_url']).to eq(new_target_url)
+                expect(response['is_active']).to eq(false)
+              end
+            end
+
+            it 'deletes a webhook', :aggregate_failures do
+              VCR.use_cassette('webhook_api_delete_webhook') do
+                target_url = 'https://ucarecdn.com/3542c513-5cf4-4adb-97b0-bfa7fbd31fb5/11.png'
+                response = subject.delete_webhook(target_url)
+                expect(response).to be_success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end