📜  Cloudrail-快速指南

📅  最后修改于: 2020-10-30 14:14:02             🧑  作者: Mango


CloudRail是一种API集成解决方案,可加快将第三方API集成到应用程序中并对其进行维护的过程。它通过为具有抽象层的多个平台提供库来实现,这些抽象层在一个公共接口后面结合了类似的服务。

CloudRail-功能

这是CloudRail的一些最突出的功能列表-

  • 统一API -CloudRail将多个Web API捆绑为一个统一API。例如,Dropbox函数upload()与Google Drive的工作原理完全相同。您可以轻松集成提供商的整个类别,例如“社交登录”,或用单行代码更改提供商。

  • API变更管理-API一直在变化,从而导致集成失败,客户不满意,甚至浪费更多的开发时间。 CloudRail监视所有API并维护集成。您会立即收到有关更改的通知,所有您需要做的就是将CloudRail库更新为最新版本-无需更改代码。

  • API统计信息-了解您的客户使用最多的API和功能。获取确定新功能或改进营销活动所需的必要见解。

  • 直接数据-您的任何数据都不会通过CloudRail服务器。系统不使用托管的中间件。所有数据转换都在您的应用程序中集成的CloudRail库中进行。这意味着没有数据隐私问题,没有停机时间,也没有其他SPOF。

  • OAuth变得简单-进行OAuth身份验证很痛苦。 CloudRail使授权就像添加一行代码一样简单。

免费版本的CloudRail仅可用于非商业目的或测试。商业用户必须购买许可证。

Cloudrail-Android

本节介绍如何使用CloudRail的Android SDK。

建立

最简单的安装方法是通过Maven。如果您将Android Studio与Gradle结合使用,则可以将以下内容添加到build.gradle文件中

dependencies {
   compile 'com.cloudrail:cloudrail-si-android:2.8.1
}

用法

以下示例显示了如何创建新文件夹并将文件从Android应用程序的资产上传到任何云存储提供商上的新创建的文件夹。

java
CloudRail.setAppKey("[CloudRail License Key]");

// CloudStorage cs = new Box(context, "[clientIdentifier]", "[clientSecret]");
// CloudStorage cs = new OneDrive(context, "[clientIdentifier]", "[clientSecret]");
// CloudStorage cs = new GoogleDrive(context, "[clientIdentifier]", "[clientSecret]");
CloudStorage cs = new Dropbox(context, "[clientIdentifier]", "[clientSecret]");

