= AppStore

== DESCRIPTION
AppStore is an unofficial implementation of the Apple AppStore API.
It provides way to search for applications, navigate through categories.

== SYNOPSIS
=== Examples
* Simple search
   @applications = AppStore::Application.search('upnp')
   @applications.class            # => Array
   @applications.length           # => 8
   @applications.first.title      # => "PlugPlayer"
   @applications.first.price      # => 4.99

* Find an application by its id
   @fontpicker = AppStore::Application.find_by_id(327076783)
   @fontpicker.class             # => AppStore::Application
   @fontpicker.title             # => "FontPicker"
   @fontpicker.price             # => 0.0
   @fontpicker.company.title     # => "Etienne Segonzac"

* User reviews
   @remote = AppStore::Application.find_by_id(284417350)
   @remote.title                # => "Remote"
   @remote.user_reviews.length  # => 10

   @review = @remote.user_reviews.first

   @review.user_name            # => "Ebolavoodoo on Aug 27, 2009"
   @review.average_user_rating  # => 1.0
   @review.text                 # => "Simply amazing. My new favorite app. Instantly responds. Easy to navigate and control. For those who say it doesn't work. Stinks to be you."

* Categories
   # Fetch featured categories
   @categories = AppStore::Category.featured
   @categories.class              # => Array
   @categories.length             # => 20
   
   # Use category
   @category = @categories.first
   @category.title                # => "Games"
   @category.item_count           # => 1573
   
   # Go through subcategories and applications
   @subcategory = @category.items.last
   @subcategory.class             # => AppStore::Category
   @subcategory.title             # => "Word"
   @subcategory.items.length      # => 26
   @subcategory.items.first.class # => AppStore::Application
   @subcategory.items.last.class  # => AppStore::Category
   @subcategory.items.last.title  # => "Twenty Five More..."

== REQUIREMENTS

* mechanize gem
* plist gem

== INSTALL
  gem install app_store

== TODO
* handle medias (screenshots, icons, ...)
* optimize navigation through lists
* handle 'links' to avoid calling AppStore API for each items in a list
* use FakeMechanize to unit test each calls
* handle multiple store/language

== LICENSE

(The MIT License)

Copyright (c) 2009, Fabien Jakimowicz <fabien@jakimowicz.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.