ncs_navigator_configuration 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,10 +1,17 @@
 NCS Navigator Configuration gem history
 =======================================
 
+0.3.0
+-----
+
+- New optional study center attribute: short_name. (#10)
+- New optional attribute for Staff Portal and Core: mail_from. (#8)
+- New optional study center attribute: `exception_email_recipients`. (#9)
+
 0.2.0
 -----
 
-- New mandatory study center attribute: recruitment_type_id.
+- New mandatory study center attribute: `recruitment_type_id`.
 
 - Be more flexible about whitespace when parsing sampling unit CSV.
 

data/lib/ncs_navigator/configuration.rb

@@ -128,6 +128,8 @@ module NcsNavigator
             URI.parse(raw_value.to_s)
           when type == 'Boolean'
             raw_value.to_s.downcase.strip == 'true' ? true : false
+          when type == Array
+            coerce_to_string_array(raw_value)
           else
             fail "Do not know how to coerce to #{type} for #{name} from [#{section}]: #{key}"
           end
@@ -141,6 +143,10 @@ module NcsNavigator
             config.ini_filename.dirname + base
           end
         end
+
+        def coerce_to_string_array(raw_value)
+          raw_value.split(/\s*,\s*/)
+        end
       end
     end
 
@@ -172,6 +178,18 @@ module NcsNavigator
     configuration_attribute :recruitment_type_id, 'Study Center', 'recruitment_type_id', String,
       :required => true
 
+    ##
+    # A short, human-readable name or abbreviation for the Study
+    # Center.
+    configuration_attribute :study_center_short_name, 'Study Center', 'short_name', String,
+      :default => 'SC'
+
+    ##
+    # The e-mail addresses which will receive uncaught exceptions from
+    # any application in the suite.
+    configuration_attribute :exception_email_recipients, 'Study Center',
+      'exception_email_recipients', Array, :default => []
+
     ##
     # The name for the institutional identity used in this deployment
     # of NCS Navigator. For instance, for the Greater Chicago Study
@@ -211,11 +229,21 @@ module NcsNavigator
     # the suite.
     configuration_attribute :staff_portal_uri, 'Staff Portal', 'uri', URI, :required => true
 
+    ##
+    # The address from which mail sent by Staff Portal will appear to come.
+    configuration_attribute :staff_portal_mail_from, 'Staff Portal', 'mail_from', String,
+      :default => 'ops@navigator.example.edu'
+
     ##
     # The root URI for the NCS Navigator Core deployment in this instance of
     # the suite.
     configuration_attribute :core_uri, 'Core', 'uri', URI, :required => true
 
+    ##
+    # The address from which mail sent by Core will appear to come.
+    configuration_attribute :core_mail_from, 'Core', 'mail_from', String,
+      :default => 'cases@navigator.example.edu'
+
     ##
     # The root URI for the PSC deployment in this instance of
     # the suite.

data/lib/ncs_navigator/configuration/version.rb

@@ -1,5 +1,5 @@
 module NcsNavigator
   class Configuration
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/sample_configuration.ini

@@ -23,6 +23,10 @@ sc_id = "20000000"
 #  4 => Original VC
 recruitment_type_id = "3"
 
+# A short (5 chars or less) human-readable abbreviation for the study
+# center.
+short_name = 'MSC'
+
 # A pointer to a CSV describing the sampling units for this study
 # center.  If the path is not absolute it will be resolved relative to
 # this file.
@@ -72,7 +76,7 @@ Chicago, IL 60611"
 # The root URI for Staff Portal.
 uri = "https://staffportal.greaterchicagoncs.org/"
 
-# The e-mail address from which mail sent by Staff Pportal will
+# The e-mail address from which mail sent by Staff Portal will
 # appear to come.
 mail_from = "staffportal@greaterchicagoncs.org"
 
@@ -83,6 +87,10 @@ mail_from = "staffportal@greaterchicagoncs.org"
 # The root URI for NCS Navigator Core.
 uri = "https://ncsnavigator.greaterchicagoncs.org/"
 
+# The e-mail address from which mail sent by Core will
+# appear to come.
+mail_from = "ncs-navigator@greaterchicagoncs.org"
+
 [PSC]
 # Configuration options which describe PSC as used by this instance of
 # the suite. (For now, PSC's own configuration options must be set

data/spec/ncs_navigator/configuration_spec.rb

@@ -65,7 +65,7 @@ module NcsNavigator
           'uri' => 'https://sp.example.edu/'
         },
         'Core' => {
-          'uri' => 'https://ncsn.example.edu/'
+          'uri' => 'https://ncsn.example.edu/',
         },
         'PSC' => {
           'uri' => 'https://psc.example.edu/'
@@ -131,6 +131,17 @@ module NcsNavigator
       end
     end
 
+    describe '#study_center_short_name' do
+      it 'defaults to SC' do
+        from_hash.study_center_short_name.should == 'SC'
+      end
+
+      it 'reflects the configured value' do
+        input_hash['Study Center']['short_name'] = 'GCSC'
+        from_hash.study_center_short_name.should == 'GCSC'
+      end
+    end
+
     describe '#study_center_username' do
       it 'reflects the configured value' do
         everything.study_center_username.should == 'NetID'
@@ -141,6 +152,19 @@ module NcsNavigator
       end
     end
 
+    describe '#exception_email_recipients' do
+      it 'reflects the configured value' do
+        everything.exception_email_recipients.should == [
+          'Fred MacMurray <fred@pacificlife.net>',
+          'Barbara Stanwyck <b@aol.com>'
+        ]
+      end
+
+      it 'is optional' do
+        from_hash.exception_email_recipients.should be_empty
+      end
+    end
+
     describe '#sampling_units_file' do
       it 'reflects the configured value, absolutized, when read from an INI' do
         everything.sampling_units_file.to_s.should ==
@@ -362,6 +386,16 @@ module NcsNavigator
           everything.staff_portal['mail_from'].should == "staffportal@greaterchicagoncs.org"
         end
       end
+
+      describe '#staff_portal_mail_from' do
+        it 'is the configured value' do
+          everything.staff_portal_mail_from.should == 'staffportal@greaterchicagoncs.org'
+        end
+
+        it 'has a reasonable default' do
+          from_hash.staff_portal_mail_from.should == 'ops@navigator.example.edu'
+        end
+      end
     end
 
     describe 'Core parts' do
@@ -382,6 +416,16 @@ module NcsNavigator
           everything.core['uri'].should == "https://ncsnavigator.greaterchicagoncs.org/"
         end
       end
+
+      describe '#core_mail_from' do
+        it 'is the configured value' do
+          everything.core_mail_from.should == 'ncs-navigator@greaterchicagoncs.org'
+        end
+
+        it 'has a reasonable default' do
+          from_hash.core_mail_from.should == 'cases@navigator.example.edu'
+        end
+      end
     end
 
     describe 'PSC parts' do

data/spec/ncs_navigator/everything.ini

@@ -13,12 +13,15 @@ Northwestern University
 420 East Superior, 10th Floor
 Chicago, IL 60611"
 
+exception_email_recipients = Fred MacMurray <fred@pacificlife.net>, Barbara Stanwyck <b@aol.com>
+
 [Staff Portal]
 uri = "https://staffportal.greaterchicagoncs.org/"
 mail_from = "staffportal@greaterchicagoncs.org"
 
 [Core]
 uri = "https://ncsnavigator.greaterchicagoncs.org/"
+mail_from = "ncs-navigator@greaterchicagoncs.org"
 
 [PSC]
 uri = "https://calendar.greaterchicagoncs.org/"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ncs_navigator_configuration
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-17 00:00:00.000000000Z
+date: 2012-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ncs_mdes
-  requirement: &2153498680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2153498680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: inifile
-  requirement: &2153498160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *2153498160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: fastercsv
-  requirement: &2153497680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2153497680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153497000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2153497000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153487960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2153487960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2153487480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *2153487480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &2153486920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +117,15 @@ dependencies:
         version: 0.3.2
   type: :development
   prerelease: false
-  version_requirements: *2153486920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2153486340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +133,12 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *2153486340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: ! "\n    An internal component of the NCS Navigator suite, this gem provides
   a common view\n    onto shared configuration elements.\n  "
 email:
@@ -139,15 +179,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2522240099632272850
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2522240099632272850
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Common configuration elements for the NCS Navigator suite