ddr-models 3.0.0.alpha.4 → 3.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed265d93ca6307ec23a3d9055d0f6965f8cb00cb
-  data.tar.gz: 48a3f01ac1cd908e49695d612be9737143102553
+  metadata.gz: 7a968b891893ea815c1d2cdfd34f7b30fd7b0037
+  data.tar.gz: ab7b098e5f87fa7f31793e878206031bd010c98b
 SHA512:
-  metadata.gz: 5fb8f5bca78ed6874d69829f0555dd6b395e7133206494bc09cad31348dfdec131120acbb8f7b0c05b48a816006c68ab0bb46d4a5e5002dbdb4b112509512d39
-  data.tar.gz: 88f6ac010d23f70f07f36c4a0ffb7364abdbfa5e956d2b835ee11085c7de77010f15e4e6e8b65eaa209760951c0e5217e37aba32c5772158aaf2d985c343eaa0
+  metadata.gz: 76508b87a3e44c630e445d2ac5f89286ff08c59ffac61f07902e5e9e3ef59d54db78e2b1707d578f905c4c682008fc178ce770f8b61aa326a67490db2975a727
+  data.tar.gz: 3b288f688a6513a82feada181e1fe8c60dde16fbb4bba03c809b5c0dcc21730008e551ab6c5575fa63f01bec9fd861f757431e5dcb09b664d7e091e37fcf11a7

data/Gemfile

@@ -3,5 +3,3 @@ source 'https://rubygems.org'
 gemspec
 
 gem "devise"
-
-gem "active-fedora", github: "projecthydra/active_fedora", ref: "f85b4eab16f45cb4c1491a27bb20b05821bd9c44"

data/app/models/collection.rb

@@ -46,8 +46,12 @@ class Collection < Ddr::Models::Base
   end
 
   def grant_roles_to_creator(creator)
-    roles.grant type: Ddr::Auth::Roles::CURATOR, agent: creator.agent, scope: Ddr::Auth::Roles::RESOURCE_SCOPE
-    roles.grant type: Ddr::Auth::Roles::CURATOR, agent: creator.agent, scope: Ddr::Auth::Roles::POLICY_SCOPE
+    roles.grant role_type: Ddr::Auth::Roles::CURATOR,
+                agent: creator.agent,
+                scope: Ddr::Auth::Roles::RESOURCE_SCOPE
+    roles.grant role_type: Ddr::Auth::Roles::CURATOR,
+                agent: creator.agent,
+                scope: Ddr::Auth::Roles::POLICY_SCOPE
   end
 
   private

data/config/initializers/active_fedora_base.rb

@@ -1,5 +1,4 @@
-module ActiveFedora
-  class Base
+ActiveFedora::Base.class_eval do
 
     def can_have_attachments?
       has_association? :attachments
@@ -26,8 +25,9 @@ module ActiveFedora
     end
 
     def describable?
-      self.is_a? Ddr::Models::Describable
+      self.is_a? Ddr::Models::Base
     end
+    deprecation_deprecate :describable?
 
     def governable?
       has_association? :admin_policy
@@ -85,5 +85,4 @@ module ActiveFedora
       !association(assoc).nil?
     end
 
-  end
 end

data/ddr-models.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rails", "~> 4.1.13"
   s.add_dependency "active-triples", "~> 0.7.2"
-  s.add_dependency "active-fedora", "~> 9.5"
+  s.add_dependency "active-fedora", "~> 9.6.2"
   s.add_dependency "hydra-validations", "~> 0.5"
   s.add_dependency "devise", "~> 3.4"
   s.add_dependency "omniauth-shibboleth", "~> 1.2.0"
@@ -31,7 +31,8 @@ Gem::Specification.new do |s|
   s.add_dependency "net-ldap", "~> 0.11"
   s.add_dependency "cancancan", "~> 1.12"
   s.add_dependency "ddr-aux-client", "~> 1.2", ">= 1.2.2"
