govuk_content_models 28.0.1 → 28.1.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 28.1.0
+
+- Add a `Downtime` model to represent downtime for an artefact.
+
 ## 28.0.1
 
 - Skip LinkValidator for archived editions.

data/app/models/downtime.rb

@@ -0,0 +1,32 @@
+class Downtime
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :message, type: String
+  field :start_time, type: DateTime
+  field :end_time, type: DateTime
+
+  belongs_to :artefact
+
+  validates_presence_of :message, :start_time, :end_time, :artefact
+  validate :end_time_is_in_future, on: :create
+  validate :start_time_precedes_end_time
+
+  def self.for(artefact)
+    where(artefact_id: artefact.id).first
+  end
+
+  def publicise?
+    Time.zone.now.between?(start_time.to_date - 1, end_time) # starting at midnight a day before start time
+  end
+
+  private
+
+  def end_time_is_in_future
+    errors.add(:end_time, "must be in the future") if end_time && ! end_time.future?
+  end
+
+  def start_time_precedes_end_time
+    errors.add(:start_time, "must be earlier than end time") if start_time && end_time && start_time >= end_time
+  end
+end

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -19,6 +19,13 @@ FactoryGirl.define do
     disabled true
   end
 
+  factory :downtime do
+    message "This service will be unavailable from 3pm to 6pm tomorrow"
+    start_time (Date.today + 1).to_time + (15 * 60 * 60)
+    end_time (Date.today + 1).to_time + (18 * 60 * 60)
+    artefact
+  end
+
   factory :tag do
     sequence(:tag_id) { |n| "crime-and-justice-#{n}" }
     sequence(:title) { |n| "The title #{n}" }

data/lib/govuk_content_models/version.rb

@@ -1,4 +1,4 @@
 module GovukContentModels
   # Changing this causes Jenkins to tag and release the gem into the wild
-  VERSION = "28.0.1"
+  VERSION = "28.1.0"
 end

data/test/models/downtime_test.rb

@@ -0,0 +1,92 @@
+require "test_helper"
+
+class DowntimeTest < ActiveSupport::TestCase
+  context "validations" do
+    should "validate presence of message" do
+      downtime = FactoryGirl.build(:downtime, message: nil)
+
+      refute downtime.valid?
+      assert_includes downtime.errors[:message], "can't be blank"
+    end
+
+    should "validate presence of start time" do
+      downtime = FactoryGirl.build(:downtime, start_time: nil)
+
+      refute downtime.valid?
+      assert_includes downtime.errors[:start_time], "can't be blank"
+    end
+
+    should "validate presence of end time" do
+      downtime = FactoryGirl.build(:downtime, end_time: nil)
+
+      refute downtime.valid?
+      assert_includes downtime.errors[:end_time], "can't be blank"
+    end
+
+    should "validate presence of artefact" do
+      downtime = FactoryGirl.build(:downtime, artefact: nil)
+
+      refute downtime.valid?
+      assert_includes downtime.errors[:artefact], "can't be blank"
+    end
+
+    should "validate end time is in future" do
+      downtime = FactoryGirl.build(:downtime, end_time: Date.today - 1)
+
+      refute downtime.valid?
+      assert_includes downtime.errors[:end_time], 'must be in the future'
+    end
+
+    should "validate end time is in future only on create" do
+      downtime = FactoryGirl.create(:downtime)
+      downtime.assign_attributes(start_time: Date.today - 3, end_time: Date.today - 1)
+
+      assert downtime.valid?
+    end
+
+    should "validate start time is earlier than end time" do
+      downtime = FactoryGirl.build(:downtime, start_time: Date.today + 2, end_time: Date.today + 1)
+
+      refute downtime.valid?
+      assert_includes downtime.errors[:start_time], "must be earlier than end time"
+    end
+  end
+
+  context "for an artefact" do
+    should "be returned if found" do
+      downtime = FactoryGirl.create(:downtime)
+      assert_equal downtime, Downtime.for(downtime.artefact)
+    end
+
+    should "be nil if not found" do
+      assert_nil Downtime.for(FactoryGirl.build(:artefact))
+    end
+  end
+
+  context "publicising downtime" do
+    should "start at midnight a day before it is scheduled" do
+      Timecop.freeze(Date.today) do # beginnning of today
+        downtime = FactoryGirl.build(:downtime)
+
+        downtime.start_time = (Date.today + 1).to_time + (3 * 60 * 60) # 3am tomorrow
+        assert downtime.publicise?
+
+        downtime.start_time = Date.today.to_time + (21 * 60 * 60) # 9pm today
+        assert downtime.publicise?
+
+        downtime.start_time = Date.today + 2 # day after tomorrow
+        refute downtime.publicise?
+      end
+    end
+
+    should "stop after scheduled end time" do
+      Timecop.freeze(Time.zone.now + 10) do
+        downtime = FactoryGirl.build(:downtime)
+
+        downtime.end_time = Time.zone.now
+        refute downtime.publicise?
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 28.0.1
+  version: 28.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -347,6 +347,7 @@ files:
 - app/models/campaign_edition.rb
 - app/models/completed_transaction_edition.rb
 - app/models/curated_list.rb
+- app/models/downtime.rb
 - app/models/edition.rb
 - app/models/guide_edition.rb
 - app/models/help_page_edition.rb
@@ -429,6 +430,7 @@ files:
 - test/models/business_support_edition_test.rb
 - test/models/campaign_edition_test.rb
 - test/models/curated_list_test.rb
+- test/models/downtime_test.rb
 - test/models/edition_scheduled_for_publishing_test.rb
 - test/models/edition_test.rb
 - test/models/help_page_edition_test.rb
@@ -475,7 +477,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1044253096296526038
+      hash: 1243140103051612447
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -484,7 +486,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1044253096296526038
+      hash: 1243140103051612447
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -510,6 +512,7 @@ test_files:
 - test/models/business_support_edition_test.rb
 - test/models/campaign_edition_test.rb
 - test/models/curated_list_test.rb
+- test/models/downtime_test.rb
 - test/models/edition_scheduled_for_publishing_test.rb
 - test/models/edition_test.rb
 - test/models/help_page_edition_test.rb