keycard 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11ebd7d6befe9108e42fc03665fad56c487e24d7ae043a3c75ebee3a065cb3da
-  data.tar.gz: 3ef4f849ece815de42e85cafe7ce1173493753716ea7cfb481ef41cab7429cad
+  metadata.gz: 289f06e8e7d3002eba8c6aa13bedf6be9fd2cd643f2923ce8cb5185aeaec6fda
+  data.tar.gz: 885e1c86b158ff4778764ea0d2a5ee6bd18ff133e811af47032b42b7a56f0e24
 SHA512:
-  metadata.gz: 84c21531e967ff071a7655df6eefe68691609e08bee68b86c1984d85dce0e5bdf615b57fd6668d406dd91d5a5422d86de04582c1b90088a145da44b6a1d78eb6
-  data.tar.gz: fa8d79a2976c0400cb34407237ce9311f5c01556357a021ecf200587d3bb6003a850b9f1addba939bf0578ad7cad19b6cf38bc5c37f0aef0238a8691a4b9208a
+  metadata.gz: 1c510e8be9b90985c08d54c07489368b14911c28d595abe51748acea4ec9f2b5914a06c3425d97afc7e9eeae18c8a7a02b1ca8a3850bc0795f88fb897918b384
+  data.tar.gz: d60d7e51da879687dd570c26382947a619f9978309de7cb797bde095e11043e71c28783e85847f22c12beff652b685db8b0dcdeb55b715197ea502fb0f6c7d4f

data/keycard.gemspec

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)

data/lib/keycard/request/attributes.rb

@@ -88,6 +88,38 @@ module Keycard::Request
 
     private
 
+    # Retrieve the value from the request's environment for a given key.
+    #
+    # This will trim whitespace and yield nil for empty values or those with
+    # the special value of '(null)'. Use {#safe} if you always want a string.
+    #
+    # @return [String|nil] value for the key, filtered and trimmed to nil
+    def get(key)
+      scrub request.env[key]
+    end
+
+    # Retrieve a guaranteed string value from the request's environment for a
+    # given key.
+    #
+    # This has the same behavior as {#get}, except that it will coalesce
+    # missing values to an empty string, convenient if you need to do string
+    # operations like splitting the value.
+    def safe(key)
+      get(key) || ''
+    end
+
+    # Scrub a value to remove whitespace, filter the special '(null)' value,
+    # and translate resulting empty strings to nil.
+    def scrub(value)
+      str = (value || '').strip
+      case str
+      when nil, '(null)', ''
+        nil
+      else
+        str
+      end
+    end
+
     attr_reader :finders
     attr_reader :request
   end

data/lib/keycard/request/cosign_attributes.rb

@@ -15,7 +15,7 @@ module Keycard::Request
     end
 
     def user_pid
-      request.env['HTTP_X_REMOTE_USER']
+      get 'HTTP_X_REMOTE_USER'
     end
 
     def user_eid
@@ -23,7 +23,7 @@ module Keycard::Request
     end
 
     def client_ip
-      (request.env['HTTP_X_FORWARDED_FOR'] || '').split(',').first
+      safe('HTTP_X_FORWARDED_FOR').split(',').first
     end
   end
 end

data/lib/keycard/request/direct_attributes.rb

@@ -14,7 +14,7 @@ module Keycard::Request
     end
 
     def user_pid
-      request.env['REMOTE_USER']
+      get 'REMOTE_USER'
     end
 
     def user_eid
@@ -22,7 +22,7 @@ module Keycard::Request
     end
 
     def client_ip
-      (request.env['REMOTE_ADDR'] || '').split(',').first
+      safe('REMOTE_ADDR').split(',').first
     end
   end
 end

data/lib/keycard/request/proxied_attributes.rb

@@ -18,7 +18,7 @@ module Keycard::Request
     end
 
     def user_pid
-      request.env['HTTP_X_REMOTE_USER']
+      get 'HTTP_X_REMOTE_USER'
     end
 
     def user_eid
@@ -26,7 +26,7 @@ module Keycard::Request
     end
 
     def client_ip
-      (request.env['HTTP_X_FORWARDED_FOR'] || '').split(',').first
+      safe('HTTP_X_FORWARDED_FOR').split(',').first
     end
   end
 end

data/lib/keycard/request/shibboleth_attributes.rb

@@ -72,15 +72,5 @@ module Keycard::Request
     def identity_keys
       %i[user_pid user_eid eduPersonScopedAffiliation]
     end
-
-    private
-
-    def get(key)
-      request.env[key]
-    end
-
-    def safe(key)
-      get(key) || ''
-    end
   end
 end

data/lib/keycard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Keycard
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keycard
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Noah Botimer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel