Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Drop dead simple Barcode and QRcode generator for Rails apps.

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

MultiEncoder

QRcode and Barcode generation for Rails apps. Saves resulting png's to the filesystem or as3. It includes a C extension that wraps the GNU Barcode project. For qrcode generation, it uses the qrcode gem, which in turn, wraps the libqrencode C library.

Installation

If you intend to generate QRCodes, you'll need to compile the C library libqrencode available here.

curl http://fukuchi.org/works/qrencode/qrencode-3.2.0.tar.gz | tar xz
cd qrencode-3.2.0
./configure
make
sudo make install

You'll also need ImageMagick to generate the barcode png's.

Add this line to your application's Gemfile:

gem 'multi_encoder'

And then execute:

$ bundle

This will compile the gbarcode extension, included within.

Usage

<%= qrcode 'whasupbro' %>
<%= barcode 'notmuchmate' %>

Options

Barcodes

The <%= barcode %> heleper generates a barcode in BARCODE_128 format and accepts the following options:

width
height
scaling_factor
xoff
yoff
margin

Example:

<%= barcode width: 100, height: 30, xoff: 100 %>

The resulting PNG will be saved on the filesystem (or as3) and rendered into the view.

Configuration

There is nothing to configure if you want the resulting png's saved to the filesystem. This is the default. If you want to upload the images to AS3 you'll need to configure the sorage options, like so:

MultiEncoder::Storage.configure do |c|
  c.destination = :aws
  c.aws_bucket_prefix = SOME_PREFIX
  c.aws_access_key = YOUR_ACCESS_KEY
  c.aws_secret_access_key =  YOUR_SECRET_ACCESS_KEY
end

It is also possible to set these values as environment valiables

That's it, you are ready to go.

The gem will create buckets with the following names, depending on the Rails environment:

[prefix]-development-barcodes
[prefix]-development-qrcodes

and so on.

Licence

MIT

Something went wrong with that request. Please try again.