Giter VIP home page Giter VIP logo

codepath-project2-nyt-article-search's Introduction

Project 2 - Week2 Assignment

New York Times Search API 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: 18 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 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 filters applied to the search results
  • User can tap on any article in results to view the contents in an embedded browser.
  • User can scroll down to see more articles. The maximum number of articles is limited by the API search.

The following optional features are implemented:

  • Implements robust error handling, check if internet is available, handle error cases, network failures
  • Used the ActionBar SearchView or custom layout as the query box instead of an EditText
  • User can share an article link to their friends or email it to themselves
  • Replaced Filter Settings Activity with a lightweight modal overlay
  • Improved the user interface and experiment with image assets and/or styling and coloring

The following bonus features are implemented:

The following additional features are implemented:

  • List anything else that you can get done to improve the app functionality!
  • Clear Advanced Search Option Setting
  • Use toast to notify user on Network Error, Advance Setting Saved, Advance Setting Cleard to make user experience smothly.

Video Walkthrough

Here's a walkthrough of implemented user stories:

Video Walkthrough

Imgur

GIF created with LiceCap.

Notes

Describe any challenges encountered while building the app.

  1. Where is the better plance to implement AsyncTask which include OkHttpClient network operations? I was using option 2 in last assignment; however I found the doInBackground operations in my Ansy task will be reused in in different activity. This time I try the option 1; after that, I realized that when I try to reapint (or notify) UI changes it introduced a piece of coupling code related to my Activity. That make me feel option 2 is not a right way to do. Anyone have some suggestion on how to better use of Async task? Thank you so much. (option 1) To create a client (e.g. NYTClient) and then crate a static inner class to extends AsyncTask? (option 2) To create a static inner class to extends AsyncTask at the Activity class.

[Resolved] In the end , I leveraged the asynchronous OkHttpClient to keep the UI coupling call in the Activity class. In the mean time , I wrapped the complexity of OkHttpClient, Request Builder,HttpUrlBuilder, and New York Times API parameters in NYTClient to decouple (also increase reusability) the networking code with UI code.

Open-source libraries used

  • Android Async HTTP - Simple asynchronous HTTP requests with JSON parsing
  • Picasso - Image loading and caching library for Android
  • [parceler]
  • [glide]
  • [okhttp]
  • [stetho]
  • [butterknife]

License

Copyright [2017] [name of copyright owner]

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.