LayerVaultAPI 3.0.4

You want to add pod 'LayerVaultAPI', '~> 3.0' similar to the following to your Podfile:

target 'MyApp' do
  pod 'LayerVaultAPI', '~> 3.0'
end

Then run a pod install inside your terminal, or from CocoaPods.app.

Alternatively to give it a test run, run the command:

pod try LayerVaultAPI


Depends on:
AFNetworking	~> 1.3.4
Mantle	~> 1.3
AFOAuth2Client	~> 0.1.1

LayerVaultAPI 3.0.4

By
Matt Thomas

Usage

Authenticating

LVCAuthenticatedClient is the main interface to the LayerVault API and is based on AFOAuth2Client for authentication. You can save an AFOAuthCredential to the keychain so you do not need to save the username or password.

LVCAuthenticatedClient *client = [[LVCAuthenticatedClient alloc] initWithClientID:LVClientID
                                                                           secret:LVClientSecret];
// Authenticate with a username & password
[self.client loginWithEmail:userName password:password];

The authentication state can be observed. Because OAuth tokens expire, users will need to be re-authenticated

[self.client addObserver:self
              forKeyPath:@"authenticationState"
                 options:NSKeyValueObservingOptionNew
                 context:kMyContext];

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
{
    if (context == kMyContext) {
        if ([keyPath isEqualToString:@"authenticationState"]) {
            LVCAuthenticationState authenticationState = (LVCAuthenticationState)[change[@"new"] integerValue];
            if (authenticationState == LVCAuthenticationStateTokenExpired) {
                [self.client loginWithEmail:self.email password:self.password];
            }
        }
    }
    else {
        [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
    }
}

Getting User Information

LVCUser contains all the information for a user including the organizations they are a part of and the projects they have access to. LVCAuthenticatedClient has a user property that is set automatically when authentication completes:

NSLog(@"%@’s Projects: %@", client.user.firstName, client.user.projects);

Getting Project Information

LVCProject contains all the information for a project all the folders, files, and revisions. LVCAuthenticatedClient can get your user information like so:

[client getProjectWithName:@"My Awesome App"
     organizationPermalink:@"fancy-company"
                completion:^(LVCProject *project,
                             NSError *error,
                             AFHTTPRequestOperation *operation) {
    NSLog(@"Look at my files: %@", project.files);
}];

Uploading an Image

This is how you would upload an image:

NSURL *fileURL = [NSURL fileURLWithPath:@"/Users/alex/Desktop/hi.jpg"];
[client uploadLocalFile:fileURL
                 toPath:@"fancy-company/My Awesome App"
             completion:^(LVCFile *file,
                          NSError *error,
                          AFHTTPRequestOperation *operation) {
    if (file) {
        NSLog(@"file uploaded successfully: %@", file);
    }
}];

Requirements

Installation

Author

Matt Thomas, [email protected]

License

LayerVaultAPI is available under the MIT license. See the LICENSE file for more info.