hydra-core 6.0.0.rc4 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0fd526ceee3e82798d9fff6c1af029b445eb45f
-  data.tar.gz: a5f2ec02b8819bd8062b2b3e8c5fe30f4634b3af
+  metadata.gz: be080a47162acf248ef80a141706589c8680144a
+  data.tar.gz: 9c6faddd32e384bf6dffb9d8ac6692fed158a1e6
 SHA512:
-  metadata.gz: 2f395a325b29044e49891f8165e91730155e76de4f9a8b7450707ef0151f3ee1fc9e6445c6b9762442322842459df558c665ecb34ca98f7ea50e4d0212ab6fe7
-  data.tar.gz: f233a9bb032ed0e5374d18b88c13113cd5ba9e14a0aa655f83130522069f4881d6659488e78f38bcd9e2e9ea67b514319adc87c7584c7bdd61f8d2763b5d7241
+  metadata.gz: a924a89074145f546b9f50b243e043f89ad2ca3097904d9d6f3b3031795026371440d324b8af8b69c8ecb94706b7eac0a81d0df7fb8789dac4e01a1e18eceecb
+  data.tar.gz: 092db137d443fc66bd733f8209553b12cd9bef8c491ff5673683173a3a5ca4f26dced251f11fa31f5b1ec869ea5eafea6cdb7fd70f5eb261922cb4d47f8eeb70

data/lib/hydra-head/version.rb

@@ -1,4 +1,4 @@
 module HydraHead
-  VERSION = "6.0.0.rc4"
+  VERSION = "6.0.0"
 end
 

data/lib/hydra/controller.rb

@@ -2,5 +2,6 @@ module Hydra::Controller
   autoload :AssetsControllerBehavior, 'hydra/controller/assets_controller_behavior'
   autoload :ControllerBehavior, 'hydra/controller/controller_behavior'
   autoload :UploadBehavior, 'hydra/controller/upload_behavior'
+  autoload :DownloadBehavior, 'hydra/controller/download_behavior'
   autoload :FileAssetsBehavior, 'hydra/controller/file_assets_behavior'
 end

data/lib/hydra/controller/download_behavior.rb

@@ -0,0 +1,125 @@
+module Hydra
+  module Controller
+    module DownloadBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        before_filter :load_asset
+        before_filter :load_datastream
+      end
+      
+      # Responds to http requests to show the datastream
+      def show
+        if can_download?
+          # we can now examine asset and determine if we should send_content, or some other action.
+          send_content (asset)
+        else 
+          logger.info "Can not read #{params['id']}"
+          raise Hydra::AccessDenied.new("You do not have sufficient access privileges to read this document, which has been marked private.", :read, params[:id])
+        end
+      end
+
+      protected
+
+      def load_asset
+        @asset = ActiveFedora::Base.find(params[:id], :cast=>true)
+      end
+
+      def load_datastream
+        @ds = datastream_to_show
+      end
+
+      def asset
+        @asset
+      end
+
+      def datastream
+        @ds
+      end
+
+      # Override this method to enforce access controls. By default it allows
+      # any datastream on an object the current user has read access to.
+      # @return [Boolean] can the curent user view this object/datastream
+      def can_download?
+        can? :read, datastream.pid
+      end 
+
+
+      # Override this method to change which datastream is shown.
+      # Loads the datastream specified by the HTTP parameter `:datastream_id`. 
+      # If this object does not have a datastream by that name, return the default datastream
+      # as returned by {#default_content_ds}
+      # @return [ActiveFedora::Datastream] the datastr
+      def datastream_to_show
+        ds = asset.datastreams[params[:datastream_id]] if params.has_key?(:datastream_id)
+        ds = default_content_ds if ds.nil?
+        ds
+      end
+      
+      # Handle the HTTP show request
+      def send_content(asset)
+        response.headers['Accept-Ranges'] = 'bytes'
+
+        if request.head?
+          content_head(datastream)
+        elsif request.headers["Range"]
+          send_range(datastream)
+        else
+          send_file_headers! content_options
+          self.response_body = datastream.stream
+        end
+      end
+
+      # Create some headers for the datastream
+      def content_options
+        {disposition: 'inline', type: datastream.mimeType, filename: datastream_name}
+      end
+
+      # Override this if you'd like a different filename
+      # @return [String] the filename
+      def datastream_name
+        params[:filename] || asset.label
+      end
+
+
+      # render an HTTP HEAD response
+      def content_head
+        response.headers['Content-Length'] = datastream.dsSize
+        response.headers['Content-Type'] = datastream.mimeType
+        head :ok
+      end
+      
+
+      # render an HTTP Range response
+      def send_range
+        _, range = request.headers["Range"].split('bytes=')
+        from, to = range.split('-').map(&:to_i)
+        to = datastream.dsSize - 1 unless to
+        length = to - from + 1
+        response.headers['Content-Range'] = "bytes #{from}-#{to}/#{datastream.dsSize}"
+        response.headers['Content-Length'] = "#{length}"
+        self.status = 206
+        send_file_headers! content_options
+        self.response_body = datastream.stream(from, length)
+      end
+      
+      private 
+      
+      def default_content_ds
+        ActiveFedora::ContentModel.known_models_for(asset).each do |model_class|
+          return model_class.default_content_ds if model_class.respond_to?(:default_content_ds)
+        end
+        if asset.datastreams.keys.include?(DownloadsController.default_content_dsid)
+          return asset.datastreams[DownloadsController.default_content_dsid]
+        end
+      end
+      
+      module ClassMethods
+        def default_content_dsid
+          "content"
+        end
+      end
+    end
+  end
+end
+

