resizing 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8fa9990c253b1b932fb5b2c599aa93f045ad22dafbeef6e5b2d298f6fa1a59e
-  data.tar.gz: c58047443368aee638f48b0b4c899fcbd8a79b73c111655942ffa63ef73f9d74
+  metadata.gz: 5da346f4f6420f1f586bc20af1e983e7dfa3d2c12a452a8a3493efff172b2cb6
+  data.tar.gz: 5e37eb4217eb0b71562fa49f8e4c5bcb9392b84d589bf0e88b6507a437208778
 SHA512:
-  metadata.gz: 0d287c87564b117378394d19d4c5e5172afa056b1865ba9f4e54e4d9811aa70a88e6e70b5e76b720c06c5f6731d040350d08f4170a336e9bffc325f815de8ea9
-  data.tar.gz: 5b4a247eb8747d23632c65c078a338a8db3dfc5db9cceffce67845941dbf36386ac981f93f90203b155afdee39e14b156d5adc7dba5766710464ffd96bf0eb20
+  metadata.gz: becfa5580edcf664eef716cb15e2e511872ef1360e81b8218e296ac14f031b05cb3bc2b70d6876247baaedc8cf03571cd8987c8149af15bd7e3e8441ca17040c
+  data.tar.gz: fb7c57ece63ce14d5fe33f8a8e0e479e68becea5edd9e23b17a4a28cbe618183bc6a4d9c442dfdbd8da5cb04e570adb8c25362c6e24ad83e22487d1ba5cacecb

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ 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:

data/Gemfile

@@ -9,8 +9,8 @@ gemspec
 rails_version = ENV['RAILS_VERSION'] || '7.0'
 gem 'rails', "~> #{rails_version}"
 
-gem 'rake', '~> 13.0'
+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, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def delete
           # Use the identifier from constructor if available, otherwise try to get from model
           if @public_id.present?
@@ -58,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'
@@ -96,6 +99,8 @@ 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)
@@ -136,8 +141,10 @@ module Resizing
 
           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
@@ -222,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.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
@@ -46,7 +47,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 +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
@@ -152,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
@@ -175,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
@@ -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)
@@ -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

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.1'
+  VERSION = '1.0.2'
 end

data/lib/resizing.rb

@@ -19,13 +19,15 @@ module Resizing
 
   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
@@ -50,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

@@ -25,8 +25,6 @@ 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", '< 7.1'
@@ -34,10 +32,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fog-aws'
   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