resizing 1.0.0.pre → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fff2fe2e1211d6d9b8fc9d399d63df0e1fe7a7f56aca9cc5c4fb045f7877110
-  data.tar.gz: ac9be08e555131de36131bcaca8747d300b951b1ee00c848d85749c0b80b4766
+  metadata.gz: 5da346f4f6420f1f586bc20af1e983e7dfa3d2c12a452a8a3493efff172b2cb6
+  data.tar.gz: 5e37eb4217eb0b71562fa49f8e4c5bcb9392b84d589bf0e88b6507a437208778
 SHA512:
-  metadata.gz: b076ac07bf0c60a9a8a8af0bf18536e78b20fe9faa2565b5c79e41fbcf1f66207be30b14e92b31e8c0af3cc05d4c5589db40d9e5dbd7574343ecee10d4121b65
-  data.tar.gz: 46c7f5303f4cf0620d0205d01c68d74a483b025918cffda9ca42207c656c6fc8cfc40c6843349181aeef170aaeeffe1e93c558aacccd98ad82f9c071ea183318
+  metadata.gz: becfa5580edcf664eef716cb15e2e511872ef1360e81b8218e296ac14f031b05cb3bc2b70d6876247baaedc8cf03571cd8987c8149af15bd7e3e8441ca17040c
+  data.tar.gz: fb7c57ece63ce14d5fe33f8a8e0e479e68becea5edd9e23b17a4a28cbe618183bc6a4d9c442dfdbd8da5cb04e570adb8c25362c6e24ad83e22487d1ba5cacecb

data/.github/workflows/test.yml

@@ -0,0 +1,61 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+permissions:
+  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 }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.1']
+        rails: ['6.1', '7.0']
+
+    runs-on: ubuntu-22.04
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: mirromutth/mysql-action@v1.1
+        with:
+          host port: 3306
+          container port: 3306
+          character set server: 'utf8mb4'
+          collation server: 'utf8mb4_general_ci'
+          mysql version: '5.7'
+          mysql database: 'resizing_gem_test'
+          mysql root password: secret
+
+      - name: "Install ruby dependencies"
+        run: |
+          sudo apt update
+          sudo apt install -y libyaml-dev curl libmysqlclient-dev
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: false
+
+      - name: bundle install
+        run: |
+          bundle install
+
+      - name: Run test
+        run: |
+          bundle exec rake test
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

data/Gemfile

@@ -5,8 +5,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in resizing.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+# Allow testing against different Rails versions
+rails_version = ENV['RAILS_VERSION'] || '7.0'
+gem 'rails', "~> #{rails_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

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
+require 'active_storage/service'
+
 module Resizing
   module ActiveStorage
     module Service
       # 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'
@@ -51,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/active_storage/service.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Resizing
+  module ActiveStorage
+    module Service
+      autoload :ResizingService, 'resizing/active_storage/service/resizing_service'
+    end
+  end
+end

data/lib/resizing/active_storage.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Resizing
+  module ActiveStorage
+    autoload :Service, 'resizing/active_storage/service'
+  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,10 +29,24 @@ module Resizing
           @content_type || file.try(:content_type)
         end
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def delete
-          @public_id = Resizing::PublicId.new(model.send :read_attribute, serialization_column)
+          # Use the identifier from constructor if available, otherwise try to get from model
+          if @public_id.present?
+            # Already set from constructor or retrieve
+          elsif model.respond_to?(:attribute_was)
+            # Try to get the value before changes (for remove! scenario)
+            column_value = model.attribute_was(serialization_column) || model.send(:read_attribute,
+                                                                                   serialization_column)
+            @public_id = Resizing::PublicId.new(column_value)
+          else
+            column_value = model.send(:read_attribute, serialization_column)
+            @public_id = Resizing::PublicId.new(column_value)
+          end
+
           return if @public_id.empty? # do nothing
 
+          # 以下、既存のコード（変更なし）
           resp = client.delete(@public_id.image_id)
           if resp['error'] == 'ActiveRecord::RecordNotFound' # 404 not found
             model.send :write_attribute, serialization_column, nil unless model.destroyed?
@@ -45,6 +60,7 @@ module Resizing
 
           raise APIError, "raise someone error:#{resp.inspect}"
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         def extension
           raise NotImplementedError, 'this method is do not used. maybe'
@@ -83,30 +99,30 @@ module Resizing
         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)
             raise NotImplementedError, 'new file is required duplicating'
           end
 
-          if new_file.respond_to? :content_type
-            @content_type ||= new_file.content_type
-          else
-            # guess content-type from extension
-            @content_type ||= MIME::Types.type_for(new_file.path).first.content_type
-          end
+          @content_type ||= if new_file.respond_to? :content_type
+                              new_file.content_type
+                            else
+                              # guess content-type from extension
+                              MIME::Types.type_for(new_file.path).first.content_type
+                            end
 
           original_filename = new_file.try(:original_filename) || new_file.try(:filename) || new_file.try(:path)
-          if original_filename.present?
-            original_filename = ::File.basename(original_filename)
-          end
+          original_filename = ::File.basename(original_filename) if original_filename.present?
 
           content = if new_file.respond_to?(:to_io)
                       new_file.to_io.tap(&:rewind)
                     elsif new_file.respond_to?(:read) && new_file.respond_to?(:rewind)
-                      new_file.read.tap do
-                        new_file.rewind
-                      end
+                      # Pass the IO object itself, not the read result
+                      new_file.rewind
+                      new_file
                     else
                       new_file
                     end
@@ -125,9 +141,11 @@ module Resizing
 
           true
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
 
