dor-rights-auth 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 155c15e0037ba6d647c2926ab7d83c01eb28902e
-  data.tar.gz: b3ea1d4f93bf56722f103d88f11dddd20b05cc77
+SHA256:
+  metadata.gz: f3461a34cc8edcf7b4362d1c6c58304bbe43a82fbd9edd16452ec02cf8a40204
+  data.tar.gz: 826e6ef53e3fec66cb97b1ab385793b9727ddc82bd81be1add9c46d285183303
 SHA512:
-  metadata.gz: 758a25ecd5845ec8e39d6bb23359c200d92f5ee77f6c37556afad96b63aa130b172b892abe6bc6b51479d4f90548f8470c6432004585c1ba9e3b5eab14690f18
-  data.tar.gz: 3d0f06f1fd0e34302c8a1010e3f7f4bff3e07750298421d0eafa3ffaf843c1c1cac391d48cee3a0ec560482a6eca2e41d1b0be354c46175baa5766b3ae8dcd6e
+  metadata.gz: 196996c12540e5e17907865aabdff51c36afca65d59781d6cf08660d7c422b8bd26fefd699bc211c02ffc51e97ada62331fc19a701f5b39c5a9e15b90a1248f0
+  data.tar.gz: 9dd9fa090720a1f4cdf5f9673513153ae3d41a63b57aaac99385353f26c9e4d3e1fa0e8309d863d1c0f01ab29302a4b4def2ee0730336ee72ace62f920ab9477

data/lib/dor/rights/auth.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'dor/rights_auth'

data/lib/dor/rights_auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 require 'time'
 
@@ -8,7 +10,7 @@ module Dor
   Rights = Struct.new(:value, :rule)
 
   # Rights for an object or File
-  EntityRights = Struct.new(:world, :group, :agent, :location)
+  EntityRights = Struct.new(:world, :group, :agent, :location, :controlled_digital_lending)
   # class EntityRights
   #   @world = #Rights
   #   @group {
@@ -18,6 +20,7 @@ module Dor
   #     'app1' => #Rights,
   #     'app2' => #Rights
   #   }
+  #   @controlled_digital_lending = false
   # end
 
   # class Dor::RightsAuth
@@ -31,8 +34,8 @@ module Dor
   # read rights_xml only once and create query-able methods for rights info
   class RightsAuth
 
-    CONTAINS_STANFORD_XPATH = "contains(translate(text(), 'STANFORD', 'stanford'), 'stanford')".freeze
-    NO_DOWNLOAD_RULE = 'no-download'.freeze
+    CONTAINS_STANFORD_XPATH = "contains(translate(text(), 'STANFORD', 'stanford'), 'stanford')"
+    NO_DOWNLOAD_RULE = 'no-download'
 
     attr_accessor :obj_lvl, :file, :embargoed, :index_elements
 
@@ -94,6 +97,12 @@ module Dor
     end
     alias_method :public_downloadable?, :world_downloadable?
 
+    # Returns true if the object is enabled for controlled digital lending
+    # @return [Boolean]
+    def controlled_digital_lending?
+      @obj_lvl.controlled_digital_lending
+    end
+
     # Returns true if the object is stanford-only readable AND has no rule attribute
     # @return [Boolean]
     def stanford_only_unrestricted?
@@ -112,6 +121,7 @@ module Dor
     # @return [Boolean]
     def agent_unrestricted?(agent_name)
       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?
@@ -194,8 +204,8 @@ module Dor
     # @return [Boolean] whether any location restrictions exist on the file or the
     #   object itself (in the absence of file-level rights)
     def restricted_by_location?(file_name = nil)
-      any_file_location = @file[file_name] && @file[file_name].location.any?
-      any_object_location = @obj_lvl.location && @obj_lvl.location.any?
+      any_file_location = @file[file_name]&.location&.any?
+      any_object_location = @obj_lvl.location&.any?
 
       any_file_location || any_object_location
     end
@@ -208,6 +218,7 @@ module Dor
     # @note should be called after doing a check for world_unrestricted?
     def agent_rights(agent_name)
       return [false, nil] if @obj_lvl.agent[agent_name].nil?
+
       [@obj_lvl.agent[agent_name].value, @obj_lvl.agent[agent_name].rule]
     end
 
@@ -274,6 +285,7 @@ module Dor
     # @return [Array]        list of things that are wrong with it
     def self.validate_lite(doc)
       return ['no_rightsMetadata'] if doc.nil? || doc.at_xpath('//rightsMetadata').nil?
+
       errors = []
       maindiscover = doc.at_xpath("//rightsMetadata/access[@type='discover' and not(file)]")
       mainread     = doc.at_xpath("//rightsMetadata/access[@type='read'     and not(file)]")
@@ -302,7 +314,10 @@ module Dor
     def self.extract_index_terms(doc)
       terms = []
       machine = doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine")
