resizing 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8fa9990c253b1b932fb5b2c599aa93f045ad22dafbeef6e5b2d298f6fa1a59e
-  data.tar.gz: c58047443368aee638f48b0b4c899fcbd8a79b73c111655942ffa63ef73f9d74
+  metadata.gz: f294d5e861e1eea2b9e47c22b5fbb72bbd2ef194b73543a24cf030473f5876ac
+  data.tar.gz: 51086d5f4785f7071128b0ccb62841a8527aaccebf456543b95ef090eb52f383
 SHA512:
-  metadata.gz: 0d287c87564b117378394d19d4c5e5172afa056b1865ba9f4e54e4d9811aa70a88e6e70b5e76b720c06c5f6731d040350d08f4170a336e9bffc325f815de8ea9
-  data.tar.gz: 5b4a247eb8747d23632c65c078a338a8db3dfc5db9cceffce67845941dbf36386ac981f93f90203b155afdee39e14b156d5adc7dba5766710464ffd96bf0eb20
+  metadata.gz: 6de5db8c05e6c2d7eff10d7315ad4300dd20e6a1a2d88b418f0486bd1310f23090b750ae42eb63d86ab2deda5bf3e49650b841ccacc63567f08da40a4c747728
+  data.tar.gz: cede047a60662714f51ba182251cb85280db895e83de00c498e6fa8c9c19d7302ac6132f7772ebc8b902ee711a173a833950267f6a2c9092c1f21a53f486d6db

data/.github/workflows/test.yml

@@ -7,22 +7,24 @@ on:
       - master
 
 permissions:
-  id-token: write # This is required for requesting the JWT
+  id-token: write # This is required for codecov/codecov-action
   contents: read  # This is required for actions/checkout
 
 jobs:
   test:
-    name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+    name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Faraday ${{ matrix.faraday }}
     strategy:
       fail-fast: false
       matrix:
         ruby: ['3.1']
         rails: ['6.1', '7.0']
+        faraday: ['1.0', '2.0']
 
     runs-on: ubuntu-22.04
 
     env:
       RAILS_VERSION: ${{ matrix.rails }}
+      FARADAY_VERSION: ${{ matrix.faraday }}
 
     steps:
       - uses: actions/checkout@v4
@@ -51,6 +53,10 @@ jobs:
         run: |
           bundle install
 
+      - name: Show Faraday version
+        run: |
+          bundle list | grep faraday
+
       - name: Run test
         run: |
           bundle exec rake test

data/.gitignore

@@ -6,3 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+vendor/
+Gemfile.lock
+tags
+sample1.jpg
+.ruby-version
+uploads/

data/Gemfile

@@ -9,8 +9,12 @@ gemspec
 rails_version = ENV['RAILS_VERSION'] || '7.0'
 gem 'rails', "~> #{rails_version}"
 
-gem 'rake', '~> 13.0'
+# Allow testing against different Faraday versions
+faraday_version = ENV['FARADAY_VERSION'] || '2.0'
+gem 'faraday', "~> #{faraday_version}"
+
+gem 'byebug'
 gem 'github_changelog_generator'
 gem 'mysql2'
-gem 'byebug'
 gem 'pry-byebug'
+gem 'rake', '~> 13.0'

data/README.md

