pageflow 17.0.5 → 17.1.0

data/lib/pageflow/zencoder_api.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderApi
     class Error < StandardError; end
     class RecoverableError < Error; end
@@ -6,13 +7,11 @@ module Pageflow
 
     def create_job(definition)
       with_exception_translation do
-        response = Zencoder::Job.create(:input => definition.input_s3_url,
-                                        :outputs => definition.outputs)
-        if response.success?
-          response.body['id']
-        else
-          raise translate_zencoder_errors(response.errors)
-        end
+        response = Zencoder::Job.create(input: definition.input_s3_url,
+                                        outputs: definition.outputs)
+        raise translate_zencoder_errors(response.errors) unless response.success?
+
+        response.body['id']
       end
     end
 
@@ -20,15 +19,13 @@ module Pageflow
       with_exception_translation do
         response = Zencoder::Job.progress(job_id)
 
-        if response.success?
-          {
-            :state => response.body["state"],
-            :progress => response.body["progress"],
-            :finished => response.body["state"] == 'finished'
-          }
-        else
-          raise translate_zencoder_errors(response.errors)
-        end
+        raise translate_zencoder_errors(response.errors) unless response.success?
+
+        {
+          state: response.body['state'],
+          progress: response.body['progress'],
+          finished: response.body['state'] == 'finished'
+        }
       end
     end
 
@@ -37,31 +34,26 @@ module Pageflow
       get_details(job_id)
     end
 
-    def get_details(job_id)
+    def get_details(job_id) # rubocop:todo Metrics/AbcSize
       with_exception_translation do
         response = Zencoder::Job.details(job_id)
 
-        if response.success?
-          input_details = response.body['job']['input_media_file']
-          outputs_details = response.body['job']['output_media_files']
+        raise translate_zencoder_errors(response.errors) unless response.success?
 
-          output_presences = outputs_details.inject({}) do |presences, output|
-            if output['label'].present?
-              presences[output['label'].to_sym] = output['state']
-            end
-            presences
-          end
+        input_details = response.body['job']['input_media_file']
+        outputs_details = response.body['job']['output_media_files']
 
-          {
-            format: input_details['format'],
-            duration_in_ms: input_details['duration_in_ms'],
-            width: input_details['width'],
-            height: input_details['height'],
-            output_presences: output_presences
-          }
-        else
-          raise translate_zencoder_errors(response.errors)
+        output_presences = outputs_details.each_with_object({}) do |output, presences|
+          presences[output['label'].to_sym] = output['state'] if output['label'].present?
         end
+
+        {
+          format: input_details['format'],
+          duration_in_ms: input_details['duration_in_ms'],
+          width: input_details['width'],
+          height: input_details['height'],
+          output_presences:
+        }
       end
     end
 
@@ -72,13 +64,11 @@ module Pageflow
     private
 
     def with_exception_translation
-      begin
-        yield
-      rescue Timeout::Error
-        raise RecoverableError, 'Zencoder timed out.'
-      rescue Zencoder::HTTPError => e
-        raise RecoverableError, e.message
-      end
+      yield
+    rescue Timeout::Error
+      raise RecoverableError, 'Zencoder timed out.'
+    rescue Zencoder::HTTPError => e
+      raise RecoverableError, e.message
     end
 
     def translate_zencoder_errors(errors)

data/lib/pageflow/zencoder_audio_output_definition.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderAudioOutputDefinition < ZencoderOutputDefinition
     attr_reader :audio_file
 