new Thread() {
   @Override
   public void run() {
      cs.createFolder("/TestFolder"); // 

Cloudrail-Java

本节介绍如何使用CloudRail的Java SDK。

建立

最简单的安装方法是通过Maven。只需将以下内容添加到您的pom.xml文件中-


   
      com.cloudrail
      cloudrail-si-java
      2.8.0
   

用法

以下示例显示如何创建新文件夹并将文件从本地计算机上载到任何云存储提供商上的新创建的文件夹。

java
CloudRail.setAppKey("[CloudRail License Key]");

// CloudStorage cs = new Box(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");
// CloudStorage cs = new OneDrive(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");
// CloudStorage cs = new GoogleDrive(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");
CloudStorage cs = new Dropbox(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");
new Thread() {
   @Override
   public void run() {
      cs.createFolder("/TestFolder");
      InputStream stream = null;
      
      try {
         stream = getClass().getResourceAsStream("Data.csv");
         long size = new File(getClass().getResource("Data.csv").toURI()).length();
         cs.upload("/TestFolder/Data.csv", stream, size, false);
      } catch (Exception e) {
         // TODO: handle error
      } finally {
         // TODO: close stream
      }
   }
}.start();

Cloudrail-Node.js

本节介绍如何使用CloudRail的Node.js SDK。

建立

最简单的安装方法是通过NPM 。只需使用以下命令-

npm install cloudrail-si

用法

以下示例显示如何创建新文件夹并将文件从本地计算机上载到任何云存储提供商上的新创建的文件夹。

javascript
const cloudrail = require("cloudrail-si");
cloudrail.Settings.setKey("[CloudRail License Key]");

// let cs = new cloudrail.services.Box(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");
// let cs = new cloudrail.services.OneDrive(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");
// let cs = new cloudrail.services.GoogleDrive(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");
let cs = new cloudrail.services.Dropbox(redirectReceiver, "[clientIdentifier]", "[clientSecret]", "[redirectUri]", "[state]");

cs.createFolder("/TestFolder", (err) => { //  { // 

Cloudrail-iOS

本节介绍如何使用CloudRail的iOS SDK。

建立

最简单的安装方法是通过CocoaPods 。只需将以下内容添加到您的podfile中

pod "cloudrail-si-ios-sdk"

确保“ use_frameworks!”标志已设置并运行

Pod install

用法

以下示例显示了如何从Objective-C和Swift中的任何云存储提供商下载文件。

objective-c
// self.service = [[CROneDrive alloc] initWithClientId:@"clientIdentifier" clientSecret:@"clientSecret" redirectUri:@"REDIRURL" state:@"CRSTATE"];
// self.service = [[CRGoogleDrive alloc] initWithClientId:@"clientIdentifier" clientSecret:@"clientSecret" redirectUri:@"REDIRURL" state:@"CRSTATE"];
// self.service = [[CRBox alloc] initWithClientId:@"clientIdentifier" clientSecret:@"clientSecret" redirectUri:@"REDIRURL" state:@"CRSTATE"];

[CRCloudRail setAppKey:@"CLOUDRAIL_API_KEY"];
self.service = [[CRDropbox alloc] initWithClientId:@"clientIdentifier" 
   clientSecret:@"clientSecret" redirectUri:@"REDIRURL" state:@"CRSTATE"];

NSInputStream * object = [self.service downloadFileWithPath:@"/mudkip.jpg"];
//READ FROM STREAM

swift
//let cloudStorage : CloudStorageProtocol = Box.init(clientId: "ClientID", clientSecret: "ClientSecret")
//let cloudStorage : CloudStorageProtocol = GoogleDrive.init(clientId: "ClientID", clientSecret: "ClientSecret")
//let cloudStorage : CloudStorageProtocol = OneDrive.init(clientId: "ClientID", clientSecret: "ClientSecret")

CRCloudRail.setAppKey("CLOUDRAIL_API_KEY")
let cloudStorage : CloudStorageProtocol = Dropbox.init(
   clientId: "ClientID", clientSecret: "ClientSecret")
do {
   let inputStream = try cloudStorage.downloadFileWithPath("/TestFolder/Data.csv")
} catch let error{
   print("An error: \(error)")
}
//READ FROM STREAM

Cloudrail-社交登录

本节介绍了为(网络)应用程序实现社交登录的用例。本章仅提供有关社交登录的概述,在随后的章节中,我们将展示如何为Facebook和Twitter进行设置,但是添加更多服务(如Google Plus,LinkedIn,GitHub,Instagram,Slack,Windows Live)非常容易和雅虎。我们将在服务器端使用带有Express的Node.js。

为什么要进行社交登录?

软件开发人员和架构师向其前端添加后端的最常见原因之一是用户管理的需求。为了使用户管理正常工作,注册和登录功能是关键。过去,大多数应用程序都有自己的身份验证系统,因此每个用户都需要通过提供电子邮件地址,密码和其他信息来主动创建帐户。

这不仅给用户带来麻烦,而且众所周知不安全。许多用户将在各处使用相同的密码,这被称为密码疲劳,随着存储密码的每一方的使用,密码被盗的可能性会增加。

最近,越来越多的服务提供“社交登录”(“使用Facebook登录”,“使用GitHub登录”等),通过允许用户在流行的平台上使用其现有帐户进行登录/登录,从而改善了用户体验。

Cloudrail-设置

注册CloudRail应用

使用此链接创建一个新应用(您可能必须先登录)-https: //developers.cloudrail.com您可以在应用摘要中找到您的CloudRail许可证密钥。

注册一个Facebook应用

使用此链接创建一个新应用(您可能必须先登录) -https://developers.facebook.com/apps/ 。然后点击“添加新应用”按钮,选择“基本设置”并创建一个新应用。在仪表板部分中,找到您的应用程序密钥(客户端ID)和应用程序密钥(客户端密钥)。

转到“添加产品”,然后选择“ Facebook登录”。将重定向URI设置为‘http:// localhost:12345 / auth / redirect / facebook’

注册一个Twitter应用

使用此链接创建一个新应用(您可能必须先登录) -https://apps.twitter.com/单击“创建新应用”按钮并填写所需的详细信息。单击“密钥和访问令牌”,您将找到您的应用密钥(客户端ID)和应用密钥(客户端密钥)。将重定向URI设置为‘http:// localhost:12345 / auth / redirect / twitter’

初始化一个新的Node.js项目

通过在控制台中发出以下命令(或非Unix OS上的等效命令),确保已安装Node.js,创建新文件夹,初始化package.json并安装ExpressCloudRail-

mkdir myProject
cd myProject
npm init
npm i --save express cloudrail-si

Cloudrail-编码

在创建的文件夹中为服务器代码创建一个新文件,并添加以下内容以导入和设置ExpressCloudRail-

javascript
const express = require("express");
const cloudrail = require("cloudrail-si");
const app = express();
cloudrail.Settings.setKey("[CloudRail license key]");

现在,我们继续编写一个函数,该函数将实例化我们要用于社交登录的服务-

javascript
function makeService(name, redirectReceiver) {
   let service;
   switch (name) {
      case "twitter":
         service = new cloudrail.services.Twitter(
            redirectReceiver,
            "[Twitter Client ID]",
            "[Twitter Client Secret]",
            "http://localhost:12345/auth/redirect/twitter"
         );
         break;
      case "facebook":
         service = new cloudrail.services.Facebook(
            redirectReceiver,
            "[Facebook Client ID]",
            "[Facebook Client Secret]",
            "http://localhost:12345/auth/redirect/facebook",
            "state"
         );
         break;
      // More services from the Profile interface can be added here, 
      //the services above are just examples
      default: throw new Error("Unrecognized service");
   }
   return service;
}

我们需要一种跟踪用户身份的方法。通常这是在数据库中完成的,但是为了使本教程简短,我们将使用一个充当伪数据库的对象。

它的所有数据都保存在内存中,因此在服务器重新启动时会丢失-

javascript
const users = {
   records: {}
};
users.find = (id) ⇒ {
   return users.records[id];
};
users.save = (id, data) ⇒ {
   users.records[id] = data;
};

之后,我们注册将处理社交登录流程开始的服务器端点-

javascript
app.get("/auth/start/:serviceName", (req, res) ⇒ {
   let serviceName = req.params["serviceName"];
   
   let redirectReceiver = (url, state, callback) ⇒ {
      res.redirect(url);
   };
   let service = makeService(serviceName, redirectReceiver);
   service.login();
});

我们启动社交登录所使用的服务将重定向到我们的服务器,我们需要处理此重定向。

在获得用户的唯一标识符后,我们检查我们是否曾经见过该用户。如果是,那么我们向他打招呼。如果没有,我们从社交网络获取名称并保存一个新用户-

javascript
app.get("/auth/redirect/:serviceName", (req, res) ⇒ {
   let serviceName = req.params["serviceName"];
   
   let redirectReceiver = (url, state, callback) ⇒ {
      callback(undefined, "http://bla.com" + req.url); 
      // The callback expects a complete URL but only the query matters
   };
    let service = makeService(serviceName, redirectReceiver);
   service.getIdentifier((err, identifier) ⇒ {
      if (err) res.status(500).send(err);
      let user = users.find(identifier);
      
      if (user) {
         res.send("Welcome back " + user.name);
      } else {
         service.getFullName((err, name) ⇒ {
            if (err) res.status(500).send(err);
            users.save(identifier, {
               name: name
            });
            res.send("Welcome greenhorn!");
         });
      }
   });
});

最后,我们让服务器监听端口12345-

javascript
app.listen(12345);

现在,我们可以启动该应用程序,并在本地浏览器中对其进行测试。

如果导航到http:// localhost:12345 / auth / start / facebook ,则将启动Facebook登录流程。

如果导航到http:// localhost:12345 / auth / start / twitter ,则将启动Twitter登录流程。

使用该服务登录并授予访问权限后,您将看到“ Welcome greenhorn!”。如果您是首次这样做,并在连续访问中“欢迎回来[您的名字]”。

要将其集成到实际网站中,您将在其中包含服务提供商的徽标,并使徽标链接到相应的URL。

此外,应将伪数据库替换为真实数据库。然后,您可以进行多达9个不同提供商的社交登录!