urmichm / places-placesearch-ktx

Kotlin library to use Place Search from Google Places API

Places | Place Search KTX

Description

This repository contains Kotlin extensions (KTX) for:

1. The Places SDK for Android

It enables you to use Place Search API.

Requirements

• API level 18+
• Places SDK through Google Play Services

Installation

In order to use the library, include the following dependency:

dependencies {
      implementation 'com.urmich.android:placesearch-ktx:1.1.0'
 }

The result of the API call can be converted into a set of Place objects. Such conversion accelerates the usage of Place Search and integrates the package into Place Details SDK. Do not forget to have Google Places library included.

dependencies {
    implementation 'com.google.android.libraries.places:places:2.6.0'
}

Update the local.properties file in your root directory (Note: this file should NOT be under version control to protect your API key) and add a single line to local.properties that looks like PLACES_API_KEY="YOUR_API_KEY", where YOUR_API_KEY is the API key you obtained in the first step. You can also take a look at the local.defaults.properties as an example. This is the same key you created to use Places SDK.

Demo App

A demo application is contained within this repository that illustrates the use of this KTX library.

To run the demo app, you'll have to:

1. Get a Places API key
2. Update the local.properties file in your root directory and add lines to local.properties that looks like PLACES_API_KEY="YOUR_API_KEY" and MAPS_API_KEY="YOUR_MAPS_API_KEY".

• YOUR_API_KEY is the API key you obtained in the first step. It is the same key you use to access Places SDK.
• YOUR_MAPS_API_KEY is the key to the use google map. You can also take a look at the local.defaults.properties as an example.

3. Build and run

Support

Encounter an issue while using this library?

If you find a bug or have a feature request, please file an issue. Or, if you'd like to contribute, send us a Pull Request.

For more information, check out the detailed guide on the Google Developers site.

places-placesearch-ktx's Issues

Getters and Setters for Nearby

Add Getters and Setters for NearbySearch

Copyright header

Add copyright header

Maven

Deploy to maven

Remove import wildcard

remove wildcard

import com.urmich.android.placesearchktx.*

Gradle Plugins

add coveralls

Find Place Module

Create a module and structure for the Find Place Module

Single Container Class

In a separate issue, think of adding a common class for :

• TextSearchContainer
• NearbySearchContainer
• FindPlaceContainer

All containers have:

• htmlAttributions (except FindPlaceContainer, but could be made nullable)
• results ( aka candidates in FindPlaceContainer, but we can use @JSON(name="candidates") to overcome this)
• status
• errorMessage
• infoMessages
• nextPageToken (except FindPlaceContainer, but could be made nullable)

A single container class would make it possible to make an abstract class with abstract call() method for all PlaceSearch classes

Originally posted by @urmichm in #33 (comment)

test pipeline

No Warnings Build

Warning to be removed

NearbySearch.kt: (273, 13): Non exhaustive 'when' statements on enum will be prohibited in 1.7, add 'null' branch or 'else' branch instead

Example App

Create a simple ExampleApp

proper refactor

do proper refactor
think about abstract classes

NearbySearch

Create builder for nearbySearch with all the parameters

Tag on logs

Current log is visible as follows:

I/System.out: WARN: Vicinity is used as address

add pipeline

add pipeline to build android Gradle on push

update readme

as Google Place

Build Google Place object based on the data received

Vicinity vs Address

Compare Vicinity and Address fields

New Issue

Describe your issue here

delete .idea

delete .idea directory

Place object

Compare Place objects
Text Search
Find Place
Search Nearby

WARN

Remove Warnings

Open Now

Double test openNow boolean

Update README

Update README with screenshots of the Demo app

places-ktx

Make it similar to places-ktx

PhotoMetadata from Container

PhotoMetadataContainer to convert into PhotoMetadata

 PhotoMetadata.builder(this.photoReference)
             .setAttributions(this.attributions[0])

Triggers exception:

Exception in thread "CoroutineScheduler-worker-2" java.lang.RuntimeException: Stub!
 at android.text.TextUtils.isEmpty(TextUtils.java:59)
 at com.google.android.libraries.places.api.model.PhotoMetadata$Builder.build(com.google.android.libraries.places:places@@2.5.0:4)
 at com.github.urmichm.diana.containers.PhotoMetadataContainer.toPhotoMetadata(PhotoMetadataContainer.kt:22)

All fileds

Introduce all the fields into the code

Text Search Module

Implement TextSearch Module

tests

Test and clean existing code

Refactor Repo

Refactors such as:
NEARBY_SEARCH_URL to be named as PLACE_SEARCH_URL and make it const

rename library

rename library
proposed names

• places-placesearch-ktx
• android-places-placesearch-ktx
• places-place-search-ktx
• place-search-ktx
• android-placesearch-ktx
• android-place-search-ktx

Questions! Questions that need answering!

Originally posted by @urmichm in #18 (comment)

version 1.1.0

Update readme and version, 1.1.0 is now available with

implementation 'com.urmich.android:placesearch-ktx:1.1.0'