-      terms.push 'none_discover'  if doc.at_xpath("//rightsMetadata/access[@type='discover']/machine/none") || doc.at_xpath("//rightsMetadata/access[@type='discover']/machine[not(*)]")
+      if doc.at_xpath("//rightsMetadata/access[@type='discover']/machine/none") ||
+         doc.at_xpath("//rightsMetadata/access[@type='discover']/machine[not(*)]")
+        terms.push 'none_discover'
+      end
       terms.push 'world_discover' if doc.at_xpath("//rightsMetadata/access[@type='discover']/machine/world[not(@rule)]")
       return terms if machine.nil?
 
@@ -323,15 +338,15 @@ module Dor
         end
       end
 
-      if doc.at_xpath("//rightsMetadata/access[@type='read' and file]/machine/none")
-        terms.push "none_read_file"
-      end
+      terms.push 'none_read_file' if doc.at_xpath("//rightsMetadata/access[@type='read' and file]/machine/none")
 
       if machine.at_xpath('./none')
         terms.push 'none_read'
       elsif machine.at_xpath('./world')
         terms.push 'world_read'
         terms.push "world|#{machine.at_xpath('./world/@rule').value.downcase}" if machine.at_xpath('./world/@rule')
+      elsif machine.at_xpath('./cdl')
+        terms.push 'cdl_none'
       end
 
       # now some statistical generation
@@ -366,23 +381,23 @@ module Dor
     def self.init_index_elements(doc)
       errors = validate_lite(doc)
       stuff = {
-        :primary          => nil,
-        :errors           => errors,
-        :terms            => [],
-        :obj_groups       => [],
-        :obj_locations    => [],
-        :obj_agents       => [],
-        :file_groups      => [],
-        :file_locations   => [],
-        :file_agents      => [],
-        :obj_world_qualified      => [],
-        :obj_groups_qualified     => [],
-        :obj_locations_qualified  => [],
-        :obj_agents_qualified     => [],
-        :file_world_qualified     => [],
-        :file_groups_qualified    => [],
+        :primary => nil,
+        :errors => errors,
+        :terms => [],
+        :obj_groups => [],
+        :obj_locations => [],
+        :obj_agents => [],
+        :file_groups => [],
+        :file_locations => [],
+        :file_agents => [],
+        :obj_world_qualified => [],
+        :obj_groups_qualified => [],
+        :obj_locations_qualified => [],
+        :obj_agents_qualified => [],
+        :file_world_qualified => [],
+        :file_groups_qualified => [],
         :file_locations_qualified => [],
-        :file_agents_qualified    => []
+        :file_agents_qualified => []
       }
 
       if errors.include? 'no_rightsMetadata'
@@ -404,6 +419,8 @@ module Dor
       has_rule = index_terms.include? 'has_rule'
       if index_terms.include?('none_discover')
         'dark'
+      elsif index_terms.include?('cdl_none')
+        'controlled digital lending'
       elsif errors.include?('no_discover_access') || errors.include?('no_discover_machine')
         'dark'
       elsif errors.include?('no_read_machine') || index_terms.include?('none_read')
@@ -440,7 +457,14 @@ module Dor
         rights.obj_lvl.world.value = false
       end
 
-      rights.obj_lvl.group  = { :stanford => Rights.new }
+      # TODO: we should also look for the <group rule="no-download">stanford</group> node and parse as needed
+      if doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/cdl")
+        rights.obj_lvl.controlled_digital_lending = true
+      else
+        rights.obj_lvl.controlled_digital_lending = false
+      end
+
+      rights.obj_lvl.group = { :stanford => Rights.new }
       xpath = "//rightsMetadata/access[@type='read' and not(file)]/machine/group[#{CONTAINS_STANFORD_XPATH}]"
       if doc.at_xpath(xpath)
         rights.obj_lvl.group[:stanford].value = true
@@ -548,20 +572,20 @@ module Dor
       end
 
       if forindex
-        [:obj_groups,
-         :obj_locations,
-         :obj_agents,
-         :file_groups,
-         :file_locations,
-         :file_agents,
-         :obj_world_qualified,
-         :obj_groups_qualified,
-         :obj_locations_qualified,
-         :obj_agents_qualified,
-         :file_world_qualified,
-         :file_groups_qualified,
-         :file_locations_qualified,
-         :file_agents_qualified].each { |index_elt| rights.index_elements[index_elt].uniq! }
+        %i[obj_groups
+           obj_locations
+           obj_agents
+           file_groups
+           file_locations
+           file_agents
+           obj_world_qualified
+           obj_groups_qualified
+           obj_locations_qualified
+           obj_agents_qualified
+           file_world_qualified
+           file_groups_qualified
+           file_locations_qualified
+           file_agents_qualified].each { |index_elt| rights.index_elements[index_elt].uniq! }
       end
 
       rights

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: dor-rights-auth
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Willy Mene
 - Joe Atzberger
+- Johnathan Martin
+- Naomi Dushay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -25,6 +27,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +84,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +127,7 @@ dependencies:
         version: '0'
 description: Parses rightsMetadata xml into a useable object
 email:
-- atz@stanford.edu
+- dlss-infrastructure-team@lists.stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -120,17 +150,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Parses rightsMetadata xml into a useable object