ncs_navigator_configuration 0.3.2 → 0.4.0

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 NCS Navigator Configuration gem history
 =======================================
 
+0.4.0
+-----
+
+- New optional Core attribute: conflict_email_recipients.  (#12)
+
+- New optional Core attribute: machine_account_username.  (#14)
+
+- Make sc_id optional.  (#16)
+
+- Make sampling_units_file optional.  (#17)
+
+- Make recruitment_type_id optional.  (#18)
+
+- Make core uri optional.  (#19)
+
 0.3.2
 -----
 

data/lib/ncs_navigator/configuration.rb

@@ -166,8 +166,7 @@ module NcsNavigator
     # @macro [attach] configuration_attribute
     #   Read from the `[$2]` section, key `$3`.
     #   @return [$4]
-    configuration_attribute :study_center_id, 'Study Center', 'sc_id', String,
-      :required => true
+    configuration_attribute :study_center_id, 'Study Center', 'sc_id', String
 
     alias :sc_id :study_center_id
 
@@ -175,8 +174,7 @@ module NcsNavigator
     # The recruitment strategy for this study center. The acceptable
     # values are those from the code list `recruit_type_cl1` in the
     # MDES.
-    configuration_attribute :recruitment_type_id, 'Study Center', 'recruitment_type_id', String,
-      :required => true
+    configuration_attribute :recruitment_type_id, 'Study Center', 'recruitment_type_id', String
 
     ##
     # A short, human-readable name or abbreviation for the Study
@@ -203,8 +201,7 @@ module NcsNavigator
     #
     # The format is described in the comments in the
     # {file:sample_configuration.ini sample INI}.
-    configuration_attribute :sampling_units_file, 'Study Center', 'sampling_units_file', Pathname,
-      :required => true
+    configuration_attribute :sampling_units_file, 'Study Center', 'sampling_units_file', Pathname
 
     ##
     # The image that should appear on the left side of the footer in
@@ -237,10 +234,13 @@ module NcsNavigator
     ##
     # The root URI for the NCS Navigator Core deployment in this instance of
     # the suite.
-    configuration_attribute :core_uri, 'Core', 'uri', URI, :required => true
+    configuration_attribute :core_uri, 'Core', 'uri', URI
 
     ##
     # Machine account for Cases.
+    configuration_attribute :core_machine_account_username, 'Core',
+      'machine_account_username', String
+
     configuration_attribute :core_machine_account_password, 'Core',
       'machine_account_password', String
 
@@ -249,6 +249,11 @@ module NcsNavigator
     configuration_attribute :core_mail_from, 'Core', 'mail_from', String,
       :default => 'cases@navigator.example.edu'
 
+    ##
+    # When a merge conflict occurs in Cases, send emails to these addresses.
+    configuration_attribute :core_conflict_email_recipients, 'Core',
+      'conflict_email_recipients', Array, :default => []
+
     ##
     # The root URI for the PSC deployment in this instance of
     # the suite.
@@ -371,12 +376,13 @@ module NcsNavigator
       areas = {}
       ssus = {}
 
-      unless sampling_units_file.readable?
+      if sampling_units_file && !sampling_units_file.readable?
         raise Error.new("Could not read sampling units CSV #{sampling_units_file}")
       end
 
       strip_ws = lambda { |h| h.nil? ? nil : h.strip }
 
+      return [] unless sampling_units_file
       faster_csv_class.foreach(sampling_units_file,
         :headers => true, :encoding => 'utf-8',
         :converters => [strip_ws], :header_converters => [strip_ws]

data/lib/ncs_navigator/configuration/version.rb

@@ -1,5 +1,5 @@
 module NcsNavigator
   class Configuration
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
   end
 end

data/sample_configuration.ini

@@ -91,6 +91,13 @@ uri = "https://ncsnavigator.greaterchicagoncs.org/"
 # appear to come.
 mail_from = "ncs-navigator@greaterchicagoncs.org"
 
+# The password used by Cases to log into other NCS-related applications.
+machine_account_password = "supersecret"
+
+# If a merge conflict is detected in Cases, emails will be sent to these
+# addresses.  Separate multiple addresses with commas.
+conflict_email_recipients = "Foo Example <foo@example.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

@@ -54,6 +54,7 @@ module NcsNavigator
     let(:everything_file) { File.expand_path('../everything.ini', __FILE__) }
 
     # input_hash should be kept minimally valid
+    # ToDo: update minimally valid input_hash with required fields only.
     let(:input_hash) {
       {
         'Study Center' => {
@@ -64,15 +65,24 @@ module NcsNavigator
         'Staff Portal' => {
           'uri' => 'https://sp.example.edu/'
         },
-        'Core' => {
-          'uri' => 'https://ncsn.example.edu/',
-        },
         'PSC' => {
           'uri' => 'https://psc.example.edu/'
         }
       }
     }
     let(:from_hash) { Configuration.new(input_hash) }
+    let(:minimum_valid_hash) {
+      {
+        'Staff Portal' => {
+          'uri' => 'https://sp.example.edu/'
+        },
+        'PSC' => {
+          'uri' => 'https://psc.example.edu/'
+        }
+      }
+    }
+    let(:from_minimum_valid_hash) { Configuration.new(minimum_valid_hash) }
+
 
     describe '#initialize' do
       describe 'from an INI file' do
@@ -107,16 +117,15 @@ module NcsNavigator
         from_hash.study_center_id.should == '234'
       end
 
-      it 'is mandatory' do
-        input_hash['Study Center'].delete 'sc_id'
-        lambda { from_hash }.
-          should raise_error("Please set a value for [Study Center]: sc_id")
+      it 'is not mandatory' do
+        lambda { from_minimum_valid_hash }.
+          should_not raise_error
       end
     end
 
     describe '#recruitment_type_id' do
       it 'reflects the configured value' do
-        from_hash.recruitment_type_id.should == '3'
+        everything.recruitment_type_id.should == '1'
       end
 
       it 'is always a string' do
@@ -124,10 +133,9 @@ module NcsNavigator
         from_hash.recruitment_type_id.should == '234'
       end
 
-      it 'is mandatory' do
-        input_hash['Study Center'].delete 'recruitment_type_id'
-        lambda { from_hash }.
-          should raise_error("Please set a value for [Study Center]: recruitment_type_id")
+      it 'is not mandatory' do
+        lambda { from_minimum_valid_hash }.
+          should_not raise_error
       end
     end
 
@@ -179,63 +187,53 @@ module NcsNavigator
         everything.sampling_units_file.should be_a(Pathname)
       end
 
-      it 'is required' do
-        input_hash['Study Center'].delete 'sampling_units_file'
-        lambda { from_hash }.
-          should raise_error "Please set a value for [Study Center]: sampling_units_file"
+      it 'is not required' do
+        lambda { from_minimum_valid_hash }.
+          should_not raise_error
       end
     end
 
     describe '#sampling_unit_areas' do
-      subject { everything.sampling_unit_areas }
-
-      it 'has the right number' do
-        subject.size.should == 2
+      describe 'when no sampling_unit_file' do
+        it 'is an empty array' do
+          from_minimum_valid_hash.sampling_unit_areas.should be_empty
+        end
       end
 
-      describe 'an individual area' do
-        let(:area) { subject.sort_by { |a| a.name }.last }
+      describe 'when sampling_units_file is present' do
+        subject { everything.sampling_unit_areas }
 
-        it 'has a name' do
-          area.name.should == 'Uptown'
+        it 'has the right number' do
+          subject.size.should == 2
         end
 
-        it 'has the right number of SSUs' do
-          area.secondary_sampling_units.size.should == 2
-        end
+        describe 'an individual area' do
+          let(:area) { subject.sort_by { |a| a.name }.last }
+
+          it 'has a name' do
+            area.name.should == 'Uptown'
+          end
 
-        it 'has the right PSU' do
-          area.primary_sampling_unit.id.should == '204'
+          it 'has the right number of SSUs' do
+            area.secondary_sampling_units.size.should == 2
+          end
+
+          it 'has the right PSU' do
+            area.primary_sampling_unit.id.should == '204'
+          end
         end
       end
     end
 
     describe '#primary_sampling_units' do
-      subject { everything.primary_sampling_units }
-
-      it 'has the right number' do
-        subject.size.should == 1
-      end
-
-      describe 'an individual PSU' do
-        let(:psu) { subject.first }
-
-        it 'has the correct ID' do
-          psu.id.should == '204'
-        end
-
-        it 'has the correct SSUs' do
-          psu.secondary_sampling_units.collect(&:id).should == %w(One Two Three)
+      describe 'when no sampling_unit_file' do
+        it 'is an empty array' do
+          from_minimum_valid_hash.primary_sampling_units.should be_empty
         end
       end
 
-      context 'without Areas and SSUs' do
-        before do
-          input_hash['Study Center']['sampling_units_file'] =
-            File.expand_path('../no_ssus.csv', __FILE__)
-        end
-
-        subject { from_hash.primary_sampling_units }
+      describe 'when sampling_units_file is present' do
+        subject { everything.primary_sampling_units }
 
         it 'has the right number' do
           subject.size.should == 1
@@ -248,102 +246,135 @@ module NcsNavigator
             psu.id.should == '204'
           end
 
-          it 'has no Areas' do
-            psu.should have(0).sampling_unit_areas
+          it 'has the correct SSUs' do
+            psu.secondary_sampling_units.collect(&:id).should == %w(One Two Three)
+          end
+        end
+
+        context 'without Areas and SSUs' do
+          before do
+            input_hash['Study Center']['sampling_units_file'] =
+              File.expand_path('../no_ssus.csv', __FILE__)
+          end
+
+          subject { from_hash.primary_sampling_units }
+
+          it 'has the right number' do
+            subject.size.should == 1
           end
 
-          it 'has no SSUs' do
-            psu.should have(0).secondary_sampling_units
+          describe 'an individual PSU' do
+            let(:psu) { subject.first }
+
+            it 'has the correct ID' do
+              psu.id.should == '204'
+            end
+
+            it 'has no Areas' do
+              psu.should have(0).sampling_unit_areas
+            end
+
+            it 'has no SSUs' do
+              psu.should have(0).secondary_sampling_units
+            end
           end
         end
       end
     end
 
     describe '#secondary_sampling_units' do
-      subject { everything.secondary_sampling_units }
-
-      it 'has the right number' do
-        subject.size.should == 3
+      describe 'when no sampling_unit_file' do
+        it 'is an empty array' do
+          from_minimum_valid_hash.secondary_sampling_units.should be_empty
+        end
       end
 
-      describe 'an individual SSU' do
-        let(:ssu) { subject.sort_by { |ssu| ssu.id }.first }
+      describe 'when sampling_units_file is present' do
+        subject { everything.secondary_sampling_units }
 
-        it 'has the correct ID' do
-          ssu.id.should == 'One'
+        it 'has the right number' do
+          subject.size.should == 3
         end
 
-        it 'has the correct name' do
-          ssu.name.should == 'West Side'
-        end
+        describe 'an individual SSU' do
+          let(:ssu) { subject.sort_by { |ssu| ssu.id }.first }
 
-        it 'has the correct area' do
-          ssu.area.name.should == 'Uptown'
-        end
+          it 'has the correct ID' do
+            ssu.id.should == 'One'
+          end
 
-        it 'has the same area as another SSU in the same area' do
-          ssu.area.should eql(subject.find { |ssu| ssu.name == 'West Side' }.area)
-        end
+          it 'has the correct name' do
+            ssu.name.should == 'West Side'
+          end
 
-        it 'has the correct PSU' do
-          ssu.primary_sampling_unit.id.should == '204'
-        end
+          it 'has the correct area' do
+            ssu.area.name.should == 'Uptown'
+          end
 
-        it 'has the correct TSUs' do
-          ssu.should have(1).tertiary_sampling_units
-        end
+          it 'has the same area as another SSU in the same area' do
+            ssu.area.should eql(subject.find { |ssu| ssu.name == 'West Side' }.area)
+          end
 
-        describe 'a TSU' do
-          let(:tsu) { ssu.tertiary_sampling_units.first }
+          it 'has the correct PSU' do
+            ssu.primary_sampling_unit.id.should == '204'
+          end
 
-          it 'has a name' do
-            tsu.name.should == 'Center'
+          it 'has the correct TSUs' do
+            ssu.should have(1).tertiary_sampling_units
           end
 
-          it 'has an ID' do
-            tsu.id.should == '1-1'
+          describe 'a TSU' do
+            let(:tsu) { ssu.tertiary_sampling_units.first }
+
+            it 'has a name' do
+              tsu.name.should == 'Center'
+            end
+
+            it 'has an ID' do
+              tsu.id.should == '1-1'
+            end
           end
         end
-      end
 
-      context 'without TSUs' do
-        before do
-          input_hash['Study Center']['sampling_units_file'] =
-            File.expand_path('../no_tsus.csv', __FILE__)
-        end
+        context 'without TSUs' do
+          before do
+            input_hash['Study Center']['sampling_units_file'] =
+              File.expand_path('../no_tsus.csv', __FILE__)
+          end
 
-        subject { from_hash.secondary_sampling_units }
+          subject { from_hash.secondary_sampling_units }
 
-        it 'has the right number' do
-          subject.size.should == 3
-        end
+          it 'has the right number' do
+            subject.size.should == 3
+          end
 
-        describe 'an individual SSU' do
-          let(:ssu) { subject.first }
+          describe 'an individual SSU' do
+            let(:ssu) { subject.first }
 
-          it 'has no TSUs' do
-            ssu.should have(0).tertiary_sampling_units
+            it 'has no TSUs' do
+              ssu.should have(0).tertiary_sampling_units
+            end
           end
         end
-      end
 
-      context 'with extra whitespace' do
-        before do
-          input_hash['Study Center']['sampling_units_file'] =
-            File.expand_path('../spaces.csv', __FILE__)
-        end
+        context 'with extra whitespace' do
+          before do
+            input_hash['Study Center']['sampling_units_file'] =
+              File.expand_path('../spaces.csv', __FILE__)
+          end
 
-        subject { from_hash.secondary_sampling_units }
+          subject { from_hash.secondary_sampling_units }
 
-        it 'has the right number' do
-          subject.size.should == 3
-        end
+          it 'has the right number' do
+            subject.size.should == 3
+          end
 
-        describe 'an individual SSU' do
-          let(:ssu) { subject.detect { |s| s.id == 'One' } }
+          describe 'an individual SSU' do
+            let(:ssu) { subject.detect { |s| s.id == 'One' } }
 
-          it 'has the name' do
-            ssu.name.should == 'West Side'
+            it 'has the name' do
+              ssu.name.should == 'West Side'
+            end
           end
         end
       end
@@ -440,12 +471,27 @@ module NcsNavigator
         end
       end
 
+      describe '#core_machine_account_username' do
+        it 'is the configured value' do
+          everything.core_machine_account_username.should == 'ncs_navigator_cases_foobar'
+        end
+      end
+
       describe '#core_machine_account_password' do
         it 'is the configured value' do
           everything.core_machine_account_password.should == 'foobar'
         end
       end
 
+      describe '#core_conflict_email_recipients' do
+        it 'is the configured value' do
+          everything.core_conflict_email_recipients.should == [
+            'Foo Bar <foobar@example.edu>',
+            'Baz Quux <bazquux@example.edu>'
+          ]
+        end
+      end
+
       describe '#core' do
         it 'exposes all the raw values in the Staff Portal section' do
           everything.core['uri'].should == "https://ncsnavigator.greaterchicagoncs.org/"

data/spec/ncs_navigator/everything.ini

@@ -22,7 +22,9 @@ mail_from = "staffportal@greaterchicagoncs.org"
 [Core]
 uri = "https://ncsnavigator.greaterchicagoncs.org/"
 mail_from = "ncs-navigator@greaterchicagoncs.org"
+machine_account_username = "ncs_navigator_cases_foobar"
 machine_account_password = "foobar"
+conflict_email_recipients="Foo Bar <foobar@example.edu>, Baz Quux <bazquux@example.edu>"
 
 [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.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ncs_mdes
@@ -182,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1883261299905752357
+      hash: 4406372814249112619
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,10 +191,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1883261299905752357
+      hash: 4406372814249112619
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Common configuration elements for the NCS Navigator suite