sufia 3.1.2 → 3.1.3

data/spec/models/access_right_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Sufia::Models::AccessRight do
+  [
+    [false, Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC,        nil,                                              nil,             true, false, false, false],
+    [false, Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED, nil,                                              nil,             true, false, false, false],
+    [false, nil,                                              nil,                                              nil,             true, false, false, false],
+    [false, nil,                                              nil,                                              2.days.from_now, false, false, false, true],
+    [false, nil,                                              nil,                                              2.days.ago,      false, false, false, true],
+    [false, nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC,        nil,             true, false, false, false],
+    [false, nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED, nil,             false, true, false, false],
+    [false, nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE,       nil,             false, false, true, false],
+    [false, nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_EMBARGO,       nil,             false, false, false, true],
+    [true,  Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC,        nil,                                              nil,             true, false, false, false],
+    [true,  Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC,        nil,                                              2.days.from_now, false, false, false, true],
+    [true,  Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC,        nil,                                              2.days.ago,      false, false, false, true],
+    [true,  Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED, nil,                                              nil,             false, true, false, false],
+    [true,  nil,                                              nil,                                              nil,             false, false, true, false],
+    [true,  nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC,        nil,             true, false, false, false],
+    [true,  nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED, nil,             false, true, false, false],
+    [true,  nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE,       nil,             false, false, true, false],
+    [true,  nil,                                              Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_EMBARGO,       nil,             false, false, false, true],
+  ].each do |given_persisted, givin_permission, given_visibility, given_embargo_release_date, expected_open_access, expected_authentication_only, expected_private, expected_open_access_with_embargo_release_date|
+    spec_text = <<-TEXT
+
+    GIVEN: {
+      persisted: #{given_persisted.inspect},
+      permission: #{givin_permission.inspect},
+      visibility: #{given_visibility.inspect},
+      embargo_release_date: #{given_embargo_release_date}
+    },
+    EXPECTED: {
+      open_access: #{expected_open_access.inspect},
+      restricted: #{expected_authentication_only.inspect},
+      private: #{expected_private.inspect},
+      open_access_with_embargo_release_date: #{expected_open_access_with_embargo_release_date}
+    },
+    TEXT
+
+    it spec_text do
+      permissions = [{access: :edit, name: givin_permission}]
+      permissionable = double(
+        'permissionable',
+        permissions: permissions,
+        visibility: given_visibility,
+        persisted?: given_persisted,
+        embargo_release_date: given_embargo_release_date
+      )
+      access_right = Sufia::Models::AccessRight.new(permissionable)
+
+      expect(access_right.open_access?).to eq(expected_open_access)
+      expect(access_right.authenticated_only?).to eq(expected_authentication_only)
+      expect(access_right.private?).to eq(expected_private)
+      expect(access_right.open_access_with_embargo_release_date?).to eq(expected_open_access_with_embargo_release_date)
+    end
+  end
+end

data/spec/models/generic_file_spec.rb

@@ -100,7 +100,7 @@ describe GenericFile do
     end
 
     it "should not be changed when it's set to its previous value" do
-      subject.visibility= 'private'
+      subject.visibility= 'restricted'
       subject.should_not be_visibility_changed
     end
 

data/spec/support/uploaded_file_monkeypatch.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 #Monkey patch UploadedFile so that it responds to read (same as ActionDispatch::Http::UploadedFile). Required by RestClient when posting to fedora.
 class Rack::Test::UploadedFile
   def read(*args)

data/sufia-models/app/models/batch.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 class Batch < ActiveFedora::Base
   include Hydra::ModelMixins::CommonMetadata
   include Hydra::ModelMixins::RightsMetadata

data/sufia-models/app/models/concerns/sufia/models/access_right.rb

