|
module Agents
class DropboxFileUrlAgent < Agent
include DropboxConcern
cannot_be_scheduled!
no_bulk_receive!
description <<-MD
The _DropboxFileUrlAgent_ is used to work with Dropbox. It takes a file path (or multiple files paths) and emits events with either [temporary links](https://www.dropbox.com/developers/core/docs#media) or [permanent links](https://www.dropbox.com/developers/core/docs#shares).
#{'## Include the `dropbox-api` and `omniauth-dropbox` gems in your `Gemfile` and set `DROPBOX_OAUTH_KEY` and `DROPBOX_OAUTH_SECRET` in your environment to use Dropbox Agents.' if dependencies_missing?}
The incoming event payload needs to have a `paths` key, with a comma-separated list of files you want the URL for. For example:
{
"paths": "first/path, second/path"
}
__TIP__: You can use the _Event Formatting Agent_ to format events before they come in. Here's an example configuration for formatting an event coming out of a _Dropbox Watch Agent_:
{
"instructions": {
"paths": "{{ added | map: 'path' | join: ',' }}"
},
"matchers": [],
"mode": "clean"
}
An example of usage would be to watch a specific Dropbox directory (with the _DropboxWatchAgent_) and get the URLs for the added or updated files. You could then, for example, send emails with those links.
Set `link_type` to `'temporary'` if you want temporary links, or to `'permanent'` for permanent ones.
MD
event_description <<-MD
The event payload will contain the following fields:
{
"url": "https://dl.dropboxusercontent.com/1/view/abcdefghijk/example",
"expires": "Fri, 16 Sep 2011 01:01:25 +0000"
}
MD
def default_options
{
'link_type' => 'temporary'
}
end
def working?
!recent_error_logs?
end
def receive(events)
events.flat_map { |e| e.payload['paths'].split(',').map(&:strip) }
.each do |path|
create_event payload: (options['link_type'] == 'permanent' ? permanent_url_for(path) : temporary_url_for(path))
end
end
private
def temporary_url_for(path)
dropbox.find(path).direct_url
end
def permanent_url_for(path)
result = dropbox.find(path).share_url({ :short_url => false })
result.url = result.url.gsub('?dl=0','?dl=1') # cause the url to point to the file, instead of to a preview page for the file
result
end
end
end
|