jekyll-flickr 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36695c3c9dde937ec527bf19b34865327ec83248d5acab73ba1e88b84f6f79a9
-  data.tar.gz: 7092b44fc42b05d27716c2805f5fb5aa73be2d0fe264ff34d036d49a6dc4d996
+  metadata.gz: eb2f0ca419b0edf09cc93e3c122d8bf8c9325c9619951d3be4b35c5f18a0fd39
+  data.tar.gz: 78b24210551fd30062797d42460f94abc1a876c90731fe1dca938db93d2f8975
 SHA512:
-  metadata.gz: 7423f1d84db3884f2e2c2b9dcb5c266db713a33e71788ae478993bb141136f4961b4e310cc110d272f14a7c744522f00331b9fb09c875ef5e68441ed6bcc58dc
-  data.tar.gz: 0a71a46c59c36f8f8708096360acc253cf9533adce08785f75371f8e5e3d57e768bcd8e43558658923217692cca91cec4acca70de3baa8544de92349846fbc09
+  metadata.gz: d681c5b700606cf9547bd8215387f76cdc0cd65c7d51357d313eb474551e69c5e6f850e4807fa94f179aff18d98ecd8c50c0673f5cb6cfacb2641aacfe166b0d
+  data.tar.gz: 0f00350dabab634676e742fb53380565a882fbe0e920f4359b4091b40729c13c3fa384d3a84658e9295792ba70596a2790481525778ca168a05457d0028bc95d

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## HEAD
 
+## 0.2.1 / 2024-01-01
+
+  * fix: change cache name according to recommendation from <https://jekyllrb.com/tutorials/cache-api/>
+  * feature: Add flexibility to searching for the right picture width and some minor issues (courtesy of <akarwande@coredigital.com>)
+
+## 0.2.0 / 2021-02-25
+
+  * dependencies: require Jekyll 4.x and use gem flickr instead of flickraw
+  * use native Jekyll cache API (<https://jekyllrb.com/tutorials/cache-api/>) instead of jekyll-cache
+
+## 0.1.3 / 2019-03-13
+
+  * refactor: use simpler API provided by gem flickraw 0.9.10
+
 ## 0.1.2 / 2019-03-06
 
   * feature: reduce overhead due to class variables

data/jekyll-flickr.gemspec

@@ -7,7 +7,7 @@ require "jekyll-flickr/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-flickr"
-  spec.version       = Jekyll::Onebox::VERSION
+  spec.version       = Jekyll::Flickr::VERSION
   spec.authors       = ["Robert Riemann"]
   spec.email         = ["robert@riemann.cc"]
   spec.summary       = "Liquid tag for responsive Flickr images using HTML5 srcset."
@@ -21,10 +21,8 @@ Gem::Specification.new do |spec|
   # 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_dependency "flickr", "~> 2.0"
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "jekyll", ">= 3.0"
+  spec.add_development_dependency "jekyll", "~>4.0", "< 5.0"
   spec.add_development_dependency "rake"
 end

data/lib/jekyll-flickr/flickr_tag.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'flickraw-cached'
-require 'jekyll-cache'
+require 'flickr'
 
 module Jekyll
   module Flickr
     class FlickrTag < Liquid::Tag
+      CACHE_NAME = "Jekyll::Flickr::FlickrTag"
 
       # selection of sizes from those offered by Flickr API
       DEFAULT_CONFIG = {
@@ -73,15 +73,13 @@ module Jekyll
 
       def flickr
         @@flickr ||= begin
-          FlickRaw.api_key = ENV['FLICKR_API_KEY'] || config['api_key']
-          FlickRaw.shared_secret = ENV['FLICKR_API_SECRET'] || config['api_secret']
-
-          @@flickr = FlickRaw::Flickr.new
+          # by default, Flickr uses ENV FLICKR_API_KEY and FLICKR_SHARED_SECRET, support here legacy name FLICKR_API_SECRET, too
+          @@flickr = ::Flickr.new(ENV['FLICKR_API_KEY'] || config['api_key'], ENV['FLICKR_SHARED_SECRET'] || ENV['FLICKR_API_SECRET'] || config['api_secret'])
         end
       end
 
       def cache
-        @@cache ||= Jekyll::Cache::FileStore.new 'flickr'
+        @@cache ||= Jekyll::Cache.new(CACHE_NAME)
       end
 
       def config
@@ -90,13 +88,13 @@ module Jekyll
 
       def render(context)
 
-        match = /(?<photo_id>\d+)(\s(\"(?<caption>[^"]+)\"))?(?<attr>.*)/.match @text
+        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']
 
-        photo_data = cache.fetch photo_id, expires_in: -1 do # disable expiry in production and development environment
+        photo_data = cache.getset photo_id do
           {
             info:  flickr.photos.getInfo(photo_id: photo_id),
             sizes: flickr.photos.getSizes(photo_id: photo_id)
@@ -107,6 +105,25 @@ module Jekyll
         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']} || photo_data[:sizes].find{ |photo| photo['label'] == 'Original'}
 
+        # if these sizes are not found, pick the one closes to width_legacy
+        unless photo_legacy
+          candidate = nil
+          smallest_delta = nil
+          photo_data[:sizes].each do |photo|
+            current_delta = (photo['width'].to_i - config['width_legacy']).abs
+            if !smallest_delta || (current_delta < smallest_delta) 
+              candidate = photo
+              smallest_delta = current_delta
+            end
+          end
+          photo_legacy = candidate
+        end
+
+        # if no photo is found return
+        unless photo_legacy
+          return ""
+        end
+
         srcset = photo_sizes.map{|photo| "#{photo['source']} #{photo['width']}w"}.join(", ")
 
         sizes = unless photo_attr.include?('sizes=') then
@@ -121,7 +138,7 @@ module Jekyll
 
         img_tag = "<img class=\"flickr\" src=\"#{photo_legacy.source}\" srcset=\"#{srcset}\" sizes=\"#{sizes}\" #{photo_attr}>"
 
-        return img_tag if not config['figcaption']
+        return compute_html_tag(img_tag) if not config['figcaption']
 
         photo_license = if config['license'] then
           license = LICENSES[photo_data[:info].license.to_i]
@@ -144,12 +161,24 @@ module Jekyll
           ""
         end
 
-        return img_tag if photo_license.empty? and photo_caption.empty?
+        return compute_html_tag(img_tag) if photo_license.empty? and photo_caption.empty?
 
         return <<-HTML
 <figure class="flickr">
   #{img_tag}
   <figcaption>#{photo_caption}#{photo_license}</figcaption>
+</figure>
+        HTML
+      end
+
+      #######
+      private
+      #######
+
+      def compute_html_tag(img_tag)
+        return <<-HTML
+<figure class="flickr">
+  #{img_tag}
 </figure>
         HTML
       end

data/lib/jekyll-flickr/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jekyll
-  module Onebox
-    VERSION = "0.1.2".freeze
+  module Flickr
+    VERSION = "0.2.1".freeze
   end
 end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-flickr
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Robert Riemann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2024-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll-cache
+  name: flickr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   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
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +42,22 @@ dependencies:
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +72,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - robert@riemann.cc
 executables: []
@@ -115,7 +93,7 @@ homepage: https://github.com/rriemann/jekyll-flickr
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -130,9 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: Liquid tag for responsive Flickr images using HTML5 srcset.
 test_files: []