Skip to content

Latest commit

 

History

History
199 lines (112 loc) · 7.04 KB

README.md

File metadata and controls

199 lines (112 loc) · 7.04 KB
Raw

GrabKit

GrabKit for iOS offers a ready-to-use component to easily import photos from social networks.

GrabKit allows you to retrieve photos from :

  • Facebook
  • FlickR
  • Picasa
  • Instagram
  • iPhone/iPad
  • ... and more to come

Abstract

In your iPhone/iPad applications, you may want to let your users access their photo albums hosted on various social networks like Facebook or FlickR, or stored in the device. Unfortunately, the websites hosting these images offer different APIs and different libraries to authentify a user, grab its photo albums, etc.

GrabKit is made to wrap these differences into :

  • a simple library : GrabKitLib
  • a simple ready-to-use component : GrabKitPicker, based on GrabKitLib

GrabKitPicker is Developer-friendly :

  • Compatible with iOS 5.1 and higher, for both iPhone and iPad, the GrabKitPicker is already compatible with your project.
  • Once you've installed and configured it, all you have to do is to present it "modally" on iPhone, or through a popover on iPad.
  • Easy to use, GrabKitPicker offers two main classes : GRKPickerViewController, and its delegate GRKPickerViewControllerDelegate.
  • Through its delegation protocol, you can easily handle the user's interactions.
  • Easy to customize, it will fit to the design of your applications.
  • Of course, GrabKitPicker uses ARC, and is full of documentation and comments.

GrabKitPicker is also User-friendly :

  • Translated in French and English so far, but soon translated in other languages. Feel free to help ! :)
  • The default interface is simple and easy to use, though heavily tested to offer the best user-experience possible.

screenshot of the demo application
Watch this demo on YouTube : http://www.youtube.com/watch?v=6sOgy_3P4Ws

Demo application

The best way to discover how powerful GrabKit is, is to run the Demo application. Only a few steps are needed to run it, just follow the detailled instructions in the wiki

How to use Grabkit in your app

Installation

To install and setup GrabKit in your project, follow the detailled instructions in the wiki

Configuration

In order to grab content from each service, you need to register your app and get an API key from each service.

Please follow the detailled instructions in the wiki

Add the GrabKitPicker in you code

From any UIViewController in your app, all you have to do is similar to this :

// Retrieve the singleton of GrabKitPicker
GRKPickerViewController * grabkitPickerViewController = [GRKPickerViewController sharedInstance];

// Set the picker's delegate. 
// Don't forget to add GRKPickerViewControllerDelegate in the list of protocols implemented by your controller.
grabkitPickerViewController.pickerDelegate = self;

 // We allow the selection 
grabkitPickerViewController.allowsSelection = YES;
grabkitPickerViewController.allowsMultipleSelection = YES;

[self presentViewController:grabkitPickerViewController animated:YES completion:^{
	// GrabKitPicker is now displayed        
}];

On iPad, you can simply call this method on the picker, to present it from a UIPopover :

[grabkitPickerViewController presentInPopoverFromBarButtonItem:sender permittedArrowDirections:UIPopoverArrowDirectionAny animated:YES];

Then, implement in your controller the delegate method you need. The delegate method called when the picker is dismissed, passing the array of the photos the user selected, is :

-(void)picker:(GRKPickerViewController*)picker didDismissWithSelectedPhotos:(NSArray*)selectedPhotos {
	
	// selectedPhotos is an NSArray of GRKPhoto objects. Check the "Model" section below for more details.
		
}

Model

  • A GRKAlbum represents a photo album. This object has the following properties :

    • albumId : id of the album, as returned by the service.
    • count : total number of photos for the album, according to the service.
    • name : name of the album.
    • coverPhoto : an instance of a GRKPhoto representing the cover photo of the album

  • A GRKPhoto represents a photo. It has a name (title of the photo), a caption(its description). A GRKPhoto has several images which represent the photo in different sizes.

  • an image is an instance of GRKImage. it has a width, a height, an URL, and a flag (isOriginal) set at YES if this image is the original image uploaded by the user.

Coming soon

  • More tests and examples
  • More services
  • More content to grab

Feel free to help and contribute :)

GrabKit v1.3 changes

FAQ

All your questions have answers.

License

This project is under MIT License, please feel free to contribute and use it.

The GrabKitPicker uses :

The Facebook Grabber uses :

The FlickR Grabber uses the ObjectiveFlickR project : https://github.com/lukhnos/objectiveflickr

The Picasa Grabber uses "Google Data APIs Objective-C Client Library" : https://code.google.com/p/gdata-objectivec-client/

Special thanks to the talented Laurence Vagner for the use of her photo album 'Foodporn' in the demo video.

Check her FlickR page for more pictures under Creative Commons licence.

The demo video has been made with CaptureRecord. https://github.com/gabriel/CaptureRecord

Donations

GrabKit is *100% free* . However, developing and supporting this project is hard work and costs real money. Please help support the development of GrabKit !

10% of your donations is donated to the Free Software Foundation.

donation

Contact

Are you using GrabKit in your project ? Do you have a suggestion ? Any question ?

Pierre-Olivier Simonard

[email protected]

www.twitter.com/pierrotsmnrd

www.linkedin.com/in/pierreoliviersimonard