Initial commit

Author: gregcoxdev

.idea/compiler.xml

@@ -1,55 +1,32 @@
-# Weedmaps Android Code Challenge!
-
-Hi there!  Thank you for taking the time to conduct the Weedmaps Android code challenge.  Please use this as a foundation to help you save time setting up your workspace; this project already contains some common dependencies and frameworks used in most Android projects.  
-**If there are other dependencies and/or frameworks that you'd like to introduce/use please feel free to add them!**
-
-# Dependencies
- - Kotlin Ext
- - Kotlin Coroutines
- - Mockito Kotlin
- - Koin
- - Retrofit
- - Moshi
- - Glide
-
-## First Things First
-Register and get a token for the Yelp Fusion API [https://www.yelp.com/developers/documentation/v3/authentication](https://www.yelp.com/developers/documentation/v3)
+# Introduction
+Hi there! Thank you for taking the time to conduct the Weedmaps Android code challenge! A project template has been provided for you. Please focus on meeting the requirements, if you’d like to showcase additional skills you may feel free to do so although it is not expected. Feel free to take any creative liberties with interface design so long as they do not deviate from the requirements of the challenge.
+
+## Expected Time Commitment
+We ask candidates to allocate **4-6 hours** for this assignment. Keep in mind this doesn’t have to be all in one sitting. You may spend no longer than **5 days** to complete this assignment, however if more time is needed please reach out!
+
+# Overview
+Leveraging the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro), build an app that displays businesses based on the user’s input in the search field. Follow the [instructions here](https://docs.developer.yelp.com/docs/fusion-authentication) to obtain an API Key for the Yelp Fusion API (don’t be worried about hard-coding the key into your app for this assignment). You may use the [designs here](https://www.figma.com/file/vcfmVmKtPf4hPwIm12jfQ5/Android-Homework?type=design&node-id=2-9&mode=design&t=EXoeVDU6A6rwhxmO-0) as a guideline for your interface. For your UI, please utilize [Jetpack Compose](https://developer.android.com/jetpack/compose) if possible, and avoid using any 3rd party UI frameworks. If you aren’t familiar with Compose, feel free to write in Android XML instead. Do not feel obligated to utilize all the properties and stubs in the project template.
+
+## Dependencies
+- [Kotlin Extensions](https://kotlinlang.org/docs/extensions.html)
+- [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html)
+- [MockK](https://notwoods.github.io/mockk-guidebook/docs/quick/android/) (Unit Testing)
+- [Koin](https://insert-koin.io/)
+- [Retrofit](https://square.github.io/retrofit/)
+- [GSON](https://github.com/google/gson)
+- [Jetpack Compose](https://developer.android.com/jetpack/compose)
+- [Coil for Compose](https://coil-kt.github.io/coil/compose/)
+**Note:** You are free to add any other dependencies and/or frameworks that you'd like but we may ask about why you chose to include them.
 
 ## Requirements
+Requirements will differ based off of the level you are applying for. Please consult with your recruiter if you need clarification on requirements.
+**Important:** The Yelp Fusion API has a **query-per-second limit of 5**, and limited to **500 API requests per 24 hours.** Keep this in mind when configuring your API requests, otherwise you’ll receive a 429 HTTP error code for some of your requests. If you’d like, show us how you’d mitigate the query-per-second issue in your approach.
 
- 1. You will be building a simple search expereince using the yelp API. [here](https://www.figma.com/file/vcfmVmKtPf4hPwIm12jfQ5/Android-Homework?node-id=2%3A9). The data will be coming from the Yelp api linked below. Your application should return businesses based on the user's input in the search field. 
-
- 2. Each business you show in the list should include: **name of the business**, **an image of the business**, and **the top review of the business(reference [here](https://www.yelp.com/developers/documentation/v3/business_reviews) for how to get the business review)**.
- 
- ### If you are apply for a senior role, you must also: 
- 
- 3. The list must endlessly scroll based on the API's paging functionality.
- 4. Include Unit Tests for parts of your code with important functionality (no need to get 100% code coverage on the whole project).
- 
-
-## If you are applying for a senior role, please do at least 2 of the following:
- 1. Requesting the user's location and sending that up in the request
- 2. Save the list of a user's recent searchers and display those to the user as autocomplete suggestions
- 3. Provide integration tests that verify the behavior established above
- 4. Provide caching of the api requests which is invalidated after 15 days
-
-## FAQ:
- - What if a link is broken above? Please reach out and we'll get those fixed. 
- - What if I have any questions? Pretend your PM is on vacation, please use your best judgement and be able to speak as to why you made certain decisions.
- - Can I modify the designs? Yes, within reason. Stay as true to them as you can, and be prepared to explain any changes you make
- - Can I use other/additional libraries that aren't listed? Yes, just be ready to talk about them 
-
-## Notes
-
- - **Important:** The Fusion API has a **query-per-second limit of 5**. Keep this in mind when configuring your API requests, otherwise you’ll receive a 429 HTTP error code for some of your requests. It would be a good idea to throttle the speed of your subsequent network requests.
-
-## Links
-
- - [Yelp Fusion API Documentation](https://www.yelp.com/developers/documentation/v3)
-
-## Project Submission Instructions
-
-Please submit either of the following to the link from the email containing your coding HW:
-A) your completed .zip file 
-B) the link to a public repo with your completed project
+## FAQ
+- What if a link is broken above? Please reach out and we'll get those fixed.
+- What if I have any questions? Pretend your product manager is on vacation, please use your best judgment and be able to speak as to why you made certain decisions.
+- Can I modify the designs? Yes, **within reason.** Stay as true to them as you can, and be prepared to explain any changes you make.
 
+# Submission
+Clone the git repository and complete using local IDE (Android Studio). Commits and created branches will show up on HackerRank web repository viewer. Please have the final submission merged into the master branch. Submit on HackerRank when the project is completed. If HackerRank isn't being used for this assessment, either ZIP the project file or provide a link to the public repository with your completed project.
+**Note:** Disregard the "Run Tests" button on the bottom right of the HackerRank project viewer.

.idea/gradle.xml

@@ -0,0 +1,84 @@
+plugins {
+    alias(libs.plugins.android.application)
+    alias(libs.plugins.kotlin.android)
+}
+
+android {
+
+    namespace = libs.versions.applicationName.get()
+    compileSdk = libs.versions.compileSdk.get().toInt()
+
+    defaultConfig {
+
+        applicationId = libs.versions.applicationName.get()
+        minSdk = libs.versions.minSdk.get().toInt()
+        targetSdk = libs.versions.targetSdk.get().toInt()
+        versionCode = libs.versions.applicationVersion.get().toInt()
+        versionName = libs.versions.applicationVersionName.get()
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+
+        vectorDrawables {
+            useSupportLibrary = true
+        }
+
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+
+    buildFeatures {
+        compose = true
+    }
+
+    composeOptions {
+        kotlinCompilerExtensionVersion = libs.versions.kotlin.compiler.get()
+    }
+
+    packaging {
+        resources {
+            excludes += "/META-INF/{AL2.0,LGPL2.1}"
+        }
+    }
+
+}
+
+dependencies {
+
+    // LIBRARY DEPENDENCIES
+    implementation(libs.coil.compose)
+    implementation(libs.bundles.compose)
+    implementation(platform(libs.compose.bom))
+    implementation(libs.gson)
+    implementation(libs.bundles.koin)
+    implementation(libs.bundles.kotlin)
+    implementation(libs.bundles.lifecycle)
+    implementation(libs.bundles.retrofit)
+    debugImplementation(libs.bundles.compose.debug)
+
+    // UNIT TEST DEPENDENCIES
+    testImplementation(libs.bundles.unit.testing)
+    testImplementation(libs.koin.test)
+
+    // INSTRUMENTATION TEST DEPENDENCIES
+    androidTestImplementation(libs.bundles.instrumentation.testing)
+    androidTestImplementation(platform(libs.compose.bom))
+    androidTestImplementation(libs.compose.junit)
+
+}

.idea/jarRepositories.xml

@@ -1,4 +1,4 @@
-package com.ngmatt.weedmapsandroidcodechallenge
+package com.weedmaps.challenge
 
 import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
@@ -19,6 +19,6 @@ class ExampleInstrumentedTest {
     fun useAppContext() {
         // Context of the app under test.
         val appContext = InstrumentationRegistry.getInstrumentation().targetContext
-        assertEquals("com.ngmatt.weedmapsandroidcodechallenge", appContext.packageName)
+        assertEquals("com.weedmaps.challenge", appContext.packageName)
     }
 }

.idea/kotlinc.xml

@@ -1,16 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.ngmatt.weedmapsandroidcodechallenge">
+    xmlns:tools="http://schemas.android.com/tools">
 
     <application
         android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
-        android:theme="@style/AppTheme">
-        <activity android:name=".HelloWorldActivity">
+        android:theme="@style/Theme.ChallengeActivity"
+        tools:targetApi="31">
+        <activity
+            android:name=".ChallengeActivity"
+            android:exported="true"
+            android:label="@string/app_name"
+            android:theme="@style/Theme.ChallengeActivity">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
+
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>