Initial commit

Author: yassine

.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,18 @@
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+# IntelliJ project files
+.idea
+*.iml
+out
+gen
+NOTES

.mvn/extensions.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<extensions>
+	<extension>
+		<groupId>io.takari.polyglot</groupId>
+		<artifactId>polyglot-groovy</artifactId>
+		<version>0.4.3</version>
+	</extension>
+</extensions>
+

lombok.config

@@ -0,0 +1 @@
+lombok.addLombokGeneratedAnnotation = true

pom.groovy

@@ -0,0 +1,23 @@
+project {
+  modelVersion '4.0.0'
+  groupId 'io.ipdata.client'
+  artifactId 'ipdata-client'
+  version '0.1.0-SNAPSHOT'
+  properties {
+    'project.build.sourceEncoding' 'UTF-8'
+    'maven.compiler.source' '6'
+    'maven.compiler.target' '6'
+  }
+  dependencies{
+    dependency ('io.github.openfeign:feign-core:9.7.0')
+    dependency ('io.github.openfeign:feign-jackson:9.7.0')
+    dependency ('io.github.openfeign:feign-httpclient:9.7.0')
+    dependency ('com.google.guava:guava:20.0')
+    dependency ('org.slf4j:slf4j-api:1.7.30')
+    dependency ('org.slf4j:slf4j-log4j12:1.7.30')
+    dependency ('org.projectlombok:lombok:1.18.10')
+    /* testing */
+    dependency('org.hamcrest:hamcrest:2.2:test')
+    dependency('junit:junit:4.13')
+  }
+}

src/main/java/io/ipdata/client/CacheConfigBuilder.java

@@ -0,0 +1,61 @@
+package io.ipdata.client;
+
+import io.ipdata.client.service.CacheConfig;
+import java.util.concurrent.TimeUnit;
+import lombok.AccessLevel;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.Accessors;
+
+@Accessors(fluent = true)
+@RequiredArgsConstructor(access = AccessLevel.PACKAGE)
+public class CacheConfigBuilder {
+
+  private final Ipdata.Builder parent;
+  private long maxSize;
+  private int timeout;
+  private TimeUnit unit;
+
+  /**
+   * Configures the cache maximum size.
+   * @param maxSize The maximum of items to keep in Cache
+   * @return this builder
+   */
+  public CacheConfigBuilder maxSize(long maxSize) {
+    if (maxSize <= 0) {
+      throw new IllegalArgumentException("cache size must be greater than 0");
+    }
+    this.maxSize = maxSize;
+    return this;
+  }
+
+  /**
+   * The maximum duration before invalidating a cache entry.
+   * @param timeout The duration
+   * @param unit The duration unit
+   * @return
+   */
+  public CacheConfigBuilder timeout(int timeout, TimeUnit unit) {
+    if (timeout <= 0) {
+      throw new IllegalArgumentException("cache timeout must be greater than 0");
+    }
+    if (unit == null) {
+      throw new IllegalArgumentException("timeout unit should not be null");
+    }
+    this.timeout = timeout;
+    this.unit = unit;
+    return this;
+  }
+
+  /**
+   * Builds A <code>CacheConfig</code> instance and registers it in the <code>Ipdata.Builder</code>
+   * @return The <code>Ipdata.Builder</code> that created this <code>CacheConfigBuilder</code>
+   */
+  public Ipdata.Builder registerCacheConfig() {
+    return parent.cacheConfig(CacheConfig.builder()
+      .maxSize(maxSize)
+      .timeout(timeout)
+      .unit(unit)
+      .build());
+  }
+
+}

src/main/java/io/ipdata/client/Ipdata.java

