File Coverage

lib/Mojolicious/Plugin/Cloudinary.pm

Criterion	Covered	Total	%
statement	46	49	93.8
branch	5	10	50.0
condition	8	18	44.4
subroutine	12	12	100.0
pod	1	1	100.0
total	72	90	80.0

package Mojolicious::Plugin::Cloudinary;

=head1 NAME

Mojolicious::Plugin::Cloudinary - Talk with cloudinary.com

=head1 DESCRIPTION

This register the methods from the L module as helpers in
your L web application. See L for details.

=head1 SYNOPSIS

  package MyWebApp;
  use Mojo::Base 'Mojolicious';

  sub startup {
    my $self = shift;

    $self->plugin('Mojolicious::Plugin::Cloudinary', {
      cloud_name => $str,
      api_key => $str,
      api_secret => $str,
    });
  }

  package MyWebApp::SomeController;

  sub upload {
    my $self = shift;

    $self->render_later;
    Mojo::IOLoop->delay(
      sub {
        my($delay) = @_;
        $self->cloudinary_upload(
          {
            file => $self->param('upload_param'),
          },
          $delay->begin,
        );
      },
      sub {
        my($delay, $res, $tx) = @_;
        return $self->render(json => $res) if $res;
        return $self->render_exception;
      },
    );
  }

=cut

use Mojo::Base -base;
use File::Basename;
use Mojo::UserAgent;
use Mojo::Util qw/ sha1_sum url_escape /;
use Scalar::Util 'weaken';
use base qw/ Cloudinary Mojolicious::Plugin /;

our $VERSION = 0.0402;    # just need something higher than the previous version

=head1 ATTRIBUTES

=head2 js_image

This string will be used as the image src for images constructed by
L. The default is "/image/blank.png".

=cut

has js_image => '/image/blank.png';

=head1 HELPERS

=head2 cloudinary_upload

See L.

=head2 cloudinary_destroy

See L.

=head2 cloudinary_url_for

See L.

=head2 cloudinary_image

  $str = $c->cloudinary_image($public_id, $url_for_args, $image_args);

This will use L to create an image
tag where "src" is set to a cloudinary image. C<$url_for_args> are passed
on to L and C<$image_args> are passed on to
L.

=head2 cloudinary_js_image

  $str = $c->cloudinary_js_image($public_id, $url_for_args);

About the same as L, except it creates an image which can
handled by the cloudinary jQuery plugin which you can read more about here:
L

Example usage:

  $c->cloudinary_js_image(1234567890 => {
    width => 115,
    height => 115,
    crop => 'thumb',
    gravity => 'faces',
    radius => '20',
  });

...will produce:


    class="cloudinary-js-image"
    alt="1234567890"
    data-src="1234567890"
    data-width="115"
    data-height="135"
    data-crop="thumb"
    data-gravity="faces"
    data-radius="20">

Note: The "class" and "alt" attributes are fixed for now.

=head1 METHODS

=head2 register

Will register the L in the L application.

=cut

sub register {
  my($self, $app, $config) = @_;

  for my $k (keys %{ $config || {} }) {
    $self->$k($config->{$k}) if exists $config->{$k};
  }

  $self->_ua($app->ua);

  $app->helper(
    cloudinary_upload => sub {
      my $c = shift;
      $self->upload(@_);
    }
  );
  $app->helper(
    cloudinary_destroy => sub {
      my $c = shift;
      $self->destroy(@_);
    }
  );
  $app->helper(
    cloudinary_url_for => sub {
      my($c, $public_id, $args) = @_;
      my $scheme = $c->req->url->scheme || '';

      if(not defined $args->{'secure'} and $scheme eq 'https') {
        $args->{'secure'} = 1;
      }

      return $self->url_for($public_id, $args);
    }
  );
  $app->helper(
    cloudinary_image => sub {
      my($c, $public_id, $args, $image_args) = @_;
      my $scheme = $c->req->url->scheme || '';

      if(not defined $args->{'secure'} and $scheme eq 'https') {
        $args->{'secure'} = 1;
      }

      return $c->image($self->url_for($public_id, $args), alt => $public_id, %$image_args);
    }
  );
  $app->helper(
    cloudinary_js_image => sub {
      my($c, $public_id, $args) = @_;
      my $scheme = $c->req->url->scheme || '';

      if(not defined $args->{'secure'} and $scheme eq 'https') {
        $args->{'secure'} = 1;
      }

      return $c->image(
        $self->js_image,
        'alt'      => $public_id,
        'class'    => 'cloudinary-js-image',
        'data-src' => $public_id,
        map {
          my $k = $Cloudinary::LONGER{$_} || $_;
          ("data-$k" => $args->{$_})
        } keys %$args
      );
    }
  );
}

=head1 COPYRIGHT & LICENSE

See L.

=head1 AUTHOR

Jan Henning Thorsen - [e-mail]

=cut

1;