idealista/yatm

A node.js module that provides access to the VIPS library and Exiv2 in order to resize and rotate images.

YATM - Yet Another Thumbnail Manager

A Node.js module that provides access to the VIPS library and Exiv2 in order to resize and rotate images.

• Getting Started
  • Prerequisities
  • Installing
• Usage
• Testing
• Built With
• Versioning
• Authors
• License
• Contributing

Getting Started

Prerequisities

Node.js installed. Tested with v14.17.0.

In version 2.0.0, the support for nodejs <= 8 and debian != buster is discontinued and not tested.

Installation

$ npm install yatm

In order to avoid external dependencies, add

LD_LIBRARY_PATH={{path to project/global node_modules}}/yatm/deps/lib/

to your Node.js environment. Usually:

export LD_LIBRARY_PATH={{path to project/global node_modules}}/yatm/deps/lib/

Usage

• (path)

  Set the thumb object with an input path.

• (buffer)

  Set the thumb object with an input buffer.

• resize(width,height)

  The resized values. One of both could be 0, so the result will adjust to the non zero side.

• rotate(rotate)

  Thumb rotation.

  • Values: {0,90,180,270}

• quality(quality)

  Desired thumb quality.

  • Values: {0-100}

• adjust(adjust)

  Adjusts the image to the width ('wi') or height ('he') if one of them are 0 setted. Usually setted with crop.

  • Values: {'wi', 'he'}

• crop(crop)

  Crops the thumb if the resized result doesn't match current ratio, avoiding deformation.

  • Values: {true,false}

• toBuffer(callback)

  Transform the thumb object with the desired options and returns the image as a buffer.

Testing

• Unit testing

$ npm test

• Memory leak

$ ./test/memoryleak/memoryleak.sh

• Full testing, that creates a docker container and installs all dependencies

$ molecule test

Built With

Versioning

For the versions available, see the tags on this repository.

Additionaly you can see what change in each version in the CHANGELOG.md file.

Authors

• Idealista - Work with - idealista

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

yatm's Issues

[REFACTOR]Change deprecated node-api usage

Description

The node-api used for c++ addon is deprecated. https://nodejs.org/docs/latest-v14.x/api/addons.html

Link/s to the specific code that needs a refactor (if applicable)

https://github.com/idealista/yatm/blob/master/src/yatm.cc

Include external dependencies

Include external dependencies

Error publishing npm package from travis

Description

npm ERR! publish Failed PUT 404
npm ERR! code E404
npm ERR! 404 Not found : yatm
npm ERR! 404
npm ERR! 404 'yatm' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

Exiv2 download sources package is not working properly

Prerequisites

• [ X ] Put an X between the brackets on this line if you have done all of the following:
  • Checked that your issue isn't already filled: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aidealista
  • Checked that there is not already provided the described functionality

Description

Download URL is giving a timeout:

TASK [exiv2 : EXIV2 | Download sources package] ******************************** [DEPRECATION WARNING]: Using tests as filters is deprecated. Instead of using result|failedinstead useresult is failed. This feature will be removed in version 2.9. Deprecation warnings can be disabled by setting deprecation_warnings=False in ansible.cfg. fatal: [yatm.cont]: FAILED! => {"changed": false, "dest": "/buildexiv2", "gid": 0, "group": "root", "mode": "0755", "msg": "Connection failure: timed out", "owner": "root", "size": 4096, "state": "directory", "uid": 0, "url": "http://www.exiv2.org/builds/exiv2-0.26-trunk.tar.gz"}

Versions

All

[BUG]Segmentation fault

Description

GLib-GObject-CRITICAL **: 13:26:51.922: g_value_type_compatible: assertion 'G_TYPE_IS_VALUE (src_type)' failed

[BUG] Missed needed libs

Description

libtiff, liblcms2 and libxext are also mandatory for the library

Notify NPM on release

Notify NPM on release

[BUG] Fix travis build

Description

Every week the Travis build fails because of a Pipenv error: https://app.travis-ci.com/github/idealista/yatm. We should fix this.

Steps to Reproduce

N/A

Environment

Reported in travis

Additional Information

N/A

Add support to Debian Jessie

Prerequisites

• [ X ] Put an X between the brackets on this line if you have done all of the following:
  • Checked that your issue isn't already filled: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aidealista
  • Checked that there is not already provided the described functionality

Description

YATM is not working under Debian Jessie

Versions

All

Support nodejs 14 and debian 10

Description

Support nodejs 14 and debian 10

Why is this needed?

In order to update environments

Use a documentation generator

Prerequisites

• [ X ] Put an X between the brackets on this line if you have done all of the following:
  • Checked that your issue isn't already filled: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aidealista
  • Checked that there is not already provided the described functionality

Description

Maybe a documentation generator (like ESDoc or JSDoc 3) should be used.

That static page should be linked in Readme file. Must be regenerated every time a change is pushed in source code.

Additional Information

• https://esdoc.org/
• https://github.com/jsdoc3/jsdoc

Create a CLI for this project

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Checked that your issue isn't already filled: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aidealista
  • Checked that there is not already provided the described functionality

Description

Would be great if YATM could be executed through terminal using a Command-line interface

Additional Information

Any additional information, configuration or data that might be necessary to reproduce the issue.