Rentdynamics

Used for accessing the RentDynamics API.

Installation

Add this line to your application's Gemfile:

gem 'rentdynamics'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rentdynamics

Usage

Basic usage is as follows:

RentDynamics::Client.new(access_key, secret_access_key, development)

Users will need to recieve an access_key and secret_access_key from RentDynamics, and the development is a boolean flag if you want to connect to the development environment or not (Defaults to false).

Once you have an instance of the client the following actions are available:

get - passing an endpoint post - passing an endpoint and a body put - passing an endpoint and a body delete - not implemented

Development

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 tags, and push the .gem file to rubygems.org.

Contributing

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

License

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

Code of Conduct

Everyone interacting in the Rentdynamics project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.