-  s.add_dependency "ddr-antivirus", "2.0.0"
+  s.add_dependency "ddr-antivirus", "~> 2.1.1"
+  s.add_dependency "virtus", "~> 1.0.5"
 
   s.add_development_dependency "bundler", "~> 1.10"
   s.add_development_dependency "rake"
@@ -41,5 +42,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "factory_girl_rails", "~> 4.4"
   s.add_development_dependency "jettywrapper", "~> 2.0"
   s.add_development_dependency "database_cleaner"
-  s.add_development_dependency "blacklight", "~> 5.15"
+  s.add_development_dependency "blacklight", "~> 5.15.0"
 end

data/lib/ddr/auth/effective_roles.rb

@@ -3,19 +3,15 @@ require "delegate"
 module Ddr::Auth
   class EffectiveRoles < SimpleDelegator
 
-    # @param obj [Object] an object that receives :roles and returns a RoleSet
-    # @param agents [String, Array<String>] agent(s) to match roles
-    # @return [Ddr::Auth::Roles::RoleSetQuery]
     def self.call(obj, agents)
       new(obj).call(agents)
     end
 
-    # @param agents [String, Array<String>] agent(s) to match roles
-    # @return [Ddr::Auth::Roles::RoleSetQuery]
     def call(agents)
       ResourceRoles.call(self)
         .merge(InheritedRoles.call(self))
         .agent(agents)
+        .result
     end
 
   end

data/lib/ddr/auth/inherited_roles.rb

@@ -3,18 +3,15 @@ require "delegate"
 module Ddr::Auth
   class InheritedRoles < SimpleDelegator
 
-    # @param obj [Object] an object that receives :roles and returns a RoleSet
-    # @return [Ddr::Auth::Roles::RoleSetQuery]
     def self.call(obj)
       new(obj).call
     end
 
-    # @return [Ddr::Auth::Roles::DetachedRoleSet]
     def call
       if has_admin_policy?
-        admin_policy.roles.in_policy_scope.detach
+        admin_policy.roles.in_policy_scope.result
       else
-        Roles::DetachedRoleSet.new
+        Roles::RoleSet.new
       end
     end
 

data/lib/ddr/auth/resource_roles.rb

@@ -3,15 +3,12 @@ require "delegate"
 module Ddr::Auth
   class ResourceRoles < SimpleDelegator
 
-    # @param obj [Object] an object that receives :roles and returns a RoleSet
-    # @return [Ddr::Auth::Roles::RoleSetQuery]
     def self.call(obj)
       new(obj).call
     end
 
-    # @return [Ddr::Auth::Roles::DetachedRoleSet]
     def call
-      roles.in_resource_scope.detach
+      roles.in_resource_scope.result
     end
 
   end

data/lib/ddr/auth/roles.rb

@@ -2,14 +2,14 @@ module Ddr::Auth
   module Roles
     extend ActiveSupport::Autoload
 
-    autoload :DetachedRoleSet
-    autoload :PropertyRoleSet
     autoload :Role
+    autoload :RoleAttribute
     autoload :RoleSet
+    autoload :RoleSetManager
     autoload :RoleSetQuery
-    autoload :RolesDatastream
     autoload :RoleType
     autoload :RoleTypes
+    autoload :RoleValidator
 
     include RoleTypes
 

data/lib/ddr/auth/roles/role.rb

