Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
getfitter / README.md
Size: Mime:

getfitter-ruby

This is the main Ruby library for Get Fitter. It should handle all of the endpoints of the API to provide a reference implementation. It uses ROAR to reconstruct full objects from the JSON reponses.

Installation

getfitter-ruby isn't (currently) on RubyGems, you should instead use the private GemFury source:

source 'https://G3ixBQ6dKteqJr6mbx82@gem.fury.io/nickcharlton/'

gem 'getfitter'

Alternatively point to the repository:

gem 'getfitter', git: 'https://github.com/getfitter/getfitter-ruby.git'

Or, install it yourself:

gem install getfitter --source https://G3ixBQ6dKteqJr6mbx82@gem.fury.io/nickcharlton/

Usage

GetFitter::API.configure do |config|
  config.url = 'https://getfitter-api.herokuapp.com/'
end

The models are exposed following the ActiveModel patterns. See the [Her][] documentation for further details.

These are implemented:

  • GetFitter::Event

Testing

Specs are provided using RSpec, you can run them using:

rake spec

Contributing

  1. Fork it ( https://github.com/getfitter/getfitter-ruby/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request