Skip to content

Studiosity/fountain-ruby

Repository files navigation

Travis Build Status Maintainability Test Coverage Gem Version

Fountain REST API for Ruby

This is a gem wrapping the v2 REST API for Fountain.

Installation

Add this line to your application's Gemfile:

gem 'fountain'

And then execute:

$ bundle

Supported API calls

Applicant Management

List, create, delete, get, update applicant etc

See https://developer.fountain.com/docs/applicants

Usage

First, initialise the Fountain API token

Fountain.configure do |config|
  config.api_token = 'YOUR-FOUNTAIN-API-TOKEN'
end

List all applicants

applicants = Fountain::Api::Applicants.list
loop do
  break if applicants.count.zero?
  applicants.each do |applicant|
    # Do something with the applicant
  end
  applicants = Fountain::Api::Applicants.list(cursor: applicants.next_cursor)
end

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Studiosity/fountain-ruby.

Note that spec tests are appreciated to minimise regressions. Before submitting a PR, please ensure that:

$ rspec

and

$ rubocop

both succeed

License

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

About

Ruby wrapper for Fountain v2 REST API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages