riiif 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be59d18f6377129fef45f1bedfd5a97e0c49838b
-  data.tar.gz: b7bdecc0a5ad3354ba72864d7550fb9b36e59fc3
+  metadata.gz: 8772e4a904c4e4a561352a0e1a449da790347522
+  data.tar.gz: adffd5861fe1daa395c5d012936208a623b2829c
 SHA512:
-  metadata.gz: b5e12cb928aa79bd9888a881fb9331851506c0b5c61504e13956535405969701ef1c30477b1bd9b103c61d463a135747330491562e241dd9aa75693b47a89cf0
-  data.tar.gz: 4c13a191e50ea352bb1ef056f0467b2ea56fc767358b748e19f01af8349fbee8d8670fa07e34986ee0e959b4085ef3cba3a9dc76a116b07ce064c8b667766575
+  metadata.gz: d0498ffb73c9552a33819a7131ddfe0089525f95b273cd4eba70d8412ce1eb6598b4b8c9aee011b8cb43bb001f47ffeafc24b6a2ce3ae9a02e0a6190c338d0ff
+  data.tar.gz: 20150a2e02553cbff87f5cacc20868245ff12418763f9c046625ec45df6bf0503e119447e7ad493903bf673b88c0939adf19710463a0ee6471a72b6618beacf4

data/README.md

@@ -157,7 +157,12 @@ end
 
 Riiif::Engine.config.cache_duration_in_days = 30
 ```
-
+#### Special note for Passenger and Apache users
+If you are running riiif in Passenger under Apache, you must set `AllowEncodedSlashes NoDecode` in your virtual host definition. For some uses, even with that directive set, the above configuration won't work for you. You may need to explicitly decode the url, like this:
+```ruby
+require "uri"
+fs_id = URI.decode(id).sub(/\A([^\/]*)\/.*/, '\1')
+```
 
 ## Running the tests
 First, build the engine

data/app/controllers/riiif/images_controller.rb

@@ -22,6 +22,8 @@ module Riiif
 
       data = image.render(image_request_params)
       headers['Access-Control-Allow-Origin'] = '*'
+      # Set a Cache-Control header
+      expires_in cache_expires, public: false if status == :ok
       send_data data,
                 status: status,
                 type: Mime::Type.lookup_by_extension(params[:format]),
@@ -32,6 +34,8 @@ module Riiif
       image = model.new(image_id)
       if authorization_service.can?(:info, image)
         headers['Access-Control-Allow-Origin'] = '*'
+        # Set a Cache-Control header
+        expires_in cache_expires, public: false
         render json: image.info.to_h.merge(server_info), content_type: 'application/ld+json'
       else
         render json: { error: 'unauthorized' }, status: :unauthorized
@@ -48,6 +52,18 @@ module Riiif
 
       LEVEL1 = 'http://iiif.io/api/image/2/level1.json'.freeze
 
+      # @return seconds before the request expires. Defaults to 1 year.
+      def cache_expires
+        1.year
+      end
+
+      # Should the Cache-Control header be public? Override this if you want to have a
+      # public Cache-Control set.
+      # @return FalseClass
+      def public_cache?
+        false
+      end
+
       def model
         params.fetch(:model, 'riiif/image').camelize.constantize
       end

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = '1.1.3'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/spec/controllers/riiif/images_controller_spec.rb

@@ -18,6 +18,7 @@ describe Riiif::ImagesController do
       expect(response.body).to eq 'IMAGEDATA'
       expect(response.headers['Link']).to eq '<http://iiif.io/api/image/2/level1.json>;rel="profile"'
       expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
+      expect(response.headers['Cache-Control']).to eq 'max-age=31557600, private'
     end
 
     context 'with an unauthorized image' do
@@ -115,6 +116,7 @@ describe Riiif::ImagesController do
       expect(response.headers['Link']).to eq '<http://iiif.io/api/image/2/level1.json>;rel="profile"'
       expect(response.headers['Content-Type']).to eq 'application/ld+json; charset=utf-8'
       expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
+      expect(response.headers['Cache-Control']).to eq 'max-age=31557600, private'
     end
 
     context 'with an unauthorized image' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A rails engine that support IIIF requests