CloudPDF Ruby

Ruby wrapper for the CloudPDF API - an cloud-based PDF management service.

Add this line to your application's Gemfile:

gem 'cloudpdf'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install cloudpdf

• Authentication
• Account Info
• Documents
• Webhooks

Get the API key for your project from your CloudPDF Dashboard → Settings → API Keys.

cloudpdf = CloudPDF::Client.new({:api_key => 'YOUR API KEY', :cloud_name => 'YOUR CLOUD NAME', :signing_secret => 'YOUR SIGNING SECRET'})

Return info about the Account associated with this API key.

cloudpdf.account

Before you can upload a PDF to CloudPDF you must create a new document.

The server will return a pre-signed Amazon upload URL where you can upload your PDF file using a PUT request.

After uploading the file you must notify our server that the upload is finished and we will process the PDF by our PDF engine.

cloudpdf.create_document({
  "name": "your_document_name.pdf",
  "description": "Description of your document",
  "tags": ["tag1", "tag2"],
  "defaultPermissions": {
    "download": "Allowed",
    "search": true,
    "selection" false,
    "info": ["email", "phone"]
  }
})

• name: The name of the PDF you want to upload (string)
• description: Description of the PDF you want to upload (string)
• parentId: The ID of the folder you want to create the document in (string)
• tags: Set tags on the document to easily filter and search documents later (array)
• defaultPermissions: Set the default permissions for this document. You can find all parameters in te API docs. If none are given we use the default permissions of the organization. You can change the default permissions of the organization in the Dashboard → Settings → Upload Settings. (object)

cloudpdf.get_document("DOCUMENT ID")

cloudpdf.update_document("DOCUMENT ID", {
  "name": "your_document_name.pdf",
  "description": "Description of your document",
  "tags": ["tag1", "tag2"],
  "defaultPermissions": {
    "download": "Allowed",
    "search": true,
    "selection" false,
    "info": ["email", "phone"]
  }
})

• name: The name of the PDF you want to upload (string)
• description: Description of the PDF you want to upload (string)
• parentId: The ID of the folder you want to create the document in (string)
• tags: Set tags on the document to easily filter and search documents later (array)
• defaultPermissions: Set the default permissions for this document. You can find all parameters in te API docs. If none are given we use the default permissions of the organization. You can change the default permissions of the organization in the Dashboard → Settings → Upload Settings. (object)

cloudpdf.delete_document("DOCUMENT ID")

After you create a document you will receive an Amazon signed URL where you can upload your PDF file using a PUT request. We suggest to upload the file directly from the clients browser to spare your server load. Below you find an example using axios in typescript.

When the file upload is finished you must notify our server.

import axios from 'axios';

axios.put(signedUploadURL, file, {
  headers: {
    "Content-Type": "application/pdf"
  },
  onUploadProgress: (e) => {
    //  Show progress
    const percentComplete = Math.round((e.loaded * 100) / e.total);
    console.log(percentComplete);
  },
});

After uploading your file to Amazon S3 you must notify our server on this endpoint that the upload is complete. On a successful request the status of the document will change from "WaitingUpload" to "Processing".

You can poll the GET endpoint for status updates or use a webhook to find out if your document has completed processing by our PDF engine.

cloudpdf.upload_document_file_complete("DOCUMENT ID", "FILE ID")

cloudpdf.get_document_file("DOCUMENT ID", "FILE ID")

Webhooks are used to notify your system of specific CloudPDF events.

cloudpdf.create_webhook({
  "name": "Webhook 1",
  "url": "https://urltotrigger.com/",
  "events": ["document.created"],
  "headers": {
    "Authorization": "Bearer secret"
  }
})

• name: The name of your webhook for your own reference (string)
• url: The URL that the webhook should trigger on a event (string)
• secret: Optional secret that you can use to secure the webhook endpoint (string)
• events: An array of events. Possible values are: document.created, document.updated, collection.created, collection.updated, tracker.new, lead.new, file.processed (array)
• headers: Object of header keys and values that will be sent as request header on the webhook request (object)

cloudpdf.get_webhook("WEBHOOK ID")

cloudpdf.update_webhook("WEBHOOK ID", {
  "name": "Webhook 1",
  "url": "https://urltotrigger.com/",
  "events": ["document.created"],
  "headers": {
    "Authorization": "Bearer secret"
  }
})

• name: The name of your webhook for your own reference (string)
• url: The URL that the webhook should trigger on a event (string)
• secret: Optional secret that you can use to secure the webhook endpoint (string)
• events: An array of events. Possible values are: document.created, document.updated, collection.created, collection.updated, tracker.new, lead.new, file.processed (array)
• headers: Object of header keys and values that will be sent as request header on the webhook request (object)

cloudpdf.delete_webhook("WEBHOOK ID")

cloudpdf.get_webhooks()

Bug reports and pull requests are welcome on GitHub at https://github.com/cloudpdf-io/cloudpdf-ruby.

The repository is available as open source under the terms of the MIT License.