This tutorial is meant for software developers who want to learn how to lose less time on API integrations!

Transcription

1

2 CloudRail About the Tutorial CloudRail is an API integration solution that speeds up the process of integrating third-party APIs into an application and maintaining them. It does so by providing libraries for multiple platforms featuring abstraction layers that combine similar services behind a common interface. Audience This tutorial is meant for software developers who want to learn how to lose less time on API integrations! Prerequisites CloudRail provides libraries for Android, Java, Node.js, and ios (Objective-C and Swift). Basic knowledge of the respective platform is required to use the corresponding library. You can quickly sign up for a free account at and get a license key which you will need to use the library. Copyright & Disclaimer Copyright 2017 by Tutorials Point (I) Pvt. Ltd. All the content and graphics published in this e-book are the property of Tutorials Point (I) Pvt. Ltd. The user of this e-book is prohibited to reuse, retain, copy, distribute or republish any contents or a part of contents of this e-book in any manner without written consent of the publisher. We strive to update the contents of our website and tutorials as timely and as precisely as possible, however, the contents may contain inaccuracies or errors. Tutorials Point (I) Pvt. Ltd. provides no guarantee regarding the accuracy, timeliness or completeness of our website or its contents including this tutorial. If you discover any errors on our website or in this tutorial, please notify us at contact@tutorialspoint.com i

3 CloudRail Table of Contents About the Tutorial... i Audience... i Prerequisites... i Copyright & Disclaimer... i Table of Contents... ii 1. CLOUDRAIL OVERVIEW CLOUDRAIL ANDROID CLOUDRAIL JAVA CLOUDRAIL NODE.JS CLOUDRAIL IOS CLOUDRAIL SOCIAL LOGIN CLOUDRAIL SETUP CLOUDRAIL CODING ii

4 1. CloudRail Overview CloudRail CloudRail is an API integration solution that speeds up the process of integrating third-party APIs into an application and maintaining them. It does so by providing libraries for multiple platforms featuring abstraction layers that combine similar services behind a common interface. CloudRail Features Here is a list of some of the most prominent features of CloudRail: Unified API CloudRail bundles multiple web APIs into a single unified API. For instance, the function upload() works exactly the same for Dropbox as it does for Google Drive. You can easily integrate whole categories of providers, e.g. Social Logins, or change a provider with a single line of code. API Change Management APIs change all the time, leading to broken integrations, unsatisfied customers and even more wasted development time. CloudRail monitors all APIs and maintains the integrations. You get immediate notifications about changes and all you need to do is update the CloudRail library to the latest version no code changes required. API Statistics Understand which APIs and functions are being used most by your customers. Get the necessary insights you need to identify new features or improve marketing campaigns. Direct Data None of your data will ever pass a CloudRail server. The system doesn t use a hosted middleware. All data transformation happens in the CloudRail library which is integrated in your App. This means no data privacy concerns, no down-times and no additional SPOF. OAuth Made Simple Doing OAuth authentications is a pain. CloudRail makes authorizations as simple as adding a single line of code. The free version of CloudRail may only be used for non-commercial purpose or testing. Commercial users must purchase a license. 1

5 2. CloudRail Android CloudRail This section gives an introduction on how to use CloudRail's Android SDK. Setup The easiest way to install is via Maven. If you are using Android Studio with Gradle, it suffices to add the following to your build.gradle file dependencies { compile 'com.cloudrail:cloudrail-si-android:2.8.1 Usage The following example shows how to create a new folder and upload a file from an Android application's assets to the newly created folder on any cloud storage provider. 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() public void run() { cs.createfolder("/testfolder"); // <--- InputStream stream = null; try { AssetManager assetmanager = getassets(); stream = assetmanager.open("userdata.csv"); long size = assetmanager.openfd("userdata.csv").getlength(); cs.upload("/testfolder/data.csv", stream, size, false); // <--- catch (Exception e) { // TODO: handle error 2

