Lattice

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add latticehris

If bundler is not being used to manage dependencies, install the gem by executing:

gem install latticehris

Usage

First you will have to confige the gem. You need to work with Lattice to receive a client_id and client_secret to access the API. Once you've retrieved that, you are ready:

Lattice.configure do |config|
  config.client_id = 'your-client-id'
  config.client_secret = 'your-client-secret'
  config.scope = 'the scopes you enabled for this' 
end

Note: the scope needs to be a string with the different scopes separate by a space. So for example:

config.scope = 'employees:personal.read employees:personal.write'

Then once you have the client setup, you can call the API. Some examples:

Lattice::Employees.all
Lattice::Employees.find(employee_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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lattice. 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 Lattice project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.