Arkio for Data.com

Arkio 是 Data.com 的 Objective-C 客户端库。

1. 特性

• 完全实现 Data.com Connect API。(PDF)
• XCTest 单元测试套件。
• CocoaPods 集成。
• 完整的 AppleDocs，可以将文档集安装在 Xcode 中。
• 基于 AFNetworking 2.0 构建。

2. API 概述

完全实现 Data.com Connect API 意味着您可以使用 Arkio 进行以下操作

• 搜索联系人。
• 购买并下载联系人。
• 检索公司的联系人计数统计。
• 检索用户的积分余额。

3. 要求

Arkio 是为 ARC 启用的应用程序编写的。默认情况下，您的构建目标需要遵守以下之一

• iOS 6 或更高版本
• OS X 10.8 或更高版本

如果您不使用 ARC，可以通过指定 Build Phases 选项卡中 Compile Sources 部分的目标实现文件 (*.m) 的编译器标志 -fobjc-arc 来使用 Arkio。请参阅 -fobjc-arc。

4. 安装

Arkio 依赖于 CocoaPods 以成功构建。使用 CocoaPods 进行安装是集成 Arkio 到项目中唯一推荐的方式。为什么？Arkio 依赖于 AFNetworking，这最易于通过 CocoaPods 获取。

CocoaPods

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

pod 'Arkio'

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

pod install

请注意，如果像上面那样仅将 Arkio 集成到项目中，则不会获得单元测试套件或本地安装 AppleDoc 文档集的能力。

单元测试与文档集

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

5. 配置

要成功与Data.com API交互，您需要一个开发者令牌/密钥。配置Arkio最简单的方法是，将您的开发令牌添加到您的应用Info.plist文件中，作为键“arkio.api.developer.token”的值，如下所示

这可以让ARKSession实例自动获取值。或者，您可以像以下那样直接在会话中设置令牌值

[arkSession setAPIDeveloperToken:@"developertokentext"];

6. 编码快速入门

在安装和配置后，在您的代码中合理的位置导入库头文件

#import "Arkio.h"

然后，使用有效的Data.com用户名和密码初始化一个ARKSession，并使用会话上的方法与API交互。

    ARKSession *session = [[ARKSession alloc] initWithUsername:@"[email protected]" 
                                                      password:@"foobar"];

    [session userInformation:^(long points, ARKError *error) {

        if (!error) {
            NSLog(@"points = %ld ", points);
        }
        else {
            // we receive an application error message from Data.com
            NSLog(@"ark error: %@", error);
        }
    }
                     failure:^(NSError *error) {
                         // an unexpected HTTP network error occurred
                         NSLog(@"failed with network error: %@", error);
                     }
    ];

7. 单元测试

从GitHub克隆repo将为您提供访问XCTest单元测试的权限。它们位于ArkioTests文件夹中，并且是找到Arkio使用示例的好地方。

配置

在测试针对Data.com API端点运行之前，需要设置3个配置设置。导航到“ArkioTests/Supporting Files”文件夹，并在ArkioTests-Info.plist文件中添加以下键的值

• arkio.api.developer.token
• arkio.account.username
• arkio.account.password

单元测试中API调用参数存储在名为ArkioTestData.plist的辅助文件中。

构建

在测试中按⇧⌘U构建之前，您需要先在repo根目录中运行CocoaPods命令pod install。

8. 参考文档

• 类参考文档可以在Cocoadocs.org上找到，链接为http://cocoadocs.org/docsets/Arkio/。
• Data.com Connect API官方文档（PDF），详见http://www.data.com/export/sites/data/common/assets/pdf/DS_Datadotcom_Connect_API_Docs.pdf）和Data.com Connect Developer Program。

联系

Arkio由Ray Scott（@rayascott）维护。

许可

Arkio在MIT许可下提供。有关更多信息，请参阅随附的LICENSE文件。