CloudSide/objc-scs

Objective-C SDK (iOS and OSX) for 新浪云存储

objc-scs

Objective-C SDK (iOS and OSX) for 新浪云存储

新浪云存储Objective-C SDK为第三方应用提供了简单易用的API调用服务，使第三方客户端无需了解复杂的验证机制即可进行授权、上传、下载等文件操作。

• 文档的详细内容请查阅：http://open.sinastorage.com/?c=doc&a=sdk
• SCS API 的详细内容请查阅：http://open.sinastorage.com/?c=doc&a=api

###SDK环境要求 ####系统版本：

• iOS: 6.0及以上。
• OSX: 10.8及以上。

####相关配置：

• 1、将SDK文件夹拷贝到你的工程目录下；
• 2、打开xcode，将SCSSDK.xcodeproj拖动到你的工程中；
• 3、选择你的工程，在右侧选择Build Settings，并设置Other Linker Flags 为 -ObjC -all_load；
• 4、选择Build Phases，在Link Binary With Libraries中添加如下：
• iOS：libSCSSDK_IOS.a；Foundation.framework ；CoreData.framework ；CoreFoundation.framework ；Security.framework ；CoreGraphics.framework ；UIKit.framework；
• OSX：libSCSSDK_OSX.a；Cocoa.framework ；CoreData.framework ；CoreFoundation.framework ；Security.framework ；AppKit.framework；
• 5、选择project，Build Settings，在Header Search Paths中添加SDK所在的相对路径，例如demo中$(SRCROOT)/../SCSSDK

###快速上手 ####设置accessKey、secretKey

SCSConnectionInfo *connectionInfo = [[SCSConnectionInfo alloc] initWithAccessKey:@"YOU ACCESS KEY" secretKey:@"YOU SECRET KEY" userInfo:nil secureConnection:NO];
[SCSConnectionInfo setSharedConnectionInfo:[connectionInfo autorelease]];

####创建操作队列

self.queue = [[[SCSOperationQueue alloc] initWithDelegate:self] autorelease];

//若全局只使用唯一的queue，方法如下：
//[SCSOperationQueue sharedQueue];

//可设置delegate用来设置队列的最大并发数，详情参考代码文档
//[[SCSOperationQueue sharedQueue] setDelegate:self];

#####Example

- (void)dealloc {
    ...
    [[SCSOperationQueue sharedQueue] removeQueueListener:self];
    ...
}

- (void)viewDidLoad {
    ...
    [[SCSOperationQueue sharedQueue] addQueueListener:self];
    ...
}

- (void)scsListBucketOperation {
    SCSListBucketOperation *op = [[[SCSListBucketOperation alloc] init] autorelease];
    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

//操作结果回调
- (void)operationQueueOperationStateDidChange:(NSNotification *)notification
{
    SCSOperation *operation = [[notification userInfo] objectForKey:SCSOperationObjectKey];

    if ([operation state] == SCSOperationDone) {

        if ([[operation kind] isEqualToString:SCSOperationKindBucketList]) {
            //Your action
        }
    }else if ([operation state] == SCSOperationError) {

        if ([[operation kind] isEqualToString:SCSOperationKindBucketList]) {
            //Your action
        }
    }
}

####Bucket操作 #####列取全部Bucket

- (void)scsListBucketOperation {

    SCSListBucketOperation *op = [[[SCSListBucketOperation alloc] init] autorelease];
    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####创建Bucket

- (void)scsAddBucketOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"要创建的Bucket名称"] autorelease];
    
    //创建时可设置bucket的acl属性
    /*
    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"要创建的Bucket名称" creationDate:nil consumedBytes:0 cannedAcl:SCSFastACLPublicReadWrite] autorelease];
    */

    SCSAddBucketOperation *op = [[[SCSAddBucketOperation alloc] initWithBucket:bucket] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####删除Bucket

- (void)scsDeleteBucketOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"待删除的Bucket名称"] autorelease];
    SCSDeleteBucketOperation *op = [[[SCSDeleteBucketOperation alloc] initWithBucket:bucket] autorelease];
    
    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####生成获取Bucket的URL

