cloudimage 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b6b4cf631917e41ac56722f43b942e77714815d52ac15a7080e56173d776e5
-  data.tar.gz: 8b5d8d15e125b076908c6d9a9e36cffe13dce4c89b2b7586235ccbc0c4e8dd71
+  metadata.gz: abb64d67ac6a4a0d7e87cd0758c94497b1c31a96f4dcfc9a4d10d2b66e4460b6
+  data.tar.gz: f12f312eea0653ee858bcc0c124a842a574ee6e63b820832c93f275687d463e3
 SHA512:
-  metadata.gz: 4405e0f5eacfd9417fc300b801cafac50a1a9e352c64bf7e611e401e66d6ac6cde6743c9a00db116118f2ae8eb2433cc5dba99fe695bc3705b0dd96911db4589
-  data.tar.gz: 28126cfc5f7c63153a6ef57b0b1bad2bd93cd22d14b093f68fa340ab2a65d730d3d25f84b3d3bedf676cca92547f0bd6bf579f5d3b55807755f899e9e273f9aa
+  metadata.gz: ec3ede4d88539362085fe46726453aa9fca339bb875a2071c897d4797a093aef6caec2805e2927f363d0ea27f21ef319634513fc855e748b76366399840cb6aa
+  data.tar.gz: d292ff52e7d4219bdbf3a0668c22f9c26da414bc187246eeb97caf550c80762a54462f5752da08312f94233caa87c5a09c156519e94093e1e3d0ee833cf4093b

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 ## master
 
-## 0.1.0 (2020-08-09)
+## 0.2.0 (2020-06-28)
+
+- URL signatures.
+  [#6](https://github.com/scaleflex/cloudimage-rb/pull/6) (@janklimo)
+- Added the remaining API params so that they can be used as helpers.
+  [#7](https://github.com/scaleflex/cloudimage-rb/pull/7) (@janklimo)
+- We don't run `rubocop` on `truffleruby` anymore.
+  It [is not officially supported](https://docs.rubocop.org/rubocop/compatibility.html)
+  and leads to [unexpected issues](https://github.com/scaleflex/cloudimage-rb/runs/815208955?check_suite_focus=true).
+  [#7](https://github.com/scaleflex/cloudimage-rb/pull/7) (@janklimo)
+
+## 0.1.0 (2020-06-09)
 
 - Introduce base models: `Cloudimage::Client`, and `Cloudimage::URI`. Generate
   URLs via `to_url` method. Add support for image resizing params.

data/README.md

@@ -14,7 +14,9 @@ Supports Ruby `2.4` and above, `JRuby`, and `TruffleRuby`.
     - [Chainable helpers](#chainable-helpers)
     - [Aliases](#aliases)
     - [Custom helpers](#custom-helpers)
+    - [Security](#security)
   - [Development](#development)
+    - [TODOs](#todos)
   - [Contributing](#contributing)
   - [License](#license)
   - [Code of Conduct](#code-of-conduct)
@@ -49,6 +51,15 @@ object:
 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.             |
+
 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
 Cloudimage URLs.
@@ -108,6 +119,20 @@ 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.
 
+### Security
+
+If `salt` is defined, all URLs will be signed.
+
+You can control the length of the generated signature by specifying `signature_length`
+when initializing the client.
+
+```ruby
+client = Cloudimage::Client.new(token: 'mysecrettoken', salt: 'mysecretsalt', signature_length: 10)
+uri = client.path('/assets/image.png')
+uri.w(200).h(400).to_url
+# => "https://mysecrettoken.cloudimg.io/v7/assets/image.png?h=400&w=200&ci_sign=79cfbc458b"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -115,6 +140,13 @@ 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

data/lib/cloudimage/client.rb

@@ -6,30 +6,44 @@ module Cloudimage
   class InvalidConfig < StandardError; end
 
   class Client
-    attr_reader :token
+    attr_reader :config
 
     API_VERSION = 'v7'
+    DEFAULT_SIGNATURE_LENGTH = 18
 
-    def initialize(token: nil)
-      @token = token
+    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
     end
 
     def path(path)
-      URI.new(base_url_for(token), path)
+      URI.new(path, **config)
     end
 
     private
 
-    def base_url_for(token)
-      "https://#{token}.cloudimg.io/#{API_VERSION}"
+    def ensure_valid_config
+      ensure_valid_token
+      ensure_valid_signature_length
     end
 
-    def ensure_valid_config
-      return unless token.to_s.strip.empty?
+    def ensure_valid_token
+      return unless config[:token].nil?
 
       raise InvalidConfig, 'Please specify your Cloudimage customer token.'
     end
+
+    def ensure_valid_signature_length
+      return if config[:salt].nil?
+      return if (6..40).cover? config[:signature_length]
+
+      raise InvalidConfig, 'Signature length must be must be 6-40 characters.'
+    end
   end
 end

data/lib/cloudimage/params.rb

@@ -18,18 +18,45 @@ module Cloudimage
       bg_colourise
       bg_img_fit
       bg_opacity
+      blur
+      blur_faces
       br_px
+      bright
       ci_info
+      contrast
+      doc_page
+      f
+      force_format
       func
       gravity
+      gray
+      grey
       h
       height
+      optipress
       org_if_sml
+      p
+      pixelate
+      pixellate
+      process
+      q
       r
+      radius
       sharp
       tl_px
       trim
       w
+      wat
+      wat_color
+      wat_colour
+      wat_url
+      wat_font
+      wat_fontsize
+      wat_gravity
+      wat_opacity
+      wat_pad
+      wat_scale
+      wat_text
       width
     ].freeze
   end

data/lib/cloudimage/uri.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest'
+
 require_relative 'params'
 require_relative 'custom_helpers'
 
@@ -8,12 +10,12 @@ module Cloudimage
     include Params
     include CustomHelpers
 
-    attr_reader :uri, :params
+    attr_reader :uri, :params, :config
 
-    def initialize(base_url, path)
-      path = ensure_path_format(path)
-      @uri = Addressable::URI.parse(base_url + path)
+    def initialize(path, **config)
+      @config = config
       @params = {}
+      @uri = build_uri_from(path)
     end
 
     PARAMS.each do |param|
@@ -32,16 +34,45 @@ module Cloudimage
       alias_method from, to
     end
 
-    def to_url(extra_params = {})
-      url_params = params.merge(extra_params)
-      uri.query_values = url_params if url_params.any?
-      uri.to_s
+    def to_url(**extra_params)
+      set_uri_params(**extra_params)
+      sign_url
     end
 
     private
 
-    def ensure_path_format(path)
-      path.start_with?('/') ? path : "/#{path}"
+    def base_url
+      "https://#{config[:token]}.cloudimg.io"
+    end
+
+    def base_url_with_api_version
+      "#{base_url}/#{config[:api_version]}"
+    end
+
+    def build_uri_from(path)
+      formatted_path = path.start_with?('/') ? path : "/#{path}"
+      Addressable::URI.parse(base_url_with_api_version + formatted_path)
+    end
+
+    def set_uri_params(**extra_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?
+
+      url + "#{uri.query_values ? '&' : '?'}ci_sign=#{signature}"
+    end
+
+    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)]
     end
   end
 end

data/lib/cloudimage/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudimage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jan Klimo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -51,7 +51,7 @@ metadata:
   changelog_uri: https://github.com/scaleflex/cloudimage-rb/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/scaleflex/cloudimage-rb
   documentation_uri: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/introduction
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Official API wrapper for Cloudimage's API.
 test_files: []