-        def name(options = {})
-          @public_id = PublicId.new(model.send :read_attribute, serialization_column)
+        def name(_options = {})
+          @public_id = PublicId.new(model.send(:read_attribute, serialization_column))
           CGI.unescape(@public_id.filename)
         end
 
@@ -138,6 +156,7 @@ module Resizing
         def retrieve(identifier)
           @public_id = Resizing::PublicId.new(identifier)
         end
+
         private
 
         attr_reader :uploader
@@ -195,7 +214,6 @@ module Resizing
           parameters.count == 2 && parameters[1].include?(:options)
         end
 
-
         # def retrieve_from_cache!(identifier)
         #   raise NotImplementedError,
         #     "Need to implement #retrieve_from_cache! if you want to use #{self.class.name} as a cache storage."
@@ -211,6 +229,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/storage/remote.rb

@@ -18,9 +18,13 @@ module Resizing
           f
         end
 
-        # def retrieve!(identifier)
-        #   super
-        # end
+        def retrieve!(identifier)
+          return nil if identifier.blank?
+
+          f = Resizing::CarrierWave::Storage::File.new(uploader, identifier)
+          f.retrieve(identifier)
+          f
+        end
 
         def cache!(new_file)
           f = Resizing::CarrierWave::Storage::File.new(uploader)

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
@@ -32,11 +33,12 @@ module Resizing
     end
 
     def file
-      return if identifier.nil?
-      return @file unless defined? @file
+      file_identifier = identifier || read_column
+
+      return nil if file_identifier.blank?
 
       @file ||= Resizing::CarrierWave::Storage::File.new(self)
-      @file.retrieve(identifier)
+      @file.retrieve(file_identifier)
       @file
     end
 
@@ -45,7 +47,8 @@ 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
 
@@ -108,11 +111,6 @@ module Resizing
       read_column
     end
 
-    def store!
-      # DO NOTHING
-      super
-    end
-
     def serialization_column
       model.send(:_mounter, mounted_as).send(:serialization_column)
     end
@@ -150,7 +148,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
@@ -173,6 +171,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
@@ -37,16 +38,14 @@ module Resizing
       raise NotImplementedError
     end
 
-    def post(file_or_binary, options = {})
+    def post(filename_or_io, options = {})
       ensure_content_type(options)
+      ensure_filename_or_io(filename_or_io)
+      filename = gather_filename filename_or_io, options
 
       url = build_post_url
-
-      filename = gather_filename file_or_binary, options
-
-      body = to_io(file_or_binary)
       params = {
-        image: Faraday::UploadIO.new(body, options[:content_type], filename)
+        image: Faraday::Multipart::FilePart.new(filename_or_io, options[:content_type], filename)
       }
 
       response = handle_faraday_error do
@@ -55,20 +54,17 @@ module Resizing
         end
       end
 
-      result = handle_create_response(response)
-      result
+      handle_create_response(response)
     end
 
-    def put(image_id, file_or_binary, options)
+    def put(image_id, filename_or_io, options)
       ensure_content_type(options)
+      ensure_filename_or_io(filename_or_io)
+      filename = gather_filename filename_or_io, options
 
       url = build_put_url(image_id)
-
-      filename = gather_filename file_or_binary, options
-
-      body = to_io(file_or_binary)
       params = {
-        image: Faraday::UploadIO.new(body, options[:content_type], filename)
+        image: Faraday::Multipart::FilePart.new(filename_or_io, options[:content_type], filename)
       }
 
       response = handle_faraday_error do
@@ -77,8 +73,7 @@ module Resizing
         end
       end
 
-      result = handle_create_response(response)
-      result
+      handle_create_response(response)
     end
 
     def delete(image_id)
@@ -90,8 +85,7 @@ module Resizing
         end
       end
 
-      result = handle_delete_response(response)
-      result
+      handle_delete_response(response)
     end
 
     def metadata(image_id, options = {})
@@ -103,8 +97,7 @@ module Resizing
         end
       end
 
-      result = handle_metadata_response(response, options)
-      result
+      handle_metadata_response(response, options)
     end
 
     private
@@ -117,9 +110,8 @@ module Resizing
       "#{config.image_host}/projects/#{config.project_id}/upload/images/"
     end
 
-    def gather_filename file_or_binary, options
-      filename = options[:filename]
-      filename ||= file_or_binary.respond_to?(:path) ? File.basename(file_or_binary.path) : nil
+    def gather_filename(filename_or_io, options)
+      options[:filename] || (filename_or_io.respond_to?(:path) ? File.basename(filename_or_io.path) : nil)
     end
 
     def build_put_url(image_id)
@@ -134,24 +126,24 @@ module Resizing
       "#{config.image_host}/projects/#{config.project_id}/upload/images/#{image_id}/metadata"
     end
 
+    def ensure_content_type(options)
+      raise ArgumentError, "need options[:content_type] for #{options.inspect}" unless options[:content_type]
+    end
 
-    def to_io(data)
-      return data.to_io if data.respond_to? :to_io
+    def ensure_filename_or_io(filename_or_io)
+      return if filename_or_io.is_a?(File)
 
-      case data
-      when String
-        StringIO.new(data)
-      else
-        raise ArgumentError, "file_or_binary is required IO class or String:#{data.class}"
-      end
-    end
+      # Accept IO-like objects (StringIO, Tempfile, etc.)
+      return if filename_or_io.respond_to?(:read) && filename_or_io.respond_to?(:rewind)
 
-    def ensure_content_type(options)
-      raise ArgumentError, "need options[:content_type] for #{options.inspect}" unless options[:content_type]
+      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})"
     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
@@ -162,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
@@ -175,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