cloudimage 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e8f90abd62c87ace671bfb901dc04fe4acd45eb4bdef4d85a5b3208d0b3b3e
-  data.tar.gz: 683086c1cd095ee0121a17d30d498f11a29d558b6e855b55b5d3a4232e312b08
+  metadata.gz: c02d5fa30289aa70eb6b0d94e13f31130e5c1918ffb18d45197bb0b62cda26de
+  data.tar.gz: ce5da501f8200577f7c9003dba581b59f88628c99a03d54fa662ed0f336737fd
 SHA512:
-  metadata.gz: b409ab0b86ba4b26c4b0e2d8d36b201f1383bdeaa67e729982eecf7ff3ad0ab142e876cb5c3294cb81ea28b985da3903f4a947f0b300e08938dd806cab1fa842
-  data.tar.gz: 4bd6d593d935c1a74cf1a6a5d440337937c88dc530d57ef71f3bc3b38b8a902bd3088b513df13700cef2c25d6d0901ac3381c5aba2dddcb967ec43f04fa7f639
+  metadata.gz: f698aefba14fee30249e29e431cf53d1e25440c97c08731ac4c050ba0bc58a95eeeac93143301fdd7cc31d7e96a4cdedac653aa832b61adf2f8c2a7681748d52
+  data.tar.gz: 3a58f037be0329dfbdfd4c1b0d0a71848caaf7d9c42fc1e9425d5f4c43015b81ee60cec29ef84cbf3318a6c195af851d82ab042d12166e7e98ae16bacff5bf2b

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [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)
@@ -15,7 +24,6 @@
 **Implemented enhancements:**
 
 - Introduce URL sealing [\#10](https://github.com/scaleflex/cloudimage-rb/pull/10) ([janklimo](https://github.com/janklimo))
-- Add support for image resizing [\#2](https://github.com/scaleflex/cloudimage-rb/pull/2) ([janklimo](https://github.com/janklimo))
 
 **Merged pull requests:**
 

data/README.md

@@ -2,8 +2,7 @@
 
 [![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`.
 
@@ -15,7 +14,9 @@ Supports Ruby `2.4` and above, `JRuby`, and `TruffleRuby`.
     - [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)
@@ -57,15 +58,16 @@ client = Cloudimage::Client.new(token: 'mysecrettoken')
 
 Cloudimage client accepts the following options:
 
-| 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).          |
+| 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
@@ -128,9 +130,8 @@ For a list of custom helpers available to you, please consult
 
 ### URL aliases
 
-Specify [aliases](https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/domains-urls/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.
+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'
@@ -139,8 +140,7 @@ 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](https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/domains-urls/origin-url-prefix)
-is just another form of URL alias. Simply make the target value an empty string:
+[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/'
@@ -149,6 +149,29 @@ 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
@@ -160,6 +183,17 @@ 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
@@ -182,8 +216,7 @@ 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](https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/responsive-images).
+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.
 
@@ -236,8 +269,7 @@ client.invalidate_urls('/v7/image.jpg?w=200', '/v7/image.jpg?h=300')
 client.invalidate_all
 ```
 
-Consult the [API docs](https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/caching-acceleration/invalidation-api)
-for further details.
+Consult the [invalidation API docs][invalidation-docs] for further details.
 
 ## Development
 
@@ -250,8 +282,7 @@ experiment.
 
 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
 
@@ -261,7 +292,15 @@ are expected to adhere to the
 
 Among others, `cloudimage` is used to power the following apps:
 
-- [Robin PRO](https://apps.shopify.com/robin-pro-image-gallery) - Fast, beautiful, mobile-friendly image galleries for Shopify stores.
+- [Robin PRO][robin-pro] - Fast, beautiful, mobile-friendly image galleries for Shopify stores.
 
 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.
+
+[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
+[url-prefix]: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/domains-urls/origin-url-prefix

data/lib/cloudimage/client.rb

@@ -30,6 +30,8 @@ module Cloudimage
         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

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

@@ -5,6 +5,7 @@ require 'set'
 require_relative 'params'
 require_relative 'custom_helpers'
 require_relative 'security'
+require_relative 'srcset'
 require_relative 'refinements'
 
 module Cloudimage
@@ -13,6 +14,7 @@ module Cloudimage
 
     include Params
     include CustomHelpers
+    include Srcset
 
     attr_reader :path, :uri, :params, :config, :sealed_params
 
@@ -61,21 +63,29 @@ module Cloudimage
     end
 
     def apply_aliases(path)
-      return path if config[:aliases].empty?
+      config[:aliases][default_alias] = ''
 
       path.dup.tap do |input|
         config[:aliases].each do |source, target|
-          input.gsub!(source, target)
+          input.sub!(source, target)
         end
       end
     end
 
+    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
-      Addressable::URI.parse(site + api_version + path)
+      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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudimage
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jan Klimo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,6 +72,7 @@ files:
 - lib/cloudimage/params.rb
 - lib/cloudimage/refinements.rb
 - lib/cloudimage/security.rb
+- lib/cloudimage/srcset.rb
 - lib/cloudimage/uri.rb
 homepage: https://github.com/scaleflex/cloudimage-rb
 licenses: