resizing 1.0.0.pre → 1.0.2

data/lib/resizing/configuration.rb

@@ -27,12 +27,8 @@ module Resizing
     def initialize(*attrs)
       case attr = attrs.first
       when Hash
-        if attr[:project_id].nil? || attr[:secret_token].nil?
-          raise_configiration_error
-        end
-        if attr[:host].present?
-          raise_configiration_error
-        end
+        raise_configiration_error if attr[:project_id].nil? || attr[:secret_token].nil?
+        raise_configiration_error if attr[:host].present?
 
         initialize_by_hash attr
         return
@@ -41,11 +37,6 @@ module Resizing
       raise_configiration_error
     end
 
-    def host
-      Kernel.warn "[DEPRECATED] The Configuration#host is deprecated. Use Configuration#image_host."
-      self.image_host
-    end
-
     def generate_auth_header
       current_timestamp = Time.now.to_i
       data = [current_timestamp, secret_token].join('|')
@@ -102,13 +93,11 @@ module Resizing
       raise ConfigurationError, 'need hash and some keys like :image_host, video_host, :project_id, :secret_token'
     end
 
+    # rubocop:disable Metrics/AbcSize
     def initialize_by_hash(attr)
-      @image_host = attr[:image_host].dup.freeze || DEFAULT_IMAGE_HOST
-      if attr[:host].present?
-        Kernel.warn "[DEPRECATED] The host on configration is deprecated. Use image_host, video_host" if attr[:host].present?
-        @image_host ||= attr[:host].dup.freeze || DEFAULT_HOST # for backward compatible
-      end
+      raise 'The host on configuration is deprecated. Use image_host, video_host' if attr[:host].present?
 
+      @image_host = attr[:image_host].dup.freeze || DEFAULT_IMAGE_HOST
       @video_host = attr[:video_host].dup.freeze || DEFAULT_VIDEO_HOST
       @project_id = attr[:project_id].dup.freeze
       @secret_token = attr[:secret_token].dup.freeze
@@ -116,5 +105,6 @@ module Resizing
       @response_timeout = attr[:response_timeout] || DEFAULT_RESPONSE_TIMEOUT
       @enable_mock = attr[:enable_mock] || false
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/resizing/http_clientable.rb

@@ -12,14 +12,14 @@ module Resizing
       end
     end
 
-    def handle_faraday_error &block
+    def handle_faraday_error
       yield
     rescue Faraday::TimeoutError => e
       handle_timeout_error e
     end
 
-    def handle_timeout_error error
-      raise APIError.new("TimeoutError: #{error.inspect}")
+    def handle_timeout_error(error)
+      raise APIError, "TimeoutError: #{error.inspect}"
     end
   end
 end

data/lib/resizing/mock_client.rb

@@ -2,12 +2,12 @@
 
 module Resizing
   class MockClient
-    def post(file_or_binary, options = {})
+    def post(_file_or_binary, _options = {})
       r = load_yaml('test/vcr/client/post.yml')
       JSON.parse(r['string'])
     end
 
-    def put(name, file_or_binary, options)
+    def put(name, _file_or_binary, _options)
       r = load_yaml('test/vcr/client/put.yml')
       result = JSON.parse(r['string'])
       # replace name, public_id and version by name argument
@@ -26,7 +26,7 @@ module Resizing
       result
     end
 
-    def metadata(name)
+    def metadata(name, _options = {})
       r = load_yaml('test/vcr/client/metadata.yml')
       result = JSON.parse(r['string'])
       # replace name and public_id by name argument
@@ -34,15 +34,16 @@ module Resizing
       result['public_id'].gsub!(/bfdaf2b3-7ec5-41f4-9caa-d53247dd9666/, name)
       result
     end
+
     private
 
-    def load_yaml filename
+    def load_yaml(filename)
       path = "#{library_root}/#{filename}"
       YAML.load_file(path)['http_interactions'].first['response']['body']
     end
 
     def library_root
-      @library_root ||= File.expand_path('../../../', __FILE__)
+      @library_root ||= File.expand_path('../..', __dir__)
     end
   end
 end

data/lib/resizing/public_id.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Resizing
   class PublicId
-    def initialize public_id
+    def initialize(public_id)
       @public_id = public_id
       parsed
     end
@@ -38,13 +40,12 @@ module Resizing
 
     def parsed
       return nil if @public_id.nil?
+
       unless defined? @parsed
         @parsed = Resizing.separate_public_id(@public_id)
-        raise "type error #{@public_id}" if @parsed == nil
+        raise "type error #{@public_id}" if @parsed.nil?
       end
       @parsed
     end
-
-    private
   end
 end

data/lib/resizing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Resizing
-  VERSION = '1.0.0.pre'
+  VERSION = '1.0.2'
 end

data/lib/resizing.rb

@@ -2,6 +2,7 @@
 
 require 'resizing/version'
 require 'faraday'
+require 'faraday/multipart'
 require 'json'
 
 module Resizing
@@ -14,16 +15,19 @@ module Resizing
   autoload :CarrierWave, 'resizing/carrier_wave'
   autoload :PublicId, 'resizing/public_id'
   autoload :Video, 'resizing/video'
+  autoload :ActiveStorage, 'resizing/active_storage'
 
   class Error < StandardError; end
   class ConfigurationError < Error; end
-  class APIError < Error;
+
+  class APIError < Error
     def decoded_body
       @decoded_body ||= {}
     end
 
     def decoded_body=(value)
       raise ArgumentError, 'The decoded_body is expected to be passed a Hash.' unless value.is_a? Hash
+
       @decoded_body = value
     end
   end
@@ -48,39 +52,39 @@ module Resizing
   end
 
   def self.post(file_or_binary, options)
-    self.client.post file_or_binary, options
+    client.post file_or_binary, options
   end
 
   def self.put(name, file_or_binary, options)
-    self.client.put name, file_or_binary, options
+    client.put name, file_or_binary, options
   end
 
   def self.delete(name)
-    self.client.delete name
+    client.delete name
   end
 
   def self.metadata(name, options)
-    self.client.metadata name, options
+    client.metadata name, options
   end
 
   # TODO: refactoring
   #
   # identifier:
-  # public_id:  /projects/098a2a0d-c387-4135-a071-1254d6d7e70a/upload/images/28c49144-c00d-4cb5-8619-98ce95977b9c/v1Id850..
-  # identifier: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-  # project_id:           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-  # image_id:                                                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-  # version:                                                                                                      ^^^^^^^^^
+  # public_id:  /projects/<project_id>/upload/images/<image_id>/v<version>
+  # identifier: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  # project_id:           ^^^^^^^^^^^^^
+  # image_id:                                        ^^^^^^^^^^
+  # version:                                                      ^^^^^^^^
   def self.generate_identifier
     Resizing.configure.generate_identifier
   end
 
-  def self.separate_public_id public_id
+  def self.separate_public_id(public_id)
     public_id.match('/projects/(?<project_id>[0-9a-f-]+)/upload/images/(?<image_id>[^/]+)(/v(?<version>[^/]+))?')
   end
 
   def self.client
-    if self.configure.enable_mock
+    if configure.enable_mock
       Resizing::MockClient.new
     else
       Resizing::Client.new

data/resizing.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Client and utilities for Resizing '
   spec.homepage      = 'https://github.com/jksy/resizing-gem'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -25,16 +25,17 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0")
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.add_runtime_dependency 'faraday', '~> 1.0'
-  spec.add_development_dependency 'rails', '~> 6.0'
+  spec.add_development_dependency 'rails', ">= 6.0", '< 7.1'
   spec.add_development_dependency 'carrierwave', '~> 1.3.2'
   spec.add_development_dependency 'fog-aws'
-  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest', '~> 5.16'
   spec.add_development_dependency 'minitest-ci'
+  spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-cobertura'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'vcr'
 end

