Merge pull request #24 from firebase/geofire-2

Geofire 2.0.0

Author: abeisgoat

README.md

@@ -21,7 +21,7 @@ Android app in this repo.
 
 ### Integrating GeoFire with your data
 
-GeoFire is designed as a lightweight add-on to Firebase. However, to keep things
+GeoFire is designed as a lightweight add-on to the Firebase Realtime Database. However, to keep things
 simple, GeoFire stores data in its own format and its own location within
 your Firebase database. This allows your existing data format and security rules to
 remain unchanged and for you to add GeoFire as an easy solution for geo queries
@@ -41,6 +41,10 @@ at `/bars/<bar-id>`.
 
 ## Upgrading GeoFire
 
+### Upgrading from GeoFire 1.x to 2.x
+
+GeoFire 2.0.0 is based on the new 3.x release of [Firebase](https://firebase.google.com).
+
 ### Upgrading from GeoFire 1.0.x to 1.1.x
 
 With the release of GeoFire for Android/Java 1.1.0, this library now uses [the new query
@@ -53,31 +57,32 @@ and [read our docs for more information about indexing your data](https://www.fi
 
 ## Including GeoFire in your project Android/Java
 
-In order to use GeoFire in your project, you need to [add the Firebase Java
-SDK](https://www.firebase.com/docs/java-quickstart.html?utm_source=geofire-java).
-There are then multiple possibilities to use GeoFire in your project.
+In order to use GeoFire in your project, you need to [add the Firebase Android
+SDK](https://firebase.google.com/docs/android/setup). After that you can include
+GeoFire with one of the choices below.
+
+### Gradle
+
+Add a dependency for GeoFire to your `gradle.build` file:
+
+```groovy
+dependencies {
+    compile 'com.firebase:geofire:2.0.0'
+}
+```
 
 ### Maven
 
-Add GeoFire to your Maven enabled projects with a new dependency:
+GeoFire also works with Maven:
 
 ```xml
 <dependency>
   <groupId>com.firebase</groupId>
   <artifactId>geofire</artifactId>
-  <version>[1.1.0,)</version>
+  <version>2.0.0</version>
 </dependency>
 ```
 
-### Gradle
-
-Likewise, you can add a dependency to your `gradle.build` file:
-
-```groovy
-dependencies {
-    compile 'com.firebase:geofire:1.1.0+'
-}
-```
 
 ### Jar-File
 
@@ -88,7 +93,7 @@ page](https://github.com/firebase/geofire-java/releases).
 ## Getting Started with Firebase
 
 GeoFire requires the Firebase database in order to store location data. You can [sign up here for a free
-account](https://www.firebase.com/signup/?utm_source=geofire-java).
+account](https://console.firebase.google.com/).
 
 
 ## Quickstart
@@ -103,7 +108,8 @@ database and to create queries. To create a new `GeoFire` instance you need to a
 reference.
 
 ```java
-GeoFire geoFire = new GeoFire(new Firebase("https://<your-firebase>.firebaseio.com/"));
+DatabaseReference ref = FirebaseDatabase.getInstance().getReference("path/to/geofire");
+GeoFire geoFire = new GeoFire(ref);
 ```
 
 Note that you can point your reference to anywhere in your Firebase database, but don't
@@ -158,8 +164,8 @@ geoFire.getLocation("firebase-hq", new LocationCallback() {
     }
 
     @Override
-    public void onCancelled(FirebaseError firebaseError) {
-        System.err.println("There was an error getting the GeoFire location: " + firebaseError);
+    public void onCancelled(DatabaseError databaseError) {
+        System.err.println("There was an error getting the GeoFire location: " + databaseError);
     }
 });
 ```
@@ -229,7 +235,7 @@ geoQuery.addGeoQueryEventListener(new GeoQueryEventListener() {
     }
 
     @Override
-    public void onGeoQueryError(FirebaseError error) {
+    public void onGeoQueryError(DatabaseError error) {
         System.err.println("There was an error with this query: " + error);
     }
 });

android/pom.xml

@@ -0,0 +1,79 @@
+<?xml version="1.0"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <!-- Inherit from ../pom.xml -->
+  <parent>
+    <groupId>com.firebase</groupId>
+    <artifactId>geofire</artifactId>
+    <version>2.0.0-SNAPSHOT</version>
+    <relativePath>../</relativePath>
+  </parent>
+
+  <artifactId>geofire-android</artifactId>
+  <packaging>aar</packaging>
+
+  <name>geofire-android</name>
+  <description>GeoFire is an open-source library for Android/Java that allows you to store and query a set of keys based on their geographic location.</description>
+  <organization>
+    <name>Firebase</name>
+    <url>https://www.firebase.com/</url>
+  </organization>
+  <url>https://github.com/firebase/geofire-java</url>
+  <scm>
+    <connection>scm:git:git@github.com:firebase/geofire-java.git</connection>
+    <developerConnection>scm:git:git@github.com:firebase/geofire-java.git</developerConnection>
+    <url>https://github.com/firebase/geofire-java</url>
+  </scm>
+  <licenses>
+    <license>
+      <name>MIT</name>
+      <url>http://firebase.mit-license.org</url>
+    </license>
+  </licenses>
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+  <build>
+    <sourceDirectory>../src/main/java</sourceDirectory>
+    <plugins>
+      <plugin>
+        <groupId>com.simpligility.maven.plugins</groupId>
+        <artifactId>android-maven-plugin</artifactId>
+        <version>4.3.0</version> <!-- use latest release -->
+        <extensions>true</extensions>
+      </plugin>
+    </plugins>
+  </build>
+  <repositories>
+    <repository>
+       <id>google-extras</id>
+       <url>file://${env.ANDROID_HOME}/extras/google/m2repository</url>
+    </repository>
+    <repository>
+       <id>android-extras</id>
+       <url>file://${env.ANDROID_HOME}/extras/android/m2repository</url>
+    </repository>
+  </repositories>
+  <dependencies>
+    <dependency>
+      <groupId>com.google.firebase</groupId>
+      <artifactId>firebase-database</artifactId>
+      <version>[9.0.2,)</version>
+      <scope>provided</scope>
+      <type>aar</type>
+    </dependency>
+    <dependency>
+      <groupId>com.google.android</groupId>
+      <artifactId>android</artifactId>
+      <version>2.2.1</version>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.8.1</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>

android/src/main/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.firebase.geofire">
+  <uses-sdk
+    android:minSdkVersion="9"
+    android:targetSdkVersion="24" />
+
+  <uses-permission android:name="android.permission.INTERNET" />
+</manifest>

examples/SFVehicles/SF Vehicles/build.gradle

@@ -3,7 +3,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:1.0.0'
+        classpath 'com.android.tools.build:gradle:2.1.0'
     }
 }
 apply plugin: 'com.android.application'
@@ -14,12 +14,13 @@ repositories {
 }
 
 android {
-    compileSdkVersion 20
-    buildToolsVersion "21.1.1"
+    compileSdkVersion 23
+    buildToolsVersion "23.0.3"
 
     defaultConfig {
+        applicationId 'com.firebase.sfvehicles'
         minSdkVersion 9
-        targetSdkVersion 20
+        targetSdkVersion 23
         versionCode 1
         versionName "1.0"
     }
@@ -38,14 +39,16 @@ android {
 dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
     // You must install or update the Support Repository through the SDK manager to use this dependency.
-    compile 'com.android.support:support-v4:20.+'
+    compile 'com.android.support:support-v4:23.4.0'
     // You must install or update the Support Repository through the SDK manager to use this dependency.
-    compile 'com.android.support:appcompat-v7:20.+'
+    compile 'com.android.support:appcompat-v7:23.4.0'
+    // You must install or update the Support Repository through the SDK manager to use this dependency.
+    compile 'com.google.android.gms:play-services-maps:9.0.2'
     // You must install or update the Google Repository through the SDK manager to use this dependency.
-    compile 'com.google.android.gms:play-services:6.1.+'
-    // Firebase
-    compile 'com.firebase:firebase-client-android:2.0.+'
+    compile 'com.google.firebase:firebase-core:9.0.2'
+    compile 'com.google.firebase:firebase-database:9.0.2'
+
     // GeoFire
-    compile 'com.firebase:geofire:1.1.+'
+    compile 'com.firebase:geofire:2.0.0'
 }
 

examples/SFVehicles/SF Vehicles/src/main/java/com/firebase/sfvehicles/SFVehiclesActivity.java

@@ -8,8 +8,6 @@
 import android.support.v4.app.FragmentActivity;
 import android.view.animation.AccelerateDecelerateInterpolator;
 import android.view.animation.Interpolator;
-import com.firebase.client.Firebase;
-import com.firebase.client.FirebaseError;
 import com.firebase.geofire.GeoFire;
 import com.firebase.geofire.GeoLocation;
 import com.firebase.geofire.GeoQuery;
@@ -18,6 +16,10 @@
 import com.google.android.gms.maps.GoogleMap;
 import com.google.android.gms.maps.SupportMapFragment;
 import com.google.android.gms.maps.model.*;
+import com.google.firebase.FirebaseApp;
+import com.google.firebase.FirebaseOptions;
+import com.google.firebase.database.DatabaseError;
+import com.google.firebase.database.FirebaseDatabase;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -26,7 +28,8 @@ public class SFVehiclesActivity extends FragmentActivity implements GeoQueryEven
 
     private static final GeoLocation INITIAL_CENTER = new GeoLocation(37.7789, -122.4017);
     private static final int INITIAL_ZOOM_LEVEL = 14;
-    private static final String GEO_FIRE_REF = "https://publicdata-transit.firebaseio.com/_geofire";
+    private static final String GEO_FIRE_DB = "https://publicdata-transit.firebaseio.com";
+    private static final String GEO_FIRE_REF = GEO_FIRE_DB + "/_geofire";
 
     private GoogleMap map;
     private Circle searchCircle;
@@ -50,10 +53,11 @@ protected void onCreate(Bundle savedInstanceState) {
         this.map.moveCamera(CameraUpdateFactory.newLatLngZoom(latLngCenter, INITIAL_ZOOM_LEVEL));
         this.map.setOnCameraChangeListener(this);
 
-        Firebase.setAndroidContext(this);
+        FirebaseOptions options = new FirebaseOptions.Builder().setApplicationId("geofire").setDatabaseUrl(GEO_FIRE_DB).build();
+        FirebaseApp app = FirebaseApp.initializeApp(this, options);
 
         // setup GeoFire
-        this.geoFire = new GeoFire(new Firebase(GEO_FIRE_REF));
+        this.geoFire = new GeoFire(FirebaseDatabase.getInstance(app).getReferenceFromUrl(GEO_FIRE_REF));
         // radius in km
         this.geoQuery = this.geoFire.queryAtLocation(INITIAL_CENTER, 1);
 
@@ -110,7 +114,7 @@ public void onGeoQueryReady() {
     }
 
     @Override
-    public void onGeoQueryError(FirebaseError error) {
+    public void onGeoQueryError(DatabaseError error) {
         new AlertDialog.Builder(this)
                 .setTitle("Error")
                 .setMessage("There was an unexpected error querying GeoFire: " + error.getMessage())

examples/SFVehicles/build.gradle

@@ -5,7 +5,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:1.0.0'
+        classpath 'com.android.tools.build:gradle:2.1.0'
     }
 }
 

examples/SFVehicles/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Thu Dec 18 13:18:37 PST 2014
+#Wed Jun 08 11:39:36 PDT 2016
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-2.2.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-2.10-all.zip

java/pom.xml

@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <!-- Inherit from ../pom.xml -->
+  <parent>
+    <groupId>com.firebase</groupId>
+    <artifactId>geofire</artifactId>
+    <version>2.0.0-SNAPSHOT</version>
+    <relativePath>../</relativePath>
+  </parent>
+
+  <artifactId>geofire-java</artifactId>
+  <packaging>jar</packaging>
+
+  <name>geofire-java</name>
+  <description>GeoFire is an open-source library for Android/Java that allows you to store and query a set of keys based on their geographic location.</description>
+  <organization>
+    <name>Firebase</name>
+    <url>https://www.firebase.com/</url>
+  </organization>
+  <url>https://github.com/firebase/geofire-java</url>
+  <scm>
+    <connection>scm:git:git@github.com:firebase/geofire-java.git</connection>
+    <developerConnection>scm:git:git@github.com:firebase/geofire-java.git</developerConnection>
+    <url>https://github.com/firebase/geofire-java</url>
+  </scm>
+  <licenses>
+    <license>
+      <name>MIT</name>
+      <url>http://firebase.mit-license.org</url>
+    </license>
+  </licenses>
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+  <build>
+    <!-- Plugins inherited -->
+  </build>
+  <dependencies>
+    <dependency>
+      <groupId>com.google.firebase</groupId>
+      <artifactId>firebase-server-sdk</artifactId>
+      <version>[3.0.0,)</version>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.android</groupId>
+      <artifactId>android</artifactId>
+      <version>2.2.1</version>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.8.1</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>