@@ -0,0 +1,94 @@
+package io.ipdata.client;
+
+import feign.Client;
+import io.ipdata.client.service.CacheConfig;
+import io.ipdata.client.service.IpdataService;
+import io.ipdata.client.service.IpdataServiceBuilder;
+import java.net.URL;
+import java.util.concurrent.TimeUnit;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import lombok.experimental.UtilityClass;
+import org.slf4j.Logger;
+
+@UtilityClass
+public final class Ipdata {
+
+  public static Ipdata.Builder builder() {
+    return new Builder();
+  }
+
+  @Setter
+  @Accessors(fluent = true, chain = true)
+  @NoArgsConstructor(access = AccessLevel.PRIVATE)
+  public static class Builder {
+
+    /**
+     * The Ipdata API key
+     */
+    @Setter
+    private String key;
+    /**
+     * The target URL for the client
+     */
+    @Setter
+    private URL url;
+    /**
+     * (Optional) To Cache api calls, a cache configuration can be provided
+     */
+    @Setter(AccessLevel.PACKAGE)
+    private CacheConfig cacheConfig;
+    /**
+     * (Optional) Configures a logger to use by the client
+     */
+    @Setter
+    private Logger logger;
+    /**
+     * (Optional) Configures a custom Feign client (If you wanna use this with Ribbon or Hystrix for example).
+     */
+    @Setter
+    private Client feignClient;
+
+    /**
+     * Configures a cache with default configuration parameters.
+     * Note: Overrides any previously configured cache.
+     *
+     * @return this builder
+     */
+    public Builder withDefaultCache() {
+      return new CacheConfigBuilder(this)
+        .maxSize(Long.MAX_VALUE)
+        .timeout(4, TimeUnit.HOURS)
+        .registerCacheConfig();
+    }
+
+    /**
+     * Allows for customizing the configuration of the cache.
+     * Note: Overrides any previously configured cache.
+     *
+     * @return a cache configuration builder
+     * @see CacheConfigBuilder
+     */
+    public CacheConfigBuilder withCache() {
+      return new CacheConfigBuilder(this);
+    }
+
+    /**
+     * @return An Ipdata api facade
+     * @see io.ipdata.client.service.IpdataService
+     */
+    public IpdataService get() {
+      if (key == null) {
+        throw new IllegalArgumentException("Key can't be null");
+      }
+      if (url == null) {
+        throw new IllegalArgumentException("Target URL can't be null");
+      }
+      return IpdataServiceBuilder.of(url, key, cacheConfig, logger, feignClient).build();
+    }
+
+  }
+
+}

src/main/java/io/ipdata/client/error/IpdataException.java

@@ -0,0 +1,18 @@
+package io.ipdata.client.error;
+
+/**
+ * A generic Ipdata client exception.
+ */
+public class IpdataException extends Exception {
+  public IpdataException(String message) {
+    super(message);
+  }
+
+  public IpdataException(String message, Throwable cause) {
+    super(message, cause);
+  }
+
+  public IpdataException(Throwable cause) {
+    super(cause);
+  }
+}

src/main/java/io/ipdata/client/error/RemoteIpdataException.java

@@ -0,0 +1,26 @@
+package io.ipdata.client.error;
+
+import lombok.Getter;
+
+/**
+ * An <code>IpdataException</code> specialization that captures errors from the downstream.
+ */
+public class RemoteIpdataException extends IpdataException {
+  @Getter
+  private final int status;
+
+  public RemoteIpdataException(String message, Throwable cause, int status) {
+    super(message, cause);
+    this.status = status;
+  }
+
+  public RemoteIpdataException(String message, int status) {
+    super(message);
+    this.status = status;
+  }
+
+  @Override
+  public String toString() {
+    return String.format("%nMessage : '%s'%nHttp Status: '%s'", getMessage(), status);
+  }
+}

src/main/java/io/ipdata/client/model/Asn.java

@@ -0,0 +1,14 @@
+package io.ipdata.client.model;
+
+import lombok.Getter;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+@ToString @Getter @Accessors(fluent = true)
+public class Asn {
+  private String asn;
+  private String name;
+  private String domain;
+  private String route;
+  private String isp;
+}