image_vise 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0790cd6968b8c71bdb827b446d0505169e6d6254'
-  data.tar.gz: 7b98094a9cffaf0f518ef1e1b2e851fbce962fa2
+  metadata.gz: 15bac8714b52ca8cc0a2b57037ffb1db1ac85216
+  data.tar.gz: 1ff26e91dcea4e222f98caf695d92096822c2df1
 SHA512:
-  metadata.gz: 1806c4f6da54b58dc7b4b38f286c6afd411a3a770c51b7cc6e258407e6fd1339063b43a1c9372b09d32345a5a4e13dc8f2e77a382b887eac798b4a7d113700a2
-  data.tar.gz: cb9a32c8dabe2261ff291d1d0ba778d79056f0fc8c41cba459f635a52fb76cfb99db13d24e08ea979525a3a8c6f2b73e3e8c275b66bdf096ccdc0fd84c3d75ac
+  metadata.gz: 262b64839c5aceb9230ef958629535248a60a4f62ca4ef8cc7d923419ebdaec7491fb5b8978795212b81d8231d9d0ea3575972fe72a4eaf7ebd7b866b506387f
+  data.tar.gz: 7ef5cf55c0893907abb72cede01ddfc6a0cc824d5ebf0c0112df2789c1a0453ee03182311766372e10dd5db9d69885c89c6b30c28798b067802873c859b6e0f8

data/.travis.yml

@@ -1,5 +1,4 @@
 rvm:
-- 2.1
 - 2.2
 - 2.3.0
 - 2.4.1

data/lib/image_vise/operators/expire_after.rb

@@ -0,0 +1,17 @@
+# Overrides the cache lifetime set in the output headers of the RenderEngine.
+# Can be used to permit the requester to set the caching lifetime, instead
+# of it being a configuration variable in the service performing the rendering
+class ImageVise::ExpireAfter < Ks.strict(:seconds)
+  def initialize(seconds:)
+    unless seconds.is_a?(Integer) && seconds > 0
+      raise ArgumentError, "the :seconds parameter must be an Integer and must be above 0, but was %s" % seconds.inspect
+    end
+    super
+  end
+
+  def apply!(_, metadata)
+    metadata[:expire_after_seconds] = seconds
+  end
+
+  ImageVise.add_operator 'expire_after', self
+end

data/lib/image_vise/render_engine.rb

@@ -79,8 +79,8 @@
       given_signature: signature,
       secrets: ImageVise.secret_keys
     )
-    render_destination_file, render_file_type, etag = process_image_request(image_request)
-    image_rack_response(render_destination_file, render_file_type, etag)
+    render_destination_file, render_file_type, etag, expire_after = process_image_request(image_request)
+    image_rack_response(render_destination_file, render_file_type, etag, expire_after)
   rescue *permanent_failures => e
     handle_request_error(e)
     http_status_code = e.respond_to?(:http_status) ? e.http_status : 400
@@ -157,14 +157,14 @@
     render_destination_file = Tempfile.new('imagevise-render').tap{|f| f.binmode }
 
     # Do the actual imaging stuff
-    apply_pipeline(source_file.path, pipeline, source_file_type, render_destination_file.path)
+    expire_after = apply_pipeline(source_file.path, pipeline, source_file_type, render_destination_file.path)
 
     # Catch this one early
     render_destination_file.rewind
     raise EmptyRender, "The rendered image was empty" if render_destination_file.size.zero?
 
     render_file_type = detect_file_type(render_destination_file)
-    [render_destination_file, render_file_type, etag]
+    [render_destination_file, render_file_type, etag, expire_after]
   ensure
     ImageVise.close_and_unlink(source_file)
   end
@@ -179,11 +179,11 @@
   # @param render_destination_file[File] the File handle to the rendered image
   # @param render_file_type[MagicBytes::FileType] the rendered file type
   # @param etag[String] the ETag for the response
