Merge pull request #28 from what3words/staging

1.0.0

Author: mani-apps

.circleci/config.yml

@@ -0,0 +1,101 @@
+version: 2.1
+orbs:
+  gradle: circleci/gradle@3.0.0
+  android: circleci/android@2.3.0
+
+jobs:
+  build-assemble:
+    executor:
+      name: android/android-machine
+      tag: 2023.11.1
+      resource-class: xlarge
+    steps:
+      - checkout
+      - restore_cache:
+          key: jars-{{ checksum "build.gradle" }}
+      - run:
+          name: Set Up
+          command: | 
+            ./gradlew wrapper
+      - save_cache:
+          paths:
+            - ~/.gradle
+          key: jars-{{ checksum "build.gradle" }}
+      - run:
+          name: API Wrapper Sample Assemble builds
+          command: |
+            ./gradlew api-wrapper-sample:assembleRelease
+      - run:
+          name: OCR Sample Assemble builds
+          command: |
+            ./gradlew ocr-sample:assembleRelease
+      - run:
+          name: Auto Suggest Sample builds
+          command: |
+            ./gradlew autosuggest-sample:assembleRelease
+      - run:
+          name: Auto Suggest Sample Voice builds
+          command: |
+            ./gradlew autosuggest-sample-voice:assembleRelease
+      - run:
+          name: Multi Component Sample Assemble builds
+          command: |
+            ./gradlew multi-component-sample:assembleRelease
+      - store_artifacts:
+          path: api-wrapper-sample/build/outputs/apk/release
+      - store_artifacts:
+          path: ocr-sample/build/outputs/apk/release
+      - store_artifacts:
+          path: autosuggest-sample/build/outputs/apk/release
+      - store_artifacts:
+          path: autosuggest-sample-voice/build/outputs/apk/release
+      - store_artifacts:
+          path: multi-component-sample/build/outputs/apk/release
+  build-ui-test:
+    executor:
+      name: android/android-machine
+      tag: 2023.11.1
+      resource-class: xlarge
+    steps:
+      - checkout
+      - run:
+            name: Config emulator
+            command: |
+              cp -rf multi-component-sample/src/androidTest/resources/custom.png /opt/android/sdk/emulator/resources
+              cp -rf multi-component-sample/src/androidTest/resources/Toren1BD.posters /opt/android/sdk/emulator/resources
+      - restore_cache:
+          key: jars-{{ checksum "build.gradle" }}
+      - android/create-avd:
+          avd-name: testDevice
+          system-image: system-images;android-34;google_apis_playstore;x86_64
+          install: true
+      - android/start-emulator:
+          avd-name: testDevice
+          no-window: true
+          camera-back: virtualscene
+          restore-gradle-cache-prefix: v1a
+          post-emulator-launch-assemble-command: echo "Emulator Started"
+      - run:
+          name: Set Up
+          command: |
+            ./gradlew wrapper
+      - save_cache:
+          paths:
+            - ~/.gradle
+          key: jars-{{ checksum "build.gradle" }}
+      - android/run-tests:
+          test-command: ./gradlew multi-component-sample:jacocoTestReport
+          max-tries: 5
+      - store_test_results:
+          path: multi-component-sample/build/outputs/androidTest-results
+      - android/save-gradle-cache:
+          cache-prefix: v1a
+workflows:
+  build-test:
+    jobs:
+      - build-assemble:
+          context:
+            - mobile
+      - build-ui-test:
+          context:
+            - mobile

.gitignore

@@ -1,33 +1,85 @@
+# [Android] ========================
+# Built application files
+*.apk
+*.ap_
+
+# Files for the Dalvik VM
+*.dex
+
+# Java class files
+*.class
+
+# Generated files
+bin/
+gen/
+
 # Gradle files
 .gradle/
 build/
 
 # Local configuration file (sdk path, etc)
 local.properties
 
