This repository holds the source code of the Marvel Application, a simple Android client for the Marvel.com. This application was created by Mohsen Mirhoseini Argi, as part of the technical assessment by the smava GmbH team.
- Marvel Application
-
Version: 1.0 - Last Update: Fri Oct 21, 2016
- Android Studio v2.2.1
- gradle-plugin v2.2.1
- Android SDK Build Tools v25.0.0
- MinSdkVersion 9
- CompileSDKVersion 25
- Retrolambda v3.3.1
- Android Support Tools (recyclerView, cardView, vector, palette,... ) v25.0.0
- Retrofit v2.1.0
- OkHttp v3.4.1
- Dagger v2.8
- RxJava v1.2.3
- RxAndroid v1.2.1
- RxBinding v1.0.0
- ButterKnife v8.4.0
- Timber v4.3.1
- Picasso v2.5.2
- OrmLite v5.0
- Firebase v9.6.1
- AndroidUtils v1.0.7
- jUnit v4.12
- Android Support Test v0.5
- Mockito v1.10.19
- Robolectric v3.1-rc1
- Espresso v2.2.2
The application has two Activities, Main and Character Activities. The Main Activity is consist of two Fragments, Search and Cache Fragments, which are responsible for searching new Mavel characters and presenting recent searched characters.
All activity lifecycle and network behaviours are implemented, and according to device size and network situation user get a good UI and UX. If no internet connection or network error, a Snackbar pops up and ask user to turn on network connection or retry.
Some simple Test Cases was designed to test application UI functionality and core classes using jUnit and AndroidUnitTest.
The Application implemented and structured bases on the MVP pattern best practice, contributed by Antonio Leiva.
Whole application functionality is implemented in "Core-Lib" module using pure Java, and .the "App" module contain all codes required for Android Application to load on Android OS, which can be replace by any other interface (e.g. console app or web app)
The view (MainActivity), contain two fragments. Search and Cache fragments both contain their own presenter and implement View interfaces and the only thing that the view will do is calling a method from the presenter every time there is an interface action.
The presenter (Search or Cache Presenters), are responsible to act as the middle man between views and models. They retrieves data from the Model or Database and returns it formatted to the view. It also decides what happens when user interact with the view.
The models (Search Interactor), would only be the gateway to the service domain layer or business logic. In this case it provide the data needed to be displayed in the view from Network.
The networking and API call are managed by Retrofit and OkHttp as its httpclient, contributed by Square. It also shows decent logs while application is running in Debug mode.
Caching characters data is done using OrmLite, a Lightweight Object Relational Mapping (ORM) Java Package. Database layer can also be done using other ORM libraries like realm or DBFlow.
Layers communications are managed by RxJava & RxAndroid contributed by ReactiveX.
Dependency Injections are being managed by Dagger created by Square and now maintained by Google.
Some minor Android common functions are managed using AndroidUtils library, developed and published on jCenter by myself.
Whole projects Dependencies are placed in "libraries.gradle" to avoid version conflicts and redundant in different modules.
Used new DataBinding library contributed by Google in Adapters for faster development, and added CustomBindingAdapter to handle downloading and caching images using Picasso library, which also use google Palette support library as a helper class to extract prominent colors from image and making a related background for a better UI/UX.
The Android Log system is replaced with Timber contributed by Jake Wharton, which avoid logging in release version.
A general HashGenerator class generates the hash key required for calling API using params.
Used new SupportVector library in some icons cases for a better UI.
Used new Google Firebase as application Analytics and CrashReport services.
Sample test cases are implemented by mockito, espresso, robolectric and mocking dagger.
Finally, used circleci and travis ci as Continues Integration services which are bind with Github repo.
You can read more about this sample project in this 5-part article: