cloudimage 0.2.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 278e88b372ae0e007da88f05ede4180b1db4203c5b36dca72acf56e1f510d2e6
-  data.tar.gz: e4761b0f0ceb55bc6311e2966472a0b52dbc7694f37833f3dec6a6c8baf80a9c
+  metadata.gz: 4367d92586decc3e9c65338418bad7a9b6b741501de236f72d421a44713ec9e1
+  data.tar.gz: e5003ebd0e1b125007b395dfbe2c04256f52cec0d452428fa82fb154ed75eb56
 SHA512:
-  metadata.gz: 323332b25479d79a894406a05dda4f9e91d119dd1d4b43f8a4880a61aa9bd5a2fa4756ec9b33e803241bef2c616f4eefdfda0e32683234f1255d4815bf582110
-  data.tar.gz: af73227c277fb3b7b63150135e730536a7c40018e90b39c7478a4fb6592981e389e883a5529fb5ce76e217a2e117c353b1a9f6dbddde4d590a2b347dc916ccb1
+  metadata.gz: 4d614cd97790eec3443da301aae5b12fa733018e08934b5a5bc41604179537a36573bb44997bcbd9ef6677e678874fc81a4a73a6e55e87727233a84af1f9892d
+  data.tar.gz: 9adeccc55a9d1a3b3368a84657ac9954243e1eefa1fc5e0fb253385bb57d08cc0e1d75f68805cdfde7352a0bcdcefea533a8606b11960402dbe7f55127543f26

data/CHANGELOG.md

