Initial commit

This commit is contained in:
Mark Nellemann 2019-08-23 15:19:51 +02:00
commit 7e349f3d35
18 changed files with 4136 additions and 0 deletions

15
.editorconfig Normal file
View file

@ -0,0 +1,15 @@
root = true
[*]
indent_style = tab
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.{json,yml}]
indent_size = 2
[*.md]
trim_trailing_whitespace = false

9
.gitignore vendored Normal file
View file

@ -0,0 +1,9 @@
.classpath
.project
.idea/
.vscode/
.gradle/
.settings/
out/
bin/
build/

28
README.md Normal file
View file

@ -0,0 +1,28 @@
# libpaqle
-----------------------------------
A Java library to query Paqle. Work in progress.
## Usage
TODO.
### Gradle
repositories {
maven { url 'https://dl.bintray.com/mnellemann/libs' }
}
dependencies {
compile 'biz.nellemann.libs:libpaqle:1.+'
runtime "org.slf4j:slf4j-simple:1.7.28"
}
## Development
To build and test the code:
./gradle build
./gradle test

18
bitbucket-pipelines.yml Normal file
View file

@ -0,0 +1,18 @@
image: openjdk:8
pipelines:
default:
- step: # define the build pipeline for the tag
caches:
- gradle
name: Build and Test
script:
- bash ./gradlew clean build
tags: # add the 'tags' section
release-*: # specify the tag
- step: # define the build pipeline for the tag
caches:
- gradle
name: Build and Release
script:
- bash ./gradlew clean build bintrayUpload

106
build.gradle Normal file
View file

@ -0,0 +1,106 @@
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4'
//classpath 'com.bmuschko:gradle-clover-plugin:2.2.3'
}
}
apply plugin: "idea"
apply plugin: "java"
apply plugin: "groovy"
apply plugin: 'maven'
apply plugin: 'jacoco'
apply plugin: 'maven-publish'
apply plugin: 'com.jfrog.bintray'
//apply from: "${project.projectDir}/gradle/clover.gradle"
version = "${version}-SNAPSHOT"
sourceCompatibility = 1.8
targetCompatibility = 1.8
repositories {
mavenCentral()
}
dependencies {
implementation("org.slf4j:slf4j-api:${slf4jVersion}")
implementation('com.google.code.gson:gson:2.8.5')
implementation("com.squareup.okhttp3:okhttp:4.1.0")
testImplementation("org.slf4j:slf4j-simple:${slf4jVersion}")
testImplementation('com.squareup.okhttp3:mockwebserver:4.1.0')
testCompile("org.codehaus.groovy:groovy-all:${groovyVersion}")
testCompile("org.spockframework:spock-core:${spockVersion}") {
exclude group: "org.codehaus.groovy"
}
testCompile( 'com.athaydes:spock-reports:1.6.2' ) {
transitive = false // this avoids affecting your version of Groovy/Spock
}
}
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
}
}
repositories {
mavenLocal()
}
}
bintray {
user = System.getenv('BINTRAY_USER')
key = System.getenv('BINTRAY_KEY')
configurations = ['archives']
pkg {
repo = "libs"
name = id
websiteUrl = siteUrl
vcsUrl = gitUrl
licenses = licenses
publish = true
}
}
jacoco {
toolVersion = "0.8.4"
}
jacocoTestReport {
group = "verification"
reports {
xml.enabled false
csv.enabled false
html.destination file("${buildDir}/reports/coverage")
}
afterEvaluate {
classDirectories.setFrom(files(classDirectories.files.collect {
fileTree(dir: it, exclude: 'biz/nellemann/libpaqle/pojo/**')
}))
}
}
test.finalizedBy jacocoTestReport
jacocoTestCoverageVerification {
violationRules {
rule {
element = 'CLASS'
limit {
counter = 'LINE'
value = 'COVEREDRATIO'
minimum = 0.7
}
excludes = [
'biz.nellemann.libpaqle.pojo.*'
]
}
}
}
check.dependsOn jacocoTestCoverageVerification

9
gradle.properties Normal file
View file

@ -0,0 +1,9 @@
id = libpaqle
group = biz.nellemann.libs
version = 1.0.0
licenses = ['APACHE-2.0'] // or something else
groovyVersion = 2.5.8
slf4jVersion = 1.7.28
spockVersion = 1.3-groovy-2.5
siteUrl = https://bitbucket.org/mnellemann/libpaqle
gitUrl = https://bitbucket.org/mnellemann/libpaqle.git

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file

Binary file not shown.

View file

@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.6-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

188
gradlew vendored Executable file
View file

@ -0,0 +1,188 @@
#!/usr/bin/env sh
#
# Copyright 2015 the original author or authors.
#
# 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
#
# https://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.
#
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"

100
gradlew.bat vendored Normal file
View file

@ -0,0 +1,100 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

View file

