jekyll-imgix 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcc0896dee63a15f24f338b8ee48bc23b72700f0
-  data.tar.gz: 6eb269d548e05b09b9ad3a8a374c9071f3af9b21
+  metadata.gz: ad542865239aa228fb356a581da7951434cf636f
+  data.tar.gz: 7d0eda8c4b5386e569ff9aa2f1b608aadb6aefbb
 SHA512:
-  metadata.gz: 9e1721b02ebeb74f4541bd907b0b8f0489ed82ce0f9f527d8a41c7748d0e0df53f7f6ecb22b07291efdd9259ff4b7e858e81da38cafaaec588e7cf371b44d276
-  data.tar.gz: 4fec6483213f8198f5fd1302b5e656518a20af655c74c87ff73d9424a6979a526423675665fab5f5f392ca3bf65ddbd12f9fa0e388ba78396fd62448e761a00e
+  metadata.gz: 11714543b0029e5a2015912fb944340695c228f3e6e4636f15d8f43e7c042ddc15752515722d91f83969839b26c1cf041da86be2b736f15b35646a273dc331c5
+  data.tar.gz: 43c326ae062487653bf2939660f13094f07dd95aa7d593834582396da3d61cd02866301a70206b5ffc6e09f9756c6890d775df084275601732587d8f3244743a

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.2.0](https://github.com/imgix/imgix-rb/compare/1.1.0...1.2.0) - December 18, 2019
+
+* feat: add multi-source support ([#11](https://github.com/imgix/jekyll-imgix/pull/11))

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2018, Zebrafish Labs Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+	Redistributions of source code must retain the above copyright notice,
+	this list of conditions and the following disclaimer.
+
+	Redistributions in binary form must reproduce the above copyright notice,
+	this list of conditions and the following disclaimer in the documentation 
+	and/or other materials provided with the distribution.
+	
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,6 +1,23 @@
-# jekyll-imgix ![Travis Build Status](https://travis-ci.org/imgix/jekyll-imgix.svg)
+<!-- ix-docs-ignore -->
+![imgix logo](https://assets.imgix.net/sdk-imgix-logo.svg)
 
-A simple Jekyll plugin for rolling imgix functionality into your Jekyll site.
+A Jekyll plugin for integrating imgix into Jekyll sites.
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-imgix.svg)](https://rubygems.org/gems/jekyll-imgix)
+[![Build Status](https://travis-ci.org/imgix/jekyll-imgix.svg)](https://travis-ci.org/imgix/jekyll-imgix)
+![Downloads](https://img.shields.io/gem/dt/jekyll-imgix)
+[![License](https://img.shields.io/github/license/imgix/drift)](https://github.com/imgix/jekyll-imgix/blob/master/LICENSE)
+
+---
+<!-- /ix-docs-ignore -->
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+  - [Multi Source Configuration](#multi-source-configuration)
+- [Usage](#usage)
+  - [Multi Source Usage](#multi-source-usage)
+- [Contributing](#contributing)
+- [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
@@ -21,6 +38,31 @@ Then include `jekyll-imgix` in the `gems:` section of your `_config.yml` file:
 gems: [jekyll/imgix]
 ```
 
+## Configuration
+
+jekyll-imgix requires a configuration block in your `_config.yml`:
+
+```yaml
+imgix:
+  source: assets.imgix.net # Your imgix source address
+  secure_url_token: FACEBEEF12 # (optional) The Secure URL Token associated with your source
+  include_library_param: true  # (optional) If `true` all the URLs will include `ixlib` parameter
+```
+
+### Multi-source configuration
+
+In addition to the standard configuration flags, the following options can be used to serve images across different sources.
+
+```yaml
+imgix:
+  sources:  # imgix source-secure_url_token key-value pairs.
+    assets.imgix.net: FACEBEEF12
+    assets2.imgix.net:            # Will generate unsigned URLs
+  default_source: assets.imgix.net  # (optional) specify a default source for generating URLs.
+```
+
+Note: `sources` and `source` *cannot* be used together.
+
 ## Usage
 
 **jekyll-imgix does not do anything unless JEKYLL_ENV is set to production**. For example,
@@ -29,7 +71,7 @@ production.
 
 jekyll-imgix exposes its functionality as a single Jekyll Filter, `imgix_url`.
 
-Simply pass an existing image path to it to activate it:
+Pass an existing image path to it to activate it:
 
 ```html
 <img src={{ "/images/bear.jpg" | imgix_url }} />
@@ -53,22 +95,27 @@ Which would result in the following HTML:
 <img src="https://assets.imgix.net/images/bear.jpg?w=400&h=300" />
 ```
 
-### Configuration
+### Multi-source usage
 
-jekyll-imgix requires a configuration block in your `_config.yml`:
+To use jekyll-imgix in a multi-source setup:
 
-```yaml
-imgix:
-  source: assets.imgix.net # Your imgix source address
-  secure_url_token: FACEBEEF12 # (optional) The Secure URL Token associated with your source
+```html
+<img src={{ "/images/bear.jpg" | imgix_url: "assets2.imgix.net", w: 400, h: 300 }} />
+<img src={{ "/images/bear.jpg" | imgix_url: w: 400, h: 300 }} />  <!-- will use default_source from config -->
 ```
 
-## Contributing
+Which would generate:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/imgix/jekyll-imgix.
+```html
+<img src="https://assets2.imgix.net/images/bear.jpg?w=400&h=300" />
+<img src="https://assets.imgix.net/images/bear.jpg?w=400&h=300" />
+```
 
+In absence of correctly configured `default_source`, `imgix_url` will report `RuntimeError` if it's used without specifying a valid source.
 
-## License
+## Contributing
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on GitHub at https://github.com/imgix/jekyll-imgix.
 
+## Code of Conduct
+Users contributing to or participating in the development of this project are subject to the terms of imgix's [Code of Conduct](https://github.com/imgix/code-of-conduct).

data/jekyll-imgix.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A simple Ruby gem to bring imgix to your Jekyll site.}
   spec.homepage      = "https://github.com/imgix/jekyll-imgix"
-  spec.license       = "MIT"
+  spec.license       = "BSD-2-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"

data/lib/jekyll/imgix.rb

@@ -4,36 +4,88 @@ require "liquid"
 
 module Jekyll
   module Imgix
-    def imgix_url(raw, opts={})
-      return raw unless production?
-      verify_config_present!
-      client.path(raw).to_url(opts)
+    def imgix_url(*args)
+      case args.size
+      when 1
+        path = args[0]
+        source = nil
+        options = {}
+      when 2
+        if args[0].is_a?(String) && args[1].is_a?(Hash)
+          path = args[0]
+          source = nil
+          options = args[1]
+        elsif args[0].is_a?(String) && args[1].is_a?(String)
+          path = args[0]
+          source = args[1]
+          options = {}
+        else
+          raise RuntimeError.new("path and source must be of type String; options must be of type Hash")
+        end
+      when 3
+        path = args[0]
+        source = args[1]
+        options = args[2]
+      else
+        raise RuntimeError.new('path missing')
+      end
+
+      return path unless production?
+
+      verify_config!
+      imgix_client(source).path(path).to_url(options)
     end
 
   private
 
-    def verify_config_present!
-      unless @context.registers[:site].config['imgix']
+    DEFAULT_OPTS = {
+      library_param: "jekyll",
+      library_version: VERSION,
+      use_https: true
+    }.freeze
+
+
+    def verify_config!
+      config = @context.registers[:site].config['imgix']
+      unless config
         raise StandardError.new("No 'imgix' section present in _config.yml. Please see https://github.com/imgix/jekyll-imgix for configuration instructions")
       end
+      if !(config['source'] || config['sources'])
+        raise StandardError.new("One of 'source', 'sources' is required")
+      end
+      if (config['source'] && config['sources'])
+        raise StandardError.new("'source' and 'sources' can't be used together")
+      end
+    end
+
+    def imgix_client(src)
+      begin
+        return imgix_clients.fetch(src)
+      rescue KeyError
+        raise RuntimeError.new("Unknown source '#{src}'")
+      end
     end
 
-    def client
-      return @client if @client
+    def imgix_clients
+      return @imgix_clients if @imgix_clients
 
-      opts = default_opts.dup
+      opts = DEFAULT_OPTS.dup
       opts[:secure_url_token] = secure_url_token if secure_url_token
       opts[:include_library_param] = include_library_param?
-      @client = ::Imgix::Client.new(opts)
-    end
 
-    def default_opts
-      {
-        host: source,
-        library_param: "jekyll",
-        library_version: VERSION,
-        use_https: true
-      }
+      @imgix_clients = {}
+      sources.map do |source, token|
+        opts[:host] = source
+        opts[:secure_url_token] = token
+        @imgix_clients[source] = ::Imgix::Client.new(opts)
+      end
+
+      begin
+        @imgix_clients[nil] = @imgix_clients.fetch(default_source || source)
+      rescue
+      end
+
+      @imgix_clients
     end
 
     def production?
@@ -52,6 +104,18 @@ module Jekyll
       ix_config.fetch('source', nil)
     end
 
+    def sources
+      begin
+        return ix_config.fetch('sources')
+      rescue
+        return { ix_config.fetch('source') => secure_url_token }
+      end
+    end
+
+    def default_source
+      ix_config.fetch('default_source', nil)
+    end
+
     def secure_url_token
       ix_config.fetch('secure_url_token', nil)
     end

data/lib/jekyll/imgix/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Imgix
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-imgix
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - kellysutton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imgix
@@ -90,8 +90,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -101,7 +102,7 @@ files:
 - lib/jekyll/imgix/version.rb
 homepage: https://github.com/imgix/jekyll-imgix
 licenses:
-- MIT
+- BSD-2-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A simple Ruby gem to bring imgix to your Jekyll site.

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 kellysutton
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.