https://github.com/taylorbrooks/rock_rms

A Ruby wrapper for the Rock RMS API
https://github.com/taylorbrooks/rock_rms

rock rock-rms ruby-wrapper

Last synced: 4 months ago
JSON representation

A Ruby wrapper for the Rock RMS API

• Host: GitHub
• URL: https://github.com/taylorbrooks/rock_rms
• Owner: taylorbrooks
• License: mit
• Created: 2017-06-19T03:34:01.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-08-25T16:04:31.000Z (6 months ago)
• Last Synced: 2025-10-04T02:59:31.320Z (4 months ago)
• Topics: rock, rock-rms, ruby-wrapper
• Language: Ruby
• Size: 360 KB
• Stars: 13
• Watchers: 3
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![](https://www.rockrms.com/Themes/RockExternal/Assets/Images/rock-logo.svg)

# Rock RMS Ruby Client ![example workflow](https://github.com/taylorbrooks/rock_rms/actions/workflows/test.yml/badge.svg)

A Ruby wrapper for the Rock RMS API

To get a general overview of Rock RMS: https://www.rockrms.com

To stay up-to-date with the code changes of Rock RMS: https://github.com/SparkDevNetwork/Rock

I'm a big fan of Rock so if you have problems using the gem or would like to see support for new endpoints, please open a GitHub issue -- I'll get it resolved as quick as I can.

### Installation

Add this line to your application's Gemfile:

````ruby

  # in your Gemfile

  gem 'rock_rms', '~> 7.0.3'

  # then...

  bundle install

````

### Usage

````ruby

  # Authenticating with username and password

  client = RockRMS::Client.new(

    url: ...,

    username: ...,

    password: ...,

  )

  # Authenticating with authorization token

  client = RockRMS::Client.new(

    url: ...,

    authorization_token: ...,

  )

  # Find a specific person

  client.find_person_by_email('gob@bluthco.com')

  client.find_person_by_name('Tobias Funke')

````

### History

View the [changelog](https://github.com/taylorbrooks/rock_rms/blob/master/CHANGELOG.md)

This gem follows [Semantic Versioning](http://semver.org/)

### Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

- [Report bugs](https://github.com/taylorbrooks/rock_rms/issues)

- Fix bugs and [submit pull requests](https://github.com/taylorbrooks/rock_rms/pulls)

- Write, clarify, or fix documentation

- Suggest or add new features

### Copyright

Copyright (c) 2017-2024 Taylor Brooks. See LICENSE for details.