-# Log/OS Files
+# Proguard folder generated by Eclipse
+proguard/
+
+# Log Files
 *.log
 
-# Android Studio generated files and folders
-captures/
-.externalNativeBuild/
-.cxx/
-*.apk
-output.json
 
-# IntelliJ
-*.iml
+## Directory-based project format:
 .idea/
-misc.xml
-deploymentTargetDropDown.xml
-render.experimental.xml
 
-# Keystore files
-*.jks
-*.keystore
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+
+
+# [Maven] ========================
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+
+
+# [Gradle-Android] ========================
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Gradle Signing
+signing.properties
+trestle.keystore
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.war
+*.ear
 
-# Google Services (e.g. APIs or Firebase)
-google-services.json
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
 
-# Android Profiling
-*.hprof
+# Misc
+/.idea/workspace.xml
+.DS_Store
+/captures
+**/*.iml
+*.class

.signing/release.jks

@@ -1,2 +1,52 @@
-# w3w-android-samples
-Multiple example apps using our wrappers and components, isolated and together.
+# <img src="https://what3words.com/assets/images/w3w_square_red.png" width="64" height="64" alt="what3words">&nbsp;Samples for what3words libraries and components
+
+This repository contains a set of individual Android Studio projects to help you learn about
+how to use what3words Library. Each sample demonstrates different use cases, complexity levels and APIs.
+
+For more information, please [read the documentation](https://developer.what3words.com/public-api).
+<br><br>
+### Gradle Properties
+
+```groovy
+MAPBOX_DOWNLOADS_TOKEN = YOUR_MAPBOX_DOWNLOADS_TOKEN
+MAPBOX_ACCESS_TOKEN = YOUR_MAPBOX_ACCESS_TOKEN
+MAPS_API_KEY = YOUR_GOOGLE_MAP_API_KEY
+PROD_API_KEY = YOUR_W3W_PRODUCTION_KEY
+```
+
+To obtain an PROD_API_KEY key, please visit https://what3words.com/select-plan and sign up for an account. That used for what3words library.
+
+MAPBOX_DOWNLOADS_TOKEN and MAPBOX_ACCESS_TOKEN for MapBox access. Please follow the quick start tutorial on the Mapbox developer portal here: https://docs.mapbox.com/android/maps/guides/install/
+
+MAPS_API_KEY for GoogleMap access. Please follow the quick start tutorial on the Mapbox developer portal here: https://developers.google.com/maps/documentation/android-sdk/start
+
+
+## Samples
+------------
+
+| Project | |
+|:-----|---------|
+|  <br><b> API Wrapper Sample </b> <br><br> A sample showing how we using what3words Android Wrapper library in autosuggest textfield search and voice search. <br><br> • Convert from coordinate to 3 words address<br>• Convert from 3 words to coordinate<br>• Search by 3 words <br>• Voice search 3 words<br><br>The library used: **[w3w-android-wrapper](https://github.com/what3words/w3w-android-wrapper)**<br><br>  **[More information](api-wrapper-sample/)**<br><br> | <img src="api-wrapper-sample/readme/SampleWrapper.png" width="320" alt="API Wrapper sample demo"> |
+|  |  |
+|  <br><b> AutoSuggest Sample </b> <br><br> A sample showing how we using what3words Components autosuggest textfield in compose and xml. <br><br> • Using Autosuggestion textfield component in compose/xml<br>• Customize voice search layout<br>• Customize picker, error message view<br>• Config result output by languague, clip to country, etc.. <br>• Config valiation input<br><br>The library used: **[w3w-android-components](https://github.com/what3words/w3w-android-components)**<br><br> **[More information](autosuggest-sample/)**<br><br> | <img src="autosuggest-sample/readme/AutoSuggestSample.png" width="320" alt="API Wrapper sample demo"> |
+|  |  |
+|  <br><b> AutoSuggest Voice Sample </b> <br><br> A sample voice only showing how we using what3words Components voice and how we customize the voice search. <br><br> • Customize the result output by voice language<br>• Config return result coordinate<br>• Config result output by languague, clip to country, etc..<br><br>The library used: **[w3w-android-components](https://github.com/what3words/w3w-android-components)**, **[w3w-android-wrapper](https://github.com/what3words/w3w-android-wrapper)**<br><br>  **[More information](autosuggest-sample-voice/)**<br><br> | <img src="autosuggest-sample-voice/readme/AutoSuggestVoiceSample.png" width="320" alt="API Wrapper sample demo"> |
+|  |  |
+|  <br><b> Mapbox Sample </b> <br><br> This is a sample show how using the what3words Map Component provides a straightforward way to add what3words to a Mapbox map and display features such as the what3words grid and what3words markers with what3words address.<br><br>• Display the what3words grid on the top of the basemap<br> • Display mapbox map with what3words Map Component <br>• Display what3words markers <br><br>The library used: **[w3w-android-map-components](https://github.com/what3words/w3w-android-map-components)**<br><br>  **[More information](mapbox-sample/)**<br><br> | <img src="mapbox-sample/readme/MapBoxSample.png" width="320" alt="API Wrapper sample demo"> |
+|  |  |
+|  <br><b> Google Map Sample </b> <br><br> This is a sample show how using the what3words Map Component provides a straightforward way to add what3words to a Google Map and display features such as the what3words grid and what3words markers with what3words address.<br><br>• Display the what3words grid on the top of the basemap <br> • Display google map with what3words Map Component <br>• Display what3words markers <br><br>The library used: **[w3w-android-map-components](https://github.com/what3words/w3w-android-map-components)**<br><br>  **[More information](maps-googlemaps-sample/)**<br><br> | <img src="maps-googlemaps-sample/readme/GoogleMapSample.png" width="320" alt="API Wrapper sample demo"> |
+|  |  |
+|  <br><b> OCR Sample </b> <br><br> This is a sample show how using the what3words OCR Component to detect 3 words adrress<br><br>• Launch OCR scanner in screen <br>• Launch OCR scanner as pop up<br>• Config language for detection  <br><br>The library used: **[w3w-android-ocr-components](https://github.com/what3words/w3w-android-ocr-components)**<br><br>  **[More information](ocr-sample/)**<br><br> | <img src="ocr-sample/readme/OCRSample.png" width="320" alt="API Wrapper sample demo"> |
+|  |  |
+|  <br><b> Multi Component Sample </b> <br><br>A sample combines fully what3words components such as autosuggest text filed, voice, map, and OCR scanner to demonstrate full flow how using in the real case by showing feature searching by text field, voice, OCR scan and prepopulate to map.<br><br>• Integrate autosuggest textfiled with voice search <br>• Intergrate map component for GoogleMap and Mapbox<br>• Intergrate the OCR scanner<br><br>The library used:  **[w3w-android-wrapper](https://github.com/what3words/w3w-android-wrapper)**, **[w3w-android-map-components](https://github.com/what3words/w3w-android-map-components)**, **[w3w-android-ocr-components](https://github.com/what3words/w3w-android-ocr-components)**<br><br>  **[More information](multi-component-sample/)**<br><br> | <img src="multi-component-sample/readme/MultiComponentsSample.png" width="320" alt="API Wrapper sample demo"> |
+|  |  |
+
+
+### Full what3words library repositories:
+
+| Name                       | Repository |
+|----------------------------|----|
+| w3w-android-wrapper        |https://github.com/what3words/w3w-android-wrapper
+| w3w-android-components     |https://github.com/what3words/w3w-android-components
+| w3w-android-map-components |https://github.com/what3words/w3w-android-map-components
+| w3w-android-ocr-components |https://github.com/what3words/w3w-android-ocr-components

README.md

@@ -0,0 +1,2 @@
+/build
+/release/