Initial commit

Author: marcransome

.gitignore

@@ -0,0 +1,22 @@
+appconfig.local.yml.setup
+concordion/.idea
+concordion/*.iml
+concordion/lib/*
+concordion/*.log
+concordion/*.log.????-??-??
+concordion/result/*
+concordion/target/*
+.cpanm/
+.DS_Store
+extlib/
+.gopancache
+hypnotoad.pid
+local/
+*.local.yml
+log
+*.log
+npm-debug.log
+*.swp
+*.tmp
+t/output.xml
+ch.gov.uk-*.zip

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "api-enumerations"]
+	path = api-enumerations
+	url = [email protected]:companieshouse/api-enumerations.git

.perl-version

@@ -0,0 +1 @@
+5.18.2

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Crown Copyright (Companies House)
+
+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.

Makefile

@@ -0,0 +1,66 @@
+LOCAL           ?= ./local
+
+SMARTPAN_URL    ?= http://darkpan.ch.gov.uk:7050
+
+GETPAN_CPUS     ?= -cpus 1 # Setting to null enables getpan to use all cores
+GETPAN_LOGLEVEL ?= INFO
+GETPAN_CACHEDIR ?= ./.gopancache
+GETPAN_ARGS     ?= $(GETPAN_CPUS) -cachedir=$(GETPAN_CACHEDIR) -smart $(SMARTPAN_URL) -loglevel=$(GETPAN_LOGLEVEL) -nodepdump -nocpan -nobackpan -metacpan
+
+CHS_ENV_HOME?=$(HOME)/.chs_env
+CHS_ENVS=$(CHS_ENV_HOME)/global_env $(CHS_ENV_HOME)/ch.gov.uk/env
+SOURCE_ENV=for chs_env in $(CHS_ENVS); do test -f $$chs_env && . $$chs_env; done
+
+PROVE_CMD       ?= $(LOCAL)/bin/prove
+PROVE_ARGS      ?= -It/lib -Ilib -I$(LOCAL)/lib/perl5 -lr
+
+TEST_UNIT_ENV   ?= COOKIE_SECRET=abcdef123456 URL_SIGNING_SALT=abcdef123456
+
+all: dist
+
+submodules: api-enumerations/.git
+
+api-enumerations/.git:
+	git submodule init
+	git submodule update
+
+getpan:
+	getpan $(GETPAN_ARGS)
+
+clean:
+	rm -rf $(LOCAL)
+	rm -rf $(GETPAN_CACHEDIR)
+
+test-unit:
+	$(TEST_UNIT_ENV) $(PROVE_CMD) $(PROVE_ARGS) t/unit
+
+test-int:
+	$(SOURCE_ENV); $(PROVE_CMD) $(PROVE_ARGS) t/integration
+
+test: test-unit test-int
+
+build: submodules getpan
+
+package:
+	$(eval commit := $(shell git rev-parse --short HEAD))
+	$(eval tag := $(shell git tag -l 'v*-rc*' --points-at HEAD))
+	$(eval VERSION := $(shell if [[ -n "$(tag)" ]]; then echo $(tag) | sed 's/^v//'; else echo $(commit); fi))
+	$(eval tmpdir:=$(shell mktemp -d build-XXXXXXXXXX))
+	cp -r $(LOCAL) $(tmpdir)
+	cp -r ./lib $(tmpdir)
+	cp -r ./script $(tmpdir)
+	cp -r ./templates $(tmpdir)
+	cp -r ./api-enumerations $(tmpdir)
+	cp -r ./t $(tmpdir)
+	cp ./appconfig.yml $(tmpdir)
+	cp ./routes.yaml $(tmpdir)
+	cp ./errors.yml $(tmpdir)
+	cp ./log4perl.production.conf $(tmpdir)
+	cp ./cpanfile $(tmpdir)
+	cp ./start.sh $(tmpdir)
+	cd $(tmpdir); zip -r ../ch.gov.uk-$(VERSION).zip *
+	rm -rf $(tmpdir)
+
+dist: build package
+
+.PHONY: all build clean dist package getpan test test-unit test-int

README.md

@@ -0,0 +1,53 @@
+ch.gov.uk
+=========
+
+The Companies House [public beta service](https://beta.companieshouse.gov.uk/) core web application.
+
+Requirements
+------------
+
+In order to build this service you need:
+
+- GNU Make
+- [GetPAN](https://github.com/ian-kent/gopan/tree/master/getpan) for dependency resolution
+
+In order to run this service you need:
+
+- [Perl](https://www.perl.org/) >=5.18.2
+
+Getting started
+---------------
+
+#### Building the service
+
+Clone this repository:
+
+```
+$ git clone https://github.com/companieshouse/ch.gov.uk.git
+```
+
+Initialise the submodule:
+```
+$ git submodule init
+$ git submodule update
+```
+
+Resolve project dependencies by 'building' the service:
+
+```
+$ make build
+```
+
+#### Running the service
+
+Run the service using the provided script:
+
+```
+$ ./start.sh
+```
+
+Configuration
+-------------
+
+The default configuration can be overridden by either exporting environment variables at the command line prior to launching the application or by adding variable exports to `~/.chs_env/ch.gov.uk/env`.
+

appconfig.yml

@@ -0,0 +1,122 @@
+---
+base:
+  url: <BASE_URL>
+
+api:
+  url: <ERIC_LOCAL_URL>
+  key: <CHS_API_KEY>
+
+cdn:
+  url: <CDN_HOST>
+  script_dir: <CDN_SCRIPT_DIR>
+
+cookie_signing_key: "<COOKIE_SECRET>"
+
+accounts_template:
+  url: <ACCOUNTS_TEMPLATE_URL>
+
+postcode:
+  url: "<POSTCODE_SERVICE_URL>"
+
+cache:
+  backend       : 'MojoX::Plugin::AnyCache::Backend::Mojo::Redis'
+  serialiser    : 'MojoX::Plugin::AnyCache::Serialiser::MessagePack'
+  server        : "<CACHE_SERVER>"
+  redis_protocol: Protocol::Redis::XS
+
+cookie_domain: "<COOKIE_DOMAIN>"
+
+security:
+    oauth2_request_key : "<CH_OAUTH2_REQUEST_KEY>"
+
+url_sign_salt: "<URL_SIGNING_SALT>"
+
+identity_providers:
+    companies_house:
+        redirect_uri  : '<CHS_URL>/oauth2/user/callback'
+        client_id     : '<CHS_CH_CLIENT_ID>'
+        client_secret : '<CHS_CH_CLIENT_SECRET>'
+        authorize_url : '<ACCOUNT_URL>/oauth2/authorise'
+        token_url     : '<ACCOUNT_LOCAL_URL>/oauth2/token'
+        profile_url   : '<ACCOUNT_LOCAL_URL>/user/profile'
+        home_url      : '<CHS_URL>'
+
+external_url_for:
+  manage_user_details : '<ACCOUNT_URL>/user/account'
+  make_authcode_change: '<ACCOUNT_URL>/company/:company_number/authcode/change'
+  follow_company      : '<CHS_MONITOR_GUI_URL>/company/:company_number/confirm-follow'
+  unfollow_company    : '<CHS_MONITOR_GUI_URL>/company/:company_number/confirm-unfollow'
+  file_accounts       : '<CHS_URL>/company/:company_number/submit-abridged-accounts/criteria'
+
+admin_url_for:
+  roles                        : <ACCOUNT_URL>/admin/roles
+  queues                       : <CHS_BACKEND_URL>/admin/queues
+  refresh_company              : <CHS_BACKEND_URL>/admin/company/
+  user_search                  : <ACCOUNT_URL>/admin/user/search
+  transaction                  : <CHS_URL>/admin/transactions/:transaction_id
+  transaction_by_company_number: <CHS_URL>/admin/company/:company_number/transactions
+  monitor                      : <CHS_MONITOR_GUI_URL>/admin/monitor
+
+filing_history:
+  items_per_page: 25
+
+officer_appointments:
+  items_per_page: 35
+
+piwik:
+  url: "<PIWIK_URL>"
+  site_id: <PIWIK_SITE_ID>
+  embed: <PIWIK_EMBED>
+
+statsd:
+  host: "<STATSD_HOST>"
+  port: "<STATSD_PORT>"
+
+queue_api:
+  url:  <QUEUE_API_LOCAL_URL>
+
+private_beta_follow: <PRIVATE_BETA_FOLLOW>
+disable_filing: <DISABLE_FILING>
+disable_follow: <DISABLE_FOLLOW>
+
+web_proxy:
+  doc_api: <WEB_PROXY_DOC_API_HTTP>
+  monitor_api: <WEB_PROXY_MONITOR_API_HTTP>
+
+elasticsearch:
+  max_pages: <ELASTIC_SEARCH_MAX_PAGES>
+  max_results: <ELASTIC_SEARCH_MAX_RESULTS>
+
+feature:
+    mortgage: <MORTGAGE_FEATURE>
+    psc: <PSC_FEATURE>
+
+image_service_start_date: <IMAGE_SERVICE_START_DATE>
+
+disable_download_xhtml_link: <DISABLE_DOWNLOAD_XHTML_LINK>
+
+recently_filed_days: <RECENTLY_FILED_DAYS>
+
+unavailable_date: <UNAVAILABLE_DATE>
+
+disable_previous_names: <DISABLE_PREVIOUS_NAMES>
+
+display_image_disabled_message: <IMAGE_DISABLED_MESSAGE>
+image_disabled_message_header: <IMAGE_DISABLED_MESSAGE_HEADER>
+image_disabled_message_text: <IMAGE_DISABLED_MESSAGE_TEXT>
+
+disable_feedback_form: <DISABLE_FEEDBACK_FORM>
+monitor:
+  api_url: <CHS_MONITOR_API_LOCAL_URL>
+  gui_url: <CHS_MONITOR_GUI_URL>
+
+confirmation_statement_available_date: <CONFIRMATION_STATEMENT_AVAILABLE_DATE>
+
+xhtml_available_date: <XHTML_AVAILABLE_DATE>
+
+pflp_feature_enabled: <PFLP_FEATURE_ENABLED>
+
+file_accounts_available_date: <FILE_ACCOUNTS_AVAILABLE_DATE>
+
+max_memory_usage: <MAX_MEMORY_USAGE>
+shared_memory_percentage: <SHARED_MEMORY_PERCENTAGE>

cpanfile

@@ -0,0 +1,45 @@
+# make sure the correct versions of the following modules
+# are resolved upfront by "pre-requiring" them.
+# XXX unlike the rest of this file, the order in this
+# section is important.
+requires 'Log::Log4perl', '==1.49'; # Needs to be before CH::Perl
+requires 'Log::Log4perl::Appender::Fluent', '==0.04'; # Needs to be before CH::Perl
+requires 'AnyEvent', '==7.12';
+requires 'Mojolicious', '==5.47';
+requires 'Moose', '==2.1402';
+
+requires 'CH::MojoX::Administration::Plugin', '==0.35';
+requires 'Net::CompaniesHouse', '==0.65';
+requires 'CH::MojoX::Plugin::API', '==0.40';
+requires 'CH::MojoX::Plugin::Config', '==0.31';
+requires 'CH::MojoX::Plugin::Exception', '==0.31';
+requires 'CH::MojoX::Plugin::HealthCheck', '==0.11';
+requires 'CH::MojoX::Plugin::QueueAPI', '==0.31';
+requires 'CH::MojoX::Plugin::Xslate', '==0.34';
+requires 'CH::MojoX::SignIn::Plugin', '==0.44';
+requires 'CH::Perl', '==0.31';
+requires 'Crypt::Rijndael', '==1.12';
+requires 'Data::Dumper::Concise', '==2.023';
+requires 'Date::Calc', '==6.3';
+requires 'DateTime::Format::ISO8601', '==0.08';
+requires 'DateTime::Tiny', '==1.04';
+requires 'Digest::SHA1', '==2.13';
+requires 'JSON::WebEncryption', '==0.06';
+requires 'Locale::Simple', '==0.016';
+requires 'Log::Declare', '==0.10';
+requires 'MojoX::JSON::XS', '==0.30';
+requires 'MojoX::Log::Declare', '==0.32';
+requires 'MojoX::Plugin::AnyCache', '==0.33';
+requires 'MojoX::Plugin::Hook::BeforeRendered', '==0.30';
+requires 'MojoX::Plugin::PODRenderer', '==0.30';
+requires 'MojoX::Plugin::Statsd', '==0.30';
+requires 'MojoX::Renderer::IncludeLater', '==0.30';
+requires 'MojoX::Renderer::Xslate', '==0.092';
+requires 'MojoX::Security::Session', '==0.38';
+requires 'MojoX::URL::Sign', '==0.30';
+requires 'MooseX::Model', '==0.31';
+requires 'Protocol::Redis::XS', '==0.05';
+requires 'Readonly', '==2.00';
+
+test_requires 'CH::Test', '==0.32';
+test_requires 'Test::Differences', '==0.63';