Paylocity Ruby Gem

Ruby toolkit for paylocity.com API.

Paylocity Web Service API Documentation

Add this line to your application's Gemfile:

gem 'paylocity-ruby-gem'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install paylocity_web_service

# config/initializers/paylocity.rb
public_key = <<HEREDOC
-----BEGIN PUBLIC KEY-----
your public key
-----END PUBLIC KEY-----
HEREDOC


PaylocityWebService.configure do |config|
  config.client_id = 'your_client_id'
  config.client_secret = 'your_client_secret' 
  config.public_key = public_key
end

# Provide authentication credentials
client = PaylocityWebService::Client.new(company_id: 'S2222')

# retrieve all employees
client.employees

# get the employee by id
client.employee(1)

# create the employee
client.create_employee(options={})

# get the open api document of current company.
client.company_schema

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/helloworld1812/paylocity-ruby-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Here are some ways you can contribute:

• by reporting bugs
• by suggesting new features
• by writing or editing documentation
• by writing test case
• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
• by refactoring code
• by closing issues
• by reviewing patches

The gem is available as open source under the terms of the MIT License.

Everyone interacting in this project’s codebase, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Good examples of API Wrapper

• Octokit
• Instagram
• Twitter