dor-rights-auth 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40f40de949255d9644bb67069e570735acfa4b5b
-  data.tar.gz: 7691335eecd9d5cf68b6fa70609c782c7114f566
+  metadata.gz: 81837a8bfa8d33081376601a6efeea90ecb80d3f
+  data.tar.gz: a2131d7af706414648f74399efc22cdda0f4cf27
 SHA512:
-  metadata.gz: f71d100e9c23464dc50014d8749589f8c69ca46137eb60cfb82cbf5b3caa9cad0c5b99130a5bad2133c5e45d735c54ff3b6203f092105ecf1335c8da6960a770
-  data.tar.gz: 9278835bc26a8774acfccc5e41f8cb9cfc58750832db255f84444e1f3180fa31fb0401775dab9f57ecbbead7ec1798b58eda873f694d98384b52f2123c2a44b7
+  metadata.gz: 1eddc3db3b13e12b7c20809622f28b4c088da471c08f2b0da4ea8a67e68583765c28cd3dd3a2c99f54b602af2e59a527d8875fd0649a0d4fd1c69c352f8745f3
+  data.tar.gz: 3adfce85f7b21e86f70d73f1eefce1c1f04968f50efb057d4f5bac18c3fe082126cb2f83e474fba1cdae90783256f9b96d19c84a31d691e70cc380d81b3c695c

data/lib/dor/rights_auth.rb

@@ -8,7 +8,7 @@ module Dor
   Rights = Struct.new(:value, :rule)
 
   # Rights for an object or File
-  EntityRights = Struct.new(:world, :group, :agent)
+  EntityRights = Struct.new(:world, :group, :agent, :location)
   # class EntityRights
   #   @world = #Rights
   #   @group {
@@ -28,9 +28,10 @@ module Dor
   #   }
   # end
 
+  # read rights_xml only once and create query-able methods for rights info
   class RightsAuth
 
-    CONTAINS_STANFORD_XPATH = "contains(translate(text(), 'STANFORD', 'stanford'), 'stanford')"
+    CONTAINS_STANFORD_XPATH = "contains(translate(text(), 'STANFORD', 'stanford'), 'stanford')".freeze
 
     attr_accessor :obj_lvl, :file, :embargoed, :index_elements
 
@@ -56,7 +57,8 @@ 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
+      # TODO: stanford_only or public with rule, figure out if this is still a legit method
+      public_unrestricted? || stanford_only_unrestricted?
     end
 
     # Returns true if the object is stanford-only readable AND has no rule attribute
@@ -115,6 +117,30 @@ module Dor
       [@obj_lvl.group[:stanford].value, @obj_lvl.group[:stanford].rule]
     end
 
+    # Returns whether an object-level location node exists for the passed in location, and the
+    #   value of its rule attribute
+    # @param [String] location_name name of the location that is tested for access
+    # @return (see #world_rights)
+    # @example Using multiple variable assignment to read both array elements
+    #   location_exists, location_rule = rights.location_rights('spec_coll_reading_room')
+    def location_rights(location_name)
+      return [false, nil] if @obj_lvl.location[location_name].nil?
+
+      [@obj_lvl.location[location_name].value, @obj_lvl.location[location_name].rule]
+    end
+
+    # Returns whether a given file has any location restrictions and falls back to
+    #  the object behavior in the absence of the file.
+    # @param [String] file_name name of the file being tested
+    # @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 || any_object_location
+    end
+
     # Returns whether an object-level agent node exists for the passed in agent, and the value of its rule attribute
     # @param [String] agent_name name of the app or thing that is tested for access
     # @return (see #world_rights)
@@ -152,6 +178,22 @@ module Dor
       [@file[file_name].group[:stanford].value, @file[file_name].group[:stanford].rule]
     end
 
+    # Returns whether a file-level location-node exists, and the value of its rule attribute
+    #    If a location-node does not exist for this file, then object-level location rights are returned
+    # @param [String] file_name name of the file being tested
+    # @param [String] location_name name of the location being tested
+    # @return (see #world_rights)
+    # @example Using multiple variable assignment to read both array elements
+    #   location_exists, location_rule = rightslocation_rights_for_file('filex', 'spec_coll_reading_room')
+    def location_rights_for_file(file_name, location_name)
+      file_rights = @file[file_name]
+      return location_rights(location_name) if file_rights.nil?
+
+      return [false, nil] if file_rights.location[location_name].nil?
+
+      [file_rights.location[location_name].value, file_rights.location[location_name].rule]
+    end
+
     # Returns whether a file-level agent-node exists, and the value of its rule attribute
     #    If an agent-node does not exist for this file, then object-level agent rights are returned
     # @param [String] file_name name of the file being tested
@@ -160,7 +202,8 @@ 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
+      # look at object level agent rights if the file-name is not stored
+      return agent_rights(agent_name) if @file[file_name].nil?
 
       return [false, nil] if @file[file_name].agent[agent_name].nil? # file rules exist, but not for this agent
 
@@ -303,14 +346,23 @@ module Dor
       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}]")
+      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
-        rule = doc.at_xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/group[#{CONTAINS_STANFORD_XPATH}]/@rule")
+        rule = doc.at_xpath("#{xpath}/@rule")
         rights.obj_lvl.group[:stanford].rule = rule.value if rule
       else
         rights.obj_lvl.group[:stanford].value = false
       end
 
+      rights.obj_lvl.location = {}
+      doc.xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/location").each do |node|
+        r = Rights.new
+        r.value = true
+        r.rule = node['rule']
+        rights.obj_lvl.location[node.content] = r
+      end
+
       rights.obj_lvl.agent = {}
       doc.xpath("//rightsMetadata/access[@type='read' and not(file)]/machine/agent").each do |node|
         r = Rights.new
@@ -347,6 +399,14 @@ module Dor
           world_access.value = false
         end
 
+        file_locations = {}
+        access_node.xpath('machine/location').each do |node|
+          r = Rights.new
+          r.value = true
+          r.rule = node['rule']
+          file_locations[node.content] = r
+        end
+
         file_agents = {}
         access_node.xpath('machine/agent').each do |node|
           r = Rights.new
@@ -360,6 +420,7 @@ module Dor
           file_rights.world = world_access
           file_rights.group = { :stanford => stanford_access }
           file_rights.agent = file_agents
+          file_rights.location = file_locations
 
           rights.file[f.content] = file_rights
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-rights-auth
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -53,6 +53,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.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: 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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Parses rightsMetadata xml into a useable object