@@ -23,11 +24,11 @@ module Pageflow
 
     def m4a_definition
       {
-        :label => 'm4a',
-        :format => 'm4a',
-        :path => audio_file.m4a.path,
-        :public => 1,
-        :headers => {
+        label: 'm4a',
+        format: 'm4a',
+        path: audio_file.m4a.path,
+        public: 1,
+        headers: {
           'Content-Type' => 'audio/mp4'
         }
       }
@@ -35,19 +36,19 @@ module Pageflow
 
     def mp3_definition
       {
-        :label => 'mp3',
-        :format => 'mp3',
-        :path => audio_file.mp3.path,
-        :public => 1
+        label: 'mp3',
+        format: 'mp3',
+        path: audio_file.mp3.path,
+        public: 1
       }
     end
 
     def ogg_definition
       {
-        :label => 'ogg',
-        :format => 'ogg',
-        :path => audio_file.ogg.path,
-        :public => 1
+        label: 'ogg',
+        format: 'ogg',
+        path: audio_file.ogg.path,
+        public: 1
       }
     end
   end

data/lib/pageflow/zencoder_meta_data_output_definition.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderMetaDataOutputDefinition < ZencoderOutputDefinition
     attr_reader :file
 
@@ -14,8 +15,8 @@ module Pageflow
     def outputs
       [
         {
-          :label => 'stub',
-          :clip_length => 1
+          label: 'stub',
+          clip_length: 1
         }
       ]
     end

data/lib/pageflow/zencoder_output_definition.rb

@@ -1,6 +1,8 @@
 module Pageflow
+  # @api private
   class ZencoderOutputDefinition
-    cattr_accessor :default_output_bucket_name, :default_sftp_host, :default_akamai_host, :default_akamai_credentials
+    cattr_accessor :default_output_bucket_name, :default_sftp_host, :default_akamai_host,
+                   :default_akamai_credentials
 
     attr_accessor :options
 
@@ -9,11 +11,11 @@ module Pageflow
     end
 
     def input_s3_url
-      raise "Not implemented"
+      raise 'Not implemented'
     end
 
     def outputs
-      raise "Not implemented"
+      raise 'Not implemented'
     end
 
     def ==(other)
@@ -21,9 +23,9 @@ module Pageflow
         other.input_s3_url == input_s3_url &&
         other.outputs == outputs
     end
-    alias_method :eql?, :==
+    alias eql? ==
 
-      protected
+    protected
 
     def transferable(definition)
       if akamai_configured?
@@ -42,9 +44,7 @@ module Pageflow
     end
 
     def with_credentials(definition)
-      if akamai_configured?
-        definition[:credentials] = akamai_credentials
-      end
+      definition[:credentials] = akamai_credentials if akamai_configured?
 
       definition
     end
@@ -58,7 +58,7 @@ module Pageflow
     end
 
     def sftp_url(path)
-      "#{File.join(sftp_host, path)}"
+      File.join(sftp_host, path).to_s
     end
 
     def sftp_host
@@ -70,7 +70,7 @@ module Pageflow
     end
 
     def akamai_url(path)
-      "#{File.join(akamai_host, path)}"
+      File.join(akamai_host, path).to_s
     end
 
     def akamai_host
@@ -89,11 +89,12 @@ module Pageflow
 
     def sftp_transfer_definition(definition)
       return unless sftp_configured?
+
       {
-        :label => "sftp_transfer_#{definition[:label]}",
-        :source => definition[:label],
-        :type => 'transfer-only',
-        :url => sftp_url(definition[:path])
+        label: "sftp_transfer_#{definition[:label]}",
+        source: definition[:label],
+        type: 'transfer-only',
+        url: sftp_url(definition[:path])
       }
     end
 
@@ -105,6 +106,7 @@ module Pageflow
 
     def sftp_definition(source_defintion)
       return unless sftp_configured?
+
       source_defintion.dup.tap do |definiton|
         definiton[:label] = "sftp_#{definiton[:label]}"
         definiton[:url] = sftp_url(definiton.delete(:path))

data/lib/pageflow/zencoder_video_output_definition.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderVideoOutputDefinition < ZencoderOutputDefinition
     cattr_accessor :skip_hls, :skip_smil
 
@@ -35,6 +36,7 @@ module Pageflow
 
     def mp4_highdef_definitions
       return [] unless video_file.encode_highdef?
+
       [transferable(mp4_4k_definition), transferable(mp4_fullhd_definition)]
     end
 
@@ -43,15 +45,15 @@ module Pageflow
         label: '4k',
         prepare_for_segmenting: ['hls', 'dash'],
         path: video_file.mp4_4k.path,
-        video_bitrate: 22000,
-        decoder_bitrate_cap: 24420,
-        decoder_buffer_size: 36631,
+        video_bitrate: 22_000,
+        decoder_bitrate_cap: 24_420,
+        decoder_buffer_size: 36_631,
         audio_bitrate: 320,
-        size: '3839x2160',
+        size: size(3839, 2160),
         skip: {
           min_size: MIN_SIZE_FOR_4K
         },
-        public: 1,
+        public: 1
       }
     end
 
@@ -64,11 +66,11 @@ module Pageflow
         decoder_bitrate_cap: 6660,
         decoder_buffer_size: 9990,
         audio_bitrate: 192,
-        size: '1919x1080',
+        size: size(1919, 1080),
         skip: {
           min_size: MIN_SIZE_FOR_FULLHD
         },
-        public: 1,
+        public: 1
       }
     end
 
@@ -81,8 +83,8 @@ module Pageflow
         decoder_bitrate_cap: 3410,
         decoder_buffer_size: 7326,
         audio_bitrate: 128,
-        size: '1280x720',
-        public: 1,
+        size: size(1280, 720),
+        public: 1
       }
     end
 
@@ -96,7 +98,7 @@ module Pageflow
         decoder_buffer_size: 2557,
         audio_bitrate: 64,
         audio_channels: 1,
-        size: '853x480',
+        size: size(853, 480),
         public: 1
       }
     end
