Project

ninjarmm

0.0
No commit activity in last 3 years
No release in over 3 years
API Wrapper for the NinjaRMM platform.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0

Runtime

 Project Readme

NinjaRMM

An unofficial REST API wrapper for the NinjaRMM platform.

Installation

Place in your Gemfile:

gem 'ninjarmm'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ninjarmm

Getting Started

Require NinjaRMM

require 'ninjarmm'

Create a new Client instance

client = NinjaRMM::Client.new access_id: 'x', secret_key: 'y'

You can also pass a Faraday adapter

client = NinjaRMM::Client.new access_id: 'x', secret_key: 'y', adapter: :typhoeus

Start making calls to the API

client.customer id: 25 # => "id"=>25, "name"=>"SOM_CUST", "description"=>"Some Customer"} 

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/craysiii/ninjarmm.

License

The gem is available as open source under the terms of the MIT License.