@@ -1,8 +1,14 @@
 # Resizing
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/resizing`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://img.shields.io/gem/v/resizing.svg)](https://rubygems.org/gems/resizing)
+[![test](https://github.com/jksy/resizing-gem/actions/workflows/test.yml/badge.svg)](https://github.com/jksy/resizing-gem/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/jksy/resizing-gem/graph/badge.svg)](https://codecov.io/gh/jksy/resizing-gem)
 
-TODO: Delete this and the text above, and describe your gem
+Client and utilities for [Resizing](https://www.resizing.net/) - an image hosting and transformation service.
+
+## Requirements
+
+- Ruby 3.1.0 or later
 
 ## Installation
 
@@ -20,37 +26,59 @@ Or install it yourself as:
 
     $ gem install resizing
 
+## Configuration
+
+```ruby
+Resizing.configure = {
+  image_host: 'https://img.resizing.net',
+  video_host: 'https://video.resizing.net',
+  project_id: 'your-project-id',
+  secret_token: 'your-secret-token'
+}
+```
+
 ## Usage
 
+### Basic Client Usage
+
+```ruby
+# Initialize client
+client = Resizing::Client.new
+
+# Upload image to resizing
+file = File.open('sample.jpg', 'r')
+response = client.post(file)
+# => {
+#      "id"=>"a4ed2bf0-a4cf-44fa-9c82-b53e581cb469",
+#      "project_id"=>"098a2a0d-0000-0000-0000-000000000000",
+#      "content_type"=>"image/jpeg",
+#      "latest_version_id"=>"LJY5bxBF7Ryxfr5kC1F.63W8bzp3pcUm",
+#      "latest_etag"=>"\"190143614e6c342637584f46f18f8c58\"",
+#      "created_at"=>"2020-05-15T15:33:10.711Z",
+#      "updated_at"=>"2020-05-15T15:33:10.711Z",
+#      "url"=>"/projects/098a2a0d-0000-0000-0000-000000000000/upload/images/a4ed2bf0-a4cf-44fa-9c82-b53e581cb469"
+#    }
+
+# Generate transformation URL
+image_id = response['id']
+transformation_url = Resizing.url_from_image_id(image_id, nil, ['w_200', 'h_300'])
+# => "https://img.resizing.net/projects/.../upload/images/.../w_200,h_300"
 ```
-  # initialize client
-  options = {
-    project_id: '098a2a0d-0000-0000-0000-000000000000',
-    secret_token: '4g1cshg......rbs6'
-  }
-  client = Resizing::Client.new(options)
-
-  # upload image to resizing
-  file = File.open('sample.jpg', 'r')
-  response = client.post(file)
-  => {
-       "id"=>"a4ed2bf0-a4cf-44fa-9c82-b53e581cb469",
-       "project_id"=>"098a2a0d-0000-0000-0000-000000000000",
-       "content_type"=>"image/jpeg",
-       "latest_version_id"=>"LJY5bxBF7Ryxfr5kC1F.63W8bzp3pcUm",
-       "latest_etag"=>"\"190143614e6c342637584f46f18f8c58\"",
-       "created_at"=>"2020-05-15T15:33:10.711Z",
-       "updated_at"=>"2020-05-15T15:33:10.711Z",
-       "url"=>"/projects/098a2a0d-0000-0000-0000-000000000000/upload/images/a4ed2bf0-a4cf-44fa-9c82-b53e581cb469"
-     }
-
-  name = response['url']
-  # get transformation url
-  name = response['url']
-  transform = {width: 200, height: 300}
-
-  transformation_url = Resizing.url(name, transform)
-  => "https://www.resizing.net/projects/098a2a0d-0000-0000-0000-000000000000/upload/images/a4ed2bf0-a4cf-44fa-9c82-b53e581cb469/width_200,height_300"
+
+### CarrierWave Integration
+
+```ruby
+class ImageUploader < CarrierWave::Uploader::Base
+  include Resizing::CarrierWave
+
+  version :list_smallest do
+    process resize_to_fill: [200, 200]
+  end
+end
+
+class User
+  mount_uploader :image, ImageUploader
+end
 ```
 
 ## Development
@@ -61,8 +89,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jksy/resizing.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/jksy/resizing-gem.
 
 ## License
 

data/lib/resizing/active_storage/service/resizing_service.rb

@@ -8,10 +8,12 @@ module Resizing
       # ref.
       # https://github.com/rails/rails/blob/master/activestorage/lib/active_storage/service/s3_service.rb
       #
-      # rubocop:disable Lint/UnusedMethodArgument,Metrics/ParameterLists
+      # rubocop:disable Metrics/ParameterLists
       class ResizingService < ::ActiveStorage::Service
         # def initialize(bucket:, upload: {}, public: false, **options)
+        # rubocop:disable Lint/MissingSuper
         def initialize; end
+        # rubocop:enable Lint/MissingSuper
 
         def upload(_key, _io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
           raise NotImplementedError, 'upload is not implemented'
@@ -53,7 +55,7 @@ module Resizing
           raise NotImplementedError, 'public_url is not implemented'
         end
       end
-      # rubocop:enable Lint/UnusedMethodArgument,Metrics/ParameterLists
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/resizing/carrier_wave/storage/file.rb

@@ -3,6 +3,7 @@
 module Resizing
   module CarrierWave
     module Storage
+      # rubocop:disable Metrics/ClassLength
       class File
         include ::CarrierWave::Utilities::Uri
 
@@ -28,6 +29,7 @@ module Resizing
           @content_type || file.try(:content_type)
         end
 
+        # rubocop:disable Metrics/AbcSize
         def delete
           # Use the identifier from constructor if available, otherwise try to get from model
           if @public_id.present?
@@ -42,22 +44,27 @@ module Resizing
             @public_id = Resizing::PublicId.new(column_value)
           end
 
-          return if @public_id.empty? # do nothing
+          return if @public_id.empty?
 
-          # 以下、既存のコード（変更なし）
           resp = client.delete(@public_id.image_id)
+
+          # NOTE: 削除時のカラムクリアは以下の理由で必要:
+          # - 画像更新時: 古い画像IDと新しい画像IDが異なるため、古い画像削除時に新しいIDを消さないようにする
+          # - 明示的なremove!時: カラムをnilにする必要がある
+          # - clear_column_if_current_imageは削除される画像IDと現在のカラム値を比較して判断
           if resp['error'] == 'ActiveRecord::RecordNotFound' # 404 not found
-            model.send :write_attribute, serialization_column, nil unless model.destroyed?
+            clear_column_if_current_image
             return
           end
 
           if @public_id.image_id == resp['id']
-            model.send :write_attribute, serialization_column, nil unless model.destroyed?
+            clear_column_if_current_image
             return
           end
 
           raise APIError, "raise someone error:#{resp.inspect}"
         end
+        # rubocop:enable Metrics/AbcSize
 
         def extension
           raise NotImplementedError, 'this method is do not used. maybe'
@@ -92,10 +99,16 @@ module Resizing
         end
 
         def current_path
+          # Return the path from @public_id if set (for retrieve scenarios),
+          # otherwise fall back to reading from model
+          return @public_id.to_s if @public_id.present?
+
           @current_path = model.send :read_attribute, serialization_column
         end
         alias path current_path
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
         def store(new_file)
           if new_file.is_a?(self.class)
             # new_file.copy_to(path)
@@ -126,18 +139,23 @@ module Resizing
           @public_id = Resizing::PublicId.new(@response['public_id'])
           @content_type = @response['content_type']
 
-          # force update column
-          # model_class
-          #   .where(primary_key_name => model.send(primary_key_name))
-          #   .update_all(serialization_column=>@public_id)
-
+          # NOTE: 理想的にはStorage::File内でモデルのカラムをいじらず、CarrierWaveに任せるべきだが、
+          # 現在の実装では以下の理由で必要:
+          # - CarrierWaveは write_uploader(column, mounter.identifiers.first) でカラムを更新
+          # - mounter.identifiers -> uploaders.map(&:identifier) -> storage.identifier -> uploader.filename
+          # - resizing-gemの filenameメソッドは read_column を返す（既存のカラム値）
+          # - そのため、CarrierWaveに任せると旧い値が書き戻されてしまう
+          # TODO: これを修正するには、Remote#identifierをオーバーライドして@public_id.to_sを返すか、
+          #       uploader.filenameの実装を変更する必要がある
           # save new value to model class
           model.send :write_attribute, serialization_column, @public_id.to_s
 
           true
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
 
-        def name(options = {})
+        def name(_options = {})
           @public_id = PublicId.new(model.send(:read_attribute, serialization_column))
           CGI.unescape(@public_id.filename)
         end
@@ -170,6 +188,20 @@ module Resizing
           @serialization_column ||= model.send(:_mounter, uploader.mounted_as).send(:serialization_column)
         end
 
+        # Only clear the column if the deleted image is the current one
+        # (not when deleting an old image during update)
+        def clear_column_if_current_image
+          return if model.destroyed?
+
+          current_value = model.send(:read_attribute, serialization_column)
+          current_public_id = Resizing::PublicId.new(current_value)
+
+          # Only clear if the deleted image is the same as the current one
+          return unless current_public_id.image_id == @public_id.image_id
+
+          model.send :write_attribute, serialization_column, nil
+        end
+
         ##
         # client of Resizing
         def client
@@ -222,6 +254,7 @@ module Resizing
         #     "Need to implement #clean_cache! if you want to use #{self.class.name} as a cache storage."
         # end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/resizing/carrier_wave.rb

@@ -4,6 +4,7 @@ require 'resizing/carrier_wave/storage/file'
 require 'resizing/carrier_wave/storage/remote'
 
 module Resizing
+  # rubocop:disable Metrics/ModuleLength
   module CarrierWave
     class Railtie < ::Rails::Railtie
       # Railtie skelton codes
@@ -28,11 +29,20 @@ module Resizing
     def initialize(*args)
       @requested_format = nil
       @default_format = nil
+      @retrieved_identifier = nil
       super
     end
 
+    # Override to store the identifier and set up @file for later use
+    def retrieve_from_store!(identifier)
+      @retrieved_identifier = identifier
+      super
+      # Ensure @file is set up so that remove! can call @file.delete
+      file
+    end
+
     def file
-      file_identifier = identifier || read_column
+      file_identifier = @retrieved_identifier || identifier || read_column
 
       return nil if file_identifier.blank?
 
@@ -46,7 +56,7 @@ module Resizing
 
       transforms = args.map do |version|
         version = version.intern
-        raise "No version is found: #{version}, #{versions.keys} are exists." unless versions.has_key? version
+        raise "No version is found: #{version}, #{versions.keys} are exists." unless versions.key? version
 
         versions[version].transform_string
       end.compact
@@ -110,11 +120,6 @@ module Resizing
       read_column
     end
 
-    def store!
-      # DO NOTHING
-      super
-    end
-
     def serialization_column
       model.send(:_mounter, mounted_as).send(:serialization_column)
     end
@@ -152,7 +157,7 @@ module Resizing
 
     private
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
     def transform_string_from(processor)
       action = processor.first
       value = processor.second
@@ -175,6 +180,7 @@ module Resizing
         "#{key}_#{value}"
       end.compact.join(',')
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/resizing/client.rb

@@ -24,6 +24,7 @@ module Resizing
   #   }
   #
   #++
+  # rubocop:disable Metrics/ClassLength
   class Client
     include Resizing::Constants
     include Resizing::Configurable
@@ -44,7 +45,7 @@ module Resizing
 
       url = build_post_url
       params = {
-        image: Faraday::Multipart::FilePart.new(filename_or_io, options[:content_type], filename)
+        image: Resizing.file_part_class.new(filename_or_io, options[:content_type], filename)
       }
 
       response = handle_faraday_error do
@@ -53,8 +54,7 @@ module Resizing
         end
       end
 
-      result = handle_create_response(response)
-      result
+      handle_create_response(response)
     end
 
     def put(image_id, filename_or_io, options)
@@ -64,7 +64,7 @@ module Resizing
 
       url = build_put_url(image_id)
       params = {
-        image: Faraday::Multipart::FilePart.new(filename_or_io, options[:content_type], filename)
+        image: Resizing.file_part_class.new(filename_or_io, options[:content_type], filename)
       }
 
       response = handle_faraday_error do
@@ -73,8 +73,7 @@ module Resizing
         end
       end
 
-      result = handle_create_response(response)
-      result
+      handle_create_response(response)
     end
 
     def delete(image_id)
@@ -86,8 +85,7 @@ module Resizing
         end
       end
 
-      result = handle_delete_response(response)
-      result
+      handle_delete_response(response)
     end
 
     def metadata(image_id, options = {})
@@ -99,8 +97,7 @@ module Resizing
         end
       end
 
-      result = handle_metadata_response(response, options)
-      result
+      handle_metadata_response(response, options)
     end
 
     private
@@ -114,8 +111,7 @@ module Resizing
     end
 
     def gather_filename(filename_or_io, options)
-      filename = options[:filename]
-      filename ||= filename_or_io.respond_to?(:path) ? File.basename(filename_or_io.path) : nil
+      options[:filename] || (filename_or_io.respond_to?(:path) ? File.basename(filename_or_io.path) : nil)
     end
 
     def build_put_url(image_id)
@@ -140,17 +136,14 @@ module Resizing
       # Accept IO-like objects (StringIO, Tempfile, etc.)
       return if filename_or_io.respond_to?(:read) && filename_or_io.respond_to?(:rewind)
 
-      if filename_or_io.is_a?(String)
-        if File.exist?(filename_or_io)
-          return
-        end
-      end
+      return if filename_or_io.is_a?(String) && File.exist?(filename_or_io)
 
-      raise ArgumentError, "filename_or_io must be a File object, an IO-like object, or a path to a file (#{filename_or_io.class})"
+      raise ArgumentError,
+            "filename_or_io must be a File object, an IO-like object, or a path to a file (#{filename_or_io.class})"
     end
 
     def handle_create_response(response)
-      raise APIError, "No response is returned" if response.nil?
+      raise APIError, 'No response is returned' if response.nil?
 
       case response.status
       when HTTP_STATUS_OK, HTTP_STATUS_CREATED
@@ -161,7 +154,7 @@ module Resizing
     end
 
     def handle_delete_response(response)
-      raise APIError, "No response is returned" if response.nil?
+      raise APIError, 'No response is returned' if response.nil?
 
       case response.status
       when HTTP_STATUS_OK, HTTP_STATUS_NOT_FOUND
@@ -174,24 +167,30 @@ module Resizing
     def handle_metadata_response(response, options = {})
       when_not_found = options[:when_not_found] || nil
 
-      raise APIError, "No response is returned" if response.nil?
+      raise APIError, 'No response is returned' if response.nil?
 
       case response.status
-      when HTTP_STATUS_OK, HTTP_STATUS_NOT_FOUND
+      when HTTP_STATUS_OK
         JSON.parse(response.body)
       when HTTP_STATUS_NOT_FOUND
         raise decode_error_from(response) if when_not_found == :raise
-        nil
+
+        JSON.parse(response.body)
       else
         raise decode_error_from(response)
       end
     end
 
-    def decode_error_from response
-      result = JSON.parse(response.body) rescue {}
+    def decode_error_from(response)
+      result = begin
+        JSON.parse(response.body)
+      rescue StandardError
+        {}
+      end
       err = APIError.new(result['message'] || "invalid http status code #{response.status}")
       err.decoded_body = result
       err
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/resizing/configurable.rb

@@ -2,7 +2,7 @@
 
 module Resizing
   module Configurable
-    def self.included mod
+    def self.included(mod)
       mod.send(:attr_reader, :config)
     end
 

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