适用于Delicious.com的FourMarks

FourMarks是用于Delicious书签服务的Objective-C客户端库。

1. 特性

• 完全实现v1 API
• 带有AHDispatch的请求节流 - （默认为1秒）
• XCText单元测试套件。
• CocoaPods集成。
• API参考文档，其中包含在Xcode中安装的构建文档集。
• 基于AFNetworking 2.0构建。

2. FourMarks API

FourMarks API允许以编程方式访问以下Delicious实体（不是字面上的意思）

• 帖子
• 标签
• 捆绑

完整的API参考文档也可用。

3. 要求

FourMarks是为支持ARC的应用程序编写的。默认情况下，您的构建目标需要满足以下条件之一：

• iOS 6.0或更高
• Xcode 5.0或更高

如果您不使用ARC，您仍然可以通过指定在目标“编译源”部分中实施文件 (*.m) 的编译器标志 -fobjc-arc 来使用FourMarks。

FourMarks依赖于CocoaPods系统，并以下项目通过CocoaPods：

• AFNetworking 2.0
• AHDispatch
• TBXML
• ISO8601DateFormatter

4. 安装

为了成功构建，FourMarks依赖于CocoaPods。通过CocoaPods进行安装是唯一推荐的将FourMarks与项目集成的方式。

4.1 CocoaPods

只需将以下行添加到项目的Podfile

pod 'FourMarks'

然后，在命令行中，从与Podfile相同的目录运行

pod install

请记住，如果您只是像上面解释的那样将FourMarks集成到项目中，将无法获取单元测试套件或本地安装AppleDoc文档集的能力。

4.2 单元测试与文档集

如果您希望将包含的AppleDocs文档集本地安装，以便在Xcode文档查看器中查看，或者查看和运行XCTest单元测试套件，则需要在本地计算机上从GitHub克隆存储库。您需要在构建项目的 "安装AppleDocs" 目标之前，在存储库的根目录中运行CocoaPods命令 pod install。默认情况下，文档集将安装到 "~/Library/Developer/Shared/Documentation/DocSets" 位置，包名为 "com.alienhitcher.FourMarks.docset"。

5. 配置

由于Delicious API不需要开发者账户、令牌或密钥，因此 FourMarks无需任何配置即可使用。使用FourMarks进行编码与《快速开始编码》示例中看到的一样简单。

话虽如此，您可以通过在应用程序的Info.plist文件中包含关键字来覆盖默认API端点。以下关键字组合按优先级列出：

• delicious.api.host - 例如："https://api.delicious.com"
• delicious.api.path - 例如："v1"

或者

• delicious.api.url - 例如："https://api.delicious.com/v1/"

5.1 NSUserDefaults

FourMarks可从NSUserDefaults中检索用户账户名和密码。为此机制能够成功工作，确保您在将用户的身份验证凭据存储在NSUserDefaults时使用以下密钥

• delicious.account.username
• delicious.account.password

然后可以使用以下代码使用这些设置初始化一个FMAccount对象

FMAccount *account = [FMAccount defaultAccount];

6. 快速开始编码

安装后，在代码中的某个合理位置导入库头文件

#import "FourMarks.h"

然后创建一个FMSession实例，并使用有效的Delicious账户的凭证进行初始化

FMSession *session = [[FMSession alloc] initWithUsername:@"foo" password:@"bar"];

[session addPost:[NSURL URLWithString:@"http://www.google.com"]
           title:@"My Google URL quick post from FourMarks"
            tags:@[@"ah-search", @"ah-engine"]
          result:^(FMResult *result) { 

               //do something with the result
               NSLog(@"result message:%@, code: %@", [result message], [result code]);                        
          }
         failure:^(NSError *error) {
             // react to the network error
         }
];

7. 单元测试

FourMarks在FourMarksTests子目录中包含一组单元测试。测试使用XCTest框架实现。测试运行在支持文件"FourMarksTestData.plist"中的数据上。与代码一起包含2种类型的单元测试

1. 生命周期测试套件。用于测试库的主要部分。测试了多个API调用，模拟了典型用例，例如创建、更新和删除帖子、创建和删除包、重命名标签等。

2. 每个API调用的单个API调用测试。如果更改了库的一部分并想测试您的更改，而不需要运行测试套件来测试整个库的实时Delicious API，这将非常实用。

从GitHub克隆存储库将为您提供访问XCTest单元测试的权限。它们位于FourMarksTests文件夹中，是找到一个使用FourMarks的示例的好地方。

7.1 配置

与直接使用FourMarks一样，包含的单元测试在使用之前无需配置。但是，单元测试中使用的API调用参数值可以进行修改，并存储在内名为FourMarksTestData.plist的支持文件中。

7.2 构建

在测试构建前，需要在仓库根目录中运行 CocoaPods 命令 pod install，以便使用 ⇧⌘U 进行测试。

8. 参考文档

• FourMarks API 参考文档
• 官方的Delicious API v1 文档可通过AVOS Systems, Inc. 在 GitHub 上获得。

9 联系方式

FourMarks 由 Ray Scott (@rayascott) 维护。

10 许可协议

FourMarks 在 MIT 许可协议下提供。有关更多信息，请参阅包含的LICENSE文件。