The Music MiniPlayer for Beats Music™ is an example application demonstrating how developers can utilitze the new Beats Music API to perform various tasks. These tasks include sign in, search, fetching images, performing API requests using AFNetworking, and caching results into a Core Data store with MagicalRecord.
The sign in flow is done using a webview to go through the oAuth 2.0 flow and extract the auth token for your application to use for making authorized API requests.
The DSYSearchViewController demonstrates how you could implement a search-as-you-type feature for albums and populate a tableview with the results.
The DSYAPIClient demonstrates how to load images from the Beats Music API's various image endpoints. These images are used to display playlist, album, and track art covers.
The DSYFullScreenViewController demonstrates how to provide an alternate full screen mode for the currently selected track. It displays the track artist's cover photo, the track's album cover, and track's title and artist name.
Since AFNetworking is one of the most widely used networking frameworks around for iOS and Mac we've utilized it to build the DSYAPIClient class to communicate with the Beats Music API. The DSYAPIClient subclasses the AFHTTPRequestOperationManager and provides an asynchronous, block-based class to perform authorized requests with the Beats Music API.
To build the project there are a few things you need to get it running on your machine.
To build this project you must first install Cocoapods. Cocoapods is a dependency manager similar to npm for node that helps developers quickly integrate third party libraries and frameworks into their projects.
If you don't want to use Cocoapods then please note you will have to resolve the following dependencies yourself:
MiniPlayer
- AFNetworking
- MagicalRecord
MiniPlayerTests
- AFNetworking
- MagicalRecord
- Expecta
- Specta
To install Cocoapods, first make sure you have Ruby installed on your machine (on OSX Ruby will be installed by default), and then run the following commands:
sudo gem install cocoapods
Once Cocoapods is installed you can install the required third party frameworks by running the following commands within the project's directory:
pod install
You will need to put your own API Key and Secret into the Keys.plist file. You can request an API key from developer.beatsmusic.com. The API Key is the Client ID and the Secret is the Client Secret.
Documentation is provided for the project using appledoc. The project contains a Generate Documentation target that will install the docset into Xcode.
To install appledoc run the following commands:
- Clone the appledoc repo
git clone git://github.com/tomaz/appledoc.git - Navigate to the cloned appledoc directory
cd appledoc/ - Run the installation script
sudo sh install-appledoc.sh
See the LICENSE file for license rights and limitations (BSD-3-Clause).
Enjoy!