owlgrin/throttle

Rate Limiter and Usage tracker

throttle

Throttle allows you to maintain a integration between your plans and your features., _(*1)

Installation

To install the package, include the following in your composer.json., _(*2)

"owlgrin/throttle": "dev-master"

And then include the following service provider in your app.php., _(*3)

'Owlgrin\Throttle\ThrottleServiceProvider'

And lastly, publish the config., _(*4)

php artisan config:publish owlgrin/throttle

Usage

Write this command in your artisan to create migrations, _(*5)

throttle:table

Now migrate all the tables to your mysql db, _(*6)

php artisan migrate

Entry of New Plan, _(*7)

Its time to create a new plan by using Owlgrin\Plan\PlanRepo 's add function, _(*8)

plan's format is as follows, _(*9)

$plan = {
  "plan":{
      "name" : "Simple",
      "identifier" :"simple",
      "description" :"this is a simple plan",
        "features": [
          {
            "name":"Horn",
            "identifier":"horn",
            "tier" :[
                {
                "rate":"4",
                "per_quantity":1,
                "limit":"500"
              },
               {
                "rate":"3",
                "per_quantity":1,
                "limit":"5000"
              }
            ]
     },
        {
            "name":"Mail",
            "identifier":"mail",
            "tier" :[
                {
                "rate":"4",
                "per_quantity":1,
                "limit":"100"
              },
               {
                "rate":"3",
                "per_quantity":1,
                "limit":"1000"
              }
            ]
     }
    ]
  }
}

Subscription of user, _(*10)

You can subscribe a user with plan id by using, _(*11)

Owlgrin\Throttle\Subscriber\SubscriberRepo

subscribe($userId, $planId), _(*12)

Biller, _(*13)

You can calculate the bill by just using, _(*14)

Owlgrin\Throttle\Biller\Biller

calculate($userId), _(*15)

or can estimate bill by, _(*16)

estimate($plan), _(*17)

$plan = {'plan_id':1,
          'feature':{
            {feature_id}:{usage},
            {feature_id}:{usage}
          }
        }