Initial commit v1.0.0.

Author: epool

.idea/dictionaries/epool.xml

@@ -0,0 +1,103 @@
+# IpApiKlient
+
+This is a utility written in [Kotlin](http://kotlinlang.org/) for checking ip's info by fetching the [ip-api.com](http://ip-api.com/) API.
+
+## Libraries
+
+This project uses the following libraries internally to work.
+
+### Development libraries
+
+- [Retrofit](http://square.github.io/retrofit/) used to consume the Picasa api.
+- [Retrofit Gson Converter](https://github.com/square/retrofit/tree/master/retrofit-converters/gson) converter to deserialize JSON responses from the picasa api.
+- [RxJava2](https://github.com/ReactiveX/RxJava) async requests.
+- [Okhttp Logging Interceptor](https://github.com/ReactiveX/RxJava) for logging http requests/responses for the Picasa api.
+
+### Testing libraries
+
+- [Spek](http://spekframework.org/) Used to write some integration tests as specs.
+
+## Usage
+
+### Dependency
+
+```groovy
+repositories {
+    ...
+    maven { url 'https://jitpack.io' }
+    ...
+}
+
+dependencies {
+    ...
+    implementation "com.github.epool:ip-api-klient:1.0.0"
+    ...
+}
+```
+
+### Blocking
+
+Use it when blocking is safe to use like on web servers.
+
+###### Java
+
+```java
+IpCheckResult ipCheckResult = IpApiKlient.getIpInfo("8.8.8.8").blockingGet();
+if (ipCheckResult.isSuccess()) {
+    IpInfo ipInfo = ipCheckResult.getIpInfo();
+} else {
+    IpError ipError = ipCheckResult.getIpError();
+}
+```
+
+###### Kotlin
+
+```kotlin
+val ipCheckResult = IpApiKlient.getIpInfo("8.8.8.8").blockingGet()
+if (ipCheckResult.isSuccess()) {
+    val ipInfo = ipCheckResult.ipInfo
+} else {
+    val ipError = ipCheckResult.ipError
+}
+```
+
+### Async
+
+Use it when blocking is not safe to use like on Android main thread.
+
+###### Java
+
+```java
+IpApiKlient.getIpInfo("8.8.8.8")
+        .subscribeOn(Schedulers.io())
+        .observeOn(AndroidSchedulers.mainThread()) // In case you are using it on Android or use any other scheduler you need
+        .subscribe(
+                new Consumer<IpCheckResult>() {
+                    @Override
+                    public void accept(IpCheckResult ipCheckResult) throws Exception {
+                        System.out.println(profile.isSuccess());
+                    }
+                },
+                new Consumer<Throwable>() {
+                    @Override
+                    public void accept(Throwable throwable) throws Exception {
+                        System.out.println(throwable.getCause().toString());
+                    }
+                }
+        );
+```
+
+###### Kotlin
+
+```kotlin
+IpApiKlient.getIpInfo("8.8.8.8")
+        .subscribeOn(Schedulers.io())
+        .observeOn(AndroidSchedulers.mainThread())
+        .subscribe(
+                { println(it.isSuccess()) },
+                { println(it.cause.toString()) }
+        )
+```
+
+**NOTE:** If the ip check has an error `IpCheckResult.isSuccess()` will be false. 
+

.idea/gradle.xml

@@ -0,0 +1,85 @@
+group 'com.nearsoft'
+version '1.0.1'
+
+buildscript {
+    ext.kotlin_version = '1.2.50'
+    ext.spek_version = '1.1.5'
+    ext.ok_http_version = '3.10.0'
+    ext.retrofit_version = '2.4.0'
+    ext.rx_java_2_version = '2.1.16'
+
+    repositories {
+        mavenCentral()
+    }
+    dependencies {
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath 'org.junit.platform:junit-platform-gradle-plugin:1.0.0'
+    }
+}
+
+apply plugin: 'kotlin'
+apply plugin: 'maven'
+apply plugin: 'org.junit.platform.gradle.plugin'
+
+group = 'com.github.epool'
+
+junitPlatform {
+    filters {
+        engines {
+            include 'spek'
+        }
+    }
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    testImplementation "org.jetbrains.spek:spek-api:$spek_version"
+    testRuntime "org.jetbrains.spek:spek-junit-platform-engine:$spek_version"
+
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
+    implementation "com.squareup.okhttp3:logging-interceptor:$ok_http_version"
+    implementation "com.squareup.retrofit2:retrofit:$retrofit_version"
+    implementation "com.squareup.retrofit2:converter-gson:$retrofit_version"
+    implementation "com.squareup.retrofit2:adapter-rxjava2:$retrofit_version"
+    implementation "io.reactivex.rxjava2:rxjava:$rx_java_2_version"
+}
+
+compileKotlin {
+    kotlinOptions.jvmTarget = "1.8"
+}
+compileTestKotlin {
+    kotlinOptions.jvmTarget = "1.8"
+}
+
+task sourcesJar(type: Jar, dependsOn: classes) {
+    classifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    classifier = 'javadoc'
+    from javadoc.destinationDir
+}
+
+artifacts {
+    archives sourcesJar
+    archives javadocJar
+}
+
+// To specify a license in the pom:
+install {
+    repositories.mavenInstaller {
+        pom.project {
+            licenses {
+                license {
+                    name 'The Apache Software License, Version 2.0'
+                    url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+                    distribution 'repo'
+                }
+            }
+        }
+    }
+}

.idea/misc.xml

@@ -0,0 +1,6 @@
+#Sun Jul 01 14:32:38 CDT 2018
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip