dor-rights-auth 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c895adda420f96705ed01622032fbf43c1b733e4
-  data.tar.gz: a8e3f2516e6db25ad27e71c10ee222d5c1092c6a
+  metadata.gz: 40f40de949255d9644bb67069e570735acfa4b5b
+  data.tar.gz: 7691335eecd9d5cf68b6fa70609c782c7114f566
 SHA512:
-  metadata.gz: beab4b017e6e1b83766572b2efe83d7ab006ca61bff8f70dd78e1921f5bab1744bc1ec7ec01e535f05d1ec57c1b42d6f5c7e76954853161192ece8ecc41140a3
-  data.tar.gz: 84ec859efe66b495bfd836953cd6ada723544c3c7be2a924150fb812ea7cf573aa9888546ec1a4c761f1df67099b766200309f1321cc07643d7faf3434b72e49
+  metadata.gz: f71d100e9c23464dc50014d8749589f8c69ca46137eb60cfb82cbf5b3caa9cad0c5b99130a5bad2133c5e45d735c54ff3b6203f092105ecf1335c8da6960a770
+  data.tar.gz: 9278835bc26a8774acfccc5e41f8cb9cfc58750832db255f84444e1f3180fa31fb0401775dab9f57ecbbead7ec1798b58eda873f694d98384b52f2123c2a44b7

data/lib/dor/rights/auth.rb

@@ -0,0 +1 @@
+require 'dor/rights_auth'

data/lib/dor/rights_auth.rb

@@ -2,9 +2,8 @@ require 'nokogiri'
 require 'time'
 
 # We handle the ugly stuff, so you don't have to.
-
 module Dor
-
+  #
   # The Individual Right
   Rights = Struct.new(:value, :rule)
 
@@ -44,7 +43,7 @@ module Dor
 
     # Returns true if the object is under embargo.
     # @return [Boolean]
-    def embargoed?
+    def embargoed? # rubocop:disable Style/TrivialAccessors
       @embargoed
     end
 
@@ -57,7 +56,7 @@ module Dor
     alias_method :public_unrestricted?, :world_unrestricted?
 
     def readable?
-      public_unrestricted? || stanford_only_unrestricted? # TODO stanford_only or public with rule, figure out if this is still a legit method
+      public_unrestricted? || stanford_only_unrestricted? # TODO: stanford_only or public with rule, figure out if this is still a legit method
     end
 
     # Returns true if the object is stanford-only readable AND has no rule attribute
@@ -70,7 +69,7 @@ module Dor
     # @param [String] agent_name Name of the agent that wants to access this object
     # @return [Boolean]
     def agent_unrestricted?(agent_name)
-      return false unless @obj_lvl.agent.has_key? 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
 
@@ -82,7 +81,7 @@ module Dor
     # @param [String] file_name Name of the file that is tested for stanford_only rights
     # @return [Boolean]
     def stanford_only_unrestricted_file?(file_name)
-      return stanford_only_unrestricted? if( @file[file_name].nil? || @file[file_name].group[:stanford].nil? )
+      return stanford_only_unrestricted? if @file[file_name].nil? || @file[file_name].group[:stanford].nil?
 
       @file[file_name].group[:stanford].value && @file[file_name].group[:stanford].rule.nil?
     end
@@ -93,7 +92,7 @@ module Dor
     # @param [String] file_name Name of file that is tested for world rights
     # @return [Boolean]
     def world_unrestricted_file?(file_name)
-      return world_unrestricted? if( @file[file_name].nil? || @file[file_name].world.nil? )
+      return world_unrestricted? if @file[file_name].nil? || @file[file_name].world.nil?
 
       @file[file_name].world.value && @file[file_name].world.rule.nil?
     end
@@ -123,7 +122,7 @@ module Dor
     #   agent_exists, agent_rule = rights.agent_rights('someapp')
     # @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?)
+      return [false, nil] if @obj_lvl.agent[agent_name].nil?
       [@obj_lvl.agent[agent_name].value, @obj_lvl.agent[agent_name].rule]
     end
 
@@ -135,7 +134,7 @@ module Dor
     # @example Using multiple variable assignment to read both array elements
     #   world_exists, world_rule = rights.world_rights_for_file('somefile')
     def world_rights_for_file(file_name)
-      return world_rights if( @file[file_name].nil? || @file[file_name].world.nil? )
+      return world_rights if @file[file_name].nil? || @file[file_name].world.nil?
 
       [@file[file_name].world.value, @file[file_name].world.rule]
     end
@@ -148,7 +147,7 @@ module Dor
     # @example Using multiple variable assignment to read both array elements
     #   su_only_exists, su_only_rule = rights.stanford_only_rights_for_file('somefile')
     def stanford_only_rights_for_file(file_name)
-      return stanford_only_rights if( @file[file_name].nil? || @file[file_name].group[:stanford].nil?)
+      return stanford_only_rights if @file[file_name].nil? || @file[file_name].group[:stanford].nil?
 
       [@file[file_name].group[:stanford].value, @file[file_name].group[:stanford].rule]
     end
@@ -161,87 +160,81 @@ module Dor
     # @example Using multiple variable assignment to read both array elements
     #   agent_exists, agent_rule = rights.agent_rights_for_file('filex', 'someapp')
     def agent_rights_for_file(file_name, agent_name)
-      return agent_rights(agent_name) if( @file[file_name].nil?) # look at object level agent rights if the file-name is not stored
+      return agent_rights(agent_name) if @file[file_name].nil? # look at object level agent rights if the file-name is not stored
 
-      return [false, nil] if( @file[file_name].agent[agent_name].nil?) # file rules exist, but not for this agent
+      return [false, nil] if @file[file_name].agent[agent_name].nil? # file rules exist, but not for this agent
 
       [@file[file_name].agent[agent_name].value, @file[file_name].agent[agent_name].rule]
     end
 
     # Check formedness of rightsMetadata -- to be replaced with XSD once formalized, one fine day
-    # @param [Nokogiri::XML] the rightsMetadata document
+    # @param [Nokogiri::XML] doc the rightsMetadata document
     # @return [Array]        list of things that are wrong with it
-    def RightsAuth.validate_lite(doc)
-      if (doc.nil? || doc.at_xpath("//rightsMetadata").nil?)
-          return ["no_rightsMetadata"]
-      end
+    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)]")
 
       if maindiscover.nil?
-        errors.push "no_discover_access", "no_discover_machine"
-      elsif maindiscover.at_xpath("./machine").nil?
-        errors.push "no_discover_machine"
-      elsif (maindiscover.at_xpath("./machine/world[not(@rule)]").nil? && maindiscover.at_xpath("./machine/none").nil?)
-        errors.push "discover_machine_unrecognized"
+        errors.push 'no_discover_access', 'no_discover_machine'
+      elsif maindiscover.at_xpath('./machine').nil?
+        errors.push 'no_discover_machine'
+      elsif maindiscover.at_xpath('./machine/world[not(@rule)]').nil? && maindiscover.at_xpath('./machine/none').nil?
+        errors.push 'discover_machine_unrecognized'
       end
       if mainread.nil?
-        errors.push "no_read_access", "no_read_machine"
-      elsif mainread.at_xpath("./machine").nil?
-        errors.push "no_read_machine"
-      else
-        ## TODO: deeper read validation?
+        errors.push 'no_read_access', 'no_read_machine'
+      elsif mainread.at_xpath('./machine').nil?
+        errors.push 'no_read_machine'
+        # else
+        # TODO: deeper read validation?
       end
 
       errors
     end
 
     # Assemble various characterizing terms for index from XML
-    # @param [Nokogiri::XML] the rightsMetadata document
-    # @return [Array] Strings of interest to the Solr index
-    def RightsAuth.extract_index_terms(doc)
+    # @param [Nokogiri::XML] doc the rightsMetadata document
+    # @return [Array<String>] Strings of interest to the Solr index
+    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")
-      terms.push "world_discover" if doc.at_xpath("//rightsMetadata/access[@type='discover']/machine/world[not(@rule)]")
+      terms.push 'none_discover'  if doc.at_xpath("//rightsMetadata/access[@type='discover']/machine/none")
+      terms.push 'world_discover' if doc.at_xpath("//rightsMetadata/access[@type='discover']/machine/world[not(@rule)]")
       return terms if machine.nil?
 
-      terms.push "has_group_rights" if machine.at_xpath("./group")
-      terms.push "has_rule" if machine.at_xpath(".//@rule")
+      terms.push 'has_group_rights' if machine.at_xpath('./group')
+      terms.push 'has_rule' if machine.at_xpath('.//@rule')
 
