ruby-thumbor 1.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 893a41411617f13eb886aa0623348b8465367c2f
-  data.tar.gz: 4f987bbd23926f386cc6e360a10156007dafb159
+SHA256:
+  metadata.gz: 7f47258a05c0f11cbb6204f06e463613a467ea0dcadfddd971330de2d58202ed
+  data.tar.gz: c510bda2d4a88fdadb96ff5d6e8051070bc80834b0b1c838a1091596f7a4db14
 SHA512:
-  metadata.gz: a7534f13bd29cda443f7b9338bf70b411ae6f4ce2802928d5c83e603272a1e3531f88ce4dd369adca224b2d5b59c7a0cbf1889e5d6097c2ea94f42993f242d28
-  data.tar.gz: 3353dcafc369ea2695b3e2883b7b6400bd63f810ead8557018a4ac313c08cb7dafa6fa5f5e1e1b597980d3c5d2ff9494112b53242d1d843b63ebad8712405ef2
+  metadata.gz: 3b886a1f96d8a9703c24e338a7e469686a05283098bc7bdc9dc9460fd753a233d0afd78df66c3b9e6f5ad344b8d5f87ef113d1d0299c81ade419910d7ca7da36
+  data.tar.gz: 1a1603bc5c9851b4faec33c45852890152d497c01be0c9465c41aa9a0cc3d7b3f17d0aaf156bf4592ecf85b75a30a2d1f839c5600065cb5d96484ef31b636a0f

data/README.md

