Params extractor

Used to encode or decode a URL params. This is useful for sending out encrypted links with token and then unencrypting, decoding and parsing them later when they come back to the app.

Getting started example

Params::Crypter.off! # turn encryption off (is on by default) - global setting
        Params::Crypter.on! # turn encryption back on - global setting

        # singleton Crypter shared between Encoder and Decoder (uses 'gibberish' gem)
        # Recommended: load password from a DB table, YAML file or similar

        Params::Crypter.password = "my very secret password"

        # encrypt and encode the params
        params = {:id => 7, :name => 'kris'}

        encoder = Params::Encoder.new(params)
        encoder.params # => 'id=7&name=kris'

        encoded_params = encoder.encoded

        email_link = "#{domain}/invite?token=" + encoded_params

        # send link in email or Facebook notification or similar

        # later... someone clicks on the link

        # decrypt and decode the params
        decoded_params = Params::Decoder.new(params).decoded

        # retrieve hash from param values
        hash = decoded_params.as_hash(:sym)
        
        # retrieve param values from hash
        id              = hash[:id].to_i
        name    = hash[:name]

        # set crypter on/off for individual encoder or decoder

        # turn off for encoder
        encoder = Params::Encoder.new "a=7", :crypter => false

        # turn off for decoder
        decoder = Params::Decoder.new token, :crypter => false

Look at the specs for more on usage.

Contributing to params_extractor

Copyright © 2012 Kristian Mandrup. See LICENSE.txt for further details.