-  def image_rack_response(render_destination_file, render_file_type, etag)
+  def image_rack_response(render_destination_file, render_file_type, etag, expire_after)
     response_headers = DEFAULT_HEADERS.merge({
       'Content-Type' => render_file_type.mime,
       'Content-Length' => '%d' % render_destination_file.size,
-      'Cache-Control' => IMAGE_CACHE_CONTROL % ImageVise.cache_lifetime_seconds,
+      'Cache-Control' => IMAGE_CACHE_CONTROL % expire_after.to_i,
       'ETag' => etag
     })
 
@@ -298,6 +298,9 @@
     # If no operators touched the writer we are going to use the automatic format selection
     writer = metadata.fetch(:writer, ImageVise::AutoWriter.new)
     writer.write_image!(magick_image, metadata, render_to_path)
+
+    # Another metadata element is the expire_after, which we default to an app-wide setting
+    metadata.fetch(:expire_after_seconds, ImageVise.cache_lifetime_seconds)
   ensure
     # destroy all the loaded images explicitly
     (image_list || []).map {|img| ImageVise.destroy(img) }

data/lib/image_vise/version.rb

@@ -1,3 +1,3 @@
 class ImageVise
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/image_vise/expire_after_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../spec_helper'
+
+describe ImageVise::ExpireAfter do
+  it "raises on invalid arguments" do
+    expect {
+      described_class.new({})
+    }.to raise_error(ArgumentError)
+
+    expect {
+      described_class.new(seconds: '1')
+    }.to raise_error(ArgumentError)
+
+    expect {
+      described_class.new(seconds: -1)
+    }.to raise_error(ArgumentError)
+
+    expect {
+      described_class.new(seconds: 0)
+    }.to raise_error(ArgumentError)
+
+    described_class.new(seconds: 25)
+  end
+
+  it "sets the :expire_after_seconds metadata key" do
+    subject = described_class.new(seconds: 4321)
+    
+    fake_magick_image = double('Magick::Image')
+    metadata = {}
+
+    subject.apply!(fake_magick_image, metadata)
+
+    seconds_value = metadata.fetch(:expire_after_seconds)
+    expect(seconds_value).to eq(4321)
+  end
+end

data/spec/image_vise/render_engine_spec.rb

@@ -353,6 +353,19 @@ describe ImageVise::RenderEngine do
       examine_image_from_string(last_response.body)
     end
 
+    it 'sets a customized Expires: cache lifetime set via the pipeline' do
+      uri = Addressable::URI.parse(public_url_psd)
+      ImageVise.add_allowed_host!(uri.host)
+      ImageVise.add_secret_key!('1337ness')
+
+      p = ImageVise::Pipeline.new.geom(geometry_string: 'x220').expire_after(seconds: 20)
+      image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+
+      get image_request.to_path_params('1337ness')
+
+      expect(last_response.headers['Cache-Control']).to eq("public, no-transform, max-age=20")
+    end
+
     it 'converts a PNG into a JPG applying a background fill' do
       uri = Addressable::URI.parse(public_url_png_transparency)
       ImageVise.add_allowed_host!(uri.host)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_vise
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -227,6 +227,7 @@ files:
 - lib/image_vise/operators/background_fill.rb
 - lib/image_vise/operators/crop.rb
 - lib/image_vise/operators/ellipse_stencil.rb
+- lib/image_vise/operators/expire_after.rb
 - lib/image_vise/operators/fit_crop.rb
 - lib/image_vise/operators/force_jpg_out.rb
 - lib/image_vise/operators/geom.rb
@@ -243,6 +244,7 @@ files:
 - spec/image_vise/background_fill_spec.rb
 - spec/image_vise/crop_spec.rb
 - spec/image_vise/ellipse_stencil_spec.rb
+- spec/image_vise/expire_after_spec.rb
 - spec/image_vise/fetcher_file_spec.rb
 - spec/image_vise/fetcher_http_spec.rb
 - spec/image_vise/file_response_spec.rb
@@ -288,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Runtime thumbnailing proxy