Git Product home page Git Product logo

fountain-ruby's Introduction

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.

fountain-ruby's People

Contributors

abrom avatar jdejong avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.