-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38 from hmrc/feature/yta-3207
YTA-3207: Added /statements endpoint.
- Loading branch information
Showing
20 changed files
with
750 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
app/uk/gov/hmrc/epayeapi/controllers/GetStatementsController.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright 2018 HM Revenue & Customs | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package uk.gov.hmrc.epayeapi.controllers | ||
|
|
||
| import javax.inject.{Inject, Singleton} | ||
|
|
||
| import akka.stream.Materializer | ||
| import play.api.libs.json.Json | ||
| import play.api.mvc.{Action, EssentialAction, Result} | ||
| import uk.gov.hmrc.auth.core.AuthConnector | ||
| import uk.gov.hmrc.domain.EmpRef | ||
| import uk.gov.hmrc.epayeapi.connectors.{EpayeApiConfig, EpayeConnector} | ||
| import uk.gov.hmrc.epayeapi.models.Formats.statementsJsonWrites | ||
| import uk.gov.hmrc.epayeapi.models.in.{EpayeMasterData, EpayeResponse, EpayeSuccess} | ||
| import uk.gov.hmrc.epayeapi.models.out.{EmpRefsJson, StatementsJson} | ||
|
|
||
| import scala.concurrent.ExecutionContext | ||
|
|
||
| @Singleton | ||
| case class GetStatementsController @Inject()( | ||
| config: EpayeApiConfig, | ||
| authConnector: AuthConnector, | ||
| epayeConnector: EpayeConnector, | ||
| implicit val ec: ExecutionContext, | ||
| implicit val mat: Materializer | ||
| ) | ||
| extends ApiController | ||
| with EpayeErrorHandler { | ||
|
|
||
| def getStatements(empRef: EmpRef): EssentialAction = { | ||
| EmpRefAction(empRef) { | ||
| Action.async { implicit request => | ||
| val masterData = epayeConnector.getMasterData(empRef, hc) | ||
| masterData.map { | ||
| successHandler(empRef) orElse errorHandler | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| def successHandler(empRef: EmpRef): PartialFunction[EpayeResponse[EpayeMasterData], Result] = { | ||
| case EpayeSuccess(EpayeMasterData(_, yearRegistered)) => | ||
| val statements = StatementsJson(config.apiBaseUrl, empRef, yearRegistered) | ||
| Ok(Json.toJson(statements)) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * Copyright 2018 HM Revenue & Customs | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package uk.gov.hmrc.epayeapi.models.in | ||
|
|
||
| import uk.gov.hmrc.epayeapi.models.TaxYear | ||
|
|
||
| case class EpayeMasterData( | ||
| accountsOfficeReference: Option[String], | ||
| yearRegistered: Option[TaxYear] | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /* | ||
| * Copyright 2018 HM Revenue & Customs | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package uk.gov.hmrc.epayeapi.models.out | ||
|
|
||
| import org.joda.time.LocalDate | ||
| import uk.gov.hmrc.domain.EmpRef | ||
| import uk.gov.hmrc.epayeapi.models.TaxYear | ||
|
|
||
| case class StatementsJson( | ||
| _embedded: Embedded, | ||
| _links: Links | ||
| ) | ||
|
|
||
| case class Embedded( | ||
| statements: Seq[Statement] | ||
| ) | ||
|
|
||
| case class Statement( | ||
| taxYear: TaxYear, | ||
| _links: StatementLinks | ||
| ) | ||
|
|
||
| case class StatementLinks( | ||
| self: Link | ||
| ) | ||
|
|
||
| case class Links( | ||
| empRefs: Link, | ||
| self: Link | ||
| ) | ||
|
|
||
| object StatementsJson { | ||
| def apply(apiBaseUrl: String, empRef: EmpRef, taxYearOfRegistration: Option[TaxYear]): StatementsJson = { | ||
| def taxYearStatement(taxYear: TaxYear): Statement = { | ||
| Statement( | ||
| taxYear = taxYear, | ||
| _links = StatementLinks(self = Link.anualStatementLink(apiBaseUrl, empRef, taxYear)) | ||
| ) | ||
| } | ||
|
|
||
| val currentTaxYear = TaxYear(LocalDate.now()) | ||
|
|
||
| val statements: Seq[Statement] = for { | ||
| regYear <- taxYearOfRegistration.toSeq | ||
| taxYearFrom <- (regYear.yearFrom to currentTaxYear.yearFrom) | ||
| taxYear = TaxYear(taxYearFrom) | ||
| } yield taxYearStatement(taxYear) | ||
|
|
||
| val links = Links( | ||
| empRefs = Link.empRefsLink(apiBaseUrl), | ||
| self = Link.statementsLink(apiBaseUrl, empRef) | ||
| ) | ||
|
|
||
| StatementsJson( | ||
| _embedded = Embedded(statements), | ||
| _links = links | ||
| ) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
resources/public/api/conf/1.0/examples/Statements.get.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| { | ||
| "_embedded": { | ||
| "statements": [{ | ||
| "taxYear": { | ||
| "year": "2016-17", | ||
| "firstDay": "2016-04-06", | ||
| "lastDay": "2017-04-05" | ||
| }, | ||
| "_links": { | ||
| "self": { | ||
| "href": "https://api.service.hmrc.gov.uk/organisations/paye/001/AB00001/statements/2016-17" | ||
| } | ||
| } | ||
| }, { | ||
| "taxYear": { | ||
| "year": "2015-16", | ||
| "firstDay": "2015-04-06", | ||
| "lastDay": "2016-04-05" | ||
| }, | ||
| "_links": { | ||
| "self": { | ||
| "href": "https://api.service.hmrc.gov.uk/organisations/paye/001/AB00001/statements/2015-16" | ||
| } | ||
| } | ||
| }, { | ||
| "taxYear": { | ||
| "year": "2014-15", | ||
| "firstDay": "2014-04-06", | ||
| "lastDay": "2015-04-05" | ||
| }, | ||
| "_links": { | ||
| "self": { | ||
| "href": "https://api.service.hmrc.gov.uk/organisations/paye/001/AB00001/statements/2014-15" | ||
| } | ||
| } | ||
| }] | ||
| }, | ||
| "_links": { | ||
| "empRefs": { | ||
| "href": "https://api.service.hmrc.gov.uk/organisations/paye/" | ||
| }, | ||
| "self": { | ||
| "href": "https://api.service.hmrc.gov.uk/organisations/paye/001/AB00001/statements" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.