imgproxy 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b6f43dc8ff8bc89edf3015f8ebac74c4c8b4f785a0c886209a66133d44c7754
+  data.tar.gz: 68749943510a2c6b41608ebb9fdd132d5339ad35486019710588f5ec3aa49d35
+SHA512:
+  metadata.gz: a320137aa833b9af94bb9de211b297e49fe2bb515a2b6a08d6cfae9b512173653ec82c1bf85964e126a56e39fe92073049e4d382d789d6a0c70e8d89d551ca20
+  data.tar.gz: 9851452726dcadfd6b84fa6018b4d3791650a69c52860fb79a5d9d2ee48b1f275d9bebfd6e8174da69acb0968d411e03ad890c26979ab2ec1b6007c412b06d29

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 imgproxy
+
+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/README.md

@@ -0,0 +1,100 @@
+# imgproxy.rb
+
+[![Gem](https://img.shields.io/gem/v/imgproxy.svg?style=for-the-badge)](https://rubygems.org/gems/imgproxy) [![rubydoc.org](https://img.shields.io/badge/rubydoc-reference-blue.svg?style=for-the-badge)](https://www.rubydoc.info/gems/imgproxy/)
+
+Gem for [imgproxy](https://github.com/DarthSim/imgproxy) URLs generation.
+
+[imgproxy](https://github.com/DarthSim/imgproxy) is a fast and secure standalone server for resizing and converting remote images. The main principles of imgproxy are simplicity, speed, and security.
+
+## Installation
+
+```
+gem install imgproxy
+```
+
+or add it to your `Gemfile`:
+
+```ruby
+gem "imgproxy"
+```
+
+## Configuration
+
+```ruby
+# config/initializers/imgproxy.rb
+
+Imgproxy.configure do |config|
+  # imgproxy endpoint
+  config.endpoint = "http://imgproxy.example.com"
+  # hex-encoded signature key
+  config.hex_key = "your_key"
+  # hex-encoded signature salt
+  config.hex_salt = "your_salt"
+  # signature size. Defaults to 32
+  config.signature_size = 5
+  # use short processing option names (`rs` for `resize`, `g` for `gravity`, etc).
+  # Defaults to true
+  config.use_short_options = false
+end
+```
+
+## Usage
+
+```ruby
+Imgproxy.url_for(
+  "http://images.example.com/images/image.jpg",
+  width: 500,
+  height: 400,
+  resizing_type: :fill,
+  sharpen: 0.5
+)
+# => http://imgproxy.example.com/2tjGMpWqjO/rs:fill:500:400/sh:0.5/plain/http://images.example.com/images/image.jpg
+```
+
+You can reuse processing options by using `Imgproxy::Builder`:
+
+```ruby
+builder = Imgproxy::Builder.new(
+  width: 500,
+  height: 400,
+  resizing_type: :fill,
+  sharpen: 0.5
+)
+
+builder.url_for("http://images.example.com/images/image1.jpg")
+builder.url_for("http://images.example.com/images/image2.jpg")
+```
+
+Available options are:
+
+* `resizing_type`
+* `width`
+* `height`
+* `dpr`
+* `enlarge`
+* `extend`
+* `gravity`
+* `gravity_x`
+* `gravity_y`
+* `quality`
+* `background`
+* `blur`
+* `sharpen`
+* `watermark_opacity`
+* `watermark_position`
+* `watermark_x_offset`
+* `watermark_y_offset`
+* `watermark_scale`
+* `preset`
+* `cachebuster`
+* `format`
+* `use_short_options`
+
+_See [imgproxy URL format guide](https://github.com/DarthSim/imgproxy/blob/master/docs/generating_the_url_advanced.md) for more info_
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/imgproxy/imgproxy.rb.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/imgproxy/builder.rb

@@ -0,0 +1,113 @@
+require 'openssl'
+require 'base64'
+
+require 'imgproxy/options'
+
+module Imgproxy
+  # Builds imgproxy URL
+  #
+  #   builder = Imgproxy::Builder.new(
+  #     width: 500,
+  #     height: 400,
+  #     resizing_type: :fill,
+  #     sharpen: 0.5
+  #   )
+  #
+  #   builder.url_for("http://images.example.com/images/image1.jpg")
+  #   builder.url_for("http://images.example.com/images/image2.jpg")
+  class Builder
+    # @param [Hash] options Processing options
+    # @see Imgproxy.url_for
+    def initialize(options = {})
+      @use_short_options = options.delete(:use_short_options)
+      @use_short_options = config.use_short_options if @use_short_options.nil?
+
+      @options = Imgproxy::Options.new(options)
+    end
+
+    # Genrates imgproxy URL
+    #
+    # @return [String] imgproxy URL
+    # @param [String] image Source image URL
+    # @see Imgproxy.url_for
+    def url_for(image)
+      path = [*processing_options, 'plain', escape_url(image)].join('/')
+      path = "#{path}@#{options[:format]}" if @options[:format]
+
+      signature = sign_path(path)
+
+      "#{Imgproxy.config.endpoint}/#{signature}/#{path}"
+    end
+
+    private
+
+    OPTIONS_ALIASES = {
+      resize: :rs,
+      size: :s,
+      resizing_type: :rt,
+      width: :w,
+      height: :h,
+      enlarge: :en,
+      extend: :ex,
+      gravity: :g,
+      quality: :q,
+      background: :bg,
+      blur: :bl,
+      sharpen: :sh,
+      watermark: :wm,
+      preset: :pr,
+      cachebuster: :cb
+    }.freeze
+
+    NEED_ESCAPE_RE = /@\?%/.freeze
+
+    def processing_options
+      @processing_options ||=
+        @options.build.map do |key, value|
+          "#{option_alias(key)}:#{wrap_array(value).join(':')}"
+        end
+    end
+
+    def option_alias(name)
+      return name unless config.use_short_options
+
+      OPTIONS_ALIASES.fetch(name, name)
+    end
+
+    def wrap_array(value)
+      value.is_a?(Array) ? value : [value]
+    end
+
+    def escape_url(url)
+      url =~ NEED_ESCAPE_RE ? CGI.escape(url) : url
+    end
+
+    def sign_path(path)
+      return 'unsafe' if signature_key.nil? || signature_salt.nil?
+
+      digest = OpenSSL::HMAC.digest(
+        OpenSSL::Digest.new('sha256'),
+        signature_key,
+        "#{signature_salt}/#{path}"
+      )[0, signature_size]
+
+      Base64.urlsafe_encode64(digest).tr('=', '')
+    end
+
+    def signature_key
+      config.key
+    end
+
+    def signature_salt
+      config.salt
+    end
+
+    def signature_size
+      config.signature_size
+    end
+
+    def config
+      Imgproxy.config
+    end
+  end
+end

data/lib/imgproxy/config.rb

@@ -0,0 +1,41 @@
+module Imgproxy
+  # Imgproxy config
+  # @see Imgproxy.configure
+  class Config
+    # @return [String] imgproxy endpoint
+    attr_reader :endpoint
+    # @return [String] imgproxy signature key
+    attr_accessor :key
+    # @return [String] imgproxy signature salt
+    attr_accessor :salt
+    # @return [Integer] imgproxy signature size. Defaults to 32
+    attr_accessor :signature_size
+    # @return [Boolean] use short processing option names
+    #   (`rs` for `resize`, `g` for `gravity`, etc).
+    #   Defaults to true
+    attr_accessor :use_short_options
+
+    def initialize
+      self.signature_size = 32
+      self.use_short_options = true
+    end
+
+    # Decodes hex-encoded key and sets it to {#key}
+    #
+    # @param value [String] hex-encoded signature key
+    def hex_key=(value)
+      self.key = [value].pack('H*')
+    end
+
+    # Decodes hex-encoded salt and sets it to {#salt}
+    #
+    # @param value [String] hex-encoded signature salt
+    def hex_salt=(value)
+      self.salt = [value].pack('H*')
+    end
+
+    def endpoint=(value)
+      @endpoint = value.end_with?('/') ? value[0..-2] : value
+    end
+  end
+end

data/lib/imgproxy/options.rb

@@ -0,0 +1,118 @@
+require 'ostruct'
+
+module Imgproxy
+  # Formats and regroups processing options
+  class Options < Hash
+    STRING_OPTS = %i[resizing_type gravity watermark_position style cachebuster
+                     format].freeze
+
+    INT_OPTS = %i[width height quality watermark_x_offset
+                  watermark_y_offset].freeze
+
+    FLOAT_OPTS = %i[dpr gravity_x gravity_y blur sharpen watermark_opacity
+                    watermark_scale].freeze
+
+    BOOL_OPTS = %i[enlarge extend].freeze
+
+    ARRAY_OPTS = %i[background preset].freeze
+
+    ALL_OPTS =
+      (STRING_OPTS + INT_OPTS + FLOAT_OPTS + BOOL_OPTS + ARRAY_OPTS).freeze
+
+    OPTS_PRIORITY = { resize: 1, size: 2 }.freeze
+
+    # @param options [Hash] raw processing options
+    def initialize(options)
+      merge!(options.slice(*ALL_OPTS))
+      typecast
+      freeze
+    end
+
+    # @return [Hash] formatted and regrouped processing options
+    def build
+      opts = dup
+
+      group_resizing_opts(opts)
+      group_gravity_opts(opts)
+      group_watermark_opts(opts)
+      encode_style(opts)
+
+      Hash[opts.sort_by { |k, _| OPTS_PRIORITY.fetch(k, 99) }]
+    end
+
+    private
+
+    def typecast
+      compact.each do |key, value|
+        self[key] =
+          case key
+          when *STRING_OPTS then value.to_s
+          when *INT_OPTS then value.to_i
+          when *FLOAT_OPTS then value.to_f
+          when *BOOL_OPTS then bool(value)
+          when *ARRAY_OPTS then wrap_array(value)
+          end
+      end
+    end
+
+    def bool(value)
+      value && value != 0 && value != '0' ? 1 : 0
+    end
+
+    def wrap_array(value)
+      value.is_a?(Array) ? value : [value]
+    end
+
+    def group_resizing_opts(opts)
+      return opts unless opts[:width] && opts[:height]
+
+      opts[:size] = trim_nils(
+        [opts.delete(:width), opts.delete(:height),
+         opts.delete(:enlarge), opts.delete(:extend)]
+      )
+
+      if opts[:resizing_type]
+        opts[:resize] = [opts.delete(:resizing_type), *opts.delete(:size)]
+      end
+
+      opts
+    end
+
+    def group_gravity_opts(opts)
+      gravity = trim_nils(
+        [
+          opts.delete(:gravity),
+          opts.delete(:gravity_x),
+          opts.delete(:gravity_y)
+        ]
+      )
+
+      opts[:gravity] = gravity unless gravity[0].nil?
+    end
+
+    def group_watermark_opts(opts)
+      watermark = trim_nils(
+        [
+          opts.delete(:watermark_opacity),
+          opts.delete(:watermark_position),
+          opts.delete(:watermark_x_offset),
+          opts.delete(:watermark_y_offset),
+          opts.delete(:watermark_scale)
+        ]
+      )
+
+      opts[:watermark] = watermark unless watermark[0].nil?
+    end
+
+    def encode_style(opts)
+      return if opts[:style].nil?
+
+      opts[:style] = Base64.urlsafe_encode64(opts[:style]).tr('=', '')
+    end
+
+    def trim_nils(value)
+      value.delete_at(-1) while !value.empty? && value[-1].nil?
+      value
+    end
+  end
+end

data/lib/imgproxy/version.rb

@@ -0,0 +1,3 @@
+module Imgproxy
+  VERSION = '0.0.2'.freeze
+end

data/lib/imgproxy.rb

@@ -0,0 +1,72 @@
+require 'imgproxy/version'
+require 'imgproxy/config'
+require 'imgproxy/builder'
+
+# @see Imgproxy::ClassMethods
+module Imgproxy
+  class << self
+    # Imgproxy config
+    #
+    # @return [Config]
+    def config
+      @config ||= Imgproxy::Config.new
+    end
+
+    # Yields Imgproxy config
+    #
+    #   Imgproxy.configure do |config|
+    #     config.endpoint = "http://imgproxy.example.com"
+    #     config.hex_key = "your_key"
+    #     config.hex_salt = "your_salt"
+    #     config.use_short_options = true
+    #   end
+    #
+    # @yieldparam config [Config]
+    # @return [Config]
+    def configure
+      yield config
+      config
+    end
+
+    # Genrates imgproxy URL
+    #
+    #   Imgproxy.url_for(
+    #     "http://images.example.com/images/image.jpg",
+    #     width: 500,
+    #     height: 400,
+    #     resizing_type: :fill,
+    #     sharpen: 0.5
+    #   )
+    #
+    # @return [String] imgproxy URL
+    # @param [String] image Source image URL
+    # @param [Hash] options Processing options
+    # @option options [String] :resizing_type
+    # @option options [Integer] :width
+    # @option options [Integer] :height
+    # @option options [Float] :dpr
+    # @option options [Boolean] :enlarge
+    # @option options [Boolean] :extend
+    # @option options [String] :gravity
+    # @option options [Float] :gravity_x
+    # @option options [Float] :gravity_y
+    # @option options [Integer] :quality
+    # @option options [Array] :background
+    # @option options [Float] :blur
+    # @option options [Float] :sharpen
+    # @option options [Float] :watermark_opacity
+    # @option options [String] :watermark_position
+    # @option options [Integer] :watermark_x_offset
+    # @option options [Integer] :watermark_y_offset
+    # @option options [Float] :watermark_scale
+    # @option options [Array] :preset
+    # @option options [String] :cachebuster
+    # @option options [String] :format
+    # @option options [Boolean] :use_short_options
+    # @see https://github.com/DarthSim/imgproxy/blob/master/docs/generating_the_url_advanced.md
+    #   imgproxy URL format documentation
+    def url_for(image, options = {})
+      Imgproxy::Builder.new(options).url_for(image)
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: imgproxy
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sergey Alexandrovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-25 00:00:00.000000000 Z
+dependencies: []
+description: A gem that easily generates imgproxy URLs for your images
+email: darthsim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/imgproxy.rb
+- lib/imgproxy/builder.rb
+- lib/imgproxy/config.rb
+- lib/imgproxy/options.rb
+- lib/imgproxy/version.rb
+homepage: https://github.com/imgproxy/imgproxy.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: imgproxy URL generator
+test_files: []