jekyll-flickr-utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ecf9cfe481ab49cbdbe3cdda762544467f75be8b88f548fa4504953e804067e
+  data.tar.gz: 258a913fb9833ad2d12608860f6b3a9d0e4a542ca4c3f04b198223aae824a9c6
+SHA512:
+  metadata.gz: d23949729a14f7375428dc8d9731f0adee3f8b88e98743abaf6eddd8d488af3ddf8309773163bfcfd9484172cf282eb1a45032e0d086ef6f41496f53500a1d6d
+  data.tar.gz: 39eb671a361ab019ffe80b50f50caeff39b58f41ec2759c5f31280406e4f304abcfb8665d51a58acd22d853cef0c5e11ae92a5832a456f0d631bb67c82d90cd7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-present Alfred Xing and the jekyll-archives contributors
+
+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/lib/flickr_downloader.rb

@@ -0,0 +1,172 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'down'
+require 'fileutils'
+require 'flickr'
+require 'jekyll'
+require 'open-uri'
+require 'sorbet-runtime'
+require 'yaml'
+
+module FlickrDownloader
+  class Generator < Jekyll::Generator
+    extend T::Sig
+
+    LOG_TOPIC = 'Flickr Downloader:'
+    JEKYLL_ROOT = T.let(Jekyll.configuration.source({}), String)
+    MANIFEST_FILE_PATH = T.let("#{JEKYLL_ROOT}/_data/flickr_photosets.yaml", String)
+
+    ConfigType = T.type_alias { T::Hash[String, T.untyped] }
+    ManifestType = T.type_alias { T::Hash[String, T::Hash[String, String]] }
+
+    DEFAULTS = T.let(
+      {
+        'enabled' => false,
+        'image_root' => 'assets/images/flickr_photosets',
+        'force_refresh' => false,
+        'image_size' => 'url_k'
+      }.freeze,
+      ConfigType
+    )
+
+    sig { params(config: ConfigType).void }
+    def initialize(config = {})
+      super
+
+      @config = T.let(DEFAULTS.merge(config.fetch('flickr_downloader', {})), ConfigType)
+
+      @flickr = T.let(nil, T.nilable(Flickr))
+
+      return unless enabled?
+
+      @flickr = Flickr.new(@config['api_key'], @config['shared_secret'])
+      @flickr.access_token = @config['access_token']
+      @flickr.access_secret = @config['access_secret']
+    end
+
+    sig { returns(T::Boolean) }
+    def enabled?
+      @config['enabled']
+    end
+
+    sig { params(site: Jekyll::Site).void }
+    def generate(site)
+      unless enabled?
+        Jekyll.logger.warn(LOG_TOPIC, 'Plugin disabled via config!')
+        return
+      end
+
+      posts = site.posts.docs.select do |post|
+        !post.data.fetch('disable_flickr_download', false) && post.data.fetch('flickr_photoset_id', nil)
+      end
+
+      FileUtils.touch(MANIFEST_FILE_PATH) if posts && !File.exist?(MANIFEST_FILE_PATH)
+
+      posts.each do |post|
+        flickr_photoset_id = post.data['flickr_photoset_id']
+
+        if flickr_photoset_id.is_a?(Array)
+          flickr_photoset_id.each { |photoset_id| download_photoset(photoset_id.to_s, post) }
+        elsif flickr_photoset_id
+          download_photoset(flickr_photoset_id.to_s, post)
+        end
+      end
+    end
+
+    sig { params(flickr_photoset_id: String).returns(T::Boolean) }
+    private def should_download?(flickr_photoset_id)
+      data = YAML.load_file(MANIFEST_FILE_PATH) || {}
+      # Ensure we treat the photoset ID as a String instead of an integer
+      data = data.transform_keys(&:to_s)
+      data.fetch(flickr_photoset_id, nil).nil? || @config['force_refresh']
+    end
+
+    sig { params(url: String, destination: String).void }
+    private def download_photo(url, destination)
+      Down.download(url, destination: "#{JEKYLL_ROOT}/#{destination}")
+    end
+
+    sig { params(manifest: ManifestType).void }
+    private def write_manifest_file(manifest)
+      data = YAML.load_file(MANIFEST_FILE_PATH) || {}
+      data = data.merge(manifest)
+      File.write(MANIFEST_FILE_PATH, YAML.dump(data))
+    end
+
+    sig { params(photoset_id: String, directory: String).returns(ManifestType) }
+    private def download_photoset_photos(photoset_id, directory)
+      directory = directory.chomp('/')
+
+      Jekyll.logger.info(LOG_TOPIC, "Downloading photos from Flickr photoset #{photoset_id} to #{directory}...")
+
+      image_size = @config['image_size']
+      # NOTE: Sorbet cannot find the dynamically-generated methods.
+      photoset = T.let(@flickr, T.untyped).photosets.getPhotos(
+        photoset_id: photoset_id,
+        extras: "description,url_o,#{image_size}"
+      )
+
+      manifest_images = {}
+      primary_photo_id = photoset.primary
+      primary_photo_filename = T.let(nil, T.nilable(String))
+
+      photoset.photo.each_with_index do |photo, index|
+        # NOTE: If the image is too small, Flickr may not have a URL matching the requested size.
+        # Fall back to the original size in such cases.
+        url = photo[image_size] || photo['url_o']
+        filename = format("#{directory}/%03d.jpg", (index + 1))
+
+        primary_photo_filename = filename if photo.id == primary_photo_id
+
+        manifest_images[filename] = {
+          'metadata' => {
+            'title' => photo.title,
+            'description' => photo.description
+          }
+        }
+
+        download_photo(url, filename)
+      end
+
+      manifest = {
+        photoset_id => {
+          'title' => photoset.title,
+          'primary_image' => primary_photo_filename,
+          'images' => manifest_images
+        }
+      }
+
+      Jekyll
+        .logger
+        .info(
+          LOG_TOPIC,
+          "Finished downloading #{manifest_images.length} photos from Flickr photoset #{photoset_id} to #{directory}."
+        )
+
+      manifest
+    end
+
+    sig { params(flickr_photoset_id: String, post: T.untyped).void }
+    private def download_photoset(flickr_photoset_id, post)
+      unless should_download?(flickr_photoset_id)
+        post_name = T.must(%r{_posts/(?<name>.+)\.md}.match(post.relative_path))['name']
+        Jekyll
+          .logger
+          .warn(
+            LOG_TOPIC,
+            # rubocop: disable Layout/LineLength
+            "Photos already downloaded for Flickr photoset #{flickr_photoset_id}, referenced by #{post_name}. Moving on."
+            # rubocop: enable Layout/LineLength
+          )
+        return
+      end
+
+      post_image_root = "#{@config['image_root']}/#{flickr_photoset_id}"
+      FileUtils.mkdir_p(post_image_root)
+
+      manifest = download_photoset_photos(flickr_photoset_id, post_image_root)
+      write_manifest_file(manifest)
+    end
+  end
+end

