Project

doorloop

0.0
The project is in a healthy, maintained state
A Ruby client for the DoorLoop API, allowing easy access to its resources.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 13.0
~> 1.0
~> 3.19.1

Runtime

 Project Readme

Doorloop

Welcome to Doorloop, an API wrapper gem for the Doorloop API. This gem allows you to easily interact with Doorloop’s API using Ruby, providing a simple and intuitive interface for managing your property management needs.

Installation

Add this line to your application's Gemfile:

gem 'doorloop'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install doorloop

Usage

To use the Doorloop gem, you need to configure it with your Doorloop API key. You can set it up directly in your code:

    require 'doorloop'
    
    client = DoorLoop::Client.new('your_api_token')
    
    # Example: List all accounts
    response = client.accounts.list
    puts response

For detailed usage and API documentation, please refer to the Doorloop API documentation.

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/mezbahalam/doorloop. 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 Doorloop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.