Splinter

This is a wrapper for the PTO by Roots API

Installation

Add this line to your application's Gemfile:

gem 'splinter-pto'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install splinter-pto

Usage

Configuration

Configure an API Key:

Splinter.configure do |c|
  c.api_key = "MY_API_KEY"
end

OOO Events

# Get all PTO Events
Splinter::OOOEvents.get_all

event_id = 1 # example event ID
Splinter::OOOEvents.find(event_id)

OOO Types

# List all OOO Event Types
Splinter::OOOTypes.get_all

# Find a specific event type by ID
type_id = '1'
Splinter::OOOTypes.find(type_id)

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 tags, 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/splinter. 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 Splinter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.