@@ -0,0 +1,79 @@
+module Sufia
+  module Models
+    class AccessRight
+      PERMISSION_TEXT_VALUE_PUBLIC = 'public'.freeze
+      PERMISSION_TEXT_VALUE_AUTHENTICATED = 'registered'.freeze
+      VISIBILITY_TEXT_VALUE_PUBLIC = 'open'.freeze
+      VISIBILITY_TEXT_VALUE_EMBARGO = 'open_with_embargo_release_date'.freeze
+      VISIBILITY_TEXT_VALUE_AUTHENTICATED = 'psu'.freeze
+      VISIBILITY_TEXT_VALUE_PRIVATE = 'restricted'.freeze
+
+      # @param permissionable [#visibility, #permissions]
+      # @example
+      #   file = GenericFile.find('sufia:1234')
+      #   access = Sufia::AccessRight.new(file)
+      def initialize(permissionable)
+        @permissionable = permissionable
+      end
+
+      attr_reader :permissionable
+      delegate :persisted?, :permissions, :visibility, to: :permissionable
+      protected :persisted?, :permissions, :visibility
+
+
+      def open_access?
+        return true if has_visibility_text_for?(VISIBILITY_TEXT_VALUE_PUBLIC)
+        # We don't want to know if its under embargo, simply does it have a date.
+        # In this way, we can properly inform the label input
+        persisted_open_access_permission? && !permissionable.embargo_release_date.present?
+      end
+
+      def open_access_with_embargo_release_date?
+        return false unless permissionable_is_embargoable?
+        return true if has_visibility_text_for?(VISIBILITY_TEXT_VALUE_EMBARGO)
+        # We don't want to know if its under embargo, simply does it have a date.
+        # In this way, we can properly inform the label input
+        persisted_open_access_permission? && permissionable.embargo_release_date.present?
+      end
+
+      def authenticated_only?
+        return false if open_access?
+        has_permission_text_for?(PERMISSION_TEXT_VALUE_AUTHENTICATED) ||
+          has_visibility_text_for?(VISIBILITY_TEXT_VALUE_AUTHENTICATED)
+      end
+
+      def private?
+        return false if open_access?
+        return false if authenticated_only?
+        return false if open_access_with_embargo_release_date?
+        true
+      end
+
+      private
+
+        def persisted_open_access_permission?
+          if persisted?
+            has_permission_text_for?(PERMISSION_TEXT_VALUE_PUBLIC)
+          else
+            visibility.to_s == ''
+          end
+        end
+
+        def on_or_after_any_embargo_release_date?
+          return true unless permissionable.embargo_release_date
+          permissionable.embargo_release_date.to_date < Date.today
+        end
+
+        def permissionable_is_embargoable?
+          permissionable.respond_to?(:embargo_release_date)
+        end
+
+        def has_visibility_text_for?(text)
+          visibility == text
+        end
+        def has_permission_text_for?(text)
+          !!permissions.detect { |perm| perm[:name] == text }
+        end
+    end
+  end
+end

data/sufia-models/app/models/concerns/sufia/models/with_access_right.rb

@@ -0,0 +1,33 @@
+module Sufia
+  module Models
+    module WithAccessRight
+      extend ActiveSupport::Concern
+
+      def under_embargo?
+        @under_embargo ||= rightsMetadata.under_embargo?
+      end
+
+      def open_access?
+        access_rights.open_access?
+      end
+
+      def open_access_with_embargo_release_date?
+        access_rights.open_access_with_embargo_release_date?
+      end
+
+      def authenticated_only_access?
+        access_rights.authenticated_only?
+      end
+
+      def private_access?
+        access_rights.private?
+      end
+
+      def access_rights
+        @access_rights ||= AccessRight.new(self)
+      end
+      protected :access_rights
+
+    end
+  end
+end

data/sufia-models/app/models/datastreams/batch_rdf_datastream.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 class BatchRdfDatastream < ActiveFedora::NtriplesRDFDatastream
   map_predicates do |map|
     map.part(:to => "hasPart", :in => RDF::DC)

