Release 0.0.1

Author: nikolaseu

.codecov.yml

@@ -0,0 +1,14 @@
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+  status:
+    patch:
+      default:
+        if_no_uploads: error
+    changes: true
+    project:
+      default:
+        target: auto
+        if_no_uploads: error
+comment: false

.gitignore

@@ -122,4 +122,3 @@ modules.xml
 
 # End of https://www.gitignore.io/api/intellij+iml
 
-.idea/*

.idea/.name

@@ -0,0 +1,20 @@
+language: java
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+sudo: false
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/
+script:
+  - "./gradlew clean check jacocoTestReport --continue"
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+branches:
+  only:
+  - master

.idea/compiler.xml

@@ -0,0 +1,106 @@
+# Change Log
+
+## [0.0.1](https://github.com/auth0/Guardian.java/tree/0.0.1) (2017-03-10)
+
+First release of Guardian for Java
+
+### Install
+
+Get Guardian Java via Maven:
+
+```xml
+<dependency>
+  <groupId>com.auth0</groupId>
+  <artifactId>guardian</artifactId>
+  <version>0.0.1</version>
+</dependency>
+```
+
+or Gradle:
+
+```gradle
+compile 'com.auth0:guardian:0.0.1'
+```
+
+### Usage
+
+Create an instance of `Guardian` using you Guardian URL:
+
+```java
+Guardian guardian = new Guardian("https://<tenant>.guardian.auth0.com");
+```
+
+Obtain an enrollment ticket from API2:
+
+```java
+String enrollmentTicket = "Ag1qX7vZVBvyTKhFwrkzaCH2M8vn5b6c";
+```
+
+#### Enrollment
+
+Use the ticket and `EnrollmentType.TOTP()` to request an TOTP enrollment, or `EnrollmentType.SMS()` and the phone number
+for an SMS enrollment.
+
+For TOTP you must ask for the TOTP URI to show to the user in the QR code.
+
+```java
+Transaction enrollmentTransaction;
+try {
+    enrollmentTransaction = guardian
+            .requestEnroll(enrollmentTicket, EnrollmentType.TOTP());
+            // or .requestEnroll(enrollmentTicket, EnrollmentType.SMS("+549XXXXXXXX58"));
+
+    // Only for TOTP: use the TOTP URI to create a QR and scan with an app
+    String totpURI = enrollmentTransaction.totpURI("Username", "Issuer");
+    System.out.println(totpURI);
+
+} catch (IOException e) {
+    // connection issue, might be internet (or invalid certificates for example)
+} catch (GuardianException e) {
+    if (e.isAlreadyEnrolled()) {
+        // the user was already enrolled
+    } else if (e.isInvalidToken()) {
+        // the ticket is not valid anymore, or was already used
+    } else {
+        // some other guardian error, check the message
+    }
+}
+```
+
+#### Transaction storage
+
+`Transaction` implements `java.io.Serializable` interface so you can save and restore it easily.
+
+> The transaction contains sensitive information like the transaction token and the recovery code. Keep in mind this
+> when considering possible storage options.
+
+#### Confirm enrollment
+
+Restore the enrollment transaction from wherever you saved it, and use it together with the OTP that the user inputs to
+confirm the enrollment, whether it's TOTP or SMS.
+
+If the OTP was valid, the enrollment is confirmed and you get an object that contains the recovery code.
+
+```java
+// get the OTP from SMS or TOTP app
+String code = "123456";
+
+try {
+    Enrollment enrollment = guardian.confirmEnroll(enrollmentTransaction, code);
+
+    // Get the recovery code and show to the user
+    String recoveryCode = enrollment.getRecoveryCode();
+    System.out.println(recoveryCode);
+
+} catch (IOException e) {
+    // connection issue, might be internet (or invalid certificates for example)
+} catch (GuardianException e) {
+    if (e.isInvalidToken()) {
+        // the transaction is not valid anymore
+    } else if (e.isInvalidOTP()) {
+        // the OTP is not valid
+    } else {
+        // some other guardian error, check the message
+    }
+}
+```

.idea/vcs.xml

@@ -78,7 +78,7 @@ For SMS use `EnrollmentType.SMS()` and the phone number instead:
 Transaction enrollmentTransaction;
 try {
     enrollmentTransaction = guardian
-            .requestEnroll(enrollmentTicket, EnrollmentType.SMS("+5493424217158"));
+            .requestEnroll(enrollmentTicket, EnrollmentType.SMS("+549XXXXXXXX58"));
 
 } catch (IOException e) {
     // connection issue, might be internet (or invalid certificates for example)

.travis.yml

@@ -7,7 +7,7 @@ logger.lifecycle("Using version ${version} for ${name}")
 
 oss {
     name 'guardian'
-    repository 'guardian-java'
+    repository 'Guardian.java'
     organization 'auth0'
     description 'Java library for Auth0\'s Guardian platform.'
 

CHANGELOG.md

@@ -36,7 +36,7 @@ public static void main(String[] args) {
         Transaction enrollmentTransaction = null;
         try {
             enrollmentTransaction = guardian
-                    //.requestEnroll(enrollmentTicket, EnrollmentType.SMS("+5493424217158"));
+                    //.requestEnroll(enrollmentTicket, EnrollmentType.SMS("+549XXXXXXXX58"));
                     .requestEnroll(enrollmentTicket, EnrollmentType.TOTP());
 
             // Only for TOTP: use the TOTP URI to create a QR and scan with an app