-      if (machine.at_xpath("./group[not(@rule) and #{CONTAINS_STANFORD_XPATH}]"))
-        terms.push "group|stanford"
-      elsif (machine.at_xpath("./group[@rule and #{CONTAINS_STANFORD_XPATH}]"))
-        terms.push "group|stanford_with_rule"
-      elsif (machine.at_xpath("./group"))
-        terms.push "group|#{machine.at_xpath("./group").value.downcase}"
+      if machine.at_xpath("./group[#{CONTAINS_STANFORD_XPATH}]")
+        terms.push 'group|stanford'
+        terms.push 'group|stanford_with_rule' if machine.at_xpath("./group[@rule and #{CONTAINS_STANFORD_XPATH}]")
+      elsif machine.at_xpath('./group')
+        terms.push "group|#{machine.at_xpath('./group').value.downcase}"
       end
 
-      if (machine.at_xpath("./none"))
-        terms.push "none_read"
-      elsif (machine.at_xpath("./world[not(@rule)]"))
-        terms.push "world_read"
-      elsif (machine.at_xpath("./world/@rule"))
-        terms.push "world|#{machine.at_xpath("./world/@rule").value.downcase}"
+      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')
       end
 
       # now some statistical generation
-      names = machine.element_children.collect { |node| node.name }
-      kidcount = names.each_with_object(Hash.new(0)){ |word,counts| counts[word] += 1 }
-      countphrase = kidcount.sort.collect{|k,v| "#{k}#{v}"}.join("|")
-      terms.push "profile:" + countphrase unless countphrase.empty?
+      names = machine.element_children.collect(&:name)
+      kidcount = names.each_with_object(Hash.new(0)) { |word, counts| counts[word] += 1 }
+      countphrase = kidcount.sort.collect { |k, v| "#{k}#{v}" }.join('|')
+      terms.push 'profile:' + countphrase unless countphrase.empty?
 
       filemachines = doc.xpath("//rightsMetadata/access[@type='read' and file]/machine")
       unless filemachines.empty?
-        terms.push "has_file_rights", "file_rights_count|#{filemachines.count}"
+        terms.push 'has_file_rights', "file_rights_count|#{filemachines.count}"
         counts = Hash.new(0)
         filemachines.each { |filemachine|
-          filemachine.element_children.each { |node|
-            counts[node.name] += 1
-          }
+          filemachine.element_children.each { |node| counts[node.name] += 1 }
         }
-        counts.each { |k,v|
+        counts.each { |k, v|
           terms.push "file_has_#{k}", "file_rights_for_#{k}|#{v}"
         }
       end
@@ -250,14 +243,14 @@ module Dor
     end
 
     # Give the index what it needs
-    # @param [Nokogiri::XML] the rightsMetadata document
-    # @return [Hash] Strings of interest to the Solr index, including:
+    # @param [Nokogiri::XML] doc the rightsMetadata document
+    # @return [Hash{Symbol => Object}] Strings of interest to the Solr index, including:
     # {
     #   :primary => '...',   # string of foremost rights category, if determinable
     #   :errors  => [...],   # known error cases
     #   :terms   => [...]    # array of non-error characterizations and stats strings
     # }
-    def RightsAuth.extract_access_rights(doc)
+    def self.extract_access_rights(doc)
       errors = validate_lite(doc)
       stuff = {
         :primary => nil,
@@ -265,65 +258,55 @@ module Dor
         :terms   => []
       }
 
-      if (errors.include? "no_rightsMetadata")
+      if errors.include? 'no_rightsMetadata'
         stuff[:primary] = 'dark'
-        return stuff    # short circuit if no metadata -- no point going on
+        return stuff # short circuit if no metadata -- no point going on
       end
 
       stuff[:terms] = extract_index_terms(doc)
+      has_rule = stuff[:terms].include? 'has_rule'
 
-      if (stuff[:terms].include?("none_discover"))
+      if stuff[:terms].include?('none_discover')
         stuff[:primary] = 'dark'
-      elsif (errors.include?("no_discover_access") || errors.include?("no_discover_machine"))
+      elsif errors.include?('no_discover_access') || errors.include?('no_discover_machine')
         stuff[:primary] = 'dark'
-      elsif (errors.include?("no_read_machine") || stuff[:terms].include?("none_read"))
+      elsif errors.include?('no_read_machine') || stuff[:terms].include?('none_read')
         stuff[:primary] = 'citation'
-      elsif (stuff[:terms].include? "world_read")
-        stuff[:primary] = 'world'
-      elsif (stuff[:terms].include? "group|stanford")
-        stuff[:primary] = 'stanford'
-      elsif (stuff[:terms].include? "has_rule")
-        stuff[:primary] = 'complicated'
+      elsif stuff[:terms].include? 'world_read'
+        stuff[:primary] = has_rule ? 'world_qualified' : 'world'
+      elsif stuff[:terms].include? 'group|stanford'
+        stuff[:primary] = has_rule ? 'stanford_qualified' : 'stanford'
+      else # should never happen, but we might as well note it if it does
+        stuff[:primary] = has_rule ? 'UNKNOWN_qualified' : 'UNKNOWN'
       end
       stuff
     end
 
-
     # Create a Dor::RightsAuth object from xml
     # @param [String|Nokogiri::XML::Document] xml rightsMetadata xml that will be parsed to build a RightsAuth object
     # @param [Boolean] forindex, flag for requesting index_elements be parsed
     # @return [Dor::RightsAuth] object created after parsing rightsMetadata xml
-    def RightsAuth.parse(xml, forindex=false)
+    def self.parse(xml, forindex = false)
       rights = Dor::RightsAuth.new
       rights.obj_lvl = EntityRights.new
       rights.obj_lvl.world = Rights.new
 
       doc = xml.is_a?(Nokogiri::XML::Document) ? xml.clone : Nokogiri::XML(xml)
-      if(doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/world"))
+      if doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/world")
         rights.obj_lvl.world.value = true
         rule = doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/world/@rule")
-        rights.obj_lvl.world.rule = rule.value if(rule)
+        rights.obj_lvl.world.rule = rule.value if rule
       else
         rights.obj_lvl.world.value = false
       end
 
-      # TODO do we still need this??????
-      # if(doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]"))
-      #   rights[:readable] = true
-      # else
-      #   rights[:readable] = false
-      # end
-
-      rights.obj_lvl.group = { :stanford => Rights.new }
-
-      if (forindex)
-        rights.index_elements = extract_access_rights(doc)
-      end
+      rights.obj_lvl.group  = { :stanford => Rights.new }
+      rights.index_elements = extract_access_rights(doc) if forindex
 
-      if(doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/group[#{CONTAINS_STANFORD_XPATH}]"))
+      if doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/group[#{CONTAINS_STANFORD_XPATH}]")
         rights.obj_lvl.group[:stanford].value = true
         rule = doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/group[#{CONTAINS_STANFORD_XPATH}]/@rule")
-        rights.obj_lvl.group[:stanford].rule = rule.value if(rule)
+        rights.obj_lvl.group[:stanford].rule = rule.value if rule
       else
         rights.obj_lvl.group[:stanford].value = false
       end
@@ -339,9 +322,9 @@ module Dor
       # Initialze embargo_status to false
       rights.embargoed = false
       embargo_node = doc.at_xpath("//rightsMetadata/access[@type='read']/machine/embargoReleaseDate")
-      if(embargo_node)
+      if embargo_node
         embargo_dt = Time.parse(embargo_node.content)
-        rights.embargoed = true if(embargo_dt > Time.now)
+        rights.embargoed = true if embargo_dt > Time.now
       end
 
       access_with_files = doc.xpath("//rightsMetadata/access[@type='read' and file]")
@@ -351,21 +334,21 @@ module Dor
         if access_node.at_xpath("machine/group[#{CONTAINS_STANFORD_XPATH}]")
           stanford_access.value = true
           rule = access_node.at_xpath("machine/group[#{CONTAINS_STANFORD_XPATH}]/@rule")
-          stanford_access.rule = rule.value if (rule)
+          stanford_access.rule = rule.value if rule
         else
           stanford_access.value = false
         end
 
-        if access_node.at_xpath("machine/world")
+        if access_node.at_xpath('machine/world')
           world_access.value = true
-          rule = access_node.at_xpath("machine/world/@rule")
-          world_access.rule = rule.value if (rule)
+          rule = access_node.at_xpath('machine/world/@rule')
+          world_access.rule = rule.value if rule
         else
           world_access.value = false
         end
 
         file_agents = {}
-        access_node.xpath("machine/agent").each do |node|
+        access_node.xpath('machine/agent').each do |node|
           r = Rights.new
           r.value = true
           r.rule = node['rule']

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-rights-auth
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Willy Mene
+- Joe Atzberger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -69,10 +70,12 @@ dependencies:
 description: Parses rightsMetadata xml into a useable object
 email:
 - wmene@stanford.edu
+- atz@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/dor/rights/auth.rb
 - lib/dor/rights_auth.rb
 - lib/dor/xsd/druid.xsd
 - lib/dor/xsd/druidlist.xsd
@@ -100,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Parses rightsMetadata xml into a useable object