data/lib/jekyll-flickr-utils.rb

@@ -0,0 +1,5 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'flickr_downloader'
+require 'post_image'

data/lib/post_image.rb

@@ -0,0 +1,92 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+module Jekyll
+  module FlickrHelpers
+    extend T::Sig
+
+    PhotosetId = T.type_alias { Integer }
+
+    sig { params(photoset_id: T.any(PhotosetId, T::Array[PhotosetId])).returns(PhotosetId) }
+    def self.get_first_photoset_id(photoset_id)
+      photoset_id = T.must(photoset_id.first) if photoset_id.is_a?(Array)
+
+      photoset_id
+    end
+
+    sig { params(photoset_id: PhotosetId).returns(T.nilable(String)) }
+    def self.get_photoset_primary_photo(photoset_id)
+      path = Jekyll.sites.first.data['flickr_photosets'].fetch(photoset_id, {}).fetch('primary_image', nil)
+      path.nil? ? nil : "/#{path}"
+    rescue KeyError
+      nil
+    end
+  end
+
+  module PostImage
+    extend T::Sig
+
+    JEKYLL_ROOT = T.let(Jekyll.configuration.source({}), String)
+
+    sig { params(post: T.untyped).returns(T.nilable(String)) }
+    def post_image(post)
+      item_id = post.fetch('relative_path')
+      Jekyll.logger.info('Post Image:', "Retrieving post image for #{item_id}")
+
+      image = post.fetch('image') { flickr_primary_photo(post) }
+      image = nil unless image && file_exists?(image)
+
+      if image.nil? && item_id.start_with?('_posts')
+        Jekyll.logger.warn('Post Image:', "Missing post image for #{item_id}")
+      end
+
+      image
+    end
+
+    sig { params(post: T.untyped).returns(T::Boolean) }
+    def post_has_image(post)
+      post_image = post_image(post)
+      !!post_image && file_exists?(post_image)
+    rescue KeyError
+      false
+    end
+
+    sig { params(post: T.untyped).returns(T::Boolean) }
+    def show_flickr_gallery(post)
+      post.key?('flickr_photoset_id') && !post.fetch('hide_flickr_gallery',
+                                                     false) && !post.fetch('hide_post_gallery', false)
+    end
+
+    sig { params(post: T.untyped).returns(T::Boolean) }
+    def show_post_gallery(post)
+      !post.fetch('hide_post_gallery', false)
+    end
+
+    sig { params(path: String).returns(T::Boolean) }
+    private def file_exists?(path)
+      full_path = "#{JEKYLL_ROOT}#{path}"
+      File.exist?(full_path)
+    end
+
+    sig { params(post: T.untyped).returns(T.nilable(String)) }
+    private def flickr_primary_photo(post)
+      photoset_id = FlickrHelpers.get_first_photoset_id(post.fetch('flickr_photoset_id'))
+      FlickrHelpers.get_photoset_primary_photo(photoset_id)
+    rescue KeyError
+      nil
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::PostImage)
+
+Jekyll::Hooks.register :posts, :pre_render do |post|
+  # Set the image field from Flickr data so jekyll-seo-tag renders the correct meta tags.
+  if !post.data.key?('image') && post.data.key?('flickr_photoset_id')
+    photoset_id = Jekyll::FlickrHelpers.get_first_photoset_id(post.data.fetch('flickr_photoset_id'))
+    image_path = Jekyll::FlickrHelpers.get_photoset_primary_photo(photoset_id)
+    post.data['image'] = image_path
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-flickr-utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clinton Blackburn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: flickr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/flickr_downloader.rb
+- lib/jekyll-flickr-utils.rb
+- lib/post_image.rb
+homepage: 
+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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Download images from Flickr
+test_files: []