Skip to content

cpoms/progresso_client

Repository files navigation

Progresso

Progresso API client

Installation

Add this line to your application's Gemfile:

gem 'progresso'

And then execute:

$ bundle

Or install it yourself as:

$ gem install progresso

Usage

client = Progresso::Client.new(subdomain, username, password)
client.learners.each do |student|
  puts "#{student.forename} #{student.surname}"
end

Development

After checking out the repo, run bin/setup to install dependencies. 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 pull requests are welcome on GitHub at https://github.com/[USERNAME]/progresso.