epb_view_models 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c27c16cc55405efe6e69cea4bf71ce33ce872ba8e141509e1fae0dbdad4bef05
+  data.tar.gz: 0c8d0416240f7dae7d8a5358464b4649ebfb6cf39790063aa582c2073b4c6c2b
+SHA512:
+  metadata.gz: 1d1c808d83169cf27e2f0d81b8577d49ef46e7f52bde4e1e35e9700a63d1dbb3a9dfa78f90320a5cb2a1d55a83d585a99d6b3362063572483f8028fb8051b1bd
+  data.tar.gz: a895e61754217f4f6361857c9cdf105cb441e7032f78053f6b6c865b372ab31cf9f9f4f283a91877ecb1e989a0c5146401b8d4d436f7bda2e61fe512380c98ed

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Jetbrains
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocop-govuk:
+    - config/default.yml
+    - config/rspec.yml
+
+inherit_mode:
+  merge:
+    - Exclude

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+ruby "~> 2.7"
+
+source "https://rubygems.org" do
+  group :test do
+    gem "rake", "~> 13.0.6"
+    gem "rspec", "~> 3.0"
+    gem "rubocop-govuk", "~> 4.0.0", require: false
+  end
+
+  gem "nokogiri", "~> 1.11"
+  gem "zeitwerk", "~> 2.4.2"
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+GEM
+  specs:
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.6.0)
+      parser (>= 3.0.1.1)
+    rubocop-rails (2.10.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    nokogiri (1.11.7-x86_64-darwin)
+      racc (~> 1.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rubocop-govuk (4.0.0)
+      rubocop (~> 1.15.0)
+      rubocop-ast (~> 1.6.0)
+      rubocop-rails (~> 2.10.0)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (~> 2.3.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  nokogiri (~> 1.11)!
+  rake (~> 13.0.6)!
+  rspec (~> 3.0)!
+  rubocop-govuk (~> 4.0.0)!
+  zeitwerk (~> 2.4.2)!
+
+RUBY VERSION
+   ruby 2.7.3p183
+
+BUNDLED WITH
+   2.2.21

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Ministry of Housing, Communities & Local Government
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,17 @@
+.DEFAULT_GOAL := help
+SHELL := /bin/bash
+
+.PHONY: help install test format
+
+help: ## Print help documentation
+	@echo -e "Makefile Help for epb-auth-tools"
+	@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+install: ## Install required libraries and setup
+	@bundle install
+
+test: ## Run all tests
+	@bundle exec rake spec
+
+format: ## Runs Rubocop with the GOV.UK rules
+	@bundle exec rake rubocop:auto_correct

data/README.md

@@ -0,0 +1,29 @@
+# EPB View Models
+
+This RubyGem provides a data model to read various Energy Performance Certificates (EPC) and abstract away historical
+version changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'epb_view_models'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem build epb_view_models.gemspec
+    $ gem install epb_view_models-<version>.gem  
+
+## Usage
+
+TODO: Write usage instructions here
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/api/schemas/data/orchestrate.json

@@ -0,0 +1,196 @@
+{
+  "SAP-Schema-17.1": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-17.1/SAP/Templates/SAP-Report.xsd"
+  },
+  "SAP-Schema-17.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-17.0/SAP/Templates/SAP-Report.xsd"
+  },
+  "SAP-Schema-16.3": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-16.3/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-16.2": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-16.2/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-16.1": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-16.1/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-16.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-16.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-15.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-15.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-14.2": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-14.2/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-14.1": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-14.1/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-14.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-14.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-13.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-13.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-12.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-12.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-11.2": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-11.2/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-11.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-11.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-10.2": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-10.2/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-17.4": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-17.4/SAP/Templates/SAP-Report.xsd"
+  },
+  "SAP-Schema-NI-17.3": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-17.3/SAP/Templates/SAP-Report.xsd"
+  },
+  "SAP-Schema-NI-17.2": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-17.2/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-17.1": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-17.1/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-17.0": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-17.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-16.1": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-16.1/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-16.0": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-16.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-15.0": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-15.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-14.2": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-14.2/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-14.1": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-14.1/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-14.0": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-14.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-13.0": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-13.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-12.0": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-12.0/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "SAP-Schema-NI-11.2": {
+    "schema_path":
+      "api/schemas/xml/SAP-Schema-NI-11.2/Messages/ConditionReportCreateRequest_1.xsd"
+  },
+  "RdSAP-Schema-20.0.0": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-20.0.0/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-NI-20.0.0": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-NI-20.0.0/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-19.0": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-19.0/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-NI-19.0": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-NI-19.0/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-18.0": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-18.0/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-NI-18.0": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-NI-18.0/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-NI-17.4": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-NI-17.4/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-NI-17.3": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-NI-17.4/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-17.1": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-17.1/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "RdSAP-Schema-17.0": {
+    "schema_path":
+    "api/schemas/xml/RdSAP-Schema-17.0/RdSAP/Templates/RdSAP-Report.xsd"
+  },
+  "SAP-Schema-18.0.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-18.0.0/SAP/Templates/SAP-Report.xsd"
+  },
+  "SAP-Schema-NI-18.0.0": {
+    "schema_path":
+    "api/schemas/xml/SAP-Schema-NI-18.0.0/SAP/Templates/SAP-Report.xsd"
+  },
+  "CEPC-8.0.0": {
+    "schema_path": "api/schemas/xml/CEPC-8.0.0/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-NI-8.0.0": {
+    "schema_path": "api/schemas/xml/CEPC-NI-8.0.0/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-7.1": {
+    "schema_path": "api/schemas/xml/CEPC-7.1/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-NI-7.1": {
+    "schema_path": "api/schemas/xml/CEPC-NI-7.1/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-7.0": {
+    "schema_path": "api/schemas/xml/CEPC-7.0/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-6.0": {
+    "schema_path": "api/schemas/xml/CEPC-6.0/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-5.1": {
+    "schema_path": "api/schemas/xml/CEPC-5.1/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-5.0": {
+    "schema_path": "api/schemas/xml/CEPC-5.0/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-4.0": {
+    "schema_path": "api/schemas/xml/CEPC-4.0/Reports/CEPC-Reports.xsd"
+  },
+  "CEPC-3.1": {
+    "schema_path": "api/schemas/xml/CEPC-3.1/Reports/CEPC-Reports.xsd"
+  }
+}

data/api/schemas/xml/CEPC-3.1/CommonFiles/CommonStructures.xsd

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- edited with XMLSpy v2005 sp1 U (http://www.xmlspy.com) by Mark Hunt (Landmark Information Group) -->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:CS="DCLG-CEPC/CommonStructures" targetNamespace="DCLG-CEPC/CommonStructures" elementFormDefault="qualified" attributeFormDefault="unqualified" version="LIG-CEPC-3.1">
+	<!-- ***************************************************************************
+	Simple Type declarations for Identification Block property values
+	 *************************************************************************** -->
+	<xs:simpleType name="ReportRetrievalType">
+		<xs:restriction base="xs:string">
+			<xs:enumeration value="List"/>
+			<xs:enumeration value="Data"/>
+			<xs:enumeration value="PDF"/>
+		</xs:restriction>
+	</xs:simpleType>
+	<xs:element name="MessageIdentifier" type="CS:MessageIdentifier"/>
+	<xs:complexType name="MessageIdentifier">
+		<xs:annotation>
+			<xs:documentation source="The standard Identifying Block for all messages."/>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element name="ClientID" type="xs:string" minOccurs="0"/>
+			<xs:element name="TransactionID" type="xs:string"/>
+			<xs:element name="Timestamp" type="xs:dateTime"/>
+		</xs:sequence>
+	</xs:complexType>
+</xs:schema>