jekyll-flickr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '08d52c799b1be3a7e36cec03f8a9bef0077b3157'
+  data.tar.gz: c588c8f2a4bd69aa051c84b571bb489bab40d4d2
+SHA512:
+  metadata.gz: 3bfbeec7b14f0ee7c771868a87b51fc1ee7798e1e1020bcdeb68834bfde30824c1939d38668cd8bccd2c55225c4cccb59b69646c6e7cfc3cd2926ad48cc5a72a
+  data.tar.gz: 8a84fef0dc6a3c82766d01cc935322c76119978018208c7e9617c8dfa1947434ed54469dd2d2d9f177d77a6c8993c051e95d4837ab4433a1f6a730644f9c422e

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## HEAD
+
+
+## 0.1.0 / 2017-04-08
+
+  * Birthday!
+  * move monkey patched code to a proper Jekyll Tag plug-in

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+if ENV["GH_PAGES"]
+  gem "github-pages"
+elsif ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017-present Robert Riemann and jekyll-onebox contributors
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,116 @@
+# Jekyll::Flickr
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-flickr.svg)](https://badge.fury.io/rb/jekyll-flickr)
+
+Liquid tag for responsive [Flickr] images using [HTML5 srcset](http://alistapart.com/article/responsive-images-in-practice): `{% flickr %}`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    $ gem 'jekyll-flickr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-flickr
+
+Then add the following to your site's `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-flickr
+```
+
+💡 If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
+
+You must further provide two [Flickr API credentials](https://www.flickr.com/services/api/keys/). You can either use environment variables `FLICKR_API_KEY` and `FLICKR_API_SECRET` or the `_config.yml`:
+
+```yml
+flickr:
+  api_key: <flickr_api_key>
+  api_secret: <flickr_shared_secret>
+```
+
+💡 API requests are cached in `.jekyll-cache/flickr` for faster builds.
+
+## Usage
+
+Use the tag as follows in your Jekyll pages, posts and collections:
+
+```liquid
+{% flickr photo_id "Caption" img_attributes %}
+```
+- The `photo_id` is required and determines the photo from Flickr. In the URL <http://alistapart.com/article/responsive-images-in-practice>, the photo_id is the number in the path after the author (here also a number), i.e. `38285149681`.
+- The `Caption` is optional and must be enclosed by double quotation marks. So far, double quotation marks in captions are not supported.
+- The `img_attributes` are any optional text that will be included in the `<img>` tag.
+
+Example:
+
+```liquid
+{% flickr 38285149681 "My favourite photo of the month." style="float: right;"}
+```
+
+This will create the following HTML output:
+
+```html
+<figure>
+  <img src="https://farm5.staticflickr.com/4570/38285149681_f7323259a3_c.jpg" srcset="https://farm5.staticflickr.com/4570/38285149681_f7323259a3_n.jpg 320w, https://farm5.staticflickr.com/4570/38285149681_f7323259a3_z.jpg 640w, https://farm5.staticflickr.com/4570/38285149681_f7323259a3_c.jpg 800w, https://farm5.staticflickr.com/4570/38285149681_f7323259a3_b.jpg 1024w, https://farm5.staticflickr.com/4570/38285149681_2436f15109_h.jpg 1600w" sizes="100vw" style="float: right;" alt="My favourite photo of the month.">
+  <figcaption>
+    <div class="caption">My favourite photo of the month.</div>
+    <div class="license">
+      © Flickr/<a href="https://www.flickr.com/photos/140750848@N04/38285149681/">moulichoudari</a>
+      <a href="https://creativecommons.org/licenses/by/2.0/">CC Attribution License</a>
+    </div>
+  </figcaption>
+</figure>
+```
+
+## Configuration
+
+```yml
+flickr:
+  api_key: <flickr_api_key>
+  api_secret: <flickr_shared_secret>
+  widths: [320, 640, 800, 1024, 1600]
+  width_legacy: 800
+  width_viewport: 100vw
+  figcaption: true
+  license: true
+  caption: true
+```
+
+The Flickr API provides images in a [number of sizes](https://www.flickr.com/services/api/flickr.photos.getSizes.html) (e.g. 75, 150, 100, 240, 320, 500, 640, 1024, 3648). The `widths` allows to filter for sizes to be included in the `srcset` attribute. The size `width_legacy` chosen from the supported sizes is used by [browsers with no support](https://caniuse.com/#feat=srcset) for the `srcset` attribute.
+
+The configuration option `width_viewport` allows to define the occupying width of the photos. It is used to set the `sizes` attribute. [More Information](http://alistapart.com/article/responsive-images-in-practice)
+
+## TODO
+
+- allow more control on cache expiration
+- allow for custom templates globally configured
+- allow for templates per tag via some arguments
+- block version (`Liquid::Block`) that allows to enclosure the caption
+- use a more sophisticated RegExp to allow for captions with quotation marks
+
+## Similar Projects
+
+- [jekyll-flickresponsive.rb](https://gist.github.com/mikka2061/e8ddb2566d90b00f990d6a39b0fd1346) using the `<picture>` tag for responsive images.
+- <https://github.com/j0k3r/jekyll-flickr-photoset>
+- <https://github.com/cnunciato/jekyll-flickr>
+- <https://github.com/lawmurray/indii-jekyll-flickr>
+- <https://github.com/tsmango/jekyll_flickr_set_tag>
+
+
+## Contributing
+
+1. Fork it ( https://github.com/rriemann/jekyll-flickr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+[Flickr]: https://www.flickr.com/

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/jekyll-flickr.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-flickr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-flickr"
+  spec.version       = Jekyll::Onebox::VERSION
+  spec.authors       = ["Robert Riemann"]
+  spec.email         = ["robert@riemann.cc"]
+  spec.summary       = "Liquid tag for responsive Flickr images using HTML5 srcset."
+  spec.homepage      = "https://github.com/rriemann/jekyll-flickr"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.1"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  # spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll-cache", "~> 1.2"
+  spec.add_dependency "flickraw-cached", ">= 20120701"
+  spec.add_dependency "flickraw", "~> 0.9.9"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "jekyll", ">= 3.0"
+  spec.add_development_dependency "rake"
+end

data/lib/jekyll-flickr.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "jekyll-onebox/version"
+require "jekyll-onebox/flickr_tag"
+
+module Jekyll
+  module Flickr
+  end
+end

data/lib/jekyll-flickr/flickr_tag.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'flickraw-cached'
+
+module Jekyll
+  module Flickr
+    class FlickrTag < Liquid::Tag
+
+      # selection of sizes from those offered by Flickr API
+      DEFAULT_CONFIG = {
+        'widths' => [320, 640, 800, 1024, 1600],
+        'width_legacy' => 800,
+        'figcaption' => true,
+        'license' => true,
+        'caption' => true,
+        'width_viewport' => '100vw'
+      }
+
+      # Flickr licenses from (added CC myself)
+      # https://www.flickr.com/services/api/flickr.photos.licenses.getInfo.html
+      LICENSES = [
+        {
+          name: "All Rights Reserved", url: ""
+        },
+        {
+          name: "CC Attribution-NonCommercial-ShareAlike License",
+          url: "https://creativecommons.org/licenses/by-nc-sa/2.0/"
+        },
+        {
+          name: "CC Attribution-NonCommercial License",
+          url: "https://creativecommons.org/licenses/by-nc/2.0/"
+        },
+        {
+          name: "CC Attribution-NonCommercial-NoDerivs License",
+          url: "https://creativecommons.org/licenses/by-nc-nd/2.0/"
+        },
+        {
+          name: "CC Attribution License",
+          url: "https://creativecommons.org/licenses/by/2.0/"
+        },
+        {
+          name: "CC Attribution-ShareAlike License",
+          url: "https://creativecommons.org/licenses/by-sa/2.0/"
+        },
+        {
+          name: "CC Attribution-NoDerivs License",
+          url: "https://creativecommons.org/licenses/by-nd/2.0/",
+        },
+        {
+          name: "No known copyright restrictions",
+          url: "https://www.flickr.com/commons/usage/"
+        },
+        {
+          name: "United States Government Work",
+          url: "http://www.usa.gov/copyright.shtml"
+        },
+        {
+          name: "Public Domain Dedication (CC0)",
+          url: "https://creativecommons.org/publicdomain/zero/1.0/"
+        },
+        {
+          name: "Public Domain Mark",
+          url: "https://creativecommons.org/publicdomain/mark/1.0/"
+        }
+      ]
+
+      def initialize(tag_name, text, tokens)
+        super
+
+        @text = text.strip
+      end
+
+      def render(context)
+        config = DEFAULT_CONFIG.merge(context.registers[:site].config['flickr'])
+
+        match = /(?<photo_id>\d+)(\s(\"(?<caption>[^"]+)\"))?(?<attr>.*)/.match @text
+
+        photo_id = match.named_captures['photo_id']
+        photo_caption = match.named_captures['caption']
+        photo_attr = match.named_captures['attr']
+
+        cache = Jekyll::Cache::FileStore.new 'flickr'
+        photo_data = cache.fetch photo_id do
+          FlickRaw.api_key = ENV['FLICKR_API_KEY'] || config['api_key']
+          FlickRaw.shared_secret = ENV['FLICKR_API_SECRET'] || config['api_secret']
+          {
+            info:  flickr.photos.getInfo(photo_id: photo_id),
+            sizes: flickr.photos.getSizes(photo_id: photo_id)
+          }
+        end
+
+        widths = config['widths'] + [config['width_legacy']]
+        photo_sizes = photo_data[:sizes].select{ |photo| widths.include?(photo['width'].to_i) }
+        photo_legacy = photo_data[:sizes].find{ |photo| photo['width'].to_i == config['width_legacy']}
+
+        srcset = photo_sizes.map{|photo| "#{photo['source']} #{photo['width']}w"}.join(", ")
+
+        sizes = unless photo_attr.include?('sizes=') then
+          context.registers[:site].config['flickr']['width_viewport']
+        else
+          ""
+        end
+
+        if photo_caption and not photo_attr.include?('alt=') then
+          photo_attr += " alt=\"#{photo_caption}\""
+        end
+
+        img_tag = "<img src=\"#{photo_legacy.source}\" srcset=\"#{srcset}\" sizes=\"#{sizes}\" #{photo_attr}>"
+
+        return img_tag if not config['figcaption']
+
+        photo_license = if config['license'] then
+          license = LICENSES[photo_data[:info].license.to_i]
+
+          owner_link = "&copy; Flickr/<a href=\"#{photo_data[:info]['urls'].first['_content']}\">#{photo_data[:info]['owner']['username']}</a>"
+
+          puts license.inspect
+
+          license_link = if license[:url]
+            "<a href=\"#{license[:url]}\">#{license[:name]}</a>"
+          else
+            license[:name]
+          end
+          "<div class=\"license\">#{owner_link} #{license_link}</div>"
+        else
+          ""
+        end
+
+        photo_caption = if config['caption'] and photo_caption then
+          "<div class=\"caption\">#{photo_caption}</div>"
+        else
+          ""
+        end
+
+        return img_tag if photo_license.empty? and photo_caption.empty?
+
+        return <<-HTML
+<figure>
+  #{img_tag}
+  <figcaption>#{photo_caption}#{photo_license}</figcaption>
+</figure>
+        HTML
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('flickr', Jekyll::Flickr::FlickrTag)

data/lib/jekyll-flickr/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Onebox
+    VERSION = "0.1.0".freeze
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-flickr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Riemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: flickraw-cached
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '20120701'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '20120701'
+- !ruby/object:Gem::Dependency
+  name: flickraw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- robert@riemann.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-flickr.gemspec
+- lib/jekyll-flickr.rb
+- lib/jekyll-flickr/flickr_tag.rb
+- lib/jekyll-flickr/version.rb
+homepage: https://github.com/rriemann/jekyll-flickr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Liquid tag for responsive Flickr images using HTML5 srcset.
+test_files: []