@@ -1,4 +1,44 @@
-## master
+# Changelog
+
+## [v0.6.0](https://github.com/scaleflex/cloudimage-rb/tree/v0.6.0) (2020-08-16)
+
+[Full Changelog](https://github.com/scaleflex/cloudimage-rb/compare/v0.5.0...v0.6.0)
+
+**Implemented enhancements:**
+
+- Add srcset generation [\#27](https://github.com/scaleflex/cloudimage-rb/pull/27) ([janklimo](https://github.com/janklimo))
+- Add default alias [\#26](https://github.com/scaleflex/cloudimage-rb/pull/26) ([janklimo](https://github.com/janklimo))
+- Configurable API version URL component [\#25](https://github.com/scaleflex/cloudimage-rb/pull/25) ([janklimo](https://github.com/janklimo))
+
+## [v0.5.0](https://github.com/scaleflex/cloudimage-rb/tree/v0.5.0) (2020-08-02)
+
+[Full Changelog](https://github.com/scaleflex/cloudimage-rb/compare/v0.4.0...v0.5.0)
+
+**Implemented enhancements:**
+
+- Invalidation [\#24](https://github.com/scaleflex/cloudimage-rb/pull/24) ([janklimo](https://github.com/janklimo))
+- Add support for custom CNAMEs [\#21](https://github.com/scaleflex/cloudimage-rb/pull/21) ([janklimo](https://github.com/janklimo))
+
+## [v0.4.0](https://github.com/scaleflex/cloudimage-rb/tree/v0.4.0) (2020-07-19)
+
+[Full Changelog](https://github.com/scaleflex/cloudimage-rb/compare/v0.3.0...v0.4.0)
+
+**Implemented enhancements:**
+
+- Add support for aliases [\#20](https://github.com/scaleflex/cloudimage-rb/pull/20) ([janklimo](https://github.com/janklimo))
+
+## [v0.3.0](https://github.com/scaleflex/cloudimage-rb/tree/v0.3.0) (2020-07-09)
+
+[Full Changelog](https://github.com/scaleflex/cloudimage-rb/compare/v0.2.1...v0.3.0)
+
+**Implemented enhancements:**
+
+- Introduce URL sealing [\#10](https://github.com/scaleflex/cloudimage-rb/pull/10) ([janklimo](https://github.com/janklimo))
+
+**Merged pull requests:**
+
+- Use changelog generation [\#16](https://github.com/scaleflex/cloudimage-rb/pull/16) ([janklimo](https://github.com/janklimo))
+- Add test coverage with SimpleCov [\#9](https://github.com/scaleflex/cloudimage-rb/pull/9) ([janklimo](https://github.com/janklimo))
 
 ## 0.2.1 (2020-06-29)
 
@@ -23,3 +63,6 @@
 
 - Set up Github actions for CI.
   [#1](https://github.com/scaleflex/cloudimage-rb/pull/1) (@janklimo)
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -1,9 +1,8 @@
 # cloudimage
 
-![](https://github.com/scaleflex/cloudimage-rb/workflows/Build/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/cloudimage.svg)](https://badge.fury.io/rb/cloudimage) ![Build status](https://github.com/scaleflex/cloudimage-rb/workflows/Build/badge.svg)
 
-`cloudimage` is the official Ruby API wrapper for
-[Cloudimage's API](https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/introduction).
+`cloudimage` is the official Ruby API wrapper for [Cloudimage's API][docs].
 
 Supports Ruby `2.4` and above, `JRuby`, and `TruffleRuby`.
 
@@ -12,14 +11,20 @@ Supports Ruby `2.4` and above, `JRuby`, and `TruffleRuby`.
   - [Usage](#usage)
     - [Hash of params](#hash-of-params)
     - [Chainable helpers](#chainable-helpers)
-    - [Aliases](#aliases)
+    - [Method aliases](#method-aliases)
     - [Custom helpers](#custom-helpers)
+    - [URL aliases](#url-aliases)
+    - [`srcset` generation](#srcset-generation)
+    - [CNAME](#cname)
+    - [Optional API version](#optional-api-version)
     - [Security](#security)
+      - [URL signature](#url-signature)
+      - [URL sealing](#url-sealing)
+    - [Invalidation API](#invalidation-api)
   - [Development](#development)
-    - [TODOs](#todos)
   - [Contributing](#contributing)
   - [License](#license)
-  - [Code of Conduct](#code-of-conduct)
+  - [Showcase](#showcase)
 
 ## Installation
 
@@ -39,7 +44,7 @@ Or install it yourself as:
 
 ## Usage
 
-The only requirement to get started is your customer token. You can
+The most common way to use Cloudimage is by means of your customer token. You can
 find it within your Admin interface:
 
 ![token](docs/token.png)
@@ -53,12 +58,16 @@ client = Cloudimage::Client.new(token: 'mysecrettoken')
 
 Cloudimage client accepts the following options:
 
-| Option             | Required? | Additional info                                     |
-| ------------------ | --------- | --------------------------------------------------- |
-| `token`            | Yes       |                                                     |
-| `salt`             | No        | See [Security](#security).                          |
-| `signature_length` | No        | Integer value in the range `6..40`. Defaults to 18. |
-| `api_version`      | No        | Defaults to the current stable version.             |
+| Option                | Type    | Additional info                                                                |
+| --------------------- | ------- | ------------------------------------------------------------------------------ |
+| `token`               | string  | Required if `cname` is missing.                                                |
+| `cname`               | string  | Required if `token` is missing. See [CNAME](#cname).                           |
+| `salt`                | string  | Optional. See [Security](#security).                                           |
+| `signature_length`    | integer | Optional. Integer value in the range `6..40`. Defaults to 18.                  |
+| `sign_urls`           | boolean | Optional. Defaults to `true`. See [Security](#security).                       |
+| `aliases`             | hash    | Optional. See [URL aliases](#url-aliases).                                     |
+| `api_key`             | string  | Optional. See [Invalidation API](#invalidation-api).                           |
+| `include_api_version` | boolean | Optional. Defaults to true. See [Optional API version](#optional-api-version). |
 
 Calling `path` on the client object returns an instance of `Cloudimage::URI`.
 It accepts path to the image as a string and we we will use it to build
@@ -101,7 +110,7 @@ uri.heigth(200).to_url
 This is useful for catching typos and identifying deprecated methods in
 case Cloudimage's API changes.
 
-### Aliases
+### Method aliases
 
 The gem comes with a handful of useful aliases. Consult
 [`Cloudimage::Params`](lib/cloudimage/params.rb) module for their full list.
@@ -119,8 +128,76 @@ need to accept arguments and will be translated into `param=1` in the final URL.
 For a list of custom helpers available to you, please consult
 [`Cloudimage::CustomHelpers`](lib/cloudimage/custom_helpers.rb) module.
 
+### URL aliases
+
+Specify [aliases][aliases] to automatically replace parts of path with defined values.
+Aliases is a hash which maps strings to be replaced with values to be used instead.
+
+```ruby
+my_alias = 'https://store.s3-us-west-2.amazonaws.com/uploads'
+client = Cloudimage::Client.new(token: 'token', aliases: { my_alias => '_uploads_' })
+client.path('https://store.s3-us-west-2.amazonaws.com/uploads/image.jpg').to_url
+# => "https://token.cloudimg.io/v7/_uploads_/image.jpg"
+```
+
+[URL prefix][url-prefix] is just another form of URL alias. Simply make the target value an empty string:
+
+```ruby
+prefix = 'https://store.s3-us-west-2.amazonaws.com/uploads/'
+client = Cloudimage::Client.new(token: 'token', aliases: { prefix => '' })
+client.path('https://store.s3-us-west-2.amazonaws.com/uploads/image.jpg').to_url
+# => "https://token.cloudimg.io/v7/image.jpg"
+```
+
+You don't need to specify an alias if the input to `path` is a URL that
+already matches the base of the generated URL:
+
+```ruby
+client = Cloudimage::Client.new(token: 'token')
+client.path('https://token.cloudimg.io/v7/image.jpg').to_url(w: 200)
+=> "https://token.cloudimg.io/v7/image.jpg?w=200"
+```
+
+### `srcset` generation
+
+Use the provided `to_srcset` method which also accepts any additional params to
+be applied to the `srcset` URLs:
+
+```ruby
+client = Cloudimage::Client.new(token: 'token')
+client.path('/assets/image.jpg').to_srcset(blur: 5)
+# => "https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=100 100w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=170 170w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=280 280w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=470 470w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=780 780w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=1300 1300w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=2170 2170w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=3620 3620w, https://token.cloudimg.io/v7/assets/image.jpg?blur=5&w=5760 5760w"
+```
+
+A growth factor is applied to exponentially distribute widths between 100 and 5760 pixels.
+See [`Cloudimage::Srcset`](/lib/cloudimage/srcset.rb) for implementation details.
+
+### CNAME
+
+If you have a custom CNAME configured for your account, you can
+use it to initialize the client:
+
+```ruby
+client = Cloudimage::Client.new(cname: 'img.klimo.io')
+client.path('/assets/image.jpg').to_url
+# => 'https://img.klimo.io/v7/assets/image.jpg'
+```
+
+### Optional API version
+
+If your account is configured to work without the API version component in the URL,
+you can configure client not to include it in the generated URL:
+
+```ruby
+client = Cloudimage::Client.new(cname: 'img.klimo.io', include_api_version: false)
+client.path('/assets/image.jpg').to_url
+# => "https://img.klimo.io/assets/image.jpg"
+```
+
 ### Security
 
+#### URL signature
+
 If `salt` is defined, all URLs will be signed.
 
 You can control the length of the generated signature by specifying `signature_length`
@@ -133,6 +210,67 @@ uri.w(200).h(400).to_url
 # => "https://mysecrettoken.cloudimg.io/v7/assets/image.png?h=400&w=200&ci_sign=79cfbc458b"
 ```
 
+#### URL sealing
+
+Whereas URL signatures let you protect your URL from any kind of
+tampering, URL sealing protects the params you specify while making
+it possible to append additional params on the fly.
+
+This is useful when working with Cloudimage's [responsive frontend libraries][responsive-images].
+A common use case would be sealing your watermark but letting the
+React client request the best possible width.
+
+To seal your URLs, initialize client with `salt` and set
+`sign_urls` to `false`. `signature_length` setting is applied
+to control the length of the generated `ci_seal` value.
+
+Use the `seal_params` helper to specify which params to seal
+as a list of arguments. These could be symbols or strings.
+
+```ruby
+client = Cloudimage::Client.new(token: 'demoseal', salt: 'test', sign_urls: false)
+
+client
+  .path('/sample.li/birds.jpg')
+  .f('bright:10,contrast:20')
+  .w(300)
+  .h(400)
+  .seal_params(:w, :f)
+  .to_url
+# => "https://demoseal.cloudimg.io/v7/sample.li/birds.jpg?ci_eqs=Zj1icmlnaHQlM0ExMCUyQ2NvbnRyYXN0JTNBMjAmdz0zMDA&ci_seal=67dd8cc44f6ba44ee5&h=400"
+
+# Alternative approach:
+client
+  .path('/sample.li/birds.jpg')
+  .to_url(f: 'bright:10,contrast:20', w: 300, h: 400, seal_params: [:w, :f])
+# => "https://demoseal.cloudimg.io/v7/sample.li/birds.jpg?ci_eqs=Zj1icmlnaHQlM0ExMCUyQ2NvbnRyYXN0JTNBMjAmdz0zMDA&ci_seal=67dd8cc44f6ba44ee5&h=400"
+```
+
+This approach protects `w` and `f` values from being edited but
+makes it possible to freely modify the value of `h`.
+
+### Invalidation API
+
+To access invalidation API you'll need to initialize client with
+an API key.
+
+The provided helper methods accept any number of strings:
+
+```ruby
+client = Cloudimage::Client.new(token: 'token', api_key: 'key')
+
+# Invalidate original
+client.invalidate_original('/v7/image.jpg')
+
+# Invalidate URLs
+client.invalidate_urls('/v7/image.jpg?w=200', '/v7/image.jpg?h=300')
+
+# Invalidate all
+client.invalidate_all
+```
+
+Consult the [invalidation API docs][invalidation-docs] for further details.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -140,27 +278,31 @@ Then, run `bundle exec rake` to run the tests. You can also run
 `bin/console` for an interactive prompt that will allow you to
 experiment.
 
-### TODOs
-
-- URL sealing
-- Add support for custom CNAMEs
-- `srcset` generation
-- Purge cache API
-
 ## Contributing
 
 Bug reports and pull requests are welcome. This project is intended
 to be a safe, welcoming space for collaboration, and contributors
-are expected to adhere to the
-[code of conduct](https://github.com/scaleflex/cloudimage-rb/blob/master/CODE_OF_CONDUCT.md).
+are expected to adhere to the [code of conduct][code-of-conduct].
 
 ## License
 
-The gem is available as open source under the terms of the
-[MIT License](https://opensource.org/licenses/MIT).
+[MIT](https://opensource.org/licenses/MIT)
+
+## Showcase
+
+Among others, `cloudimage` is used to power the following apps:
+
+- [Robin PRO][robin-pro] - Fast, beautiful, mobile-friendly image galleries for Shopify stores.
+- [Spotlightify][spotlightify] - Turning the spotlight on the best Shopify stores.
 
-## Code of Conduct
+Using this gem in your app? Let us know in [this issue](https://github.com/scaleflex/cloudimage-rb/issues/8)
+so that we can feature it.
 
-Everyone interacting with the project's codebase, issues, and pull
-requests is expected to follow the
-[code of conduct](https://github.com/scaleflex/cloudimage-rb/blob/master/CODE_OF_CONDUCT.md).
+[aliases]: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/domains-urls/aliases
+[code-of-conduct]: https://github.com/scaleflex/cloudimage-rb/blob/master/CODE_OF_CONDUCT.md
+[docs]: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/introduction
+[invalidation-docs]: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/caching-acceleration/invalidation-api
+[responsive-images]: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/responsive-images
+[robin-pro]: https://apps.shopify.com/robin-pro-image-gallery
+[spotlightify]: https://www.spotlightify.com/
+[url-prefix]: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/domains-urls/origin-url-prefix

data/lib/cloudimage.rb

@@ -2,5 +2,4 @@
 
 require 'addressable/uri'
 
-require_relative 'cloudimage/version'
 require_relative 'cloudimage/client'

data/lib/cloudimage/client.rb

@@ -1,25 +1,22 @@
 # frozen_string_literal: true
 
 require_relative 'uri'
+require_relative 'invalidation'
 
 module Cloudimage
   class InvalidConfig < StandardError; end
 
   class Client
+    include Invalidation
+
     attr_reader :config
 
     API_VERSION = 'v7'
     DEFAULT_SIGNATURE_LENGTH = 18
 
     def initialize(**options)
-      @config = {}
-      @config[:token] = options[:token]
-      @config[:salt] = options[:salt]
-      @config[:signature_length] =
-        options[:signature_length] || DEFAULT_SIGNATURE_LENGTH
-      @config[:api_version] = API_VERSION
-
-      ensure_valid_config
+      @config = set_config_defaults(options)
+      validate_config
     end
 
     def path(path)
@@ -28,18 +25,31 @@ module Cloudimage
 
     private
 
-    def ensure_valid_config
-      ensure_valid_token
-      ensure_valid_signature_length
+    def set_config_defaults(options)
+      options.tap do |config|
+        config[:signature_length] =
+          options[:signature_length] || DEFAULT_SIGNATURE_LENGTH
+        config[:api_version] = API_VERSION
+        config[:include_api_version] =
+          options[:include_api_version].nil? ? true : false
+        config[:sign_urls] = options[:sign_urls].nil? ? true : false
+        config[:aliases] = options[:aliases] || {}
+      end
+    end
+
+    def validate_config
+      validate_site_config
+      validate_signature_length
     end
 
-    def ensure_valid_token
-      return unless config[:token].nil?
+    def validate_site_config
+      return unless config[:token].nil? && config[:cname].nil?
 
-      raise InvalidConfig, 'Please specify your Cloudimage customer token.'
+      raise InvalidConfig,
+            'Please specify your customer token or a custom CNAME.'
     end
 
-    def ensure_valid_signature_length
+    def validate_signature_length
       return if config[:salt].nil?
       return if (6..40).cover? config[:signature_length]
 

data/lib/cloudimage/custom_helpers.rb

@@ -5,5 +5,11 @@ module Cloudimage
     def positionable_crop(origin_x:, origin_y:, width:, height:)
       tl_px(origin_x, origin_y).br_px(origin_x + width, origin_y + height)
     end
+
+    def seal_params(*query_params)
+      # URI#query_values returns hash where keys are strings.
+      sealed_params.merge(query_params.map(&:to_s))
+      self
+    end
   end
 end

data/lib/cloudimage/invalidation.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Cloudimage
+  module Invalidation
+    ENDPOINT = ::URI.parse('https://api.cloudimage.com/invalidate')
+
+    %i[original urls all].each do |type|
+      define_method "invalidate_#{type}" do |*paths|
+        validate_api_key
+
+        body = {
+          scope: type,
+        }
+
+        body[:urls] = paths if paths.any?
+
+        send_request(body)
+      end
+    end
+
+    private
+
+    def validate_api_key
+      return if config[:api_key]
+
+      raise InvalidConfig, 'API key is required to perform cache invalidation.'
+    end
+
+    def headers
+      {
+        'X-Client-Key': config[:api_key],
+        'Content-Type': 'application/json',
+      }
+    end
+
+    def send_request(body)
+      http = Net::HTTP.new(ENDPOINT.host, ENDPOINT.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Post.new(ENDPOINT.path, headers)
+      request.body = body.to_json
+
+      http.request(request)
+    end
+  end
+end

data/lib/cloudimage/refinements.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Cloudimage
+  module Refinements
+    unless {}.respond_to?(:slice)
+      refine Hash do
+        def slice(*keys)
+          keys.each_with_object({}) do |k, acc|
+            acc[k] = self[k] if key?(k)
+          end
+        end
+      end
+    end
+
+    unless ''.respond_to?(:delete_prefix)
+      refine String do
+        def delete_prefix(prefix)
+          sub(/\A#{prefix}/, '')
+        end
+      end
+    end
+
+    unless Kernel.respond_to?(:yield_self)
+      refine Kernel do
+        def yield_self
+          unless block_given?
+            return ::Enumerator.new(1) do |yielder|
+              yielder.yield(self)
+            end
+          end
+
+          yield(self)
+        end
+      end
+    end
+
+    unless Kernel.respond_to?(:then)
+      refine Kernel do
+        def then
+          return yield_self unless block_given?
+
+          yield_self(&::Proc.new)
+        end
+      end
+    end
+  end
+end

data/lib/cloudimage/security.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'base64'
+
+require_relative 'refinements'
+
+module Cloudimage
+  class Security
+    using Refinements
+
+    attr_reader :uri, :config
+
+    def initialize(uri, **config)
+      @uri = uri
+      @config = config
+    end
+
+    def sign_url(request_uri)
+      query = uri.query_values || {}
+      uri.query_values = query.merge(ci_sign: signature(request_uri))
+    end
+
+    def seal_url(path, sealed_params)
+      query = uri.query_values || {}
+      sealed_query = query.slice(*sealed_params)
+      query.keep_if { |k, _| !sealed_query.key?(k) }
+      eqs = eqs(sealed_query)
+      query[:ci_eqs] = eqs unless eqs.empty?
+      query[:ci_seal] = seal(path, eqs)
+      uri.query_values = query
+    end
+
+    private
+
+    def signature(request_uri)
+      digest = Digest::SHA1.hexdigest(config[:salt] + request_uri)
+      trim(digest, config[:signature_length])
+    end
+
+    def eqs(query_params)
+      uri = Addressable::URI.new
+      uri.query_values = query_params
+      Base64.urlsafe_encode64(uri.query, padding: false)
+    end
+
+    def seal(path, eqs)
+      digest = Digest::SHA1.hexdigest(path + eqs + config[:salt])
+      trim(digest, config[:signature_length])
+    end
+
+    def trim(signature, length)
+      signature[0, length]
+    end
+  end
+end

data/lib/cloudimage/srcset.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Cloudimage
+  module Srcset
+    # 5760 is 3x 1920 (the largest common screen width):
+    # https://gs.statcounter.com/screen-resolution-stats
+    SRCSET_RANGE = (100..5_760).freeze
+    SRCSET_GROWTH_FACTOR = 1.67
+
+    def to_srcset(**extra_params)
+      srcset_widths
+        .map { |width| "#{to_url(**extra_params, w: width)} #{width}w" }
+        .join(', ')
+    end
+
+    private
+
+    def srcset_widths
+      current = SRCSET_RANGE.begin
+
+      [].tap do |widths|
+        loop do
+          widths << current
+          current = (current * SRCSET_GROWTH_FACTOR).round(-1)
+
+          break if current >= SRCSET_RANGE.end && widths << SRCSET_RANGE.end
+        end
+      end
+    end
+  end
+end

data/lib/cloudimage/uri.rb

@@ -1,31 +1,35 @@
 # frozen_string_literal: true
 
-require 'digest'
+require 'set'
 
 require_relative 'params'
 require_relative 'custom_helpers'
+require_relative 'security'
+require_relative 'srcset'
+require_relative 'refinements'
 
 module Cloudimage
   class URI
+    using Refinements
+
     include Params
     include CustomHelpers
+    include Srcset
 
-    attr_reader :uri, :params, :config
+    attr_reader :path, :uri, :params, :config, :sealed_params
 
     def initialize(path, **config)
       @config = config
       @params = {}
-      @uri = build_uri_from(path)
+      @sealed_params = Set.new
+      @path = transform(path)
+      @uri = build_uri
     end
 
     PARAMS.each do |param|
       define_method param do |*args|
-        @params[param] = if args.any?
-                           args.join(',')
-                         else
-                           # Flag params don't need to pass in arguments.
-                           @params[param] = 1
-                         end
+        # Flag params don't need to pass in arguments.
+        params[param] = args.any? ? args.join(',') : 1
         self
       end
     end
@@ -36,43 +40,75 @@ module Cloudimage
 
     def to_url(**extra_params)
       set_uri_params(**extra_params)
-      sign_url
+      secure_url
+      uri.to_s
     end
 
     private
 
-    def base_url
+    def site
+      return "https://#{config[:cname]}" if config[:cname]
+
       "https://#{config[:token]}.cloudimg.io"
     end
 
-    def base_url_with_api_version
-      "#{base_url}/#{config[:api_version]}"
+    def api_version
+      "/#{config[:api_version]}"
+    end
+
+    def transform(path)
+      path
+        .then { |input| input.start_with?('/') ? input : "/#{input}" }
+        .then(&method(:apply_aliases))
+    end
+
+    def apply_aliases(path)
+      # path and aliases can be frozen
+      aliases = config[:aliases].dup
+
+      aliases[default_alias] = ''
+
+      path.dup.tap do |input|
+        aliases.each do |source, target|
+          input.sub!(source, target)
+        end
+      end
     end
 
-    def build_uri_from(path)
-      formatted_path = path.start_with?('/') ? path : "/#{path}"
-      Addressable::URI.parse(base_url_with_api_version + formatted_path)
+    def default_alias
+      config[:include_api_version] ? "#{site}#{api_version}/" : "#{site}/"
+    end
+
+    def request_uri
+      uri.request_uri.delete_prefix(api_version)
+    end
+
+    def build_uri
+      if config[:include_api_version]
+        Addressable::URI.parse(site + api_version + path)
+      else
+        Addressable::URI.parse(site + path)
+      end
     end
 
     def set_uri_params(**extra_params)
+      seal_params(*extra_params.delete(:seal_params))
       url_params = params.merge(**extra_params)
       return unless url_params.any?
 
       uri.query_values = url_params
     end
 
-    def sign_url
-      url = uri.to_s
-
-      return url if config[:salt].nil?
+    def secure_url
+      return uri.to_s if config[:salt].nil?
 
-      url + "#{uri.query_values ? '&' : '?'}ci_sign=#{signature}"
-    end
+      security = Security.new(uri, **config)
 
-    def signature
-      path = uri.to_s.sub(base_url_with_api_version, '')
-      digest = Digest::SHA1.hexdigest(config[:salt] + path)
-      digest[0..(config[:signature_length] - 1)]
+      if config[:sign_urls]
+        security.sign_url(request_uri)
+      else
+        security.seal_url(path, sealed_params)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudimage
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Jan Klimo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description: Fast and easy image resizing, transformation, and acceleration in the
   Cloud.
 email:
@@ -40,9 +68,12 @@ files:
 - lib/cloudimage.rb
 - lib/cloudimage/client.rb
 - lib/cloudimage/custom_helpers.rb
+- lib/cloudimage/invalidation.rb
 - lib/cloudimage/params.rb
+- lib/cloudimage/refinements.rb
+- lib/cloudimage/security.rb
+- lib/cloudimage/srcset.rb
 - lib/cloudimage/uri.rb
-- lib/cloudimage/version.rb
 homepage: https://github.com/scaleflex/cloudimage-rb
 licenses:
 - MIT

data/lib/cloudimage/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Cloudimage
-  VERSION = '0.2.1'
-end