hydra-access-controls 8.2.0 → 9.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d0c332d417111f77876c46bd3331349ce28da60
-  data.tar.gz: 1282b9c10fe0ac75ba5e2793da8a08a1e0deb462
+  metadata.gz: 83a5be099ceb5cd745dc8fe1cd49ae0c5a72ba6d
+  data.tar.gz: 3670874653b5bc44c0dac63b277f755b99ad93cb
 SHA512:
-  metadata.gz: 36f0b7eeab09aeee018e6610fd510a392110e7c6d6251d7b78b70c9c9b33b36014675b373f36487e53139ed79f397fa0e4404aee052c2f1c9630b4120c1cd2da
-  data.tar.gz: c61a05b0b34fdf009ab676eda0a67f209f42c53d792952e39e454ac09be6cc4c9c2c66f665d47717a0b89a50e4155462ac6b8cb07c2bde46a577b351a374d33f
+  metadata.gz: caf8e64a95d305198f5558e05cdf59fcffa12a0c48ccb447644cd108aff0595dad6c0e8b9924efb0c1067883bf5e5b049dd81f5ff03f5523fb93c575873f1c91
+  data.tar.gz: 4543dfab3f31ac9d8077fce7a29a17dcb3e72cfa97635300f7fadd52dca7fa69599cda30cf4400b9671610f6c05a8dd13c04251ccc0b999a1aef352e7e876f0d

data/README.textile

