riiif 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d27a0256321086b2506eff19730afe79b72e198f
-  data.tar.gz: 7e4673c9759001f4176228c80d91c40f9afed2ca
+  metadata.gz: ba70ff2bc96642dfaef0a13aa368721e64d819b9
+  data.tar.gz: f2211f18a7da732e70f6151b907c6cbf66d2a88a
 SHA512:
-  metadata.gz: 5c38c62c7772d793ddc74250b89d98b8d694a09f871f77e848d7d26da24b02e3d34305cb9543f6c03b02facf11249229414ba28f359b01cef3972bc73c74587f
-  data.tar.gz: c1a52a6d8ace9585c4d4d267c175d7ab2a8ba227762860e627dc6ecd4cd2db047de4612a5f90b5d1696139a93bbec97276a1d5b5b9c807a3fa3b864415a7a5df
+  metadata.gz: a593880f25ace996a90457cf99aaba644fc4c4410622e4203f3e968609d598ffd1080b33698e45d9de3b9f63be76b836b89b12a236c49e5bfb9c231e2b8dcaeb
+  data.tar.gz: b560c0e4f6bb82d44c671f1c32a0ddf24eb6aeac633357aa9e0885886e247a6e987055c629b2ef618499c486f9c1c80d5c285bda00ee972a81a6070e66d1cdc5

data/README.md