data/sufia-models/app/models/datastreams/fits_datastream.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 class FitsDatastream < ActiveFedora::OmDatastream
   include OM::XML::Document
 

data/sufia-models/app/models/datastreams/generic_file_rdf_datastream.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 class GenericFileRdfDatastream < ActiveFedora::NtriplesRDFDatastream
   map_predicates do |map|
     map.part_of(:to => "isPartOf", :in => RDF::DC)

data/sufia-models/app/models/datastreams/properties_datastream.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # properties datastream: catch-all for info that didn't have another home.  Particularly depositor.
 class PropertiesDatastream < ActiveFedora::OmDatastream
   set_terminology do |t|

data/sufia-models/app/models/follow.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 class Follow < ActiveRecord::Base
 
   extend ActsAsFollower::FollowerLib

data/sufia-models/app/models/subject_local_authority_entry.rb

@@ -1,16 +1,2 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 class SubjectLocalAuthorityEntry < ActiveRecord::Base
 end

data/sufia-models/lib/sufia/models/generic_file/visibility.rb

@@ -10,48 +10,52 @@ module Sufia
       end
 
       def visibility= (value)
+        return if value.nil?
         # only set explicit permissions
         case value
-        when "open"
+        when Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
           public_visibility!
-        when "psu"
+        when Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
           registered_visibility!
-        when "restricted" 
+        when Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE 
           private_visibility!
+        else
+          raise ArgumentError, "Invalid visibility: #{value.inspect}"
         end
       end
 
-      def public_visibility!
-        visibility_will_change! unless visibility == 'public'
-        self.datastreams["rightsMetadata"].permissions({:group=>"public"}, "read")
-      end
-
-      def registered_visibility!
-        visibility_will_change! unless visibility == 'registered'
-        self.datastreams["rightsMetadata"].permissions({:group=>"registered"}, "read")
-        self.datastreams["rightsMetadata"].permissions({:group=>"public"}, "none")
-      end
-
-      def private_visibility!
-        visibility_will_change! unless visibility == 'private'
-        self.datastreams["rightsMetadata"].permissions({:group=>"registered"}, "none")
-        self.datastreams["rightsMetadata"].permissions({:group=>"public"}, "none")
-      end
-
       def visibility
-        if read_groups.include? 'public'
-          'public'
-        elsif read_groups.include? 'registered'
-          'registered'
+        if read_groups.include? Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC
+          Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
+        elsif read_groups.include? Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED
+          Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
         else
-          'private'
+          Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
         end
       end
 
       def set_visibility(visibility)
-        Deprecation.warn Permissions, "set_visibility is deprecated, use visibility= instead.  set_visibility will be removed in sufia 3.0", caller
+        Deprecation.warn Visibility, "set_visibility is deprecated, use visibility= instead.  set_visibility will be removed in sufia 3.0", caller
         self.visibility= visibility
       end
+
+      private 
+        def public_visibility!
+          visibility_will_change! unless visibility == Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
+          self.datastreams["rightsMetadata"].permissions({:group=>Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC}, "read")
+        end
+
+        def registered_visibility!
+          visibility_will_change! unless visibility == Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
+          self.datastreams["rightsMetadata"].permissions({:group=>Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED}, "read")
+          self.datastreams["rightsMetadata"].permissions({:group=>Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC}, "none")
+        end
+
+        def private_visibility!
+          visibility_will_change! unless visibility == Sufia::Models::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
+          self.datastreams["rightsMetadata"].permissions({:group=>Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED}, "none")
+          self.datastreams["rightsMetadata"].permissions({:group=>Sufia::Models::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC}, "none")
+        end
     end
   end
 end

data/sufia-models/lib/sufia/models/id_service.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 require 'noid'
 
 module Sufia

data/sufia-models/lib/sufia/models/jobs/audit_job.rb

@@ -1,17 +1,3 @@
-# Copyright © 2012 The Pennsylvania State University
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 class AuditJob < ActiveFedoraPidBasedJob
   def queue_name
     :audit