cloudimage 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06d221bc041ab617d9997d66e6d2c4b9f03dcbdcbbf4c05cb6b54f1c66f7c5f1
-  data.tar.gz: 2ed732e2099d6a3b1a9649da9840b303bef144f43b0cd2801e09f6d080361c28
+  metadata.gz: 72e83343c301b5b791cd7fa5f88593fd3715cfa01d918e6d473aae4376022594
+  data.tar.gz: '059edd8cd34c45bf7226cd876fb10d64d4cefc93059996d6e12f66a0ccc2d96d'
 SHA512:
-  metadata.gz: 5385f01daa66e04d394c8cc2d0257f367ba5f18f3f553ccc71a7341c4149975c94a5b707305cf3e3a6c93a6ff5a2346a459c623d7ca80aff35ca65c886dd0cb9
-  data.tar.gz: f4130b0bf5d7b40325e5a04f69a5e8dcbe117519369a517d4665788c3c78d0e84ba976d1c542bf0a06a38082893dd2342e695b8906e2ef9df54df0f807a389e9
+  metadata.gz: 24d09cd09df390e46f6e9e0035ae3df80eb458a2b80c7f6f39d922c21c333063e4abd95302f63a007dc6da289301875b3bd7ec87c2c21daa2d08dd96799d8b29
+  data.tar.gz: 805d1c5b001cebd0deaf230111785284c69e6759e3d64f18d635df832195495a19afa209a1c0fc45484b44dd7ead82edff532747cfec12a8d838851cfc7607fa

data/CHANGELOG.md

@@ -1,16 +1,18 @@
 # Changelog
 
-## [Unreleased](https://github.com/scaleflex/cloudimage-rb/tree/HEAD)
+## [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...HEAD)
+[Full Changelog](https://github.com/scaleflex/cloudimage-rb/compare/v0.2.1...v0.3.0)
 
 **Closed issues:**
 
+- 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)
 
 **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

@@ -1,6 +1,6 @@
 # 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).
@@ -12,15 +12,15 @@ 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)
     - [Security](#security)
       - [URL signature](#url-signature)
       - [URL sealing](#url-sealing)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
-  - [Code of Conduct](#code-of-conduct)
   - [Showcase](#showcase)
 
 ## Installation
@@ -55,13 +55,13 @@ 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.             |
-| `sign_urls`        | No        | Defaults to `true`. See [Security](#security).      |
+| 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).                    |
 
 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
@@ -104,7 +104,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.
@@ -122,6 +122,29 @@ 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](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.
+
+```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](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:
+
+```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"
+```
+
 ### Security
 
 #### URL signature
@@ -194,14 +217,7 @@ are expected to adhere to the
 
 ## License
 
-The gem is available as open source under the terms of the
-[MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-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).
+[MIT](https://opensource.org/licenses/MIT)
 
 ## Showcase
 

data/lib/cloudimage.rb

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

data/lib/cloudimage/client.rb

@@ -19,6 +19,7 @@ module Cloudimage
         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
     end

data/lib/cloudimage/refinements.rb

@@ -19,5 +19,29 @@ module Cloudimage
         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/uri.rb

@@ -18,7 +18,7 @@ module Cloudimage
       @config = config
       @params = {}
       @sealed_params = Set.new
-      @path = ensure_path_format(path)
+      @path = transform(path)
       @uri = build_uri
     end
 
@@ -50,8 +50,20 @@ module Cloudimage
       "/#{config[:api_version]}"
     end
 
-    def ensure_path_format(path)
-      path.start_with?('/') ? path : "/#{path}"
+    def transform(path)
+      path
+        .then { |input| input.start_with?('/') ? input : "/#{input}" }
+        .then(&method(:apply_aliases))
+    end
+
+    def apply_aliases(path)
+      return path if config[:aliases].empty?
+
+      path.dup.tap do |input|
+        config[:aliases].each do |source, target|
+          input.gsub!(source, target)
+        end
+      end
     end
 
     def request_uri

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudimage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jan Klimo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,7 +72,6 @@ files:
 - lib/cloudimage/refinements.rb
 - lib/cloudimage/security.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.3.0'
-end