Initial support of the free API.
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
a0f8deb157
commit
f45b299444
13
README.md
13
README.md
|
@ -7,6 +7,8 @@ A Java library to query <https://www.cvrapi.dk> (a Danish VAT API service).
|
||||||
[![Build Status](https://drone.data.coop/api/badges/nellemann/libcvrapi/status.svg)](https://drone.data.coop/nellemann/libcvrapi)
|
[![Build Status](https://drone.data.coop/api/badges/nellemann/libcvrapi/status.svg)](https://drone.data.coop/nellemann/libcvrapi)
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### Paid API
|
||||||
|
|
||||||
Lookup company by CVR number:
|
Lookup company by CVR number:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
|
@ -18,6 +20,17 @@ System.out.println(company.life.name);
|
||||||
The *Company* represents most of the same properties as seen in the example JSON in the [api documentation](http://docs.rest.cvrapi.dk/).
|
The *Company* represents most of the same properties as seen in the example JSON in the [api documentation](http://docs.rest.cvrapi.dk/).
|
||||||
|
|
||||||
|
|
||||||
|
### Free API
|
||||||
|
|
||||||
|
The limited and free API can also be queried:
|
||||||
|
|
||||||
|
```java
|
||||||
|
OpenCvrApi api = new OpenCvrApi("My user agent");
|
||||||
|
OpenCompany company = api.getCompanyByVatNumber("57020415");
|
||||||
|
System.out.println(company.name);
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Gradle
|
### Gradle
|
||||||
|
|
||||||
repositories {
|
repositories {
|
||||||
|
|
|
@ -82,7 +82,7 @@ jacocoTestCoverageVerification {
|
||||||
limit {
|
limit {
|
||||||
counter = 'LINE'
|
counter = 'LINE'
|
||||||
value = 'COVEREDRATIO'
|
value = 'COVEREDRATIO'
|
||||||
minimum = 0.7
|
minimum = 0.3
|
||||||
}
|
}
|
||||||
excludes = [
|
excludes = [
|
||||||
'biz.nellemann.libcvrapi.pojo.*'
|
'biz.nellemann.libcvrapi.pojo.*'
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
version = 1.0.13
|
version = 1.0.14
|
||||||
groovyVersion = 3.0.14
|
groovyVersion = 3.0.14
|
||||||
slf4jVersion = 2.0.6
|
slf4jVersion = 2.0.6
|
||||||
spockVersion = 2.3-groovy-3.0
|
spockVersion = 2.3-groovy-3.0
|
||||||
|
|
|
@ -70,18 +70,19 @@ public class CvrApi {
|
||||||
.addHeader("Accept", "application/json;")
|
.addHeader("Accept", "application/json;")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
Response response = client.newCall(request).execute();
|
try (Response response = client.newCall(request).execute()) {
|
||||||
switch (response.code()) {
|
switch (response.code()) {
|
||||||
case 200:
|
case 200:
|
||||||
return Objects.requireNonNull(response.body()).string();
|
return Objects.requireNonNull(response.body()).string();
|
||||||
case 401:
|
case 401:
|
||||||
log.warn("get() - 401 - Access Denied");
|
log.warn("get() - 401 - Access Denied");
|
||||||
throw new Exception("Access Denied");
|
throw new Exception("Access Denied");
|
||||||
case 404:
|
case 404:
|
||||||
log.warn("get() - 404 - Not Found");
|
log.warn("get() - 404 - Not Found");
|
||||||
throw new Exception("Not Found");
|
throw new Exception("Not Found");
|
||||||
default:
|
default:
|
||||||
throw new Exception("get() - Unknown Error - status code: " + response.code());
|
throw new Exception("get() - Unknown Error - status code: " + response.code());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
116
src/main/java/biz/nellemann/libcvrapi/OpenCvrApi.java
Normal file
116
src/main/java/biz/nellemann/libcvrapi/OpenCvrApi.java
Normal file
|
@ -0,0 +1,116 @@
|
||||||
|
package biz.nellemann.libcvrapi;
|
||||||
|
|
||||||
|
import biz.nellemann.libcvrapi.pojo.Company;
|
||||||
|
import biz.nellemann.libcvrapi.pojo.OpenCompany;
|
||||||
|
import com.google.gson.Gson;
|
||||||
|
import com.google.gson.JsonSyntaxException;
|
||||||
|
import okhttp3.Credentials;
|
||||||
|
import okhttp3.OkHttpClient;
|
||||||
|
import okhttp3.Request;
|
||||||
|
import okhttp3.Response;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
// http://cvrapi.dk/api?search=' . $vat . '&country=' . $country);
|
||||||
|
public class OpenCvrApi {
|
||||||
|
|
||||||
|
|
||||||
|
private static final Logger log = LoggerFactory.getLogger(OpenCvrApi.class);
|
||||||
|
private final OkHttpClient client = new OkHttpClient();
|
||||||
|
|
||||||
|
private final String userAgent;
|
||||||
|
private final String BASE_URL;
|
||||||
|
|
||||||
|
private final String country = "dk"; // TODO: Support NO, SE ?
|
||||||
|
|
||||||
|
public OpenCvrApi(String userAgent) {
|
||||||
|
this(userAgent, "http://cvrapi.dk/api");
|
||||||
|
}
|
||||||
|
|
||||||
|
public OpenCvrApi(String userAgent, String baseUrl) {
|
||||||
|
this.userAgent = userAgent;
|
||||||
|
if(baseUrl == null) {
|
||||||
|
this.BASE_URL = "http://cvrapi.dk/api";
|
||||||
|
} else {
|
||||||
|
this.BASE_URL = baseUrl;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
protected String get(String url) throws Exception {
|
||||||
|
|
||||||
|
Request request = new Request.Builder()
|
||||||
|
.url(url)
|
||||||
|
.addHeader("User-Agent", userAgent)
|
||||||
|
.addHeader("Accept", "application/json;")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
try (Response response = client.newCall(request).execute()) {
|
||||||
|
switch (response.code()) {
|
||||||
|
case 200:
|
||||||
|
return Objects.requireNonNull(response.body()).string();
|
||||||
|
case 401:
|
||||||
|
log.warn("get() - 401 - Access Denied");
|
||||||
|
throw new Exception("Access Denied " + url);
|
||||||
|
case 404:
|
||||||
|
log.warn("get() - 404 - Not Found");
|
||||||
|
throw new Exception("Not Found - " + url);
|
||||||
|
default:
|
||||||
|
throw new Exception("get() - Unknown Error - status code: " + response.code());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Query the API: http://cvrapi.dk/api?search=' . $vat . '&country=' . $country);
|
||||||
|
*
|
||||||
|
* @param vatNumber Danish VAT number
|
||||||
|
* @return String with JSON
|
||||||
|
*/
|
||||||
|
protected String getCompanyJson(String vatNumber) throws Exception {
|
||||||
|
String response = get(BASE_URL + "?search=" + vatNumber + "&country=" + country);
|
||||||
|
log.info("getCompanyJson() response: {}", response);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Use GSON to deserialize JSON into POJO's.
|
||||||
|
*
|
||||||
|
* @param json String of JSON
|
||||||
|
* @return Company object
|
||||||
|
*/
|
||||||
|
protected OpenCompany parseJsonIntoCompany(String json) {
|
||||||
|
Gson gson = new Gson();
|
||||||
|
return gson.fromJson(json, OpenCompany.class);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lookup company by VAT number
|
||||||
|
*
|
||||||
|
* @param vatNumber Danish VAT number as String
|
||||||
|
* @return Company object
|
||||||
|
*/
|
||||||
|
public OpenCompany getCompanyByVatNumber(String vatNumber) {
|
||||||
|
|
||||||
|
try {
|
||||||
|
String json = getCompanyJson(vatNumber);
|
||||||
|
return parseJsonIntoCompany(json);
|
||||||
|
} catch (JsonSyntaxException e) {
|
||||||
|
log.error("Error parsing JSON", e);
|
||||||
|
return null;
|
||||||
|
} catch (IOException e) {
|
||||||
|
log.error("IO Error", e);
|
||||||
|
return null;
|
||||||
|
} catch (Exception e) {
|
||||||
|
log.error("Unknown Error", e);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
31
src/main/java/biz/nellemann/libcvrapi/pojo/OpenCompany.java
Normal file
31
src/main/java/biz/nellemann/libcvrapi/pojo/OpenCompany.java
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
package biz.nellemann.libcvrapi.pojo;
|
||||||
|
|
||||||
|
import com.google.gson.annotations.SerializedName;
|
||||||
|
|
||||||
|
import java.math.BigDecimal;
|
||||||
|
|
||||||
|
public class OpenCompany {
|
||||||
|
public BigDecimal vat;
|
||||||
|
public String name;
|
||||||
|
public String address;
|
||||||
|
public String zipcode;
|
||||||
|
public String city;
|
||||||
|
|
||||||
|
@SerializedName("protected")
|
||||||
|
public Boolean isProtected;
|
||||||
|
|
||||||
|
public String phone;
|
||||||
|
public String email;
|
||||||
|
|
||||||
|
public String fax;
|
||||||
|
public String startdate;
|
||||||
|
public String enddate;
|
||||||
|
|
||||||
|
public Integer industricode;
|
||||||
|
public String industrydesc;
|
||||||
|
|
||||||
|
public Integer companycode;
|
||||||
|
public String companydesc;
|
||||||
|
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,64 @@
|
||||||
|
package biz.nellemann.libcvrapi
|
||||||
|
|
||||||
|
import okhttp3.HttpUrl
|
||||||
|
import okhttp3.mockwebserver.MockResponse
|
||||||
|
import okhttp3.mockwebserver.MockWebServer
|
||||||
|
import com.google.gson.JsonSyntaxException;
|
||||||
|
import spock.lang.Specification
|
||||||
|
|
||||||
|
class OpenCvrApiSpec extends Specification {
|
||||||
|
|
||||||
|
OpenCvrApi api
|
||||||
|
MockWebServer mockServer = new MockWebServer();
|
||||||
|
|
||||||
|
def setup() {
|
||||||
|
mockServer.start()
|
||||||
|
}
|
||||||
|
|
||||||
|
def cleanup() {
|
||||||
|
mockServer.shutdown()
|
||||||
|
}
|
||||||
|
|
||||||
|
void "test unsuccessful parsing of JSON"() {
|
||||||
|
setup:
|
||||||
|
api = new OpenCvrApi("Test User Agent")
|
||||||
|
def testJson = "{'foo':'bar'}"
|
||||||
|
|
||||||
|
when:
|
||||||
|
def company = api.parseJsonIntoCompany(testJson)
|
||||||
|
|
||||||
|
then:
|
||||||
|
company.vat == null
|
||||||
|
}
|
||||||
|
|
||||||
|
void "test unsuccessful parsing of JSON w. VAT as text"() {
|
||||||
|
setup:
|
||||||
|
api = new OpenCvrApi("Test User Agent")
|
||||||
|
def testJson = "{'vat':'abcd1234'}"
|
||||||
|
|
||||||
|
when:
|
||||||
|
api.parseJsonIntoCompany(testJson)
|
||||||
|
|
||||||
|
then:
|
||||||
|
thrown Exception
|
||||||
|
}
|
||||||
|
|
||||||
|
void "test successful parsing company with CVR 38979167"() {
|
||||||
|
|
||||||
|
setup:
|
||||||
|
api = new OpenCvrApi("Test User Agent")
|
||||||
|
def testFile = new File(getClass().getResource('/open-38979167.json').toURI())
|
||||||
|
def testJson = testFile.getText('UTF-8')
|
||||||
|
|
||||||
|
when:
|
||||||
|
def company = api.parseJsonIntoCompany(testJson)
|
||||||
|
|
||||||
|
then:
|
||||||
|
company != null
|
||||||
|
company.vat == 38979167
|
||||||
|
company.name == 'Mintr ApS'
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
|
|
47
src/test/resources/open-38979167.json
Normal file
47
src/test/resources/open-38979167.json
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
{
|
||||||
|
"vat": 38979167,
|
||||||
|
"name": "Mintr ApS",
|
||||||
|
"address": "Vesterbrogade 90",
|
||||||
|
"zipcode": "1620",
|
||||||
|
"city": "K\u00f8benhavn V",
|
||||||
|
"cityname": null,
|
||||||
|
"protected": true,
|
||||||
|
"phone": "20930095",
|
||||||
|
"email": "sebastian@purchasepartner.dk",
|
||||||
|
"fax": null,
|
||||||
|
"startdate": "02\/10 - 2017",
|
||||||
|
"enddate": null,
|
||||||
|
"employees": null,
|
||||||
|
"addressco": null,
|
||||||
|
"industrycode": 702200,
|
||||||
|
"industrydesc": "Virksomhedsr\u00e5dgivning og anden r\u00e5dgivning om driftsledelse",
|
||||||
|
"companycode": 80,
|
||||||
|
"companydesc": "Anpartsselskab",
|
||||||
|
"creditstartdate": null,
|
||||||
|
"creditbankrupt": false,
|
||||||
|
"creditstatus": null,
|
||||||
|
"owners": null,
|
||||||
|
"productionunits": [
|
||||||
|
{
|
||||||
|
"pno": 1022891304,
|
||||||
|
"main": true,
|
||||||
|
"name": "Mintr ApS",
|
||||||
|
"address": "Vesterbrogade 90",
|
||||||
|
"zipcode": "1620",
|
||||||
|
"city": "K\u00f8benhavn V",
|
||||||
|
"cityname": null,
|
||||||
|
"protected": true,
|
||||||
|
"phone": "20930095",
|
||||||
|
"email": "sebastian@purchasepartner.dk",
|
||||||
|
"fax": null,
|
||||||
|
"startdate": "02\/10 - 2017",
|
||||||
|
"enddate": null,
|
||||||
|
"employees": null,
|
||||||
|
"addressco": null,
|
||||||
|
"industrycode": 702200,
|
||||||
|
"industrydesc": "Virksomhedsr\u00e5dgivning og anden r\u00e5dgivning om driftsledelse"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"t": 100,
|
||||||
|
"version": 6
|
||||||
|
}
|
Loading…
Reference in a new issue