Project 2 - NYTSearch

NYTSearch is an android app that allows a user to search for articles on web using simple filters. The app utilizes New York Times Search API.

Time spent: 25 hours spent in total

User Stories

The following required functionality is completed:

• User can search for news article by specifying a query and launching a search. Search displays a grid of image results from the New York Times Search API.
• User can scroll down to see more articles. The maximum number of articles is limited by the API search.
• User can tap on any image in results to see the full text of article full-screen

The following optional features are implemented:

• Used the ActionBar SearchView or custom layout as the query box
• User can share an article link to their friends or email it to themselves
• Improved the user interface and experiment with image assets and/or styling and coloring
• User can click on "settings" which allows selection of advanced search options to filter results
  • User can configure advanced search filters such as:
    • Begin Date (using a date picker)
    • News desk values (Arts, Fashion & Style, Sports)
    • Sort order (oldest or newest)
  • Subsequent searches have any selected filters applied to the results
  • Uses a lightweight modal dialog for filters rather than an activity
• Replaces the default ActionBar with a Toolbar.
• Apply the popular Butterknife annotation library to reduce view boilerplate.
• Replace GridView with the RecyclerView and the StaggeredGridLayoutManager to improve the grid of image results displayed.
• Use Parcelable instead of Serializable leveraging the popular Parceler library.
• Replace Picasso with Glide for more efficient image rendering.
• Before an article search is triggered by the user, displays the current top stories of the day by default.
• Hides the Toolbar at the top as the user scrolls down through the results using the CoordinatorLayout and AppBarLayout.
• Leverage the popular GSON library to streamline the parsing of JSON data and avoid manual parsing.

The following additional features are implemented:

• Toolbar title changes to reflect most recent query
• Change number of columns depending on orientation
• Changed launcher icon
• Date picker initializes to previously set date

Video Walkthrough

Here's a walkthrough of implemented user stories:

GIF created with LiceCap.

Notes

Since I used a Dialog Fragment instead of a new activity for my filters, I did not have a reason to implement Serializable or Parcelable. It was difficult to diagnose issues with API Rate Limit errors when using the Article Search API. Working between fragments was also a bit of a challenge with the listener implementation. I could not figure out how to use 2 separate date pickers in a single fragment with another fragment as the listener since the listener could not differentiate between the two date pickers.

Open-source libraries used

• Android Async HTTP - Simple asynchronous HTTP requests with JSON parsing
• Picasso - Image loading and caching library for Android

License

Copyright [2016] [Kristina Shia]

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.