Popular Movies

An Android application that displays a list of movies and details about them. The information is retrieved from themoviedatabase.org, using their RESTful API. So, in order to build and use this project, you'll need to get a key and place it in the configuration properties file app/src/main/res/raw/configuration.xml.

This application was developed as an assignment for Udacity's Android Developer Nanodegree. A list of features that may be added in future versions can be found at TODO.md.

Configuration

Before you build the application, edit app/src/main/res/raw/configuration.xml and add your access key for themoviedatabase.org's RESTful API. For example:

...
<entry key="api_key">4N4W350M3K3Y</entry>
...

Building the application

Requirements:

Java SE Development Kit 8. This project uses Java 8's lambda syntax, so a lower version may not be used.
Android SDK

Compiling and installing

Important: If you're using [Android Studio] (http://developer.android.com/tools/studio/index.html), make sure you have the latest version, and if the project shows error when you open it, clean the project and if needed, rebuild it. That is, go to Build > Clean Project, and if errors are still reported execute Build > Rebuild Project.

This project uses Gradle and the different build tasks may be executed using the provided Gradle Wrapper scripts. For example, to list the available tasks you may execute:

$ ./gradlew tasks

You may create the APK by invoking:

$ ./gradlew assembleDebug

$ ./gradlew build

The resulting APK may be found at app/build/outputs.

Frameworks and libraries used

This application uses the following frameworks and libraries:

[Data Binding Library] (https://developer.android.com/tools/data-binding/guide.html) to follow the Model-View-ViewModel pattern. More information can be found in the following articles:
- [Android databinding: Goodbye presenter, hello ViewModel!] (http://tech.vg.no/2015/07/17/android-databinding-goodbye-presenter-hello-viewmodel/)
- [Don't forget the View Model!] (http://tech.vg.no/2015/04/06/dont-forget-the-view-model/)
Retrofit to consume the RESTful API.
Picasso to download, cache and display images.
Dagger 2 for dependency injection.
Retrolambda in order to use Java 8's lambda syntax.
EventBus to handle communication between Fragments and Activities.
Parceler to generate Parcelable wrappers of domain model classes.
Commons Lang for common tasks, like implementing equals, hashCode and toString.

Notes

The cached movie data and RESTful API configuration information are kept for a maximum of 24 hours, since the documentation suggests [checking for updates every few days] (http://docs.themoviedb.apiary.io/#reference/configuration), and the lists are updated daily.

Licencing and attributions

For licencing information, read LICENSE.txt and NOTICE.txt.

Copyright 2015 Jesús Adolfo García Pasquel

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

adolfogp/PopularMovies