neustar-pfm-cli

About

Neustar WebPerformance Management API
Local Validate

Reference

Installation

Add this line to your application's Gemfile:

gem 'neustar_pfm_cli'

And then execute:

$ bundle

Or install it yourself as:

$ gem install neustar_pfm_cli

Usage

API Shared Secret

export NEUSTAR_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxx"
export NEUSTAR_SHARED_KEY="xxxxxxx"

Local Validator

export NEUSTAR_LOCAL_VALIDATOR_PATH="/path/to/local-validator-4.34.17/bin/validator"

loadtest

ls ...

bundle exec bin/npc-loadtest ls | jq '.data.items[]'

get ...

bundle exec bin/npc-loadtest get -i 123456 | jq '.data.items[]'

del ...

bundle exec bin/npc-loadtest del -i $(bundle exec bin/npc-loadtest ls | jq '.data.items[].id')

sc ...

bundle exec bin/npc-loadtest sc -f loadtest.yml

loadtest.yml

name: "myloadtest"
region: "AP_NORTHEAST"
scripts:
  - percentage: 100
    scriptId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    parts:
  - duration: 5
    maxUsers: 10
    type: "RAMP"

scripting

ls ...

bundle exec bin/npc-scripting ls | jq '.data.items[]'

val ... Local Validator

bundle exec bin/npc-scripting val -f path/to/script.js

up ...

bundle exec bin/npc-scripting up -n script_name -f path/to/script.js -t tag1,tag2 -d description

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake false to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.