cloudimage 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72e83343c301b5b791cd7fa5f88593fd3715cfa01d918e6d473aae4376022594
-  data.tar.gz: '059edd8cd34c45bf7226cd876fb10d64d4cefc93059996d6e12f66a0ccc2d96d'
+  metadata.gz: 67e8f90abd62c87ace671bfb901dc04fe4acd45eb4bdef4d85a5b3208d0b3b3e
+  data.tar.gz: 683086c1cd095ee0121a17d30d498f11a29d558b6e855b55b5d3a4232e312b08
 SHA512:
-  metadata.gz: 24d09cd09df390e46f6e9e0035ae3df80eb458a2b80c7f6f39d922c21c333063e4abd95302f63a007dc6da289301875b3bd7ec87c2c21daa2d08dd96799d8b29
-  data.tar.gz: 805d1c5b001cebd0deaf230111785284c69e6759e3d64f18d635df832195495a19afa209a1c0fc45484b44dd7ead82edff532747cfec12a8d838851cfc7607fa
+  metadata.gz: b409ab0b86ba4b26c4b0e2d8d36b201f1383bdeaa67e729982eecf7ff3ad0ab142e876cb5c3294cb81ea28b985da3903f4a947f0b300e08938dd806cab1fa842
+  data.tar.gz: 4bd6d593d935c1a74cf1a6a5d440337937c88dc530d57ef71f3bc3b38b8a902bd3088b513df13700cef2c25d6d0901ac3381c5aba2dddcb967ec43f04fa7f639

data/CHANGELOG.md

@@ -1,18 +1,25 @@
 # Changelog
 
+## [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)
 
-**Closed issues:**
+**Implemented enhancements:**
 
-- Add URL sealing [\#12](https://github.com/scaleflex/cloudimage-rb/issues/12)
-- Add automatic changelog generation [\#11](https://github.com/scaleflex/cloudimage-rb/issues/11)
+- 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:**
 
 - Use changelog generation [\#16](https://github.com/scaleflex/cloudimage-rb/pull/16) ([janklimo](https://github.com/janklimo))
-- Introduce URL sealing [\#10](https://github.com/scaleflex/cloudimage-rb/pull/10) ([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)

data/README.md

@@ -15,9 +15,11 @@ Supports Ruby `2.4` and above, `JRuby`, and `TruffleRuby`.
     - [Method aliases](#method-aliases)
     - [Custom helpers](#custom-helpers)
     - [URL aliases](#url-aliases)
+    - [CNAME](#cname)
     - [Security](#security)
       - [URL signature](#url-signature)
       - [URL sealing](#url-sealing)
+    - [Invalidation API](#invalidation-api)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -41,7 +43,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)
@@ -55,13 +57,15 @@ client = Cloudimage::Client.new(token: 'mysecrettoken')
 
 Cloudimage client accepts the following options:
 
-| Option             | Required? | Type    | Additional info                                     |
-| ------------------ | --------- | ------- | --------------------------------------------------- |
-| `token`            | Yes       | string  |                                                     |
-| `salt`             | No        | string  | See [Security](#security).                          |
-| `signature_length` | No        | integer | Integer value in the range `6..40`. Defaults to 18. |
-| `sign_urls`        | No        | boolean | Defaults to `true`. See [Security](#security).      |
-| `aliases`          | No        | hash    | See [URL aliases](#url-aliases).                    |
+| 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).          |
 
 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
@@ -145,6 +149,17 @@ client.path('https://store.s3-us-west-2.amazonaws.com/uploads/image.jpg').to_url
 # => "https://token.cloudimg.io/v7/image.jpg"
 ```
 
+### 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'
+```
+
 ### Security
 
 #### URL signature
@@ -201,6 +216,29 @@ client
 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 [API docs](https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/caching-acceleration/invalidation-api)
+for further details.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/cloudimage/client.rb

@@ -1,27 +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
-      @config[:sign_urls] = options[:sign_urls].nil? ? true : false
-      @config[:aliases] = options[:aliases] || {}
-
-      ensure_valid_config
+      @config = set_config_defaults(options)
+      validate_config
     end
 
     def path(path)
@@ -30,18 +25,29 @@ 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[: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/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/uri.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 require_relative 'params'
 require_relative 'custom_helpers'
 require_relative 'security'
@@ -43,6 +45,8 @@ module Cloudimage
     private
 
     def site
+      return "https://#{config[:cname]}" if config[:cname]
+
       "https://#{config[:token]}.cloudimg.io"
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudimage
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jan Klimo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -68,6 +68,7 @@ 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