resizing 1.2.0 → 1.2.1

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.2.0'
+  VERSION = '1.2.1'
 end

data/lib/resizing.rb

@@ -15,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
@@ -49,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,20 +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', '~> 2.3'
   spec.add_runtime_dependency 'faraday-multipart'
-  spec.add_development_dependency 'rails', '> 6.0'
   spec.add_development_dependency 'carrierwave', '~> 2.2.5'
   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 'rubocop'
-  spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'vcr'
   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

data/test/resizing/carrier_wave_test.rb

@@ -4,6 +4,8 @@ require 'test_helper'
 
 module Resizing
   class CarrierWaveTest < Minitest::Test
+    include VCRRequestAssertions
+
     def setup
       TestModel.delete_all
       TestJPGModel.delete_all
@@ -23,24 +25,65 @@ module Resizing
 
     def test_remove_resizing_picture
       model = prepare_model TestModel
+      model.save!
+
+      # VCRカセットのDELETEリクエストが実際に発行されたことを確認
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.remove_resizing_picture!
+        model.save!
+      end
+
+      # DELETEが成功した結果、URLがnilになることを確認
+      assert_nil model.resizing_picture_url
+    end
+
+    def test_remove_calls_delete_immediately
+      model = prepare_model TestModel
+      model.save!
+
+      # remove!を呼んだとき即時にDELETEリクエストがとぶことを確認する
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.resizing_picture.remove!
+      end
+    end
+
+    def test_blank_returns_true_after_remove
+      model = prepare_model TestModel
+      model.save!
 
-      VCR.use_cassette 'carrier_wave_test/remove_resizing_picture' do
-        SecureRandom.stub :uuid, '28c49144-c00d-4cb5-8619-98ce95977b9c' do
-          model.remove_resizing_picture!
+      refute model.resizing_picture.blank?, 'resizing_picture should not be blank before remove'
 
-          assert_nil model.resizing_picture_url
-        end
+      # DELETEリクエストが発行されたことを確認
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.remove_resizing_picture!
+        model.save!
       end
+
+      assert model.resizing_picture.blank?, 'resizing_picture should be blank after remove'
+      assert_nil model.resizing_picture_url
     end
 
-    def test_do_not_raise_if_empty_column_is_removed
+    def test_blank_returns_true_for_new_record
+      model = TestModel.new
+      assert model.resizing_picture.blank?, 'resizing_picture should be blank for new record'
+    end
+
+    def test_remove_resizing_picture_with_flag_and_save
       model = prepare_model TestModel
+      model.save!
+
+      refute model.resizing_picture.blank?, 'resizing_picture should not be blank before remove'
+
+      model.remove_resizing_picture = true
 
-      VCR.use_cassette 'carrier_wave_test/remove_resizing_picture' do
-        SecureRandom.stub :uuid, '28c49144-c00d-4cb5-8619-98ce95977b9c' do
-          model.resizing_picture.remove!
-        end
+      # save時にDELETEリクエストが発行されたことを確認
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.save!
       end
+
+      # DELETEが成功した結果、blank?がtrueになることを確認
+      assert model.resizing_picture.blank?, 'resizing_picture should be blank after save'
+      assert_nil model.resizing_picture_url
     end
 
     def test_picture_url_return_correct_value_and_when_model_reloaded
@@ -84,42 +127,61 @@ module Resizing
     end
 
     def test_is_successful
-      model = prepare_model_with_tempfile TestModel
+      model = TestModel.new
+
+      # POSTリクエストが発行されたことを確認
+      assert_vcr_requests_made 'carrier_wave_test/save' do
+        file = File.open('test/data/images/sample1.jpg', 'r')
+        model.resizing_picture = file
+      end
+
+      assert_equal('http://192.168.56.101:5000/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e/', model.resizing_picture_url)
+    end
+
+    def test_file_returns_same_instance_on_multiple_calls
+      model = prepare_model TestModel
       model.save!
-      # assert_equal('http://192.168.56.101:5000/projects/098a2a0d-c387-4135-a071-1254d6d7e70a/upload/images/28c49144-c00d-4cb5-8619-98ce95977b9c/v1Id850__tqNsnoGWWUibtIBZ5NgjV45M/', model.resizing_picture_url)
+
+      file1 = model.resizing_picture.file
+      file2 = model.resizing_picture.file
+
+      assert_same file1, file2
     end
 
-    def expect_url
-      'http://192.168.56.101:5000/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/'+
-        'upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+    def test_file_returns_nil_for_blank_identifier
+      model = TestModel.new
+      assert_nil model.resizing_picture.file
     end
 
-    def prepare_model model
-      VCR.use_cassette 'carrier_wave_test/save', record: :once do
-        SecureRandom.stub :uuid, '28c49144-c00d-4cb5-8619-98ce95977b9c' do
-          model = model.new
-          file = File.open('test/data/images/sample1.jpg', 'r')
-          uploaded_file = ActionDispatch::Http::UploadedFile.new(
-            filename: File.basename(file.path),
-            type: 'image/jpeg',
-            tempfile: file
-          )
-
-          model.resizing_picture = uploaded_file
-          return model
-        end
-      end
+    def test_file_uses_read_column_when_identifier_nil
+      model = prepare_model TestModel
+      model.save!
+      model.reload
+
+      file = model.resizing_picture.file
+      refute_nil file
+      assert_instance_of Resizing::CarrierWave::Storage::File, file
+    end
+
+    def expect_url
+      'http://192.168.56.101:5000/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/' \
+        'upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
     end
 
-    def prepare_model_with_tempfile model
+    def prepare_model(model)
+      result = nil
       VCR.use_cassette 'carrier_wave_test/save', record: :once do
-        SecureRandom.stub :uuid, '28c49144-c00d-4cb5-8619-98ce95977b9c' do
-          model = model.new
-          file = File.open('test/data/images/sample1.jpg', 'r')
-          model.resizing_picture = file
-          return model
-        end
+        result = model.new
+        file = File.open('test/data/images/sample1.jpg', 'r')
+        uploaded_file = ActionDispatch::Http::UploadedFile.new(
+          filename: File.basename(file.path),
+          type: 'image/jpeg',
+          tempfile: file
+        )
+
+        result.resizing_picture = uploaded_file
       end
+      result
     end
   end
 end