@@ -101,6 +101,25 @@ You can do this to create a default Riiif::Image to use (useful for passing "mis
 Riiif::Image.new('no_image', Riiif::File.new(Riiif.not_found_image))
 ```
 
+## Authorization
+
+The controller will call an authorization service with the controller context.  This service must have a method `can?(action, image)` which returns a boolean. The default service is the `RIIIF::NilAuthrorizationService` which permits all requests. 
+
+In this example we've dissallowed all requests:
+
+```ruby
+class NoService
+  def initalize(controller)
+  end
+
+  def can?(action, image)
+    false
+  end
+end
+
+Riiif::Image.authorization_service = NoService
+```
+
 ## Integration with Hydra/Fedora
 
 Create an initializer like this in `config/initializers/riiif_initializer.rb`

data/app/controllers/riiif/images_controller.rb

@@ -9,15 +9,17 @@ module Riiif
     def show
       begin
         image = model.new(image_id)
-        status = :ok
+        status = if authorization_service.can?(:show, image)
+                   :ok
+                 else
+                   :unauthorized
+                  end
       rescue ImageNotFoundError
-        if Riiif.not_found_image.present?
-          image = model.new(image_id, Riiif::File.new(Riiif.not_found_image))
-          status = :not_found
-        else
-          raise
-        end
+        status = :not_found
       end
+
+      image = not_found_image unless status == :ok 
+
       data = image.render(params.permit(:region, :size, :rotation, :quality, :format))
       headers['Access-Control-Allow-Origin'] = '*'
       send_data data,
@@ -28,8 +30,12 @@ module Riiif
 
     def info
       image = model.new(image_id)
-      headers['Access-Control-Allow-Origin'] = '*'
-      render json: image.info.merge(server_info), content_type: 'application/ld+json'
+      if authorization_service.can?(:info, image)
+        headers['Access-Control-Allow-Origin'] = '*'
+        render json: image.info.merge(server_info), content_type: 'application/ld+json'
+      else
+        render json: { error: 'unauthorized' }, status: :unauthorized
+      end
     end
 
     # this is a workaround for https://github.com/rails/rails/issues/25087
@@ -50,10 +56,19 @@ module Riiif
       params[:id]
     end
 
+    def authorization_service
+      model.authorization_service.new(self)
+    end
+
     def link_header
       response.headers["Link"] = "<#{LEVEL1}>;rel=\"profile\""
     end
 
+    def not_found_image
+      raise "Not found image doesn't exist" unless Riiif.not_found_image
+      model.new(image_id, Riiif::File.new(Riiif.not_found_image))
+    end
+
     CONTEXT = '@context'
     CONTEXT_URI = 'http://iiif.io/api/image/2/context.json'
     ID = '@id'

data/app/models/riiif/image.rb

@@ -2,8 +2,9 @@ require 'digest/md5'
 module Riiif
   class Image
 
-    class_attribute :file_resolver, :info_service
+    class_attribute :file_resolver, :info_service, :authorization_service
     self.file_resolver = FileSystemFileResolver.new
+    self.authorization_service = NilAuthorizationService
 
     # this is the default info service
     # returns a hash with the original image dimensions.

data/lib/riiif/nil_authorization_service.rb

@@ -0,0 +1,10 @@
+module Riiif
+  class NilAuthorizationService
+    def initialize(_controller)
+    end
+
+    def can?(_action, _object)
+      true
+    end
+  end
+end

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/lib/riiif.rb

@@ -8,6 +8,7 @@ module Riiif
   autoload :HTTPFileResolver
   autoload :Routes
   autoload :AkubraSystemFileResolver
+  autoload :NilAuthorizationService
 
   class Error < RuntimeError; end
   class InvalidAttributeError < Error; end

data/spec/controllers/images_controller_spec.rb

@@ -6,7 +6,7 @@ describe Riiif::ImagesController do
   routes { Riiif::Engine.routes }
 
   describe "#show" do
-    it "should send images to the service" do
+    it "sends images to the service" do
       image = double
       expect(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
       expect(image).to receive(:render).with("region" => 'full', "size" => 'full',
@@ -20,6 +20,21 @@ describe Riiif::ImagesController do
       expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
     end
 
+    context "with an unauthorized image" do
+      let(:auth) { double("no auth service", can?: false) }
+      let(:not_found_image) { double("not_found_image", render: 'test data') }
+      before do
+        allow(controller).to receive(:authorization_service).and_return(auth)
+        allow(controller).to receive(:not_found_image).and_return(not_found_image)
+      end
+      it "renders 401" do
+        get :show, id: 'abcd1234', action: "show", region: 'full', size: 'full',
+                   rotation: '0', quality: 'default', format: 'jpg'
+        expect(response.body).to eq "test data"
+        expect(response.code).to eq "401"
+      end
+    end
+
     context "with a invalid region" do
       it "renders 400" do
         image = double("an image")
@@ -89,21 +104,35 @@ describe Riiif::ImagesController do
     end
   end
 
-  it "returns info" do
-    image = double
-    expect(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
-    expect(image).to receive(:info).and_return({width: 6000, height: 4000 })
-    get :info, id: 'abcd1234', format: 'json'
-    expect(response).to be_successful
-    json = JSON.parse(response.body)
-    expect(json).to eq "@context" => "http://iiif.io/api/image/2/context.json",
-      "@id" =>"http://test.host/images/abcd1234",
-      "width" =>6000,
-      "height" =>4000,
-      "profile" => ["http://iiif.io/api/image/2/level1.json", "formats" => ["jpg", "png"]],
-      'protocol' => 'http://iiif.io/api/image'
-    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 '*'
+  describe "info" do
+    it "returns info" do
+      image = double
+      expect(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
+      expect(image).to receive(:info).and_return({width: 6000, height: 4000 })
+      get :info, id: 'abcd1234', format: 'json'
+      expect(response).to be_successful
+      json = JSON.parse(response.body)
+      expect(json).to eq "@context" => "http://iiif.io/api/image/2/context.json",
+        "@id" =>"http://test.host/images/abcd1234",
+        "width" =>6000,
+        "height" =>4000,
+        "profile" => ["http://iiif.io/api/image/2/level1.json", "formats" => ["jpg", "png"]],
+        'protocol' => 'http://iiif.io/api/image'
+      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 '*'
+    end
+
+    context "with an unauthorized image" do
+      let(:auth) { double("no auth service", can?: false) }
+      before do
+        allow(controller).to receive(:authorization_service).and_return(auth)
+      end
+      it "renders 401" do
+        get :info, id: 'abcd1234', format: 'json'
+        expect(response.body).to eq "{\"error\":\"unauthorized\"}"
+        expect(response.code).to eq "401"
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - lib/riiif/engine.rb
 - lib/riiif/file_system_file_resolver.rb
 - lib/riiif/http_file_resolver.rb
+- lib/riiif/nil_authorization_service.rb
 - lib/riiif/rails/routes.rb
 - lib/riiif/routes.rb
 - lib/riiif/version.rb