data/test/resizing/active_storage_service_test.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Resizing
+  module ActiveStorage
+    module Service
+      class ResizingServiceTest < Minitest::Test
+        def setup
+          @service = Resizing::ActiveStorage::Service::ResizingService.new
+        end
+
+        def teardown
+          # NOP
+        end
+
+        def test_service_initialization
+          assert_instance_of Resizing::ActiveStorage::Service::ResizingService, @service
+        end
+
+        def test_upload_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.upload('test_key', StringIO.new('test data'))
+          end
+        end
+
+        def test_download_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.download('test_key')
+          end
+        end
+
+        def test_download_chunk_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.download_chunk('test_key', 0..99)
+          end
+        end
+
+        def test_delete_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.delete('test_key')
+          end
+        end
+
+        def test_exist_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.exist?('test_key')
+          end
+        end
+
+        def test_url_for_direct_upload_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.url_for_direct_upload(
+              'test_key',
+              expires_in: 3600,
+              content_type: 'image/png',
+              conteont_length: 1024,
+              checksum: 'test_checksum'
+            )
+          end
+        end
+
+        def test_headers_for_direct_upload_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.headers_for_direct_upload(
+              'test_key',
+              content_type: 'image/png',
+              checksum: 'test_checksum'
+            )
+          end
+        end
+
+        def test_private_url_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.send(
+              :private_url,
+              'test_key',
+              expires_in: 3600,
+              filename: 'test.png',
+              content_type: 'image/png',
+              disposition: :attachment
+            )
+          end
+        end
+
+        def test_public_url_raises_not_implemented_error
+          assert_raises NotImplementedError do
+            @service.send(
+              :public_url,
+              'test_key',
+              filename: 'test.png'
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/test/resizing/carrier_wave/storage/file_test.rb

@@ -7,22 +7,163 @@ module Resizing
     module Storage
       class FileTest < Minitest::Test
         def setup
-          # NOP
+          @configuration_template = {
+            image_host: 'http://192.168.56.101:5000',
+            video_host: 'http://192.168.56.101:5000',
+            project_id: 'e06e710d-f026-4dcf-b2c0-eab0de8bb83f',
+            secret_token: 'ewbym2r1pk49x1d2lxdbiiavnqp25j2kh00hsg3koy0ppm620x5mhlmgl3rq5ci8',
+            open_timeout: 10,
+            response_timeout: 20
+          }
+          Resizing.configure = @configuration_template
         end
 
         def teardown
           # NOP
         end
 
-        def test_store
-          # f = Resizing::CarrierWave::Storage::File.new(uploader)
-          # upload_file = File.new(uploader, path)
-          # f.store(upload_file)
-          # f.save!
+        def test_initialize_without_identifier
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+          assert_instance_of Resizing::CarrierWave::Storage::File, file
+          assert file.public_id.empty?
+        end
+
+        def test_initialize_with_identifier
+          model = TestModel.new
+          uploader = model.resizing_picture
+          identifier = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+          file = Resizing::CarrierWave::Storage::File.new(uploader, identifier)
+
+          assert_instance_of Resizing::CarrierWave::Storage::File, file
+          assert_equal identifier, file.public_id.to_s
+        end
+
+        def test_retrieve_sets_public_id
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+          identifier = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+
+          file.retrieve(identifier)
+
+          assert_equal identifier, file.public_id.to_s
+        end
+
+        def test_delete_does_nothing_when_public_id_empty
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+          # Should not raise any error and should return early
+          result = file.delete
+          assert_nil result
+        end
+
+        def test_current_path_returns_nil_for_new_model
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+          assert_nil file.current_path
+        end
+
+        def test_path_alias
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+          assert_nil file.current_path
+          assert_nil file.path
+        end
+
+        def test_authenticated_url_returns_nil
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+          assert_nil file.authenticated_url
         end
 
-        def uploader
-          MiniTest::Mock.expect(:cache_path)
+        def test_authenticated_url_with_options_returns_nil
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+          assert_nil file.authenticated_url(expires_in: 3600)
+        end
+
+        def test_extension_raises_not_implemented_error
+          model = TestModel.new
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+          assert_raises(NotImplementedError) do
+            file.extension
+          end
+        end
+
+        def test_name_returns_image_id_from_public_id
+          model = TestModel.new
+          identifier = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+          # Use write_attribute to set the column directly
+          model.send(:write_attribute, :resizing_picture, identifier)
+          uploader = model.resizing_picture
+          file = Resizing::CarrierWave::Storage::File.new(uploader, identifier)
+
+          # name returns image_id (UUID) from public_id
+          assert_equal '14ea7aac-a194-4330-931f-6b562aec413d', file.name
+        end
+
+        def test_store_uploads_file_and_sets_public_id
+          VCR.use_cassette 'carrier_wave_test/save', record: :once do
+            model = TestModel.new
+            uploader = model.resizing_picture
+            file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+            source_file = ::File.open('test/data/images/sample1.jpg', 'r')
+            uploaded_file = ActionDispatch::Http::UploadedFile.new(
+              filename: ::File.basename(source_file.path),
+              type: 'image/jpeg',
+              tempfile: source_file
+            )
+
+            result = file.store(uploaded_file)
+
+            assert result
+            refute file.public_id.empty?
+            assert_equal 'image/jpeg', file.content_type
+          end
+        end
+
+        def test_store_with_file_object
+          VCR.use_cassette 'carrier_wave_test/save', record: :once do
+            model = TestModel.new
+            uploader = model.resizing_picture
+            file = Resizing::CarrierWave::Storage::File.new(uploader)
+
+            source_file = ::File.open('test/data/images/sample1.jpg', 'r')
+
+            result = file.store(source_file)
+
+            assert result
+            refute file.public_id.empty?
+          end
+        end
+
+        def test_delete_with_valid_public_id
+          VCR.use_cassette 'carrier_wave_test/remove_resizing_picture' do
+            model = TestModel.new
+            identifier = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+            model.send(:write_attribute, :resizing_picture, identifier)
+            uploader = model.resizing_picture
+            file = Resizing::CarrierWave::Storage::File.new(uploader, identifier)
+
+            # This should call delete on Resizing API
+            file.delete
+          end
         end
       end
     end

data/test/resizing/carrier_wave/storage/remote_test.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Resizing
+  module CarrierWave
+    module Storage
+      class RemoteTest < Minitest::Test
+        def setup
+          @configuration_template = {
+            image_host: 'http://192.168.56.101:5000',
+            video_host: 'http://192.168.56.101:5000',
+            project_id: 'e06e710d-f026-4dcf-b2c0-eab0de8bb83f',
+            secret_token: 'ewbym2r1pk49x1d2lxdbiiavnqp25j2kh00hsg3koy0ppm620x5mhlmgl3rq5ci8',
+            open_timeout: 10,
+            response_timeout: 20
+          }
+          Resizing.configure = @configuration_template
+
+          model = TestModel.new
+          @uploader = model.resizing_picture
+          @storage = Remote.new(@uploader)
+        end
+
+        def teardown
+          # NOP
+        end
+
+        def test_storage_has_required_methods
+          assert_respond_to @storage, :store!
+          assert_respond_to @storage, :remove!
+          assert_respond_to @storage, :cache!
+          assert_respond_to @storage, :retrieve_from_cache!
+          assert_respond_to @storage, :delete_dir!
+          assert_respond_to @storage, :clean_cache!
+        end
+
+        def test_retrieve_from_cache_returns_nil
+          result = @storage.retrieve_from_cache!('identifier')
+          assert_nil result
+        end
+
+        def test_delete_dir_does_nothing
+          # Should not raise any exception
+          assert_nil @storage.delete_dir!('/path/to/dir')
+        end
+
+        def test_clean_cache_does_nothing
+          # Should not raise any exception
+          assert_nil @storage.clean_cache!(3600)
+        end
+
+        def test_storage_initialization
+          assert_instance_of Remote, @storage
+        end
+
+        def test_retrieve_returns_nil_for_blank_identifier
+          result = @storage.retrieve!(nil)
+          assert_nil result
+
+          result = @storage.retrieve!('')
+          assert_nil result
+        end
+
+        def test_retrieve_returns_file_for_valid_identifier
+          identifier = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+          result = @storage.retrieve!(identifier)
+
+          assert_instance_of Resizing::CarrierWave::Storage::File, result
+          assert_equal identifier, result.public_id.to_s
+        end
+      end
+    end
+  end
+end