Introduction
The Files.com Ruby gem provides convenient access to all aspects of Files.com from applications written in the Ruby language.
Files.com customers use our Ruby gem for directly working with files and folders as well as performing management tasks such as adding/removing users, onboarding counterparties, retrieving information about automations and more.
The Ruby gem uses the Files.com RESTful APIs via the HTTPS protocol (port 443) to securely communicate and transfer files so no firewall changes should be required in order to allow connectivity to Files.com.
Files.com is a Ruby Shop
At Files.com, we use Ruby as a primary language all over the company. Our main server-side API is developed in Ruby, as are many of our microservices.
This Ruby gem is used directly in many internal projects at Files.com, including several of the integrations we maintain. You can expect the official Files.com Ruby gem to be highly performant and kept up to date at all times.
Installation
To install the gem, simply use Rubygems:
You can also use Bundler, by adding files.com to your app's Gemfile:
Requirements
The Files.com gem requires Ruby 3+.
Ruby 2.x is now considered end-of-life by the Ruby project. As a policy, Files.com does not support integrations which are considered end-of-life by their vendor.
Repository
Explore the files-sdk-ruby code on GitHub.
Getting Started
The Files::File and Files::Dir models implement the standard Ruby API for File and Dir, respectively. (Note that the Files.com SDK uses the word Folder, not Dir, and Files::Dir is simply an alias for Files::Folder).
Getting Support
The Files.com Support team provides official support for all of our official Files.com integration tools.
To initiate a support conversation, you can send an Authenticated Support Request or simply send an E-Mail to support@files.com.