data/spec/controllers/downloads_controller_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe DownloadsController do
+  before do
+    Rails.application.routes.draw do
+      resources :downloads
+    end
+  end
+
+  describe "routing" do
+    it "should route" do
+      assert_recognizes( {:controller=>"downloads", :action=>"show", "id"=>"test1"}, "/downloads/test1?filename=my%20dog.jpg" )
+    end
+  end
+
+  describe "with a file" do
+    before do
+      @user = User.create!(email: 'email@example.com', password: 'password')
+      @obj = ActiveFedora::Base.new
+      @obj = ModsAsset.new
+      @obj.label = "world.png"
+      @obj.add_file_datastream('foobarfoobarfoobar', :dsid=>'content', :mimeType => 'image/png')
+      @obj.add_file_datastream("It's a stream", :dsid=>'descMetadata', :mimeType => 'text/plain')
+      @obj.read_users = [@user.user_key]
+      @obj.save!
+    end
+    after do
+      @obj.destroy
+    end 
+    describe "when logged in as reader" do
+      before do
+        sign_in @user
+        User.any_instance.stub(:groups).and_return([])
+      end
+      describe "show" do
+        it "should default to returning configured default download" do
+          DownloadsController.default_content_dsid.should == "content"
+          get "show", :id => @obj.pid
+          response.should be_success
+          response.headers['Content-Type'].should == "image/png"
+          response.headers["Content-Disposition"].should == "inline; filename=\"world.png\""
+          response.body.should == 'foobarfoobarfoobar'
+        end
+        it "should return requested datastreams" do
+          get "show", :id => @obj.pid, :datastream_id => "descMetadata"
+          response.should be_success
+          response.headers['Content-Type'].should == "text/plain"
+          response.headers["Content-Disposition"].should == "inline; filename=\"world.png\""
+          response.body.should == "It's a stream"
+        end
+        it "should support setting disposition to inline" do
+          get "show", :id => @obj.pid, :disposition => "inline"
+          response.should be_success
+          response.headers['Content-Type'].should == "image/png"
+          response.headers["Content-Disposition"].should == "inline; filename=\"world.png\""
+          response.body.should == 'foobarfoobarfoobar'
+        end
+        it "should allow you to specify filename for download" do
+          get "show", :id => @obj.pid, "filename" => "my%20dog.png"
+          response.should be_success
+          response.headers['Content-Type'].should == "image/png"
+          response.headers["Content-Disposition"].should == "inline; filename=\"my%20dog.png\""
+          response.body.should == 'foobarfoobarfoobar'
+        end
+      end
+    end
+
+    describe "when not logged in as reader" do
+      describe "show" do
+        before do
+          sign_in User.create!(email: 'email2@example.com', password: 'password')
+        end
+        it "should deny access" do
+          lambda { get "show", :id =>@obj.pid }.should raise_error Hydra::AccessDenied
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -19,8 +19,8 @@ end
 
 RSpec.configure do |config|
   config.include Devise::TestHelpers, :type => :controller
-
-
+  config.use_transactional_fixtures = true
+  config.before(:suite) { User.destroy_all }
 end
 
 

data/spec/support/app/controllers/downloads_controller.rb

@@ -0,0 +1,3 @@
+class DownloadsController < ApplicationController
+  include Hydra::Controller::DownloadBehavior
+end

data/spec/support/lib/generators/test_app_generator.rb

@@ -13,6 +13,10 @@ class TestAppGenerator < Rails::Generators::Base
 
   def copy_test_fixtures
     copy_file "app/models/generic_content.rb"
+
+    # Download controller
+    copy_file "app/controllers/downloads_controller.rb"
+
     copy_file "spec/fixtures/hydrangea_fixture_mods_article1.foxml.xml" 
 
     # For testing Hydra::SubmissionWorkflow

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-core
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc4
+  version: 6.0.0
 platform: ruby
 authors:
 - Matt Zumwalt, Bess Sadler, Julie Meloni, Naomi Dushay, Jessie Keck, John Scofield,
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.0.rc4
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.0.rc4
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: jettywrapper
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +213,7 @@ files:
 - lib/hydra.rb
 - lib/hydra/controller.rb
 - lib/hydra/controller/controller_behavior.rb
+- lib/hydra/controller/download_behavior.rb
 - lib/hydra/controller/upload_behavior.rb
 - lib/hydra/global_configurable.rb
 - lib/hydra/model_methods.rb
@@ -227,6 +228,7 @@ files:
 - spec/.gitignore
 - spec/controllers/catalog_controller_spec.rb
 - spec/controllers/catalog_valid_html_spec.rb
+- spec/controllers/downloads_controller_spec.rb
 - spec/factories.rb
 - spec/helpers/blacklight_helper_spec.rb
 - spec/helpers/facets_helper_spec.rb
@@ -243,6 +245,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/Gemfile
+- spec/support/app/controllers/downloads_controller.rb
 - spec/support/app/models/generic_content.rb
 - spec/support/app/models/sample.rb
 - spec/support/app/models/solr_document.rb
@@ -272,9 +275,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.0
@@ -285,6 +288,7 @@ test_files:
 - spec/.gitignore
 - spec/controllers/catalog_controller_spec.rb
 - spec/controllers/catalog_valid_html_spec.rb
+- spec/controllers/downloads_controller_spec.rb
 - spec/factories.rb
 - spec/helpers/blacklight_helper_spec.rb
 - spec/helpers/facets_helper_spec.rb
@@ -301,6 +305,7 @@ test_files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/Gemfile
+- spec/support/app/controllers/downloads_controller.rb
 - spec/support/app/models/generic_content.rb
 - spec/support/app/models/sample.rb
 - spec/support/app/models/solr_document.rb