@@ -58,19 +58,19 @@ In config/initializers/hydra_config.rb
     # ... other stuff ...
     indexer = Solrizer::Descriptor.new(:string, :stored, :indexed, :multivalued)
     config[:permissions] = {
-      :discover => {:group =>ActiveFedora::SolrService.solr_name("discover_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("discover_access_person", indexer)},
-      :read => {:group =>ActiveFedora::SolrService.solr_name("read_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("read_access_person", indexer)},
-      :edit => {:group =>ActiveFedora::SolrService.solr_name("edit_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("edit_access_person", indexer)},
-      :owner => ActiveFedora::SolrService.solr_name("depositor", indexer),
-      :embargo_release_date => ActiveFedora::SolrService.solr_name("embargo_release_date", Solrizer::Descriptor.new(:date, :stored, :indexed))
+      :discover => {:group =>ActiveFedora::SolrQueryBuilder.solr_name("discover_access_group", indexer), :individual=>ActiveFedora::SolrQueryBuilder.solr_name("discover_access_person", indexer)},
+      :read => {:group =>ActiveFedora::SolrQueryBuilder.solr_name("read_access_group", indexer), :individual=>ActiveFedora::SolrQueryBuilder.solr_name("read_access_person", indexer)},
+      :edit => {:group =>ActiveFedora::SolrQueryBuilder.solr_name("edit_access_group", indexer), :individual=>ActiveFedora::SolrQueryBuilder.solr_name("edit_access_person", indexer)},
+      :owner => ActiveFedora::SolrQueryBuilder.solr_name("depositor", indexer),
+      :embargo_release_date => ActiveFedora::SolrQueryBuilder.solr_name("embargo_release_date", Solrizer::Descriptor.new(:date, :stored, :indexed))
     }
     indexer = Solrizer::Descriptor.new(:string, :stored, :indexed, :multivalued)
     config[:permissions][:inheritable] = {
-      :discover => {:group =>ActiveFedora::SolrService.solr_name("inheritable_discover_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("inheritable_discover_access_person", indexer)},
-      :read => {:group =>ActiveFedora::SolrService.solr_name("inheritable_read_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("inheritable_read_access_person", indexer)},
-      :edit => {:group =>ActiveFedora::SolrService.solr_name("inheritable_edit_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("inheritable_edit_access_person", indexer)},
-      :owner => ActiveFedora::SolrService.solr_name("inheritable_depositor", indexer),
-      :embargo_release_date => ActiveFedora::SolrService.solr_name("inheritable_embargo_release_date", Solrizer::Descriptor.new(:date, :stored, :indexed))
+      :discover => {:group =>ActiveFedora::SolrQueryBuilder.solr_name("inheritable_discover_access_group", indexer), :individual=>ActiveFedora::SolrQueryBuilder.solr_name("inheritable_discover_access_person", indexer)},
+      :read => {:group =>ActiveFedora::SolrQueryBuilder.solr_name("inheritable_read_access_group", indexer), :individual=>ActiveFedora::SolrQueryBuilder.solr_name("inheritable_read_access_person", indexer)},
+      :edit => {:group =>ActiveFedora::SolrQueryBuilder.solr_name("inheritable_edit_access_group", indexer), :individual=>ActiveFedora::SolrQueryBuilder.solr_name("inheritable_edit_access_person", indexer)},
+      :owner => ActiveFedora::SolrQueryBuilder.solr_name("inheritable_depositor", indexer),
+      :embargo_release_date => ActiveFedora::SolrQueryBuilder.solr_name("inheritable_embargo_release_date", Solrizer::Descriptor.new(:date, :stored, :indexed))
     }
   end
 </pre>

data/app/models/concerns/hydra/access_controls/access_right.rb

@@ -1,7 +1,7 @@
 module Hydra
   module AccessControls
     class AccessRight
-      # What these groups are called in the Hydra rightsMetadata XML:
+      # What these groups are called in the Hydra rights assertions:
       PERMISSION_TEXT_VALUE_PUBLIC = 'public'.freeze
       PERMISSION_TEXT_VALUE_AUTHENTICATED = 'registered'.freeze
 
@@ -79,8 +79,9 @@ module Hydra
         def has_visibility_text_for?(text)
           visibility == text
         end
+
         def has_permission_text_for?(text)
-          !!permissions.detect { |perm| perm.name == text }
+          !!permissions.detect { |perm| perm.agent_name == text }
         end
     end
   end

data/app/models/concerns/hydra/access_controls/embargoable.rb

@@ -2,164 +2,152 @@ module Hydra
   module AccessControls
     module Embargoable
       extend ActiveSupport::Concern
+      include Hydra::AccessControls::WithAccessRight
 
       included do
-        include Hydra::AccessControls::WithAccessRight
-        # We include EmbargoableMethods so that it can override the methods included above,
-        # and doesn't create a ActiveSupport::Concern::MultipleIncludedBlocks
-        include EmbargoableMethods
         validates :embargo_release_date, :lease_expiration_date, :'hydra/future_date' => true
 
-        has_attributes :visibility_during_embargo, :visibility_after_embargo, :embargo_release_date,
-          :visibility_during_lease, :visibility_after_lease, :lease_expiration_date,
-          datastream: 'rightsMetadata', multiple: false
+        belongs_to :embargo, predicate: Hydra::ACL.hasEmbargo, class_name: 'Hydra::AccessControls::Embargo'
+        belongs_to :lease, predicate: Hydra::ACL.hasLease, class_name: 'Hydra::AccessControls::Lease'
 
-        has_attributes :embargo_history, :lease_history, datastream: 'rightsMetadata', multiple:true
+        delegate :visibility_during_embargo, :visibility_during_embargo=, :visibility_after_embargo, :visibility_after_embargo=, :embargo_release_date, :embargo_release_date=, :embargo_history, :embargo_history=, to: :existing_or_new_embargo
+        delegate :visibility_during_lease, :visibility_during_lease=, :visibility_after_lease, :visibility_after_lease=, :lease_expiration_date, :lease_expiration_date=, :lease_history, :lease_history=, to: :existing_or_new_lease
       end
 
-      module EmbargoableMethods
-        def under_embargo?
-          rightsMetadata.under_embargo?
-        end
+      # if the embargo exists return it, if not, build one and return it
+      def existing_or_new_embargo
+        embargo || build_embargo
+      end
 
-        def active_lease?
-          rightsMetadata.active_lease?
-        end
+      # if the lease exists return it, if not, build one and return it
+      def existing_or_new_lease
+        lease || build_lease
+      end
 
-        # If changing away from embargo or lease, this will deactivate the lease/embargo before proceeding.
-        # The lease_visibility! and embargo_visibility! methods rely on this to deactivate the lease when applicable.
-        def visibility=(value)
-          # If changing from embargo or lease, deactivate the lease/embargo and wipe out the associated metadata before proceeding
-          if !embargo_release_date.nil?
-            deactivate_embargo! unless value == visibility_during_embargo
-          end
-          if !lease_expiration_date.nil?
-            deactivate_lease! unless value == visibility_during_lease
-          end
-          super
+      def to_solr(solr_doc = {})
+        super.tap do |doc|
+          doc.merge!(embargo.to_hash) if embargo
+          doc.merge!(lease.to_hash) if lease
         end
+      end
 
-        def apply_embargo(release_date, visibility_during=nil, visibility_after=nil)
-          self.embargo_release_date = release_date
-          self.visibility_during_embargo = visibility_during unless visibility_during.nil?
-          self.visibility_after_embargo = visibility_after unless visibility_after.nil?
-          embargo_visibility!
-          visibility_will_change!
-        end
+      def under_embargo?
+        embargo && embargo.active?
+      end
 
-        def deactivate_embargo!
-          return unless embargo_release_date
-          embargo_state = under_embargo? ? "active" : "expired"
-          embargo_record = embargo_history_message(embargo_state, Date.today, embargo_release_date, visibility_during_embargo, visibility_after_embargo)
-          self.embargo_release_date = nil
-          self.visibility_during_embargo = nil
-          self.visibility_after_embargo = nil
-          self.embargo_history += [embargo_record]
-          visibility_will_change!
-        end
+      def active_lease?
+        lease && lease.active?
+      end
 
-        def validate_embargo
-          if embargo_release_date
-            if under_embargo?
-              expected_visibility = visibility_during_embargo
-              failure_message = "An embargo is in effect for this object until #{embargo_release_date}.  Until that time the "
-            else
-              expected_visibility = visibility_after_embargo
-              failure_message = "The embargo expired on #{embargo_release_date}.  The "
-            end
-            if visibility == expected_visibility
-              return true
-            else
-              failure_message << "visibility should be #{expected_visibility} but it is currently #{visibility}.  Call embargo_visibility! on this object to repair."
-              self.errors[:embargo] << failure_message
-              return false
-            end
-          else
-            return true
-          end
-        end
 
-        # Set the current visibility to match what is described in the embargo.
-        def embargo_visibility!
-          if embargo_release_date
-            if under_embargo?
-              self.visibility_during_embargo = visibility_during_embargo ? visibility_during_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
-              self.visibility_after_embargo = visibility_after_embargo ? visibility_after_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
-              self.visibility = visibility_during_embargo
-            else
-              self.visibility = visibility_after_embargo ? visibility_after_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
-            end
-          end
+      # If changing away from embargo or lease, this will deactivate the lease/embargo before proceeding.
+      # The lease_visibility! and embargo_visibility! methods rely on this to deactivate the lease when applicable.
+      def visibility=(value)
+        # If changing from embargo or lease, deactivate the lease/embargo and wipe out the associated metadata before proceeding
+        if !embargo_release_date.nil?
+          deactivate_embargo! unless value == visibility_during_embargo
         end
-
-        def validate_lease
-          if lease_expiration_date
-            if active_lease?
-              expected_visibility = visibility_during_lease
-              failure_message = "A lease is in effect for this object until #{lease_expiration_date}.  Until that time the "
-            else
-              expected_visibility = visibility_after_lease
-              failure_message = "The lease expired on #{lease_expiration_date}.  The "
-            end
-            if visibility == expected_visibility
-              return true
-            else
-              failure_message << "visibility should be #{expected_visibility} but it is currently #{visibility}.  Call lease_visibility! on this object to repair."
-              self.errors[:lease] << failure_message
-              return false
-            end
-          else
-            return true
-          end
+        if !lease_expiration_date.nil?
+          deactivate_lease! unless value == visibility_during_lease
         end
+        super
+      end
 
-        def apply_lease(release_date, visibility_during=nil, visibility_after=nil)
-          self.lease_expiration_date = release_date
-          self.visibility_during_lease = visibility_during unless visibility_during.nil?
-          self.visibility_after_lease = visibility_after unless visibility_after.nil?
-          lease_visibility!
-          visibility_will_change!
+      def apply_embargo(release_date, visibility_during=nil, visibility_after=nil)
+        self.embargo_release_date = release_date
+        self.visibility_during_embargo = visibility_during unless visibility_during.nil?
+        self.visibility_after_embargo = visibility_after unless visibility_after.nil?
+        embargo_visibility!
+        visibility_will_change!
+      end
+
+      def deactivate_embargo!
+        embargo && embargo.deactivate!
+        visibility_will_change!
+      end
+
+      # Validate that the current visibility is what is specified in the embargo
+      def validate_embargo
+        Deprecation.warn Embargoable, "validate_embargo is deprecated and will be removed in hydra-access-controls 9.0.0. Use validate_visibility_complies_with_embargo instead."
+        validate_visibility_complies_with_embargo
+      end
+
+      # Validate that the current visibility is what is specified in the embargo
+      def validate_visibility_complies_with_embargo
+        return true unless embargo_release_date
+        if under_embargo?
+          expected_visibility = visibility_during_embargo
+          failure_message = "An embargo is in effect for this object until #{embargo_release_date}.  Until that time the "
+        else
+          expected_visibility = visibility_after_embargo
+          failure_message = "The embargo expired on #{embargo_release_date}.  The "
+        end
+        if visibility != expected_visibility
+          failure_message << "visibility should be #{expected_visibility} but it is currently #{visibility}.  Call embargo_visibility! on this object to repair."
+          self.errors[:embargo] << failure_message
+          return false
         end
+        true
+      end
 
-        def deactivate_lease!
-          return unless lease_expiration_date
-          lease_state = active_lease? ? "active" : "expired"
-          lease_record = lease_history_message(lease_state, Date.today, lease_expiration_date, visibility_during_lease, visibility_after_lease)
-          self.lease_expiration_date = nil
-          self.visibility_during_lease = nil
-          self.visibility_after_lease = nil
-          self.lease_history += [lease_record]
-          visibility_will_change!
+      # Set the current visibility to match what is described in the embargo.
+      def embargo_visibility!
+        return unless embargo_release_date
+        if under_embargo?
+          self.visibility_during_embargo = visibility_during_embargo ? visibility_during_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
+          self.visibility_after_embargo = visibility_after_embargo ? visibility_after_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
+          self.visibility = visibility_during_embargo
+        else
+          self.visibility = visibility_after_embargo ? visibility_after_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
         end
+      end
 
-        # Set the current visibility to match what is described in the lease.
-        def lease_visibility!
-          if lease_expiration_date
-            if active_lease?
-              self.visibility_during_lease = visibility_during_lease ? visibility_during_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
-              self.visibility_after_lease = visibility_after_lease ? visibility_after_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
-              self.visibility = visibility_during_lease
-            else
-              self.visibility = visibility_after_lease ? visibility_after_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
-            end
-          end
+      def validate_lease
+        Deprecation.warn Embargoable, "validate_lease is deprecated and will be removed in hydra-access-controls 9.0.0. Use validate_visibility_complies_with_lease instead."
+        validate_visibility_complies_with_lease
+      end
+
+      def validate_visibility_complies_with_lease
+        return true unless lease_expiration_date
+        if active_lease?
+          expected_visibility = visibility_during_lease
+          failure_message = "A lease is in effect for this object until #{lease_expiration_date}.  Until that time the "
+        else
+          expected_visibility = visibility_after_lease
+          failure_message = "The lease expired on #{lease_expiration_date}.  The "
+        end
+        if visibility != expected_visibility
+          failure_message << "visibility should be #{expected_visibility} but it is currently #{visibility}.  Call lease_visibility! on this object to repair."
+          self.errors[:lease] << failure_message
+          return false
         end
+        true
+      end
 
-        protected
+      def apply_lease(release_date, visibility_during=nil, visibility_after=nil)
+        self.lease_expiration_date = release_date
+        self.visibility_during_lease = visibility_during unless visibility_during.nil?
+        self.visibility_after_lease = visibility_after unless visibility_after.nil?
+        lease_visibility!
+        visibility_will_change!
+      end
 
-          # Create the log message used when deactivating an embargo
-          # This method may be overriden in order to transform the values of the passed parameters.
-          def embargo_history_message(state, deactivate_date, release_date, visibility_during, visibility_after)
-            I18n.t 'hydra.embargo.history_message', state: state, deactivate_date: deactivate_date, release_date: release_date,
-              visibility_during: visibility_during, visibility_after: visibility_after
-          end
+      def deactivate_lease!
+        lease && lease.deactivate!
+        visibility_will_change!
+      end
 
-          # Create the log message used when deactivating a lease
-          # This method may be overriden in order to transform the values of the passed parameters.
-          def lease_history_message(state, deactivate_date, expiration_date, visibility_during, visibility_after)
-            I18n.t 'hydra.lease.history_message', state: state, deactivate_date: deactivate_date, expiration_date: expiration_date,
-              visibility_during: visibility_during, visibility_after: visibility_after
+      # Set the current visibility to match what is described in the lease.
+      def lease_visibility!
+        if lease_expiration_date
+          if active_lease?
+            self.visibility_during_lease = visibility_during_lease ? visibility_during_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
+            self.visibility_after_lease = visibility_after_lease ? visibility_after_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
+            self.visibility = visibility_during_lease
+          else
+            self.visibility = visibility_after_lease ? visibility_after_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
           end
+        end
       end
     end
   end