No release in over 3 years
Low commit activity in last 3 years
Ruby gem for consuming the RESTful JSON-based DSS IT Roles Management API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.9
~> 10.0
 Project Readme

Roles Management API

Ruby gem for interacting with the DSS IT Roles Management API system.

Installation

Add this line to your application's Gemfile:

gem 'roles-management-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install roles-management-api

Usage

client = RolesManagementAPI.login("https://roles.installation.url/api", "Username", "API Key")
client.connected?

r = client.find_role_by_id(1234)
puts "Role has #{r.assignments.length} assignments."

p = client.find_person_by_loginid('somebody')
puts "'somebody' user has full name of #{p.name}"

# You can also do: p = client.find_entity_by_id(123) if you know the ID

puts "Removing first assignment from role ..."
r.assignments.delete(r.assignments[0])
client.save(r)

puts "Adding 'somebody' to role ..."
r.assignments << p
client.save(r)

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/dssit/roles-management-api/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