
This add-on is operated by Expedited Security
Resize images for Retina use, thumbnails and social promotion.
Resizer
Last updated March 23, 2019
The Resizer add-on is currently in beta.
Table of Contents
Resizer is an add-on to resize images for Retina use, thumbnails and social promotion.
Resize images on the fly to fit your particular needs. Generate images for Retina or other HDPI displays, make thumbnails or custom sizes to speed page load times.
Resizer exposes an API and has supported examples for Ruby, PHP, Python, Node and Java.
Provisioning the add-on
Resizer can be attached to a Heroku application via the CLI:
A list of all plans available can be found here.
$ heroku addons:create resizer
-----> Adding resizer to sharp-mountain-4005... done, v18 (free)
Once Resizer has been added a RESIZER_API_KEY
config variable will contain your specific API key granting access to the newly provisioned Resizer instance. This can be confirmed using the heroku config:get
command.
$ heroku config:get RESIZER_API_KEY
Bl4XHVbdsf5GIXQbqTfXR5IrpuuXER2kaVc2zNnA
After installing Resizer your application should be modified to fully integrate with the add-on.
Local setup
Environment setup
After provisioning the add-on it’s necessary to locally replicate the config vars so your development environment can operate against the service.
Use the Heroku Local command-line tool to configure, run and manage process types specified in your app’s Procfile. Heroku Local reads configuration variables from a .env
file. To view all of your app’s config vars, type heroku config
. Use the following command for each value that you want to add to your .env
file.
$ heroku config:get RESIZER_API_KEY -s >> .env
Credentials and other sensitive configuration values should not be committed to source-control. In Git exclude the .env
file with: echo .env >> .gitignore
.
For more information, see the Heroku Local article.
Input Parameter Descriptions
All languages will follow this call structure for inputs.
Index | Name | Example | Description |
---|---|---|---|
0 | image_url |
string | The URL to the source image |
1 | width |
integer | Width to resize to (in px) |
2 | height |
integer | Height to resize to (in px) |
Using with Ruby
Install the Resizer gem.
# In your Gemfile
gem 'resizer', git: 'https://github.com/mbuckbee/Resizer-Gem.git'
Making a Request
$ > require 'resizer'
=> true
# Note: the 'Controller' here is not a reference to Rails controllers
# but an internal structure, won't interfere with your Rails app and will
# work fine in a standalone ruby app or another framework
$ > r = Resizer::APIController.new
$ > data = r.lookup("https://www.expeditedaddons.com/base.png","100","100")
# Writes the resized file data to the local directory
$ > File.open("resized.png","w"){|f| f.write(data)}
Resized File
Using with PHP
<?php
$ch = curl_init('https://resizer.expeditedaddons.com/?api_key=' . getenv('RESIZER_API_KEY') . '&height=100&image_url=https%3A%2F%2Fapp.expeditedaddons.com%2Fbase.png&width=100');
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);
Using with Python
import os
from urllib2 import Request, urlopen
request = Request('https://resizer.expeditedaddons.com/?api_key=' + os.environ['RESIZER_API_KEY'] + '&height=100&image_url=https%3A%2F%2Fapp.expeditedaddons.com%2Fbase.png&width=100')
response_body = urlopen(request).read()
print response_body
Using with Node
var request = require('request');
request('https://resizer.expeditedaddons.com/?api_key=' + process.env.RESIZER_API_KEY + '&height=100&image_url=https%3A%2F%2Fapp.expeditedaddons.com%2Fbase.png&width=100', function (error, response, body) {
console.log('Status:', response.statusCode);
console.log('Headers:', JSON.stringify(response.headers));
console.log('Response:', body);
});
Using with Java
// Maven : Add these dependencies to your pom.xml (java6+)
// <dependency>
// <groupId>org.glassfish.jersey.core</groupId>
// <artifactId>jersey-client</artifactId>
// <version>2.8</version>
// </dependency>
// <dependency>
// <groupId>org.glassfish.jersey.media</groupId>
// <artifactId>jersey-media-json-jackson</artifactId>
// <version>2.8</version>
// </dependency>
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
Client client = ClientBuilder.newClient();
Response response = client.target('https://resizer.expeditedaddons.com/?api_key=' + System.getenv('RESIZER_API_KEY') + '&height=100&image_url=https%3A%2F%2Fapp.expeditedaddons.com%2Fbase.png&width=100}')
.request(MediaType.TEXT_PLAIN_TYPE)
.get();
System.out.println("status: " + response.getStatus());
System.out.println("headers: " + response.getHeaders());
System.out.println("body:" + response.readEntity(String.class));
Dashboard
The Resizer dashboard allows you to monitor your API usage limits.
The dashboard can be accessed via the CLI:
$ heroku addons:open resizer
Opening resizer for sharp-mountain-4005
or by visiting the Heroku Dashboard and selecting the application in question. Select Resizer from the Add-ons menu.
Troubleshooting
As a sanity check it is sometimes useful to bypass your app stack and check the endpoint, your API Key and parameters directly.
Test with your browser
# Modify the following to use your actual API Key
https://resizer.expeditedaddons.com/?api_key=REPLACE_WITH_YOUR_RESIZER_API_KEY&height=100&image_url=https%3A%2F%2Fapp.expeditedaddons.com%2Fbase.png&width=100
A successful call will return your requested data with a HTTP result code of 200
along with your data. We recommend the JSON Formatter extension as a useful tool.
Your API key can be found on your Resizer dashboard.
Migrating between plans
No downtime or disruption of service will occur as you modify your plans.
Use the heroku addons:upgrade
command to migrate to a new plan.
$ heroku addons:upgrade resizer:newplan
-----> Upgrading resizer:newplan to sharp-mountain-4005... done, v18 ($49/mo)
Your plan has been updated to: resizer:newplan
Removing the add-on
Resizer can be removed via the CLI.
This will destroy all associated data, cannot be undone and will immediately block access to the API
$ heroku addons:destroy resizer
-----> Removing resizer from sharp-mountain-4005... done, v20 (free)
Support
All Resizer support and runtime issues should be submitted via one of the Heroku Support channels. Any non-support related issues or product feedback is welcome at support@expeditedaddons.com