epb_view_models 2.2.17 → 2.2.18

data/api/schemas/xml/CEPC-S-7.0/Reports/UserManagement.xsd

@@ -0,0 +1,171 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:pfdt="http://www.est.org.uk/epc/estcrV1/DCLG-HIP/BaseDataTypes" xmlns:HIP="http://www.est.org.uk/epc/estcrV1/DCLG-HIP" xmlns:SAP="http://www.est.org.uk/epc/estcrV1/DCLG-SAP09" targetNamespace="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" elementFormDefault="qualified" version="LIG-16.0">
+	<xs:annotation>
+		<xs:documentation>© Department of Communities and Local Government. © Crown copyright, 2007. The Home Condition Report logo and associated wording is a registered trade mark - any unlicensed use is not permitted. Copyright in the typographical arrangement of this document rests with the Crown. This publication, excluding logos, may be reproduced free of charge in any format or medium for research, private study, for internal circulation within an organisation or by registered scheme users. This is subject to it being reproduced accurately and not used in a misleading context.</xs:documentation>
+	</xs:annotation>
+	<xs:include schemaLocation="./BaseDataTypes.xsd"/>
+	<!--xs:include schemaLocation="./HCR-Domains.xsd"/-->
+	<!--<xs:include schemaLocation="../Templates/Property.xsd"/>-->
+	<xs:include schemaLocation="./Property.xsd"/>
+	<xs:element name="Energy-Assessor" type="Energy-Assessor"/>
+  <xs:complexType name="Energy-Assessor">
+    <xs:annotation>
+      <xs:documentation>
+        A Energy-Assessor is a person certified by a Accrediation Scheme as being qualified to carry out an Energy Assessment and produce an Energy Performance Certificate.
+      </xs:documentation>
+    </xs:annotation>
+    <xs:sequence>
+      <xs:element name="Membership-Number" type="xs:string" minOccurs="1" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The unique identifier assigned to the Energy Assessor by the Approved Organisation by which they can be identified throughout their membership of the scheme.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="Name" type="xs:string" minOccurs="1" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The name by which the Energy Assessor is registered. This is a structured name containing prefix, first name + surname.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="Approved-Organisation-Name" type="xs:string" minOccurs="1" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The name of the Approved Organisation that certified the Energy Assessor.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="Approved-Organisation-Web-Address" type="xs:string" minOccurs="1" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The web address of the Approved Organisation that certified the Energy Assessor.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="Trading-Address" type="xs:string" minOccurs="0" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The address that any written correspondence can be sent to. This is not the same as the Registered Address because it may, of course, be a Post Office Box.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="Company-Name" type="xs:string" minOccurs="0" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The Name of the Company that the Energy Assessor is empolyed by.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="Status" type="EAStatusCode" minOccurs="0" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The Status of the Energy Assessor - at the time of producing and lodging a report this shoudl be "Registered" but any of the values can be present on the  EA Register itself.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="E-Mail" type="xs:string" minOccurs="0" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>Optional e-mail address for the Energy Assessor</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="Telephone-Number" type="xs:string" minOccurs="0" maxOccurs="1"/>
+      <xs:element name="Base-Postcode-Location" type="PostcodeType" minOccurs="0" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>The full postcode that the Energy Assessor works from.</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:simpleType name="EAStatusCode">
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="Inactive">
+        <xs:annotation>
+          <xs:documentation>Inactive</xs:documentation>
+        </xs:annotation>
+      </xs:enumeration>
+      <xs:enumeration value="Registered">
+        <xs:annotation>
+          <xs:documentation>Registered</xs:documentation>
+        </xs:annotation>
+      </xs:enumeration>
+      <xs:enumeration value="Struck-Off">
+        <xs:annotation>
+          <xs:documentation>Struck Off</xs:documentation>
+        </xs:annotation>
+      </xs:enumeration>
+      <xs:enumeration value="Suspended">
+        <xs:annotation>
+          <xs:documentation>Suspended</xs:documentation>
+        </xs:annotation>
+      </xs:enumeration>
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="InspectorTypeCode">
+		<xs:restriction base="xs:string">
+			<xs:enumeration value="1">
+				<xs:annotation>
+					<xs:documentation>Home Inspector</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+			<xs:enumeration value="2">
+				<xs:annotation>
+					<xs:documentation>Domestic Energy Assessor</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+		</xs:restriction>
+	</xs:simpleType>
+	<xs:element name="Mortgage-Lender" type="Mortgage-Lender"/>
+	<xs:complexType name="Mortgage-Lender">
+		<xs:annotation>
+			<xs:documentation>A Mortgage Lender is an organisation that may lend money to the Buyer for the purpose of purchasing the Property.
+
+As part of this decision making the Mortgage Lender may use an Automated Valuation Model (AVM) to value the Property and requires access to the underlying data in the Home Condition Report or the content of the Energy Performance Certificate in order to complete this valuation.</xs:documentation>
+		</xs:annotation>
+		<xs:all/>
+	</xs:complexType>
+	<xs:simpleType name="Postcode-CoverageType">
+		<xs:restriction base="xs:string">
+			<xs:maxLength value="500"/>
+			<xs:pattern value="[A-Z]{1,2}[0-9]{0,2}(,[A-Z]{1,2}[0-9]{0,2})*"/>
+		</xs:restriction>
+	</xs:simpleType>
+	<xs:element name="Certification-Scheme" type="Certification-Scheme"/>
+	<xs:complexType name="Certification-Scheme">
+		<xs:annotation>
+			<xs:documentation>The Certification Scheme is the "regulatory" body responsible for regulating the activities of the Home Inspectors.
+
+A Certification Scheme will carry out certain primary functions in accordance with the standards, focussed around certifying, managing and regulating Home Inspectors and registering Home Condition Reports.
+
+Although covered by a different regulatory regime a Certification Scheme is synonymous with the role of an Accreditation Body in the production of an Energy Performance Certificate.</xs:documentation>
+		</xs:annotation>
+		<xs:all>
+			<xs:element name="Scheme-Name" type="xs:string"/>
+			<xs:element name="Complaints-Address" type="AddressType" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>The address to which any complaints should be sent.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="Contact-Address" type="AddressType" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>The address that any written correspondence can be sent to. This is not the same as the Registered Address because it may, of course, be a Post Office Box.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="Web-Site" type="xs:string"/>
+			<xs:element name="E-Mail" type="xs:string">
+				<xs:annotation>
+					<xs:documentation>the E-Mail address that the Authorised User can be contacted at.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="Registered-Name" type="xs:string">
+				<xs:annotation>
+					<xs:documentation>The public name by which the Authorised User is known by - this is either a personal name (e.g. "Mr John Smith") built up from the components of the Person Name if the Authorised User is an individual such as a Home Inspector or a Company Name if the Authorised User is an organisation.
+
+In the case of a individual the name may not be unique (e.g. there may be many thousands of people called "Mr John Smith") so this is information about the Authorised User rather than an identifier.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="Fax" type="PhoneNumberType"/>
+			<xs:element name="Telephone" type="PhoneNumberType"/>
+		</xs:all>
+	</xs:complexType>
+	<xs:element name="CertificationSchemeKeyFields" type="CertificationSchemeKeyFields"/>
+	<xs:complexType name="CertificationSchemeKeyFields">
+		<xs:annotation>
+			<xs:documentation>Key field definition for the Certification Scheme class.</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element name="Registered-Name" type="xs:string"/>
+		</xs:sequence>
+	</xs:complexType>
+	<xs:simpleType name="PhoneNumberType">
+		<xs:restriction base="xs:string">
+			<xs:pattern value="[0-9\-\.\)\(\+ ]+"/>
+		</xs:restriction>
+	</xs:simpleType>
+</xs:schema>

