ResmarkSystems::Client

This community maintained Resmark Systems API client library provides convenient access to Resmark Systems' API endpoints for Ruby applications. Our goal is to provide a wrapper over all the API endpoints offered by Resmark Systems' booking and reservation software.

Notice: This is an unofficial, community-maintained library. It is built and maintained independently by developers who build applications that are clients of the Resmark Systems API, and is not affiliated with or officially endorsed by Resmark Systems, LLC.

Installation

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

Contributing

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

Code of Conduct

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

Disclaimer / Notice

This is an independent, community-maintained API wrapper library. It is not officially affiliated with, endorsed by, or associated with Resmark Systems.

Please note:

• API Limits: Users are entirely responsible for adhering to their own Resmark Systems API rate limits and terms of service.
• Breaking Changes: Because this library relies on an external API, upstream changes by Resmark Systems may cause parts of this gem to break until an update is release.
• Gem is provided "as-is":: In accordance with the LGPL, this software is provided "as-is", without warranty of any kind.

License

This project is licensed under the GNU Lesser General Public License version 3.0 or any later version - see COPYING.LESSER file for details.