@@ -0,0 +1,83 @@
+# ruby-thumbor [![Github Actions](https://github.com/thumbor/ruby-thumbor/actions/workflows/main.yml/badge.svg)](https://github.com/thumbor/ruby-thumbor/actions) [![Gem Version](https://badge.fury.io/rb/ruby-thumbor.svg)](https://rubygems.org/gems/ruby-thumbor) [![Coverage Status](https://coveralls.io/repos/thumbor/ruby-thumbor/badge.svg?branch=master&service=github)](https://coveralls.io/github/thumbor/ruby-thumbor?branch=master)
+
+ruby-thumbor is the Ruby client to the thumbor imaging service (http://github.com/thumbor/thumbor).
+
+## Features
+* Generate thumbor encrypted URLs
+* Obtain metadata from image operations in thumbor
+
+## Install
+``` bash
+gem install ruby-thumbor
+```
+
+## Using it
+``` ruby
+require 'ruby-thumbor'
+
+image = Thumbor::Cascade.new('my-security-key', 'remote-image.com/path/to/image.jpg')
+image.width(300).height(200).watermark_filter('http://remote-image.com/path/to/image.jpg', 30).generate
+
+# url will contain something like:
+# /2913921in321n3k2nj32hjhj3h22/remote-image.com/path/to/image.jpg
+
+# Now you just need to concatenate this generated path, with your thumbor server url
+```
+
+### or
+``` ruby
+require 'ruby-thumbor'
+
+crypto = Thumbor::CryptoURL.new 'my-security-key'
+
+url = crypto.generate(width: 200, height: 300, image: 'remote-image.com/path/to/image.jpg')
+```
+
+## Available Thumbor arguments
+``` ruby
+meta: bool # flag that indicates that thumbor should return only meta-data on the operations it would otherwise perform;
+
+crop: [<int>, <int>, <int>, <int>] # Coordinates for manual cropping. The first item is the two arguments are the coordinates for the left, top point and the last two are the coordinates for the right, bottom point (thus forming the square to crop);
+
+width: <int> # the width for the thumbnail;
+
+height: <int> # the height for the thumbnail;
+
+flip: <bool> # flag that indicates that thumbor should flip horizontally (on the vertical axis) the image;
+
+flop: <bool> # flag that indicates that thumbor should flip vertically (on the horizontal axis) the image;
+
+halign: :left, :center or :right # horizontal alignment that thumbor should use for cropping;
+
+valign: :top, :middle or :bottom # horizontal alignment that thumbor should use for cropping;
+
+smart: <bool> # flag that indicates that thumbor should use smart cropping;
+
+filters: ['blur(20)', 'watermark(http://my.site.com/img.png,-10,-10,50)'] # array of filters and their arguments
+```
+
+If you need more info on what each option does, check thumbor's documentation at https://thumbor.readthedocs.io/en/latest/index.html.
+
+## License
+(The MIT License)
+
+Copyright (c) 2022 Bernardo Heynemann <heynemann@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ruby-thumbor.rb

@@ -1,15 +1,7 @@
+# frozen_string_literal: true
+
 require 'thumbor/crypto_url'
 require 'thumbor/cascade'
 
 module Thumbor
-  @@key = nil
-
-  def self.key=(key)
-    @@key = key
-  end
-
-  def self.key
-    @@key
-  end
 end
-

data/lib/thumbor/cascade.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'openssl'
 require 'base64'
@@ -6,20 +8,23 @@ require 'cgi'
 
 module Thumbor
   class Cascade
-    attr_accessor :image, :old_crypto, :options, :filters
+    attr_accessor :image, :crypto, :options, :filters
+
+    FILTER_REGEX = Regexp.new('^(.+)_filter$')
 
-    @available_options = [
-      :meta, :crop, :center,
-      :original_width, :original_height,
-      :width, :height, :flip,
-      :flop, :halign, :valign,
-      :smart, :fit_in, :adaptive_fit_in,
-      :full_fit_in, :adaptive_full_fit_in,
-      :old, :trim]
+    @available_options = %i[
+      meta crop center
+      original_width original_height
+      width height flip
+      flop halign valign
+      smart fit_in adaptive_fit_in
+      full_fit_in adaptive_full_fit_in
+      trim debug
+    ]
 
     extend Forwardable
 
-    def_delegators :@old_crypto, :computed_key
+    def_delegators :@crypto, :computed_key
 
     @available_options.each do |opt|
       define_method(opt) do |*args|
@@ -29,48 +34,48 @@ module Thumbor
       end
     end
 
-    def initialize(image=nil)
+    def initialize(key = nil, image = nil)
+      @key = key
       @image = image
       @options = {}
       @filters = []
-      @old_crypto = Thumbor::CryptoURL.new Thumbor.key
-    end
-
-    def url_for
-      @old_crypto.url_for prepare_options(@options).merge({image: @image, filters: @filters})
+      @crypto = Thumbor::CryptoURL.new @key
     end
 
     def generate
-      @old_crypto.generate prepare_options(@options).merge({image: @image, filters: @filters})
+      @crypto.generate prepare_options(@options).merge({ image: @image, filters: @filters })
     end
 
-    def method_missing(m, *args)
-      if /^(.+)_filter$/.match(m.to_s)
-        @filters << "#{$1}(#{escape_args(args).join(',')})"
+    def method_missing(method, *args)
+      if method =~ FILTER_REGEX
+        @filters << "#{FILTER_REGEX.match(method)[1]}(#{escape_args(args).join(',')})"
         self
       else
         super
       end
     end
 
+    def respond_to_missing?(method, include_private = false)
+      method =~ FILTER_REGEX || super
+    end
+
     private
 
     def escape_args(args)
       args.map do |arg|
-        arg = CGI::escape(arg) if arg.is_a? String and arg.match(/^https?:\/\//)
+        arg = CGI.escape(arg) if arg.is_a?(String) && arg.match(%r{^https?://})
         arg
       end
     end
 
     def prepare_options(options)
-      options.reduce({}) do |final_options, item|
+      options.each_with_object({}) do |item, final_options|
         value = if item[1].length == 1
-          item[1].first
-        else
-          item[1]
-        end
+                  item[1].first
+                else
+                  item[1]
+                end
         final_options[item[0]] = value
-        final_options
       end
     end
   end

data/lib/thumbor/crypto_url.rb

@@ -1,240 +1,192 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'base64'
 require 'digest/md5'
 require 'cgi'
 
 module Thumbor
-    class CryptoURL
-        attr_accessor :computed_key
-
-        def initialize(key)
-            Thumbor.key = key
-        end
-
-        def computed_key
-            (Thumbor.key * 16)[0..15]
-        end
+  class CryptoURL
+    def initialize(key = nil)
+      @key = key
+    end
 
-        def pad(s)
-            s + ("{" * (16 - s.length % 16))
-        end
+    def calculate_width_and_height(url_parts, options)
+      width = options[:width]
+      height = options[:height]
+
+      width *= -1 if width && options[:flip]
+      height *= -1 if height && options[:flop]
+
+      if width || height
+        width ||= 0
+        height ||= 0
+      end
+
+      has_width = width
+      has_height = height
+      if options[:flip] && !has_width && !has_height
+        width = '-0'
+        height = '0' if !has_height && !(options[:flop])
+      end
+      if options[:flop] && !has_width && !has_height
+        height = '-0'
+        width = '0' if !has_width && !(options[:flip])
+      end
+
+      url_parts.push("#{width}x#{height}") if width || height
+    end
 
-        def calculate_width_and_height(url_parts, options)
-            width = options[:width]
-            height = options[:height]
-
-            if width and options[:flip]
-                width = width * -1
-            end
-            if height and options[:flop]
-                height = height * -1
-            end
-
-            if width or height
-                width = 0 if not width
-                height = 0 if not height
-            end
-
-            has_width = width
-            has_height = height
-            if options[:flip] and not has_width and not has_height
-                width = "-0"
-                height = '0' if not has_height and not options[:flop]
-            end
-            if options[:flop] and not has_width and not has_height
-                height = "-0"
-                width = '0' if not has_width and not options[:flip]
-            end
-
-            if width or height
-                width = width.to_s
-                height = height.to_s
-                url_parts.push(width << 'x' << height)
-            end
+    def calculate_centered_crop(options)
+      width = options[:width]
+      height = options[:height]
+      original_width = options[:original_width]
+      original_height = options[:original_height]
+      center = options[:center]
+
+      return unless original_width &&
+                    original_height &&
+                    center &&
+                    (width || height)
+
+      raise 'center must be an array of x,y' unless center.is_a?(Array) && center.length == 2
+
+      center_x, center_y = center
+      width ||= original_width
+      height ||= original_height
+      width = width.abs
+      height = height.abs
+      new_aspect_ratio = width / height.to_f
+      original_aspect_ratio = original_width / original_height.to_f
+
+      crop = nil
+      # We're going wider, vertical crop
+      if new_aspect_ratio > original_aspect_ratio
+        # How tall should we be? because new_aspect_ratio is > original_aspect_ratio we can be sure
+        # that cropped_height is always less than original_height (original). This is assumed below.
+        cropped_height = (original_width / new_aspect_ratio).round
+        # Calculate coordinates around center
+        top_crop_point = (center_y - (cropped_height * 0.5)).round
+        bottom_crop_point = (center_y + (cropped_height * 0.5)).round
+
+        # If we've gone above the top of the image, take all from the bottom
+        if top_crop_point.negative?
+          top_crop_point = 0
+          bottom_crop_point = cropped_height
+        # If we've gone below the top of the image, take all from the top
+        elsif bottom_crop_point > original_height
+          top_crop_point = original_height - cropped_height
+          bottom_crop_point = original_height
+          # Because cropped_height < original_height, top_crop_point and
+          # bottom_crop_point will never both be out of bounds
         end
 
-        def calculate_centered_crop(options)
-            width = options[:width]
-            height = options[:height]
-            original_width = options[:original_width]
-            original_height = options[:original_height]
-            center = options[:center]
-
-            return unless original_width &&
-                            original_height &&
-                            center &&
-                            (width || height)
-
-            unless center.kind_of?(Array) && center.length == 2
-                raise 'center must be an array of x,y'
-            end
-
-            center_x, center_y = center
-            width ||= original_width
-            height ||= original_height
-            width = width.abs
-            height = height.abs
-            new_aspect_ratio = width / height.to_f
-            original_aspect_ratio = original_width/original_height.to_f
-
-            crop = nil
-            # We're going wider, vertical crop
-            if new_aspect_ratio > original_aspect_ratio
-              # How tall should we be? because new_aspect_ratio is > original_aspect_ratio we can be sure
-              # that cropped_height is always less than original_height (original). This is assumed below.
-              cropped_height = (original_width / new_aspect_ratio).round
-              # Calculate coordinates around center
-              top_crop_point = (center_y - (cropped_height * 0.5)).round
-              bottom_crop_point = (center_y + (cropped_height * 0.5)).round
-
-              # If we've gone above the top of the image, take all from the bottom
-              if top_crop_point < 0
-                top_crop_point = 0
-                bottom_crop_point = cropped_height
-              # If we've gone below the top of the image, take all from the top
-              elsif bottom_crop_point > original_height
-                top_crop_point = original_height - cropped_height
-                bottom_crop_point = original_height
-              # Because cropped_height < original_height, top_crop_point and
-              # bottom_crop_point will never both be out of bounds
-              end
-
-              # Put it together
-              crop = [0, top_crop_point, original_width, bottom_crop_point]
-            # We're going taller, horizontal crop
-            elsif new_aspect_ratio < original_aspect_ratio
-              # How wide should we be? because new_aspect_ratio is < original_aspect_ratio we can be sure
-              # that cropped_width is always less than original_width (original). This is assumed below.
-              cropped_width = (original_height * new_aspect_ratio).round
-              # Calculate coordinates around center
-              left_crop_point = (center_x - (cropped_width * 0.5)).round
-              right_crop_point = (center_x + (cropped_width * 0.5)).round
-
-              # If we've gone beyond the left of the image, take all from the right
-              if left_crop_point < 0
-                left_crop_point = 0
-                right_crop_point = cropped_width
-              # If we've gone beyond the right of the image, take all from the left
-              elsif right_crop_point > original_width
-                left_crop_point = original_width - cropped_width
-                right_crop_point = original_width
-              # Because cropped_width < original_width, left_crop_point and
-              # right_crop_point will never both be out of bounds
-              end
-
-              # Put it together
-              crop = [left_crop_point, 0, right_crop_point, original_height]
-            end
-
-            options[:crop] = crop
+        # Put it together
+        crop = [0, top_crop_point, original_width, bottom_crop_point]
+      # We're going taller, horizontal crop
+      elsif new_aspect_ratio < original_aspect_ratio
+        # How wide should we be? because new_aspect_ratio is < original_aspect_ratio we can be sure
+        # that cropped_width is always less than original_width (original). This is assumed below.
+        cropped_width = (original_height * new_aspect_ratio).round
+        # Calculate coordinates around center
+        left_crop_point = (center_x - (cropped_width * 0.5)).round
+        right_crop_point = (center_x + (cropped_width * 0.5)).round
+
+        # If we've gone beyond the left of the image, take all from the right
+        if left_crop_point.negative?
+          left_crop_point = 0
+          right_crop_point = cropped_width
+        # If we've gone beyond the right of the image, take all from the left
+        elsif right_crop_point > original_width
+          left_crop_point = original_width - cropped_width
+          right_crop_point = original_width
+          # Because cropped_width < original_width, left_crop_point and
+          # right_crop_point will never both be out of bounds
         end
 
-        def url_for(options, include_hash = true)
-            if not options[:image]
-                raise 'image is a required argument.'
-            end
-
-            url_parts = Array.new
+        # Put it together
+        crop = [left_crop_point, 0, right_crop_point, original_height]
+      end
 
-            if options[:trim]
-                trim_options  = ['trim']
-                trim_options << options[:trim] unless options[:trim] == true or options[:trim][0] == true
-                url_parts.push(trim_options.join(':'))
-            end
+      options[:crop] = crop
+    end
 
-            if options[:meta]
-                url_parts.push('meta')
-            end
+    def url_for(options)
+      raise 'image is a required argument.' unless options[:image]
 
-            calculate_centered_crop(options)
+      url_parts = []
 
-            crop = options[:crop]
-            if crop
-                crop_left = crop[0]
-                crop_top = crop[1]
-                crop_right = crop[2]
-                crop_bottom = crop[3]
+      url_parts.push('debug') if options[:debug]
 
-                if crop_left > 0 or crop_top > 0 or crop_bottom > 0 or crop_right > 0
-                    url_parts.push(crop_left.to_s << 'x' << crop_top.to_s << ':' << crop_right.to_s << 'x' << crop_bottom.to_s)
-                end
-            end
+      if options[:trim]
+        trim_options = ['trim']
+        trim_options << options[:trim] unless (options[:trim] == true) || (options[:trim][0] == true)
+        url_parts.push(trim_options.join(':'))
+      end
 
-            [:fit_in, :adaptive_fit_in, :full_fit_in, :adaptive_full_fit_in].each do |fit|
-                if options[fit]
-                    url_parts.push(fit.to_s.gsub('_','-'))
-                end
-            end
+      url_parts.push('meta') if options[:meta]
 
-            if options.include?(:fit_in) or options.include?(:full_fit_in) and not (options.include?(:width) or options.include?(:height))
-                raise ArgumentError, 'When using fit-in or full-fit-in, you must specify width and/or height.'
-            end
+      calculate_centered_crop(options)
 
-            calculate_width_and_height(url_parts, options)
+      crop = options[:crop]
+      if crop
+        crop_left = crop[0]
+        crop_top = crop[1]
+        crop_right = crop[2]
+        crop_bottom = crop[3]
 
-            if options[:halign] and options[:halign] != :center
-                url_parts.push(options[:halign])
-            end
+        if crop_left.positive? || crop_top.positive? || crop_bottom.positive? || crop_right.positive?
+          url_parts.push(crop_left.to_s << 'x' << crop_top.to_s << ':' << crop_right.to_s << 'x' << crop_bottom.to_s)
+        end
+      end
 
-            if options[:valign] and options[:valign] != :middle
-                url_parts.push(options[:valign])
-            end
+      %i[fit_in adaptive_fit_in full_fit_in adaptive_full_fit_in].each do |fit|
+        url_parts.push(fit.to_s.gsub('_', '-')) if options[fit]
+      end
 
-            if options[:smart]
-                url_parts.push('smart')
-            end
+      if (options.include?(:fit_in) || options.include?(:full_fit_in)) && !(options.include?(:width) || options.include?(:height))
+        raise ArgumentError, 'When using fit-in or full-fit-in, you must specify width and/or height.'
+      end
 
-            if options[:filters] && !options[:filters].empty?
-              filter_parts = []
-              options[:filters].each do |filter|
-                filter_parts.push(filter)
-              end
+      calculate_width_and_height(url_parts, options)
 
-              url_parts.push("filters:#{ filter_parts.join(':') }")
-            end
+      url_parts.push(options[:halign]) if options[:halign] && (options[:halign] != :center)
 
-            if include_hash
-                image_hash = Digest::MD5.hexdigest(options[:image])
-                url_parts.push(image_hash)
-            end
+      url_parts.push(options[:valign]) if options[:valign] && (options[:valign] != :middle)
 
-            return url_parts.join('/')
-        end
+      url_parts.push('smart') if options[:smart]
 
-        def url_safe_base64(str)
-            Base64.encode64(str).gsub('+', '-').gsub('/', '_').gsub!(/[\n]/, '')
+      if options[:filters] && !options[:filters].empty?
+        filter_parts = []
+        options[:filters].each do |filter|
+          filter_parts.push(filter)
         end
 
-        def generate_old(options)
-            url = pad(url_for(options))
-            cipher = OpenSSL::Cipher::Cipher.new('aes-128-ecb').encrypt
-            cipher.key = computed_key
-            encrypted = cipher.update(url)
-            based = url_safe_base64(encrypted)
+        url_parts.push("filters:#{filter_parts.join(':')}")
+      end
 
-            "/#{based}/#{options[:image]}"
-        end
+      url_parts.join('/')
+    end
 
-        def generate_new(options)
-            thumbor_path = ""
+    def url_safe_base64(str)
+      Base64.encode64(str).gsub('+', '-').gsub('/', '_').gsub!(/\n/, '')
+    end
 
-            image_options = url_for(options, false)
-            thumbor_path << image_options + '/' unless image_options.empty?
+    def generate(options)
+      thumbor_path = []
 
-            thumbor_path << options[:image]
+      image_options = url_for(options)
+      thumbor_path << "#{image_options}/" unless image_options.empty?
 
-            if Thumbor.key
-                signature = url_safe_base64(OpenSSL::HMAC.digest('sha1', Thumbor.key, thumbor_path))
-                thumbor_path.insert(0, "/#{signature}/")
-            else
-                thumbor_path.insert(0, "/unsafe/")
-            end
-            thumbor_path
-        end
+      thumbor_path << options[:image]
 
-        def generate(options)
-            return generate_old(options) if options[:old]
-            generate_new(options)
-        end
+      if @key.nil?
+        thumbor_path.insert(0, '/unsafe/')
+      else
+        signature = url_safe_base64(OpenSSL::HMAC.digest('sha1', @key, thumbor_path.join))
+        thumbor_path.insert(0, "/#{signature}/")
+      end
+      thumbor_path.join
     end
+  end
 end

data/lib/thumbor/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Thumbor
-  VERSION = '1.3.0'
+  VERSION = '4.0.0'
 end

data/spec/spec_helper.rb

@@ -1,14 +1,29 @@
+# frozen_string_literal: true
+
 require 'simplecov'
+require 'simplecov-lcov'
+
+SimpleCov::Formatter::LcovFormatter.config do |config|
+  config.report_with_single_file = true
+  config.single_report_path = 'coverage/lcov.info'
+end
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter
+  ]
+)
 
 SimpleCov.start do
-add_filter '/spec/'
+  add_filter '/spec/'
 end
 
+SimpleCov.at_exit do
+  SimpleCov.result.format!
+end
 
 RSpec.configure do |c|
-  c.filter_run :focus => true
+  c.filter_run focus: true
   c.run_all_when_everything_filtered = true
-  c.expect_with :rspec do |config|
-    config.syntax = [:should, :expect]
-  end
 end