3scale-3scale_ws_api

= Interface for 3scale web service API monitoring system

This plugin provides interface for communication with 3scale monitoring system.

== Configuration

If you are using rails 2.1 or newer, put this into your config/environment.rb file:

config.gem "3scale_interface"

If you are using older version, put there this instead:

require "3scale_interface"

== Usage

First, create new interface object with 3scale backed hostname and Your private authentication key:

interface = ThreeScale::Interface.new("http://3scale.net", "a3b034...")

Because the object is stateless, you can create just one and store it globally.

Then for each request to Your service:

• Start the transaction with user key and (optionally) estimated resource usage (in this example it is: 1 hit and 42000 kilobytes of storage space),

transaction = interface.start(user_key, 'hits' => 1, 'storage' => 42000)

This will return transaction data (if successful). It is a hash containing these fields:

:id:: transaction id necessary for confirmation or cancellation of transaction (see following steps).

:provider_verification_key:: the provider should send this key back to user so he/she can verify the authenticity of the response.

:contract_name:: name of contract the user is signed for. This can be used to send different response according to contract type, if that is desired.

• Process the request.

2a. If the processing was successful: Call +confirm+:

interface.confirm(transaction[:id])

Or call it with actual resource usage, if it differs from predicted one:

interface.confirm(transaction[:id], 'hits' => 1, 'storage' => 40500)

2b. If there was some error, call +cancel+:

interface.cancel(transaction[:id])

• Send response back to the user together with +provider_verification_key+.