data/lib/epb_view_models.rb

@@ -5,7 +5,7 @@ loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.setup
 
 module EpbViewModels
-  VERSION = "2.2.17"
+  VERSION = "2.2.18"
 end
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast

data/lib/view_model/cepc_s_70/cepc.rb

@@ -0,0 +1,184 @@
+module ViewModel
+  module CepcS70
+    class Cepc < ViewModel::Cepc71::CommonSchema
+      def date_of_expiry
+        expires_at = (Date.parse(date_of_registration) - 1) >> 12 * 10
+
+        expires_at.to_s
+      end
+
+      def building_environment
+        xpath(%w[Building-Environment])
+      end
+
+      def energy_efficiency_rating
+        xpath(%w[Asset-Rating])&.to_i
+      end
+
+      def current_energy_efficiency_band
+        xpath(%w[Energy-Band])
+      end
+
+      def potential_energy_rating
+        xpath(%w[Potential-Rating])&.to_i
+      end
+
+      def potential_energy_band
+        xpath(%w[Potential-Band])
+      end
+
+      def new_build_benchmark_band
+        xpath(%w[New-Build-Benchmark-Band])
+      end
+
+      def comparative_asset_rating
+        xpath(%w[Comparative-Asset-Rating])&.to_i
+      end
+
+      def comparative_asset_band
+        xpath(%w[Comparative-Energy-Band])
+      end
+
+      def epc_rating_ber
+        xpath(%w[BER])&.to_f
+      end
+
+      def approximate_energy_use
+        xpath(%w[Approximate-Energry-Use])&.to_i
+      end
+
+      def floor_area
+        xpath(%w[Technical-Information Floor-Area])&.to_i
+      end
+
+      def main_heating_fuel
+        xpath(%w[Main-Heating-Fuel])
+      end
+
+      def property_type
+        xpath(%w[Property-Type Long-Description])
+      end
+
+      def property_long_description
+        xpath(%w[Property-Type Long-Description])
+      end
+
+      def property_short_description
+        xpath(%w[Property-Type Short-Description])
+      end
+
+      def compliant_2002
+        nil
+      end
+
+      def renewable_energy_sources
+        @xml_doc.search("Renewable-Energy-Sources").children.search("Renewable-Energy-Source").map(&:content)
+      end
+
+      def electricity_sources
+        @xml_doc.search("Electricity-Sources").children.search("Electricity-Source").map(&:content)
+      end
+
+      def primary_energy_indicator
+        xpath(%w[Primary-Energry-Indicator])&.to_i
+      end
+
+      def calculation_tool
+        xpath(%w[Calculation-Tool])
+      end
+
+      def ter_2002
+        nil
+      end
+
+      def ter
+        xpath(%w[TER])&.to_f
+      end
+
+      def recommendations(payback = "")
+        if payback.empty?
+          # return an enumerable of all nodes
+          @xml_doc.xpath "Recommendations-Report RR-Recommendations"
+        else
+          @xml_doc
+            .search("Recommendations-Report RR-Recommendations/#{payback}")
+            .map do |node|
+              {
+                code: node.at("Recommendation-Code").content,
+                text: node.at("Recommendation").content,
+                cO2Impact: node.at("CO2-Impact").content,
+              }
+          end
+        end
+      end
+
+      def short_payback_recommendations
+        recommendations("Short-Payback")
+      end
+
+      def medium_payback_recommendations
+        recommendations("Medium-Payback")
+      end
+
+      def long_payback_recommendations
+        recommendations("Long-Payback")
+      end
+
+      def other_payback_recommendations
+        recommendations("Other-Payback")
+      end
+
+      def related_rrn
+        nil
+      end
+
+      def new_build_rating
+        xpath(%w[New-Build-Benchmark])&.to_i
+      end
+
+      def existing_build_rating
+        nil
+      end
+
+      def epc_related_party_disclosure
+        nil
+      end
+
+      def trading_address
+        xpath(%w[Trading-Address])
+      end
+
+      def company_name
+        xpath(%w[Company-Name])
+      end
+
+      def insurer
+        xpath(%w[Insurer])
+      end
+
+      def policy_no
+        xpath(%w[Policy-No])
+      end
+
+      def insurer_effective_date
+        xpath(%w[Effective-Date])
+      end
+
+      def insurer_expiry_date
+        xpath(%w[Expiry-Date])
+      end
+
+      def insurer_pi_limit
+        xpath(%w[PI-Limit])
+      end
+
+      def inspection_date
+        xpath(%w[Inspection-Date])
+      end
+
+      def completion_date
+        xpath(%w[Completion-Date])
+      end
+    end
+  end
+end