6 CloudRail finally { // TODO: close stream.start(); 3

7 3. CloudRail Java CloudRail This section gives an introduction on how to use CloudRail's Java SDK. Setup The easiest way to install is via Maven. It suffices to add the following to your pom.xml file <dependencies> <dependency> <groupid>com.cloudrail</groupid> <artifactid>cloudrail-si-java</artifactid> <version>2.8.0</version> </dependency> </dependencies> Usage The following example shows how to create a new folder and upload a file from the local machine to the newly created folder on any cloud storage provider. 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() public void run() { cs.createfolder("/testfolder"); InputStream stream = null; try { stream = getclass().getresourceasstream("data.csv"); 4

8 CloudRail 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 {.start(); // TODO: close stream 5

9 4. CloudRail Node.js CloudRail This section gives an introduction on how to use CloudRail's Node.js SDK. Setup The easiest way to install is via NPM. Simply use the following command npm install cloudrail-si Usage The following example shows how to create a new folder and upload a file from the local machine to the newly created folder on any cloud storage provider. 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) => { // <--- if (err) throw err; let filestream = fs.createreadstream("userdata.csv"); let size = fs.statsync("userdata.csv").size; cs.upload("/testfolder/data.csv", filestream, size, false, (err) => { // <--- if (err) throw err; console.log("upload successfully finished"); ); ); 6

10 5. CloudRail ios CloudRail This section gives an introduction on how to use CloudRail's ios SDK. Setup The easiest way to install is via CocoaPods. Simply add the following to your podfile pod "cloudrail-si-ios-sdk" Make sure the "use_frameworks!" flag is set and run. Pod install Usage The following examples show how to download a file from any cloud storage provider in Objective-C and 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") 7

11 CloudRail 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 8

12 6. CloudRail Social Login CloudRail This section presents the use-case of implementing social login for a (web) app. This chapter provides just an overview on Social Login and in the subsequent chapters, we will show how to set it up for Facebook and Twitter but it is very easy to add more services like Google Plus, LinkedIn, GitHub, Instagram, Slack, Windows Live and Yahoo. We will be using Node.js with Express on the server side. Why Social Login? One of the most common reasons why software developers and architects add a backend to their frontend(s) is the need for user management. In order for user management to work, signup and sign-in functionalities are the key. In the past, most applications had their own system for authentication and thus every user needed to actively create an account by providing address, password and other information. Not only is this cumbersome to the user but also notoriously insecure. Many users will use the same password everywhere, known as password fatigue, and with every party that has the password stored, the probability grows that it is stolen. Of late, more and more services offer social login ( Login with Facebook, Login with GitHub, etc.) which improves user experience by letting users signup/login with their already existing account on a popular platform. 9

13 7. CloudRail Setup CloudRail Register a CloudRail app Use this link to create a new app (you may have to login first): You can find your CloudRail license key in the app summary. Register a Facebook app Use this link to create a new app (you may have to login first): Then click the 'Add a New App' button, choose 'Basic setup' and create a new app. In the dashboard section, you find your App Key (Client ID) and App Secret (Client Secret). Go to 'Add Product' and select 'Facebook Login'. Set the Redirect URI to ' Register a Twitter app Use this link to create a new app (you may have to login first): Click the 'Create New App' button and fill in the required details. Click on 'Keys and Access Tokens' and you'll find your App Key (Client ID) and App Secret (Client Secret). Set the Redirect URI to ' Initialize a new Node.js project Make sure you have Node.js installed, create a new folder, initialize the package.json and install Express and CloudRail by issuing the following commands in the console (or the equivalent commands on non-unix OSs) mkdir myproject cd myproject npm init npm i --save express cloudrail-si 10

14 8. CloudRail Coding CloudRail Create a new file for your server code in the created folder and add the following to import and setup Express and CloudRail javascript const express = require("express"); const cloudrail = require("cloudrail-si"); const app = express(); cloudrail.settings.setkey("[cloudrail license key]"); Now, we continue by writing a function that will instantiate the services we want to use for social login javascript function makeservice(name, redirectreceiver) { let service; switch (name) { case "twitter": service = new cloudrail.services.twitter( ); break; redirectreceiver, "[Twitter Client ID]", "[Twitter Client Secret]", " case "facebook": service = new cloudrail.services.facebook( ); break; redirectreceiver, "[Facebook Client ID]", "[Facebook Client Secret]", " "state" // More services from the Profile interface can be added here, the services above are just examples default: throw new Error("Unrecognized service"); 11

15 CloudRail return service; We need a way to keep track of user identities. This is normally done in a database but to keep this tutorial short, we will use an object that acts as a pseudo-database. All its data is kept in memory and is thus lost when the server restarts javascript const users = { ; records: { users.find = (id) { ; return users.records[id]; users.save = (id, data) { users.records[id] = data; ; Now, we register the server endpoint that will handle the start of the social login flow 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(); The service we have started the social login with will redirect to our server and we need to handle this redirect. 12

16 CloudRail After getting a unique identifier for the user, we check if we have seen this user before. If yes, then we greet him with his name. If not, we get the name from the social network and save a new user javascript app.get("/auth/redirect/:servicename", (req, res) { let servicename = req.params["servicename"]; let redirectreceiver = (url, state, callback) { callback(undefined, " + 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!"); Finally, we have the server listen on port javascript app.listen(12345); We can now start the application and test it in our local browser. If you navigate to you will start the Facebook login flow. If you navigate to you will start the Twitter login flow. 13

17 CloudRail After logging in with the service and granting access, you will be seeing "Welcome greenhorn!" if you do it for the first time and "Welcome back [your name]" on consecutive visits. To integrate it into an actual website, you would, for example, include the service provider's logos there and make the logos link to the respective URLs. Besides, the pseudo-database should be replaced with a real one. And there you go, social login for up to 9 different providers! 14