@@ -111,7 +113,7 @@ module Pageflow
         decoder_buffer_size: 924,
         audio_bitrate: 64,
         audio_channels: 1,
-        size: '640x360',
+        size: size(640, 360),
         public: 1,
         h264_profile: 'baseline'
       }
@@ -123,7 +125,8 @@ module Pageflow
           non_transferable(dash_high_definition),
           non_transferable(dash_medium_definition),
           non_transferable(dash_low_definition),
-          non_transferable(dash_playlist_definition)
+          non_transferable(dash_playlist_definition),
+          non_transferable(dash_playlist_high_and_up_definition)
         ]
     end
 
@@ -144,7 +147,8 @@ module Pageflow
           non_transferable(hls_high_definition),
           non_transferable(hls_medium_definition),
           non_transferable(hls_low_definition),
-          non_transferable(hls_playlist_definition)
+          non_transferable(hls_playlist_definition),
+          non_transferable(hls_playlist_high_and_up_definition)
         ]
     end
 
@@ -228,46 +232,47 @@ module Pageflow
     end
 
     def dash_playlist_definition
-      {
+      Playlist.build(
         label: 'dash-playlist',
-        streams: dash_stream_definitions,
-        allow_skipped_sources: true,
-        type: 'playlist',
-        streaming_delivery_format: 'dash',
-        path: video_file.dash_playlist.path,
-        public: 1
-      }
+        attachment: video_file.dash_playlist,
+        format: 'dash'
+      ) do |streams|
+        streams.from(dash_low_definition)
+        streams.from(dash_medium_definition)
+        streams.from(dash_high_definition)
+
+        if video_file.encode_highdef?
+          streams.from(dash_fullhd_definition)
+          streams.from(dash_4k_definition)
+        end
+      end
     end
 
-    def dash_stream_definitions
-      [
-        {
-          source: 'dash-low',
-          path: video_file.dash_low.url_relative_to(video_file.dash_playlist)
-        },
-        {
-          source: 'dash-medium',
-          path: video_file.dash_medium.url_relative_to(video_file.dash_playlist)
-        },
-        {
-          source: 'dash-high',
-          path: video_file.dash_high.url_relative_to(video_file.dash_playlist)
-        }
-      ] + dash_highdef_stream_definitions
+    def dash_playlist_high_and_up_definition
+      Playlist.build(
+        label: 'dash-playlist-high-and-up',
+        attachment: video_file.dash_playlist_high_and_up,
+        format: 'dash'
+      ) do |streams|
+        streams.from(dash_high_definition)
+
+        if video_file.encode_highdef?
+          streams.from(dash_fullhd_definition)
+          streams.from(dash_4k_definition)
+        end
+      end
     end
 
-    def dash_highdef_stream_definitions
-      return [] unless video_file.encode_highdef?
-      [
-        {
-          source: 'dash-fullhd',
-          path: video_file.dash_fullhd.url_relative_to(video_file.dash_playlist)
-        },
-        {
-          source: 'dash-4k',
-          path: video_file.dash_4k.url_relative_to(video_file.dash_playlist)
-        }
-      ]
+    def dash_playlist_fullhd_and_up_definition
+      Playlist.build(
+        label: 'dash-playlist-fullhd-and-up',
+        attachment: video_file.dash_playlist_fullhd_and_up,
+        format: 'dash',
+        min_size: MIN_SIZE_FOR_FULLHD
+      ) do |streams|
+        streams.from(dash_fullhd_definition)
+        streams.from(dash_4k_definition)
+      end
     end
 
     def hls_low_definition
@@ -336,50 +341,47 @@ module Pageflow
     end
 
     def hls_playlist_definition
-      {
+      Playlist.build(
         label: 'hls-playlist',
-        streams: hls_stream_definitions,
-        allow_skipped_sources: true,
-        type: 'playlist',
-        path: video_file.hls_playlist.path,
-        public: 1
-      }
+        attachment: video_file.hls_playlist,
+        format: 'hls'
+      ) do |streams|
+        streams.from(hls_medium_definition, bandwidth: 1769)
+        streams.from(hls_low_definition, bandwidth: 619)
+        streams.from(hls_high_definition, bandwidth: 3538)
+
+        if video_file.encode_highdef?
+          streams.from(hls_fullhd_definition, bandwidth: 8575)
+          streams.from(hls_4k_definition, bandwidth: 32_000)
+        end
+      end
     end
 