- (void)scsGetBucketURL {
    
    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"demo-001"] autorelease];

    NSDate *expiresDate = [NSDate dateWithTimeIntervalSince1970:4133933441];
    NSString *urlString = [[bucket urlWithSign:YES expires:expiresDate ip:nil security:NO] absoluteString];

    //获取public bucket的URL
    //NSString *urlString = [[bucket urlWithSign:NO expires:nil ip:nil security:NO] absoluteString];
}

####Object操作 #####列取指定Bucket下的全部Object

- (void)scsListObjectOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"指定的Bucket名称"] autorelease];
    SCSListObjectOperation *op = [[[SCSListObjectOperation alloc] initWithBucket:bucket] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####上传Object

- (void)scsAddObjectOperation {

    NSDictionary *fileInfo = [NSDictionary dictionaryWithObjectsAndKeys:@"要上传的文件全路径",SCSObjectFilePathDataSourceKey, nil];
    
    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"目标Bucket名称"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）" userDefinedMetadata:nil metadata:nil dataSourceInfo:fileInfo] autorelease];

    //上传时可设置文件的acl属性
    /*
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）" userDefinedMetadata:nil metadata:nil dataSourceInfo:fileInfo cannedAcl:SCSFastACLPublicReadWrite] autorelease];
    */

    SCSAddObjectOperation *op = [[[SCSAddObjectOperation alloc] initWithObject:object] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####秒传Object

- (void)scsAddObjectRelaxOperation {

    NSString *sha1 = @"被秒传文件的sha1";
    NSDictionary *fileInfo = [NSDictionary dictionaryWithObjectsAndKeys:@"文件全路径",SCSObjectFilePathDataSourceKey, nil];

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"指定的Bucket名称"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）" userDefinedMetadata:nil metadata:nil dataSourceInfo:fileInfo] autorelease];

    SCSAddObjectRelaxOperation *op = [[[SCSAddObjectRelaxOperation alloc] initWithObject:object fileSha1:[sha1 retain] fileSize:@"被秒传的文件大小"] autorelease];

    //秒传时可设置文件的acl属性，参考上传Object

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####拷贝Object

- (void)scsCopyObjectOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"被拷贝Object所在的Bucke名称"] autorelease];
    SCSObject *objSrc = [[[SCSObject alloc] initWithBucket:bucket key:@"被拷贝文件的key（前缀+文件名）"] autorelease];

    SCSBucket *bucketDest = [[[SCSBucket alloc] initWithName:@"目标Object所在的Bucke名称"] autorelease];
    SCSObject *objDest = [[[SCSObject alloc] initWithBucket:bucketDest key:@"目标文件的key（前缀+文件名）"] autorelease];

    //拷贝时可设置文件的acl属性，参考上传Object

    SCSCopyObjectOperation *op = [[[SCSCopyObjectOperation alloc] initWithObjectfrom:objSrc to:objDest] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####删除Object

- (void)scsDeleteObjectOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"文件所在的Bucket名称"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）"] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####下载Object

- (void)scsDownloadObjectOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"文件所在的Bucket名称"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）"] autorelease]; 
    
    SCSDownloadObjectOperation *op = [[[SCSDownloadObjectOperation alloc] initWithObject:object saveTo:@"文件保存全路径"] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####更新Object

- (void)scsUpdateObjectOperation {

    NSDictionary *udmd = [NSDictionary dictionaryWithObjectsAndKeys:@"要修改的信息", @"要修改信息的key", nil];//可用作添加新属性
    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"文件所在的Bucket名称"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）" userDefinedMetadata:udmd] autorelease];

    //更新时可设置文件的acl属性，参考上传Object    

    SCSUpdateObjectOperation *op = [[[SCSUpdateObjectOperation alloc] initWithObject:object] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####获取Object信息

- (void)scsGetInfoObjectOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"文件所在的Bucket名称"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）"] autorelease];
    
    SCSGetInfoObjectOperation *op = [[[SCSGetInfoObjectOperation alloc] initWithObject:object] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####生成获取Object的URL

- (void)scsGetObjectURL {
    
    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"demo-001"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:[NSString stringWithFormat:@"demo_pic_0.png"]] autorelease];
    
    NSDate *expiresDate = [NSDate dateWithTimeIntervalSince1970:4133933441];
    NSString *urlString = [[object urlWithSign:YES expires:expiresDate ip:nil security:NO] absoluteString];

    //获取public object的URL
    //NSString *urlString = [[object urlWithSign:NO expires:nil ip:nil security:NO] absoluteString];
}

####ACL操作

• ACL详细内容请查阅：http://open.sinastorage.com/?c=doc&a=guide&section=acl

#####获取Bucket的ACL信息

- (void)scsGetACLBucketOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"目标Bucket名称"] autorelease];    
    SCSGetACLOperation *op = [[[SCSGetACLOperation alloc] initWithBucket:bucket object:nil] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

######设置Bucket的ACL信息

- (void)scsSetACLBucketOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"目标Bucket名称"] autorelease];
    
    SCSGrantee *grantee = [[[SCSGrantee alloc] initWithUid:@"被授权的Grantee ID"] autorelease];
    SCSGrant *grant = [[[SCSGrant alloc] initWithGrantArray:@[被授权的Grant数组]] autorelease];
    SCSACL *acl = [[[SCSACL alloc] initWithGranteesAndGrants:[NSDictionary dictionaryWithObject:grant forKey:[grantee uid]]] autorelease];
    
    SCSSetACLOperation *op = [[[SCSSetACLOperation alloc] initWithBucket:bucket object:nil acl:acl] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####Example

- (void)scsSetACLBucketOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"demo-001"] autorelease];
    
	//grantee:被授权对象：AccessKeyId、SCSACLAnonymouseUsersGroupGranteeID、SCSACLCanonicalUserGroupGranteeID
    SCSGrantee *grantee = [[[SCSGrantee alloc] initWithUid:SCSACLCanonicalUserGroupGranteeID] autorelease];

	//grant:授权类型：SCSFastACLPrivate、SCSFastACLPublicRead、SCSFastACLPublicReadWrite、
	//				 SCSFastACLAuthenticatedRead、SCSFastACLBucketOwnerRead、SCSFastACLBucketOwnerFullControl
    SCSGrant *grant = [[[SCSGrant alloc] initWithGrantArray:@[SCSACLGrantRead, SCSACLGrantReadACP, SCSACLGrantWrite, SCSACLGrantWriteACP]] autorelease];
    SCSACL *acl = [[[SCSACL alloc] initWithGranteesAndGrants:[NSDictionary dictionaryWithObject:grant forKey:[grantee uid]]] autorelease];
    
    SCSSetACLOperation *op = [[[SCSSetACLOperation alloc] initWithBucket:bucket object:nil acl:acl] autorelease];
    
    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####获取Object的ACL信息

- (void)scsGetACLObjectOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"文件所在Bucket名称"] autorelease];
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）"] autorelease];
    SCSGetACLOperation *op = [[[SCSGetACLOperation alloc] initWithBucket:bucket object:object] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}

#####设置Object的ACL信息

- (void)scsSetACLObjectOperation {

    SCSBucket *bucket = [[[SCSBucket alloc] initWithName:@"文件所在Bucket名称"] autorelease];
    
	//具体实现请参考设置Bucket的ACL信息的Example
    SCSGrantee *grantee = [[[SCSGrantee alloc] initWithUid:@"被授权的Grantee ID"] autorelease];
    SCSGrant *grant = [[[SCSGrant alloc] initWithGrantArray:@[被授权的Grant数组]] autorelease];
    SCSACL *acl = [[[SCSACL alloc] initWithGranteesAndGrants:[NSDictionary dictionaryWithObject:grant forKey:[grantee uid]]] autorelease];
    
    SCSObject *object = [[[SCSObject alloc] initWithBucket:bucket key:@"目标文件的key（前缀+文件名）"] autorelease];
    
    SCSSetACLOperation *op = [[[SCSSetACLOperation alloc] initWithBucket:bucket object:object acl:acl] autorelease];

    [[SCSOperationQueue sharedQueue] addToCurrentOperations:op];
}