MgmtConsole

This is an API client gem for our mgmt console.

Installation

Add this line to your application's Gemfile:

gem 'mgmt_console'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mgmt_console

Usage

The example below is how to retrieve a list of all communities across all instances.

require 'mgmt_console'
client = MgmtConsole::Client.new(access_token: '7fd3e655e79037d66b7b2cd4094c13b4', api_endpoint: 'https://console.mindjet.com/api/v1', ssl_verify: true)
engage_communities = client.engage_communities(nil, per_page: 200)
while client.last_response.rels[:next]
  engage_communities.concat(client.last_response.rels[:next].get.data)
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/mgmt_console/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request