@@ -1,117 +1,70 @@
-module Ddr
-  module Auth
-    module Roles
-      #
-      # The assignment of a role to an agent within a scope.
-      #
-      class Role < ActiveTriples::Resource
-
-        DEFAULT_SCOPE = Roles::RESOURCE_SCOPE
-
-        include Hydra::Validations
-
-        configure type: Ddr::Vocab::Roles.Role
-        property :role_type, predicate: Ddr::Vocab::Roles.type
-        property :agent, predicate: Ddr::Vocab::Roles.agent
-        property :scope, predicate: Ddr::Vocab::Roles.scope
-
-        validates :agent, presence: true, cardinality: { is: 1 }
-        validates :role_type, inclusion: { in: Roles.type_map.keys }, cardinality: { is: 1 }
-        validates :scope, inclusion: { in: Roles::SCOPES }, cardinality: { is: 1 }
-
-        class << self
-
-          # Build a Role instance from hash attributes
-          # @param args [Hash] the attributes
-          # @return [Role] the role
-          # @example
-          #   Role.build type: "Curator", agent: "bob", scope: "resource"
-          def build(args={})
-            new.tap do |role|
-              role.attributes = build_attributes(args)
-              if role.invalid?
-                raise Ddr::Models::Error, "Invalid #{self.name}: #{role.errors.full_messages.join('; ')}"
-              end
-            end
-          end
-
-          alias_method :deserialize, :build
-
-          # Deserialize a Role from JSON
-          # @param json [String] the JSON string
-          # @return [Role] the role
-          def from_json(json)
-            deserialize JSON.parse(json)
-          end
-
-          private
-
-          def build_attributes(args={})
-            # symbolize keys and stringify values
-            attrs = args.each_with_object({}) do |(k, v), memo|
-              memo[k.to_sym] = Array(v).first.to_s
-            end
-            # set default scope if necessary
-            attrs[:scope] ||= DEFAULT_SCOPE
-            # accept :type key for role_type attribute
-            if attrs.key?(:type)
-              attrs[:role_type] = attrs.delete(:type)
-            end
-            attrs
-          end
-
-        end
-
-        # Roles are considered equivalent (== and eql?) if they
-        # are of the same type and have the same agent and scope.
-        # @param other [Object] the object of comparison
-        # @return [Boolean] the result
-        def ==(other)
-          if self.class == other.class
-            self.to_h == other.to_h
-          else
-            super
-          end
-        end
+require "json"
+require "virtus"
+
+module Ddr::Auth
+  module Roles
+    #
+    # The assignment of a role to an agent within a scope.
+    #
+    class Role
+      extend Deprecation
+      include Virtus.value_object
+      include Ddr::Models::Validatable
+
+      self.validator = RoleValidator
+
+      DEFAULT_SCOPE = Roles::RESOURCE_SCOPE
+
+      values do
+        attribute :agent,     RoleAttribute
+        attribute :role_type, RoleAttribute
+        attribute :scope,     RoleAttribute, default: DEFAULT_SCOPE
+      end
 
-        def eql?(other)
-          (self == other) && (hash == other.hash)
+      class << self
+        def build(*args)
+          Deprecation.warn(Role, "`build` is deprecated; use `new` instead.")
+          new(*args)
         end
 
-        def hash
-          to_h.hash
+        def from_json(json)
+          new JSON.parse(json)
         end
+      end
 
-        def to_s
-          to_h.to_s
-        end
+      def initialize(*args)
+        super
+        validate!
+      end
 
-        def in_resource_scope?
-          scope.first == Roles::RESOURCE_SCOPE
-        end
+      def to_s
+        to_h.to_s
+      end
 
-        def in_policy_scope?
-          scope.first == Roles::POLICY_SCOPE
-        end
+      def to_json
+        JSON.dump(to_h)
+      end
 
-        def inspect
-          "#<#{self.class.name} role_type=#{role_type.first.inspect}, " \
-          "agent=#{agent.first.inspect}, scope=#{scope.first.inspect}>"
+      def validate!
+        if invalid?
+          raise Ddr::Models::Error, "Invalid Role: #{errors.full_messages.join('; ')}"
         end
+      end
 
-        def to_h
-          as_json
-        end
-        alias_method :to_hash, :to_h
-        alias_method :serialize, :to_h
+      def in_resource_scope?
+        scope == Roles::RESOURCE_SCOPE
+      end
 
-        # Returns the permissions associated with the role
-        # @return [Array<Symbol>] the permissions
-        def permissions
-          Roles.type_map[role_type.first].permissions
-        end
+      def in_policy_scope?
+        scope == Roles::POLICY_SCOPE
+      end
 