data/lib/view_model/cepc_wrapper.rb

@@ -61,6 +61,8 @@ module ViewModel
         ViewModel::Cepc40::Cepc.new xml_doc
       when :"CEPC-3.1"
         ViewModel::Cepc31::Cepc.new xml_doc
+      when :"CEPC-S-7.0"
+        ViewModel::CepcS70::Cepc.new xml_doc
       when :"CEPC-S-7.1"
         ViewModel::CepcS71::Cepc.new xml_doc
       else

data/lib/view_model/factory.rb

@@ -18,6 +18,7 @@ module ViewModel
       CEPC-5.0
       CEPC-4.0
       CEPC-3.1
+      CEPC-S-7.0
       CEPC-S-7.1
     ].freeze
     TYPES_OF_RD_SAP = %i[

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epb_view_models
 version: !ruby/object:Gem::Version
-  version: 2.2.17
+  version: 2.2.18
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
@@ -161,6 +161,14 @@ files:
 - api/schemas/xml/CEPC-NI-8.0.0/Reports/Performance-Summary.xsd
 - api/schemas/xml/CEPC-NI-8.0.0/Reports/Report-Header.xsd
 - api/schemas/xml/CEPC-NI-8.0.0/Reports/Reported-Data.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/BaseDataTypes.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/CEPC-Reports.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/Input-Data.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/Performance-Summary.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/Property.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/Report-Header.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/Reported-Data.xsd
+- api/schemas/xml/CEPC-S-7.0/Reports/UserManagement.xsd
 - api/schemas/xml/CEPC-S-7.1/Reports/BaseDataTypes.xsd
 - api/schemas/xml/CEPC-S-7.1/Reports/CEPC-Reports.xsd
 - api/schemas/xml/CEPC-S-7.1/Reports/Input-Data.xsd
@@ -1712,6 +1720,7 @@ files:
 - lib/view_model/cepc_ni800/dec.rb
 - lib/view_model/cepc_ni800/dec_rr.rb
 - lib/view_model/cepc_rr_wrapper.rb
+- lib/view_model/cepc_s_70/cepc.rb
 - lib/view_model/cepc_s_71/cepc.rb
 - lib/view_model/cepc_wrapper.rb
 - lib/view_model/cs63/common_schema.rb