-    def hls_stream_definitions
-      [
-        {
-          source: 'hls-medium',
-          path: video_file.hls_medium.url_relative_to(video_file.hls_playlist),
-          bandwidth: 1769
-        },
-        {
-          source: 'hls-low',
-          path: video_file.hls_low.url_relative_to(video_file.hls_playlist),
-          bandwidth: 619
-        },
-        {
-          source: 'hls-high',
-          path: video_file.hls_high.url_relative_to(video_file.hls_playlist),
-          bandwidth: 3538
-        }
-      ] + hls_highdef_stream_definitions
+    def hls_playlist_high_and_up_definition
+      Playlist.build(
+        label: 'hls-playlist-high-and-up',
+        attachment: video_file.hls_playlist_high_and_up,
+        format: 'hls'
+      ) do |streams|
+        streams.from(hls_high_definition, bandwidth: 3538)
+
+        if video_file.encode_highdef?
+          streams.from(hls_fullhd_definition, bandwidth: 8575)
+          streams.from(hls_4k_definition, bandwidth: 32_000)
+        end
+      end
     end
 
-    def hls_highdef_stream_definitions
-      return [] unless video_file.encode_highdef?
-      [
-        {
-          source: 'hls-fullhd',
-          path: video_file.hls_fullhd.url_relative_to(video_file.hls_playlist),
-          bandwidth: 8575
-        },
-        {
-          source: 'hls-4k',
-          path: video_file.hls_4k.url_relative_to(video_file.hls_playlist),
-          bandwidth: 32000
-        }
-      ]
+    def hls_playlist_fullhd_and_up_definition
+      Playlist.build(
+        label: 'hls-playlist-fullhd-and-up',
+        attachment: video_file.hls_playlist_fullhd_and_up,
+        format: 'hls',
+        min_size: MIN_SIZE_FOR_FULLHD
+      ) do |streams|
+        streams.from(hls_fullhd_definition, bandwidth: 8575)
+        streams.from(hls_4k_definition, bandwidth: 32_000)
+      end
     end
 
     def smil_definitions
@@ -457,7 +459,7 @@ module Pageflow
         smil_fullhd_stream_definitions,
         {
           path: video_file.mp4_4k.url(host: :hls_origin, default_protocol: 'http'),
-          bandwidth: 32000
+          bandwidth: 32_000
         }
       ].flatten
     end
@@ -472,6 +474,15 @@ module Pageflow
       result
     end
 
+    def size(max, min)
+      if video_file.width && video_file.height &&
+         video_file.width < video_file.height
+        "#{min}x#{max}"
+      else
+        "#{max}x#{min}"
+      end
+    end
+
     def thumbnails_definition(url_helper)
       {
         thumbnails: [
@@ -491,5 +502,46 @@ module Pageflow
         ]
       }
     end
+
+    # @api private
+    class Playlist
+      def self.build(**args)
+        builder = new(**args)
+        yield builder
+        builder.build_definition
+      end
+
+      def initialize(label:, attachment:, format:, min_size: nil)
+        @label = label
+        @attachment = attachment
+        @format = format
+        @min_size = min_size
+        @streams = []
+      end
+
+      def from(source_definition, bandwidth: nil)
+        @streams << {
+          source: source_definition[:label],
+          path: @attachment.relative_path_to(source_definition[:path]),
+          bandwidth:
+        }.compact
+      end
+
+      def build_definition
+        definition = {
+          label: @label,
+          streams: @streams,
+          allow_skipped_sources: true,
+          type: 'playlist',
+          path: @attachment.path,
+          public: 1
+        }
+
+        definition[:streaming_delivery_format] = @format if @format == 'dash'
+        definition[:skip] = {min_size: @min_size} if @min_size
+
+        definition
+      end
+    end
   end
 end

data/lib/pageflow.rb

@@ -3,7 +3,7 @@ require 'pageflow/global_config_api'
 require 'pageflow/news_item_api'
 require 'pageflow/version'
 
-module Pageflow
+module Pageflow # rubocop:todo Style/Documentation
   extend GlobalConfigApi
   extend NewsItemApi
 
@@ -29,7 +29,12 @@ module Pageflow
 
   def self.active_admin_settings(config)
     config.before_action do
-      I18n.locale = current_user.try(:locale) || http_accept_language.compatible_language_from(I18n.available_locales) || I18n.default_locale
+      I18n.locale =
+        current_user.try(:locale) ||
+        http_accept_language.compatible_language_from(
+          I18n.available_locales
+        ) ||
+        I18n.default_locale
     end
   end
 

data/lib/tasks/pageflow_tasks.rake

@@ -24,7 +24,7 @@ namespace :pageflow do
 
   namespace :prune_auto_snapshots_jobs do
     desc 'Enqueue jobs to destroy old auto snapshot revisions'
-    task :enqueue => :environment do
+    task enqueue: :environment do
       options = {
         created_before: ENV['CREATED_BEFORE'] ? Time.parse(ENV['CREATED_BEFORE']) : 1.month.ago,
         keep_count: ENV.fetch('KEEP_COUNT', 20)