forked from pierrotsmnrd/grabKit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
199 lines (112 loc) · 7.04 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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.
<p align="center">
<img alt="screenshot of the demo application" width="285" height="539" src="https://github.com/pierrotsmnrd/grabKit/raw/master/doc/demo.gif"/><br />
Watch this demo on YouTube : http://www.youtube.com/watch?v=6sOgy_3P4Ws<br />
</p>
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](https://github.com/pierrotsmnrd/grabKit/wiki/How-to-run-GrabKit's-demo-application)
How to use Grabkit in your app
-------------
### Installation
To install and setup GrabKit in your project, follow the [detailled instructions in the wiki](https://github.com/pierrotsmnrd/grabKit/wiki/How-to-install-GrabKit)
### 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](https://github.com/pierrotsmnrd/grabKit/wiki/How-to-configure-GrabKit)
### 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
-------
* Introducing the GrabKitPicker, and much more. [check the full changelog](https://github.com/pierrotsmnrd/grabKit/blob/master/changelog.txt)
FAQ
-------
[All your questions have answers.](https://github.com/pierrotsmnrd/grabKit/wiki/FAQ)
License
-------
This project is under MIT License, please feel free to contribute and use it.
The GrabKitPicker uses :
* NVUIGradientButton made by Nicolas Verinaud. https://github.com/nverinaud/NVUIGradientButton/
* MBProgressHUD made by Jonathan George. https://github.com/jdg/MBProgressHUD/
* PSTCollectionView by Peter Steinberger. https://github.com/steipete/PSTCollectionView/
The Facebook Grabber uses :
* ISO8601DateFormatter made by Peter Hosey. http://boredzo.org/iso8601unparser/
* Facebook iOS SDK https://github.com/facebook/facebook-ios-sdk
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](http://www.redisdead.net/) for the use of her photo album 'Foodporn' in the demo video.
Check her [FlickR page](http://www.flickr.com/photos/redisdead) 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**.
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GEHQ8UX5RR298&lc=US¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)
Contact
-------
Are you using GrabKit in your project ? Do you have a suggestion ? Any question ?
Pierre-Olivier Simonard
www.twitter.com/pierrotsmnrd
www.linkedin.com/in/pierreoliviersimonard