dor-rights-auth 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cf8440dedbe7f16ab7b4c9e6ddb7b2915469fed
-  data.tar.gz: f9af60728a4c488eebfd37f4812cedc90f243675
+  metadata.gz: f11af5041a20deb4cbbfb44ffc3a62683f4b1b1f
+  data.tar.gz: ebb61768470adb0888c612c13947e58125ca478a
 SHA512:
-  metadata.gz: 318fbc547f7abd9bd91dc0199b3f5acd71985c04324cb2cdf7ebee64e324e10687ec727475a4ecb9e5523ba8e970ef55904fc9a63133dc7f2fce8454d9255e15
-  data.tar.gz: df90d1277ddf87928a34ab995bbb596faaeb0c56b86f79f316a8589eb08e37154277b688dd69229dc98e0033c470c68242b7329aeb143364505fa0a2f9bed2dd
+  metadata.gz: 92a28e6e5f84bb81a71b69b8ff36c0cf7c661458260f7ec129ce5f1448eb19f5d91c5a17945b32ec609c30840ce33566e617e6718f2f19c5854cd33d3db54ddd
+  data.tar.gz: 31557219e0eda1041b8fe34ebc4e4fc52b8615c037c36af43d2939ba5453b6cef28b844dc2dc9561d90ee2eefce4a2bfb431f2dc54dc9d2c573e2cf7d14c59c6

data/lib/dor/rights_auth.rb

@@ -32,6 +32,7 @@ module Dor
   class RightsAuth
 
     CONTAINS_STANFORD_XPATH = "contains(translate(text(), 'STANFORD', 'stanford'), 'stanford')".freeze
+    NO_DOWNLOAD_RULE = 'no-download'.freeze
 
     attr_accessor :obj_lvl, :file, :embargoed, :index_elements
 
@@ -53,7 +54,6 @@ module Dor
     def world_unrestricted?
       @obj_lvl.world.value && @obj_lvl.world.rule.nil?
     end
-
     alias_method :public_unrestricted?, :world_unrestricted?
 
     def readable?
@@ -61,12 +61,27 @@ module Dor
       public_unrestricted? || stanford_only_unrestricted?
     end
 
+    # Returns true if the object is readable AND allows download
+    # @return [Boolean]
+    def world_downloadable?
+      world_rule = @obj_lvl.world.rule
+      @obj_lvl.world.value && (world_rule.nil? || world_rule != NO_DOWNLOAD_RULE)
+    end
+    alias_method :public_downloadable?, :world_downloadable?
+
     # Returns true if the object is stanford-only readable AND has no rule attribute
     # @return [Boolean]
     def stanford_only_unrestricted?
       @obj_lvl.group[:stanford].value && @obj_lvl.group[:stanford].rule.nil?
     end
 
+    # Returns true if the object is stanford-only readable AND allows download
+    # @return [Boolean]
+    def stanford_only_downloadable?
+      stanford_rule = @obj_lvl.group[:stanford].rule
+      @obj_lvl.group[:stanford].value && (stanford_rule.nil? || stanford_rule != NO_DOWNLOAD_RULE)
+    end
+
     # Returns true if the passed in agent (usually an application) is allowed access to the object without a rule
     # @param [String] agent_name Name of the agent that wants to access this object
     # @return [Boolean]
@@ -74,7 +89,6 @@ module Dor
       return false unless @obj_lvl.agent.key? agent_name
       @obj_lvl.agent[agent_name].value && @obj_lvl.agent[agent_name].rule.nil?
     end
-
     alias_method :allowed_read_agent?, :agent_unrestricted?
 
     # Returns true if the file is stanford-only readable AND has no rule attribute
@@ -98,18 +112,38 @@ module Dor
 
       @file[file_name].world.value && @file[file_name].world.rule.nil?
     end
-
     alias_method :public_unrestricted_file?, :world_unrestricted_file?
 
+    # Returns true if the file is world readable AND either has no rule attribute or
+    # the rule attribute is not 'no-download'
+    #   If world rights do not exist for this file, then object level rights are returned
+    # @see #world_downloadable?
+    # @param [String] file_name name of the file being tested
+    # @return (see #world_rights)
+    def world_downloadable_file?(file_name)
+      return world_downloadable? if @file[file_name].nil? || @file[file_name].world.nil?
+
+      world_rule = @file[file_name].world.rule
+      @file[file_name].world.value && (world_rule.nil? || world_rule != NO_DOWNLOAD_RULE)
+    end
+    alias_method :public_downloadable_file?, :world_downloadable_file?
+
+    def stanford_only_downloadable_file?(file_name)
+      return stanford_only_downloadable? if @file[file_name].nil? || @file[file_name].group[:stanford].nil?
+
+      stanford_rule = @file[file_name].group[:stanford].rule
+      @file[file_name].group[:stanford].value && (stanford_rule.nil? || stanford_rule != NO_DOWNLOAD_RULE)
+    end
+
     # Returns whether an object-level world node exists, and the value of its rule attribute
-    # @return [Array<(Boolean, String)>] First value: existance of node. Second Value: rule attribute, nil otherwise
+    # @return [Array<(Boolean, String)>] First value: existence of node. Second Value: rule attribute, nil otherwise
     # @example Using multiple variable assignment to read both array elements
     #   world_exists, world_rule = rights.world_rights
     def world_rights
       [@obj_lvl.world.value, @obj_lvl.world.rule]
     end
 
-    # Returns whether and object-level group/stanford node exists, and the value of its rule attribute
+    # Returns whether an object-level group/stanford node exists, and the value of its rule attribute
     # @return (see #world_rights)
     # @example Using multiple variable assignment to read both array elements
     #   su_only_exists, su_only_rule = rights.stanford_only_rights
@@ -168,7 +202,7 @@ module Dor
     # Returns whether a file-level group/stanford node exists, and the value of its rule attribute
     #    If a group/stanford node does not exist for this file, then object-level group/stanford rights are returned
     # @see #stanford_only_rights
-    # @param (see #world_rights_for_file)
+    # @param [String] file_name name of the file being tested
     # @return (see #world_rights)
     # @example Using multiple variable assignment to read both array elements
     #   su_only_exists, su_only_rule = rights.stanford_only_rights_for_file('somefile')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-rights-auth
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -97,7 +97,6 @@ dependencies:
         version: '0'
 description: Parses rightsMetadata xml into a useable object
 email:
-- wmene@stanford.edu
 - atz@stanford.edu
 executables: []
 extensions: []
@@ -131,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Parses rightsMetadata xml into a useable object