/market-req

Primary LanguageCoffeeScript

Market req

Market req purposed for store oauth tokens for making more request to oauth services to overcome rpm/rph limit by using more than one token. Store tokens and usage stat in redis.

Installation

  $ npm install market-req

Simple example (coffee-script)

   client = require("market-req").createClient()
   # add 10 request tokens for current hour
   client.addToken "srv", "token_key", "token_secret", 10
   ...
   # fetch 3 tokens
   client.fetchTokens "srv", 3, (err, tokens) ->
     unless err
       # utilize tokens array
       token         = tokens[0].key
       token_secret  = tokens[0].secret

Get market statistics

    client = require("market-req").createClient()
    # current hour
    client.getStatByHour "srv", (err, stat) -> 
      console.log "stat = #{JSON.stringify stat}"
    ...
    # custom hour
    client.getStatByHour "srv", 367910, (err, stat) ->
      console.log "stat = #{JSON.stringify stat}"

Auto add tokens

Add tokens, that will be added authomatically each hour.

    client = require("market-req").createClient()
    client.addAuto "srv", [{key:"key1", secret:"secret1", count:10}, {key:"key2", secret:"secret2", count:20}]2
    ...
    # remove first key and add tokens to second
    client.addAuto "srv", [{key:"key1", secret:"secret1", count:0}, {key:"key2", secret:"secret2", count:40}]
    client.fetchTokens "srv", 22, (err, tokens) -> 
      console.log "err  = #{JSON.stringify err}\ntokens = #{JSON.stringify tokens}"

Changelog

v 0.2.2

  • Disable duplicate key tokens in auto tokens
  • Add method for replacing token counts addAuto (bulk) and replaceAutoToken (single update)

v 0.2.0

  • Ability to automatically add specified tokens

License

(The MIT License)

Copyright (c) 2011 Temnov Kirill <allselead@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.