@ -0,0 +1,107 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 biz.nellemann.libpaqle;
import java.io.IOException;
import java.util.List;
import biz.nellemann.libpaqle.pojo.PaqleResponse;
import com.google.gson.Gson;
import com.google.gson.JsonSyntaxException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import okhttp3.Credentials;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
public class Paqle {
private final static Logger log = LoggerFactory.getLogger(Paqle.class);
private final OkHttpClient client;
private final String company;
private final String basicUsername;
private final String basicPassword;
protected String baseUrl = "https://entityapi.paqle.net";
public Paqle(String company, String basicUsername, String basicPassword) {
this.company = company;
this.basicUsername = basicUsername;
this.basicPassword = basicPassword;
client = new OkHttpClient();
}
protected String get(String url) throws IOException, Exception {
String credential = Credentials.basic(basicUsername, basicPassword);
Request request = new Request.Builder().url(url)
.header("Authorization", credential).addHeader("Accept", "application/json;").build();
Response response = client.newCall(request).execute();
switch (response.code()) {
case 200:
return response.body().string();
case 401:
log.warn("get() - 401 - Access Denied");
throw new Exception("Access Denied");
case 404:
log.warn("get() - 404 - Not Found");
throw new Exception("Not Found");
default:
throw new Exception("get() - Unknown Error - status code: " + response.code());
}
}
/**
* @param vatNumbers
* @return
* @throws IOException
*/
protected String getJson(List<String> vatNumbers) throws IOException, Exception {
String cvrIds = String.join(",", vatNumbers);
String jsonText = get(baseUrl + "/entities?customer=" + company + "&news&cvrIds=" + cvrIds);
log.debug("getEntities() response: " + jsonText);
return jsonText;
}
/**
* Use GSON to deserialize JSON into POJO's.
*
* @param json
* @return
*/
protected PaqleResponse getResponse(String json) throws JsonSyntaxException {
Gson gson = new Gson();
PaqleResponse response = gson.fromJson(json, PaqleResponse.class);
return response;
}
}

View file

@ -0,0 +1,55 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 biz.nellemann.libpaqle.pojo;
public class Entity {
Boolean published;
Boolean hidden;
Integer OriginalId;
Integer CurrentId;
String type;
String countryCode;
String PaqleUrl;
/*
"Entities": [
{
"Published": true,
"SectionsDk": {
"CvrMetadata": [
{
"CvrId": "4004110055"
}
]
},
"MergedIds": [
1818574
],
"Hidden": false,
"OriginalId": 1495393,
"CurrentId": 7906322,
"Type": "Person",
"CountryCode": "dk",
"PaqleUrl": "https://www.paqle.dk/p/lars-fruergaard-jørgensen/1495393"
},
],*/
}

View file

@ -0,0 +1,43 @@
package biz.nellemann.libpaqle.pojo;
import java.util.List;
public class News {
Integer EntityOriginalId;
String ClusterHash;
String Published;
String LanguageCode;
String sourceName;
String Url;
List<NewsHeadline> Headline;
/*
News": [
{
"EntityOriginalId": 11801,
"ClusterHash": "fbdcfe3faff89fd16e0172148a1503f8",
"Published": "2019-04-02T19:58Z",
"LanguageCode": "da",
"SourceName": "Finans.dk",
"Url": "http://entityapi.paqle.net/articles/2ad41f1fbcf45cf495cf5d2b089d81",
"Headline": [
{
"Text": "Nationalbanken holder sig fra valutaindgreb trods svækkelse"
}
],
"Extract": [
{
"Text": "Hos "
},
{
"Text": "Sydbank",
"Highlight": true
},
{
"Text": " ser man den manglende intervention som et tegn på, at Nationalbanken er \"komfortabel\" med situationen."
}
]
}
]*/
}

View file

@ -0,0 +1,8 @@
package biz.nellemann.libpaqle.pojo;
public class NewsExtract {
String Text;
Boolean Highlight;
}

View file

@ -0,0 +1,7 @@
package biz.nellemann.libpaqle.pojo;
public class NewsHeadline {
String Text;
}

View file

@ -0,0 +1,13 @@
package biz.nellemann.libpaqle.pojo;
import java.util.List;
// https://entityapi.paqle.net/documentation/entities
public class PaqleResponse {
List<Entity> Entities;
List<News> News;
}

View file

@ -0,0 +1,52 @@
package biz.nellemann.libpaqle
import biz.nellemann.libpaqle.pojo.PaqleResponse
import okhttp3.HttpUrl
import okhttp3.mockwebserver.MockResponse
import okhttp3.mockwebserver.MockWebServer
import spock.lang.Specification
class PaqleSpec extends Specification {
Paqle paqle
MockWebServer mockServer = new MockWebServer();
def setup() {
paqle = new Paqle("TestCompany", "testUser", "testPassword")
mockServer.start();
}
def cleanup() {
mockServer.shutdown()
}
void "test succesfull parsing of test JSON"() {
setup:
def testFile = new File(getClass().getResource('/test.json').toURI())
def testJson = testFile.getText('UTF-8')
when:
PaqleResponse response = paqle.getResponse(testJson)
then:
response.Entities.size() == 2
response.News.size() == 100
}
void "test succesful HTTP GET 15027800"() {
setup:
mockServer.enqueue(new MockResponse().setBody("{}"));
HttpUrl baseUrl = mockServer.url("/");
paqle.baseUrl = baseUrl.toString()
when:
def jsonString = paqle.getJson(["15027800"])
then:
jsonString != null
jsonString == "{}"
}
}

3373
src/test/resources/test.json Normal file

File diff suppressed because it is too large Load diff