+      # Returns the permissions associated with the role
+      # @return [Array<Symbol>] the permissions
+      def permissions
+        Roles.type_map[role_type].permissions
       end
+
     end
   end
 end

data/lib/ddr/auth/roles/role_attribute.rb

@@ -0,0 +1,16 @@
+require "virtus"
+
+module Ddr::Auth
+  module Roles
+    class RoleAttribute < Virtus::Attribute
+
+      def coerce(value)
+        if value.is_a? Array
+          return coerce(value.first)
+        end
+        value.to_s
+      end
+
+    end
+  end
+end

data/lib/ddr/auth/roles/role_set.rb

@@ -1,102 +1,49 @@
+require "set"
+require "virtus"
+
 module Ddr::Auth
   module Roles
     #
     # Wraps a set of Roles
     #
-    # @abstract
-    #
     class RoleSet
+      include Virtus.model
       include Enumerable
+      include ActiveModel::Serializers::JSON
 
-      attr_reader :role_set
+      attribute :roles, Set[Role]
 
-      delegate :where, :agent, :scope, :role_type, :type, :agents, :permissions,
+      delegate :where, :agent, :scope, :role_type,
                :in_policy_scope, :in_resource_scope,
                to: :query
 
-      delegate :empty?, :clear, to: :role_set
-
-      def initialize(role_set)
-        @role_set = role_set
-      end
-
-      # Grants roles - i.e., adds them to the role set
-      # @example - default scope ("resource")
-      #   grant type: "Curator", agent: "bob"
-      # @example - explicit scope
-      #   grant type: "Curator", agent: "sue", scope: "policy"
-      # @param roles [Role, Hash, RoleSet, Array] the role(s) to grant
-      def grant(*roles)
-        raise NotImplementedError, "Subclasses must implement `grant`."
-      end
-
-      # Return true/false depending on whether the role has been granted
-      # @param role [Ddr::Auth::Roles::Role, Hash] the role
-      # @return [Boolean] whether the role has been granted
-      def granted?(role)
-        include? coerce(role)
-      end
+      delegate :each, :empty?, :clear, to: :roles
 
-      # Revokes roles - i.e., removes them from the role set
-      # @example
-      #   revoke type: "Curator", agent: "bob", scope: "resource"
-      # @param roles [Role, Hash, RoleSet, Array] the role(s) to revoke
-      def revoke(*roles)
-        raise NotImplementedError, "Subclasses must implement `revoke`."
+      def self.from_json(json)
+        new.from_json(json.present? ? json : "{}")
       end
 
-      # Replace the current roles in the role set with new roles
-      # @param roles [Role, Hash, RoleSet, Array] the role(s) to grant
-      def replace(*roles)
-        revoke_all
-        grant(*roles)
-      end
-
-      # Remove all roles from the role set
-      # @return [RoleSet] self
-      def revoke_all
-        raise NotImplementedError, "Subclasses must implement `revoke_all`."
+      def ==(other)
+        instance_of?(other.class) && self.roles == other.roles
       end
 
-      # Return the RoleSet serialized as JSON
-      # @return [String] the JSON string
-      def to_json
-        serialize.to_json
+      def merge(other)
+        self.roles += other.roles
+        self
       end
 
-      # Return the RoleSet serialized as an Array of serialized Roles
-      # @return [Array<Hash>]
-      def serialize
-        to_a.map(&:serialize)
+      def permissions
+        map(&:permissions).flatten.uniq
       end
 
-      def ==(other)
-        if other.is_a? RoleSet
-          self.to_set == other.to_set
-        else
-          super
-        end
+      def agents
+        map(&:agent).uniq
       end
 
-      private
-
       def query
         RoleSetQuery.new(self)
       end
 
-      def coerce(obj)
-        case obj
-        when RoleSet
-          coerce(obj.role_set)
-        when Array, Set
-          obj.map { |r| coerce(r) }.flatten
-        when Role
-          obj
-        else
-          Role.build(obj)
-        end
-      end
-
     end
   end
 end