Peoplegroup::Hris
This Ruby library is a wrapper over our HRIS. If we'd switch systems, we could easily do so by adding a new class that inherits from the HRTool class.
Installation
Add this line to your application's Gemfile:
gem 'peoplegroup-hris'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install peoplegroup-hris
Usage
require 'peoplegroup/hris'
PeopleGroup::HRIS.configure do |config|
config.hris_client = PeopleGroup::HRIS::BambooHR
end
all_team_members = PeopleGroup::HRIS::TeamMembers.all
all_active_team_members = PeopleGroup::HRIS::TeamMembers.active_and_current
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
. 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 the created tag, and push the .gem
file to rubygems.org.
Contributing
Bug reports and merge requests are welcome on GitLab at https://gitlab.com/gitlab-com/people-group/peopleops-eng/hris-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Peoplegroup::Hris project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.